@things-factory/integration-sftp 8.0.0-beta.8 → 8.0.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@things-factory/integration-sftp",
-  "version": "8.0.0-beta.8",
+  "version": "8.0.0",
   "main": "dist-server/index.js",
   "browser": "client/index.js",
   "things-factory": true,
@@ -24,13 +24,13 @@
     "migration:create": "node ../../node_modules/typeorm/cli.js migration:create ./server/migrations/migration"
   },
   "dependencies": {
-    "@things-factory/auth-base": "^8.0.0-beta.8",
-    "@things-factory/biz-base": "^8.0.0-beta.8",
-    "@things-factory/env": "^8.0.0-beta.4",
-    "@things-factory/integration-fulfillment": "^8.0.0-beta.8",
-    "@things-factory/shell": "^8.0.0-beta.5",
+    "@things-factory/auth-base": "^8.0.0",
+    "@things-factory/biz-base": "^8.0.0",
+    "@things-factory/env": "^8.0.0",
+    "@things-factory/integration-fulfillment": "^8.0.0",
+    "@things-factory/shell": "^8.0.0",
     "aws-sdk": "^2.960.0",
     "xml-js": "^1.6.11"
   },
-  "gitHead": "bf5206511b2d84dfb95edc3dae7f54f6cbb9bcca"
+  "gitHead": "07ef27d272dd9a067a9648ac7013748510556a18"
 }

package/server/controllers/herbalife/apis/create-serial-number.ts

@@ -0,0 +1,51 @@
+import { BACKUPPATH, SNSUBMITDATAPATH } from '../../../sftp-const'
+
+export function createSerialNumber() {
+  return {
+    method: 'post',
+    path: '{folderPath}/{folderType}{snPath}',
+    denormalize(req) {
+      let { releaseGood, inventoryItems, sftp } = req
+      let { folderPath, platform } = sftp
+      const folderType: string = sftp.isDevelopment ? `dev` : `prd`
+      const snPath: string = SNSUBMITDATAPATH
+      const backupPath: string = `${BACKUPPATH}${platform}/${folderType}`
+
+      let responseFilePattern: any = JSON.parse(sftp.responseFilePattern)
+      const { snSuffix, fileExtension, snRunningNumberDigit, snSequence } = responseFilePattern
+      let newSeq: number = parseFloat(snSequence) + 1
+      let newSequence = newSeq.toString().padStart(snRunningNumberDigit, '0')
+      let newResponseFilePattern: string = JSON.stringify({
+        ...responseFilePattern,
+        snSequence: newSeq.toString()
+      })
+      sftp = { ...sftp, responseFilePattern: newResponseFilePattern }
+
+      const today = new Date()
+      const year = today.getFullYear().toString()
+      const month = (today.getMonth() + 1).toString().padStart(2, '0')
+      const day = today.getDate().toString().padStart(2, '0')
+      const newDate = day + month + year
+
+      let title: string = snSuffix ? snSuffix : ``
+      title += `_` + newDate
+      title += `_` + newSequence
+      title += fileExtension ? `.` + fileExtension : ``
+
+      let content: string = ''
+      const orderNo: string = releaseGood.refNo
+      for (let i = 0; i < inventoryItems.length; i++) {
+        let serialNumber: string = inventoryItems[i].serialNumber
+        content += orderNo + '|' + serialNumber + '\n'
+      }
+
+      return {
+        resource: { folderPath, folderType, snPath },
+        payload: { title, content, sftp, backupPath }
+      }
+    },
+    normalize(res) {
+      return res
+    }
+  }
+}

package/server/controllers/herbalife/apis/create-shipment.ts

