@things-factory/operato-hub 4.3.82 → 4.3.87

package/openapi/v1.yaml

@@ -12,27 +12,21 @@ info:
     name: MIT
     url: http://mit-license.org/
 tags:
-  - name: 'Authentication'
-  - name: 'Bizplace'
-  - name: 'Partner'
-  - name: 'Contact Point'
-  - name: 'Product'
+  - name: 'product'
     description: 'API for read, create and update products'
-  - name: 'Marketplace'
-  - name: 'Inbound'
+  - name: 'inbound'
     description: 'API to create and get inbound order list and detail'
-  - name: 'Outbound'
+  - name: 'outbound'
     description: 'API to create and get outbound order list and detail'
-  - name: 'Inventory'
+  - name: 'inventory'
     description: 'API to get inventory information from WMS'
 schemes:
   - 'https'
   - 'http'
 servers:
-  - url: '/oauth'
+  - url: '/api/v1'
 
-components:     # test 
-# Authentorize Button
+components:
   securitySchemes:
     basicAuth:
       type: http
@@ -54,31 +48,6 @@ components:     # test
             LMD: last-mile delivery system
             FREIGHT: freight system
             FLEET: fleet system
-# Schemas at the bottom
-  schemas:
-    # Response Code
-    API Response Code:     
-      type: object
-      properties:
-        E00:
-          type: No Errors
-          HTTP Response Status Code: 200 OK
-        E01:
-          type: 'Invalid parameter value: {{parameter}}'
-          HTTP Response Status Code: 400 Bad Request 
-        E02:
-          type: 'Unexpected parameter: {{parameter}}'
-          HTTP Response Status Code: 400 Bad Request
-        E03:
-          type: 'Missing parameter: {{parameter}}'
-          HTTP Response Status Code: 400 Bad Request
-        E04:
-          type: 'Resource not found: {{parameter}}'
-          HTTP Response Status Code: 404 Not Found
-        E05:
-          type: 'Duplicate entry: {{parameter}}'
-          HTTP Response Status Code: 409 Conflict
-
 
 security:
   - basicAuth: []
@@ -98,7 +67,7 @@ responses:
 securityDefinitions:
   wms_auth:
     type: 'oauth2'
-    authorizationUrl: 'http://petstore.swagger.io/oauth/dialog' # <-- i don't know why it's still here
+    authorizationUrl: 'http://petstore.swagger.io/oauth/dialog'
     flow: 'implicit'
     scopes:
       write:product: 'modify product in specific company id'
@@ -117,4 +86,3 @@ securityDefinitions:
 externalDocs:
   description: 'Find out about our release notes'
   url: 'https://developer.myoperato.com/release_notes'
-

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@things-factory/operato-hub",
-  "version": "4.3.82",
+  "version": "4.3.87",
   "main": "dist-server/index.js",
   "browser": "client/index.js",
   "things-factory": true,
@@ -56,66 +56,66 @@
     "@operato/scene-tab": "^0.1.8",
     "@operato/scene-table": "^0.1.8",
     "@operato/scene-wheel-sorter": "^0.1.8",
