refactor(api): Introduce unified API layer for freight backoffice

apps/edr-freight-web/backoffice/src/hooks/hooks/useBookings.ts

@@ -1,16 +0,0 @@
-import { useQuery } from "@tanstack/react-query";
-
-import { bookingsService } from "../services/bookings.service";
-
-export const useBookings = () =>
-  useQuery({
-    queryKey: ["bookings"],
-    queryFn: bookingsService.list,
-  });
-
-export const useBooking = (id: string) =>
-  useQuery({
-    queryKey: ["bookings", id],
-    queryFn: () => bookingsService.get(id),
-    enabled: Boolean(id),
-  });

apps/edr-freight-web/backoffice/src/hooks/hooks/useConsignments.ts

@@ -1,16 +0,0 @@
-import { useQuery } from "@tanstack/react-query";
-
-import { consignmentsService } from "../services/consignments.service";
-
-export const useConsignments = () =>
-  useQuery({
-    queryKey: ["consignments"],
-    queryFn: consignmentsService.list,
-  });
-
-export const useConsignment = (id: string) =>
-  useQuery({
-    queryKey: ["consignments", id],
-    queryFn: () => consignmentsService.get(id),
-    enabled: Boolean(id),
-  });

apps/edr-freight-web/backoffice/src/hooks/hooks/useCustomers.ts

@@ -1,50 +0,0 @@
-import { useMutation, useQuery, useQueryClient } from "@tanstack/react-query";
-
-import { customersService } from "@/services/customers.service";
-import type {
-  CreateCustomerDto,
-  UpdateCustomerDto,
-} from "@/types/customers";
-
-const KEY = ["customers"] as const;
-
-export const useCustomers = () =>
-  useQuery({
-    queryKey: KEY,
-    queryFn: customersService.list,
-  });
-
-export const useCustomer = (id: string | undefined) =>
-  useQuery({
-    queryKey: [...KEY, "id", id],
-    queryFn: () => customersService.getById(id!),
-    enabled: Boolean(id),
-  });
-
-export const useCreateCustomer = () => {
-  const qc = useQueryClient();
-  return useMutation({
-    mutationFn: (dto: CreateCustomerDto) => customersService.create(dto),
-    onSuccess: () => qc.invalidateQueries({ queryKey: KEY }),
-  });
-};
-
-export const useUpdateCustomer = () => {
-  const qc = useQueryClient();
-  return useMutation({
-    mutationFn: ({ id, dto }: { id: string; dto: UpdateCustomerDto }) =>
-      customersService.update(id, dto),
-    onSuccess: (_data, { id }) => {
-      qc.invalidateQueries({ queryKey: KEY });
-      qc.invalidateQueries({ queryKey: [...KEY, "id", id] });
-    },
-  });
-};
-
-export const useDeleteCustomer = () => {
-  const qc = useQueryClient();
-  return useMutation({
-    mutationFn: (id: string) => customersService.remove(id),
-    onSuccess: () => qc.invalidateQueries({ queryKey: KEY }),
-  });
-};

apps/edr-freight-web/backoffice/src/hooks/hooks/useTracking.ts

@@ -1,10 +0,0 @@
-import { useQuery } from "@tanstack/react-query";
-
-import { trackingService } from "../services/tracking.service";
-
-export const useTracking = (consignmentId: string) =>
-  useQuery({
-    queryKey: ["tracking", consignmentId],
-    queryFn: () => trackingService.forConsignment(consignmentId),
-    enabled: Boolean(consignmentId),
-  });

apps/edr-freight-web/backoffice/src/hooks/rule-engine/useRuleEngine.ts

@@ -1,11 +1,8 @@
 import { useMutation, useQuery, useQueryClient } from "@tanstack/react-query";
 import toast from "react-hot-toast";
 
