@things-factory/integration-sellercraft 8.0.0-beta.9 → 8.0.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@things-factory/integration-sellercraft",
-  "version": "8.0.0-beta.9",
+  "version": "8.0.0",
   "main": "dist-server/index.js",
   "browser": "client/index.js",
   "things-factory": true,
@@ -24,18 +24,18 @@
     "migration:create": "node ../../node_modules/typeorm/cli.js migration:create ./server/migrations/migration"
   },
   "dependencies": {
-    "@operato/data-grist": "^8.0.0-beta",
-    "@things-factory/apptool-ui": "^8.0.0-beta.9",
-    "@things-factory/auth-ui": "^8.0.0-beta.9",
-    "@things-factory/biz-base": "^8.0.0-beta.9",
-    "@things-factory/code-ui": "^8.0.0-beta.9",
-    "@things-factory/context-ui": "^8.0.0-beta.9",
-    "@things-factory/i18n-base": "^8.0.0-beta.9",
-    "@things-factory/integration-marketplace": "^8.0.0-beta.9",
-    "@things-factory/integration-ui": "^8.0.0-beta.9",
-    "@things-factory/more-ui": "^8.0.0-beta.9",
-    "@things-factory/resource-ui": "^8.0.0-beta.9",
-    "@things-factory/setting-ui": "^8.0.0-beta.9",
+    "@operato/data-grist": "^8.0.0",
+    "@things-factory/apptool-ui": "^8.0.0",
+    "@things-factory/auth-ui": "^8.0.0",
+    "@things-factory/biz-base": "^8.0.0",
+    "@things-factory/code-ui": "^8.0.0",
+    "@things-factory/context-ui": "^8.0.0",
+    "@things-factory/i18n-base": "^8.0.0",
+    "@things-factory/integration-marketplace": "^8.0.0",
+    "@things-factory/integration-ui": "^8.0.0",
+    "@things-factory/more-ui": "^8.0.0",
+    "@things-factory/resource-ui": "^8.0.0",
+    "@things-factory/setting-ui": "^8.0.0",
     "debug": "^4.1.1",
     "node-fetch": "^2.6.0"
   },
@@ -49,5 +49,5 @@
     "nock": "^13.0.2",
     "should": "^13.2.3"
   },
-  "gitHead": "86b1dfa26292926a2d5447fdc23bfa5a9e983245"
+  "gitHead": "07ef27d272dd9a067a9648ac7013748510556a18"
 }

package/server/constants/index.ts

@@ -0,0 +1,2 @@
+export * from './platform'
+export * from './order-status-mapping'

package/server/constants/order-status-mapping.ts

@@ -0,0 +1,28 @@
+export const ORDER_STATUS = {
+  pending: 'CONFIRMED',
+  payment_pending: 'PAYMENT_PENDING',
+  ready_to_ship: 'READY_TO_SHIP',
+  processing: 'CONFIRMED',
+  shipped: 'SHIPPED',
+  completed: 'DELIVERED',
+  cancelled: 'CANCELLED',
+  canceled: 'CANCELLED',
+  refunded: 'REFUND_COMPLETE',
+  failed: 'SHIPMENT_LOST_OR_DAMAGED',
+  refund: 'REFUND_COMPLETE',
+  ttk_100: 'PAYMENT_PENDING', // UNPAID
+  ttk_111: 'CONFIRMED', // AWAITING_SHIPMENT
+  ttk_112: 'READY_TO_SHIP', // AWAITING_COLLECTION
+  ttk_121: 'SHIPPED', // IN_TRANSIT
+  ttk_122: 'DELIVERED', // DELIVERED
+  ttk_130: 'CLOSED', // COMPLETED
+  ttk_140: 'CANCELLED', // CANCELLED
+  ttk_201: 'INITIATED_CANCELLATION', // CANCEL_PENDING
+  ttk_202: '', // CANCEL_REJECT
+  ttk_203: 'CANCELLED' // CANCEL_COMPLETED
+}
+
+export const SHIPPING_TYPE = {
+  DROP_SHIPPING: 'DROP_SHIPPING',
+  CROSS_DOCKING_PICKUP: 'CROSS_DOCKING_PICKUP'
+}

package/server/constants/platform.ts

@@ -0,0 +1,6 @@
+export const PLATFORM = {
+  WCM: 'woocommerce',
+  MGT: 'magento',
+  TTK: 'tiktok',
+  SPF: 'shopify'
+}

package/server/controllers/index.ts

@@ -0,0 +1,5 @@
+import './sellercraft'
+
+export * from './sellercraft-api'
+export * from './sellercraft-channel-integration'
+export * from './sellercraft-channel-integration-api'

