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

package/server/controllers/woocommerce/apis/update-store-product-variation-stock.ts

@@ -0,0 +1,20 @@
+/* https://woocommerce.github.io/woocommerce-rest-api-docs/?javascript#update-a-product-variation */
+/* /wp-json/wc/v3/products/<product_id>/variations/<id> */
+
+export function updateStoreProductVariationStock(req) {
+  return {
+    method: 'put',
+    path: '/products/{itemId}/variations/{variationId}',
+    denormalize(req) {
+      var { qty, itemId, variationId } = (Array.isArray(req) ? req[0] : req) || {}
+
+      return {
+        resource: { itemId: parseInt(itemId), variationId: parseInt(variationId) },
+        payload: { stock_quantity: qty, manage_stock: true }
+      }
+    },
+    normalize(res) {
+      return res
+    }
+  }
+}

package/server/controllers/woocommerce/index.ts

@@ -0,0 +1,8 @@
+export * from './woocommerce'
+
+import { StoreAPI } from '../store-api'
+
+import { action } from './platform-action'
+import * as APIS from './apis'
+
+StoreAPI.registerPlatform('woocommerce', action, APIS)

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

@@ -0,0 +1,48 @@
+import { Woocommerce } from './woocommerce'
+
+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
+}
+
+/**
+ * @summary Building Path Method and Payload
+ * @description After denormalise of data is done,
+ * platform API method will be called with its path and payload,
+ * this section is to build path and substitution of the resource in url as well as the payload for body request.
+ * Every woocommerce API call requires consumer_key, consumer_secret, storeUrl, queryStringAuth.
+ * consumer_key, consumer_secret, storeUrl are retrieved from database, queryStringAuth must always set to true
+ * to avoid permission error from Woocommerce.
+ */
+export const action = async ({ store, method = 'get', path, request }) => {
+  const client = new Woocommerce({
+    consumer_key: store.accessKey,
+    consumer_secret: store.accessSecret,
+    storeURL: store.storeURL,
+    queryStringAuth: true
+  })
+
+  const { resource = {}, payload = {} } = request
+
+  path = substitute(path, resource)
+
+  var response = await client[method](path, payload)
+  if (response.code) {
+    throw response
+  }
+
+  return response
+}

package/server/controllers/woocommerce/woocommerce.ts

@@ -0,0 +1,104 @@
+import fetch from 'node-fetch'
+
+const debug = require('debug')('things-factory:integration-marketplace:woocommerce')
+
+export type WoocommerceConfig = {
+  consumer_key: string
+  consumer_secret: string
+  storeURL: string
+  queryStringAuth: Boolean
+}
+
+export class Woocommerce {
+  private config: WoocommerceConfig
+
+  constructor(config: WoocommerceConfig) {
+    this.config = {
+      ...config
+    }
+  }
+
+  /**
+   * @summary Get Method
+   * @description Using v3 API, map the consumer_key, consumer_secret to the endpoint path.
+   * X-WP-Total is to get the total items from the response
+   */
+  async get(path: string, data: any) {
+    const { consumer_key, consumer_secret, storeURL, queryStringAuth } = this.config
+
+    const qs = Object.entries(data)
+      .map(([k, v]) => `${k}=${encodeURIComponent(String(v))}`)
+      .join('&')
+
+    const endpoint = `${storeURL}/wp-json/wc/v3${path}?consumer_key=${consumer_key}&consumer_secret=${consumer_secret}&query_string_auth=${queryStringAuth}&${
+      qs ? '&' + qs : ''
+    }`
+    debug('endpoint', endpoint)
+
+    const response = await fetch(endpoint, {
+      headers: {
+        'Content-Type': 'application/json'
+      }
+    })
+
+    const totalItems = response.headers.get('X-WP-Total')
+    const totalPages = response.headers.get('X-WP-TotalPages')
+    const link = response.headers.get('Link')
+
+    var result: any = {}
+    result.items = await response.json()
+    result.totalItems = totalItems
+    result.totalPages = totalPages
+    result.link = link
+
+    debug('response result', result)
+
+    return result
+  }
+
+  async post(path: string, data: any = {}) {
+    const { consumer_key, consumer_secret, storeURL } = this.config
+
+    debug('data', data)
+
+    const jsondata = JSON.stringify(data)
+
+    const endpoint = `${storeURL}/wp-json/wc/v3${path}?consumer_key=${consumer_key}&consumer_secret=${consumer_secret}`
+
+    const response = await fetch(endpoint, {
+      method: 'post',
+      headers: {
+        'Content-Type': 'application/json'
+      },
+      body: jsondata
+    })
+
+    const result = await response.json()
+    debug('response result', result)
+
+    return result
+  }
+
+  async put(path: string, data: any = {}) {
+    const { consumer_key, consumer_secret, storeURL } = this.config
+
+    debug('data', data)
+
+    const jsondata = JSON.stringify(data)
+
+    const endpoint = `${storeURL}/wp-json/wc/v3${path}?consumer_key=${consumer_key}&consumer_secret=${consumer_secret}`
+
+    const response = await fetch(endpoint, {
+      method: 'put',
+      headers: {
+        'Content-Type': 'application/json'
+      },
+      body: jsondata
+    })
+
+    const result = await response.json()
+    debug('response result', result)
+
+    return result
+  }
+}

