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

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

@@ -0,0 +1,67 @@
+import crypto from 'crypto'
+import { Parameter, SystemParameters } from './types'
+
+/**
+ * { key: value } => 'keyvalue'
+ * @param {Object} parameters
+ * @return {string} concatString
+ */
+const concatObjectKeyValue = (parameters: Parameter): string => {
+  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(apiPath + concatObjectKeyValue(params))
+    .digest('hex')
+
+  return hash.toUpperCase() // must use upper case
+}
+
+/**
+ * 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 makeSystemParameters(
+  appKey: string,
+  appSecret: string,
+  apiPath: string,
+  accessToken: string | undefined,
+  payload?: Parameter
+): SystemParameters {
+  const systemParams: {
+    app_key: string
+    sign_method: string
+    timestamp: string
+    access_token?: string
+  } = {
+    app_key: appKey,
+    sign_method: 'sha256',
+    timestamp: Date.now().toString()
+  }
+
+  if (accessToken) {
+    systemParams.access_token = accessToken
+  }
+
+  return {
+    ...systemParams,
+    sign: signRequest(appSecret, apiPath, { ...payload, ...systemParams })
+  }
+}

package/server/controllers/lazada/client/types.ts

@@ -0,0 +1,30 @@
+export const Endpoint = {
+  sg: 'https://api.lazada.sg/rest',
+  th: 'https://api.lazada.co.th/rest',
+  my: 'https://api.lazada.com.my/rest',
+  vn: 'https://api.lazada.vn/rest',
+  ph: 'https://api.lazada.com.ph/rest',
+  id: 'https://api.lazada.co.id/rest',
+  auth: 'https://auth.lazada.com/rest'
+}
+
+export type Parameter = {
+  [key: string]: any
+}
+
+/**
+ * Lazada Open Platform System Parameters
+ * @typedef SystemParameters
+ * @property {string} app_key :mandatory
+ * @property {string} access_token :conditional
+ * @property {string} timestamp :mandatory
+ * @property {string} sign_method :mandatory 'sha256'
+ * @property {string} sign :mandatory
+ */
+export interface SystemParameters {
+  app_key: string
+  timestamp: string
+  access_token?: string
+  sign_method: string
+  sign: string
+}

package/server/controllers/lazada/client/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/controllers/lazada/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('lazada', action, APIS)

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

@@ -0,0 +1,35 @@
+import { config } from '@things-factory/env'
+
+import { Lazada } from './client'
+
+const lazadaConfig = config.get('marketplaceIntegrationLazada', {})
+const { appKey, appSecret } = lazadaConfig
+
+export const action = async ({ store, method = 'get', path, request }) => {
+  try {
+    return await _action({ store, method, path, request })
+  } catch (ex) {
+    if (ex.code === 'IllegalAccessToken') {
+      var refreshStore = await Lazada.refreshAccessToken(
+        { refresh_token: store.refreshToken },
+        appKey,
+        appSecret,
+        store.id
+      )
+      return await _action({ store: refreshStore, method, path, request })
+    } else {
+      throw ex
+    }
+  }
+}
+
+export const _action = async ({ store, method = 'get', path, request }) => {
+  const client = new Lazada(store.countryCode, appKey, appSecret)
+
+  var response = await client[method == 'post' ? 'post' : 'get'](path, request, store.accessToken)
+  if (!response.data && !(response.code && response.code == '0')) {
+    throw response
+  }
+
+  return response?.data ? response.data : response.result
+}

package/server/controllers/magento/apis/create-order-comment.ts

@@ -0,0 +1,32 @@
+/* https://magento.redoc.ly/2.4.2-admin/tag/ordersidcomments#operation/salesOrderManagementV1AddCommentPost */
+/* /orders/{id}/comments */
+
+export function createOrderComment() {
+  return {
+    method: 'post',
+    path: '/orders/{id}/comments',
+    denormalize(req) {
+      var { orderId, remark: comment, status } = req || {}
+
+      // statusHistory: {
+      //   comment: string,
+      //   created_at: string,
+      //   entity_id: 0,
+      //   entity_name: string,
+      //   is_customer_notified: 0,
+      //   is_visible_on_front: 0,
+      //   parent_id: 0,
+      //   status: string,
+      //   extension_attributes: { }
+      // }
+
+      return {
+        resource: { id: orderId },
+        payload: { statusHistory: { comment, status, is_customer_notified: 0, is_visible_on_front: 0 } }
+      }
+    },
+    normalize(res) {
+      return res
+    }
+  }
+}

package/server/controllers/magento/apis/create-order-refund.ts