package/server/controllers/sellercraft/apis/add-inbound-order.ts

@@ -0,0 +1,50 @@
+/* https://docs.sellercraft.co/docs/api-integrations/b3A6MTY3OTk0Mjg-register-product-inbound */
+
+export function addInboundOrder() {
+  return {
+    method: 'post',
+    path: '/product/inbound',
+    denormalize(req) {
+      const { accountId, inboundId, inboundTime, inboundType, purchaseOrderId, sellercraftOPs } = req
+
+      let orderInformation: any = {}
+      orderInformation.account_id = accountId
+      orderInformation.inbound_id = inboundId
+      orderInformation.inbound_time = inboundTime
+      orderInformation.inbound_type = inboundType
+      orderInformation.purchase_order_id = purchaseOrderId
+
+      let products: any[] = sellercraftOPs.map(orderProduct => {
+        const { packageDimension, forceCreateProduct } = orderProduct
+        let sellercraftOP: any = {}
+        sellercraftOP.sku = orderProduct.sku
+        sellercraftOP.unit_of_measure = orderProduct.uom
+        sellercraftOP.purchase_order_quantity = orderProduct.purchaseOrderQty
+        sellercraftOP.received_quantity = orderProduct.receivedQty
+        sellercraftOP.batch_number = orderProduct.batchId
+        sellercraftOP.expiry_time = orderProduct?.expiryTime ? orderProduct.expiryTime : 0
+        sellercraftOP.force_create_product = forceCreateProduct
+        sellercraftOP.product_name = orderProduct.productName
+        sellercraftOP.gtin = orderProduct.gtin
+        sellercraftOP.package_weight_gm = orderProduct.weight
+        sellercraftOP.package_dimensions = {
+          length_mm: packageDimension.length,
+          width_mm: packageDimension.width,
+          height_mm: packageDimension.height
+        }
+
+        return sellercraftOP
+      })
+
+      return {
+        payload: {
+          ...orderInformation,
+          products
+        }
+      }
+    },
+    normalize(res) {
+      return res
+    }
+  }
+}

package/server/controllers/sellercraft/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/sellercraft/apis/fetch-order-document.ts

@@ -0,0 +1,18 @@
+/* https://docs.sellercraft.co/docs/api-integrations/b3A6MTY4ODQxNTc-fetch-order-documents */
+
+export function fetchOrderDocument() {
+  return {
+    method: 'get',
+    path: '/order/documents',
+    denormalize(req) {
+      const { accountId: account_id, orderId: order_id, packageId: package_id } = req
+      return {
+        payload: { account_id, order_id, package_id }
+      }
+    },
+    normalize(res) {
+      const { documents, tracking_no: trackingNo, shipper_name: transporter } = res.data
+      return { documents, trackingNo, transporter }
+    }
+  }
+}

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

@@ -0,0 +1,8 @@
+export * from './echo'
+export * from './add-inbound-order'
+export * from './fetch-order-document'
+export * from './initiate-order-document'
+export * from './initiate-order-shipment'
+export * from './pack-marketplace-order'
+export * from './update-marketplace-order'
+export * from './update-product'

package/server/controllers/sellercraft/apis/initiate-order-document.ts

@@ -0,0 +1,17 @@
+/* https://docs.sellercraft.co/docs/api-integrations/b3A6MTY4ODAzMjg-initiate-order-documents */
+
+export function initiateOrderDocument() {
+  return {
+    method: 'post',
+    path: '/order/documents',
+    denormalize(req) {
+      const { accountId: account_id, orderId: order_id, packageId: package_id } = req
+      return {
+        payload: { account_id, order_id, package_id }
+      }
+    },
+    normalize(res) {
+      return res
+    }
+  }
+}

package/server/controllers/sellercraft/apis/initiate-order-shipment.ts

@@ -0,0 +1,29 @@
+/* https://docs.sellercraft.co/docs/api-integrations/b3A6MTY4NjQxODU-initiate-order-shipment */
+
+export function initiateOrderShipment() {
+  return {
+    method: 'post',
+    path: '/order/ship',
+    denormalize(req) {
+      const { accountId: account_id, orderId: order_id, packageId: package_id } = req
+      return {
+        payload: { account_id, order_id, package_id }
+      }
+    },
+    normalize(res) {
+      const {
+        handover_type: handOverType,
+        pickup_time: pickupTime,
+        pickup_address: pickupAddress,
+        dropoff_address: dropoffAddress
+      } = res.data
+
+      return {
+        handOverType,
+        pickupTime,
+        pickupAddress,
+        dropoffAddress
+      }
+    }
+  }
+}

package/server/controllers/sellercraft/apis/pack-marketplace-order.ts

