@things-factory/operato-hub 4.3.82 → 4.3.83

package/server/routers/api/restful-apis/v1/middlewares/validation-middleware.ts

@@ -1,70 +0,0 @@
-import { ApiError, ApiErrorHandler, throwInternalServerError } from '../utils/error-util'
-
-const debug = require('debug')('things-factory:operato-hub:validation-middleware')
-
-import { params, reqParams, requireLimitOffsetValidation, requireFromToDateValidation } from '../utils/params'
-import { validateFromToDate, validateLimitOffset } from '../utils/validate-util'
-
-export async function validationMiddleware(context, next) {
-  let path = context.req._parsedUrl.pathname
-  let endpoint = path.substring(path.lastIndexOf('/') + 1)
-  let q = context?.request?.query
-
-  // validate data key
-  try {
-    if (context.method == 'POST' && !context?.request?.body?.data) {
-      throw new ApiError('E03', 'data')
-    }
-
-    validateExpected(endpoint, context)
-    validateRequired(endpoint, context)
-
-    if (requireLimitOffsetValidation.includes(endpoint)) {
-      let { limit, offset } = validateLimitOffset(q?.limit, q?.offset)
-      context.request.query.limit = limit
-      context.request.query.offset = offset
-    }
-    if (requireFromToDateValidation.includes(endpoint)) {
-      let { fromDate, toDate } = validateFromToDate(q?.fromDate, q?.toDate)
-      context.request.query.fromDate = fromDate
-      context.request.query.toDate = toDate
-    }
-
-    await next()
-  } catch (e) {
-    if (e instanceof ApiError) ApiErrorHandler(context, e)
-    else throwInternalServerError(context, e)
-  }
-}
-
-function validateExpected(endpoint, context) {
-  let data = context.method == 'POST' ? context.request.body.data : context.request.query
-  let expected = params[endpoint]
-  let result = context.method == 'POST' ? Object.keys(flatten(data)) : Object.keys(data)
-  for (let r of result) {
-    if (!expected.includes(r)) throw new ApiError('E02', r.toString())
-  }
-}
-
-function validateRequired(endpoint, context) {
-  let data = context.method == 'POST' ? context.request.body.data : context.request.query
-  let required = reqParams[endpoint]
-  let result = context.method == 'POST' ? Object.keys(flatten(data)) : Object.keys(data)
-  if (required) {
-    for (let r of required) {
-      let v = r.split('.').slice(0, -1).join('.')
-      if (!required.includes(v) && !result.includes(v)) continue
-      if (!result.includes(r)) throw new ApiError('E03', r.toString())
-    }
-  }
-}
-
-function flatten(obj, path = '') {
-  if (!(obj instanceof Object)) return { [path.replace(/\.$/g, '')]: obj }
-
-  return Object.keys(obj).reduce((output, key) => {
-    return obj instanceof Array
-      ? { ...output, ...flatten(obj[key], path) }
-      : { ...output, ...flatten(obj[key], path + key + '.') }
-  }, {})
-}

package/server/routers/api/restful-apis/v1/middlewares/warehouse-middleware.ts

@@ -1,31 +0,0 @@
-import { getRepository } from 'typeorm'
-import { Bizplace } from '@things-factory/biz-base'
-import { ApiError } from '../utils/error-util'
-
-const debug = require('debug')('things-factory:operato-hub:warehouse-middleware')
-
-export async function warehouseMiddleware(context, next) {
-  const { warehouseId } = context.query
-  const { business } = context.state
-
-  let warehouse: Bizplace
-
-  debug('company and warehouse', business, warehouseId)
-
-  if (!business) throw new ApiError('E04', 'Company')
-
-  if (warehouseId) {
-    warehouse = await getRepository(Bizplace).findOne(warehouseId, {
-      relations: ['company', 'domain']
-    })
-    debug('warehouse', warehouseId, warehouse?.domain?.subdomain)
-
-    if (!warehouse) throw new ApiError('E04', 'Warehouse')
-  } else {
-    throw new ApiError('E04', 'Warehouse')
-  }
-
-  context.state.warehouse = warehouse
-
-  await next()
-}

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