@@ -0,0 +1,88 @@
+import { BACKUPPATH, COMPLETEDATAPATH } from '../../../sftp-const'
+
+export function createShipment() {
+  return {
+    method: 'post',
+    path: '{folderPath}/{folderType}{shipmentCompletePath}',
+    denormalize(req) {
+      let { releaseGoods, sftp } = req
+      let { folderPath, platform } = sftp
+      const folderType: string = sftp.isDevelopment ? `dev` : `prd`
+      const shipmentCompletePath: string = COMPLETEDATAPATH
+      const backupPath: string = `${BACKUPPATH}${platform}/${folderType}`
+
+      let responseFilePattern: any = JSON.parse(sftp.responseFilePattern)
+      const { suffix, fileExtension, runningNumberDigit, sequence } = responseFilePattern
+      let newSeq: number = parseFloat(sequence) + 1
+      let newSequence = newSeq.toString().padStart(runningNumberDigit, '0')
+      let newResponseFilePattern: string = JSON.stringify({
+        ...responseFilePattern,
+        sequence: newSeq.toString()
+      })
+      sftp = { ...sftp, responseFilePattern: newResponseFilePattern }
+
+      const warehouseNumber: string = releaseGoods[0].refNo2
+      let title: string = suffix ? suffix : ``
+      title += newSequence
+      title += warehouseNumber ? `_` + warehouseNumber : ``
+      title += fileExtension ? `.` + fileExtension : ``
+
+      let backupTitle: string = releaseGoods[0].refNo + '_' + title
+      const orderNoColumn: number = 15
+      const shipmentColumn: number = 27
+      const trackingNoColumn: number = 20
+      let bulkContent = ''
+      for (let releaseGood of releaseGoods) {
+        const refNoLength: number = releaseGood.refNo.length
+        let content: string = `1710` + releaseGood.refNo
+        let spaceNeeded: number = orderNoColumn - refNoLength
+        for (let i = 0; i < spaceNeeded; i++) {
+          content += ` `
+        }
+        content += warehouseNumber
+        content += `001000001`
+        for (let i = 0; i < shipmentColumn; i++) {
+          content += ` `
+        }
+        content += `000000 `
+        for (let i = 0; i < trackingNoColumn; i++) {
+          content += ` `
+        }
+        content += `000000000000 `
+        const today = new Date()
+        const year = today.getFullYear().toString()
+        const month = (today.getMonth() + 1).toString().padStart(2, '0')
+        const day = today.getDate().toString().padStart(2, '0')
+        const newDate = year + month + day
+        content += newDate + '\n'
+
+        for (let i = 0; i < releaseGood.orderInventories.length; i++) {
+          const orderInventory: any = releaseGood.orderInventories[i]
+          let sku: string = orderInventory.product.brandSku
+          content += `1810` + releaseGood.refNo
+          for (let i = 0; i < spaceNeeded; i++) {
+            content += ` `
+          }
+          const idx = (i + 1).toString().padStart(2, '0')
+          const productCode: string = sku.substring(0, 4)
+          content += idx + `000000` + productCode
+          let productCodeSpaceNeeded = 7 - productCode.length
+          for (let i = 0; i < productCodeSpaceNeeded; i++) {
+            content += ` `
+          }
+          const orderedQty = orderInventory.releaseQty.toString().padStart(4, '0')
+          const pickedQty = orderInventory.pickedQty.toString().padStart(4, '0')
+          content += orderedQty + pickedQty + '\n'
+        }
+        bulkContent += content
+      }
+      return {
+        resource: { folderPath, folderType, shipmentCompletePath },
+        payload: { title, backupTitle, content: bulkContent, sftp, backupPath }
+      }
+    },
+    normalize(res) {
+      return res
+    }
+  }
+}

package/server/controllers/herbalife/apis/echo.ts

@@ -0,0 +1,14 @@
+export function echo() {
+  return {
+    path: '/echo',
+    denormalize(req) {
+      return { ...req }
+    },
+    normalize(res) {
+      return { ...res }
+    },
+    action({ store, method, path, request, platformAction }) {
+      return { ...request }
+    }
+  }
+}

package/server/controllers/herbalife/apis/get-outbound-order.ts

