Skip to content

armgit / umami

Public Imported from GitHub
0

Umami is a privacy-first web and product analytics platform. Traffic, campaigns, behavior, conversions, and revenue in one place. No cookies, no surveillance, self-hosted or in the cloud.

3.8 KB
Raw Blame
import { FILTER_COLUMNS, OPERATORS } from '@/lib/constants';
import { parseSessionPropertyFilters, parseUniversalEventPropertyFilters } from '@/lib/params';
import { safeDecodeURIComponent } from '@/lib/url';
import { useShare } from './context/useShare';
import { useFields } from './useFields';
import { useMessages } from './useMessages';
import { useNavigation } from './useNavigation';
import { useOperatorLabels } from './useOperatorLabels';

export function useFilters() {
  const { t, labels } = useMessages();
  const { pathname, query } = useNavigation();
  const { fields } = useFields();
  const operatorLabels = useOperatorLabels();
  const share = useShare();
  const allowFilter = share?.parameters?.allowFilter !== false;

  const operators = [
    { name: 'eq', type: 'string', label: t(labels.is) },
    { name: 'neq', type: 'string', label: t(labels.isNot) },
    { name: 'c', type: 'string', label: t(labels.contains) },
    { name: 'dnc', type: 'string', label: t(labels.doesNotContain) },
    { name: 're', type: 'string', label: t(labels.regexMatch) },
    { name: 'nre', type: 'string', label: t(labels.regexNotMatch) },
    { name: 'i', type: 'array', label: t(labels.includes) },
    { name: 'dni', type: 'array', label: t(labels.doesNotInclude) },
    { name: 't', type: 'boolean', label: t(labels.isTrue) },
    { name: 'f', type: 'boolean', label: t(labels.isFalse) },
    { name: 'eq', type: 'number', label: t(labels.is) },
    { name: 'neq', type: 'number', label: t(labels.isNot) },
    { name: 'gt', type: 'number', label: t(labels.greaterThan) },
    { name: 'lt', type: 'number', label: t(labels.lessThan) },
    { name: 'gte', type: 'number', label: t(labels.greaterThanEquals) },
    { name: 'lte', type: 'number', label: t(labels.lessThanEquals) },
    { name: 'bf', type: 'date', label: t(labels.before) },
    { name: 'af', type: 'date', label: t(labels.after) },
    { name: 'eq', type: 'uuid', label: t(labels.is) },
  ];

  const typeFilters = {
    string: [
      OPERATORS.equals,
      OPERATORS.notEquals,
      OPERATORS.contains,
      OPERATORS.doesNotContain,
      OPERATORS.regex,
      OPERATORS.notRegex,
    ],
    array: [OPERATORS.contains, OPERATORS.doesNotContain],
    boolean: [OPERATORS.true, OPERATORS.false],
    number: [
      OPERATORS.equals,
      OPERATORS.notEquals,
      OPERATORS.greaterThan,
      OPERATORS.lessThan,
      OPERATORS.greaterThanEquals,
      OPERATORS.lessThanEquals,
    ],
    date: [OPERATORS.before, OPERATORS.after],
    uuid: [OPERATORS.equals],
  };

  const filters = allowFilter
    ? Object.keys(query).reduce((arr, key) => {
        const baseName = key.replace(/\d+$/, '');
        if (FILTER_COLUMNS[baseName]) {
          let operator = 'eq';
          let value = safeDecodeURIComponent(query[key]);
          const label = fields.find(({ name }) => name === baseName)?.label;

          const match = value.match(/^([a-z]+)\.(.*)/);

          if (match) {
            operator = match[1];
            value = match[2];
          }

          return arr.concat({
            name: key,
            type: baseName,
            operator,
            value,
            label,
          });
        }
        return arr;
      }, [])
    : [];
  const eventPropertyFilters =
    allowFilter && pathname.endsWith('/events') ? parseUniversalEventPropertyFilters(query) : [];
  const sessionPropertyFilters = allowFilter ? parseSessionPropertyFilters(query) : [];

  const getFilters = (type: string) => {
    return (
      typeFilters[type]?.map((key: string | number) => ({
        type,
        value: key,
        label: operatorLabels[key],
      })) ?? []
    );
  };

  return {
    fields,
    operators,
    filters,
    eventPropertyFilters,
    sessionPropertyFilters,
    operatorLabels,
    typeFilters,
    getFilters,
  };
}