Merge pull request #78 from KasualBusiness/develop

v1.5.1

Author: yourikopecky

.eslintrc.json

@@ -19,7 +19,8 @@
     "prettier/prettier": [
       "error",
       {
-        "singleQuote": true
+        "singleQuote": true,
+        "trailingComma": "none"
       }
     ]
   }

README.md

@@ -258,11 +258,7 @@ const listProducts = async () => {
 
 Operator can be `'start'`, `'end'`, `'contains'` and `'strict'`.
 
-## Tests
-
-```bash
-npm run test
-```
+### References
 
 #### addresses
 
@@ -1017,3 +1013,9 @@ npm run test
 | `create` | body, CustomParams     | Create on custom endpoint       |
 | `update` | id, body, CustomParams | Update on custom endpoint by id |
 | `delete` | id, body, CustomParams | Delete on custom endpoint by id |
+
+## Tests
+
+```bash
+npm run test
+```

package-lock.json

@@ -1,6 +1,6 @@
 {
   "name": "@kasual-business/prestashop-api",
-  "version": "1.5.0",
+  "version": "1.5.1",
   "description": "Prestashop node API",
   "keywords": [
     "prestashop",
@@ -44,19 +44,19 @@
   "author": "Kasual Business",
   "license": "MIT",
   "devDependencies": {
-    "@types/qs": "^6.9.7",
-    "@typescript-eslint/eslint-plugin": "^5.59.8",
-    "@typescript-eslint/parser": "^5.57.0",
-    "eslint": "^8.43.0",
-    "eslint-config-prettier": "^8.8.0",
-    "eslint-plugin-prettier": "^4.2.1",
-    "nock": "^13.3.1",
-    "prettier": "2.8.7",
-    "typescript": "^5.0.2",
-    "vitest": "^0.29.8"
+    "@types/qs": "^6.9.8",
+    "@typescript-eslint/eslint-plugin": "^6.8.0",
+    "@typescript-eslint/parser": "^6.8.0",
+    "eslint": "^8.51.0",
+    "eslint-config-prettier": "^9.0.0",
+    "eslint-plugin-prettier": "^5.0.1",
+    "nock": "^13.3.4",
+    "prettier": "^3.0.3",
+    "typescript": "^5.2.2",
+    "vitest": "^0.34.6"
   },
   "dependencies": {
-    "axios": "^1.4.0",
+    "axios": "^1.5.1",
     "qs": "^6.11.2",
     "xmlbuilder2": "^3.1.1"
   }

package.json

@@ -4,7 +4,7 @@ import {
   GetParams,
   PostParams,
   PutParams,
-  DeleteParams,
+  DeleteParams
 } from '../types/global.type';
 import {
   listCall,
@@ -13,15 +13,15 @@ import {
   putCall,
   deleteCall,
   getSchemaCall,
-  findCall,
+  findCall
 } from '../utils/calls';
 import {
   PrestashopAPIDeleteResponse,
-  PrestashopAPIResponse,
+  PrestashopAPIResponse
 } from '../types/calls.type';
 import {
   handleBodyCreateUpdateAssociations,
-  handleCreateUpdateMultiLanguagesFields,
+  handleCreateUpdateMultiLanguagesFields
 } from '../utils/handlers';
 import { KEYS_TO_DELETE_WHEN_UPDATING } from '../utils/consts';
 
@@ -124,7 +124,7 @@ export class Base<T> {
       // Pre-merge key deletation, some keys block the update of an item
       const listOfKeysToExclude = [
         ...keysToDelete,
-        ...KEYS_TO_DELETE_WHEN_UPDATING,
+        ...KEYS_TO_DELETE_WHEN_UPDATING
       ];
 
       listOfKeysToExclude.forEach(

src/classes/base.class.ts

@@ -20,7 +20,7 @@ export class Custom<Response> {
     const response = await customCall<Response>({
       method: 'GET',
       path: `/${this.endpoint}`,
-      params,
+      params
     });
 
     return response;
@@ -40,7 +40,7 @@ export class Custom<Response> {
     const response = await customCall<Response>({
       method: 'GET',
       path: `/${this.endpoint}${id ? `/${id}` : ''}`,
-      params,
+      params
     });
 
     return response;
@@ -61,7 +61,7 @@ export class Custom<Response> {
       method: 'POST',
       path: `/${this.endpoint}`,
       body,
-      params,
+      params
     });
 
     return response;
@@ -83,7 +83,7 @@ export class Custom<Response> {
       method: 'PUT',
       path: `/${this.endpoint}${id ? `/${id}` : ''}`,
       body,
-      params,
+      params
     });
 
     return response;
@@ -103,7 +103,7 @@ export class Custom<Response> {
     const response = await customCall<Response, Body>({
       method: 'DELETE',
       path: `/${this.endpoint}${id ? `/${id}` : ''}`,
-      params,
+      params
     });
 
     return response;

src/classes/custom.class.ts

@@ -30,7 +30,7 @@ export class Images {
       const response: AxiosResponse = await call({
         method: 'POST',
         path: `/images/${type}/${itemId}`,
-        body: formData,
+        body: formData
       }).catch((error) => {
         return error.response;
       });
@@ -46,7 +46,7 @@ export class Images {
         method: 'POST',
         path: `/images/${type}/${itemId}`,
         body: formData,
-        headers: formData.getHeaders(),
+        headers: formData.getHeaders()
       }).catch((error) => {
         return error.response;
       });
@@ -73,7 +73,7 @@ export class Images {
     const response = await customCall<ArrayBuffer>({
       method: 'GET',
       path: `/images/${type}/${itemId}/${imageId}`,
-      responseType: 'arraybuffer',
+      responseType: 'arraybuffer'
     });
 
     return response;
@@ -96,7 +96,7 @@ export class Images {
   ): Promise<PrestashopAPIDeleteResponse | undefined> => {
     const response = await customCall<PrestashopAPIDeleteResponse>({
       method: 'DELETE',
-      path: `/images/${type}/${itemId}/${imageId}`,
+      path: `/images/${type}/${itemId}/${imageId}`
     });
 
     return response;

src/classes/images.class.ts

@@ -3,3 +3,4 @@ export * from './custom.class';
 export * from './images.class';
 export * from './stock-movements.class';
 export * from './stocks.class';
+export * from './search.class';

src/classes/index.ts

@@ -0,0 +1,42 @@
+import {
+  PrestashopAPIResponse,
+  SearchParams,
+  SearchResponse
+} from '../types/calls.type';
+import { customCall } from '../utils/calls';
+
+export class Search {
+  /**
+   * Search function.
+   *
+   * @param params
+   * @returns
+   */
+  find = async (
+    params: SearchParams | undefined = {
+      value: '',
+      languageId: -1
+    }
+  ): Promise<PrestashopAPIResponse<SearchResponse>> => {
+    const searchParams = new URLSearchParams();
+
+    searchParams.append('query', params.value);
+    searchParams.append('language', params.languageId.toString());
+
+    const response = await customCall<Partial<SearchResponse>>({
+      method: 'GET',
+      path: '/search',
+      params: {
+        customSearchParams: searchParams
+      }
+    });
+
+    return {
+      data: {
+        products: response?.products || [],
+        categories: response?.categories || []
+      },
+      errors: response?.errors
+    };
+  };
+}

src/classes/search.class.ts

@@ -4,11 +4,11 @@ import {
   GetParams,
   ListParams,
   PostParams,
-  PutParams,
+  PutParams
 } from '../types/global.type';
 import {
   PrestashopAPIResponse,
-  StockMovementsResponse,
+  StockMovementsResponse
 } from '../types/calls.type';
 import { customCall } from '../utils/calls';
 
@@ -25,12 +25,12 @@ export class StockMovements {
     const response = await customCall<Partial<StockMovementsResponse>>({
       method: 'GET',
       path: '/stock_mvt',
-      params,
+      params
     });
 
     return {
       data: response?.stock_movements || [],
-      errors: response?.errors,
+      errors: response?.errors
     };
   };
 
@@ -48,19 +48,19 @@ export class StockMovements {
     const response = await customCall<StockMovementsResponse>({
       method: 'GET',
       path: `/stock_mvt/${id}`,
-      params,
+      params
     });
 
     if (response?.stock_movements && response?.stock_movements.length > 0) {
       return {
         data: response?.stock_movements[0] || [],
-        errors: response?.errors,
+        errors: response?.errors
       };
     }
 
     return {
       data: undefined,
-      errors: response?.errors,
+      errors: response?.errors
     };
   };
 
@@ -79,19 +79,19 @@ export class StockMovements {
       method: 'POST',
       path: '/stock_mvt',
       body: { stock_mvt: body },
-      params,
+      params
     });
 
     if (response?.stock_movements && response?.stock_movements.length > 0) {
       return {
         data: response?.stock_movements[0] || [],
-        errors: response?.errors,
+        errors: response?.errors
       };
     }
 
     return {
       data: undefined,
-      errors: response?.errors,
+      errors: response?.errors
     };
   };
 
@@ -112,19 +112,19 @@ export class StockMovements {
       method: 'PUT',
       path: `/stock_mvt/${id}`,
       body: { stock_mvt: body },
-      params,
+      params
     });
 
     if (response?.stock_movements && response?.stock_movements.length > 0) {
       return {
         data: response?.stock_movements[0] || [],
-        errors: response?.errors,
+        errors: response?.errors
       };
     }
 
     return {
       data: undefined,
-      errors: response?.errors,
+      errors: response?.errors
     };
   };
 
@@ -142,19 +142,19 @@ export class StockMovements {
     const response = await customCall<StockMovementsResponse>({
       method: 'DELETE',
       path: `/stock_mvt/${id}`,
-      params,
+      params
     });
 
     if (response?.stock_movements && response?.stock_movements.length > 0) {
       return {
         data: response?.stock_movements[0] || [],
-        errors: response?.errors,
+        errors: response?.errors
       };
     }
 
     return {
       data: undefined,
-      errors: response?.errors,
+      errors: response?.errors
     };
   };
 }