@leaddreamer/inventorylogic 0.0.3-beta.87 → 0.0.3-beta.90

package/business/APIs/index.js

@@ -0,0 +1,18 @@
+import ky from "ky";
+
+export function factoryAPI(baseURL, authorizationCode) {
+    return ky.create({
+        prefix: baseURL,
+        header: {
+            'Authorization': `Bearer ${authorizationCode}`,
+        },
+        hooks: {
+            beforeRequest: [
+                ({ request }) => {
+                    request.headers.set('Authorization', `Bearer ${authorizationCode}`);
+                }
+            ]
+        }
+    });
+}
+

package/business/Product/googleMerchantAPI.js

@@ -5,6 +5,16 @@
 //////////////////////////////////////////////////////////////////////
 // Constants
 
+/**
+ * @typedef {object} Price
+ * @property {string} amountMicros
+ * int64. The price represented as a number in micros (1 million micros
+ * is an equivalent to one's currency standard unit, for example,
+ * 1 USD = 1000000 micros).
+ * @property {string} currencyCode
+ * The currency of the price using three-letter acronyms according to ISO 4217.
+ */
+
 /**
  * @typedef {string} SKU
  */
@@ -37,8 +47,8 @@
  */
 
 /**
- * a Google Product record
- * @typedef {object} GoogleProductAPI
+ * a Google Product Attributes - Product-specific part of product Feed
+ * @typedef {object} GoogleProductAttributes
  * @property {SKU} id id of Product also used as sku
  * @property {Name} title title (name) of Product
  * @property {Text} item_group_id ID for a group of products that come in different versions (variants)
@@ -66,7 +76,7 @@
  * page and be clear to your customers (for example, “May 6, 2023”).
  * If an exact date can’t be provided, you can use an estimated date
  * (for example, “May 2023”).
- * @property {?string|ISO4217} cost_of_goods_sold
+ * @property {?Price} cost_of_goods_sold
  * The costs associated with the sale of a particular product as defined
  * by the accounting convention you set up. These costs may include
  * material, labor, freight, or other overhead expenses. By
@@ -74,14 +84,14 @@
  * other metrics, such as your gross margin and the amount of revenue
  * generated by your ads and free listings.
  * @property {ISO8601} expiration_date The date that your product should stop showing
- * @property {number|ISO4217} price
- * @property {?number|ISO4217} sale_price
+ * @property {Price} price
+ * @property {?Price} sale_price
  * @property {?DateRange} sale_price_effective_date
  * @property {?GoogleProductTaxonomy} google_product_category
  * @property {?string} product_type "Casual" google_product_category
  * @property {Text} brand
  * The brand(s) associated with a product or service, or the brand(s) maintained by an organization or business user.
- * @property {gtin8 | gtin12 | gtin13 | gtin14 | gtin | isbn} gtin
+ * @property {"gtin8"|"gtin12"|"gtin13"|"gtin14"|"gtin"} gtin
  * @property {Text} mpn
  * The Manufacturer Part Number (MPN) of the product, or the product to which the offer refers.
  * @property {"no"|"yes"} adult
@@ -146,72 +156,386 @@
  */
 
 /**
+ * A message that represents custom attributes. Exactly one of value or groupValues must not be empty.
+ * @typedef {object} CustomAttribute
+ * @property {string} name The name of the attribute.
+ * @property {string} value The value of the attribute. If value is not empty, groupValues must be empty.
+ * @property {Array.CustomAttribute} groupValues
+ * Subattributes within this attribute group. If groupValues is not empty, value must be empty.
+ */
+
+/**
+ * Google Product feed "wrapper"
+ * @typedef {object} GoogleProductAPI
+ * @property {string} name
+ * Identifier. The name of the product.
+ * Format: accounts/{account}/productInputs/{productinput}
+ * The {productinput} segment is a unique identifier for the product.
+ * This identifier must be unique within a merchant account and
+ * generally follows the structure: contentLanguage~feedLabel~offerId.
+ * Example: en~US~sku123 For legacy local products, the structure is:
+ * local~contentLanguage~feedLabel~offerId. Example: local~en~US~sku123
+ * @property {string} base64EncodedName
+ * Output only. The unpadded base64url encoded name of the product
+ * input. Format: accounts/{account}/productInputs/{productinput}
+ * where the last section productinput is the unpadded base64url encoding
+ * of the contentLanguage~feedLabel~offerId name. Example:
+ * accounts/123/productInputs/ZW5-VVN-c2t1LzEyMw for the decoded product
+ * input name accounts/123/productInputs/en~US~sku/123. This field can
+ * be used directly as input to the API methods that require the product
+ * input name to be encoded if it contains special characters, for
+ * example GetProductInput.
+ * @property {string} product
+ * Output only. The name of the processed product. Format: accounts/{account}/products/{product}
+ * @property {string} base64EncodedProduct
+ * Output only. The unpadded base64url encoded name of the processed
+ * product. Format: accounts/{account}/products/{product} where the
+ * last section product is the unpadded base64url encoding of the
+ * contentLanguage~feedLabel~offerId name. Example:
+ * accounts/123/products/ZW5-VVN-c2t1LzEyMw for the decoded product
+ * name accounts/123/products/en~US~sku/123. This field can be used
+ * directly as input to the API methods that require the product name
+ * to be encoded if it contains special characters, for example GetProduct.
+ * @property {boolean} legacyLocal
+ * Immutable. Determines whether the product is only targeting local
+ * destinations and whether the product name should be distinguished
+ * with a local~ prefix. For example, accounts/123/productInputs/local~en~US~sku123.
+ * If a product that is not legacyLocal is already targeting local
+ * destinations, creating a legacyLocal product with an otherwise
+ * matching name will fail.
+ * @property {string} offerId
+ * Required. Immutable. Your unique identifier for the product. This is
+ * the same for the product input and processed product. Leading and
+ * trailing whitespaces are stripped and multiple whitespaces are
+ * replaced by a single whitespace upon submission. See the products
+ * data specification for details.
+ * @property {string} contentLanguage
+ * Required. Immutable. The two-letter ISO 639-1 language code for the product.
+ * @property {string} feedLabel
+ * Required. Immutable. The feed label that lets you categorize and
+ * identify your products. The maximum allowed characters are 20, and
+ * the supported characters are A-Z, 0-9, hyphen, and underscore. The
+ * feed label must not include any spaces. For more information, see
+ * Using feed labels.
+ * @property {GoogleProductAttributes} productAttributes
+ * Optional. A list of strongly-typed product attributes.
+ * @property {Array.CustomAttribute} customAttributes
+ * Optional. A list of custom (merchant-provided) attributes. It can
+ * also be used for submitting any attribute of the data specification
+ * in its generic form (for example, { "name": "size type",
+ * "value": "regular" }). This is useful for submitting attributes not
+ * explicitly exposed by the API. Maximum allowed number of characters
+ * for each custom attribute is 10240 (represents sum of characters for
+ * name and value). Maximum 2500 custom attributes can be set per
+ * product, with total size of 102.4kB. Underscores in custom attribute
+ * names are replaced by spaces upon insertion.
+ * @property {string} versionNumber
+ * Optional. Immutable. Represents the existing version (freshness) of
+ * the product, which can be used to preserve the right order when
+ * multiple updates are done at the same time.
+ * If set, the insertion is prevented when version number is lower than
+ * the current version number of the existing product. Re-insertion
+ * (for example, product refresh after 30 days) can be performed with
+ * the current versionNumber.
+ * Only supported for insertions into primary data sources. Do not set
+ * this field for updates. Do not set this field for insertions into
+ * supplemental data sources.
+ * If the operation is prevented, the aborted exception will be thrown.
+ */
+
+/**
+ * A Map between GoogleProductAPI and Pricing Internal API
  * @type {GoogleProductAPI}
+ * @const
  */
