Skip to content

🐸 Rybbit - open-source and privacy-friendly alternative to Google Analytics that is 10x more intuitive.

1.9 KB
Raw Blame
import { useMutation, useQueryClient } from "@tanstack/react-query";
import { useDebounce } from "@uidotdev/usehooks";
import { FUNNEL_PAGE_FILTERS } from "../../../../lib/filterGroups";
import { getFilteredFilters, useStore } from "../../../../lib/store";
import { FunnelRequest, FunnelResponse, saveFunnel, SaveFunnelRequest } from "../../endpoints";
import { useAnalyticsQuery } from "../../useAnalyticsQuery";

/**
 * Hook for analyzing conversion funnels through a series of steps
 */
export function useGetFunnel(config?: FunnelRequest, debounce?: boolean) {
  const debouncedConfig = useDebounce(config, 500);
  const configToUse = debounce ? debouncedConfig : config;
  // Only the funnel page's filter parameters apply; an empty subset means no
  // filters at all (not the store's full filter list).
  const filteredFilters = getFilteredFilters(FUNNEL_PAGE_FILTERS);

  return useAnalyticsQuery<FunnelResponse[]>({
    key: "funnel",
    path: "funnels/analyze",
    useFilters: filteredFilters.length > 0,
    customFilters: filteredFilters,
    body: () => ({ steps: configToUse?.steps ?? [], name: configToUse?.name }),
    enabled: !!configToUse,
  });
}

/**
 * Hook for saving funnel configurations without analyzing them
 */
export function useSaveFunnel() {
  const site = useStore(state => state.site);
  const queryClient = useQueryClient();

  return useMutation<{ success: boolean; funnelId: number }, Error, SaveFunnelRequest>({
    mutationFn: async funnelConfig => {
      try {
        const saveResponse = await saveFunnel(site, {
          steps: funnelConfig.steps,
          name: funnelConfig.name,
          reportId: funnelConfig.reportId,
        });

        // Invalidate the funnels query to refresh the list
        queryClient.invalidateQueries({ queryKey: ["funnels", site] });

        return saveResponse;
      } catch (error) {
        throw new Error("Failed to save funnel");
      }
    },
  });
}