@leaddreamer/inventorylogic 0.0.3-beta.86 → 0.0.3-beta.89

package/business/Product/squarespace.js

@@ -9,9 +9,29 @@
 //import {SampleJSON, feedSample} from "./SquarespaceSample.js"
 import sampleJSON from './sampleJSON.json' with { type: 'json' };
 import feedSample from './feedSample.json' with { type: 'json' };
+import { factoryAPI } from '../APIs/index.js';
 //////////////////////////////////////////////////////////////////////
 // Constants
 
+export const SqsURL = "https://api.squarespace.com/";
+export const SqsProducts = "v2/commerce/products";
+export const listSqsProductsMethod = 'GET'
+
+export let SqsAPI = undefined;
+
+export function initSqs(authorizationCode) {
+    SqsAPI = factoryAPI(SqsURL, authorizationCode)
+
+};
+
+export async function listProductsSqs() {
+    if (SqsAPI) {
+        return await SqsAPI.get(SqsProducts).json();
+    } else {
+        return null;
+    }
+}
+
 /**
  * A list of attributes for a product
  * @typedef {Array.String} AttributeList
@@ -113,11 +133,12 @@ import feedSample from './feedSample.json' with { type: 'json' };
 
 /**
  * variant record (including inventory and pricing)
- * @typedef {object} PhysicalProductVariant
+ * @typedef {object} sqsPhysicalProductVariant
  * @property {Array.AttributeValue} attributes array of attribute/value pairs for a variant
  * @property {string} gtin Global Trade Item Number
  * @property {string} id unique ID for product variant
  * @property {ProductImage} image Image associated with this variant
+ * @property {Pricing} pricing
  * @property {string} mpn manufacturer part number
  * @property {ProductMeasurements} shippingMeasurements
  * @property {string} sku
@@ -125,8 +146,14 @@ import feedSample from './feedSample.json' with { type: 'json' };
  */
 
 /**
- * a Square product record
- * @typedef {object} PhysicalProduct
+ * a Squarespace product record
+ * Map between GoogleProductAPI and internal Product Data
+ * Note that when gg >> internal, index is *discovered* by searching
+ * for a matching item_group_id <<>> id. if item_group_id is *not*
+ * found add a new top-level product.
+ * Then look within  varinats for a matching SKU; if found, use that
+ * value for the index; if *not* found add the variant.
+ * @typedef {object} sqsPhysicalProduct
  * @property {dateTime} createdOn
  * @property {?string} id Id of document (redundant for convenience)
  * @property {dateTime} modifiedOn
@@ -144,81 +171,93 @@ import feedSample from './feedSample.json' with { type: 'json' };
  * @property {Array.PhysicalProductVariant} variants
  */
 
