feat: add available filters endpoint

Author: siiick

packages/app-builder/src/models/analytics/available-filters.ts

@@ -0,0 +1,37 @@
+import { type AvailableFiltersRequestDto, type AvailableFiltersResponseDto } from 'marble-api';
+import * as R from 'remeda';
+
+export type AvailableFilterType = 'string' | 'number' | 'boolean';
+export type FiltersTypes = 'triggerObject';
+
+export type AvailableFiltersRequest = {
+  scenarioId: string;
+  start: string;
+  end: string;
+};
+
+export type AvailableFiltersResponse = {
+  name: string;
+  type: AvailableFilterType;
+  source: FiltersTypes;
+}[];
+
+export const adaptAvailableFiltersResponse = (
+  response: AvailableFiltersResponseDto,
+): AvailableFiltersResponse => {
+  return response.map((item) => ({
+    name: item.name,
+    type: item.type as AvailableFilterType,
+    source: R.toCamelCase(item.source) as FiltersTypes,
+  }));
+};
+
+export const transformAvailableFiltersRequest = (
+  request: AvailableFiltersRequest,
+): AvailableFiltersRequestDto => {
+  return {
+    scenario_id: request.scenarioId,
+    start: request.start,
+    end: request.end,
+  };
+};

packages/app-builder/src/models/analytics/index.ts

@@ -1,3 +1,4 @@
+export * from './available-filters';
 export * from './decisions-outcomes-perday';
 export * as legacyAnalytics from './legacy-analytics';
 

packages/app-builder/src/queries/analytics/get-available-filters.ts

@@ -0,0 +1,37 @@
+import { useAgnosticNavigation } from '@app-builder/contexts/AgnosticNavigationContext';
+import { AvailableFiltersResponse } from '@app-builder/models/analytics/available-filters';
+import { getRoute } from '@app-builder/utils/routes';
+import { useQuery } from '@tanstack/react-query';
+
+export const useGetAvailableFilters = ({
+  scenarioId,
+  dateRange,
+}: {
+  scenarioId: string;
+  dateRange: { start: string; end: string };
+}) => {
+  const navigate = useAgnosticNavigation();
+
+  const endpoint = getRoute('/ressources/analytics/available_filters/:scenarioId', {
+    scenarioId,
+  });
+  return useQuery({
+    queryKey: ['analytics', 'available-filters', scenarioId, dateRange],
+    queryFn: async () => {
+      const response = await fetch(endpoint, {
+        method: 'POST',
+        headers: {
+          'Content-Type': 'application/json',
+        },
+        body: JSON.stringify({ scenarioId, start: dateRange.start, end: dateRange.end }),
+      });
+      const result = await response.json();
+      if (result.redirectTo) {
+        navigate(result.redirectTo);
+        return;
+      }
+
+      return result as Promise<AvailableFiltersResponse>;
+    },
+  });
+};

packages/app-builder/src/repositories/AnalyticsRepository.ts

@@ -9,6 +9,12 @@ import {
   mergeDateRanges,
   transformDecisionOutcomesPerDayQuery,
 } from '@app-builder/models/analytics';
+import {
+  type AvailableFiltersRequest,
+  type AvailableFiltersResponse,
+  adaptAvailableFiltersResponse,
+  transformAvailableFiltersRequest,
+} from '@app-builder/models/analytics/available-filters';
 
 import { compareAsc, compareDesc, differenceInDays } from 'date-fns';
 
@@ -17,6 +23,7 @@ export interface AnalyticsRepository {
   getDecisionOutcomesPerDay(
     args: DecisionOutcomesPerDayQuery,
   ): Promise<DecisionOutcomesPerPeriod | null>;
+  getAvailableFilters(args: AvailableFiltersRequest): Promise<AvailableFiltersResponse>;
 }
 
 export function makeGetAnalyticsRepository() {
@@ -85,5 +92,13 @@ export function makeGetAnalyticsRepository() {
         return null;
       }
     },
+
+    getAvailableFilters: async (
+      args: AvailableFiltersRequest,
+    ): Promise<AvailableFiltersResponse> => {
+      return client
+        .getAvailableFilters(transformAvailableFiltersRequest(args))
+        .then((response) => adaptAvailableFiltersResponse(response));
+    },
   });
 }

packages/app-builder/src/routes/ressources+/analytics+/available_filters.$scenarioId.ts

@@ -0,0 +1,30 @@
+import { initServerServices } from '@app-builder/services/init.server';
+import { getRoute } from '@app-builder/utils/routes';
+import { ActionFunctionArgs } from '@remix-run/node';
+import { z } from 'zod/v4';
+
+const urlParamsSchema = z.object({
+  scenarioId: z.uuidv4(),
+});
+
+const queryParamsSchema = z.object({
+  start: z.iso.datetime(),
+  end: z.iso.datetime(),
+});
+
+export async function action({ request, params }: ActionFunctionArgs) {
+  const { authService } = initServerServices(request);
+  const { analytics } = await authService.isAuthenticated(request, {
+    failureRedirect: getRoute('/sign-in'),
+  });
+
+  const urlParams = urlParamsSchema.parse(params);
+  const queryParams = queryParamsSchema.parse(await request.json());
+
+  const query = await analytics.getAvailableFilters({
+    scenarioId: urlParams.scenarioId,
+    start: queryParams.start,
+    end: queryParams.end,
+  });
+  return Response.json(query);
+}

packages/app-builder/src/utils/routes/routes.ts

@@ -370,6 +370,11 @@ export const routes = [
         "path": "healthcheck",
         "file": "routes/healthcheck.ts"
       },
+      {
+        "id": "routes/ressources+/analytics+/available_filters.$scenarioId",
+        "path": "ressources/analytics/available_filters/:scenarioId",
+        "file": "routes/ressources+/analytics+/available_filters.$scenarioId.ts"
+      },
       {
         "id": "routes/ressources+/analytics+/decisions_outcomes_per_day.$scenarioId",
         "path": "ressources/analytics/decisions_outcomes_per_day/:scenarioId",

packages/app-builder/src/utils/routes/types.ts

@@ -53,6 +53,7 @@ export type RoutePath =
   | '/upload/:objectType'
   | '/app-router'
   | '/healthcheck'
+  | '/ressources/analytics/available_filters/:scenarioId'
   | '/ressources/analytics/decisions_outcomes_per_day/:scenarioId'
   | '/ressources/analytics/query/:queryName'
   | '/ressources/annotations/download-file/:annotationId/:fileId'
@@ -246,6 +247,7 @@ export type RouteID =
   | 'routes/_index'
   | 'routes/app-router'
   | 'routes/healthcheck'
+  | 'routes/ressources+/analytics+/available_filters.$scenarioId'
   | 'routes/ressources+/analytics+/decisions_outcomes_per_day.$scenarioId'
   | 'routes/ressources+/analytics+/query.$queryName'
   | 'routes/ressources+/annotations+/download-file.$annotationId.$fileId'