@leaddreamer/inventorylogic 0.0.3-beta.47 → 0.0.3-beta.53

package/business/Product/Squarespace.js

@@ -0,0 +1,505 @@
+/**
+ * Typedefs, constants, support functions and database operations related to Products
+ * @module SquarespaceProduct
+ */
+import { Forms, fillForm } from "@leaddreamer/staticforms";
+
+import { PRODUCT, MARKUPS, ISBN_LENGTH } from "../boilerplate/index.js";
+
+//////////////////////////////////////////////////////////////////////
+// Constants
+
+/**
+ * A list of attributes for a product
+ * @typedef {Array.String} AttributeList
+ */
+
+/**
+ * Array of attribute name/value pairs
+ * @typedef {object} AttributeValue
+ * @property {string} AttibuteName attribute name from attribute list
+ * @property {string} value value for the particular attribute
+ */
+
+/**
+ * Image Descriptor
+ * @typedef {object} ProductImage
+ * @property {string} altText alt text for the image - SEO etc
+ * @property {Array.string} availableFormats Available image sizes.
+ * @property {string} id unique id for this productImage
+ * @property {integer} orderIndex Position of the image in the product's image list.
+ * @property {object} originalSize Image size when first uploaded.
+ * @property {string} URL Absolute URL of the image hosted on Squarespace.
+ */
+
+/**
+ * Currency Description ISO 4217 currency code
+ * @typedef {object} CurrencyDescription
+ * @property {string} currencyCode
+ * @property {integer} defaultFractionDigits
+ * @property {string} displayName
+ * @property {string} numericCodeAsString
+ * @property {string} symbol
+ */
+
+/**
+ * Monetary Value Specification
+ * @typedef {object} MonetaryValue
+ * @property {CurrencyDescription}
+ * @property {decimal} value Decimal monetary value
+ */
+
+/**
+ * Pricing Object
+ * @typedef {object} FullProductPricing
+ * @property {MonetaryValue} basePrice
+ * @property {boolean} onSale
+ * @property {MonetaryValue} salePrice
+ */
+
+/**
+ * @typedef {object} ProductDimensionsUnit
+ * @property {Text} name
+ * @property {Text} value
+ */
+
+/**
+ * Dimensions Object
+ * @typedef {object} ProductDimensions
+ * @property {float} height 
+ * @property {float} width 
+ * @property {float} length
+ * @property {ProductDimensionsUnit} unit
+ */
+
+/**
+ * @typedef {"KILOGRAM" | "POUND"} ProductWeightUnitEnum
+ */
+
+/**
+ * Weight Object
+ * @typedef {object} ProductWeight
+ * @property {"KILOGRAM" | "POUND"} unit
+ * @property {float} value
+ */
+
+/**
+ * Measurements of the variant when it's shipped. Present for PHYSICAL products only.
+ * @typedef {object} ProductMeasurements
+ * @property {ProductDimensions} dimensions
+ * @property {ProductWeight} weight
+ */
+
+/**
+ * Available stock for the variant. Present for PHYSICAL products only.
+ * @typedef {object} ProductStock
+ * @property {integer} quantity
+ * @property {boolean} unlimited
+ */
+
+
+/**
+ * variant record (including inventory and pricing)
+ * @typedef {object} PhysicalProductVariant
+ * @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 {string} mpn manufacturer part number
+ * @property {ProductMeasurements} shippingMeasurements
+ * @property {string} sku
+ * @property {ProductStock} stock
+ */
+
+/**
+ * Meta Information for SEO
+ * @typedef {object} MetaData
+ * @property {string} title
+ * @property {string} description
+ */
+
+/**
+ * @typedef {"PHYSICAL" | "SERVICE" | "GIFT_CARD" | "DIGITAL"} ProductTypeV2Enum
+ */
+
+/**
+ * a Square product record
+ * @typedef {object} PhysicalProduct
+ * @property {dateTime} createdOn
+ * @property {?string} id Id of document (redundant for convenience)
+ * @property {dateTime} modifiedOn
+ * @property {string} storePageId
+ * @property {"PHYSICAL" | "SERVICE" | "GIFT_CARD" | "DIGITAL"} type
+ * @property {string} description Basic description of the product
+ * @property {Array.ProductImage} images Image associated with this variant
+ * @property {boolean} isVisible
+ * @property {string} name name for the Product
+ * @property {MetaData} seoOptions
+ * @property {Array.string} tags
+ * @property {string} URL
+ * @property {string} urlSlug
+ * @property {Array.string} variantAttributes
+ * @property {Array.PhysicalProductVariant} variants
+ */
+
+/**
+ * @readonly
+ * @constant
+ * @type {PhysicalProduct}
+ * @default
+ */
+const PhysicalProductDefault = {
+    created: null,
+    id: null,
+    modified: null,
+    storePageId: "",
+    type: PHYSICAL,
+    description: null,
+    images: [],
+    isVisible: true,
+    name: `A Product`,
+    seoOptions: {
+        title: "",
+        description: "",
+    },
+    tags: [],
+    url: "",
+    urlSlug: "",
+    variantAttributes: [],
+    variants: [
+        {
+            attributes: [],
+            gtin: "",
+            id: "",
+            image: {},
+            mpn: "",
+            shippingMeasurements: {
+                dimensions: {
+                    height: 0,
+                    width: 0,
+                    length: 0,
+                    height: 0,
+                    unit: INCH,
+                },
+                weight: {
+                    value: 0,
+                    unit: POUND,
+                }
+            },
+            sku: "",
+            stock: {
+                quantity: 0,
+                unlimited: false,
+            }
+        }
+    ],
+};
+
+/**
+/**
+ * @readonly
+ * @constant
+ * @type {PhysicalProduct}
+ * @default
+ */
+const PhysicalProductMap = {
+
+}
+
+/**
+ * @readonly
+ * @constant
+ * @type {Product}
+ * @default
+ */
+const ProductDataForm = {
+    Id: `string.uuid`,
+    refPath: null,
+    name: `commerce.product`,
+    description: `commerce.productDescription`,
+    sku: `commerce.isbn:${ISBN_LENGTH}`,
+    markups: `subrecord:${MARKUPS}`,
+    projectQ: `checkbox`
+};
+
+/**
+ * @readonly
+ * @constant
+ * @type {Product}
+ * @default
+ */
+const ProductDefaultForm = {
+    Id: `hidden`,
+    refPath: `hidden`,
+    name: "text",
+    description: "textarea",
+    sku: "text",
+    markups: `subrecord:${MARKUPS}`,
+    projectQ: `checkbox`,
+};
+
+Forms.Base[PRODUCT] = ProductDefault;
+Forms.BaseForm[PRODUCT] = ProductDefaultForm;
+Forms.CreateForm[PRODUCT] = ProductDefaultForm;
+Forms.Data[PRODUCT] = ProductDataForm;
+Forms.Summarize[PRODUCT] = summarizeProduct;
+Forms.Save[PRODUCT] = updateProduct;
+Forms.SearchBy[PRODUCT] = "name";
+
+//////////////////////////////////////////////////////////////////////
+// business operations
+
+//////////////////////////////////////////////////////////////////////
+// record operations
+
+//////////////////////////////////////////////////////////////////////
+// utilities
+
+const SampleJSON = {
+    "id": "69fa54e8f691fe20c13bc732",
+    "type": "PHYSICAL",
+    "name": "Stack : : short gemstone earrings",
+    "description": "<p style=\"white-space:pre-wrap;\" data-rte-preserve-empty=\"true\">About an inch long, my Stack earrings are quick grabs of a bit of neutral with a pop of color when you want earrings for a casual day look. Choose your favorite palette or ping me with your own color combinations and ideas!</p><p style=\"white-space:pre-wrap;\" data-rte-preserve-empty=\"true\"><span>:: great gift!<br />:: 1.25 inches<br />:: limited edition<br />:: ships 4-7 days from purchase<br />:: handcrafted in tucson, arizona</span></p>",
+    "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-Hall's 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.0,
+                    "width": 6.0,
+                    "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.0,
+                    "width": 6.0,
+                    "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.0,
+                    "width": 6.0,
+                    "height": 0.5
+                }
+            },
+            "gtin": null,
+            "mpn": null
+        }
+    ],
+    "variantAttributes": [
+        "Color"
+    ],
+    "isVisible": true,
+};
+
+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",
+};
+
+function squarespaceJSONtoProductMapping(productJSON) {
+    const incomingProduct = JSON.parse(productJSON);
+    let storageProduct = {};
+    let properties = Object.getOwnPropertyNames(incomingProduct);
+    console.log(properties);
+
+};
+
+squarespaceJSONtoProductMapping(SampleJSON);
+
+const SquarespaceVariantMap = {
+    "id": "id",
+    "sku": "sku",
+    "image": "image",
+    "pricing": "price",
+    "stock": "stock",
+    "attributes": "attributes",
+    "shippingMeasurements": "shippingMeasurements",
+    "gtin": "gtin",
+    "mpn": "mpn",
+    //other fields not used
+};
+
+async function squarespaceVariantMapping(product){
+
+};