-//////////////////////////////////////////////////////////////////////
-// business operations
-
-//////////////////////////////////////////////////////////////////////
-// record operations
-
-//////////////////////////////////////////////////////////////////////
-// utilities
-
-const squarespaceVariantMap = {
-    "id": {target: "platformIds.SquarespaceId"},
-    "sku": {target: "sku"},
-    "image": {target: "image"},
-    "pricing": {target: "price"},
-    "stock": {target: "stock"},
-    "attributes": {target: "attributes"},
-    "shippingMeasurements": {target: "shippingMeasurements"},
-    "gtin": {target: "gtin"},
-    "mpn": {target: "mpn"},
+/**
+ * @type {sqsPhysicalProductVariant}
+ * @constant
+ * @default
+ */
+const sqsVariantMap = { 
+    //all assume productMap.variants[index] prefix
+    "id": { target: "platformData.squarespaceData.Id" },
+    "sku": { target: "sku" },
+    "image": { target: "image" },
+    "pricing": { target: "pricing" },
+    "stock": { target: "stock" },
+    "attributes": { target: "attributes" },
+    "shippingMeasurements": { target: "shippingMeasurements" },
+    "gtin": { target: "gtin" },
+    "mpn": { target: "mpn" },
     //other fields not used
 };
 
-const squarespaceProductMap = {
-    "id": {target: "platformIds.SquarespaceId"},
-    "type": {target:"product_type"},
-    "name": {target: "name"},
-    "description": {target: "description"},
-    "storePageId": {target: "platformData.squarespaceData.storePageId"},
-    "url": {target: "URL"},
-    "urlSlug": {target: "urlSlug"},
-    "images": {target: "mediaObject.images"},
-    "tags": {target: "attributes.tags"},
-    "seoOptions": {target: "seoOptions"},
-    "createdOn": {target: "recipe.createdOn"},
-    "modifiedOn": {target: "recipe.modifiedOn"},
+/**
+ * @type {sqsPhysicalProduct}
+ * @constant
+ * @default
+ */
+const sqsProductMap = {
+    "id": { target: "platformData.squarespaceData.Id" },
+    "type": { target: "product_type" },
+    "name": { target: "name" },
+    "description": { target: "description" },
+    "storePageId": { target: "platformData.squarespaceData.storePageId" },
+    "url": { target: "platformData.squarespaceData.URL" },
+    "urlSlug": { target: "platformData.squarespaceData.urlSlug" },
+    "images": { target: "mediaObject.images" },
+    "tags": { target: "attributes.tags" },
+    "seoOptions": { target: "seoOptions" },
+    "createdOn": { target: "recipe.createdOn" },
+    "modifiedOn": { target: "recipe.modifiedOn" },
     "variants": {
         target: "variants",
-        formatter: SquarespaceVariantMap
+        formatter: sqsVariantMap
     },
-    "variantAttributes": {target: "variantAttributes"},
-    "isVisible": {target: "isVisible"},
+    "variantAttributes": { target: "variantAttributes" },
+    "isVisible": { target: "isVisible" },
 };
 
-function jsonToItemMapping(itemJSON, itemMap) {
-    const incomingItem = JSON.parse(itemJSON);
-    return itemToItemMapping(incomingItem, itemMap);
-}
+//////////////////////////////////////////////////////////////////////
+// business operations
+
+//////////////////////////////////////////////////////////////////////
+// record operations
 
-export function jsonProductFeedToItemMapping(feedJSON) {
+//////////////////////////////////////////////////////////////////////
+// utilities
+
+/**
+ * Converts a JSON encoded Squarespace product feed to an array of internal products.
+ * @param {JSON} feedJSON 
+ * @returns {Array.Products}
+ */
+export function sqsProductFeedToProducts(feedJSON) {
     const incomingFeed = JSON.parse(feedJSON);
+    //returns an array
     return incomingFeed.products.map(product => {
-        return itemToItemMapping(product, SquarespaceProductMap);
+        return sqsProductToProduct(product, sqsProductMap);
     });
 }
 
-function itemToItemMapping(incomingItem, itemMap) {
-    
-    let properties = Object.getOwnPropertyNames(incomingItem);
-    let outputItem = properties.reduce((outbound, property) => {
-        const target = itemMap[property]?.target
+function sqsProductToProduct(sqProduct, itemMap) {
+
+    const properties = Object.getOwnPropertyNames(sqProduct);
+    const product = properties.reduce((outbound, property) => {
+        const target = itemMap[property]?.target;
         const formatter = itemMap[property]?.formatter;
-        let saveValue = Array.isArray(incomingItem[property])
-            ? incomingItem[property].map((entry) => {
+        const saveValue = Array.isArray(sqProduct[property])
+            ? sqProduct[property].map((entry) => {
                 return formatter
-                ? itemToItemMapping(entry, formatter)
-                : entry;
+                    ? sqsProductToProduct(entry, formatter)
+                    : entry;
             })
-            : incomingItem[property];
+            : sqProduct[property];
 
         const labels = target.split(".");
         return recursiveMapWalk(outbound, labels, saveValue);
 
-    }, {}) ;
+    }, {});
 
-    return outputItem;
+    return product;
 };
 
 /**
@@ -239,6 +278,40 @@ function recursiveMapWalk(thisObject, labels, value) {
     }
 };
 
-export function squarespaceFeedTest () {
-    return jsonProductFeedToItemMapping(feedSample);
-}
+/**
+ * Takes an array of internal Product Objects and converts it to 
+ * a JSON feed
+ * @param {Array.Product} productsArray 
+ */
+export function productsToSqsProductFeed(productsArray) {
+    const converted = productsArray.map((product) => {
+        return productToSqsProduct(product, sqsProductMap);
+    });
+    return JSON.stringify({ products: converted });
+};
+
+export function productToSqsProduct(product, itemMap) {
+
+    let properties = Object.getOwnPropertyNames(itemMap);
+    let outputItem = properties.reduce((outbound, property) => {
+        const formatter = itemMap[property]?.formatter;
+        const labels = itemMap[property]?.target.split(".");
+        const selectValue = labels.reduce((thisLevel, label) => {
+            return thisLevel[label];
+        }, product);
+        const saveValue = Array.isArray(selectValue)
+            ? selectValue.map((selectEntry) => {
+                return formatter
+                    ? productToSqsProduct(selectEntry, formatter)
+                    : selectEntry;
+            })
+            : selectValue;
+        outbound[property] = saveValue;
+        return {
+            ...outbound,
+            [property]: saveValue
+        };
+    }, {});
+    return outputItem;
+};
+

package/index.js

@@ -49,11 +49,12 @@ import { setLogger } from "@leaddreamer/genericutilities";
  * export * from "@leaddreamer/firebase-wrapper";
  * ```
  */
-export default async function databasePromise(firebase, config, thisLogger = null) {
+export async function databasePromise(firebase, config, thisLogger = null) {
   setLogger(thisLogger);
   return FirebaseWrapper(firebase, config, thisLogger);
 }
 
+export default databasePromise;
 export * from "./business/index.js";
 export * from "@leaddreamer/firebase-wrapper";
 export * from "@leaddreamer/genericutilities";

package/package.json

@@ -3,7 +3,7 @@
   "engines": {
     "node": ">=22"
   },
-  "version": "0.0.3-beta.86",
+  "version": "0.0.3-beta.89",
   "description": "Business & Database Logic for Inventory Services",
   "repository": {
     "type": "git",
@@ -49,6 +49,7 @@
     "@leaddreamer/firebase-wrapper": "^2.1.2-beta.0",
     "@leaddreamer/genericutilities": "^0.2.8",
     "@leaddreamer/staticforms": "^1.1.0",
+    "ky": "2.1.0",
     "lodash.clonedeep": "4.5.0"
   },
   "peerDependencies": {

package/whack.js

@@ -0,0 +1,18 @@
+import {
+    initSqs,
+    listProductsSqs,
+    sqsProductFeedToProducts,
+    productsToSqsProductFeed
+} from "./index.js";
+
+const code = '8b962d77-9fd3-49f4-8a56-5d64ba14afa0';
+
+await initSqs(code);
+
+const productJSON = await listProductsSqs();
+
+const items = sqsProductFeedToProducts(JSON.stringify(productJSON));
+
+const reverse = productsToSqsProductFeed(items);
+
+console.dir(reverse, { depth: null, length: null });