@@ -0,0 +1,35 @@
+/* https://docs.sellercraft.co/docs/api-integrations/b3A6MTY4NTc0NjI-pack-an-order */
+
+export function packMarketplaceOrder() {
+  return {
+    method: 'post',
+    path: '/order/pack',
+    denormalize(req) {
+      const { accountId: account_id, orderId: order_id, sellercraftOPs } = req
+
+      const items: any[] = sellercraftOPs.map(orderProduct => {
+        return {
+          sku: orderProduct.sku,
+          quantity: orderProduct.releaseQty,
+          unit_of_measure: orderProduct.uom
+        }
+      })
+
+      let packages: any[] = []
+      packages.push({ items })
+
+      return {
+        payload: {
+          account_id,
+          order_id,
+          packages
+        }
+      }
+    },
+    normalize(res) {
+      const { packages } = res.data
+      const packageId: string = packages[0].package_id
+      return packageId
+    }
+  }
+}

package/server/controllers/sellercraft/apis/update-marketplace-order.ts

@@ -0,0 +1,14 @@
+/* https://docs.sellercraft.co/docs/api-integrations/b3A6MTY4OTA0NDM-amend-an-order */
+
+export function updateMarketplaceOrder() {
+  return {
+    method: 'put',
+    path: '/order',
+    denormalize(req) {
+      return req
+    },
+    normalize(res) {
+      return res
+    }
+  }
+}

package/server/controllers/sellercraft/apis/update-product.ts

@@ -0,0 +1,21 @@
+/* https://docs.sellercraft.co/docs/api-integrations/b3A6MTY4OTE3MTA-update-product */
+
+export function updateProduct() {
+  return {
+    method: 'put',
+    path: '/product',
+    denormalize(req) {
+      const { accountId, sellercraftInv } = req
+
+      return {
+        payload: {
+          account_id: accountId,
+          products: sellercraftInv
+        }
+      }
+    },
+    normalize(res) {
+      return res
+    }
+  }
+}

package/server/controllers/sellercraft/index.ts

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

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

@@ -0,0 +1,39 @@
+import { config } from '@things-factory/env'
+
+import { Sellercraft } from './sellercraft'
+
+const sellercraftConfig = config.get('sellercraftIntegrationConfig', {})
+const { apiKey } = sellercraftConfig
+
+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 Sellercraft({ apiKey })
+
+  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/sellercraft/sellercraft.ts

@@ -0,0 +1,109 @@
+import fetch from 'node-fetch'
+import { v4 as uuidv4 } from 'uuid'
+
+const debug = require('debug')('things-factory:integration-sellercraft:sellercraft')
+
+export type SellercraftConfig = {
+  apiKey: string
+}
+
+export class Sellercraft {
+  private config: SellercraftConfig
+
+  constructor(config: SellercraftConfig) {
+    this.config = {
+      ...config
+    }
+  }
+
+  getBaseUrl() {
+    return `https://open.sellercraft.co/v1`
+  }
+
+  generateRequestId() {
+    return uuidv4()
+  }
+
+  async post(path: string, data: any = {}) {
+    const { apiKey } = this.config
+
+    debug('data', data)
+
+    const jsondata = JSON.stringify(data)
+    const requestId: string = this.generateRequestId()
+    const fullPath: string = `${this.getBaseUrl()}${path}`
+
+    const response: any = await fetch(fullPath, {
+      method: 'post',
+      headers: {
+        'Content-Type': 'application/json',
+        request_id: requestId,
+        'x-api-key': apiKey
+      },
+      body: jsondata
+    })
+
+    if (response.ok) {
+      return await response.json()
+    } else {
+      const result = await response.text()
+      throw new Error(`(${response.status}) ${result}`)
+    }
+  }
+
+  async put(path: string, data: any = {}) {
+    const { apiKey } = this.config
+
+    const jsondata = JSON.stringify(data)
+    const requestId: string = this.generateRequestId()
+    const fullPath: string = `${this.getBaseUrl()}${path}`
+    debug('data', data)
+
+    const response: any = await fetch(fullPath, {
+      method: 'put',
+      headers: {
+        'Content-Type': 'application/json',
+        request_id: requestId,
+        'x-api-key': apiKey
+      },
+      body: jsondata
+    })
+
+    if (response.ok) {
+      return await response.json()
+    } else {
+      const result = await response.text()
+      throw new Error(`(${response.status}) ${result}`)
+    }
+  }
+
+  async get(path: string, data: any = {}) {
+    const { apiKey } = this.config
+
+    const qs = Object.entries(data)
+      .map(([k, v]) => `${k}=${encodeURIComponent(String(v))}`)
+      .join('&')
+
+    const fullPath: string = `${this.getBaseUrl()}${path}`
+    const endpoint = `${fullPath}${qs ? '?' + qs : ''}`
+    debug('endpoint', endpoint)
+
+    const requestId: string = this.generateRequestId()
+
+    const response: any = await fetch(endpoint, {
+      method: 'get',
+      headers: {
+        'Content-Type': 'application/json',
+        request_id: requestId,
+        'x-api-key': apiKey
+      }
+    })
+
+    if (response.ok) {
+      return await response.json()
+    } else {
+      const result = await response.text()
+      throw new Error(`(${response.status}) ${result}`)
+    }
+  }
+}

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

