@things-factory/operato-hub 4.3.78 → 4.3.79-alpha.0

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

@@ -0,0 +1,199 @@
+const limitOffset = ['limit', 'offset']
+const fromToDate = ['fromDate', 'toDate']
+
+// all possible fields in objects
+// endpoint will only accept objects with these fields
+// used for throwing E02 error
+export const expectedParams = {
+  getBizplaceList: [...limitOffset],
+  getContactPointList: ['bizplaceId', 'companyName', 'email', ...limitOffset],
+  getProductList: ['bizplaceId', 'skuId', ...limitOffset],
+  getMarketplaceStoreList: [...limitOffset],
+  getMarketplaceOrderShippingList: ['storeId', 'shippingNo', 'orderNo', 'status', ...fromToDate, ...limitOffset],
+  getPartnerList: ['bizplaceId', ...limitOffset],
+  getInboundOrderList: ['bizplaceId', 'ganNo', 'status', ...fromToDate, ...limitOffset],
+  getInboundOrderDetails: ['bizplaceId', 'ganNo'],
+  getGoodsReceivedNoteList: ['bizplaceId', ...fromToDate, ...limitOffset],
+  getReleaseOrderList: ['bizplaceId', 'roNo', 'status', ...fromToDate, ...limitOffset],
+  getReleaseOrderDetails: ['bizplaceId', 'roNo'],
+  getDeliveryOrderList: ['bizplaceId', ...fromToDate, ...limitOffset],
+  getOnhandInventoryList: ['bizplaceId', 'sku', 'batchId', ...fromToDate, ...limitOffset],
+  getInventoryProductGroupList: ['bizplaceId', 'sku', 'batchId', ...fromToDate, ...limitOffset],
+  addContactPoints: ['bizplaceId', 'data'],
+  addContactPointsData: [
+    'name',
+    'companyName',
+    'description',
+    'email',
+    'fax',
+    'phone',
+    'billingAddress',
+    'accountNo',
+    'address',
+    'address2',
+    'city',
+    'state',
+    'postCode',
+    'type'
+  ],
+  cancelMarketplaceOrder: ['storeId', 'orderNo', 'remark', 'cancelBy'],
+  requireDataKey: ['data'],
+  addProductsData: [
+    'sku',
+    'brandSku',
+    'name',
+    'description',
+    'type',
+    'brand',
+    'subBrand',
+    'isRequiredCheckExpiry',
+    'isRequireSerialNumberScanning',
+    'isRequireSerialNumberScanningInbound',
+    'isRequireSerialNumberScanningOutbound',
+    'pickingStrategy',
+    'expirationPeriod',
+    'productDetails'
+  ],
+  addProductsDataProductDetails: [
+    'isDefault',
+    'gtin',
+    'refCode',
+    'packingType',
+    'packingSize',
+    'uom',
+    'uomValue',
+    'costPrice',
+    'minQty',
+    'maxQty',
+    'bufferQty',
+    'movement',
+    'weightUnit',
+    'nettWeight',
+    'grossWeight',
+    'lengthUnit',
+    'width',
+    'depth',
+    'height',
+    'volume',
+    'auxUnit1',
+    'auxValue1',
+    'auxUnit2',
+    'auxValue2',
+    'auxUnit3',
+    'auxValue3',
+    'auxUnit4',
+    'auxValue4',
+    'auxUnit5',
+    'auxValue5',
+    'childProductDetail'
+  ],
+  updateMarketplaceOrderDelivered: ['storeId', 'orderNo'],
+  cancelInboundOrder: ['bizplaceId', 'data'],
+  cancelInboundOrderData: ['ganNo', 'remark'],
+  addMplaceOrder: ['storeId', 'data'],
+  addMplaceData: [
+    'orderNo',
+    'status',
+    'itemCount',
+    'paymentMethod',
+    'remark',
+    'giftOption',
+    'orderCreatedAt',
+    'orderUpdatedAt',
+    'marketplaceOrderItems'
+  ],
+  addMplaceDataMplaceOrderItems: [
+    'orderItemId',
+    'qty',
+    'cancelBy',
+    'returnStatus',
+    'packageId',
+    'status',
+    'marketplaceProductVariation',
+    'marketplaceOrderShipping'
+  ],
+  addMplaceDataMplaceProductVar: ['variationId', 'sku', 'variationSku', 'variationName'],
+  addMplaceDataMplaceOrderShipping: [
+    'attentionTo',
+    'address1',
+    'address2',
+    'address3',
+    'address4',
+    'address5',
+    'state',
+    'city',
+    'postCode',
+    'country',
+    'phone1',
+    'phone2',
+    'email',
+    'freightType',
+    'parcelType',
+    'deliveryMethod',
+    'totalWeight',
+    'totalVolume',
+    'transporter'
+  ],
+  addInboundOrderData: [
+    'bizplaceId',
+    'refNo',
+    'refNo2',
+    'refNo3',
+    'etaDate',
+    'ownTransport',
+    'importCargo',
+    'container',
+    'containerNo',
+    'containerSize',
+    'truckNo',
+    'deliveryOrderNo',
+    'orderProducts',
+    'supplier'
+  ],
+  addInboundOrderDataOrderProducts: ['product', 'batchId', 'packingType', 'packingSize', 'packQty', 'palletQty'],
+  addInboundOrderDataOrderProductsProduct: ['sku', 'uom', 'uomValue'],
+  addInboundOrderDataSupplier: ['name', 'companyName', 'email', 'accountNo']
+}
+
+// used for throwing E03 error
+// endpoint will only accept requests that have objects with these fields
+export const reqParams = {
+  getContactPointList: ['bizplaceId'],
+  getProductList: ['bizplaceId'],
+  getMarketplaceOrderShippingList: ['storeId'],
+  getInboundOrderList: ['bizplaceId'],
+  getInboundOrderDetails: ['bizplaceId', 'ganNo'],
+  getGoodsReceivedNoteList: ['bizplaceId'],
+  getReleaseOrderList: ['bizplaceId'],
+  getReleaseOrderDetails: ['bizplaceId', 'roNo'],
+  getDeliveryOrderList: ['bizplaceId'],
+  getOnhandInventoryList: ['bizplaceId'],
+  getInventoryProductGroupList: ['bizplaceId'],
+  requireDataKey: ['data'],
+  addContactPoints: ['bizplaceId', 'data'],
+  addContactPointsData: ['name', 'email', 'phone', 'address', 'type'],
+  cancelMarketplaceOrder: ['storeId', 'orderNo', 'remark'],
+  addProductsData: ['sku', 'name', 'type', 'productDetails'],
+  addProductsDataProductDetails: ['isDefault', 'gtin', 'packingType', 'packingSize', 'uom', 'uomValue'],
+  updateMarketplaceOrderDelivered: ['storeId', 'orderNo'],
+  cancelInboundOrder: ['bizplaceId', 'data'],
+  cancelInboundOrderData: ['ganNo', 'remark'],
+  addMplaceOrder: ['storeId', 'data'],
+  addMplaceData: ['orderNo', 'status', 'marketplaceOrderItems'],
+  addMplaceOrderDataMplaceOrderItems: ['orderItemId', 'qty', 'marketplaceProductVariation', 'marketplaceOrderShipping'],
+  addMplaceDataMplaceProductVar: ['variationId', 'variationSku', 'variationName'],
+  addMplaceDataMplaceOrderShipping: [
+    'attentionTo',
+    'address1',
+    'state',
+    'city',
+    'postCode',
+    'country',
+    'phone1',
+    'email'
+  ],
+  addInboundOrderData: ['bizplaceId', 'etaDate', 'ownTransport', 'orderProducts'],
+  addInboundOrderDataOrderProducts: ['product', 'batchId', 'packQty'],
+  addInboundOrderDataOrderProductsProduct: ['sku'],
+  addInboundOrderDataSupplier: ['name', 'companyName', 'email', 'accountNo']
+}

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

