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

package/server/controllers/shopee/shopee.ts

@@ -0,0 +1,191 @@
+import crypto from 'crypto'
+import fetch from 'node-fetch'
+import { createPayloadLog } from '@things-factory/integration-base'
+
+const debug = require('debug')('things-factory:integration-marketplace:shopee')
+
+export type ShopeeConfig = {
+  partner_id: number
+  partner_key: string
+  shopid?: number
+  code?: string
+  redirect_uri?: string
+  webhook_url?: string
+  isUAT?: boolean
+  access_token?: string
+}
+
+export class Shopee {
+  private config: ShopeeConfig
+
+  constructor(config: ShopeeConfig) {
+    this.config = {
+      ...config
+    }
+
+    this.config.partner_id = Number(this.config.partner_id)
+  }
+
+  getBaseUrl() {
+    return `https://partner${this.config.isUAT ? '.test-stable' : ''}.shopeemobile.com`
+  }
+
+  buildAuthURL(isCancel = false) {
+    const { partner_key, partner_id, redirect_uri } = this.config
+
+    const timestamp = Math.round(new Date().getTime() / 1000)
+
+    const authPath = `/api/v2/shop/${isCancel ? 'cancel_auth_partner' : 'auth_partner'}`
+    const sign = crypto
+      .createHmac('sha256', partner_key)
+      .update(partner_id + authPath + timestamp)
+      .digest('hex')
+
+    let authUrl = `${this.getBaseUrl()}${authPath}`
+    authUrl += `?partner_id=${partner_id}`
+    authUrl += `&redirect=${redirect_uri}`
+    authUrl += `&timestamp=${timestamp}`
+    authUrl += `&sign=${sign}`
+
+    debug('auth-url', authUrl)
+    return authUrl
+  }
+
+  buildCancelAuthUrl() {
+    return this.buildAuthURL(true)
+  }
+
+  generateAuthorization(path, data) {
+    const message = `${this.getBaseUrl() + path}|${data}`
+    return crypto.createHmac('sha256', this.config.partner_key).update(message).digest('hex')
+  }
+
+  isValidSignature(params, signature) {
+    const message = `${this.config.webhook_url}|${params}`
+    const digest = crypto.createHmac('sha256', this.config.partner_key).update(message).digest('hex')
+
+    return digest === signature
+  }
+
+  async post(endpoint, data: any = {}) {
+    const { partner_id, shopid } = this.config
+
+    data.partner_id = partner_id
+    data.timestamp = Math.floor(Date.now() / 1000)
+    if (shopid) {
+      data.shopid = shopid
+    }
+
+    debug('data', data)
+
+    const jsondata = JSON.stringify(data)
+
+    const response = await fetch(`${this.getBaseUrl()}/api/v1/${endpoint}`, {
+      method: 'post',
+      headers: {
+        'Content-Type': 'application/json',
+        Authorization: this.generateAuthorization(`/api/v1${endpoint}`, jsondata)
+      },
+      body: jsondata
+    })
+
+    const result = await response.json()
+    debug('response result', result)
+
+    return result
+  }
+
+  async getV2(endpoint, data: any = {}) {
+    const { partner_id, shopid, access_token, partner_key } = this.config
+
+    const timestamp = Math.floor(Date.now() / 1000)
+    const sign = crypto
+      .createHmac('sha256', partner_key)
+      .update(partner_id + '/api/v2' + endpoint + timestamp + access_token + shopid)
+      .digest('hex')
+
+    data.partner_id = partner_id
+    data.timestamp = timestamp
+    data.access_token = access_token
+    data.shop_id = shopid
+    data.sign = sign
+
+    debug('data', data)
+
+    const qs = Object.entries(data)
+      .map(([k, v]) => `${k}=${encodeURIComponent(String(v))}`)
+      .join('&')
+
+    const response = await fetch(`${this.getBaseUrl()}/api/v2/${endpoint}${qs ? '?' + qs : ''}`, {
+      method: 'get'
+    })
+
+    const result = await response.json()
+    try {
+      createPayloadLog(shopid as any, endpoint, qs, result, {
+        state: { domain: null }
+      })
+    } catch (e) {}
+    debug('response result', result)
+
+    return result
+  }
+
+  async postV2(endpoint, data: any = {}) {
+    const { partner_id, shopid, access_token, partner_key } = this.config
+
+    const timestamp = Math.floor(Date.now() / 1000)
+    const sign = crypto
+      .createHmac('sha256', partner_key)
+      .update(partner_id + '/api/v2' + endpoint + timestamp + access_token + shopid)
+      .digest('hex')
+
+    let auth = {
+      partner_id: partner_id,
+      access_token: access_token,
+      shop_id: shopid,
+      sign: sign,
+      timestamp: timestamp
+    }
+
+    const qs = Object.entries(auth)
+      .map(([k, v]) => `${k}=${encodeURIComponent(String(v))}`)
+      .join('&')
+
+    const jsondata = JSON.stringify(data)
+
+    debug('data', data)
+
+    const response = await fetch(`${this.getBaseUrl()}/api/v2/${endpoint}${qs ? '?' + qs : ''}`, {
+      method: 'post',
+      body: jsondata,
+      headers: {
+        'Content-Type': 'application/json'
+      }
+    })
+
+    let result
+    if (endpoint == '/logistics/download_shipping_document') {
+      try {
+        let awb = await response.buffer()
+        result = {
+          awb,
+          data
+        }
+      } catch {
+        result = await response.json()
+      }
+    } else {
+      result = await response.json()
+      try {
+        createPayloadLog(shopid as any, endpoint, jsondata, result, {
+          state: { domain: null }
+        })
+      } catch (e) {}
+    }
+
+    debug('response result', result)
+
+    return result
+  }
+}