-import { QUERY_KEYS } from "@/constants/TANSTACK_QUEY_KEY";
-import {
-  ruleEngineService,
-  type RuleEngineListParams,
-} from "@/services/ruleEngine/ruleEngine.service";
+import { api } from "@/services/api";
+import type { RuleEngineListParams } from "@/services/ruleEngine/ruleEngine.service";
 import { RULE_ENGINE_SELECT_NONE } from "@/pages/ruleEngine/config/resources";
 import type {
   ApproveRatePayload,
@@ -15,26 +12,29 @@ import type {
 
 const CARGO_TYPE_PARENT_PAGE_SIZE = 500;
 
+const listKey = (resource: RuleEngineResourceSlug) =>
+  ["rule-engine", resource] as const;
+
 export const useRuleEngineList = (
   resource: RuleEngineResourceSlug,
   params: RuleEngineListParams,
 ) =>
-  useQuery({
-    queryKey: [...QUERY_KEYS.RULE_ENGINE.list(resource), params],
-    queryFn: () => ruleEngineService.list<RuleEngineRecord>(resource, params),
-  });
+  useQuery(
+    api.ruleEngine.list.queryOptions({
+      input: { resource, params },
+    }),
+  );
 
 export const useCargoTypeParentOptions = (excludeId?: string, enabled = true) =>
   useQuery({
-    queryKey: [
-      ...QUERY_KEYS.RULE_ENGINE.list("cargo-types"),
-      "parent-options",
-      excludeId ?? "",
-    ],
+    queryKey: api.ruleEngine.list.queryKey({
+      resource: "cargo-types",
+      params: { page: 1, pageSize: CARGO_TYPE_PARENT_PAGE_SIZE },
+    }),
     queryFn: () =>
-      ruleEngineService.list<RuleEngineRecord>("cargo-types", {
-        page: 1,
-        pageSize: CARGO_TYPE_PARENT_PAGE_SIZE,
+      api.ruleEngine.list.call({
+        resource: "cargo-types",
+        params: { page: 1, pageSize: CARGO_TYPE_PARENT_PAGE_SIZE },
       }),
     enabled,
     select: (result) => {
@@ -45,7 +45,9 @@ export const useCargoTypeParentOptions = (excludeId?: string, enabled = true) =>
           const name = String(row.cargoTypeName ?? "").trim();
           const code = String(row.code ?? "").trim();
           const label =
-            name && code ? `${name} (${code})` : name || code || String(row.id);
+            name && code
+              ? `${name} (${code})`
+              : name || code || String(row.id);
           return { label, value: String(row.id) };
         });
       return [noneOption, ...parents];
@@ -53,20 +55,20 @@ export const useCargoTypeParentOptions = (excludeId?: string, enabled = true) =>
   });
 
 export const useApprovalChain = (enabled: boolean) =>
-  useQuery({
-    queryKey: QUERY_KEYS.RULE_ENGINE.chain,
-    queryFn: () => ruleEngineService.getApprovalChain(),
-    enabled,
-  });
+  useQuery(
+    api.ruleEngine.getApprovalChain.queryOptions({
+      enabled,
+    }),
+  );
 
 export const useRuleEngineMutations = (resource: RuleEngineResourceSlug) => {
   const qc = useQueryClient();
   const invalidate = () =>
-    qc.invalidateQueries({ queryKey: QUERY_KEYS.RULE_ENGINE.list(resource) });
+    qc.invalidateQueries({ queryKey: listKey(resource) });
 
   const create = useMutation({
     mutationFn: (payload: Record<string, unknown>) =>
-      ruleEngineService.create(resource, payload),
+      api.ruleEngine.create.call({ resource, payload }),
     onSuccess: () => {
       toast.success("Created successfully");
       invalidate();
@@ -81,7 +83,7 @@ export const useRuleEngineMutations = (resource: RuleEngineResourceSlug) => {
     }: {
       id: string;
       payload: Record<string, unknown>;
-    }) => ruleEngineService.update(resource, id, payload),
+    }) => api.ruleEngine.update.call({ resource, id, payload }),
     onSuccess: () => {
       toast.success("Updated successfully");
       invalidate();
@@ -90,7 +92,8 @@ export const useRuleEngineMutations = (resource: RuleEngineResourceSlug) => {
   });
 
   const remove = useMutation({
-    mutationFn: (id: string) => ruleEngineService.remove(resource, id),
+    mutationFn: (id: string) =>
+      api.ruleEngine.remove.call({ resource, id }),
     onSuccess: () => {
       toast.success("Deleted successfully");
       invalidate();
@@ -104,10 +107,10 @@ export const useRuleEngineMutations = (resource: RuleEngineResourceSlug) => {
 export const useRateWorkflow = () => {
   const qc = useQueryClient();
   const invalidate = () =>
-    qc.invalidateQueries({ queryKey: QUERY_KEYS.RULE_ENGINE.list("rates") });
+    qc.invalidateQueries({ queryKey: listKey("rates") });
 
   const submit = useMutation({
-    mutationFn: (id: string) => ruleEngineService.submitRate(id),
+    mutationFn: (id: string) => api.ruleEngine.submitRate.call({ id }),
     onSuccess: () => {
       toast.success("Rate submitted for approval");
       invalidate();
@@ -116,8 +119,13 @@ export const useRateWorkflow = () => {
   });
 
   const approve = useMutation({
-    mutationFn: ({ id, payload }: { id: string; payload: ApproveRatePayload }) =>
-      ruleEngineService.approveRate(id, payload),
+    mutationFn: ({
+      id,
+      payload,
+    }: {
+      id: string;
+      payload: ApproveRatePayload;
+    }) => api.ruleEngine.approveRate.call({ id, payload }),
     onSuccess: () => {
       toast.success("Rate approved");
       invalidate();

apps/edr-freight-web/backoffice/src/hooks/useDropdownSettings.ts

@@ -1,6 +1,6 @@
-import { useMutation, useQuery, useQueryClient } from "@tanstack/react-query";
+import { useMutation, useQueryClient } from "@tanstack/react-query";
 
-import { dropdownSettingsService } from "@/services/dropdownSettings.service";
+import { api } from "@/services/api";
 import type {
   CreateDropdownOptionDto,
   CreateDropdownSettingDto,
@@ -8,38 +8,15 @@ import type {
   UpdateDropdownSettingDto,
 } from "@/types/dropdownSettings";
 
-const KEY = ["dropdown-settings"] as const;
-
-/* ------------------------------ Queries ------------------------------ */
-
-export const useDropdownSettings = () =>
-  useQuery({
-    queryKey: KEY,
-    queryFn: dropdownSettingsService.list,
-  });
-
-export const useDropdownSetting = (id: string) =>
-  useQuery({
-    queryKey: [...KEY, "id", id],
-    queryFn: () => dropdownSettingsService.getById(id),
-    enabled: Boolean(id),
-  });
-
-export const useDropdownSettingByCode = (code: string) =>
-  useQuery({
-    queryKey: [...KEY, "code", code],
-    queryFn: () => dropdownSettingsService.getByCode(code),
-    enabled: Boolean(code),
-  });
-
 /* ----------------------------- Mutations ----------------------------- */
 
 export const useCreateDropdownSetting = () => {
   const qc = useQueryClient();
   return useMutation({
     mutationFn: (dto: CreateDropdownSettingDto) =>
-      dropdownSettingsService.create(dto),
-    onSuccess: () => qc.invalidateQueries({ queryKey: KEY }),
+      api.dropdownSettings.create.call(dto),
+    onSuccess: () =>
+      qc.invalidateQueries({ queryKey: api.dropdownSettings.list.queryKey() }),
   });
 };
 
@@ -52,10 +29,12 @@ export const useUpdateDropdownSetting = () => {
     }: {
       id: string;
       dto: UpdateDropdownSettingDto;
-    }) => dropdownSettingsService.update(id, dto),
+    }) => api.dropdownSettings.update.call({ id, dto }),
     onSuccess: (_data, { id }) => {
-      qc.invalidateQueries({ queryKey: KEY });
-      qc.invalidateQueries({ queryKey: [...KEY, "id", id] });
+      qc.invalidateQueries({ queryKey: api.dropdownSettings.list.queryKey() });
+      qc.invalidateQueries({
+        queryKey: api.dropdownSettings.getById.queryKey({ id }),
+      });
     },
   });
 };
@@ -63,8 +42,9 @@ export const useUpdateDropdownSetting = () => {
 export const useDeleteDropdownSetting = () => {
   const qc = useQueryClient();
   return useMutation({
-    mutationFn: (id: string) => dropdownSettingsService.remove(id),
-    onSuccess: () => qc.invalidateQueries({ queryKey: KEY }),
+    mutationFn: (id: string) => api.dropdownSettings.remove.call({ id }),
+    onSuccess: () =>
+      qc.invalidateQueries({ queryKey: api.dropdownSettings.list.queryKey() }),
   });
 };
 
@@ -77,10 +57,12 @@ export const useReplaceDropdownOptions = () => {
     }: {
       settingId: string;
       options: CreateDropdownOptionDto[];
-    }) => dropdownSettingsService.replaceOptions(settingId, options),
+    }) => api.dropdownSettings.replaceOptions.call({ id: settingId, options }),
     onSuccess: (_data, { settingId }) => {
-      qc.invalidateQueries({ queryKey: KEY });
-      qc.invalidateQueries({ queryKey: [...KEY, "id", settingId] });
+      qc.invalidateQueries({ queryKey: api.dropdownSettings.list.queryKey() });
+      qc.invalidateQueries({
+        queryKey: api.dropdownSettings.getById.queryKey({ id: settingId }),
+      });
     },
   });
 };
@@ -94,10 +76,12 @@ export const useAddDropdownOption = () => {
     }: {
       settingId: string;
       dto: CreateDropdownOptionDto;
-    }) => dropdownSettingsService.addOption(settingId, dto),
+    }) => api.dropdownSettings.addOption.call({ id: settingId, dto }),
     onSuccess: (_data, { settingId }) => {
-      qc.invalidateQueries({ queryKey: KEY });
-      qc.invalidateQueries({ queryKey: [...KEY, "id", settingId] });
+      qc.invalidateQueries({ queryKey: api.dropdownSettings.list.queryKey() });
+      qc.invalidateQueries({
+        queryKey: api.dropdownSettings.getById.queryKey({ id: settingId }),
+      });
     },
   });
 };
