@things-factory/integration-marketplace 5.0.0-alpha.5 → 5.0.0-alpha.52

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

@@ -0,0 +1,46 @@
+/* https://bytedance.feishu.cn/docs/doccnDyz5Bbk26iOdejbBRBlLrb#ytBXoS */
+
+export function getStoreOrderPackage() {
+  return {
+    method: 'get',
+    path: '/api/fulfillment/detail',
+    denormalize(req) {
+      var { packageId } = req || {}
+
+      return { payload: { package_id: packageId } }
+    },
+    async normalize(res) {
+      const { data } = res
+
+      let result: any = {
+        packageId: data.package_id,
+        orderInfoList: data.order_info_list.map(itm => {
+          return {
+            orderId: itm.order_id,
+            skuList: itm.sku_list.map(sku => {
+              return {
+                skuId: sku.sku_id,
+                skuName: sku.sku_name,
+                skuImage: sku.sku_image,
+                quantity: sku.quantity
+              }
+            })
+          }
+        }),
+        packageStatus: data.package_status,
+        deliveryOption: data.delivery_option,
+        shippingProvider: data.shipping_provider,
+        shippingProviderId: data.shipping_provider_id,
+        trackingNumber: data.tracking_number,
+        orderListIdList: data.order_line_id_list,
+        pickUpType: data.pick_up_type,
+        pickUpStartTime: data.pick_up_start_time,
+        pickupEndTime: data.pick_up_end_time,
+        createTime: data.create_time,
+        updateTime: data.update_time
+      }
+
+      return result
+    }
+  }
+}

package/server/controllers/tiktok/apis/get-store-order-packages.ts

@@ -0,0 +1,43 @@
+/* https://bytedance.feishu.cn/wiki/wikcntMLczW460imZUfYqaa1Dng#jIY8hJ */
+
+import { StoreAPI } from '../../store-api'
+
+export function getStoreOrderPackages() {
+  return {
+    method: 'post',
+    path: '/api/fulfillment/search',
+    denormalize(req) {
+      var { pagination, fromDate, toDate, nextCursor } = req || {}
+      var { page, limit } = pagination || { page: 0, limit: 100 }
+
+      var create_time_from = Math.floor(new Date(fromDate).getTime() / 1000)
+      var create_time_to = Math.floor(new Date(toDate).getTime() / 1000)
+
+      var payload = {
+        page_size: limit,
+        cursor: nextCursor,
+        create_time_from,
+        create_time_to
+      }
+
+      return { payload }
+    },
+    async normalize(res, { store }) {
+      const { data } = res
+
+      var more: boolean = data?.more || false
+      var nextCursor: string = more ? data.next_cursor : null
+      const packageList: any[] = data?.package_list || []
+
+      let results: any[] = []
+      for (let i = 0; i < packageList.length; i++) {
+        const packageObj: any = packageList[i]
+        const packageDetail: any = await StoreAPI.getStoreOrderPackage(store, { packageId: packageObj.package_id })
+
+        results.push({ ...packageDetail })
+      }
+
+      return { results, more, nextCursor }
+    }
+  }
+}

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