package/server/controllers/shopify/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/shopify/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/shopify/apis/get-inventory-level.ts

@@ -0,0 +1,17 @@
+/* https://shopify.dev/docs/admin-api/rest/reference/inventory/inventorylevel?api[version]=2020-01#index-2020-01 */
+
+export function getInventoryLevel() {
+  return {
+    method: 'get',
+    path: '/inventory_levels.json',
+    denormalize(req) {
+      const { inventoryItemIds: inventory_item_ids } = req
+      return {
+        payload: { inventory_item_ids }
+      }
+    },
+    normalize(res) {
+      return res
+    }
+  }
+}

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

@@ -0,0 +1,172 @@
+/* https://shopify.dev/api/admin-rest/2022-01/resources/order#[get]/admin/api/2022-01/orders/{order_id}.json */
+
+export function getStoreOrder() {
+  return {
+    method: 'get',
+    path: '/orders/{orderId}.json',
+    denormalize(req) {
+      const { orderId } = req
+
+      return {
+        resource: {
+          orderId
+        }
+      }
+    },
+    normalize(res) {
+      var { order } = res
+      const orderId = order.id
+      const fulfillmentStatus = order.fulfillment_status
+      let orderStatus = order?.cancelled_at ? 'cancelled' : fulfillmentStatus ? fulfillmentStatus : 'unfulfilled'
+
+      let itemCount: Number = 0
+      let result: any
+
+      if (fulfillmentStatus != null) {
+        const fulfillment = order.fulfillments[0]
+
+        result = {
+          name: fulfillment.order_id,
+          orderNo: order.name,
+          currency: order.currency,
+          totalAmount: order.current_total_price,
+          remark: order.note,
+          orderCreatedAt: new Date(order.created_at).toUTCString(),
+          orderUpdatedAt: new Date(order.updated_at).toUTCString(),
+          discountValue: order.total_discounts,
+          status: orderStatus,
+          trackingNo: fulfillment.tracking_number,
+          shippingProvider: fulfillment.tracking_company,
+          recipientAddress:
+            fulfillment.billing_address == null ? fulfillment.shipping_address : fulfillment.billing_address,
+          reason: order.cancel_reason,
+          orderItems: fulfillment.line_items.map(lineItem => {
+            return {
+              name: lineItem.id.toString(),
+              qty: lineItem.quantity,
+              status: lineItem.status || lineItem.fulfillment_status,
+              paidPrice: lineItem.price,
+              docRefNo: lineItem.id,
+              variationId: lineItem.product_exists === true ? lineItem.variant_id : lineItem.id.toString(),
+              variationSku: lineItem.sku,
+              channelSku: lineItem.sku,
+              variationName: lineItem.name
+            }
+          })
+        }
+      } else {
+        let lineItems = []
+
+        const refundItems = order.refunds
+          .reduce((acc, curr) => {
+            const refundLineItems = curr.refund_line_items
+            acc.push(...refundLineItems)
+
+            return acc
+          }, [])
+          .reduce((acc, curr) => {
+            let sum = acc.findIndex(x => x.line_item_id === curr.line_item_id)
+            if (sum >= 0) {
+              acc[sum].quantity += curr.quantity
+            } else {
+              acc.push(curr)
+            }
+
+            return acc
+          }, [])
+
+        let filteredLineItems = []
+        if (orderStatus == 'cancelled') {
+          filteredLineItems = order.line_items
+        } else {
+          filteredLineItems = order.line_items.filter(item => item.fulfillable_quantity > 0)
+        }
+
+        filteredLineItems.map(lineItem => {
+          const matchedLineItem = refundItems.find(item => item.line_item_id == lineItem.id)
+
+          if (!matchedLineItem) {
+            lineItem = {
+              name: lineItem.id.toString(),
+              qty: lineItem.quantity,
+              paidPrice: lineItem.price,
+              docRefNo: lineItem.id,
+              variationId: lineItem.product_exists === true ? lineItem.variant_id : lineItem.id.toString(),
+              variationSku: lineItem.sku,
+              channelSku: lineItem.sku,
+              variationName: lineItem.name,
+              status: lineItem.status || lineItem.fulfillment_status
+            }
+
+            lineItems.push(lineItem)
+          } else {
+            lineItem = {
+              name: lineItem.id.toString(),
+              qty: orderStatus == 'cancelled' ? lineItem.quantity : lineItem.quantity - matchedLineItem.quantity,
+              paidPrice: lineItem.price,
+              docRefNo: lineItem.id,
+              variationId: lineItem.product_exists === true ? lineItem.variant_id : lineItem.id.toString(),
+              variationSku: lineItem.sku,
+              channelSku: lineItem.sku,
+              variationName: lineItem.name,
+              status: lineItem.status || lineItem.fulfillment_status
+            }
+
+            if (lineItem.qty >= 0) lineItems.push(lineItem)
+          }
+        })
+
+        result = {
+          name: orderId,
+          orderNo: order.name,
+          currency: order.currency,
+          totalAmount: orderStatus == 'cancelled' ? order.total_price : order.current_total_price,
+          remark: order.note,
+          orderCreatedAt: new Date(order.created_at).toUTCString(),
+          orderUpdatedAt: new Date(order.updated_at).toUTCString(),
+          discountValue: order.total_discounts,
+          recipientAddress: order.billing_address,
+          status: orderStatus,
+          reason: order.cancel_reason,
+          orderItems: lineItems
+        }
+      }
+
+      if (order?.shipping_address || order?.billing_address) {
+        const {
+          address1,
+          address2,
+          phone,
+          zip: postCode,
+          city,
+          country,
+          first_name,
+          last_name,
+          province: state
+        } = order?.shipping_address ? order.shipping_address : order.billing_address
+
+        var orderShipping = {
+          address1,
+          address2,
+          address3: null,
+          address4: null,
+          address5: null,
+          phone1: phone,
+          phone2: null,
+          postCode,
+          city,
+          state,
+          country: country === 'MY' ? 'Malaysia' : country,
+          collectionCurrency: null,
+          attentionTo: `${first_name} ${last_name}`
+        }
+
+        result.orderShipping = orderShipping
+      }
+
+      itemCount = result.orderItems.length
+      result.itemCount = itemCount
+      return result
+    }
+  }
+}

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

