Implemented: schema for shipment, defined action to fetch the shipments, and added transformation rule(#2vd6xty)

src/index.ts

@@ -1,12 +1,13 @@
-import { events, Product, Response, Order, OrderItem, OrderPart, User } from '@/types'
+import { events, Product, Response, Order, OrderItem, OrderPart, Shipment, User } from '@/types'
 import { init, resetConfig, updateToken, updateInstanceUrl } from '@/api'
 import { isError } from '@/util'
-import { fetchProducts, getOrderDetails, getProfile, updateOrderStatus } from '@/modules'
+import { fetchProducts, fetchShipments, getOrderDetails, getProfile, updateOrderStatus } from '@/modules'
 
 export {
   getOrderDetails,
   updateOrderStatus,
   fetchProducts,
+  fetchShipments,
   init,
   isError,
   resetConfig,
@@ -16,6 +17,7 @@ export {
   events,
   Product,
   Response,
+  Shipment,
   Order,
   OrderItem,
   OrderPart,

src/mappings/shipment.ts

@@ -0,0 +1,13 @@
+const shipmentTransformRule = {
+  item: {
+    shipmentId: "shipmentId",
+    estimatedArrivalDate: "estimatedArrivalDate",
+    fromPartyId: "partyIdFrom",
+    toPartyId: "partyIdTo",
+    statusId: "statusId",
+    shipmentItemCount: "shipmentItemCount",
+    destinationFacilityId: "destinationFacilityId"
+  }
+}
+
+export { shipmentTransformRule }

src/modules/index.ts

@@ -1,9 +1,11 @@
 import { getOrderDetails, updateOrderStatus } from '@/modules/order'
 import { fetchProducts } from '@/modules/product'
 import { getProfile } from '@/modules/user'
+import { fetchShipments } from '@/modules/shipment'
 
 export {
   fetchProducts,
+  fetchShipments,
   getOrderDetails,
   getProfile,
   updateOrderStatus

src/modules/shipment/index.ts

@@ -0,0 +1,59 @@
+import api from "@/api";
+import { hasError } from "@/util";
+import { Response, Shipment } from "@/types";
+import { shipmentTransformRule } from "@/mappings/shipment";
+import { transform } from "node-json-transform";
+
+async function fetchShipments(payload: any): Promise <Shipment[] | Response> {
+  let response = {} as Shipment[] | Response
+
+  const query = {
+    "inputFields": {
+      "destinationFacilityId": payload.facilityId,
+      "statusId": "PURCH_SHIP_SHIPPED",
+      "shipmentTypeId_fld0_value": "INCOMING_SHIPMENT",
+      "shipmentTypeId_fld0_op": "equals",
+      "shipmentTypeId_fld0_grp": "1",
+      "parentTypeId_fld0_value": "INCOMING_SHIPMENT",
+      "parentTypeId_fld0_op": "equals",
+      "parentTypeId_fld0_grp": "2",
+    },
+    "entityName": "ShipmentAndTypeAndItemCount",
+    "fieldList" : ["shipmentId", "primaryShipGroupSeqId", "partyIdFrom", "partyIdTo", "estimatedArrivalDate", "destinationFacilityId", "statusId", "shipmentItemCount"],
+    "noConditionFind": "Y",
+    "viewSize": payload.viewSize,
+    "viewIndex": payload.viewIndex,
+  } as any
+
+  if(payload.queryString) {
+    query.inputFields["shipmentId"] = payload.queryString;
+    query.inputFields["shipmentId_op"] = "contains";
+    query.inputFields["shipmentId_ic"] = "Y";
+  }
+
+  try {
+    const resp = await api({
+      url: '/performFind',
+      method: 'post',
+      data: query,
+      cache: true
+    }) as any
+
+    if (resp.status === 200 && resp.data.docs?.length > 0 && !hasError(resp)) {
+      const shipments: Array<Shipment> = transform(resp.data.docs, shipmentTransformRule)
+      response = shipments;
+    } else {
+      response = [];
+    }
+  } catch(err) {
+    response = {
+      code: 'error',
+      message: 'Something went wrong',
+      serverResponse: err
+    }
+  }
+
+  return response;
+}
+
+export { fetchShipments }

src/types/Shipment.ts

@@ -0,0 +1,75 @@
+import { Enumeration, Party, Status, Uom } from "./index"
+
+export interface ShipmentItemSource {
+  shipmentItemSourceId?: string;
+  orderId?: string;
+  orderItemSeqId?: string;
+  returnId?: string;
+  returnItemSeqId?: string;
+  statusId?: string;
+  invoiceId?: string;
+  invoiceItemSeqId?: string;
+}
+
+export interface Shipment {
+  shipmentId: string;
+  shipmentTypeEnumId?: string;
+  statusId?: string;
+  fromPartyId?: string;
+  toPartyId?: string;
+  binLocationNumber?: number;
+  productStoreId?: string;
+  priority?: number;
+  entryDate?: number;
+  shipAfterDate?: number;
+  shipBeforeDate?: number;
+  estimatedReadyDate?: number;
+  estimatedShipDate?: number;
+  estimatedArrivalDate?: number;
+  latestCancelDate?: number;
+  packedDate?: number;
+  pickContainerId?: string;
+  estimatedShipCost?: number;
+  costUomId?: string;
+  addtlShippingCharge?: number;
+  addtlShippingChargeDesc?: string;
+  signatureRequiredEnumId?: string;
+  handlingInstructions?: string;
+  otherPartyOrderId?: string;
+  systemMessageRemoteId?: string;
+  externalId?: string;
+  originId?: string;
+  type?: Enumeration;
+  status?: Status;
+  fromParty?: Party;
+  toParty?: Party;
+  costUom?: Uom;
+  contents?: Array<{
+    shipmentContentId?: string;
+    shipmentContentTypeEnumId?: string;
+    shipmentId?: string;
+    productId?: string;
+    shipmentPackageSeqId?: string;
+    shipmentRouteSegmentSeqId?: string;
+    contentLocation?: string;
+    description?: string;
+    contentDate?: number;
+    userId?: string;
+  }>;
+  items?: Array<{
+    shipmentId?: string;
+    productId?: string;
+    quantity?: number;
+    itemSource?: ShipmentItemSource;
+  }>;
+  packages?: Array<{
+    shipmentId?: string;
+    shipmentPackageSeqId?: string;
+    shipmentBoxTypeId?: string;
+    weight?: number;
+    weightUomId?: string;
+    gatewayPackageId?: string;
+  }>;
+  shipmentItemCount?: number; // Item count in shipment
+  destinationFacilityId?: string; // Destination facility Id for shipment
+}

src/types/index.ts

@@ -6,6 +6,7 @@ import { Party } from './Party';
 import { Product } from './Product';
 import { Status } from './Status';
 import { Uom } from './Uom';
+import { Shipment } from './Shipment';
 import { User } from './User';
 
 const events = {
@@ -30,6 +31,7 @@ export {
   OrderPart,
   Party,
   Product,
+  Shipment,
   Status,
   Uom,
   User,