@leaddreamer/inventorylogic 0.0.3-beta.75 → 0.0.3-beta.76

package/README.md

@@ -1185,7 +1185,7 @@ users
         * [~MarkupsDefault](#module_Markups..MarkupsDefault) : <code>Markups</code>
         * [~MaterialDefaultForm](#module_Markups..MaterialDefaultForm) : <code>Material</code>
         * [~MarkupsDefaultForm](#module_Markups..MarkupsDefaultForm) : <code>Stage</code>
-        * [~updateMarkups(stage, parent)](#module_Markups..updateMarkups) ⇒ <code>promise.LineItem</code>
+        * [~updateMarkups(markups, parent)](#module_Markups..updateMarkups) ⇒ <code>promise.LineItem</code>
         * [~Markups](#module_Markups..Markups) : <code>number</code>
 
 <a name="module_Markups.MaterialChoices"></a>
@@ -1224,16 +1224,16 @@ users
 **Read only**: true  
 <a name="module_Markups..updateMarkups"></a>
 
-### Markups~updateMarkups(stage, parent) ⇒ <code>promise.LineItem</code>
+### Markups~updateMarkups(markups, parent) ⇒ <code>promise.LineItem</code>
 writes record back to database.  Assumes only Id is valid
 
 **Kind**: inner method of [<code>Markups</code>](#module_Markups)  
 **Returns**: <code>promise.LineItem</code> - a copy of the data written  
 
-| Param | Type | Description |
-| --- | --- | --- |
-| stage | <code>LineItem</code> | a partially-populated product record for updates |
-| parent | <code>Record</code> | minimal record of product, user (or none) this stage belongs to |
+| Param | Type | Default | Description |
+| --- | --- | --- | --- |
+| markups | <code>Markups</code> |  | a partially-populated product record for updates |
+| parent | <code>Record</code> | <code></code> | minimal record of product, user (or none) this stage belongs to |
 
 <a name="module_Markups..Markups"></a>
 
@@ -2638,6 +2638,7 @@ Typedefs, constants, support functions and database operations related to Produc
 
 
 * [SquarespaceProduct](#module_SquarespaceProduct)
+    * [~recursiveMapWalk(thisObject, labels)](#module_SquarespaceProduct..recursiveMapWalk)
     * [~AttributeList](#module_SquarespaceProduct..AttributeList) : <code>Array.String</code>
     * [~AttributeValue](#module_SquarespaceProduct..AttributeValue) : <code>object</code>
     * [~ProductImage](#module_SquarespaceProduct..ProductImage) : <code>object</code>
@@ -2655,6 +2656,18 @@ Typedefs, constants, support functions and database operations related to Produc
     * [~PhysicalProductVariant](#module_SquarespaceProduct..PhysicalProductVariant) : <code>object</code>
     * [~PhysicalProduct](#module_SquarespaceProduct..PhysicalProduct) : <code>object</code>
 
+<a name="module_SquarespaceProduct..recursiveMapWalk"></a>
+
+### SquarespaceProduct~recursiveMapWalk(thisObject, labels)
+Uses an array of object member labels to insert a value into an object
+
+**Kind**: inner method of [<code>SquarespaceProduct</code>](#module_SquarespaceProduct)  
+
+| Param | Type |
+| --- | --- |
+| thisObject | <code>object</code> | 
+| labels | <code>Array.string</code> | 
+
 <a name="module_SquarespaceProduct..AttributeList"></a>
 
 ### SquarespaceProduct~AttributeList : <code>Array.String</code>
@@ -2933,19 +2946,23 @@ Creates a new Blank Product
 
 ### Product~ProductDefault : <code>Product</code>
 **Kind**: inner constant of [<code>Product</code>](#module_Product)  
-**Default**: <code>{&quot;name&quot;:&quot;&quot;,&quot;description&quot;:null,&quot;recipe&quot;:&quot;&quot;,&quot;image_links&quot;:&quot;&quot;,&quot;type&quot;:&quot;PHYSICAL&quot;,&quot;isVisible&quot;:true,&quot;seoOptions&quot;:&quot;&quot;,&quot;tags&quot;:&quot;&quot;,&quot;materials&quot;:&quot;&quot;,&quot;patterns&quot;:&quot;&quot;,&quot;URL&quot;:&quot;&quot;,&quot;urlSlug&quot;:&quot;&quot;,&quot;variantAttributes&quot;:&quot;&quot;,&quot;variants&quot;:&quot;&quot;,&quot;google_product_type&quot;:&quot;&quot;,&quot;shipping_time&quot;:0,&quot;condition&quot;:&quot;&quot;,&quot;adultQ&quot;:false,&quot;age_group&quot;:&quot;adult&quot;,&quot;color&quot;:&quot;&quot;,&quot;material&quot;:&quot;&quot;,&quot;gender&quot;:&quot;unisex&quot;,&quot;attributes_gemstones&quot;:&quot;&quot;,&quot;pattern&quot;:&quot;&quot;,&quot;size&quot;:&quot;&quot;,&quot;weight&quot;:0,&quot;shippingMeasurements&quot;:&quot;&quot;}</code>  
+**Default**: <code>{&quot;platformIds&quot;:&quot;&quot;,&quot;platformData&quot;:&quot;&quot;,&quot;name&quot;:null,&quot;short_name&quot;:null,&quot;description&quot;:null,&quot;short_description&quot;:null,&quot;google_product_category&quot;:null,&quot;product_type&quot;:null,&quot;brand&quot;:&quot;&quot;,&quot;demographics&quot;:&quot;&quot;,&quot;attributes&quot;:&quot;&quot;,&quot;recipe&quot;:&quot;&quot;,&quot;mediaObject&quot;:&quot;&quot;,&quot;mobileInfo&quot;:null,&quot;isVisible&quot;:true,&quot;type&quot;:&quot;PHYSICAL&quot;,&quot;seoOptions&quot;:&quot;&quot;,&quot;tags&quot;:&quot;&quot;,&quot;materials&quot;:&quot;&quot;,&quot;patterns&quot;:&quot;&quot;,&quot;URL&quot;:null,&quot;urlSlug&quot;:null,&quot;variantAttributes&quot;:&quot;&quot;,&quot;variants&quot;:&quot;&quot;}</code>  
 **Read only**: true  
 <a name="module_Product..ProductDataForm"></a>
 
 ### Product~ProductDataForm : <code>Product</code>
+Form to create test data
+
 **Kind**: inner constant of [<code>Product</code>](#module_Product)  
 **Default**: <code>{&quot;Id&quot;:&quot;&quot;,&quot;refPath&quot;:null,&quot;name&quot;:&quot;&quot;,&quot;description&quot;:&quot;&quot;,&quot;sku&quot;:&quot;&quot;,&quot;markups&quot;:&quot;&quot;,&quot;projectQ&quot;:&quot;&quot;}</code>  
 **Read only**: true  
 <a name="module_Product..ProductDefaultForm"></a>
 
 ### Product~ProductDefaultForm : <code>Product</code>
+Form to enter MINIMAL product data to start creation
+
 **Kind**: inner constant of [<code>Product</code>](#module_Product)  
-**Default**: <code>{&quot;Id&quot;:&quot;&quot;,&quot;refPath&quot;:&quot;&quot;,&quot;name&quot;:&quot;text&quot;,&quot;description&quot;:&quot;textarea&quot;,&quot;sku&quot;:&quot;text&quot;,&quot;markups&quot;:&quot;&quot;,&quot;projectQ&quot;:&quot;&quot;}</code>  
+**Default**: <code>{&quot;Id&quot;:&quot;&quot;,&quot;refPath&quot;:&quot;&quot;,&quot;name&quot;:&quot;text&quot;,&quot;description&quot;:&quot;textarea&quot;,&quot;sku&quot;:&quot;text&quot;}</code>  
 **Read only**: true  
 <a name="module_Product..updateProduct"></a>
 
@@ -2957,8 +2974,8 @@ writes record back to database.  Assumes only Id is valid
 
 | Param | Type | Default | Description |
 | --- | --- | --- | --- |
-| product | <code>LineItem</code> |  | a partially-populated product record for updates |
-| user | <code>Product</code> | <code></code> | minimal record of user this product belongs to |
+| product | <code>Product</code> |  | a partially-populated product record for updates |
+| user | <code>User</code> | <code></code> | minimal record of user this product belongs to |
 
 <a name="module_Product..summarizeProduct"></a>
 
@@ -3034,6 +3051,8 @@ a Brand Object
 
 | Name | Type | Description |
 | --- | --- | --- |
+| Id | <code>string</code> | Database Id of document (redundant for convenience) |
+| refPath | <code>string</code> | if from database, full path to document |
 | aggregateRating | <code>AggregateRatingsValue</code> |  |
 | logo | <code>URL</code> \| <code>ImageObject</code> |  |
 | review | <code>ReviewObject</code> | A review of the item. Supersedes reviews |
@@ -3201,7 +3220,7 @@ Demographics characteristics
 
 | Name | Type |
 | --- | --- |
-| adult | <code>boolean</code> | 
+| adultOriented | <code>boolean</code> | 
 | age_group | <code>AgeGroupEnum</code> | 
 | gender | <code>GenderEnum</code> | 
 
@@ -3215,9 +3234,9 @@ List of product ID's for various platforms
 
 | Name | Type |
 | --- | --- |
-| SquarespaceId | <code>Text</code> | 
-| GoogleMerchantId | <code>Text</code> | 
-| ShopifyId | <code>Text</code> | 
+| squarespaceId | <code>Text</code> | 
+| googleMerchantId | <code>Text</code> | 
+| shopifyId | <code>Text</code> | 
 
 <a name="module_Product..SquarespaceDataObject"></a>
 
@@ -3261,8 +3280,6 @@ List of Platform Specific Data
 | custom_label_2 | <code>string</code> | 
 | custom_label_3 | <code>string</code> | 
 | custom_label_4 | <code>string</code> | 
-| createdOn | <code>Date</code> | 
-| modifiedOn | <code>Date</code> | 
 
 <a name="module_Product..VideoImage"></a>
 
@@ -3294,7 +3311,7 @@ Media Related Data
 
 | Name | Type |
 | --- | --- |
-| images | <code>Array:ProductImage</code> | 
+| images | <code>Array.ProductImage</code> | 
 | video_image | <code>VideoImage</code> | 
 | virtual_model | <code>VirtualModel</code> | 
 
@@ -3308,7 +3325,7 @@ variant record (including inventory and pricing)
 
 | Name | Type | Description |
 | --- | --- | --- |
-| id | <code>string</code> | unique ID for product variant |
+| platformIds | <code>PlatformIDs</code> |  |
 | sku | <code>string</code> |  |
 | image | <code>ProductImage</code> | Image associated with this variant |
 | pricing | <code>FullProductPricing</code> |  |
@@ -3335,9 +3352,7 @@ a product record
 | Id | <code>string</code> | Database Id of document (redundant for convenience) |
 | refPath | <code>string</code> | if from database, full path to document |
 | platformIds | <code>PlatformIDs</code> |  |
-| platformData | <code>platformData</code> |  |
-| squarespaceData | <code>SquarespaceDataObject</code> |  |
-| storePageId | <code>Text</code> |  |
+| platformData | <code>PlatformData</code> |  |
 | name | <code>string</code> | name for the Product |
 | short_name | <code>string</code> | name for the Product |
 | description | <code>string</code> | Basic description of the product |

package/business/Markups/index.js

@@ -168,7 +168,7 @@ Forms.Choices[MATERIAL] = MaterialChoices
 // record operations
 /**
  * writes record back to database.  Assumes only Id is valid
- * @param {LineItem} stage a partially-populated product record for updates
+ * @param {Markups} markups a partially-populated product record for updates
  * @param {Record} parent minimal record of product, user (or none) this stage belongs to
  * @returns {promise.LineItem} a copy of the data written
  */

package/business/Product/Squarespace.js

@@ -6,6 +6,9 @@
 
 //import { PRODUCT, MARKUPS, ISBN_LENGTH } from "../boilerplate/index.js";
 
+//import {SampleJSON, feedSample} from "./SquarespaceSample.js"
+import SampleJSON from './SampleJSON.json' with { type: 'json' };
+import feedSample from './feedSample.json' with { type: 'json' };
 //////////////////////////////////////////////////////////////////////
 // Constants
 
@@ -150,59 +153,92 @@
 //////////////////////////////////////////////////////////////////////
 // utilities
 
-const SampleJSON = '{"id":"69fa54e8f691fe20c13bc732","type":"PHYSICAL","name":"Stack : : short gemstone earrings","description":"Bob","storePageId":"694b2289b16b8d02d4bdaaba","url":"https://sirlinhalljewelry.com/shop/p/stack-earrings-26050500","urlSlug":"p/stack-earrings-26050500","images":[{"id":"69fa5769cfa3e81e12d7c224","altText":"PXL_20260505_201834132.jpg","orderIndex":0,"url":"https://images.squarespace-cdn.com/content/v1/694b2288b16b8d02d4bdaa0c/2bf39ac2-a49b-4820-a211-961d6a0722ef/PXL_20260505_201834132.jpg","originalSize":{"width":480,"height":480},"availableFormats":[]},{"id":"69fa5769f691fe20c13bc9f8","altText":"PXL_20260505_201739701.jpg","orderIndex":1,"url":"https://images.squarespace-cdn.com/content/v1/694b2288b16b8d02d4bdaa0c/8d5186e3-e5a1-43bb-9714-77a939b8bc40/PXL_20260505_201739701.jpg","originalSize":{"width":480,"height":480},"availableFormats":[]},{"id":"69fa5769cfa3e81e12d7c225","altText":"PXL_20260505_201915047.jpg","orderIndex":2,"url":"https://images.squarespace-cdn.com/content/v1/694b2288b16b8d02d4bdaa0c/ff61c7e8-a03b-442e-81b2-db67241d85ec/PXL_20260505_201915047.jpg","originalSize":{"width":480,"height":480},"availableFormats":[]},{"id":"69fa5769f691fe20c13bc9f9","altText":"PXL_20260505_202122912.jpg","orderIndex":3,"url":"https://images.squarespace-cdn.com/content/v1/694b2288b16b8d02d4bdaa0c/357dfd2f-1bce-4687-b57b-1ff53209d970/PXL_20260505_202122912.jpg","originalSize":{"width":480,"height":480},"availableFormats":[]},{"id":"69fa5769a3780355a2edfbb0","altText":"PXL_20260505_202100350.jpg","orderIndex":4,"url":"https://images.squarespace-cdn.com/content/v1/694b2288b16b8d02d4bdaa0c/4fcf4192-dbe3-477a-90e7-be0c553f4c5b/PXL_20260505_202100350.jpg","originalSize":{"width":480,"height":480},"availableFormats":[]},{"id":"69fa5769cfa3e81e12d7c226","altText":"PXL_20260505_201947380.jpg","orderIndex":5,"url":"https://images.squarespace-cdn.com/content/v1/694b2288b16b8d02d4bdaa0c/fba1dcf8-8526-47ab-ab7f-be2ab37a1dbd/PXL_20260505_201947380.jpg","originalSize":{"width":480,"height":480},"availableFormats":[]}],"tags":[],"seoOptions":{"title":"Stack short gemstone and pearl earrings","description":"Tucson designer Lisa Sirlin-Halls Stack earrings are quick grabs of a bit of neutral with a pop of color when you want earrings for a casual day look."},"createdOn":"2026-05-05T20:36:56.235Z","modifiedOn":"2026-05-05T20:48:35.104Z","variants":[{"id":"fdb09e8d-467c-412e-a355-f6a40a24af24","sku":"26050101","image":null,"pricing":{"basePrice":{"currency":"USD","value":"68.00"},"salePrice":{"currency":"USD","value":"0.00"},"onSale":false},"stock":{"quantity":1,"unlimited":false},"attributes":{"Color":"Blue with Labradorite"},"shippingMeasurements":{"weight":{"unit":"POUND","value":0.0625},"dimensions":{"unit":"INCH","length":9,"width":6,"height":0.5}},"gtin":null,"mpn":null},{"id":"61c47a68-5acb-4d74-b18b-83ac27e49aeb","sku":"26050102","image":null,"pricing":{"basePrice":{"currency":"USD","value":"68.00"},"salePrice":{"currency":"USD","value":"0.00"},"onSale":false},"stock":{"quantity":1,"unlimited":false},"attributes":{"Color":"Silver with Black Onyx"},"shippingMeasurements":{"weight":{"unit":"POUND","value":0.0625},"dimensions":{"unit":"INCH","length":9,"width":6,"height":0.5}},"gtin":null,"mpn":null},{"id":"4b1ca060-8d0e-4e20-9863-cb37324da85d","sku":"26050103","image":null,"pricing":{"basePrice":{"currency":"USD","value":"68.00"},"salePrice":{"currency":"USD","value":"0.00"},"onSale":false},"stock":{"quantity":1,"unlimited":false},"attributes":{"Color":"Champagne yellow and Pearl"},"shippingMeasurements":{"weight":{"unit":"POUND","value":0.0625},"dimensions":{"unit":"INCH","length":9,"width":6,"height":0.5}},"gtin":null,"mpn":null}],"variantAttributes":["Color"],"isVisible":true}';
+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"},
+    //other fields not used
+};
 
 const SquarespaceProductMap = {
-    "id": "platformIds.SquarespaceId",
-    "type": "PHYSICAL",
-    "name": "name",
-    "description": "description",
-    "storePageId": "platformData.squarespaceData.storePageId",
-    "url": "URL",
-    "urlSlug": "urlSlug",
-    "images": [
-        "images[index]",
-    ],
-    "tags": "attributes.tags",
-    "seoOptions": "seoOptions",
-    "createdOn": "attributes.createdOn",
-    "modifiedOn": "attributes.modifiedOn",
-    "variants": [squarespaceVariantMapping],
-    "variantAttributes": "variantAttributes",
-    "isVisible": "isVisible",
+    "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"},
+    "variants": {
+        target: "variants",
+        formatter: SquarespaceVariantMap
+    },
+    "variantAttributes": {target: "variantAttributes"},
+    "isVisible": {target: "isVisible"},
 };
 
-function squarespaceJSONtoProductMapping(productJSON) {
-    console.log("productJSON");
-    console.dir(productJSON,  { depth: null });
-    const lesser = '{"id":"69fa5769cfa3e81e12d7c224","altText":"PXL_20260505_201834132.jpg","orderIndex":0,"url":"https://images.squarespace-cdn.com/content/v1/694b2288b16b8d02d4bdaa0c/2bf39ac2-a49b-4820-a211-961d6a0722ef/PXL_20260505_201834132.jpg","originalSize":{"width":480,"height":480},"availableFormats":[]}';
-    const incomingProduct = JSON.parse(productJSON);
-    console.log("incomingProduct");
-    console.dir(incomingProduct, {depth: null});
-    
-    let properties = Object.getOwnPropertyNames(incomingProduct);
-    console.log("properties: ", properties);
-    let storageProduct = properties.reduce((outbound, property) => {
-        const formatString = SquarespaceProductMap[property];
-        console.log(property, ": ", formatString);
-    }, {}) 
-};
+function JSONtoItemMapping(itemJSON, itemMap) {
+    const incomingItem = JSON.parse(itemJSON);
+    return ItemToItemMapping(incomingItem, itemMap);
+}
 
-squarespaceJSONtoProductMapping(SampleJSON);
+export function JSONProductFeedToItemMapping(feedJSON) {
+    const incomingFeed = JSON.parse(feedJSON);
+    return incomingFeed.products.map(product => {
+        return ItemToItemMapping(product, SquarespaceProductMap);
+    });
+}
 
-const SquarespaceVariantMap = {
-    "id": "id",
-    "sku": "sku",
-    "image": "image",
-    "pricing": "price",
-    "stock": "stock",
-    "attributes": "attributes",
-    "shippingMeasurements": "shippingMeasurements",
-    "gtin": "gtin",
-    "mpn": "mpn",
-    //other fields not used
+function ItemToItemMapping(incomingItem, itemMap) {
+    
+    let properties = Object.getOwnPropertyNames(incomingItem);
+    let outputItem = properties.reduce((outbound, property) => {
+        const target = itemMap[property]?.target
+        const formatter = itemMap[property]?.formatter;
+        let saveValue = Array.isArray(incomingItem[property])
+            ? incomingItem[property].map((entry) => {
+                return formatter
+                ? ItemToItemMapping(entry, formatter)
+                : entry;
+            })
+            : incomingItem[property];
+
+        const labels = target.split(".");
+        return recursiveMapWalk(outbound, labels, saveValue);
+
+    }, {}) ;
+
+    return outputItem;
 };
 
-async function squarespaceVariantMapping(product){
+/**
+ * Uses an array of object member labels to insert a value into an object
+ * @param {object} thisObject 
+ * @param {Array.string} labels 
+ */
+function recursiveMapWalk(thisObject, labels, value) {
+    if (labels.length < 1) {
+        return value;
+    } else {
+        const downObject = thisObject[labels[0]] ? thisObject[labels[0]] : {};
+        return {
+            ...thisObject,
+            //labels[0] as recursively passed to this level
+            [labels[0]]: recursiveMapWalk(downObject, labels.slice(1), value)
+        };
+    }
+};
 
-};
+export function squarespaceFeedTest () {
+    return JSONProductFeedToItemMapping(feedSample);
+}