Skip to content

OpenPanel is an open-source web and product analytics platform, an open-source alternative to Mixpanel with optional self-hosting.

2.2 KB
Raw Blame
import type { IChartRange } from '@openpanel/core/modules/report/report.constants';
import {
  getDefaultIntervalByDates,
  getDefaultIntervalByRange,
  intervals,
  timeWindows,
} from '@openpanel/core/modules/report/report.constants';
import { differenceInCalendarMonths } from 'date-fns';
import {
  parseAsInteger,
  parseAsString,
  parseAsStringEnum,
  useQueryState,
} from 'nuqs';
import { useCookieStore } from '@/hooks/use-cookie-store';
import { mapKeys } from '@/utils/object-to-zod-enums';

const nuqsOptions = { history: 'push' } as const;

export function useOverviewOptions() {
  const [startDate, setStartDate] = useQueryState(
    'start',
    parseAsString.withOptions(nuqsOptions)
  );
  const [endDate, setEndDate] = useQueryState(
    'end',
    parseAsString.withOptions(nuqsOptions)
  );
  const [cookieRange, setCookieRange] = useCookieStore<IChartRange>(
    'range',
    '7d'
  );
  const [range, setRange] = useQueryState(
    'range',
    parseAsStringEnum(mapKeys(timeWindows))
      .withDefault(cookieRange)
      .withOptions({
        ...nuqsOptions,
        clearOnDefault: false,
      })
  );
  const [overrideInterval, setInterval] = useQueryState(
    'overrideInterval',
    parseAsStringEnum(mapKeys(intervals)).withOptions({
      ...nuqsOptions,
      clearOnDefault: false,
    })
  );

  const interval =
    overrideInterval ||
    getDefaultIntervalByDates(startDate, endDate) ||
    getDefaultIntervalByRange(range);

  const [metric, setMetric] = useQueryState(
    'metric',
    parseAsInteger.withDefault(0).withOptions(nuqsOptions)
  );

  return {
    // Skip previous for ranges over 6 months (for performance reasons)
    previous: !(
      range === 'yearToDate' ||
      range === 'lastYear' ||
      (range === 'custom' &&
        startDate &&
        endDate &&
        differenceInCalendarMonths(startDate, endDate) > 6)
    ),
    range,
    setRange: (value: IChartRange | null) => {
      if (value !== 'custom') {
        setStartDate(null);
        setEndDate(null);
        if (value) {
          setCookieRange(value);
        }
        setInterval(null);
      }
      setRange(value);
    },
    metric,
    setMetric,
    startDate,
    setStartDate,
    endDate,
    setEndDate,
    interval,
    setInterval,
  };
}