Implemented: code to define success response schema(#85zrhhcgr)

src/index.ts

@@ -1,4 +1,4 @@
-import { events, Product, Response, Stock, Order, OrderItem, OrderPart, OPERATOR, User } from '@/types'
+import { events, Product, Response, Stock, ListResponse, Order, OrderItem, OrderPart, OPERATOR, User } from '@/types'
 import { init, resetConfig, updateToken, updateInstanceUrl } from '@/api'
 import { isError } from '@/util'
 import { fetchProducts, fetchProductsGroupedBy, fetchProductsGroupedByParent, fetchProductsStockAtFacility, getOrderDetails, getProfile, updateOrderStatus } from '@/modules'
@@ -17,6 +17,7 @@ export {
   fetchProductsStockAtFacility,
   getProfile,
   events,
+  ListResponse,
   Product,
   Response,
   Stock,

src/modules/product/index.ts

@@ -1,10 +1,10 @@
 import api from "@/api";
-import { OPERATOR, Product, Response } from "@/types";
-import { hasError, isError } from "@/util";
+import { OPERATOR, Product, Response, ListResponse } from "@/types";
+import { hasError } from "@/util";
 import { transform } from 'node-json-transform'
 import { productTransformRule } from "@/mappings/product";
 
-async function fetchProducts(params: any): Promise<any | Response> {
+async function fetchProducts(params: any): Promise<ListResponse<Product> | Response> {
 
   const payload = {
     "json": {
@@ -51,17 +51,17 @@ async function fetchProducts(params: any): Promise<any | Response> {
 
     if (resp.status == 200 && !hasError(resp) && resp.data?.response?.numFound > 0) {
 
-      const product: Array<Product> = transform(resp.data.response.docs, productTransformRule)
+      const products: Array<Product> = transform(resp.data.response.docs, productTransformRule)
 
-      return {
-        products: product,
+      return Promise.resolve({
+        list: products,
         total: resp.data?.response?.numFound
-      }
+      })
     } else {
-      return {
-        products: {},
+      return Promise.resolve({
+        list: [],
         total: 0
-      }
+      })
     }
   } catch (err) {
     return Promise.reject({
@@ -72,7 +72,7 @@ async function fetchProducts(params: any): Promise<any | Response> {
   }
 }
 
-async function fetchProductsGroupedBy(params: any): Promise<any | Response> {
+async function fetchProductsGroupedBy(params: any): Promise<ListResponse<Product> | Response> {
 
   const payload = {
     "json": {
@@ -132,17 +132,17 @@ async function fetchProductsGroupedBy(params: any): Promise<any | Response> {
         }
       })
 
-      return {
-        products,
-        matches: resp.data?.grouped?.groupId.matches,
-        ngroups: resp.data?.grouped?.groupId.ngroups
-      }
+      return Promise.resolve({
+        list: products,
+        total: resp.data?.grouped?.groupId.matches,
+        groups: resp.data?.grouped?.groupId.ngroups
+      })
     } else {
-      return {
-        products: {},
-        matches: 0,
-        ngroups: 0
-      }
+      return Promise.resolve({
+        list: [],
+        total: 0,
+        groups: 0
+      })
     }
   } catch (err) {
     return Promise.reject({
@@ -153,7 +153,7 @@ async function fetchProductsGroupedBy(params: any): Promise<any | Response> {
   }
 }
 
-async function fetchProductsGroupedByParent(params: any): Promise<Product[] | Response> {
+async function fetchProductsGroupedByParent(params: any): Promise<ListResponse<Product> | Response> {
 
   const payload = {
     ...params,

src/types/index.ts

@@ -40,11 +40,18 @@ interface Response {
   serverResponse?: any;
 }
 
+interface ListResponse<T> {
+  list: Array<T>;
+  total?: number;
+  groups?: number;
+}
+
 export {
   ContactMech,
   Enumeration,
   events,
   Geo,
+  ListResponse,
   Order,
   OrderItem,
   OrderPart,