@@ -1,70 +0,0 @@
-// custom error class used when throwing errors for API V1
-export class ApiError extends Error {
-  responseCode: string
-  status: number
-  message: string
-  details: string
-  constructor(responseCode: string, message: string, ...params) {
-    super(...params)
-    this.responseCode = responseCode
-    this.name = 'ApiError'
-    switch (responseCode) {
-      case 'E01':
-        this.status = 400
-        this.message = 'Invalid parameter values'
-        this.details = message
-        break
-      case 'E02':
-        this.status = 400
-        this.message = 'Unexpected parameters'
-        this.details = message
-        break
-      case 'E03':
-        this.status = 400
-        this.message = 'Missing parameters'
-        this.details = message
-        break
-      case 'E04':
-        this.status = 404
-        this.message = 'Resource not found'
-        this.details = message
-        break
-      case 'E05':
-        this.status = 409
-        this.message = 'Duplicate entry'
-        this.details = message
-        break
-      case 'E06':
-        this.status = 500
-        this.message = 'Internal server error'
-        this.details = message
-        break
-    }
-  }
-}
-
-// used in catch block to give an error response
-export function ApiErrorHandler(context, e) {
-  context.type = 'application/json'
-  context.status = e.status
-  context.body = {
-    error: {
-      responseCode: e.responseCode,
-      message: e.message,
-      details: e.details
-    }
-  }
-}
-
-// used in catch block for all errors that are not ApiError
-export function throwInternalServerError(context, e) {
-  context.type = 'application/json'
-  context.status = 500
-  context.body = {
-    error: {
-      responseCode: 'E06',
-      message: 'Internal Server Error',
-      details: e.message
-    }
-  }
-}

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

@@ -1,360 +0,0 @@
-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.packingType',
-    'orderInventories.packingSize',
-    'orderInventories.releaseQty',
-    'remark',
-    'billTo',
-    'billTo.billingAddress'
-  ],
-  'cancel-release-order': ['bizplaceId', 'roNo', 'remark'],
-  'update-release-order-details': [
-    'releaseGood',
-    'releaseGood.bizplaceId',
-    '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': ['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',
-    'billTo.billingAddress'
-  ],
-  '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'],
-  'cancel-release-order': ['bizplaceId', 'roNo', 'remark'],
-  'update-release-order-details': [
-    'releaseGood',
-    'releaseGood.bizplaceId',
-    'releaseGood.roId',
-    'shippingOrder.shipName',
-    'shippingOrder.containerNo',
-    'shippingOrder.containerArrivalDate',
-    'shippingOrder.containerLeavingDate'
-  ],
-  'update-marketplace-shipping-order': ['storeId', 'orderNo', 'airwayBill', 'trackingNo']
-}
-
-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'
-]

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

@@ -1,49 +0,0 @@
-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 ago = new Date(now.getTime())
-  const sevenDaysAgo = ago.setDate(ago.getDate() - 7)
-
-  if (!fromDate) fromDate = sevenDaysAgo
-  else fromDate = new Date(fromDate)
-  if (!toDate) toDate = now
-  else toDate = new Date(toDate)
-
-  if (toDate < fromDate) throw new ApiError('E01', 'toDate')
-
-  const diffTime = Math.abs(toDate - fromDate)
-  const diffDays = Math.ceil(diffTime / (1000 * 60 * 60 * 24))
-  if (diffDays > 31) throw new ApiError('E01', 'fromDate')
-
-  if (isNaN(Date.parse(fromDate.toUTCString()))) throw new ApiError('E01', 'fromDate')
-  if (isNaN(Date.parse(toDate.toUTCString()))) throw new ApiError('E01', 'toDate')
-
-  fromDate = fromDate.toUTCString()
-  toDate = toDate.toUTCString()
-  return { fromDate, toDate }
-}
-