@things-factory/integration-marketplace 4.2.3 → 4.2.8

package/server/controllers/tiktok/apis/get-store-product.ts

@@ -0,0 +1,95 @@
+/* https://bytedance.feishu.cn/docs/doccnDyz5Bbk26iOdejbBRBlLrb#ytBXoS */
+
+/* status: 0-all, 1-draft, 2-pending, 3-failed, 4-live, 5-seller_deactivated, 
+           6-platform-deactivated, 7-freeze, 8-deleted 
+*/
+
+export function getStoreProduct() {
+  return {
+    method: 'get',
+    path: '/api/products/details',
+    denormalize(req) {
+      var { productId } = req || {}
+
+      return { payload: { product_id: productId } }
+    },
+    async normalize(res) {
+      const { data } = res
+
+      const productVariations: any[] = data.skus
+
+      let variants: any[] = []
+      if (productVariations && productVariations?.length > 0) {
+        variants = productVariations.map(variant => {
+          let totalProductQty: number = 0
+          let stockInfos = variant.stock_infos
+          stockInfos.map(stockInfo => {
+            totalProductQty += stockInfo.available_stock
+          })
+
+          return {
+            variationId: variant.id,
+            variationSku: variant.seller_sku || variant.id.toString(),
+            channelSku: variant.seller_sku || variant.id.toString(),
+            name: data.product_name,
+            qty: totalProductQty,
+            primaryUnit: 'N/A',
+            primaryUnitValue: data.package_weight === '' ? null : parseFloat(data.package_weight),
+            costPrice: variant.price.original_price === '' ? null : parseFloat(variant.price.original_price),
+            sellPrice: variant.price.original_price === '' ? null : parseFloat(variant.price.original_price),
+            isEnabled: data.product_status == 4 ? true : false,
+            length: data?.package_length ? data.package_length * 10 : 1,
+            width: data?.package_width ? data.package_width * 10 : 1,
+            height: data?.package_height ? data.package_height * 10 : 1,
+            weight: data.package_weight === '' ? null : parseFloat(data.package_weight)
+          }
+        })
+      } else {
+        variants = [
+          {
+            variationId: data.product_id,
+            variationSku: data.product_name,
+            channelSku: data.product_name,
+            name: data.product_name,
+            qty: 0,
+            primaryUnit: 'N/A',
+            primaryUnitValue: data.package_weight === '' ? null : parseFloat(data.package_weight),
+            costPrice: null,
+            sellPrice: null,
+            isEnabled: data.product_status == 4 ? true : false,
+            length: data?.package_length ? data.package_length * 10 : 1,
+            width: data?.package_width ? data.package_width * 10 : 1,
+            height: data?.package_height ? data.package_height * 10 : 1,
+            weight: data.package_weight === '' ? null : parseFloat(data.package_weight)
+          }
+        ]
+      }
+
+      const result = {
+        itemId: data.product_id,
+        name: data.product_name,
+        brand: data?.brand?.name || null,
+        isVerified: data.product_status == 4 ? true : false,
+        categoryId: data?.category_list?.length > 0 ? data.category_list[0].id : '',
+        images: getImageUrl(data.images),
+        variations: variants
+      }
+
+      return result
+    }
+  }
+}
+
+function getImageUrl(images) {
+  let imageSrc: any = []
+
+  if (images) {
+    images.map(image => {
+      image.url_list.map(url => {
+        imageSrc.push(url)
+      })
+    })
+  }
+
+  return imageSrc
+}

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

@@ -0,0 +1,38 @@
+/* https://bytedance.feishu.cn/docs/doccnDyz5Bbk26iOdejbBRBlLrb#ytBXoS */
+
+/* status: 0-all, 1-draft, 2-pending, 3-failed, 4-live, 5-seller_deactivated, 
+           6-platform-deactivated, 7-freeze, 8-deleted 
+*/
+
+import { StoreAPI } from '../../store-api'
+
+export function getStoreProducts() {
+  return {
+    method: 'post',
+    path: '/api/products/search',
+    denormalize(req) {
+      var { pagination } = req || {}
+      var { page, limit } = pagination || { page: 0, limit: 100 }
+
+      return {
+        payload: { page_size: limit, page_number: page + 1, search_status: 0 },
+        resource: {}
+      }
+    },
+    async normalize(res, { store }) {
+      const { data } = res
+
+      const products: any[] = data?.products || []
+      const total: number = data?.total || 0
+
+      let results: any[] = []
+      for (let i = 0; i < products.length; i++) {
+        const product: any = products[i]
+        const productDetails = await StoreAPI.getStoreProduct(store, { productId: product.id })
+        results.push({ ...productDetails })
+      }
+
+      return { results, total }
+    }
+  }
+}

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