-    "@things-factory/api": "^4.3.82",
-    "@things-factory/apptool-ui": "^4.3.82",
-    "@things-factory/attachment-base": "^4.3.82",
-    "@things-factory/auth-base": "^4.3.82",
-    "@things-factory/auth-ui": "^4.3.82",
-    "@things-factory/biz-base": "^4.3.82",
-    "@things-factory/biz-ui": "^4.3.82",
-    "@things-factory/board-service": "^4.3.82",
-    "@things-factory/board-ui": "^4.3.82",
-    "@things-factory/code-ui": "^4.3.82",
-    "@things-factory/component-ui": "^4.3.82",
-    "@things-factory/context-ui": "^4.3.82",
-    "@things-factory/document-template-ui": "^4.3.82",
-    "@things-factory/export-ui": "^4.3.82",
-    "@things-factory/export-ui-csv": "^4.3.82",
-    "@things-factory/export-ui-excel": "^4.3.82",
-    "@things-factory/grist-ui": "^4.3.82",
-    "@things-factory/help": "^4.3.82",
-    "@things-factory/i18n-base": "^4.3.82",
-    "@things-factory/import-ui": "^4.3.82",
-    "@things-factory/import-ui-excel": "^4.3.82",
-    "@things-factory/integration-accounting": "^4.3.82",
-    "@things-factory/integration-fulfillment": "^4.3.82",
-    "@things-factory/integration-lmd": "^4.3.82",
-    "@things-factory/integration-marketplace": "^4.3.82",
-    "@things-factory/integration-pos": "^4.3.82",
-    "@things-factory/integration-sellercraft": "^4.3.82",
-    "@things-factory/integration-sftp": "^4.3.82",
-    "@things-factory/lite-menu": "^4.3.82",
-    "@things-factory/more-ui": "^4.3.82",
-    "@things-factory/notification": "^4.3.82",
-    "@things-factory/pdf": "^4.3.82",
-    "@things-factory/product-ui": "^4.3.82",
-    "@things-factory/resource-ui": "^4.3.82",
-    "@things-factory/sales-base": "^4.3.82",
-    "@things-factory/scene-data-transform": "^4.3.82",
-    "@things-factory/scene-excel": "^4.3.82",
-    "@things-factory/scene-firebase": "^4.3.82",
-    "@things-factory/scene-form": "^4.3.82",
-    "@things-factory/scene-google-map": "^4.3.82",
-    "@things-factory/scene-graphql": "^4.3.82",
-    "@things-factory/scene-label": "^4.3.82",
-    "@things-factory/scene-marker": "^4.3.82",
-    "@things-factory/scene-mqtt": "^4.3.82",
-    "@things-factory/scene-restful": "^4.3.82",
-    "@things-factory/scene-visualizer": "^4.3.82",
-    "@things-factory/setting-ui": "^4.3.82",
-    "@things-factory/shell": "^4.3.82",
-    "@things-factory/system-ui": "^4.3.82",
-    "@things-factory/warehouse-base": "^4.3.82",
-    "@things-factory/worksheet-base": "^4.3.82",
+    "@things-factory/api": "^4.3.86",
+    "@things-factory/apptool-ui": "^4.3.86",
+    "@things-factory/attachment-base": "^4.3.86",
+    "@things-factory/auth-base": "^4.3.86",
+    "@things-factory/auth-ui": "^4.3.86",
+    "@things-factory/biz-base": "^4.3.86",
+    "@things-factory/biz-ui": "^4.3.86",
+    "@things-factory/board-service": "^4.3.86",
+    "@things-factory/board-ui": "^4.3.86",
+    "@things-factory/code-ui": "^4.3.86",
+    "@things-factory/component-ui": "^4.3.86",
+    "@things-factory/context-ui": "^4.3.86",
+    "@things-factory/document-template-ui": "^4.3.86",
+    "@things-factory/export-ui": "^4.3.86",
+    "@things-factory/export-ui-csv": "^4.3.86",
+    "@things-factory/export-ui-excel": "^4.3.86",
+    "@things-factory/grist-ui": "^4.3.86",
+    "@things-factory/help": "^4.3.86",
+    "@things-factory/i18n-base": "^4.3.86",
+    "@things-factory/import-ui": "^4.3.86",
+    "@things-factory/import-ui-excel": "^4.3.86",
+    "@things-factory/integration-accounting": "^4.3.86",
+    "@things-factory/integration-fulfillment": "^4.3.86",
+    "@things-factory/integration-lmd": "^4.3.86",
+    "@things-factory/integration-marketplace": "^4.3.86",
+    "@things-factory/integration-pos": "^4.3.86",
+    "@things-factory/integration-sellercraft": "^4.3.86",
+    "@things-factory/integration-sftp": "^4.3.86",
+    "@things-factory/lite-menu": "^4.3.86",
+    "@things-factory/more-ui": "^4.3.86",
+    "@things-factory/notification": "^4.3.86",
+    "@things-factory/pdf": "^4.3.86",
+    "@things-factory/product-ui": "^4.3.86",
+    "@things-factory/resource-ui": "^4.3.86",
+    "@things-factory/sales-base": "^4.3.86",
+    "@things-factory/scene-data-transform": "^4.3.86",
+    "@things-factory/scene-excel": "^4.3.86",
+    "@things-factory/scene-firebase": "^4.3.86",
+    "@things-factory/scene-form": "^4.3.86",
+    "@things-factory/scene-google-map": "^4.3.86",
+    "@things-factory/scene-graphql": "^4.3.86",
+    "@things-factory/scene-label": "^4.3.86",
+    "@things-factory/scene-marker": "^4.3.86",
+    "@things-factory/scene-mqtt": "^4.3.86",
+    "@things-factory/scene-restful": "^4.3.86",
+    "@things-factory/scene-visualizer": "^4.3.86",
+    "@things-factory/setting-ui": "^4.3.86",
+    "@things-factory/shell": "^4.3.86",
+    "@things-factory/system-ui": "^4.3.86",
+    "@things-factory/warehouse-base": "^4.3.86",
+    "@things-factory/worksheet-base": "^4.3.87",
     "koa2-swagger-ui": "^5.0.2",
     "swagger-jsdoc": "^5.0.0",
     "yamljs": "^0.3.0"
   },
   "devDependencies": {
-    "@things-factory/builder": "^4.3.82"
+    "@things-factory/builder": "^4.3.86"
   },
   "resolutions": {
     "core-js": "^3.16.0"
   },