@@ -0,0 +1,174 @@
+/* https://bytedance.feishu.cn/docs/doccnDyz5Bbk26iOdejbBRBlLrb#ytBXoS */
+
+import { StoreAPI } from '../../store-api'
+
+// Delivery Option: STANDARD, EXPRESS, ECONOMY, SEND_BY_SELLER
+
+const documentStatuses = [112, 121, 122, 130]
+
+export function getStoreOrder() {
+  return {
+    method: 'post',
+    path: '/api/orders/detail/query',
+    denormalize(req) {
+      var { orderId } = req || {}
+
+      let orderIds = Array.isArray(orderId) ? orderId : [orderId]
+
+      return { payload: { order_id_list: orderIds } }
+    },
+    async normalize(res, { store }) {
+      const { data } = res
+      const orderList = data.order_list
+      let results: any[] = []
+
+      for (let i = 0; i < orderList.length; i++) {
+        const order: any = orderList[i]
+        const {
+          order_id: name,
+          order_id: orderNo,
+          payment_method: paymentMethod,
+          payment_info: paymentInfo,
+          order_status: status,
+          ext_status: extStatus,
+          create_time,
+          update_time,
+          rts_sla,
+          recipient_address: recipientAddress,
+          item_list: itemList,
+          order_line_list: orderLineList,
+          package_list: packageList,
+          delivery_option: deliveryOption
+        } = order
+
+        let orderStatus: string = `ttk_${status}`
+        switch (extStatus) {
+          case 201:
+          case 203:
+            orderStatus = `ttk_${extStatus}`
+            break
+          default:
+            orderStatus = `ttk_${status}`
+        }
+
+        var orderUpdatedAt = new Date(update_time * 1000)
+        var orderCreatedAt = new Date(Number(create_time))
+        var slaExpiresAt = Boolean(rts_sla) ? new Date(rts_sla * 1000) : null
+        let docRefNo = orderNo
+        let isSOF: boolean = false
+        if (deliveryOption == 'SEND_BY_SELLER') isSOF = true
+
+        let orderItems = itemList.map(item => {
+          var { sku_id, quantity: qty, sku_original_price, sku_sale_price } = item
+          var matchedOrderLine = orderLineList.find(ol => ol.sku_id == sku_id)
+          var name = matchedOrderLine.order_line_id
+
+          return {
+            name,
+            variationId: sku_id,
+            qty,
+            paidPrice: sku_sale_price,
+            orderNo,
+            docRefNo,
+            total: sku_sale_price,
+            totalTax: 0,
+            subtotal: sku_original_price,
+            subtotalTax: 0,
+            slaExpiresAt
+          }
+        })
+
+        const { full_address, phone, zipcode, city, region: country, name: firstName } = recipientAddress
+
+        let billing = {
+          address_1: full_address,
+          address_2: null,
+          address_3: null,
+          address_4: null,
+          address_5: null,
+          phone,
+          phone_2: null,
+          postcode: zipcode,
+          city,
+          country,
+          first_name: firstName,
+          last_name: null
+        }
+
+        let shipping = {
+          address_1: full_address,
+          address_2: null,
+          address_3: null,
+          address_4: null,
+          address_5: null,
+          phone,
+          phone_2: null,
+          postcode: zipcode,
+          city,
+          country,
+          first_name: firstName,
+          last_name: null
+        }
+
+        let orderShipping = {
+          address1: shipping.address_1,
+          address2: null,
+          address3: null,
+          address4: null,
+          address5: null,
+          phone1: shipping.phone,
+          phone2: null,
+          postCode: shipping.postcode,
+          city: shipping.city,
+          country: shipping.country,
+          collectionCurrency: paymentInfo.currency,
+          attentionTo: shipping.first_name
+        }
+
+        let result: any = {
+          name,
+          orderNo,
+          status: orderStatus,
+          orderCreatedAt,
+          orderUpdatedAt,
+          totalAmount: paymentInfo.total_amount,
+          itemCount: itemList.length,
+          orderItems,
+          orderShipping,
+          billing,
+          shipping,
+          firstName,
+          lastName: null,
+          isSOF
+        }
+
+        let orderPackage: any = {}
+        if (packageList && packageList[0]?.package_id) {
+          let orderPackageDetail: any = await StoreAPI.getStoreOrderPackage(store, {
+            packageId: packageList[0].package_id
+          })
+
+          orderPackage = {
+            ...orderPackageDetail,
+            orderId: name
+          }
+
+          if (documentStatuses.indexOf(status) >= 0) {
+            let orderDocument: any = await StoreAPI.getStoreOrderDocument(store, {
+              packageId: packageList[0].package_id,
+              documentType: 1
+            })
+
+            orderPackage.orderDocument = orderDocument || []
+          }
+
+          result.orderPackage = orderPackage
+        }
+
+        results.push(result)
+      }
+
+      return results
+    }
+  }
+}

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