@@ -0,0 +1,291 @@
+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.packQty',
+    'orderProducts.palletQty',
+    'orderProducts.product',
+    'orderProducts.product.sku',
+    'orderProducts.product.uom',
+    'orderProducts.product.uomValue',
+    'supplier',
+    'supplier.name',
+    'supplier.companyName',
+    'supplier.email',
+    'supplier.accountNo'
+  ],
+  '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.product.packingType',
+    'orderInventories.product.packingSize',
+    'orderInventories.releaseQty'
+  ]
+}
+
+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': ['bizplaceId', 'name', 'email', 'phone', 'address', 'type'],
+  'add-marketplace-order': [
+    'storeId',
+    'orderNo',
+    'status',
+    'marketplaceOrderItems',
+    'marketplaceOrderItems.orderItemId',
+    'marketplaceOrderItems.qty',
+    'marketplaceOrderItems.marketplaceProductVariation',
+    'marketplaceOrderItems.marketplaceProductVariation.variationId',
+    'marketplaceOrderItems.marketplaceProductVariation.variationSku',
+    'marketplaceOrderItems.marketplaceProductVariation.variationName',
+    'marketplaceOrderItems.marketplaceOrderShipping',
+    'marketplaceOrderItems.marketplaceOrderShipping.attentionTo',
+    'marketplaceOrderItems.marketplaceOrderShipping.address1',
+    'marketplaceOrderItems.marketplaceOrderShipping.state',
+    'marketplaceOrderItems.marketplaceOrderShipping.city',
+    'marketplaceOrderItems.marketplaceOrderShipping.postCode',
+    'marketplaceOrderItems.marketplaceOrderShipping.country',
+    'marketplaceOrderItems.marketplaceOrderShipping.phone1',
+    'marketplaceOrderItems.marketplaceOrderShipping.email'
+  ],
+  'cancel-marketplace-order': ['storeId', 'orderNo', 'remark'],
+  'update-marketplace-order-delivered': ['storeId', 'orderNo'],
+  'add-products': [
+    'sku',
+    'name',
+    'type',
+    'productDetails',
+    'productDetails.isDefault',
+    'productDetails.gtin',
+    'productDetails.packingType',
+    'productDetails.packingSize',
+    'productDetails.uom',
+    'productDetails.uomValue'
+  ],
+  'add-release-order': [
+    'bizplaceId',
+    'releaseDate',
+    'exportOption',
+    'ownTransport',
+    'shippingOrder.shipName',
+    'shippingOrder.containerNo',
+    'shippingOrder.containerArrivalDate',
+    'shippingOrder.containerLeavingDate',
+    'orderInventories',
+    'orderInventories.product',
+    'orderInventories.product.sku',
+    'orderInventories.releaseQty'
+  ],
+  'add-inbound-order': [
+    'bizplaceId',
+    'etaDate',
+    'ownTransport',
+    'orderProducts',
+    'orderProducts.batchId',
+    'orderProducts.packQty',
+    'orderProducts.product',
+    'orderProducts.product.sku',
+    'supplier.name',
+    'supplier.companyName',
+    'supplier.email',
+    'supplier.accountNo'
+  ],
+  'cancel-inbound-order': ['bizplaceId', 'ganNo', 'remark']
+}

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