@@ -111,8 +95,9 @@ export const useUpdateDropdownOption = () => {
     }: {
       optionId: string;
       dto: UpdateDropdownOptionDto;
-    }) => dropdownSettingsService.updateOption(optionId, dto),
-    onSuccess: () => qc.invalidateQueries({ queryKey: KEY }),
+    }) => api.dropdownSettings.updateOption.call({ optionId, dto }),
+    onSuccess: () =>
+      qc.invalidateQueries({ queryKey: api.dropdownSettings.list.queryKey() }),
   });
 };
 
@@ -120,7 +105,8 @@ export const useRemoveDropdownOption = () => {
   const qc = useQueryClient();
   return useMutation({
     mutationFn: (optionId: string) =>
-      dropdownSettingsService.removeOption(optionId),
-    onSuccess: () => qc.invalidateQueries({ queryKey: KEY }),
+      api.dropdownSettings.removeOption.call({ optionId }),
+    onSuccess: () =>
+      qc.invalidateQueries({ queryKey: api.dropdownSettings.list.queryKey() }),
   });
 };

apps/edr-freight-web/backoffice/src/hooks/useFileUploadSettings.ts

@@ -1,6 +1,6 @@
-import { useMutation, useQuery, useQueryClient } from "@tanstack/react-query";
+import { useMutation, useQueryClient } from "@tanstack/react-query";
 