@@ -0,0 +1,20 @@
+/* https://magento.redoc.ly/2.4.2-admin/tag/orderorderIdrefund#operation/salesRefundOrderV1ExecutePost */
+/* /orders/{orderId}/comments */
+
+export function createOrderRefund() {
+  return {
+    method: 'post',
+    path: '/orders/{orderId}/refund',
+    denormalize(req) {
+      var { orderItemId, qty } = req || {}
+
+      return {
+        resource: { orderId: req.orderId },
+        payload: { items: { order_item_id: orderItemId, qty } }
+      }
+    },
+    normalize(res) {
+      return res
+    }
+  }
+}

package/server/controllers/magento/apis/create-order-ship.ts

@@ -0,0 +1,43 @@
+/* https://magento.redoc.ly/2.4.2-admin/tag/orderorderIdship#operation/salesShipOrderV1ExecutePost */
+/* /orders/{orderId}/ship */
+
+export function createOrderShip() {
+  return {
+    method: 'post',
+    path: '/order/{orderId}/ship',
+    denormalize(req) {
+      var { orderId, orderItems, shippings, sourceCodes } = req || {}
+
+      const items: any[] = orderItems.map(orderItem => {
+        return {
+          order_item_id: parseInt(orderItem.name.replaceAll('"', '')),
+          qty: orderItem.qty
+        }
+      })
+
+      const tracks: any[] = shippings.map(shipping => {
+        return {
+          carrier_code: shipping.carrierCode,
+          track_number: shipping.trackingNo,
+          title: shipping.carrierCode
+        }
+      })
+
+      const shipmentArguments: any[] = sourceCodes.map(sourceCode => {
+        return {
+          extension_attributes: {
+            source_code: sourceCode
+          }
+        }
+      })
+
+      return {
+        resource: { orderId },
+        payload: { items, tracks, arguments: shipmentArguments[0] }
+      }
+    },
+    normalize(res) {
+      return res
+    }
+  }
+}

package/server/controllers/magento/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/magento/apis/get-store-order.ts

@@ -0,0 +1,15 @@
+export function getStoreOrder() {
+  return {
+    path: '/orders/{id}',
+    method: 'get',
+    denormalize(req) {
+      let { id } = req
+      return {
+        resource: { id }
+      }
+    },
+    normalize(res) {
+      return res
+    }
+  }
+}

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

@@ -0,0 +1,159 @@
+/* https://magento.redoc.ly/2.4.2-admin/tag/orders#operation/salesOrderRepositoryV1GetListGet */
+
+export function getStoreOrders() {
+  return {
+    method: 'get',
+    path: '/orders',
+    denormalize(req) {
+      var { pagination, fromCreatedDate, toCreatedDate } = req || {}
+      var { page = 0, limit = 100 } = pagination || {}
+
+      var created_at_min = new Date(fromCreatedDate).toISOString()
+      var created_at_max = new Date(toCreatedDate).toISOString()
+      /* Must include only create_time or update_time in the request. */
+      // var update_time_from = lastOneDay
+      // var update_time_to = now
+
+      var payload: any = {
+        currentPage: page,
+        pageSize: limit,
+        filter_groups: [
+          {
+            filters: [
+              {
+                field: 'created_at',
+                value: created_at_min,
+                condition_type: 'from'
+              }
+            ]
+          },
+          {
+            filters: [
+              {
+                field: 'created_at',
+                value: created_at_max,
+                condition_type: 'to'
+              }
+            ]
+          }
+        ]
+      }
+
+      return { payload }
+    },
+    async normalize(res, { store }) {
+      // return res.orders
+
+      var { items: orders } = res
+
+      const results: any[] = orders.map(order => {
+        const {
+          entity_id: orderId,
+          increment_id: orderNo,
+          order_currency_code: currency,
+          grand_total,
+          customer_note_notify,
+          created_at,
+          updated_at,
+          status,
+          items
+        } = order
+
+        let result: any
+        let docRefNo = orderNo
+
+        let orderItems = items.map(item => {
+          var { item_id: name, product_id, qty_ordered: qty, price, original_price, price, tax_amount, tax_invoiced } = item
+
+          return {
+            name,
+            variationId: product_id,
+            qty,
+            paidPrice: price,
+            orderNo,
+            docRefNo,
+            total: price,
+            totalTax: tax_invoiced,
+            subtotal: original_price,
+            subtotalTax: tax_amount,
+            originalPrice: original_price
+          }
+        })
+
+        result = {
+          name: orderId,
+          orderNo,
+          currency,
+          totalAmount: grand_total,
+          remark: customer_note_notify,
+          orderCreatedAt: new Date(created_at).toUTCString(),
+          orderUpdatedAt: new Date(updated_at).toUTCString(),
+          status: status,
+          orderItems: orderItems
+        }
+
+        if (order?.extension_attributes?.shipping_assignments) {
+          const {
+            street,
+            telephone,
+            postcode,
+            city,
+            country_id,
+            firstname,
+            lastname,
+            middlename
+          } = order.extension_attributes.shipping_assignments[0].shipping.address
+
+          var orderShipping = {
+            address1: street,
+            address2: null,
+            address3: null,
+            address4: null,
+            address5: null,
+            phone1: telephone,
+            phone2: null,
+            postCode: postcode,
+            city,
+            country: country_id === 'MY' ? 'Malaysia' : country_id,
+            collectionCurrency: order.order_currency_code,
+            attentionTo: `${firstname} ${middlename} ${lastname}`
+          }
+
+          result.orderShipping = orderShipping
+
+          // For SC mapping
+          result.shipping = {
+            address_1: street,
+            postcode: postcode,
+            country: country_id,
+            city,
+            first_name: firstname,
+            last_name: lastname,
+            phone: telephone,
+            email: order.customer_email
+          }
+          let billingAddress = order?.billing_address
+          result.billing = {
+            address_1: billingAddress.street,
+            postcode: billingAddress.postcode,
+            country: billingAddress.country_id,
+            city: billingAddress.city,
+            first_name: billingAddress.firstname,
+            last_name: billingAddress.lastname,
+            phone: billingAddress.telephone,
+            email: billingAddress.email
+          }
+          result.firstName = order.customer_firstname
+          result.lastName = order.customer_lastname
+          result.isSOF = true
+        }
+
+        return result
+      })
+
+      let more = res.search_criteria.page_size * res.search_criteria.current_page < res.total_count || false
+
+      return { results, more }
+    }
+  }
+}

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