@@ -0,0 +1,290 @@
+/* https://open.shopee.com/documents?module=4&type=1&id=399 */
+
+export function getStoreOrders() {
+  return {
+    method: 'get',
+    path: '/orders.json',
+    denormalize(req) {
+      var { pagination, fromCreatedDate, toCreatedDate, fromUpdatedDate, toUpdatedDate, lastOrderId, nextCursor } = req || {}
+      var { page = 0, limit = 100 } = pagination || {}
+
+      var payload: any = {
+        limit
+      }
+
+      if (nextCursor) {
+        payload.page_info = nextCursor
+      }
+
+      if (fromCreatedDate && toCreatedDate && !nextCursor) {
+        var created_at_min = new Date(fromCreatedDate).toISOString()
+        var created_at_max = new Date(toCreatedDate).toISOString()
+        payload.created_at_min = created_at_min
+        payload.created_at_max = created_at_max
+        payload.status = 'any'
+      }
+
+      if (fromUpdatedDate && toUpdatedDate && !nextCursor) {
+        var updated_at_min = new Date(fromUpdatedDate).toISOString()
+        var updated_at_max = new Date(toUpdatedDate).toISOString()
+        payload.updated_at_min = updated_at_min
+        payload.updated_at_max = updated_at_max
+        payload.status = 'any'
+      }
+
+      if (lastOrderId) payload.since_id = Number(lastOrderId)
+
+      return { payload }
+    },
+    async normalize(res, { store }) {
+      // return res.orders
+
+      // removed item -> fulfillable_quantity = 0
+
+      const linkParams = res.link
+      var more: boolean = false
+      let nextCursor: any = null
+
+      if (linkParams) {
+        more = checkNextPage(linkParams).nextPage
+        nextCursor = checkNextPage(linkParams).nextCursor
+      }
+
+      const orderSourceNames: any = ['pos']
+      var { orders } = res
+
+      const results: any[] = orders
+        .filter(item => !orderSourceNames.includes(item.source_name))
+        .map(order => {
+          const orderId = order.id
+          const fulfillmentStatus = order.fulfillment_status
+          const paymentStatus = order?.financial_status || ''
+          let orderStatus = order?.cancelled_at ? 'cancelled' : fulfillmentStatus ? fulfillmentStatus : 'unfulfilled'
+          let sellercraftStatus = getSellercraftStatus(fulfillmentStatus, paymentStatus)
+
+          let itemCount: Number = 0
+          let result: any
+
+          if (fulfillmentStatus != null) {
+            const fulfillment = order.fulfillments[0]
+
+            result = {
+              name: fulfillment.order_id,
+              orderNo: order.name,
+              currency: order.currency,
+              totalAmount: order.current_total_price,
+              remark: order.note,
+              orderCreatedAt: new Date(order.created_at).toUTCString(),
+              orderUpdatedAt: new Date(order.updated_at).toUTCString(),
+              discountValue: order.total_discounts,
+              status: order.financial_status == 'pending' ? 'unpaid' : orderStatus,
+              sellercraftStatus,
+              trackingNo: fulfillment.tracking_number,
+              shippingProvider: fulfillment.tracking_company,
+              recipientAddress:
+                fulfillment.billing_address == null ? fulfillment.shipping_address : fulfillment.billing_address,
+              reason: order.cancel_reason,
+              orderItems: fulfillment.line_items.map(lineItem => {
+                return {
+                  name: lineItem.id.toString(),
+                  qty: lineItem.quantity,
+                  status: lineItem.status,
+                  paidPrice: lineItem.price,
+                  docRefNo: lineItem.id,
+                  variationId: lineItem.product_exists === true ? lineItem.variant_id : lineItem.id.toString(),
+                  variationSku: lineItem.sku,
+                  channelSku: lineItem.sku,
+                  variationName: lineItem.name,
+                  originalPrice: lineItem.price,
+                  total: lineItem.price,
+                  subtotal: lineItem.price
+                }
+              })
+            }
+          } else {
+            let lineItems = []
+
+            const refundItems = order.refunds
+              .reduce((acc, curr) => {
+                const refundLineItems = curr.refund_line_items
+                acc.push(...refundLineItems)
+
+                return acc
+              }, [])
+              .reduce((acc, curr) => {
+                let sum = acc.findIndex(x => x.line_item_id === curr.line_item_id)
+                if (sum >= 0) {
+                  acc[sum].quantity += curr.quantity
+                } else {
+                  acc.push(curr)
+                }
+
+                return acc
+              }, [])
+
+            let filteredLineItems = []
+            if (orderStatus == 'cancelled') {
+              filteredLineItems = order.line_items
+            } else {
+              filteredLineItems = order.line_items.filter(item => item.fulfillable_quantity > 0)
+            }
+
+            filteredLineItems.map(lineItem => {
+              const matchedLineItem = refundItems.find(item => item.line_item_id == lineItem.id)
+
+              if (!matchedLineItem) {
+                lineItem = {
+                  name: lineItem.id.toString(),
+                  qty: lineItem.quantity,
+                  paidPrice: lineItem.price,
+                  docRefNo: lineItem.id,
+                  variationId: lineItem.product_exists === true ? lineItem.variant_id : lineItem.id.toString(),
+                  variationSku: lineItem.sku,
+                  channelSku: lineItem.sku,
+                  variationName: lineItem.name,
+                  originalPrice: lineItem.price,
+                  total: lineItem.price,
+                  subtotal: lineItem.price
+                }
+
+                lineItems.push(lineItem)
+              } else {
+                lineItem = {
+                  name: lineItem.id.toString(),
+                  qty: orderStatus == 'cancelled' ? lineItem.quantity : lineItem.quantity - matchedLineItem.quantity,
+                  paidPrice: lineItem.price,
+                  docRefNo: lineItem.id,
+                  variationId: lineItem.product_exists === true ? lineItem.variant_id : lineItem.id.toString(),
+                  variationSku: lineItem.sku,
+                  channelSku: lineItem.sku,
+                  variationName: lineItem.name,
+                  originalPrice: lineItem.price,
+                  total: lineItem.price,
+                  subtotal: lineItem.price
+                }
+
+                if (lineItem.qty >= 0) lineItems.push(lineItem)
+              }
+            })
+
+            result = {
+              name: orderId,
+              orderNo: order.name,
+              currency: order.currency,
+              totalAmount: orderStatus == 'cancelled' ? order.total_price : order.current_total_price,
+              remark: order.note,
+              orderCreatedAt: new Date(order.created_at).toUTCString(),
+              orderUpdatedAt: new Date(order.updated_at).toUTCString(),
+              discountValue: order.total_discounts,
+              recipientAddress: order.billing_address,
+              status: order.financial_status == 'pending' ? 'unpaid' : orderStatus,
+              sellercraftStatus,
+              reason: order.cancel_reason,
+              orderItems: lineItems
+            }
+          }
+
+          if (order?.shipping_address || order?.billing_address) {
+            const {
+              address1,
+              address2,
+              phone,
+              zip: postCode,
+              city,
+              country,
+              first_name,
+              last_name,
+              province: state
+            } = order?.shipping_address ? order.shipping_address : order.billing_address
+
+            var orderShipping = {
+              address1,
+              address2,
+              address3: null,
+              address4: null,
+              address5: null,
+              phone1: phone,
+              phone2: null,
+              postCode,
+              city,
+              state,
+              country: country === 'MY' ? 'Malaysia' : country,
+              collectionCurrency: order.currency,
+              attentionTo: `${first_name} ${last_name}`
+            }
+
+            result.orderShipping = orderShipping
+
+            // For SC mapping
+
+            let shippingAddress = order?.shipping_address
+            let billingAddress = order?.billing_address || shippingAddress
+
+            result.shipping = {
+              address_1: shippingAddress?.address1,
+              address_2: shippingAddress?.address2,
+              address_3: shippingAddress?.province,
+              postcode: shippingAddress?.zip,
+              country: shippingAddress?.country_code,
+              city: shippingAddress?.city,
+              first_name: shippingAddress?.first_name,
+              last_name: shippingAddress?.last_name,
+              phone: shippingAddress?.phone,
+              email: order?.email
+            }
+            result.billing = {
+              address_1: billingAddress?.address1,
+              address_2: billingAddress?.address2,
+              address_3: billingAddress?.province,
+              postcode: billingAddress?.zip,
+              country: billingAddress?.country_code,
+              city: billingAddress?.city,
+              first_name: billingAddress?.first_name,
+              last_name: billingAddress?.last_name,
+              phone: billingAddress?.phone,
+              email: order?.email
+            }
+            result.isSOF = true
+            result.firstName = order?.customer?.first_name || ''
+            result.lastName = order?.customer?.last_name || ''
+            result.sellercraftDisplayOrderNo = order.name
+          }
+
+          itemCount = result.orderItems.length
+          result.itemCount = itemCount
+
+          return result
+        })
+
+      return { results, more, nextCursor }
+    }
+  }
+}
+
+function checkNextPage(link) {
+  let nextPage: boolean = false
+  let nextCursor = null
+
+  // If there's a previous link, remove the first part of the string entirely
+  if (link.indexOf(`rel="next"`) > -1) {
+    let nextLink = link.split(' ')
+    nextLink = nextLink[nextLink.indexOf(`rel="next"`)-1]
+    nextCursor = new URLSearchParams(nextLink.substring(nextLink.indexOf('<') + 1, nextLink.lastIndexOf('>'))).get('page_info')
+    nextPage = true
+  }
+
+  return { nextPage, nextCursor }
+}
+
+function getSellercraftStatus(fulfillmentStatus, paymentStatus) {
+  if (
+    (fulfillmentStatus == 'unfulfilled' || !fulfillmentStatus) &&
+    (paymentStatus == 'pending' || paymentStatus == 'unpaid')
+  )
+    return 'payment_pending'
+  if ((fulfillmentStatus == 'unfulfilled' || !fulfillmentStatus) && paymentStatus == 'paid') return 'processing'
+  if (fulfillmentStatus == 'fulfilled' && paymentStatus == 'paid') return 'shipped'
+  if (paymentStatus == 'refunded') return 'refunded'
+  if (paymentStatus == 'voided') return 'cancelled'
+  if (paymentStatus == 'overdue') return 'cancelled'
+}