feat(types): change api return values to a generic type (#6)

.eslintrc

@@ -1,3 +1,6 @@
 {
-  "extends": ["@socialgouv/eslint-config-typescript"]
+  "extends": ["@socialgouv/eslint-config-typescript"],
+  "rules": {
+    "@typescript-eslint/consistent-type-definitions": ["error", "type"]
+  }
 }

package.json

@@ -7,7 +7,7 @@
     "build": "tsc",
     "start": "node dist/src/app.js",
     "k8s": "yarn --silent --cwd .k8s",
-    "lint": "eslint .",
+    "lint": "eslint . -c .eslintrc",
     "test": "jest"
   },
   "author": "Fabrique des ministère sociaux",

src/api-types.ts

@@ -0,0 +1,4 @@
+export type ArchifiltreCountStatistic = {
+  label: string;
+  value: number;
+};

src/matomo/matomo-service.ts

@@ -1,5 +1,6 @@
 import axios from "axios";
 
+import type { ArchifiltreCountStatistic } from "../api-types";
 import { matomoToken, matomoUrl } from "../config";
 import type { MatomoEventCategory } from "./matomo-types";
 import {
@@ -32,5 +33,5 @@ const getBulkMatomoData = async (): Promise<MatomoEventCategory[][]> =>
     })
     .then(({ data }: { data: MatomoEventCategory[][] }) => data);
 
-export const getMatomoData = async (): Promise<MatomoEventCategory[]> =>
+export const getMatomoData = async (): Promise<ArchifiltreCountStatistic[]> =>
   getBulkMatomoData().then(sanitizeMatomoData);

src/matomo/matomo-types.ts

@@ -1,5 +1,5 @@
-export interface MatomoEventCategory {
+export type MatomoEventCategory = {
   label: string;
   // eslint-disable-next-line @typescript-eslint/naming-convention
   nb_events: number;
-}
+};

src/matomo/matomo-utils.test.ts

@@ -39,12 +39,12 @@ describe("matomoUtils", () => {
 
       expect(sanitizeMatomoData(matomoData)).toEqual([
         {
+          count: 10,
           label: "label",
-          nb_events: 10,
         },
         {
+          count: 20,
           label: "label2",
-          nb_events: 20,
         },
       ]);
     });

src/matomo/matomo-utils.ts

@@ -1,11 +1,12 @@
-import { compose, flatten, map, pick } from "lodash/fp";
+import { compose, flatten, map, mapKeys, pick } from "lodash/fp";
 
+import type { ArchifiltreCountStatistic } from "../api-types";
 import type { MatomoEventCategory } from "./matomo-types";
 
-interface CreateMatomoMethodParams {
+type CreateMatomoMethodParams = {
   method: string;
   label: string;
-}
+};
 
 const createMatomoMethod = ({ method, label }: CreateMatomoMethodParams) =>
   `method=${method}&idSite=9&date=2019-04-17,today&period=range&label=${label}`;
@@ -25,9 +26,20 @@ export const getBulkRequestParamsFromLabels = (
       {}
     );
 
+const keysMap: Record<string, string> = {
+  label: "label",
+  // eslint-disable-next-line @typescript-eslint/naming-convention
+  nb_events: "count",
+};
+
+const convertMatomoDataToApiData = mapKeys(
+  (key: string): string => keysMap[key]
+);
+
 export const sanitizeMatomoData: <T extends MatomoEventCategory>(
   matomoApiResponse: T[][]
-) => MatomoEventCategory[] = compose(
+) => ArchifiltreCountStatistic[] = compose(
+  map(convertMatomoDataToApiData),
   map(pick(["label", "nb_events"])),
   flatten
 );