@@ -0,0 +1,119 @@
+export function getOutboundOrder() {
+  return {
+    method: 'get',
+    path: '{folderPath}/{folderType}/sob/data/{fileKey}',
+    denormalize(req) {
+      const { folderPath, folderType, fileKey } = req
+      return {
+        resource: { folderPath, folderType, fileKey }
+      }
+    },
+    normalize(res, { sftp }) {
+      const { Order } = res
+      let isAccept: boolean = false
+
+      const responseFilePattern = JSON.parse(sftp.responseFilePattern)
+      const acceptOrderTypes = responseFilePattern.acceptOrderTypes // ['RSO', 'MSO', 'MSBO']
+      const acceptNTSStatuses = responseFilePattern.acceptNTSStatuses //['', 'BACKORDER']
+      const acceptWarehouseNumber = responseFilePattern.acceptWarehouseNumber //['NK']
+      const acceptCommand = responseFilePattern.acceptCommand //['NTS', '']
+      const acceptFreightCode = responseFilePattern.acceptFreightCode // ['PU']
+
+      let orderHeader: any = Order.OrderHeader
+      let generalInfo: any = orderHeader.General
+      let distributorDetails: any = orderHeader.DistributorDetails
+      let shippingInstructions: any = Order.ShippingInstructions
+
+      let orderType: string = generalInfo.OrderType._text
+      let ntsStatus: string = generalInfo.NTSStatus._text || ''
+      let command: string = generalInfo.Command._text || ''
+      let warehouseNumber: string = generalInfo.WarehouseNumber._text
+      let freightCode: string = shippingInstructions.FreightCode._text
+
+      if (
+        acceptWarehouseNumber.includes(warehouseNumber) &&
+        acceptOrderTypes.includes(orderType) &&
+        acceptNTSStatuses.includes(ntsStatus) &&
+        acceptCommand.includes(command) &&
+        acceptFreightCode.includes(freightCode)
+      ) {
+        isAccept = true
+      }
+
+      let shippingInstruction: string = shippingInstructions.ShippingInstructions._text
+      let ntsDateParts = generalInfo.NTS_Date._text.split('/')
+      let releaseDate: string = ntsDateParts[2] + '-' + ntsDateParts[1] + '-' + ntsDateParts[0]
+      let orderInfo: any = {
+        refNo: generalInfo.OrderNumber._text,
+        refNo2: warehouseNumber,
+        type: 'b2b',
+        releaseDate,
+        collectionOrderNo: generalInfo.OrderNumber._text,
+        marketplaceOrderStatus: ntsStatus,
+        ownTransport: true,
+        exportOption: false,
+        packingOption: false,
+        remark: shippingInstruction,
+        billTo: {
+          billingAddress: distributorDetails.BillTo.BillToAddress._text
+        },
+        deliverTo: {
+          deliveryAddress1: distributorDetails.ShipTo.Address1._text,
+          deliveryAddress2: distributorDetails.ShipTo.Address2._text,
+          deliveryAddress3: distributorDetails.ShipTo.Address3._text,
+          attentionTo: distributorDetails.ShipTo.Name._text,
+          city: distributorDetails.ShipTo.City._text,
+          state: distributorDetails.ShipTo.ShipToState._text,
+          postalCode: distributorDetails.ShipTo.Zipcode._text,
+          country: distributorDetails.ShipTo.Country._text,
+          phone1: distributorDetails.ShipTo.Phone._text
+        }
+      }
+
+      let OrderLine = Order.PickList
+      let totalItems: number = parseFloat(Order.PickList.LinesInPickList._text)
+      let itemsToPick: any[] = []
+      let checkDuplicationValidation
+      if (totalItems == 1) {
+        if (parseFloat(OrderLine.Item.QuantityReleased._text) > 0) {
+          itemsToPick.push({
+            product: {
+              sku: OrderLine.Item.StockingSKU._text
+            },
+            releaseQty: parseFloat(OrderLine.Item.QuantityReleased._text)
+          })
+        }
+      } else {
+        OrderLine.Item.map(line => {
+          if (parseFloat(line.QuantityReleased._text) > 0) {
+            itemsToPick.push({
+              product: {
+                sku: line.StockingSKU._text
+              },
+              releaseQty: parseFloat(line.QuantityReleased._text)
+            })
+          }
+        })
+      }
+
+      if (ntsStatus == 'BACKORDER' && OrderLine.Item.some(itm => itm.QuantityReleased._text == 0)) {
+        checkDuplicationValidation = false
+      }
+
+      if (itemsToPick.length == 0) {
+        isAccept = false
+      }
+
+      let orderItems: any[] = itemsToPick
+
+      let result: any = {
+        ...orderInfo,
+        orderInventories: orderItems,
+        isAccept,
+        checkDuplicationValidation
+      }
+
+      return result
+    }
+  }
+}