@@ -0,0 +1,13 @@
+export * from './echo'
+export * from './get-store-order'
+export * from './get-store-orders'
+export * from './get-store-order-document'
+export * from './get-store-order-packages'
+export * from './get-store-order-package'
+export * from './get-store-product-attributes'
+export * from './get-store-product-categories'
+export * from './get-store-product'
+export * from './get-store-products'
+export * from './update-store-product-variation-stock'
+export * from './update-store-product-variation-price'
+export * from './update-order-status'

package/server/controllers/tiktok/apis/update-order-status.ts

@@ -0,0 +1,22 @@
+export function updateOrderStatus() {
+  return {
+    path: '/api/order/rts',
+    method: 'post',
+    async denormalize(req, { store }) {
+      let { orderId, status } = req
+
+      if (status == 'ready_to_ship') {
+        return {
+          payload: {
+            order_id: orderId
+          }
+        }
+      } else {
+        return
+      }
+    },
+    normalize(res) {
+      return res
+    }
+  }
+}

package/server/controllers/tiktok/apis/update-store-product-variation-price.ts

@@ -0,0 +1,24 @@
+export function updateStoreProductVariationPrice() {
+  return {
+    path: '/api/products/prices',
+    method: 'put',
+    denormalize(req) {
+      const { variationId, sellPrice, productId } = (Array.isArray(req) ? req[0] : req) || {}
+
+      return {
+        payload: {
+          product_id: productId,
+          skus: [
+            {
+              id: variationId,
+              original_price: sellPrice.toString()
+            }
+          ]
+        }
+      }
+    },
+    normalize(res) {
+        return res
+    }
+  }
+}

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

@@ -0,0 +1,28 @@
+export function updateStoreProductVariationStock() {
+  return {
+    method: 'put',
+    path: '/api/products/stocks',
+    denormalize(req) {
+      const { variationId, qty, itemId } = (Array.isArray(req) ? req[0] : req) || {}
+
+      return {
+        payload: {
+          product_id: itemId,
+          skus: [
+            {
+              id: variationId,
+              stock_infos: [
+                {
+                  available_stock: qty
+                }
+              ]
+            }
+          ]
+        }
+      }
+    },
+    normalize(res) {
+      return res
+    }
+  }
+}

package/server/controllers/tiktok/client/index.ts

@@ -0,0 +1,2 @@
+export * from './types'
+export * from './tiktok'

package/server/controllers/tiktok/client/signature.ts

@@ -0,0 +1,78 @@
+import crypto from 'crypto'
+import { Parameter, PublicRequestParameters } from './types'
+
+/**
+ * { key: value } => 'keyvalue'
+ * @param {Object} parameters
+ * @return {string} concatString
+ */
+const concatObjectKeyValue = (parameters: Parameter): string => {
+  if (!parameters) return ''
+  return Object.entries(parameters)
+    .sort(([k1, v1], [k2, v2]) => (k2 > k1 ? -1 : 1))
+    .map(([k, v]) => `${k}${v}`)
+    .join('')
+}
+
+/**
+ * Calculate a signature hash
+ * @param {string} appSecret
+ * @param {string} apiPath e.g. /order/get
+ * @param {Object} params
+ * @return {string} signature hash
+ */
+export const signRequest = (appSecret: string, apiPath: string, params: Parameter): string => {
+  const hash = crypto
+    .createHmac('sha256', appSecret)
+    .update(appSecret + apiPath + concatObjectKeyValue(params) + appSecret)
+    .digest('hex')
+
+  return hash
+}
+
+/**
+ * Gather system and business parameters to compute signature
+ * @param {string} appKey
+ * @param {string} appSecret
+ * @param {string} apiPath
+ * @param {string?} accessToken
+ * @param {Parameter?} payload
+ * @return {SystemParameters}
+ */
+export function makePublicRequestParameters(
+  appKey: string,
+  appSecret: string,
+  apiPath: string,
+  accessToken: string,
+  shopId: string,
+  payload?: Parameter
+): PublicRequestParameters {
+  const ts = Math.floor(new Date(new Date().toUTCString()).getTime() / 1000).toString()
+
+  const publicRequestParams: {
+    app_key: string
+    timestamp: string
+    access_token: string
+    shop_id?: string
+  } = {
+    app_key: appKey,
+    timestamp: ts,
+    access_token: accessToken
+  }
+
+  let signatureParams: any = {
+    app_key: publicRequestParams.app_key,
+    timestamp: publicRequestParams.timestamp
+  }
+
+  if (shopId) {
+    publicRequestParams.shop_id = shopId
+
+    signatureParams.shop_id = shopId
+  }
+
+  return {
+    ...publicRequestParams,
+    sign: signRequest(appSecret, apiPath, { ...payload, ...signatureParams })
+  }
+}