-  "gitHead": "fb0cb65bba75de2d2d0784202138d6d79dafa274"
+  "gitHead": "a8a7a0ddad241a559d0d6b24c4d7e6503f81049b"
 }

package/server/middlewares/business-middleware.ts

@@ -1,8 +1,6 @@
-import { getRepository } from 'typeorm'
-
-import { Application } from '@things-factory/auth-base'
 import { Bizplace, Company } from '@things-factory/biz-base'
 import { Domain, getDomainFromURL } from '@things-factory/shell'
+import { getRepository } from 'typeorm'
 
 const debug = require('debug')('things-factory:operato-hub:business-middleware')
 
@@ -13,7 +11,6 @@ export async function businessMiddleware(context, next) {
 
   if (user) {
     const domain: Domain = await getDomainFromURL(context)
-    const application: Application = await getRepository(Application).findOne({ where: { id: user.reference } })
 
     let company: Company
     if (domain.extType === 'company') {
@@ -27,7 +24,6 @@ export async function businessMiddleware(context, next) {
     }
 
     context.state.business = company
-    context.state.application = application
   }
 
   await next()

package/server/middlewares/store-middleware.ts

@@ -1,5 +1,4 @@
 import { getRepository } from 'typeorm'
-
 import { MarketplaceStore as MarketplaceStoreEntity } from '@things-factory/integration-marketplace'
 
 const debug = require('debug')('things-factory:operato-hub:store-middleware')

package/server/routers/api/index.ts

@@ -1,2 +1,3 @@
 import './restful-apis/v1'
+import './restful-apis/v2'
 import './restful-apis/unstable'

package/server/routers/api/restful-apis/unstable/add-draft-release-order.ts

@@ -16,7 +16,7 @@ router.post(
   warehouseMiddleware,
   async (context, next) => {
     return await getConnection().transaction(async (tx: EntityManager) => {
-      const { client, domain, application } = context.state
+      const { client, domain } = context.state
       const { warehouseId: customerBizplaceId } = context.params
       const { t } = context
 
@@ -126,8 +126,7 @@ router.post(
                 phone1: bodyReq?.deliverTo?.phone1 || null,
                 phone2: bodyReq?.deliverTo?.phone2 || null,
                 email: bodyReq?.deliverTo?.email || null,
-                packageId: bodyReq?.packageId || null,
-                source: application?.type || null
+                packageId: bodyReq?.packageId || null
               },
               orderProducts: orderInventories,
               files: []

package/server/routers/api/restful-apis/unstable/add-inbound-order.ts

@@ -15,7 +15,7 @@ router.post(
   businessMiddleware,
   warehouseMiddleware,
   async (context, next) => {
-    const { client, domain, application } = context.state
+    const { client, domain } = context.state
     const { warehouseId } = context.params
     const { t } = context
     const attachments = undefined
@@ -173,10 +173,7 @@ router.post(
               }
             }
           `,
-          variables: {
-            arrivalNotice: { ...bodyReq, orderProducts, warehouseId, source: application?.type },
-            attachments
-          },
+          variables: { arrivalNotice: { ...bodyReq, orderProducts, warehouseId }, attachments },
           context: {
             ...context,
             hasUpload: true,

package/server/routers/api/restful-apis/unstable/add-release-order.ts

@@ -43,7 +43,7 @@ router.post(
   warehouseMiddleware,
   async (context, next) => {
     return await getConnection().transaction(async (tx: EntityManager) => {
-      const { client, domain, user, application } = context.state
+      const { client, domain, user } = context.state
       const { warehouseId: customerBizplaceId } = context.params
       const { t } = context
       const bodyReq = context.request.body
@@ -107,8 +107,7 @@ router.post(
           storeName: bodyReq?.storeName,
           storeId: bodyReq?.storeId,
           routeId: bodyReq?.routeId,
-          stopId: bodyReq?.stopId,
-          source: application?.type
+          stopId: bodyReq?.stopId
         }
 
         // check existing order
@@ -496,7 +495,6 @@ async function createReleaseGood(
       stopId: releaseGood?.stopId,
       packageId: releaseGood?.packageId || null,
       noOfItems: orderProducts.length,
-      source: releaseGood?.source,
       creator: user,
       updater: user,
       acceptedBy: user,

package/server/routers/api/restful-apis/v1/add-contact-point.ts

@@ -0,0 +1,77 @@
+import { restfulApiRouter as router } from '@things-factory/api'
+import gql from 'graphql-tag'
+import { businessMiddleware } from '../../../../middlewares/business-middleware'
+import { warehouseMiddleware } from '../../../../middlewares/warehouse-middleware'
+
+const debug = require('debug')('things-factory:operato-hub:restful-api:v1:add-contact-point')
+
+router.post(
+  '/v1/warehouse/:warehouseId/add-contact-point',
+  businessMiddleware,
+  warehouseMiddleware,
+  async (context, next) => {
+    const { client, warehouse: bizplace, domain } = context.state
+    const { warehouseId } = context.params
+    const { t } = context
+    let bodyReq = context.request.body
+
+    if (!warehouseId) context.throw(404, t('error.warehouse id not found'))
+
+    if (typeof bodyReq === undefined || !Object.keys(bodyReq)?.length) {
+      context.throw(400, context.t('error.invalid body request format'))
+    }
+
+    await checkMandatoryKey(context, bodyReq)
+    debug('post:/add-contact-point request.body', bodyReq)
+
+    let patches: any[] = bodyReq.map(record => {
+      let patch = Object.assign({}, record)
+      patch.cuFlag = '+'
+
+      return patch
+    })
+
+    context.body = {
+      result: (
+        await client.query({
+          query: gql`
+            mutation updateMultipleContactPoint($patches: [ContactPointPatch]!) {
+              updateMultipleContactPoint(patches: $patches) {
+                name
+                companyName
+                phone
+                address
+                address2
+                city
+                state
+                postalCode
+                type
+                fax
+                email
+                address
+                billingAddress
+                accountNo
+              }
+            }
+          `,
+          variables: { patches },
+          context: {
+            ...context,
+            state: {
+              ...context.state,
+              bizplace,
+              domain
+            }
+          }
+        } as any)
+      ).data
+    }
+  }
+)
+
+export async function checkMandatoryKey(context, params) {
+  let noparams = ['name', 'email', 'phone', 'address', 'billingAddress', 'type'].filter(param => !(param in params))
+
+  if (noparams?.length)
+    context.throw(400, context.t('error.required param x not found', { x: `${noparams.join(', ')}` }))
+}

package/server/routers/api/restful-apis/v1/add-draft-release-order.ts

@@ -0,0 +1,196 @@
+import gql from 'graphql-tag'
+import { EntityManager, getConnection } from 'typeorm'
+
+import { restfulApiRouter as router } from '@things-factory/api'
+import { Bizplace } from '@things-factory/biz-base'
+import { OrderInventory } from '@things-factory/sales-base'
+
+import { businessMiddleware } from '../../../../middlewares/business-middleware'
+import { warehouseMiddleware } from '../../../../middlewares/warehouse-middleware'
+
+const debug = require('debug')('things-factory:operato-hub:restful-api:unstable:add-draft-release-order')
+
+router.post(
+  '/v1/warehouse/:warehouseId/add-draft-release-order',
+  businessMiddleware,
+  warehouseMiddleware,
+  async (context, next) => {
+    return await getConnection().transaction(async (tx: EntityManager) => {
+      const { client, domain } = context.state
+      const { warehouseId: customerBizplaceId } = context.params
+      const { t } = context
+
+      if (!customerBizplaceId) context.throw(404, t('error.warehouse id not found'))
+
+      let bodyReq = context.request.body
+      if (typeof bodyReq === undefined || !Object.keys(bodyReq)?.length) {
+        context.throw(400, t('error.invalid body request format'))
+      }
+      debug('post:/add-draft-release-order request.body', bodyReq)
+      await checkMandatoryKey(context, bodyReq)
+
+      // get customer company's bizplace
+      const customerBizplace: Bizplace = await tx.getRepository(Bizplace).findOne({
+        where: { id: customerBizplaceId }
+      })
+
+      const orderInventories: OrderInventory[] = bodyReq.orderInventories
+
+      context.body = {
+        result: (
+          await client.mutate({
+            mutation: gql`
+              mutation upsertDraftReleaseGood(
+                $draftReleaseGood: DraftReleaseGoodPatch!
+                $orderProducts: [OrderProductPatch!]!
+                $files: [Upload!]
+              ) {
+                upsertDraftReleaseGood(
+                  draftReleaseGood: $draftReleaseGood
+                  orderProducts: $orderProducts
+                  files: $files
+                ) {
+                  id
+                  name
+                  refNo
+                  refNo2
+                  refNo3
+                  status
+                  truckNo
+                  ownTransport
+                  marketplaceOrderStatus
+                  billingAddress
+                  deliveryAddress1
+                  deliveryAddress2
+                  deliveryAddress3
+                  deliveryAddress4
+                  deliveryAddress5
+                  attentionTo
+                  attentionCompany
+                  city
+                  state
+                  postalCode
+                  country
+                  phone1
+                  phone2
+                  email
+                  type
+                  exportOption
+                  releaseDate
+                  collectionOrderNo
+                  bizplace {
+                    name
+                  }
+                  orderProducts {
+                    product {
+                      sku
+                      name
+                      description
+                    }
+                    packingType
+                    packingSize
+                    releaseQty
+                  }
+                }
+              }
+            `,
+            variables: {
+              draftReleaseGood: {
+                bizplace: {
+                  id: customerBizplace.id
+                },
+                courierOption: bodyReq.courierOption,
+                collectionOrderNo: bodyReq.collectionOrderNo,
+                exportOption: bodyReq.exportOption,
+                ownTransport: bodyReq.ownTransport,
+                packingOption: bodyReq.packingOption,
+                refNo: bodyReq.refNo,
+                refNo2: bodyReq?.refNo2,
+                refNo3: bodyReq?.refNo3,
+                releaseDate: bodyReq.releaseDate,
+                type: bodyReq.type,
+                marketplaceOrderStatus: bodyReq?.marketplaceOrderStatus,
+                remark: bodyReq?.remark || null,
+                billingAddress: bodyReq?.billTo?.billingAddress || null,
+                deliveryAddress1: bodyReq?.deliverTo?.deliveryAddress1 || null,
+                deliveryAddress2: bodyReq?.deliverTo?.deliveryAddress2 || null,
+                deliveryAddress3: bodyReq?.deliverTo?.deliveryAddress3 || null,
+                deliveryAddress4: bodyReq?.deliverTo?.deliveryAddress4 || null,
+                deliveryAddress5: bodyReq?.deliverTo?.deliveryAddress5 || null,
+                attentionTo: bodyReq?.deliverTo?.attentionTo || null,
+                attentionCompany: bodyReq?.deliverTo?.attentionCompany || null,
+                city: bodyReq?.deliverTo?.city || null,
+                state: bodyReq?.deliverTo?.state || null,
+                postalCode: bodyReq?.deliverTo?.postalCode || null,
+                country: bodyReq?.deliverTo?.country || null,
+                phone1: bodyReq?.deliverTo?.phone1 || null,
+                phone2: bodyReq?.deliverTo?.phone2 || null,
+                email: bodyReq?.deliverTo?.email || null
+              },
+              orderProducts: orderInventories,
+              files: []
+            },
+            context: {
+              ...context,
+              hasUpload: true,
+              state: {
+                ...context.state,
+                customerBizplace,
+                domain,
+                type: 'api'
+              }
+            }
+          } as any)
+        ).data
+      }
+    })
+  }
+)
+
+export async function checkMandatoryKey(context, params) {
+  let noparams = ['releaseDate', 'exportOption'].filter(param => !(param in params))
+
+  if ('ownTransport' in params) {
+    if (params.ownTransport == true) {
+      if (!params.hasOwnProperty('collectionOrderNo')) {
+        noparams.push('collectionOrderNo')
+      }
+    }
+  } else {
+    noparams.push('ownTransport')
+  }
+
+  if ('exportOption' in params) {
+    if (params.exportOption === true) {
+      if (
+        params.exportOption.filter(
+          record =>
+            !record.containerNo || !record.containerArrivalDate || !record.containerLeavingDate || !record.shipName
+        ).length
+      ) {
+        noparams.push('exportOption')
+      }
+    }
+  }
+
+  if ('orderInventories' in params) {
+    params.orderInventories.forEach((param, key) => {
+      let noSubParams = []
+
+      if (!param?.releaseQty) noSubParams.push('releaseQty')
+
+      if (!param?.product) noSubParams.push('product')
+
+      if (noSubParams?.length)
+        context.throw(400, context.t('error.required param x not found', { x: `${noSubParams.join(', ')}` }))
+    })
+  } else {
+    noparams.push('orderInventories')
+  }
+
+  if (noparams?.length) {
+    context.throw(400, context.t('error.required param x not found', { x: `${noparams.join(', ')}` }))
+  }
+
+  return params
+}