package/server/controllers/herbalife/apis/index.ts

@@ -0,0 +1,4 @@
+export * from './echo'
+export * from './get-outbound-order'
+export * from './create-shipment'
+export * from './create-serial-number'

package/server/controllers/herbalife/herbalife.ts

@@ -0,0 +1,53 @@
+import '../../sftp-s3'
+
+import { xml2js } from 'xml-js'
+
+import { Sftp } from '../../service'
+import { SFTPFILESTORAGE } from '../../sftp-const'
+import { generateFiles } from '../../util/generate-files'
+
+const debug = require('debug')('things-factory:integration-sftp:herbalife')
+
+export type HerbalifeConfig = {}
+
+export class Herbalife {
+  constructor() {}
+
+  async get(path: string, data: any = {}) {
+    const fileResult: any = await SFTPFILESTORAGE.readFile(path, 'utf-8')
+    const item: any = xml2js(fileResult, {
+      compact: true
+    })
+    const result: any = { ...item }
+    return result
+  }
+
+  async post(path: string, data: any = {}) {
+    const {
+      title,
+      backupTitle,
+      content,
+      sftp,
+      backupPath
+    }: { title: string; backupTitle: string; content: string; sftp: Sftp; backupPath: string } = data
+
+    let params: any[] = [
+      {
+        title,
+        uploadPath: path,
+        content
+      }
+    ]
+
+    if (backupPath) {
+      params.push({
+        title: backupTitle,
+        uploadPath: backupPath,
+        content
+      })
+    }
+    await generateFiles(params)
+
+    return sftp
+  }
+}

package/server/controllers/herbalife/index.ts

@@ -0,0 +1,7 @@
+import { SftpAPI } from '../sftp-api'
+import * as APIS from './apis'
+import { action } from './platform-action'
+
+export * from './herbalife'
+
+SftpAPI.registerPlatform('herbalife', action, APIS)

package/server/controllers/herbalife/platform-action.ts

@@ -0,0 +1,34 @@
+import { Herbalife } from './herbalife'
+
+function substitute(path, obj) {
+  var props = []
+  var re = /{([^}]+)}/g
+  var text
+
+  while ((text = re.exec(path))) {
+    props.push(text[1])
+  }
+
+  var result = path
+  props.forEach(prop => {
+    let value = obj[prop.trim()]
+    result = result.replace(`{${prop}}`, value === undefined ? '' : value)
+  })
+
+  return result
+}
+
+export const action = async ({ method = 'get', path, request }) => {
+  const client = new Herbalife()
+
+  const { resource = {}, payload = {} } = request
+
+  path = substitute(path, resource)
+
+  var response = await client[method](path, payload)
+  if (response.errors) {
+    throw response
+  }
+
+  return response
+}

package/server/controllers/index.ts

@@ -0,0 +1,3 @@
+import './herbalife'
+
+export * from './sftp-api'

package/server/controllers/sftp-api/decorators.ts