package/server/controllers/zalora/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/zalora/apis/get-airway-bill.ts

@@ -0,0 +1,17 @@
+export function getAirwayBill() {
+  return {
+    path: '/FIXME',
+    denormalize(req) {
+      return {
+        x: 'a',
+        y: 'y'
+      }
+    },
+    normalize(res) {
+      return {
+        a: 'a',
+        b: 'y'
+      }
+    }
+  }
+}

package/server/controllers/zalora/apis/get-store-order-items.ts

@@ -0,0 +1,17 @@
+export function getStoreOrderItems() {
+  return {
+    method: 'get',
+    path: 'GetOrderItems',
+    denormalize(req) {
+      const { orderId: OrderId } = req
+      return {
+        query: {
+          OrderId
+        }
+      }
+    },
+    normalize(res) {
+      return res.OrderItems.OrderItem
+    }
+  }
+}

package/server/controllers/zalora/apis/get-store-order.ts

@@ -0,0 +1,17 @@
+export function getStoreOrder() {
+  return {
+    method: 'get',
+    path: 'GetOrder',
+    denormalize(req) {
+      const { orderId: OrderId } = req
+      return {
+        query: {
+          OrderId
+        }
+      }
+    },
+    normalize(res) {
+      return res.Orders.Order
+    }
+  }
+}

package/server/controllers/zalora/apis/get-store-orders.ts

@@ -0,0 +1,21 @@
+export function getStoreOrders() {
+  return {
+    method: 'get',
+    path: 'GetOrders',
+    denormalize(req) {
+      var { pagination } = req || {}
+      var { page = 0, limit = 100 } = pagination || {}
+
+      return {
+        query: {
+          Limit: limit,
+          Offset: page * limit,
+          Status: 'pending'
+        }
+      }
+    },
+    normalize(res) {
+      return res.Orders.Order
+    }
+  }
+}

package/server/controllers/zalora/apis/get-store-product-categories.ts

@@ -0,0 +1,20 @@
+export function getStoreProductCategories() {
+  return {
+    method: 'get',
+    path: 'GetCategoryTree',
+    denormalize(req) {
+      var { pagination } = req || {}
+      var { page = 0, limit = 100 } = pagination || {}
+
+      return {
+        query: {
+          Limit: limit,
+          Offset: page * limit
+        }
+      }
+    },
+    normalize(res) {
+      return res.Categories.Category
+    }
+  }
+}

package/server/controllers/zalora/apis/get-store-product-category-attributes.ts

@@ -0,0 +1,18 @@
+export function getStoreProductCategoryAttributes() {
+  return {
+    method: 'get',
+    path: 'GetCategoryAttributes',
+    denormalize(req) {
+      var { categoryId: PrimaryCategory } = req || {}
+
+      return {
+        query: {
+          PrimaryCategory
+        }
+      }
+    },
+    normalize(res) {
+      return res.Attribute
+    }
+  }
+}

package/server/controllers/zalora/apis/get-store-products.ts

@@ -0,0 +1,20 @@
+export function getStoreProducts() {
+  return {
+    method: 'get',
+    path: 'GetProducts',
+    denormalize(req) {
+      var { pagination } = req || {}
+      var { page = 0, limit = 100 } = pagination || {}
+
+      return {
+        query: {
+          Limit: limit,
+          Offset: page * limit
+        }
+      }
+    },
+    normalize(res) {
+      return res.Products.Product
+    }
+  }
+}

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

@@ -0,0 +1,8 @@
+export * from './echo'
+export * from './get-airway-bill'
+export * from './get-store-orders'
+export * from './get-store-order'
+export * from './get-store-order-items'
+export * from './get-store-product-categories'
+export * from './get-store-product-category-attributes'
+export * from './get-store-products'

package/server/controllers/zalora/index.ts

@@ -0,0 +1,8 @@
+export * from './zalora'
+
+import { StoreAPI } from '../store-api'
+
+import { action } from './platform-action'
+import * as APIS from './apis'
+
+StoreAPI.registerPlatform('zalora', action, APIS)

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

