@things-factory/operato-hub 4.3.122 → 4.3.123

package/server/routers/api/restful-apis/v1/utils/params.ts

@@ -0,0 +1,562 @@
+const limitOffset = ['limit', 'offset']
+const fromToDate = ['fromDate', 'toDate']
+
+export const params = {
+  'get-bizplace-list': [...limitOffset],
+  'get-contact-point-list': ['bizplaceId', 'companyName', 'email', ...limitOffset],
+  'get-product-list': ['bizplaceId', 'skuId', ...limitOffset],
+  'get-marketplace-store-list': [...limitOffset],
+  'get-marketplace-order-shipping-list': ['storeId', 'shippingNo', 'orderNo', 'status', ...fromToDate, ...limitOffset],
+  'get-partner-list': ['bizplaceId', ...limitOffset],
+  'get-inbound-order-list': ['bizplaceId', 'ganNo', 'status', ...fromToDate, ...limitOffset],
+  'get-inbound-order-details': ['bizplaceId', 'ganNo'],
+  'get-goods-received-note-list': ['bizplaceId', ...fromToDate, ...limitOffset],
+  'get-release-order-list': ['bizplaceId', 'roNo', 'status', ...fromToDate, ...limitOffset],
+  'get-release-order-details': ['bizplaceId', 'roNo'],
+  'get-delivery-order-list': ['bizplaceId', ...fromToDate, ...limitOffset],
+  'get-onhand-inventory-list': ['bizplaceId', 'sku', 'batchId', ...fromToDate, ...limitOffset],
+  'get-inventory-product-group-list': ['bizplaceId', 'sku', 'batchId', ...fromToDate, ...limitOffset],
+  'add-contact-points': [
+    'bizplaceId',
+    'name',
+    'companyName',
+    'description',
+    'email',
+    'fax',
+    'phone',
+    'billingAddress',
+    'accountNo',
+    'address',
+    'address2',
+    'city',
+    'state',
+    'postCode',
+    'type'
+  ],
+  'add-marketplace-order': [
+    'storeId',
+    'orderNo',
+    'status',
+    'itemCount',
+    'paymentMethod',
+    'remark',
+    'giftOption',
+    'orderCreatedAt',
+    'orderUpdatedAt',
+    'marketplaceOrderItems',
+    'marketplaceOrderItems.orderItemId',
+    'marketplaceOrderItems.qty',
+    'marketplaceOrderItems.cancelBy',
+    'marketplaceOrderItems.returnStatus',
+    'marketplaceOrderItems.packageId',
+    'marketplaceOrderItems.status',
+    'marketplaceOrderItems.marketplaceProductVariation',
+    'marketplaceOrderItems.marketplaceProductVariation.sku',
+    'marketplaceOrderItems.marketplaceProductVariation.variationSku',
+    'marketplaceOrderItems.marketplaceProductVariation.variationName',
+    'marketplaceOrderItems.marketplaceProductVariation.variationId',
+    'marketplaceOrderItems.marketplaceOrderShipping',
+    'marketplaceOrderItems.marketplaceOrderShipping.attentionTo',
+    'marketplaceOrderItems.marketplaceOrderShipping.address1',
+    'marketplaceOrderItems.marketplaceOrderShipping.address2',
+    'marketplaceOrderItems.marketplaceOrderShipping.address3',
+    'marketplaceOrderItems.marketplaceOrderShipping.address4',
+    'marketplaceOrderItems.marketplaceOrderShipping.address5',
+    'marketplaceOrderItems.marketplaceOrderShipping.state',
+    'marketplaceOrderItems.marketplaceOrderShipping.city',
+    'marketplaceOrderItems.marketplaceOrderShipping.postCode',
+    'marketplaceOrderItems.marketplaceOrderShipping.country',
+    'marketplaceOrderItems.marketplaceOrderShipping.phone1',
+    'marketplaceOrderItems.marketplaceOrderShipping.phone2',
+    'marketplaceOrderItems.marketplaceOrderShipping.email',
+    'marketplaceOrderItems.marketplaceOrderShipping.freightType',
+    'marketplaceOrderItems.marketplaceOrderShipping.parcelType',
+    'marketplaceOrderItems.marketplaceOrderShipping.deliveryMethod',
+    'marketplaceOrderItems.marketplaceOrderShipping.totalWeight',
+    'marketplaceOrderItems.marketplaceOrderShipping.totalVolume',
+    'marketplaceOrderItems.marketplaceOrderShipping.transporter'
+  ],
+  'cancel-marketplace-order': ['storeId', 'orderNo', 'remark', 'cancelBy'],
+  'update-marketplace-order-delivered': ['storeId', 'orderNo'],
+  'add-products': [
+    'sku',
+    'brandSku',
+    'name',
+    'description',
+    'type',
+    'brand',
+    'subBrand',
+    'isRequiredCheckExpiry',
+    'isRequireSerialNumberScanning',
+    'isRequireSerialNumberScanningInbound',
+    'isRequireSerialNumberScanningOutbound',
+    'pickingStrategy',
+    'expirationPeriod',
+    'productDetails',
+    'productDetails.isDefault',
+    'productDetails.gtin',
+    'productDetails.refCode',
+    'productDetails.packingType',
+    'productDetails.packingSize',
+    'productDetails.uom',
+    'productDetails.uomValue',
+    'productDetails.costPrice',
+    'productDetails.minQty',
+    'productDetails.maxQty',
+    'productDetails.bufferQty',
+    'productDetails.movement',
+    'productDetails.weightUnit',
+    'productDetails.nettWeight',
+    'productDetails.grossWeight',
+    'productDetails.lengthUnit',
+    'productDetails.width',
+    'productDetails.depth',
+    'productDetails.height',
+    'productDetails.volume',
+    'productDetails.auxUnit1',
+    'productDetails.auxValue1',
+    'productDetails.auxUnit2',
+    'productDetails.auxValue2',
+    'productDetails.auxUnit3',
+    'productDetails.auxValue3',
+    'productDetails.auxUnit4',
+    'productDetails.auxValue4',
+    'productDetails.auxUnit5',
+    'productDetails.auxValue5',
+    'productDetails.childProductDetail'
+  ],
+  'add-inbound-order': [
+    'bizplaceId',
+    'refNo',
+    'refNo2',
+    'refNo3',
+    'etaDate',
+    'ownTransport',
+    'importCargo',
+    'container',
+    'containerNo',
+    'containerSize',
+    'truckNo',
+    'deliveryOrderNo',
+    'orderProducts',
+    'orderProducts.batchId',
+    'orderProducts.packingType',
+    'orderProducts.packingSize',
+    'orderProducts.qty',
+    'orderProducts.palletQty',
+    'orderProducts.product',
+    'orderProducts.product.sku',
+    'orderProducts.product.refCode',
+    'orderProducts.product.uom',
+    'orderProducts.product.uomValue',
+    'supplierId'
+  ],
+  'cancel-inbound-order': ['bizplaceId', 'ganNo', 'remark'],
+  'add-release-order': [
+    'bizplaceId',
+    'releaseDate',
+    'refNo',
+    'refNo2',
+    'refNo3',
+    'type',
+    'transporter',
+    'trackingNo',
+    'packingOption',
+    'exportOption',
+    'ownTransport',
+    'courierOption',
+    'collectionOrderNo',
+    'shippingOrder',
+    'shippingOrder.shipName',
+    'shippingOrder.containerNo',
+    'shippingOrder.loadType',
+    'shippingOrder.from',
+    'shippingOrder.to',
+    'shippingOrder.containerArrivalDate',
+    'shippingOrder.containerLeavingDate',
+    'deliverTo',
+    'deliverTo.deliveryAddress1',
+    'deliverTo.deliveryAddress2',
+    'deliverTo.deliveryAddress3',
+    'deliverTo.deliveryAddress4',
+    'deliverTo.deliveryAddress5',
+    'deliverTo.attentionTo',
+    'deliverTo.city',
+    'deliverTo.postalCode',
+    'deliverTo.country',
+    'deliverTo.state',
+    'deliverTo.phone1',
+    'deliverTo.phone2',
+    'marketplaceOrderStatus',
+    'airwayBill',
+    'invoice',
+    'attentionCompany',
+    'email',
+    'packageId',
+    'storeName',
+    'storeId',
+    'routeId',
+    'stopId',
+    'source',
+    'orderInventories',
+    'orderInventories.product',
+    'orderInventories.product.sku',
+    'orderInventories.product.refCode',
+    'orderInventories.packingType',
+    'orderInventories.packingSize',
+    'orderInventories.releaseQty',
+    'orderInventories.sellingPrice',
+    'orderInventories.paidAmount',
+    'remark',
+    'billTo',
+    'billTo.billingAddress',
+    'requiredDraft',
+    'platformCountry',
+    'platformCode',
+    'platformName',
+    'discountAmount',
+    'taxAmount',
+    'shippingFee'
+  ],
+  'cancel-release-order': ['bizplaceId', 'roId', 'orderNo', 'orderNo2', 'orderNo3', 'remark'],
+  'update-release-order-details': [
+    'bizplaceId',
+    'releaseGood',
+    'releaseGood.roId',
+    'releaseGood.collectionOrderNo',
+    'releaseGood.refNo',
+    'releaseGood.refNo2',
+    'releaseGood.refNo3',
+    'releaseGood.marketplaceOrderStatus',
+    'releaseGood.billingAddress',
+    'releaseGood.deliveryAddress1',
+    'releaseGood.attentionTo',
+    'releaseGood.city',
+    'releaseGood.country',
+    'releaseGood.postalCode',
+    'releaseGood.phone1',
+    'releaseGood.transporter',
+    'releaseGood.trackingNo',
+    'releaseGood.airwayBill',
+    'releaseGood.invoice',
+    'shippingOrder',
+    'shippingOrder.shipName',
+    'shippingOrder.containerNo',
+    'shippingOrder.loadType',
+    'shippingOrder.from',
+    'shippingOrder.to',
+    'shippingOrder.containerArrivalDate',
+    'shippingOrder.containerLeavingDate'
+  ],
+  'update-marketplace-shipping-order': ['storeId', 'orderNo', 'transporter', 'airwayBill', 'trackingNo']
+}
+
+export const reqParams = {
+  'get-contact-point-list': ['bizplaceId'],
+  'get-product-list': ['bizplaceId'],
+  'get-marketplace-order-shipping-list': ['storeId'],
+  'get-inbound-order-list': ['bizplaceId'],
+  'get-inbound-order-details': ['bizplaceId', 'ganNo'],
+  'get-goods-received-note-list': ['bizplaceId'],
+  'get-release-order-list': ['bizplaceId'],
+  'get-release-order-details': ['bizplaceId', 'roNo'],
+  'get-delivery-order-list': ['bizplaceId'],
+  'get-onhand-inventory-list': ['bizplaceId'],
+  'get-inventory-product-group-list': ['bizplaceId'],
+  'add-contact-points': [
+    {
+      name: 'name',
+      required: true,
+      type: 'field'
+    },
+    {
+      name: 'email',
+      required: true,
+      type: 'field'
+    },
+    {
+      name: 'phone',
+      required: true,
+      type: 'field'
+    },
+    {
+      name: 'address',
+      required: true,
+      type: 'field'
+    },
+    {
+      name: 'type',
+      required: true,
+      type: 'field'
+    }
+  ],
+  'add-marketplace-order': [
+    {
+      name: 'storeId',
+      required: true,
+      type: 'field'
+    },
+    {
+      name: 'orderNo',
+      required: true,
+      type: 'field'
+    },
+    {
+      name: 'status',
+      required: true,
+      type: 'field'
+    },
+    {
+      name: 'marketplaceOrderItems',
+      required: true,
+      type: 'array',
+      data: [
+        { name: 'orderItemId', required: true, type: 'field' },
+        { name: 'qty', required: true, type: 'field' },
+        {
+          name: 'marketplaceProductVariation',
+          required: true,
+          type: 'object',
+          data: [
+            { name: 'variationId', required: true, type: 'field' },
+            { name: 'variationSku', required: true, type: 'field' },
+            { name: 'variationName', required: true, type: 'field' }
+          ]
+        },
+        {
+          name: 'marketplaceOrderShipping',
+          required: true,
+          type: 'object',
+          data: [
+            { name: 'attentionTo', required: true, type: 'field' },
+            { name: 'address1', required: true, type: 'field' },
+            { name: 'state', required: true, type: 'field' },
+            { name: 'city', required: true, type: 'field' },
+            { name: 'postCode', required: true, type: 'field' },
+            { name: 'country', required: true, type: 'field' },
+            { name: 'phone1', required: true, type: 'field' },
+            { name: 'email', required: true, type: 'field' }
+          ]
+        }
+      ]
+    }
+  ],
+  'cancel-marketplace-order': [
+    { name: 'storeId', required: true, type: 'field' },
+    { name: 'orderNo', required: true, type: 'field' },
+    { name: 'remark', required: true, type: 'field' }
+  ],
+  'update-marketplace-order-delivered': [
+    { name: 'storeId', required: true, type: 'field' },
+    { name: 'orderNo', required: true, type: 'field' }
+  ],
+  'add-products': [
+    {
+      name: 'sku',
+      required: true,
+      type: 'field'
+    },
+    {
+      name: 'name',
+      required: true,
+      type: 'field'
+    },
+    {
+      name: 'type',
+      required: true,
+      type: 'field'
+    },
+    {
+      name: 'productDetails',
+      required: true,
+      type: 'array',
+      data: [
+        { name: 'isDefault', required: true, type: 'field' },
+        { name: 'gtin', required: true, type: 'field' },
+        { name: 'packingType', required: true, type: 'field' },
+        { name: 'packingSize', required: true, type: 'field' },
+        { name: 'uom', required: true, type: 'field' },
+        { name: 'uomValue', required: true, type: 'field' }
+      ]
+    }
+  ],
+  'add-release-order': [
+    {
+      name: 'bizplaceId',
+      required: true,
+      type: 'field'
+    },
+    {
+      name: 'releaseDate',
+      required: true,
+      type: 'field'
+    },
+    {
+      name: 'exportOption',
+      required: true,
+      type: 'field'
+    },
+    {
+      name: 'ownTransport',
+      required: true,
+      type: 'field'
+    },
+    {
+      name: 'shippingOrder',
+      required: false,
+      type: 'object',
+      data: [
+        { name: 'shipName', required: true, type: 'field' },
+        { name: 'containerNo', required: true, type: 'field' },
+        { name: 'containerArrivalDate', required: true, type: 'field' },
+        { name: 'containerLeavingDate', required: true, type: 'field' }
+      ]
+    },
+    {
+      name: 'orderInventories',
+      required: true,
+      type: 'array',
+      data: [
+        {
+          name: 'product',
+          required: true,
+          type: 'object',
+          data: [
+            {
+              name: 'sku',
+              required: true,
+              type: 'field'
+            }
+          ]
+        },
+        {
+          name: 'releaseQty',
+          required: true,
+          type: 'field'
+        }
+      ]
+    },
+    {
+      name: 'billTo',
+      required: false,
+      type: 'object',
+      data: [
+        {
+          name: 'billingAddress',
+          required: true,
+          type: 'field'
+        }
+      ]
+    }
+  ],
+  'add-inbound-order': [
+    {
+      name: 'bizplaceId',
+      required: true,
+      type: 'field'
+    },
+    {
+      name: 'etaDate',
+      required: true,
+      type: 'field'
+    },
+    {
+      name: 'ownTransport',
+      required: true,
+      type: 'field'
+    },
+    {
+      name: 'orderProducts',
+      required: true,
+      type: 'array',
+      data: [
+        {
+          name: 'batchId',
+          required: true,
+          type: 'field'
+        },
+        {
+          name: 'qty',
+          required: true,
+          type: 'field'
+        },
+        {
+          name: 'product',
+          required: true,
+          type: 'object',
+          data: [
+            {
+              name: 'sku',
+              required: true,
+              type: 'field'
+            }
+          ]
+        }
+      ]
+    },
+    {
+      name: 'supplierId',
+      required: false,
+      type: 'field'
+    }
+  ],
+  'cancel-inbound-order': [
+    { name: 'bizplaceId', required: true, type: 'field' },
+    { name: 'ganNo', required: true, type: 'field' },
+    { name: 'remark', required: true, type: 'field' }
+  ],
+  'cancel-release-order': [
+    { name: 'bizplaceId', required: true, type: 'field' },
+    { name: 'remark', required: true, type: 'field' }
+  ],
+  'update-release-order-details': [
+    { name: 'bizplaceId', required: true, type: 'field' },
+    {
+      name: 'releaseGood',
+      required: true,
+      type: 'object',
+      data: [{ name: 'roId', required: true, type: 'field' }]
+    },
+    {
+      name: 'shippingOrder',
+      required: false,
+      type: 'object',
+      data: [
+        { name: 'shipName', required: true, type: 'field' },
+        { name: 'containerNo', required: true, type: 'field' },
+        { name: 'containerArrivalDate', required: true, type: 'field' },
+        { name: 'containerLeavingDate', required: true, type: 'field' }
+      ]
+    }
+  ],
+  'update-marketplace-shipping-order': [
+    { name: 'storeId', required: true, type: 'field' },
+    { name: 'orderNo', required: true, type: 'field' },
+    { name: 'airwayBill', required: true, type: 'field' },
+    { name: 'trackingNo', required: true, type: 'field' }
+  ]
+}
+
+export const requireLimitOffsetValidation = [
+  'get-release-order-list',
+  'get-onhand-inventory-list',
+  'get-inventory-product-group-list',
+  'get-inbound-order-list',
+  'get-goods-received-note-list',
+  'get-delivery-order-list',
+  'get-product-list',
+  'get-partner-list',
+  'get-marketplace-store-list',
+  'get-marketplace-order-shipping-list',
+  'get-contact-point-list',
+  'get-bizplace-list'
+]
+
+export const requireFromToDateValidation = [
+  'get-release-order-list',
+  'get-onhand-inventory-list',
+  'get-inbound-order-list',
+  'get-goods-received-note-list',
+  'get-delivery-order-list',
+  'get-marketplace-order-shipping-list'
+]