-import { fileUploadSettingsService } from "@/services/fileUploadSettings.service";
+import { api } from "@/services/api";
 import type {
   CreateFileUploadFieldDto,
   CreateFileUploadSettingDto,
@@ -8,38 +8,17 @@ import type {
   UpdateFileUploadSettingDto,
 } from "@/types/fileUploadSettings";
 
-const KEY = ["file-upload-settings"] as const;
-
-/* ------------------------------ Queries ------------------------------ */
-
-export const useFileUploadSettings = () =>
-  useQuery({
-    queryKey: KEY,
-    queryFn: fileUploadSettingsService.list,
-  });
-
-export const useFileUploadSetting = (id: string) =>
-  useQuery({
-    queryKey: [...KEY, "id", id],
-    queryFn: () => fileUploadSettingsService.getById(id),
-    enabled: Boolean(id),
-  });
-
-export const useFileUploadSettingByCode = (code: string) =>
-  useQuery({
-    queryKey: [...KEY, "code", code],
-    queryFn: () => fileUploadSettingsService.getByCode(code),
-    enabled: Boolean(code),
-  });
-
 /* ----------------------------- Mutations ----------------------------- */
 
 export const useCreateFileUploadSetting = () => {
   const qc = useQueryClient();
   return useMutation({
     mutationFn: (dto: CreateFileUploadSettingDto) =>
-      fileUploadSettingsService.create(dto),
-    onSuccess: () => qc.invalidateQueries({ queryKey: KEY }),
+      api.fileUploadSettings.create.call(dto),
+    onSuccess: () =>
+      qc.invalidateQueries({
+        queryKey: api.fileUploadSettings.list.queryKey(),
+      }),
   });
 };
 
@@ -52,10 +31,14 @@ export const useUpdateFileUploadSetting = () => {
     }: {
       id: string;
       dto: UpdateFileUploadSettingDto;
-    }) => fileUploadSettingsService.update(id, dto),
+    }) => api.fileUploadSettings.update.call({ id, dto }),
     onSuccess: (_data, { id }) => {
-      qc.invalidateQueries({ queryKey: KEY });
-      qc.invalidateQueries({ queryKey: [...KEY, "id", id] });
+      qc.invalidateQueries({
+        queryKey: api.fileUploadSettings.list.queryKey(),
+      });
+      qc.invalidateQueries({
+        queryKey: api.fileUploadSettings.getById.queryKey({ id }),
+      });
     },
   });
 };