@@ -0,0 +1,43 @@
+import Debug from 'debug'
+
+import { Sftp } from '../../service'
+
+const debug = Debug('things-factory:integration-sftp:sftp-api-decorator')
+
+const NOOP = v => v
+
+export const api = (target: Object, property: string, descriptor: TypedPropertyDescriptor<any>): any => {
+  const method = descriptor.value
+
+  descriptor.value = async function (sftp: Sftp, request) {
+    const SftpAPI = this
+
+    var { platform } = sftp
+
+    var { action: platformAction, apis } = SftpAPI.getPlatform(platform)
+
+    var m = apis[method.name]
+    if (!m) {
+      throw Error(`SFTP doesn't have API ${method.name}`)
+    }
+
+    var {
+      path,
+      method: httpMethod = 'post',
+      denormalize = NOOP,
+      normalize = NOOP,
+      action = platformAction
+    } = m.apply(this, [request])
+
+    var denormalized = await denormalize(request || {}, { sftp })
+    debug('request', denormalized)
+
+    var response = await action.apply(this, [{ sftp, method: httpMethod, path, request: denormalized, platformAction }])
+
+    debug('response', response)
+
+    return await normalize(response, { sftp })
+  }
+
+  return descriptor
+}

package/server/controllers/sftp-api/index.ts

@@ -0,0 +1,39 @@
+import { getRepository } from '@things-factory/shell'
+
+import { Sftp } from '../../service'
+import { api } from './decorators'
+
+export class SftpAPI {
+  static platforms = {}
+
+  static registerPlatform(name, action, apis) {
+    SftpAPI.platforms[name] = {
+      action,
+      apis
+    }
+  }
+
+  static getPlatform(name) {
+    return SftpAPI.platforms[name]
+  }
+
+  static async getSftp(id) {
+    const repository = getRepository(Sftp)
+    return await repository.findOne({
+      where: { id },
+      relations: ['domain']
+    })
+  }
+
+  @api
+  static echo(sftp, req): any {}
+
+  @api
+  static getOutboundOrder(sftp, req): any {}
+
+  @api
+  static createShipment(sftp, req): any {}
+
+  @api
+  static createSerialNumber(sftp, req): any {}
+}

package/server/index.ts

@@ -0,0 +1,7 @@
+import './routes'
+
+export * from './middlewares'
+export * from './service'
+export * from './sftp-const'
+export * from './controllers'
+export * from './util'

package/server/middlewares/index.ts

@@ -0,0 +1,3 @@
+export function initMiddlewares(app) {
+  /* can add middlewares into app */
+}

package/server/routes.ts

@@ -0,0 +1,28 @@
+const debug = require('debug')('things-factory:integration-sftp:routes')
+
+process.on('bootstrap-module-global-public-route' as any, (app, globalPublicRouter) => {
+  /*
+   * can add global public routes to application (auth not required, tenancy not required)
+   *
+   * ex) routes.get('/path', async(context, next) => {})
+   * ex) routes.post('/path', async(context, next) => {})
+   */
+})
+
+process.on('bootstrap-module-global-private-route' as any, (app, globalPrivateRouter) => {
+  /*
+   * can add global private routes to application (auth required, tenancy not required)
+   */
+})
+
+process.on('bootstrap-module-domain-public-route' as any, (app, domainPublicRouter) => {
+  /*
+   * can add domain public routes to application (auth not required, tenancy required)
+   */
+})
+
+process.on('bootstrap-module-domain-private-route' as any, (app, domainPrivateRouter) => {
+  /*
+   * can add domain private routes to application (auth required, tenancy required)
+   */
+})

package/server/service/index.ts

@@ -0,0 +1,18 @@
+/* EXPORT ENTITY TYPES */
+export * from './sftp/sftp'
+
+/* IMPORT ENTITIES AND RESOLVERS */
+import { entities as SftpEntities, resolvers as SftpResolvers } from './sftp'
+
+export const entities = [  
+  /* ENTITIES */
+	...SftpEntities,
+] 
+
+
+export const schema = {
+  resolverClasses: [
+    /* RESOLVER CLASSES */
+		...SftpResolvers,
+  ] 
+}

package/server/service/sftp/index.ts

@@ -0,0 +1,6 @@
+import { Sftp } from './sftp'
+import { SftpQuery } from './sftp-query'
+import { SftpMutation } from './sftp-mutation'
+
+export const entities = [Sftp]
+export const resolvers = [SftpQuery, SftpMutation]