@@ -0,0 +1,18 @@
+import { Zalora } from './zalora'
+
+export const action = async ({ store, path, method = 'get', request }) => {
+  const client = new Zalora({
+    apiKey: store.accessToken,
+    userId: store.storeId,
+    countryCode: store.countryCode?.toLowerCase()
+  })
+
+  const { query, payload } = request
+
+  var response = await client[method.toLowerCase()](path, query, payload)
+  if (response.ErrorResponse) {
+    throw response
+  }
+
+  return response.SuccessResponse?.Body
+}

package/server/controllers/zalora/zalora/index.ts

@@ -0,0 +1,70 @@
+import fetch from 'node-fetch'
+import Debug from 'debug'
+import { makeQueryString } from './signature'
+import { xmlize } from './xml'
+
+const debug = Debug('things-factory:integration-marketplace:zalora')
+
+export type ZaloraConfig = {
+  userId: string
+  apiKey: string
+  countryCode: string
+}
+
+export class Zalora {
+  config: ZaloraConfig
+
+  constructor(config: ZaloraConfig) {
+    this.config = {
+      ...config
+    }
+  }
+
+  getBaseUrl() {
+    return `https://sellercenter-api.zalora.com.${this.config.countryCode}`
+  }
+
+  async get(action, query) {
+    var endpoint =
+      this.getBaseUrl() +
+      '?' +
+      makeQueryString({
+        userId: this.config.userId,
+        action,
+        apiKey: this.config.apiKey,
+        query
+      })
+
+    debug('endpoint', endpoint)
+
+    const response = await fetch(endpoint, {
+      method: 'get'
+    })
+
+    return await response.json()
+  }
+
+  async post(action, query: any, payload: any) {
+    var endpoint =
+      this.getBaseUrl() +
+      '?' +
+      makeQueryString({
+        userId: this.config.userId,
+        action,
+        apiKey: this.config.apiKey,
+        query
+      })
+
+    debug('endpoint', endpoint)
+
+    const response = await fetch(endpoint, {
+      method: 'post',
+      headers: {
+        'Content-Type': 'application/x-www-form-urlencoded'
+      },
+      body: payload ? xmlize(payload) : ''
+    })
+
+    return await response.json()
+  }
+}

package/server/controllers/zalora/zalora/signature.ts

@@ -0,0 +1,37 @@
+import crypto from 'crypto'
+
+type Parameter = {
+  [key: string]: any
+}
+
+function querystring(params: Parameter) {
+  return Object.keys(params)
+    .map(k => encodeURIComponent(k) + '=' + encodeURIComponent(params[k]))
+    .join('&')
+}
+
+function makeSignature(apiKey: string, params: Parameter): string {
+  var sorted = Object.entries(params)
+    .sort(([k1, v1], [k2, v2]) => (k2 > k1 ? -1 : 1))
+    .map(([k, v]) => `${encodeURIComponent(k)}=${encodeURIComponent(v)}`)
+    .join('&')
+
+  return crypto.createHmac('sha256', apiKey).update(sorted).digest('hex')
+}
+
+export function makeQueryString({ userId, action, apiKey, query }): string {
+  const signatureParams = {
+    UserID: userId,
+    Version: '1.0',
+    Action: action,
+    Format: 'JSON',
+    Timestamp: new Date().toISOString(),
+    ...query
+  }
+
+  return querystring({
+    ...signatureParams,
+    Signature: makeSignature(apiKey, signatureParams),
+    ...query
+  })
+}

package/server/controllers/zalora/zalora/xml.ts

@@ -0,0 +1,24 @@
+function OBJtoXML(obj) {
+  var xml = ''
+  for (var prop in obj) {
+    xml += obj[prop] instanceof Array ? '' : '<' + prop + '>'
+    if (obj[prop] instanceof Array) {
+      for (var array in obj[prop]) {
+        xml += '<' + prop + '>'
+        xml += OBJtoXML(new Object(obj[prop][array]))
+        xml += '</' + prop + '>'
+      }
+    } else if (typeof obj[prop] == 'object') {
+      xml += OBJtoXML(new Object(obj[prop]))
+    } else {
+      xml += obj[prop]
+    }
+    xml += obj[prop] instanceof Array ? '' : '</' + prop + '>'
+  }
+  var xml = xml.replace(/<\/?[0-9]{1,}>/g, '')
+  return xml
+}
+
+export function xmlize(obj) {
+  return '<?xml version="1.0" encoding="UTF-8" ?>' + OBJtoXML(obj)
+}

package/server/engine/connector/index.ts

@@ -0,0 +1,3 @@
+import './lazada-connector'
+import './shopee-connector'
+import './marketplace-connector'

package/server/engine/connector/lazada-connector.ts