package/server/controllers/tiktok/client/tiktok.ts

@@ -0,0 +1,139 @@
+import fetch from 'node-fetch'
+
+import { makePublicRequestParameters } from './signature'
+import { Parameter } from './types'
+
+const debug = require('debug')('things-factory:integration-marketplace:tiktok')
+
+export type TiktokConfig = {
+  appKey: string
+  appSecret: string
+  accessToken: string
+  channelShopId: string
+}
+
+export class Tiktok {
+  private config: TiktokConfig
+
+  constructor(config: TiktokConfig) {
+    this.config = {
+      ...config
+    }
+  }
+
+  getBaseURL() {
+    return `https://open-api.tiktokglobalshop.com`
+  }
+
+  /**
+   * @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, params: Parameter) {
+    const { appKey, appSecret, accessToken, channelShopId } = this.config
+
+    const qs = Object.entries({
+      ...params,
+      ...makePublicRequestParameters(appKey, appSecret, path, accessToken, channelShopId, params)
+    })
+      .map(([k, v]) => `${k}=${encodeURIComponent(String(v))}`)
+      .join('&')
+
+    const endpoint = `${this.getBaseURL()}${path}?${qs ? qs : ''}`
+    debug('endpoint', endpoint)
+
+    const response = await fetch(endpoint, {
+      headers: {
+        'Content-Type': 'application/json'
+      }
+    })
+
+    var result: any = {}
+    const resResult: any = await response.json()
+    result.data = resResult.data
+
+    debug('response result', result)
+
+    return result
+  }
+
+  async post(path: string, data: any = {}) {
+    const { appKey, appSecret, accessToken, channelShopId } = this.config
+
+    debug('data', data)
+
+    const jsondata = JSON.stringify(data)
+
+    const { app_key, timestamp, access_token, sign, shop_id } = makePublicRequestParameters(
+      appKey,
+      appSecret,
+      path,
+      accessToken,
+      channelShopId
+    )
+
+    const qs = Object.entries({
+      app_key,
+      timestamp,
+      access_token,
+      sign,
+      shop_id
+    })
+      .map(([k, v]) => `${k}=${encodeURIComponent(String(v))}`)
+      .join('&')
+
+    const endpoint = `${this.getBaseURL()}${path}?${qs ? '&' + qs : ''}`
+    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 { appKey, appSecret, accessToken, channelShopId } = this.config
+
+    debug('data', data)
+
+    const jsondata = JSON.stringify(data)
+
+    const { app_key, timestamp, access_token, sign } = makePublicRequestParameters(
+      appKey,
+      appSecret,
+      path,
+      accessToken,
+      channelShopId
+    )
+
+    const qs = Object.entries({
+      app_key,
+      timestamp,
+      access_token,
+      sign
+    })
+      .map(([k, v]) => `${k}=${encodeURIComponent(String(v))}`)
+      .join('&')
+
+    const endpoint = `${this.getBaseURL()}${path}?${qs ? '&' + qs : ''}`
+    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/tiktok/client/types.ts

@@ -0,0 +1,20 @@
+export type Parameter = {
+  [key: string]: any
+}
+
+/**
+ * Tiktok Open Platform Public Request Parameters
+ * @typedef PublicRequestParameters
+ * @property {string} timestamp :mandatory
+ * @property {string} app_key :mandatory
+ * @property {string} access_token :mandatory
+ * @property {string} shop_id :mandatory
+ * @property {string} sign :mandatory
+ */
+export interface PublicRequestParameters {
+  timestamp: string
+  app_key: string
+  access_token: string
+  sign: string
+  shop_id?: string
+}

package/server/controllers/tiktok/index.ts

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

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

@@ -0,0 +1,48 @@
+import { Tiktok } from './client/tiktok'
+
+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 Tiktok API call requires consumer_key, consumer_secret, access_token.
+ * consumer_key, consumer_secret, access_token are retrieved from tokencraft
+ * to avoid permission error from TikTok.
+ */
+export const action = async ({ store, method = 'get', path, request }) => {
+  const client = new Tiktok({
+    appKey: store.accessKey || '5p6q6g',
+    appSecret: store.accessSecret || 'c30cf452265ab418514bb81fa49fc333aecbf081',
+    accessToken: store.accessToken,
+    channelShopId: store.channelShopId
+  })
+
+  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/apis/get-store-products.ts

@@ -17,7 +17,6 @@ export function getStoreProducts() {
       return { payload }
     },
     async normalize(res, { store }) {
-
       const { items, totalItems: totalProducts } = res
 
       let results: any[] = []
@@ -36,13 +35,17 @@ export function getStoreProducts() {
           images: product.images.map(image => {
             return image.src
           }),
-          attributes: product.attributes.map(attribute => {
-            return {
-              native_attribute_id: attribute.id,
-              attribute_key: attribute.name,
-              values: attribute.options
-            }
-          }),
+          attributes:
+            product?.attributes?.map(attribute => {
+              return {
+                attributeId: attribute.id,
+                name: attribute.name,
+                originalValue: attribute.options,
+                native_attribute_id: attribute.id,
+                attribute_key: attribute.name,
+                values: attribute.options
+              }
+            }) || [],
           isVerified: product.purchasable,
           variations:
             productVariations.length === 0
@@ -57,13 +60,17 @@ export function getStoreProducts() {
                     primaryUnitValue: product.weight === '' ? null : parseFloat(product.weight),
                     costPrice: product.price === '' ? null : parseFloat(product.price),
                     sellPrice: product.sale_price === '' ? null : parseFloat(product.sale_price),
-                    attributes: product.attributes.map(attribute => {
-                      return {
-                        native_attribute_id: attribute.id,
-                        attribute_key: attribute.name,
-                        values: attribute.options
-                      }
-                    }),
+                    attributes:
+                      product?.attributes?.map(attribute => {
+                        return {
+                          attributeId: attribute.id,
+                          name: attribute.name,
+                          originalValue: attribute.options,
+                          native_attribute_id: attribute.id,
+                          attribute_key: attribute.name,
+                          values: attribute.options
+                        }
+                      }) || [],
                     isEnabled: product.purchasable,
                     length: product.dimensions.length * 10,
                     width: product.dimensions.width * 10,
@@ -83,13 +90,17 @@ export function getStoreProducts() {
                     primaryUnitValue: variant.weight === '' ? null : parseFloat(variant.weight),
                     costPrice: variant.price === '' ? null : parseFloat(variant.price),
                     sellPrice: variant.sale_price === '' ? null : parseFloat(variant.sale_price),
-                    attributes: variant.attributes.map(attribute => {
-                      return {
-                        native_attribute_id: attribute.id,
-                        attribute_key: attribute.name,
-                        values: [attribute.option]
-                      }
-                    }),
+                    attributes:
+                      variant?.attributes?.map(attribute => {
+                        return {
+                          attributeId: attribute.id,
+                          name: attribute.name,
+                          originalValue: attribute.options,
+                          native_attribute_id: attribute.id,
+                          attribute_key: attribute.name,
+                          values: [attribute.option]
+                        }
+                      }) || [],
                     isEnabled: variant.purchasable,
                     length: variant.dimensions.length * 10,
                     width: variant.dimensions.width * 10,