@@ -0,0 +1,43 @@
+export function getStoreProductCategories() {
+  return {
+    method: 'get',
+    path: '/categories/list',
+    denormalize(req) {
+      var { pagination } = req || {}
+      var { page = 0, limit = 100 } = pagination || {}
+
+      const resource: any = {}
+      const payload: any = {
+        pageSize: limit,
+        currentPage: page
+      }
+      return { resource, payload }
+    },
+    normalize(res) {
+      let results = res.items
+      results = mapCategories(results, [])
+      results = results.map(result => {
+        let { id, name, parent_id, is_active, children_data } = result
+        return {
+          id,
+          name,
+          parent: parent_id,
+          isActive: is_active
+        //   childrenCategories: children_data
+        }
+      })
+      results = results.filter(cat => cat.parent != 0)
+      return { results: results }
+    }
+  }
+}
+
+function mapCategories(results, arr) {
+  for (let result of results) {
+      if (result.children_data?.length > 0) {
+        mapCategories(result.children_data, arr)
+      }
+      arr.push(result)
+  }
+  return arr
+}

package/server/controllers/magento/apis/get-store-product-variations.ts

@@ -0,0 +1,17 @@
+/* https://magento.redoc.ly/2.4.2-admin/tag/configurable-productsskuchildren#operation/configurableProductLinkManagementV1GetChildrenGet */
+/* /v1/configurable-products/{sku}/children  */
+
+export function getStoreProductVariations() {
+  return {
+    method: 'get',
+    path: '/configurable-products/{sku}/children',
+    denormalize(req) {
+      const resource: any = { sku: req.sku }
+      const payload: any = {}
+      return { resource, payload }
+    },
+    async normalize(res, { store }) {
+      return res.items || []
+    }
+  }
+}

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

@@ -0,0 +1,44 @@
+/* https://magento.redoc.ly/2.4.2-admin/tag/productssku#operation/catalogProductRepositoryV1GetGet */
+
+export function getStoreProduct() {
+  return {
+    method: 'get',
+    path: '/products/{sku}',
+    denormalize(req) {
+      const resource: any = { sku: req.sku }
+      const payload: any = {}
+      return { resource, payload }
+    },
+    normalize(res) {
+      var { item_id, primary_category, skus } = res
+
+      const result: any = {
+        itemId: item_id,
+        categoryId: primary_category,
+        variations: skus.map(sku => {
+          return {
+            variationId: sku.ShopSku,
+            variationSku: sku.SellerSku,
+            channelSku: sku.SkuId,
+            qty: sku?.quantity ? sku.quantity : 0,
+            bufferQty: 0,
+            costPrice: sku.price,
+            sellPrice: sku.price,
+            discountId: sku.discount_id,
+            marketplaceStatus: sku.Status,
+            height: sku.package_height,
+            length: sku.package_length,
+            weight: sku.package_weight,
+            width: sku.package_width,
+            promo_from: sku.special_from_time,
+            promo_to: sku.special_to_time,
+            promo_price: sku.special_price,
+            promo_time_format: sku.special_time_format
+          }
+        })
+      }
+
+      return result
+    }
+  }
+}

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

