Integration category (#4)

* Support search by category endpoint

* added category lists

---------

Co-authored-by: Perceval Faramaz <[email protected]>

Author: aliyss

src/api/MigrosAPI.ts

@@ -21,6 +21,10 @@ import {
   IProductSearchOptions,
 } from "./onesearch-oc-seaapi/product-search";
 import { migusto } from "./migusto";
+import {
+  ICategoryListBody,
+  ICategoryListOptions,
+} from "./onesearch-oc-seaapi/category";
 
 export class MigrosAPI {
   private _leShopToken: string | undefined;
@@ -118,6 +122,22 @@ export class MigrosAPI {
       },
     },
     productSearch: {
+      categoryList: async (
+        categoryListBody: ICategoryListBody,
+        categoryListOptions?: ICategoryListOptions,
+        token: string | undefined = this.leShopToken,
+      ): Promise<any> => {
+        if (!token) {
+          throw Error("LeShop Token is undefined");
+        }
+        return await productSearch.listCategories(
+          categoryListBody,
+          {
+            leshopch: token,
+          },
+          categoryListOptions,
+        );
+      },
       searchProduct: async (
         productSearchBody: IProductSearchBody,
         productSearchOptions?: IProductSearchOptions,

src/api/apiPaths.ts

@@ -5,6 +5,7 @@ const defaultMigustoApiPath = "https://migusto.migros.ch";
 export const migrosApiPaths = {
   ["onesearch-oc-seapi"]: {
     public: {
+      v3: defaultMigrosApiPath + "/onesearch-oc-seaapi/public/v3",
       v4: defaultMigrosApiPath + "/onesearch-oc-seaapi/public/v4",
       v5: defaultMigrosApiPath + "/onesearch-oc-seaapi/public/v5",
     },

src/api/onesearch-oc-seaapi/category.ts

@@ -0,0 +1,79 @@
+import { Region } from "../enums/Region";
+import { Language } from "../enums/Language";
+import { Algorithm } from "../enums/Algorithm";
+import { SortFields } from "../enums/SortFields";
+import { SortOrder } from "../enums/SortOrder";
+
+import { postRequest } from "../../utils/requests";
+
+import { migrosApiPaths } from "../apiPaths";
+import { IMigrosNecessaryHeaders } from "../interfaces/headers";
+
+const url = migrosApiPaths["onesearch-oc-seapi"].public.v3 + "/search/category";
+
+// eslint-disable-next-line @typescript-eslint/naming-convention
+export type ICategoryListOptions = Record<string, any>;
+
+const defaultCategoryListOptions: ICategoryListOptions = {};
+
+export interface ICategoryListBody extends Record<string, any> {
+  algorithm?: Algorithm;
+  categoryId: number;
+  filters?: Record<any, any>;
+  from: number;
+  language?: Language;
+  productIds?: string[];
+  regionId?: Region;
+  requestSponsoredProducts?: boolean;
+  sortFields?: SortFields[];
+  sortOrder?: SortOrder;
+}
+
+const defaultCategoryListBody: ICategoryListBody = {
+  algorithm: Algorithm.DEFAULT,
+  regionId: Region.NATIONAL,
+  language: Language.EN,
+  productIds: [],
+  sortFields: [],
+  sortOrder: SortOrder.ASC,
+  requestSponsoredProducts: false,
+  from: 0,
+  categoryId: 0,
+};
+
+async function postCategoryListRequest(
+  url: string,
+  body: ICategoryListBody,
+  options: ICategoryListOptions,
+  headers: IMigrosNecessaryHeaders,
+): Promise<Record<string, any>> {
+  const necessaryHeaders = {
+    accept: "application/json, text/plain, *!/!*",
+    // eslint-disable-next-line @typescript-eslint/naming-convention
+    "content-type": "application/json",
+    ...headers,
+  };
+
+  const response = await postRequest(url, body, options, necessaryHeaders);
+
+  return await response.json();
+}
+
+export async function categoryList(
+  categoryListBody: ICategoryListBody,
+  headers: IMigrosNecessaryHeaders,
+  categoryListOptions?: ICategoryListOptions,
+): Promise<any> {
+  categoryListOptions = {
+    ...defaultCategoryListOptions,
+    ...categoryListOptions,
+  };
+  categoryListBody = { ...defaultCategoryListBody, ...categoryListBody };
+
+  return postCategoryListRequest(
+    url,
+    categoryListBody,
+    categoryListOptions,
+    headers,
+  );
+}

src/api/onesearch-oc-seaapi/index.ts

@@ -1,5 +1,7 @@
 import { postProductSearch } from "./product-search";
+import { categoryList } from "./category";
 
 export const productSearch = {
-	searchProduct: postProductSearch
-}
+  searchProduct: postProductSearch,
+  listCategories: categoryList,
+};

tests/category-list.test.ts

@@ -0,0 +1,22 @@
+import { describe, expect, test } from "@jest/globals";
+import { MigrosAPI } from "../src";
+import { ICategoryListBody } from "../src/api/onesearch-oc-seaapi/category";
+
+describe("Get a list of categories", () => {
+  test("Search for Dairy", async () => {
+    const guestInfo = await MigrosAPI.account.oauth2.getGuestToken();
+    const categoryListBody: ICategoryListBody = {
+      from: 0,
+      categoryId: 7494731,
+    };
+    const response = await MigrosAPI.products.productSearch.listCategories(
+      categoryListBody,
+      {
+        leshopch: guestInfo.token,
+      },
+    );
+    expect(response.categories[0].name).toBe(
+      "Dairy, eggs & fresh convenience food",
+    );
+  });
+});

tests/migusto-recipe-products.test.ts

@@ -12,6 +12,6 @@ describe("Search for recipe products", () => {
     };
     const response =
       await MigrosAPI.migusto.recipeProducts(recipeProductOptions);
-    expect(response.productIds).toContain("103322000000");
+    expect(response.productIds).toContain("220221000110");
   });
 });