package/server/routers/api/restful-apis/v1/utils/validate-util.ts

@@ -0,0 +1,59 @@
+import _ from 'lodash'
+
+import { ApiError } from './error-util'
+
+// validates limit and offset are passed in as integers within accepted range
+// values are floored
+export function validateLimitOffset(limit, offset) {
+  if (!limit) limit = 100
+  limit = parseInt(limit)
+  if (isNaN(limit)) throw new ApiError('E01', 'limit')
+  if (limit > 100 || limit < 1) throw new ApiError('E01', 'limit')
+
+  if (!offset) offset = 0
+  offset = parseInt(offset)
+  if (isNaN(offset)) throw new ApiError('E01', 'offset')
+  if (offset < 0) throw new ApiError('E01', 'offset')
+
+  return { limit, offset }
+}
+
+// assigns default values if undefined
+// validates passed in dates are ISO format
+// toDate cannot be before fromDate
+// difference in days cannot exceed 31
+// converts ISO format dates to UTC format dates for database query
+export function validateFromToDate(fromDate, toDate) {
+  const now = new Date()
+  const then = new Date(new Date().setDate(new Date().getDate() - 7))
+
+  // validate date format
+  if (fromDate && !(new Date(fromDate) instanceof Date)) throw new ApiError('E01', 'fromDate')
+  if (toDate && !(new Date(toDate) instanceof Date)) throw new ApiError('E01', 'toDate')
+
+  // assign default dates
+  if (!fromDate && !toDate) {
+    fromDate = then.toISOString()
+    toDate = now.toISOString()
+  } else if (!fromDate && toDate) {
+    throw new ApiError('E03', 'fromDate')
+  } else if (fromDate && !toDate) {
+    throw new ApiError('E03', 'toDate')
+  }
+
+  // validate conjuction
+  if (toDate < fromDate) throw new ApiError('E01', 'from and to dates are not in conjuction')
+
+  // validate date range
+  const diffTime = Math.abs(new Date(toDate).getTime() - new Date(fromDate).getTime())
+  const diffDays = Math.ceil(diffTime / (1000 * 60 * 60 * 24))
+  if (diffDays > 31) throw new ApiError('E01', 'date range is more than 31 days')
+
+  return { fromDate, toDate }
+}
+
+// Regular expression to check if string is a valid UUID
+export function isValidUUID(str) {
+  const regexExp = /^[0-9a-fA-F]{8}\b-[0-9a-fA-F]{4}\b-[0-9a-fA-F]{4}\b-[0-9a-fA-F]{4}\b-[0-9a-fA-F]{12}$/gi
+  return regexExp.test(str)
+}