@@ -63,8 +46,11 @@ export const useUpdateFileUploadSetting = () => {
 export const useDeleteFileUploadSetting = () => {
   const qc = useQueryClient();
   return useMutation({
-    mutationFn: (id: string) => fileUploadSettingsService.remove(id),
-    onSuccess: () => qc.invalidateQueries({ queryKey: KEY }),
+    mutationFn: (id: string) => api.fileUploadSettings.remove.call({ id }),
+    onSuccess: () =>
+      qc.invalidateQueries({
+        queryKey: api.fileUploadSettings.list.queryKey(),
+      }),
   });
 };
 
@@ -77,10 +63,14 @@ export const useReplaceFileUploadFields = () => {
     }: {
       settingId: string;
       fields: CreateFileUploadFieldDto[];
-    }) => fileUploadSettingsService.replaceFields(settingId, fields),
+    }) => api.fileUploadSettings.replaceFields.call({ id: settingId, fields }),
     onSuccess: (_data, { settingId }) => {
-      qc.invalidateQueries({ queryKey: KEY });
-      qc.invalidateQueries({ queryKey: [...KEY, "id", settingId] });
+      qc.invalidateQueries({
+        queryKey: api.fileUploadSettings.list.queryKey(),
+      });
+      qc.invalidateQueries({
+        queryKey: api.fileUploadSettings.getById.queryKey({ id: settingId }),
+      });
     },
   });
 };
@@ -94,10 +84,14 @@ export const useAddFileUploadField = () => {
     }: {
       settingId: string;
       dto: CreateFileUploadFieldDto;
-    }) => fileUploadSettingsService.addField(settingId, dto),
+    }) => api.fileUploadSettings.addField.call({ settingId, dto }),
     onSuccess: (_data, { settingId }) => {
-      qc.invalidateQueries({ queryKey: KEY });
-      qc.invalidateQueries({ queryKey: [...KEY, "id", settingId] });
+      qc.invalidateQueries({
+        queryKey: api.fileUploadSettings.list.queryKey(),
+      });
+      qc.invalidateQueries({
+        queryKey: api.fileUploadSettings.getById.queryKey({ id: settingId }),
+      });
     },
   });
 };
@@ -111,8 +105,11 @@ export const useUpdateFileUploadField = () => {
     }: {
       fieldId: string;
       dto: UpdateFileUploadFieldDto;
-    }) => fileUploadSettingsService.updateField(fieldId, dto),
-    onSuccess: () => qc.invalidateQueries({ queryKey: KEY }),
+    }) => api.fileUploadSettings.updateField.call({ fieldId, dto }),
+    onSuccess: () =>
+      qc.invalidateQueries({
+        queryKey: api.fileUploadSettings.list.queryKey(),
+      }),
   });
 };
 
@@ -120,7 +117,10 @@ export const useRemoveFileUploadField = () => {
   const qc = useQueryClient();
   return useMutation({
     mutationFn: (fieldId: string) =>
-      fileUploadSettingsService.removeField(fieldId),
-    onSuccess: () => qc.invalidateQueries({ queryKey: KEY }),
+      api.fileUploadSettings.removeField.call({ fieldId }),
+    onSuccess: () =>
+      qc.invalidateQueries({
+        queryKey: api.fileUploadSettings.list.queryKey(),
+      }),
   });
 };