@@ -0,0 +1,55 @@
+/* https://bytedance.feishu.cn/wiki/wikcntMLczW460imZUfYqaa1Dng#jIY8hJ */
+
+import { StoreAPI } from '../../store-api'
+
+export function getStoreOrders() {
+  return {
+    method: 'post',
+    path: '/api/orders/search',
+    denormalize(req) {
+      var { pagination, fromCreatedDate, toCreatedDate, fromUpdatedDate, toUpdatedDate, nextCursor } = req || {}
+      var { page, limit } = pagination || { page: 0, limit: 100 }
+
+      let payload: any = { page_size: limit }
+
+      if (fromCreatedDate && toCreatedDate) {
+        const create_time_from = Math.floor(new Date(fromCreatedDate).getTime() / 1000)
+        const create_time_to = Math.floor(new Date(toCreatedDate).getTime() / 1000)
+
+        payload.create_time_from = create_time_from
+        payload.create_time_to = create_time_to
+      }
+
+      if (fromUpdatedDate && toUpdatedDate) {
+        const update_time_from = Math.floor(new Date(fromUpdatedDate).getTime() / 1000)
+        const update_time_to = Math.floor(new Date(toUpdatedDate).getTime() / 1000)
+
+        payload.update_time_from = update_time_from
+        payload.update_time_to = update_time_to
+      }
+
+      if (nextCursor) payload.cursor = nextCursor
+
+      return { payload }
+    },
+    async normalize(res, { store }) {
+      const { data } = res
+
+      var more: boolean = data?.more || false
+      var nextCursor: string = more ? data.next_cursor : null
+      let orderList: any[] = data?.order_list || []
+
+      let results: any[] = []
+      while (orderList.length > 0) {
+        let orderIds = orderList.splice(0, orderList.length >= 20 ? 20 : orderList.length)
+        const orderIdList: any = orderIds.map(orderId => orderId.order_id)
+        const orderDetails: any[] = await StoreAPI.getStoreOrder(store, { orderId: orderIdList })
+        orderDetails.map(orderDetail => {
+          results.push({ ...orderDetail })
+        })
+      }
+
+      return { results, more, nextCursor }
+    }
+  }
+}

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

@@ -0,0 +1,29 @@
+/* https://bytedance.feishu.cn/docs/doccnDyz5Bbk26iOdejbBRBlLrb#WBz4V0 */
+
+export function getStoreProductAttributes() {
+  return {
+    method: 'get',
+    path: '/api/products/attributes',
+    denormalize(req) {
+      const { categoryId } = req
+      return { payload: { category_id: categoryId } }
+    },
+    normalize(res) {
+      const { data } = res
+
+      let results: any = []
+      data.attributes.map(item => {
+        let result: any = {
+          id: item.id,
+          name: item.local_display_name,
+          attributeType: item.attribute_type,
+          parent: !item.is_leaf ? 0 : item.parent_id
+        }
+
+        results.push(result)
+      })
+
+      return results
+    }
+  }
+}

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

@@ -0,0 +1,27 @@
+/* https://bytedance.feishu.cn/docs/doccnDyz5Bbk26iOdejbBRBlLrb#jIY8hJ */
+
+export function getStoreProductCategories() {
+  return {
+    method: 'get',
+    path: '/api/products/categories',
+    denormalize(req) {
+      return { payload: {} }
+    },
+    normalize(res) {
+      const { data } = res
+
+      let results: any = []
+      data.category_list.map(item => {
+        let result: any = {
+          id: item.id,
+          name: item.local_display_name,
+          parent: item.is_leaf ? item.parent_id : 0
+        }
+
+        results.push(result)
+      })
+
+      return { results, total: 1 }
+    }
+  }
+}

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,45 @@
+/* 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, fromUpdatedDate, toUpdatedDate } = req || {}
+      var { page, limit } = pagination || { page: 0, limit: 100 }
+
+      var payload: any = { page_size: limit, page_number: page + 1, search_status: 0 }
+
+      if (fromUpdatedDate && toUpdatedDate) {
+        payload.update_time_from = Math.floor(new Date(fromUpdatedDate).getTime() / 1000)
+        payload.update_time_to = Math.floor(new Date(toUpdatedDate).getTime() / 1000)
+      }
+
+      return {
+        payload,
+        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,24 @@
+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 { payload: {}, requiredAPICall: false }
+      }
+    },
+    normalize(res) {
+      let result = { ...res, requiredDocument: true }
+
+      return result
+    }
+  }
+}

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 })
+  }
+}