@@ -0,0 +1,120 @@
+/* https://shopify.dev/docs/admin-api/rest/reference/products/product?api[version]=2020-07#index-2020-07 */
+
+import { StoreAPI } from '../../store-api'
+
+export function getStoreProducts() {
+  return {
+    method: 'get',
+    path: '/products',
+    denormalize(req) {
+      var { pagination } = req || {}
+      var { page, limit } = pagination || { page: 0, limit: 100 }
+
+      var payload: any = {
+        currentPage: page + 1,
+        pageSize: limit
+      }
+
+      return { payload }
+    },
+    async normalize(res, { store }) {
+      // return res.products
+      let { items, total_count } = res
+
+      let parentLinkList = items.map(e => {return {id: e.id, children: e.extension_attributes.configurable_product_links}})?.filter(e => e.children)
+
+      let activeMarketplaceDistributors: any[] = []
+      if (store?.marketplaceDistributors) {
+        activeMarketplaceDistributors = store.marketplaceDistributors.filter(
+          marketplaceDistributor => marketplaceDistributor.status === 'ACTIVE'
+        )
+      }
+
+      let results: any[] = []
+
+      for (var i = 0; i < items.length; i++) {
+        const product: any = items[i]
+
+        let totalProductQty: number = 0
+
+        try {
+          const stockItems: any[] = await StoreAPI.getStoreStockItem(store, {
+            sku: product.sku,
+            distributors: activeMarketplaceDistributors
+          })
+
+          stockItems.map(stockItem => {
+            if (stockItem.sku === product.sku) {
+              totalProductQty += stockItem.qty
+            }
+          })
+        } catch (e) {}
+        const productVariations: any[] = await StoreAPI.getStoreProductVariations(store, { sku: product.sku })
+
+        const result = {
+          itemId: product.id,
+          isku: product.sku,
+          name: product.name,
+          type: product.type_id,
+          hasVariation: false,
+          attributes: [],
+          images: product?.custom_attributes?.find(att => att.attribute_code == 'image')?.value
+            ? [
+                `${store.storeURL}pub/media/catalog/product${
+                  product?.custom_attributes?.find(att => att.attribute_code == 'image')?.value
+                }`
+              ]
+            : [],
+          categoryId: product?.custom_attributes?.find(att => att.attribute_code == 'category_ids').value[0],
+          variations:
+            productVariations.length > 0
+              ? productVariations.map(variant => {
+                  const { stock_id: variantStockId, qty: variantQty } = variant.extension_attributes.stock_item
+
+                  return {
+                    variationId: variant.id,
+                    variationSku: variant.sku,
+                    channelSku: variant.sku,
+                    name: variant.name,
+                    qty: variantQty,
+                    inventoryItemId: variantStockId,
+                    costPrice: variant.price,
+                    sellPrice: variant.price,
+                    marketplaceStatus: variant.status,
+                    primaryUnit: 'lbs',
+                    primaryUnitValue: variant.weight
+                  }
+                })
+              : [
+                  {
+                    variationId: product.id,
+                    variationSku: product.sku,
+                    channelSku: product.sku,
+                    name: product.name,
+                    qty: totalProductQty,
+                    costPrice: product.price,
+                    sellPrice: product.price,
+                    marketplaceStatus: product.status,
+                    primaryUnit: 'lbs',
+                    primaryUnitValue: product.weight,
+                    length:
+                      product?.custom_attributes?.find(att => att.attribute_code == 'ts_dimensions_length')?.value *
+                      25.4 || 0,
+                    width:
+                      product?.custom_attributes?.find(att => att.attribute_code == 'ts_dimensions_width')?.value *
+                      25.4 || 0,
+                    height:
+                      product?.custom_attributes?.find(att => att.attribute_code == 'ts_dimensions_height')?.value *
+                      25.4 || 0,
+                    weight: product.weight * 453.59237 || 0
+                  }
+                ]
+        }
+
+        results.push({ ...result })
+      }
+
+      return { results, total: total_count, parentLinkList }
+    }
+  }
+}