Skip to content

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

Refactor analytics API structure by moving single column hooks to a dedicated subdirectory

Bill Yangb44d457a0491
diff --git a/client/src/api/analytics/useInfiniteSingleCol.ts b/client/src/api/analytics/singleCol/useInfiniteSingleCol.ts
similarity index 81%
rename from client/src/api/analytics/useInfiniteSingleCol.ts
rename to client/src/api/analytics/singleCol/useInfiniteSingleCol.ts
index 02b41dcf3..62892bf64 100644
--- a/client/src/api/analytics/useInfiniteSingleCol.ts
+++ b/client/src/api/analytics/singleCol/useInfiniteSingleCol.ts
@@ -1,15 +1,8 @@
-import { FilterParameter } from "@rybbit/shared";
-import { useInfiniteQuery, UseInfiniteQueryResult, InfiniteData } from "@tanstack/react-query";
-import { SingleColResponse } from "@/api/analytics/useSingleCol";
+import { SingleColResponse } from "@/api/analytics/singleCol/useSingleCol";
import { authedFetch, getQueryParams } from "@/api/utils";
-import { timeZone } from "@/lib/dateTimeUtils";
import { useStore } from "@/lib/store";
-
-type UseInfiniteSingleColOptions = {
- parameter: FilterParameter;
- limit?: number;
- useFilters?: boolean;
-};
+import { FilterParameter } from "@rybbit/shared";
+import { InfiniteData, useInfiniteQuery, UseInfiniteQueryResult } from "@tanstack/react-query";
export type InfinitePaginatedResponse = {
data: SingleColResponse[];
@@ -20,7 +13,11 @@ export function useInfiniteSingleCol({
parameter,
limit = 25,
useFilters = true,
-}: UseInfiniteSingleColOptions): UseInfiniteQueryResult<InfiniteData<InfinitePaginatedResponse>> {
+}: {
+ parameter: FilterParameter;
+ limit?: number;
+ useFilters?: boolean;
+}): UseInfiniteQueryResult<InfiniteData<InfinitePaginatedResponse>> {
const { time, site, filters } = useStore();
return useInfiniteQuery({
diff --git a/client/src/api/analytics/usePaginatedSingleCol.ts b/client/src/api/analytics/singleCol/usePaginatedSingleCol.ts
similarity index 88%
rename from client/src/api/analytics/usePaginatedSingleCol.ts
rename to client/src/api/analytics/singleCol/usePaginatedSingleCol.ts
index 70ed9697c..929975490 100644
--- a/client/src/api/analytics/usePaginatedSingleCol.ts
+++ b/client/src/api/analytics/singleCol/usePaginatedSingleCol.ts
@@ -1,18 +1,9 @@
-import { SingleColResponse } from "@/api/analytics/useSingleCol";
+import { SingleColResponse } from "@/api/analytics/singleCol/useSingleCol";
import { authedFetch, getQueryParams } from "@/api/utils";
import { useStore } from "@/lib/store";
import { Filter, FilterParameter } from "@rybbit/shared";
import { useQuery, UseQueryResult } from "@tanstack/react-query";
-type UsePaginatedSingleColOptions = {
- parameter: FilterParameter;
- limit?: number;
- page?: number;
- useFilters?: boolean;
- enabled?: boolean;
- additionalFilters?: Filter[];
-};
-
type PaginatedResponse = {
data: SingleColResponse[];
totalCount: number;
@@ -25,7 +16,14 @@ export function usePaginatedSingleCol({
useFilters = true,
enabled = true,
additionalFilters = [],
-}: UsePaginatedSingleColOptions): UseQueryResult<PaginatedResponse> {
+}: {
+ parameter: FilterParameter;
+ limit?: number;
+ page?: number;
+ useFilters?: boolean;
+ enabled?: boolean;
+ additionalFilters?: Filter[];
+}): UseQueryResult<PaginatedResponse> {
const { time, site, filters } = useStore();
const queryParams = {
diff --git a/client/src/api/analytics/useSingleCol.ts b/client/src/api/analytics/singleCol/useSingleCol.ts
similarity index 92%
rename from client/src/api/analytics/useSingleCol.ts
rename to client/src/api/analytics/singleCol/useSingleCol.ts
index 42a9f4288..c63a05e85 100644
--- a/client/src/api/analytics/useSingleCol.ts
+++ b/client/src/api/analytics/singleCol/useSingleCol.ts
@@ -1,8 +1,8 @@
import { FilterParameter } from "@rybbit/shared";
import { useQuery, UseQueryResult } from "@tanstack/react-query";
-import { useStore } from "../../lib/store";
-import { APIResponse } from "../types";
-import { authedFetch, getQueryParams } from "../utils";
+import { useStore } from "../../../lib/store";
+import { APIResponse } from "../../types";
+import { authedFetch, getQueryParams } from "../../utils";
type PeriodTime = "current" | "previous";
diff --git a/client/src/app/[site]/components/shared/Filters/ValueSelect.tsx b/client/src/app/[site]/components/shared/Filters/ValueSelect.tsx
index 86b76f737..919cfce08 100644
--- a/client/src/app/[site]/components/shared/Filters/ValueSelect.tsx
+++ b/client/src/app/[site]/components/shared/Filters/ValueSelect.tsx
@@ -2,7 +2,7 @@
import { FilterParameter } from "@rybbit/shared";
import { useMemo } from "react";
-import { useSingleCol } from "../../../../../api/analytics/useSingleCol";
+import { useSingleCol } from "../../../../../api/analytics/singleCol/useSingleCol";
import { MultiSelect } from "../../../../../components/MultiSelect";
import { useGetRegionName } from "../../../../../lib/geo";
import { getCountryName, getLanguageName } from "../../../../../lib/utils";
diff --git a/client/src/app/[site]/components/shared/Map/MapComponent.tsx b/client/src/app/[site]/components/shared/Map/MapComponent.tsx
index 1b1984b84..63da04a97 100644
--- a/client/src/app/[site]/components/shared/Map/MapComponent.tsx
+++ b/client/src/app/[site]/components/shared/Map/MapComponent.tsx
@@ -3,7 +3,7 @@
import { useMeasure } from "@uidotdev/usehooks";
import "ol/ol.css";
import { useEffect, useState } from "react";
-import { useSingleCol } from "../../../../../api/analytics/useSingleCol";
+import { useSingleCol } from "../../../../../api/analytics/singleCol/useSingleCol";
import { useCountries, useSubdivisions } from "../../../../../lib/geo";
import { CountryFlag } from "../icons/CountryFlag";
import { useMapInstance } from "./hooks/useMapInstance";
diff --git a/client/src/app/[site]/components/shared/StandardSection/Row.tsx b/client/src/app/[site]/components/shared/StandardSection/Row.tsx
index a5913aad5..1314126c6 100644
--- a/client/src/app/[site]/components/shared/StandardSection/Row.tsx
+++ b/client/src/app/[site]/components/shared/StandardSection/Row.tsx
@@ -3,8 +3,8 @@ import NumberFlow from "@number-flow/react";
import { round } from "lodash";
import { ChevronDown, ChevronRight, SquareArrowOutUpRight } from "lucide-react";
import { ReactNode, useState, useCallback } from "react";
-import { usePaginatedSingleCol } from "../../../../../api/analytics/usePaginatedSingleCol";
-import { SingleColResponse } from "../../../../../api/analytics/useSingleCol";
+import { usePaginatedSingleCol } from "../../../../../api/analytics/singleCol/usePaginatedSingleCol";
+import { SingleColResponse } from "../../../../../api/analytics/singleCol/useSingleCol";
import { addFilter, removeFilter, useStore } from "../../../../../lib/store";
// Custom hook for filter handling logic
diff --git a/client/src/app/[site]/components/shared/StandardSection/StandardSection.tsx b/client/src/app/[site]/components/shared/StandardSection/StandardSection.tsx
index 3421a314d..7a7b8a5fc 100644
--- a/client/src/app/[site]/components/shared/StandardSection/StandardSection.tsx
+++ b/client/src/app/[site]/components/shared/StandardSection/StandardSection.tsx
@@ -4,8 +4,8 @@ import { Button } from "@/components/ui/button";
import { FilterParameter } from "@rybbit/shared";
import { AlertCircle, Info, RefreshCcw } from "lucide-react";
import { ReactNode } from "react";
-import { usePaginatedSingleCol } from "../../../../../api/analytics/usePaginatedSingleCol";
-import { SingleColResponse } from "../../../../../api/analytics/useSingleCol";
+import { usePaginatedSingleCol } from "../../../../../api/analytics/singleCol/usePaginatedSingleCol";
+import { SingleColResponse } from "../../../../../api/analytics/singleCol/useSingleCol";
import { CardLoader } from "../../../../../components/ui/card";
import { Row } from "./Row";
import { Skeleton } from "./Skeleton";
diff --git a/client/src/app/[site]/components/shared/StandardSection/StandardSectionDialog.tsx b/client/src/app/[site]/components/shared/StandardSection/StandardSectionDialog.tsx
index 0bf040f9e..938791a8c 100644
--- a/client/src/app/[site]/components/shared/StandardSection/StandardSectionDialog.tsx
+++ b/client/src/app/[site]/components/shared/StandardSection/StandardSectionDialog.tsx
@@ -11,8 +11,8 @@ import {
import { useDebounce, useIntersectionObserver } from "@uidotdev/usehooks";
import { ChevronDown, ChevronUp, Loader2, Search, SquareArrowOutUpRight } from "lucide-react";
import { ReactNode, useEffect, useMemo, useState } from "react";
-import { useInfiniteSingleCol } from "../../../../../api/analytics/useInfiniteSingleCol";
-import { SingleColResponse } from "../../../../../api/analytics/useSingleCol";
+import { useInfiniteSingleCol } from "../../../../../api/analytics/singleCol/useInfiniteSingleCol";
+import { SingleColResponse } from "../../../../../api/analytics/singleCol/useSingleCol";
import { FilterParameter } from "@rybbit/shared";
import { addFilter } from "../../../../../lib/store";
import { cn, formatSecondsAsMinutesAndSeconds } from "../../../../../lib/utils";
diff --git a/client/src/app/[site]/funnels/components/FunnelForm.tsx b/client/src/app/[site]/funnels/components/FunnelForm.tsx
index adf49eeb8..e7107ca50 100644
--- a/client/src/app/[site]/funnels/components/FunnelForm.tsx
+++ b/client/src/app/[site]/funnels/components/FunnelForm.tsx
@@ -6,7 +6,7 @@ import { Select, SelectContent, SelectItem, SelectTrigger, SelectValue } from "@
import { Plus, Save, Trash2 } from "lucide-react";
import { useState } from "react";
import { FunnelResponse, FunnelStep } from "../../../../api/analytics/funnels/useGetFunnel";
-import { useSingleCol } from "../../../../api/analytics/useSingleCol";
+import { useSingleCol } from "../../../../api/analytics/singleCol/useSingleCol";
import { ThreeDotLoader } from "../../../../components/Loaders";
import { Label } from "../../../../components/ui/label";
import { Switch } from "../../../../components/ui/switch";
diff --git a/client/src/app/[site]/globe/2d/hooks/useOpenLayersCountriesLayer.ts b/client/src/app/[site]/globe/2d/hooks/useOpenLayersCountriesLayer.ts
index 07139af33..9a450eb8e 100644
--- a/client/src/app/[site]/globe/2d/hooks/useOpenLayersCountriesLayer.ts
+++ b/client/src/app/[site]/globe/2d/hooks/useOpenLayersCountriesLayer.ts
@@ -5,7 +5,7 @@ import VectorLayer from "ol/layer/Vector";
import VectorSource from "ol/source/Vector";
import { Fill, Stroke, Style } from "ol/style";
import { MutableRefObject, useEffect, useMemo, useRef, useState } from "react";
-import { useSingleCol } from "../../../../../api/analytics/useSingleCol";
+import { useSingleCol } from "../../../../../api/analytics/singleCol/useSingleCol";
import { useCountries } from "../../../../../lib/geo";
import { addFilter } from "../../../../../lib/store";
import { createColorScale } from "../../utils/colorScale";
diff --git a/client/src/app/[site]/globe/2d/hooks/useOpenLayersSubdivisionsLayer.ts b/client/src/app/[site]/globe/2d/hooks/useOpenLayersSubdivisionsLayer.ts
index 28a053f8f..bc83814d6 100644
--- a/client/src/app/[site]/globe/2d/hooks/useOpenLayersSubdivisionsLayer.ts
+++ b/client/src/app/[site]/globe/2d/hooks/useOpenLayersSubdivisionsLayer.ts
@@ -5,7 +5,7 @@ import VectorLayer from "ol/layer/Vector";
import VectorSource from "ol/source/Vector";
import { Fill, Stroke, Style } from "ol/style";
import { MutableRefObject, useEffect, useMemo, useRef, useState } from "react";
-import { useSingleCol } from "../../../../../api/analytics/useSingleCol";
+import { useSingleCol } from "../../../../../api/analytics/singleCol/useSingleCol";
import { useSubdivisions } from "../../../../../lib/geo";
import { addFilter } from "../../../../../lib/store";
import { createColorScale } from "../../utils/colorScale";
diff --git a/client/src/app/[site]/globe/3d/hooks/useCountriesLayer.ts b/client/src/app/[site]/globe/3d/hooks/useCountriesLayer.ts
index 9ee180556..6e6769bbd 100644
--- a/client/src/app/[site]/globe/3d/hooks/useCountriesLayer.ts
+++ b/client/src/app/[site]/globe/3d/hooks/useCountriesLayer.ts
@@ -1,7 +1,7 @@
import { FilterParameter } from "@rybbit/shared";
import mapboxgl from "mapbox-gl";
import { useEffect, useMemo, useRef } from "react";
-import { useSingleCol } from "../../../../../api/analytics/useSingleCol";
+import { useSingleCol } from "../../../../../api/analytics/singleCol/useSingleCol";
import { useCountries } from "../../../../../lib/geo";
import { addFilter } from "../../../../../lib/store";
import { createColorScale } from "../../utils/colorScale";
diff --git a/client/src/app/[site]/globe/3d/hooks/useSubdivisionsLayer.ts b/client/src/app/[site]/globe/3d/hooks/useSubdivisionsLayer.ts
index 865316fe8..59a1256af 100644
--- a/client/src/app/[site]/globe/3d/hooks/useSubdivisionsLayer.ts
+++ b/client/src/app/[site]/globe/3d/hooks/useSubdivisionsLayer.ts
@@ -1,7 +1,7 @@
import { FilterParameter } from "@rybbit/shared";
import mapboxgl from "mapbox-gl";
import { useEffect, useMemo, useRef } from "react";
-import { useSingleCol } from "../../../../../api/analytics/useSingleCol";
+import { useSingleCol } from "../../../../../api/analytics/singleCol/useSingleCol";
import { useSubdivisions } from "../../../../../lib/geo";
import { addFilter } from "../../../../../lib/store";
import { createColorScale } from "../../utils/colorScale";
diff --git a/client/src/app/[site]/goals/components/GoalFormModal.tsx b/client/src/app/[site]/goals/components/GoalFormModal.tsx
index b2f37d230..af0908128 100644
--- a/client/src/app/[site]/goals/components/GoalFormModal.tsx
+++ b/client/src/app/[site]/goals/components/GoalFormModal.tsx
@@ -7,7 +7,7 @@ import * as z from "zod";
import { useCreateGoal } from "../../../../api/analytics/goals/useCreateGoal";
import { Goal } from "../../../../api/analytics/goals/useGetGoals";
import { useUpdateGoal } from "../../../../api/analytics/goals/useUpdateGoal";
-import { useSingleCol } from "../../../../api/analytics/useSingleCol";
+import { useSingleCol } from "../../../../api/analytics/singleCol/useSingleCol";
import { EventIcon, PageviewIcon } from "../../../../components/EventIcons";
import { Button } from "../../../../components/ui/button";
import {
@@ -111,28 +111,29 @@ export default function GoalFormModal({ siteId, goal, trigger, isCloneMode = fal
// Initialize form with default values or existing goal
const form = useForm<FormValues>({
resolver: zodResolver(formSchema),
- defaultValues: (isEditMode || isCloneMode) && goal
- ? {
- name: isCloneMode ? `${goal.name || `Goal #${goal.goalId}`} (Copy)` : (goal.name || ""),
- goalType: goal.goalType,
- config: {
- pathPattern: goal.config.pathPattern || "",
- eventName: goal.config.eventName || "",
- eventPropertyKey: goal.config.eventPropertyKey || "",
- eventPropertyValue:
- goal.config.eventPropertyValue !== undefined ? String(goal.config.eventPropertyValue) : "",
+ defaultValues:
+ (isEditMode || isCloneMode) && goal
+ ? {
+ name: isCloneMode ? `${goal.name || `Goal #${goal.goalId}`} (Copy)` : goal.name || "",
+ goalType: goal.goalType,
+ config: {
+ pathPattern: goal.config.pathPattern || "",
+ eventName: goal.config.eventName || "",
+ eventPropertyKey: goal.config.eventPropertyKey || "",
+ eventPropertyValue:
+ goal.config.eventPropertyValue !== undefined ? String(goal.config.eventPropertyValue) : "",
+ },
+ }
+ : {
+ name: "",
+ goalType: "path",
+ config: {
+ pathPattern: "",
+ eventName: "",
+ eventPropertyKey: "",
+ eventPropertyValue: "",
+ },
},
- }
- : {
- name: "",
- goalType: "path",
- config: {
- pathPattern: "",
- eventName: "",
- eventPropertyKey: "",
- eventPropertyValue: "",
- },
- },
});
const goalType = form.watch("goalType");
@@ -203,8 +204,8 @@ export default function GoalFormModal({ siteId, goal, trigger, isCloneMode = fal
{isEditMode
? "Update the goal details below."
: isCloneMode
- ? "Clone this goal with the same configuration."
- : "Set up a new conversion goal to track specific user actions."}
+ ? "Clone this goal with the same configuration."
+ : "Set up a new conversion goal to track specific user actions."}
</DialogDescription>
</DialogHeader>
diff --git a/client/src/app/[site]/pages/components/PageListItem.tsx b/client/src/app/[site]/pages/components/PageListItem.tsx
index 03d5eecb5..2c080ed10 100644
--- a/client/src/app/[site]/pages/components/PageListItem.tsx
+++ b/client/src/app/[site]/pages/components/PageListItem.tsx
@@ -2,7 +2,7 @@
import { useGetSite } from "@/api/admin/sites";
import { useGetOverviewBucketed } from "@/api/analytics/useGetOverviewBucketed";
-import { SingleColResponse } from "@/api/analytics/useSingleCol";
+import { SingleColResponse } from "@/api/analytics/singleCol/useSingleCol";
import { usePageMetadata } from "@/api/usePageMetadata";
import { Card, CardContent } from "@/components/ui/card";
import { Filter } from "@rybbit/shared";