@things-factory/integration-marketplace 4.0.9 → 4.0.13

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

@@ -1,58 +1,16 @@
 /* https://woocommerce.github.io/woocommerce-rest-api-docs/?javascript#list-all-products  /wp-json/wc/v3/categoriess */
 
-export function getStoreProducts() {
+export function getStoreProductCategories() {
   return {
     method: 'get',
-    path: '/categories',
+    path: '/products/categories',
     denormalize(req) {
-      var { pagination } = req || {}
-      var { page, limit } = pagination || { page: 0, limit: 100 }
-
-      var payload: any = {
-        per_page: limit,
-        offset: page * limit
-      }
-
-      return { payload }
+      return { payload: {} }
     },
-    async normalize(res, { store }) {
-      // return res.products
-
-      let results: any[] = []
-      const totalProducts = res.totalProducts
-
-      for (var i = 0; i < res.products.length; i++) {
-        const product: any = res.products[i]
-        const productVariations: any[] = product.variations
-
-        const result = {
-          itemId: product.id,
-          name: product.name,
-          type: product.type,
-          description: product.description,
-          hasVariation: true,
-          categoryId: product?.categories.length > 0 ? product.categories[0].id : null,
-          attributes: [],
-          variations: productVariations.map(variant => {
-            return {
-              variationId: variant.id,
-              variationSku: variant.sku,
-              channelSku: variant.sku,
-              name: product.name + ' (' + variant.attributes[0].options + ')',
-              qty: variant.stock_quantity,
-              primaryUnit: 'N/A',
-              primaryUnitValue: variant.weight,
-              costPrice: variant.price,
-              sellPrice: variant.sale_price,
-              attributes: variant.attributes
-            }
-          })
-        }
-
-        results.push({ ...result })
-      }
+    normalize(res, { store }) {
+      const { items, totalItems } = res
 
-      return { results, total: totalProducts }
+      return { results: items, total: totalItems }
     }
   }
 }

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

@@ -1,7 +1,17 @@
 export * from './echo'
 export * from './create-order-note'
+export * from './get-store-product-categories'
 export * from './get-store-products'
 export * from './get-store-product-variations'
 export * from './get-store-orders'
 export * from './update-store-product-stock'
 export * from './update-store-product-variation-stock'
+export * from './get-store-product-categories'
+export * from './update-order'
+export * from './update-product-attribute'
+export * from './update-store-product-price'
+export * from './update-store-product-variation-price'
+export * from './get-store-order'
+export * from './update-store-product-price'
+export * from './update-store-product-variant-stock'
+export * from './update-store-product-variant-price'

package/server/controllers/woocommerce/apis/update-order.ts

@@ -0,0 +1,36 @@
+/* https://woocommerce.github.io/woocommerce-rest-api-docs/#update-an-order */
+/* /wp-json/wc/v3/orders/<id> */
+
+import { StoreAPI } from '../../store-api'
+
+export function updateOrder(req) {
+  return {
+    method: 'put',
+    path: '/orders/{orderId}',
+    async denormalize(req, { store }) {
+      var { status, orderId } = req || {}
+
+      const order = await StoreAPI.getStoreOrder(store, { orderId })
+
+      let orderStatus = status
+      if (orderStatus == 'PACKED') {
+        if (order.status == 'pending') {
+          orderStatus = 'on-hold'
+        } else {
+          orderStatus = order.status
+        }
+      }
+      if (orderStatus == 'READY_TO_SHIP') {
+        orderStatus = 'completed'
+      }
+      if (orderStatus == 'CANCELLED') {
+        orderStatus = 'cancelled'
+      }
+
+      return { resource: { orderId: orderId }, payload: { status: orderStatus } }
+    },
+    normalize(res) {
+      return res.items
+    }
+  }
+}

package/server/controllers/woocommerce/apis/update-product-attribute.ts

@@ -0,0 +1,17 @@
+/* https://woocommerce.github.io/woocommerce-rest-api-docs/#update-a-product-attribute */
+/* /wp-json/wc/v3/attributes/<id> */
+
+export function updateProductAttribute(req) {
+  return {
+    method: 'put',
+    path: '/products/attributes/{attributeId}',
+    denormalize(req) {
+      var { name, attributeId } = req || {}
+
+      return { resource: { attributeId: attributeId }, payload: { name } }
+    },
+    normalize(res) {
+      return res
+    }
+  }
+}

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

@@ -0,0 +1,20 @@
+/* https://woocommerce.github.io/woocommerce-rest-api-docs/?javascript#update-a-product */
+/* /wp-json/wc/v3/products/<id> */
+
+export function updateStoreProductPrice(req) {
+  return {
+    method: 'put',
+    path: '/products/{itemId}',
+    denormalize(req) {
+      var { costPrice, sellPrice, productId } = req || {}
+
+      return {
+        resource: { itemId: parseInt(productId) },
+        payload: { regular_price: costPrice?.toString(), sale_price: sellPrice?.toString() }
+      }
+    },
+    normalize(res) {
+      return res
+    }
+  }
+}

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

@@ -6,12 +6,12 @@ export function updateStoreProductStock(req) {
     method: 'put',
     path: '/products/{itemId}',
     denormalize(req) {
-      var { qty, itemId } = req[0] || {}
+      var { qty, itemId } = req || {}
 
       return { resource: { itemId: parseInt(itemId) }, payload: { stock_quantity: qty, manage_stock: true } }
     },
     normalize(res) {
-      return res.items
+      return res
     }
   }
 }

package/server/controllers/woocommerce/apis/update-store-product-variant-price.ts

@@ -0,0 +1,17 @@
+/* https://woocommerce.github.io/woocommerce-rest-api-docs/?javascript#update-a-product-variation */
+/* /wp-json/wc/v3/products/<product_id>/variations/<id> */
+
+export function updateStoreProductVariantPrice(req) {
+  return {
+    method: 'put',
+    path: '/products/{itemId}/variations/{variantId}',
+    denormalize(req) {
+      var { cost_price, sell_price, product_id, variant_id } = req[0] || {}
+
+      return { resource: { itemId: parseInt(product_id), variantId: parseInt(variant_id) }, payload: { price: cost_price, sale_price: sell_price } }
+    },
+    normalize(res) {
+        return res.items
+    }
+  }
+}

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

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

package/server/controllers/woocommerce/apis/update-store-product-variation-price.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 updateStoreProductVariationPrice(req) {
+  return {
+    method: 'put',
+    path: '/products/{itemId}/variations/{variantId}',
+    denormalize(req) {
+      var { costPrice, sellPrice, productId, variationId } = req || {}
+
+      return {
+        resource: { itemId: parseInt(productId), variantId: parseInt(variationId) },
+        payload: { regular_price: costPrice?.toString(), sale_price: sellPrice?.toString() }
+      }
+    },
+    normalize(res) {
+      return res
+    }
+  }
+}

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

@@ -1,4 +1,4 @@
-/* https://woocommerce.github.io/woocommerce-rest-api-docs/?javascript#update-a-product */
+/* 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) {
@@ -6,7 +6,7 @@ export function updateStoreProductVariationStock(req) {
     method: 'put',
     path: '/products/{itemId}/variations/{variationId}',
     denormalize(req) {
-      var { qty, itemId, variationId } = req[0] || {}
+      var { qty, itemId, variationId } = req || {}
 
       return {
         resource: { itemId: parseInt(itemId), variationId: parseInt(variationId) },
@@ -14,7 +14,7 @@ export function updateStoreProductVariationStock(req) {
       }
     },
     normalize(res) {
-      return res.items
+      return res
     }
   }
 }

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

@@ -1,10 +1,5 @@
-import { config } from '@things-factory/env'
-
 import { Woocommerce } from './woocommerce'
 
-const woocommerceConfig = config.get('marketplaceIntegrationWoocommerce', {})
-const { key_id, user_id, consumer_key, consumer_secret } = woocommerceConfig
-
 function substitute(path, obj) {
   var props = []
   var re = /{([^}]+)}/g
@@ -23,6 +18,15 @@ function substitute(path, obj) {
   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,

package/server/controllers/woocommerce/woocommerce.ts

@@ -18,14 +18,19 @@ export class Woocommerce {
     }
   }
 
+  /**
+   * @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 } = this.config
+    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}${
+    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)

package/server/routers/woocommerce-router.ts

@@ -7,6 +7,11 @@ import { STORE_STATUS } from '../graphql/constants'
 
 export const woocommerceRouter = new Router()
 
+/**
+ * @summary Callback After Authentication
+ * @description When the callback is triggered, we will receive key_id, user_id, consumer_key and consumer_secret
+ * from Woocommerce. We store them into database for easy retrieval.
+ */
 export type WoocommerAccessInfo = {
   key_id: number
   user_id: string
@@ -17,13 +22,6 @@ export type WoocommerAccessInfo = {
 
 woocommerceRouter.post('/callback-woocommerce', async (context, next) => {
   try {
-    // {
-    //   "key_id": 1,
-    //   "user_id": 123,
-    //   "consumer_key": "ck_xxxxxxxxxxxxxxxx",
-    //   "consumer_secret": "cs_xxxxxxxxxxxxxxxx",
-    //   "key_permissions": "read_write"
-    // }
     const accessInfo: WoocommerAccessInfo = context.request.body
     await saveWoocommerceAccessInfo(accessInfo)
     context.status = 200