@@ -0,0 +1,52 @@
+import Debug from 'debug'
+const debug = Debug('things-factory:integration-marketplace:store-api-decorator')
+
+import { Sellercraft } from '../../service'
+import { createPayloadLog } from '@things-factory/integration-base'
+
+const NOOP = v => v
+
+export const api = (target: Object, property: string, descriptor: TypedPropertyDescriptor<any>): any => {
+  const method = descriptor.value
+
+  descriptor.value = async function (store: Sellercraft, request) {
+    const SellercraftAPI = this
+
+    var { platform } = store
+
+    var { action: platformAction, apis } = SellercraftAPI.getPlatform(platform)
+
+    var m = apis[method.name]
+    if (!m) {
+      throw Error(`Sellercraft 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 || {}, { store })
+    debug('request', denormalized)
+
+    try {
+      var response = await action.apply(this, [
+        { store, method: httpMethod, path, request: denormalized, platformAction }
+      ])
+
+      createPayloadLog(store.accountId, path, denormalized, response, request?.context)
+
+      debug('response', response)
+
+      return await normalize(response, { store })
+    } catch (error) {
+      createPayloadLog(store.accountId, path, denormalized, error, request?.context)
+      throw error
+    }
+  }
+
+  return descriptor
+}

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

@@ -0,0 +1,51 @@
+import { getRepository } from '@things-factory/shell'
+
+import { Sellercraft } from '../../service'
+import { api } from './decorators'
+
+export class SellercraftAPI {
+  static platforms = {}
+
+  static registerPlatform(name, action, apis) {
+    SellercraftAPI.platforms[name] = {
+      action,
+      apis
+    }
+  }
+
+  static getPlatform(name) {
+    return SellercraftAPI.platforms[name]
+  }
+
+  static async getSellercraft(id) {
+    const repository = getRepository(Sellercraft)
+    return await repository.findOne({
+      where: { id },
+      relations: ['domain']
+    })
+  }
+
+  @api
+  static echo(sellercraft, req): any {}
+
+  @api
+  static addInboundOrder(sellercraft, req): any {}
+
+  @api
+  static fetchOrderDocument(sellercraft, req): any {}
+
+  @api
+  static initiateOrderDocument(sellercraft, req): any {}
+
+  @api
+  static initiateOrderShipment(sellercraft, req): any {}
+
+  @api
+  static packMarketplaceOrder(sellercraft, req): any {}
+
+  @api
+  static updateMarketplaceOrder(sellercraft, req): any {}
+
+  @api
+  static updateProduct(sellercraft, req): any {}
+}

package/server/controllers/sellercraft-channel-integration/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/sellercraft-channel-integration/apis/index.ts

@@ -0,0 +1,6 @@
+export * from './echo'
+export * from './ingest-channel-categories'
+export * from './ingest-channel-category-attributes'
+export * from './ingest-channel-order-package'
+export * from './ingest-channel-order'
+export * from './ingest-channel-product'

package/server/controllers/sellercraft-channel-integration/apis/ingest-channel-categories.ts

@@ -0,0 +1,37 @@
+/* https://docs.sellercraft.co/docs/api-integrations/b3A6MTY4NjQxODU-initiate-order-shipment */
+
+export function ingestChannelCategories() {
+  return {
+    method: 'post',
+    path: '/channel/ingest/category',
+    denormalize(req) {
+      const { categories } = req
+
+      let newCategories = mapCategories(categories)
+
+      return {
+        payload: [...newCategories]
+      }
+    },
+    normalize(res) {
+      return res
+    }
+  }
+}
+
+function mapCategories(categories) {
+  if (!categories) return null
+  categories = categories.map(category => {
+    let children_categories = mapCategories(category.childrenCategories)
+    return {
+      native_category_id: category.categoryId.toString(),
+      channel_code: category.channelCode,
+      channel_country: category.countryCode,
+      category_name: category.categoryName,
+      is_leaf: children_categories.length == 0 ? true : false,
+      is_active: category.isActive,
+      children_categories
+    }
+  })
+  return categories
+}