-export const googleAPIProductMap = {
+export const ggProductMap = {
+   //all assume variants.index. prefix
+   "name": { 
+      target: "variants.index.platformData.googleData.name",
+      //formula: "accounts/{$account}/productInputs/{$productinput}",
+      //productInput = '${contentLanguage}~${feedLabel}~${sku}'
+   },
+   "base64EncodedName": {
+      target: "variants.index.platformData.googleData.base64EncodedName"
+   },
+   "product": {
+      target: "variants.index.platformData.googleData.product"
+   },
+   "base64EncodedProduct": {
+      target: "variants.index.platformData.googleData.base64EncodedProduct"
+   },
+   "legacyLocal": {
+      target: "variants.index.platformData.googleData.legacyLocal"
+   },
+   "offerId": {
+      //immutable. Used to create.
+      target: "variants.index.sku",
+   },
+   "contentLanguage": {
+      //immutable. Used to create.
+      target: "variants.index.platformData.googleData.contentLanguage",
+   },
+   "feedLabel": {
+      //immutable. Used to create.
+      target: "variants.index.platformData.googleData.feedLabel",
+   },
+   "productAttributes": {
+      target: "",
+      formatter: ggProductAttributeMap,
+   },
+   "customAttributes": {
+      target: "variants.index.platformData.googleData.customAttributes",
+      formatter: ggcustomAttributes,
+   },
+   "versionNumber": {
+      target: "variants.index.versionNumber",
+   },
+}
+
+/**
+ * @type {GoogleProductAttributes}
+ */
+export const ggProductAttributeMap = {
    //id needs programmatic processing
-   id: "variants[index].sku", //id of Product also used as sku
+   id: "variants.index.sku", //id of Product also used as sku
    title: "name", //title (name) of Product
    item_group_id: "id",
    item_group_title: "title",
    description: "description",
-   link: "URL",
+   link: "variants.index.URL",
    //image_link and image_additional_links need programmatic process
-   image_link: "variants[index].image.URL",
-   additional_image_link: "mediaobject.images[all]",
+   image_link: "variants.index.image.URL",
+   additional_image_link: "mediaobject.images", //could be array
    video_link: "mediaobject.video_image.video_link",
    virtual_model_link: "mediaobject.virtual_model.virtual_model_link",
-   mobile_link: null,
+   //mobile_link: null,
    //availability needs to be programmatic
    availability: null, //"in_stock" | "out_of_stock" | "preorder" | "backorder",
-   availability_date: "variants[index].availability_date",
-   cost_of_goods_sold: null,
-   expiration_date: "variants[index].expiration_date",
-   price: "variants[index].pricing.baseprice.value| |variants[index].pricing.baseprice.currencyDescription.displayName",
-   sale_price: "variants[index].pricing.saleprice.value| |variants[index].pricing.saleprice.currencyDescription.displayName",
-   sale_price_effective_date: "variants[index].pricing.effectiveDate.",
+   availability_date: "variants.index.availability_date",
+   //cost_of_goods_sold: null,
+   expiration_date: "variants.index.expiration_date",
+   price: {
+      amountMicros: "variants.index.pricing.baseprice.value",
+      currenyCode: "variants.index.pricing.baseprice.currencyDescription.displayName"
+   },
+   sale_price: {
+      amountMicros: "variants.index.pricing.saleprice.value",
+      currenyCode: "variants.index.pricing.saleprice.currencyDescription.displayName"
+   },
+   sale_price_effective_date: "variants.index.pricing.effectiveDate.",
    google_product_category: "google_product_category",
    product_type: "product_type",
    brand: "brand.name",
-   gtin: "variants[index].gtin",
-   mpn: "variants[index].gtin",
+   gtin: "variants.index.gtin",
+   mpn: "variants.index.gtin",
    adult: "demographics.adult",
    age_group: "demographics.age_group",
    gender: "demographics.gender",
    condition: "attributes.condition",
-   color: "attributes.colors[0]",
-   material: "attributes.materials[0]",
-   pattern: "attributes.patterns[0]",
-   product_length: "variants[index].productMeasurements.dimensions.length&' '&variants[index].productMeasurements.dimensions.unit",
-   product_width: "variants[index].productMeasurements.dimensions.width&' '&variants[index].productMeasurements.dimensions.unit",
-   product_height: "variants[index].productMeasurements.dimensions.height&' '&variants[index].productMeasurements.dimensions.unit",
+   color: "attributes.colors.0",
+   material: "attributes.materials.0",
+   pattern: "attributes.patterns.0",
+   product_length: {
+      value: "variants.index.productMeasurements.dimensions.length",
+      unit: "variants.index.productMeasurements.dimensions.unit",
+   },
+   product_width: {
+      value: "variants.index.productMeasurements.dimensions.width",
+      unit: "variants.index.productMeasurements.dimensions.unit",
+   },
+   product_height: {
+      value: "variants.index.productMeasurements.dimensions.height",
+      unit: "variants.index.productMeasurements.dimensions.unit",
+   },
    product_highlight: "short_description",
-   product_weight: "variants[index].productMeasurements.weight.value&' '&variants[index].productMeasurements.weight.unit",
+   product_weight: {
+      value: "variants.index.productMeasurements.weight.value",
+      unit: "variants.index.productMeasurements.weight.unit",
+   },
    /*question_and_answer: [
       {
          question: Text,
          answer: Text,
       },
    ],*/
-   size: "variants[index].sizeSpecification.hasMeasurement.value",
-   size_type: "variants[index].sizeSpecification.sizeGroup",
-   size_system: "variants[index].sizeSpecification.sizeSystem",
-   variant_option: "variants[index].sizeSpecification.attributes",
-   ads_redirect: null,
-   custom_label_0: null,
-   custom_label_1: null,
-   custom_label_2: null,
-   custom_label_3: null,
-   custom_label_4: null,
-   promotion_id: null,
-   lifestyle_image_link: null,
+   size: "variants.index.sizeSpecification.hasMeasurement.value",
+   size_type: "variants.index.sizeSpecification.sizeGroup",
+   size_system: "variants.index.sizeSpecification.sizeSystem",
+   variant_option: "variants.index.attributes",
+   //ads_redirect: null,
+   //custom_label_0: null,
+   //custom_label_1: null,
+   //custom_label_2: null,
+   //custom_label_3: null,
+   //custom_label_4: null,
+   //promotion_id: null,
+   //lifestyle_image_link: null,
    short_title: "short_name",
-   shipping_length: "variants[index].shippingMeasurements.dimensions.length",
-   shipping_width: "variants[index].shippingMeasurements.dimensions.width",
-   shipping_height: "variants[index].shippingMeasurements.dimensions.height",
-   shipping_label: null,
+   shipping_length: {
+      value: "variants.index.shippingMeasurements.dimensions.length",
+      unit: "variants.index.shippingMeasurements.dimensions.unit",
+   },
+   shipping_width: {
+      value: "variants.index.shippingMeasurements.dimensions.width",
+      unit: "variants.index.shippingMeasurements.dimensions.unit",
+   },
+   shipping_height: {
+      value: "variants.index.shippingMeasurements.dimensions.height",
+      unit: "variants.index.shippingMeasurements.dimensions.unit",
+   },
+   //shipping_label: null,
+};
+
+/**
+ * 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.
+ * @type {GoogleProductAPI}
+ * @const
+ */
+export const ggProductInputMap = {
+   //all assume variants.index prefix
+   "legacyLocal": {
+      target: "variants.index.platformData.googleData.legacyLocal"
+   },
+   "offerId": {
+      //immutable. Used to create.
+      target: "variants.index.sku",
+   },
+   "contentLanguage": {
+      //immutable. Used to create.
+      target: "variants.index.platformData.googleData.contentLanguage",
+   },
+   "feedLabel": {
+      //immutable. Used to create.
+      target: "variants.index.platformData.googleData.feedLabel",
+   },
+   "productAttributes": {
+      target: "",
+      formatter: "ggProductAttributeMap"
+   },
+   "customAttributes": {
+      target: "variants.index.platformData.googleData.customAttributes",
+      formatter: ggcustomAttributes,
+   },
+   "versionNumber": {
+      target: "variants.index.versionNumber",
+   },
 }
 
+/**
+ * Because Google Merchants uses a NON-hierarchical variants listing
+ * system - each variant is a separate item, linked to it's "group"/
+ * parent by an id.  As such, we need to "unwrap" our internal
+ * hierarchical system.
+ * Each "product" is processed by walking an "index" of the variants,
+ * building a single GoogleMerchant listing for each variant.
+ */
+
+/**
+ * Converts a JSON encoded Squarespace product feed to an array of internal products.
+ * @param {JSON} feedJSON 
+ * @returns {Array.Products}
+ */
+export function ggProductFeedToProducts(feedJSON) {
+   const incomingFeed = JSON.parse(feedJSON);
+   //returns an array
+   return incomingFeed.products.map(product => {
+      return ggProductToProduct(product, ggProductMap);
+   });
+}
+
+function ggProductToProduct(ggProduct, itemMap) {
+
+   const properties = Object.getOwnPropertyNames(ggProduct);
+   const product = properties.reduce((outbound, property) => {
+      const target = itemMap[property];
+      const saveValue = Array.isArray(ggProduct[property])
+         ? ggProduct[property].map((entry) => {
+            return formatter
+               ? ggProductToProduct(entry, formatter)
+               : entry;
+         })
+         : ggProduct[property];
+
+      const labels = target.split(".");
+      return recursiveMapWalk(outbound, labels, saveValue);
+
+   }, {});
+
+   return 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)
+      };
+   }
+};
+
+/**
+ * Takes an array of internal Product Objects and converts it to 
+ * a JSON feed
+ * @param {Array.Product} productsArray 
+ */
+export function productsToGgProductFeed(productsArray) {
+   const converted = productsArray.reduce((accumulate, product) => {
+      const set = productToGgProducts(product, ggProductMap);
+      return accumulate.concat(set);
+   }, []);
+   return JSON.stringify({ products: converted });
+};
+
+export function productToGgProducts(product, itemMap) {
+
+   const group = product.variants.map((variant, index) => {
+      let properties = Object.getOwnPropertyNames(itemMap);
+
+      let outputItem = properties.reduce((outbound, property) => {
+         if (!itemMap[property])
+            return {
+               ...outbound,
+               [property]: null
+            };
+         const segments = itemMap[property].split("&");
+
+         const finalValue = segments.reduce((prevSegment, segment) => {
+            const labels = segment.split(".");
+            const newSegment = labels.reduce((thisLevel, label) => {
+               if (!thisLevel)
+                  return null;;
+               return thisLevel[label == "index" ? index : label];
+            }, product);
+            return prevSegment
+               ? '${prevSegment} ${newSegment}'
+               : newSegment;
+         }, null);
+
+         return {
+            ...outbound,
+            [property]: finalValue
+         };
+      }, {});
+      return outputItem;
+   }, {});
+   return group;
+};
+
+
 /**
  * 
  * @param {string} field 

package/business/Product/index.js

@@ -176,22 +176,25 @@ import { typedRecordFromChild } from "../Utilities/index.js"
 
 /**
  * List of product ID's for various platforms
- * @typedef {object} PlatformIDs
- * @property {Text} squarespaceId
- * @property {Text} googleMerchantId
- * @property {Text} shopifyId
+ * @typedef {object} PlatformData
+ * @property {Text} squarespace
+ * @property {Text} googleMerchant
+ * @property {Text} shopify
  */
 
 /**
  * Squarespace Specific Data
  * @typedef {object} SquarespaceDataObject
- * @property {Text} storePageId
+ * @property {string} SquarespaceId
+ * @property {string} storePageId
  */
 
 /**
  * List of Platform Specific Data
  * @typedef {object} PlatformData
  * @property {SquarespaceDataObject} squarespaceData
+ * @property {GoogleDataObject} googleData
+ * @property {ShopifyDataObject} shopifyData
  */
 
 /**
@@ -229,7 +232,7 @@ import { typedRecordFromChild } from "../Utilities/index.js"
 /**
  * variant record (including inventory and pricing)
  * @typedef {object} PhysicalProductVariant
- * @property {PlatformIDs} platformIds
+ * @property {PlatformData} platformData
  * @property {string} sku
  * @property {ProductImage} image Image associated with this variant
  * @property {FullProductPricing} pricing
@@ -262,7 +265,6 @@ import { typedRecordFromChild } from "../Utilities/index.js"
  * @typedef {object} Product
  * @property {?string} Id Database Id of document (redundant for convenience)
  * @property {?string} refPath if from database, full path to document
- * @property {PlatformIDs} platformIds
  * @property {PlatformData} platformData
  * @property {string} name name for the Product
  * @property {string} short_name name for the Product
@@ -291,11 +293,11 @@ import { typedRecordFromChild } from "../Utilities/index.js"
  * @type {Product}
  * @default
  */
-const productDefault = {
-  platformIds: {
-    squarespaceId: null,
-    googleMerchantId: null,
-    shopifyId: null
+const productDefault = { 
+  platformData: {
+    squarespace: null,
+    googleMerchant: null,
+    shopify: null
   },
   platformData: {
     squarespaceData: {