@@ -0,0 +1,49 @@
+import { config } from '@things-factory/env'
+import { ConnectionManager, Connector } from '@things-factory/integration-base'
+import { getRepository } from '@things-factory/shell'
+
+import { Lazada } from '../../controllers/lazada'
+import { MarketplaceStore } from '../../entities'
+
+const lazadaConfig = config.get('marketplaceIntegrationLazada', {})
+const { appKey, appSecret } = lazadaConfig
+
+export class LazadaConnector implements Connector {
+  async ready(connectionConfigs) {
+    await Promise.all(connectionConfigs.map(this.connect))
+
+    ConnectionManager.logger.info('lazada-connector connections are ready')
+  }
+
+  async connect(connection) {
+    const { domain, name, endpoint: storeId } = connection
+
+    const repository = getRepository(MarketplaceStore)
+    const marketplaceStore: any = await repository.findOne({
+      where: { domain: { id: domain.id }, storeId }
+    })
+
+    const client = new Lazada(marketplaceStore.countryCode, appKey, appSecret)
+    client.accessToken = marketplaceStore.accessToken
+
+    ConnectionManager.addConnectionInstance(connection, client)
+
+    ConnectionManager.logger.info(`lazada-connector connection(${name}:${connection.endpoint}) is connected`)
+  }
+
+  async disconnect(connection) {
+    ConnectionManager.removeConnectionInstance(connection)
+
+    ConnectionManager.logger.info(`lazada-connector connection(${connection.name}) is disconnected`)
+  }
+
+  get parameterSpec() {
+    return []
+  }
+
+  get taskPrefixes() {
+    return ['lazada']
+  }
+}
+
+ConnectionManager.registerConnector('lazada-connector', new LazadaConnector())

package/server/engine/connector/marketplace-connector.ts

@@ -0,0 +1,33 @@
+import { ConnectionManager, Connector } from '@things-factory/integration-base'
+
+export class MarketplaceConnector implements Connector {
+  async ready(connectionConfigs) {
+    await Promise.all(connectionConfigs.map(this.connect))
+
+    ConnectionManager.logger.info('marketplace-connector connections are ready')
+  }
+
+  async connect(connection) {
+    const { domain, name, endpoint } = connection
+
+    ConnectionManager.addConnectionInstance(connection, { ...connection })
+
+    ConnectionManager.logger.info(`marketplace-connector connection(${name}:${connection.endpoint}) is connected`)
+  }
+
+  async disconnect(connection) {
+    ConnectionManager.removeConnectionInstance(connection)
+
+    ConnectionManager.logger.info(`marketplace-connector connection(${connection.name}) is disconnected`)
+  }
+
+  get parameterSpec() {
+    return []
+  }
+
+  get taskPrefixes() {
+    return ['marketplace']
+  }
+}
+
+ConnectionManager.registerConnector('marketplace-connector', new MarketplaceConnector())

package/server/engine/connector/shopee-connector.ts

@@ -0,0 +1,46 @@
+import { ConnectionManager, Connector } from '@things-factory/integration-base'
+import { Shopee } from '../../controllers/shopee/shopee'
+
+import { config } from '@things-factory/env'
+const shopeeConfig = config.get('marketplaceIntegrationShopee', {})
+const { partnerId, partnerKey, isUAT } = shopeeConfig
+
+export class ShopeeConnector implements Connector {
+  async ready(connectionConfigs) {
+    await Promise.all(connectionConfigs.map(this.connect))
+
+    ConnectionManager.logger.info('shopee-connector connections are ready')
+  }
+
+  async connect(connection) {
+    var { name, endpoint: shopId } = connection
+
+    ConnectionManager.logger.info(`shopee config: ${partnerId}, ${partnerKey}`)
+    const client = new Shopee({
+      isUAT: isUAT,
+      shopid: Number(shopId),
+      partner_id: partnerId,
+      partner_key: partnerKey
+    })
+
+    ConnectionManager.addConnectionInstance(connection, client)
+
+    ConnectionManager.logger.info(`shopee-connector connection(${name}:${connection.endpoint}) is connected`)
+  }
+
+  async disconnect(connection) {
+    ConnectionManager.removeConnectionInstance(connection)
+
+    ConnectionManager.logger.info(`shopee-connector connection(${connection.name}) is disconnected`)
+  }
+
+  get parameterSpec() {
+    return []
+  }
+
+  get taskPrefixes() {
+    return ['shopee']
+  }
+}
+
+ConnectionManager.registerConnector('shopee-connector', new ShopeeConnector())

package/server/engine/index.ts

@@ -0,0 +1,2 @@
+import './connector'
+import './task'

package/server/engine/task/index.ts

@@ -0,0 +1,4 @@
+import './shopee-post'
+import './lazada-get'
+import './lazada-post'
+import './marketplace-api'