@@ -0,0 +1,74 @@
+import _ from 'lodash'
+import { getRepository } from 'typeorm'
+
+import { Bizplace } from '@things-factory/biz-base'
+
+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 }
+}
+
+// loops through query parameters to ensure only expected parameters are passed to logic
+export function validateFilter(queryObj: Object, expectedParams: string[]) {
+  for (const key in queryObj) {
+    if (!expectedParams.includes(key)) throw new ApiError('E02', key)
+  }
+}
+
+// checks if object has required parameter property
+export function validateReqParams(queryObj: Object, reqParams: string[]) {
+  let noparams = []
+  for (const reqParam of reqParams) {
+    if (!_.has(queryObj, reqParam)) noparams.push(reqParam)
+  }
+  if (noparams.length > 0) throw new ApiError('E03', noparams.join(', '))
+}
+
+// assigns default values if undefined
+// validates passed in dates are ISO format
+// converts ISO format dates to UTC format dates for database query
+export function validateFromToDate(fromDate, toDate) {
+  const now = new Date()
+  const ago = new Date(now.getTime())
+  const sevenDaysAgo = ago.setDate(ago.getDate() - 7)
+  const nowUtc = now.toUTCString()
+  const sevenDaysAgoUtc = new Date(sevenDaysAgo).toUTCString()
+
+  if (!fromDate) fromDate = sevenDaysAgoUtc
+  else fromDate = new Date(fromDate).toUTCString()
+  if (!toDate) toDate = nowUtc
+  else toDate = new Date(toDate).toUTCString()
+
+  if (isNaN(Date.parse(fromDate))) throw new ApiError('E01', 'fromDate')
+  if (isNaN(Date.parse(toDate))) throw new ApiError('E01', 'toDate')
+
+  return { fromDate, toDate }
+}
+
+// validates if bizplace belongs to company
+export async function validateBizplaceOfCompany(companyId, bizplaceId) {
+  if (!isValidUUID(bizplaceId)) throw new ApiError('E01', 'bizplaceId')
+  const bizplace: Bizplace = await getRepository(Bizplace).findOne({
+    where: { id: bizplaceId }
+  })
+  if (!bizplace) throw new ApiError('E01', 'bizplaceId')
+}
+
+// Regular expression to check if string is a valid UUID
+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)
+}