@leaddreamer/inventorylogic 0.0.3-beta.48 → 0.0.3-beta.54

package/business/Product/GoogleMarchantMarkup.js

@@ -0,0 +1,252 @@
+/**
+ * Typedefs, constants, support functions and database operations related to Products
+ * @module GoogleProduct
+ */
+//////////////////////////////////////////////////////////////////////
+// Constants
+
+/**
+ * @typedef {string} SKU
+ */
+/**
+ * @typedef {string} Name
+ */
+
+/**
+ * @typedef {object} ImageObject
+ * @property {?text|MediaObject} caption
+ * @property {?text} embeddedTextCaption
+ * @property {?object} exifData
+ * @property {?Date|DateTime} dateCreated
+ * @property {?Date|DateTime} dateModified
+ * @property {?Date|DateTime} datePublished
+ * @property {?text|number} position The position of an item in a series or sequence of items.
+ * @property {?text} text The textual content of this CreativeWork.
+ * @property {ImageObject} thumbnail
+ * @property {text} alternateName An alias for the item.
+ * @property {text} description A description of the item.
+ * @property {URL|ImageObject} imageAn image of the item. This can be a URL or a fully described ImageObject.
+ * @property {Name} name	The name of the item.
+ * @property {URL} url
+ */
+
+/**
+ * @typedef {object} ReviewRating
+ * @property {text} type "Rating"
+ * @property {integer|text} bestRating The highest value allowed in this rating system.
+ * @property {integer|text} worstRating The lowest value allowed in this rating system.
+ * @property {Text|Number} ratingValue
+ * The rating for the content.
+ * Usage guidelines:
+ * Use values from 0123456789 (Unicode 'DIGIT ZERO' (U+0030) to 'DIGIT NINE' (U+0039)) rather than superficially similar Unicode symbols.
+ * Use '.' (Unicode 'FULL STOP' (U+002E)) rather than ',' to indicate a decimal point. Avoid using these symbols as a readability separator.
+ */
+
+/**
+ * @typedef {object} ReviewObject
+ * @property {text} type "Review"
+ * @property {?text} author
+ * @property {?text} name
+ * @property {?Date|DateTime} datePublished
+ * @property {text} reviewBody
+ * @property {?Array.ReviewRating} reviews
+ * @property {?ReviewRating} review
+ */
+
+/**
+ * @typedef {object} AggregateRatingsValue
+ * @property {text} type "AggregateRating"
+ * @property {?Thing} itemReviewed The item that is being reviewed/rated.
+ * @property {?integer} ratingCount The count of total number of ratings.
+ * @property {?integer} reviewCount The count of total number of reviews.
+ * @property {text} ratingExplanation
+ * 	A short explanation (e.g. one to two sentences) providing background context and other information that led to the conclusion expressed in the rating. This is particularly applicable to ratings associated with "fact check" markup using ClaimReview.
+ * @property {Text|Number} ratingValue
+ * The rating for the content.
+ * Usage guidelines:
+ * Use values from 0123456789 (Unicode 'DIGIT ZERO' (U+0030) to 'DIGIT NINE' (U+0039)) rather than superficially similar Unicode symbols.
+ * Use '.' (Unicode 'FULL STOP' (U+002E)) rather than ',' to indicate a decimal point. Avoid using these symbols as a readability separator.
+ * @property {integer|text} bestRating The highest value allowed in this rating system.
+ * @property {integer|text} worstRating The lowest value allowed in this rating system.
+ */
+
+/**
+ * a Brand Object
+ * @typedef {object} BrandObject
+ * @property {?AggregateRatingsValue} aggregateRating
+ * @property {?URL|ImageObject} logo
+ * @property {ReviewObject} review A review of the item. Supersedes reviews
+ * @property {text} slogan A slogan or motto associated with the item.
+ * @property {Name} name The name of the brand.
+ */
+
+/**
+ * @typedef {object} QuantitativeValue
+ * @property {Boolean | Number | text | StructuredValue} value
+ * The value of a QuantitativeValue (including Observation) or property value node.
+ * * For QuantitativeValue and MonetaryAmount, the recommended type for values is 'Number'.
+ * * For PropertyValue, it can be 'Text', 'Number', 'Boolean', or 'StructuredValue'.
+ * * Use values from 0123456789 (Unicode 'DIGIT ZERO' (U+0030) to 'DIGIT NINE' (U+0039)) rather than superficially similar Unicode symbols.
+ * * Use '.' (Unicode 'FULL STOP' (U+002E)) rather than ',' to indicate a decimal point. Avoid using these symbols as a readability separator.
+ * @property {number} maxValue The upper value of some characteristic or property.
+ * @property {number} minValue The lower value of some characteristic or property.
+ * @property {?Text} unitText A string or text indicating the unit of measurement. Useful if you cannot provide a standard unit code for unitCode
+ * @property {?Text | URL} unitCode 
+ * The unit of measurement given using the UN/CEFACT Common Code (3 characters) or a URL. Other codes than the UN/CEFACT Common Code may be used with a prefix followed by a colon
+ * 
+ */
+/**
+ * Size Grouping options
+ * @typedef {"Big"|"Boys"|"ExtraShort"|"ExtraTall"|"Girls"|"Husky"|"Infants"|"Juniors"|"Maternity"|"Mens"|"Misses"|"Petite"|"Plus"|"Regular"|"Short"|"Tall"|"Womens"} SizeGroupEnumeration
+ */
+
+/**
+ * Google Merchant API Size/Fit Options
+ * @typedef {"regular"|"petite"|"maternity"|"big"|"tall"|"plus"} SizeTypeEnumeration
+ */
+
+/**
+ * Google Merchant API Size System/Country Options
+ * @typedef {"US"|"UK"|"EU"|"DE"|"FR"|"JP"|"CN"|"IT"|"BR"|"MEX"|"AU"} SizeSystemEnumeration
+ */
+
+/**
+ * Google Merchant API Variant-identifying dimensions and their values
+ * @typedef {object} GoogleAPIVariantOption
+ * @property {Text} name
+ * @property {Text} value
+ */
+
+/**
+ * @typedef {object} SizeSpecification
+ * @property {Text} type "SizeSpecification"
+ * @property {QuantitativeValue} hasMeasurement
+ * @property {Array.SizeGroupEnumeration|SizeGroupEnumeration|Text} sizeGroup
+ * The size group (also known as "size type") for a product's size. Size groups are common in the fashion industry to define size
+ * segments and suggested audiences for wearable products. Multiple values can be combined, for example "men's big and tall", "petite maternity" or "regular".
+ * @property {Array.SizeSystemEnumeration|SizeSystemEnumeration|Text} sizeSystem
+ * The size system used to identify a product's size. Typically either a standard (for example, "GS1" or "ISO-EN13402"), country
+ * code (for example "US" or "JP"), or a measuring system (for example "Metric" or "Imperial").
+ * @property {QuantitativeValue} suggestedAge The age or age range for the intended audience or user, for example 3-12 months for infants, 1-5 years for toddlers.
+ * @property {GenderType|Text} suggestedGender The suggested gender of the intended user or audience, for example "male", "female", or "unisex".
+ * @property {QuantitativeValue} suggestedMeasurement A suggested range of body measurements for the intended audience or user, for example inseam between 32 and 34 inches or
+ * height between 170 and 190 cm. Typically found on a size chart for wearable products.
+ */
+
+/**
+ * Google Merchant API User-, merchant-, and manufacturer-authored questions and answers about the product.
+ * @typedef {object} QAObject
+ * @property {Text} question Max. 1000 characters.
+ * @property {Text} answer Max. 1000 characters.
+ */
+
+/**
+ * @typedef {"in_stock" | "out_of_stock" | "preorder" | "backorder"} availabilityEnum
+ */
+/**
+ * a Google Product record
+ * @typedef {object} GoogleProduct
+ * @property {SKU} id id of Product also used as sku
+ * @property {Name} title title (name) of Product
+ * @property {string} description Basic description of the product
+ * @property {URL} link Your product’s landing page
+ * @property {URL} image_link The URL of your product’s main image
+ * @property {?URL} additional_image_link The URL of your product’s main image
+ * @property {?URL} video_link Additional link to show a video of your product.
+ * @property {?URL} virtual_model_link Additional link to show a 3D model of your product.
+ * @property {?URL} mobile_link Your product’s mobile-optimized landing page when you have a different URL for mobile and desktop traffic
+ * @property {availabilityEnum} availability
+ * Accurately submit the product's availability and match the availability
+ * from your landing page, checkout pages, and structured data (for
+ * example, “in_stock” or “out_of_stock” in your Schema.org markup).
+ * If an item is out of stock, the price must still be clearly visible
+ * on the landing page.
+ * Provide the availability date [availability_date] attribute if you
+ * submit preorder [preorder] or backorder [backorder] as the availability value.
+ * @property {string|ISO8601} availability_date
+ * Use this attribute if your product's availability is set to preorder.
+ * Provide a value up to one year in the future.
+ * The availability date should also be added to the product’s landing
+ * 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
+ * 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
+ * submittingthe COGS for your products, you gain insights about
+ * 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 {?DateRange} sale_price_effective_date
+ * @property {?GoogleProductTaxonomy} google_product_category
+ * @property {?string} product_type
+ * @property {Text|BrandObject} 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 {Text} mpn
+ * The Manufacturer Part Number (MPN) of the product, or the product to which the offer refers.
+ * @property {"no"|"yes"} adult
+ * @property {Text} age_group newborn | infant | toddler | kids | adult
+ * @property {Text} gender male female unisex
+ * @property {Text} color The color of the product.
+ * @property {?"new"|"refurbished"|"used"} condition
+ * @property {Text} item_group_id ID for a group of products that come in different versions (variants)
+ * @property {Text} item_group_title name for a group of products that come in different versions (variants)
+ * @property {?Text} material A material that something is made from, e.g. leather, wool, cotton, paper.
+ * @property {?Text} pattern A pattern that something has
+ * @property {?Text}product_length Your product's length
+ * @property {?Text}product_width Your product's width
+ * @property {?Text}product_height Your product's height
+ * Use the same unit of measurement for each product dimension attribute
+ * (including product length, width, and height). Otherwise, the
+ * information won't be displayed.
+ * @property {?Text} product_highlight The most relevant highlights of your products
+ * @property {?Text} product_weight Your product's weight
+ * @property {?Array.QAObject} question_and_answer User-, merchant-, and
+ * manufacturer-authored questions and answers about the product.
+ * @property {Text | SizeSpecification | QuantitativeValue} size
+ * @property {SizeTypeEnumeration} size_type Your apparel product’s cut
+ * @property {SizeSystemEnumeration} size_system
+ * The country of the size system used by your produc
+ * @property {Array.GoogleAPIVariantOption} variant_option
+ * Variant-identifying dimensions and their values
+ * @property {?URL} ads_redirect
+ * A URL used to specify additional parameters for your product page.
+ * Customers will be sent to this URL rather than the value that you
+ * submit for the link [link] or mobile link [mobile_link] attributes
+ * @property {?Text} custom_label_0
+ * Label that you assign to a product to help organize bidding and
+ * reporting in Shopping campaigns
+ * @property {?Text} custom_label_1
+ * Label that you assign to a product to help organize bidding and
+ * reporting in Shopping campaigns
+ * @property {?Text} custom_label_2
+ * Label that you assign to a product to help organize bidding and
+ * reporting in Shopping campaigns
+ * @property {?Text} custom_label_3
+ * Label that you assign to a product to help organize bidding and
+ * reporting in Shopping campaigns
+ * @property {?Text} custom_label_4
+ * Label that you assign to a product to help organize bidding and
+ * reporting in Shopping campaigns
+ * @property {?Text} promotion_id An identifier that allows you to
+ * match products to promotions
+ * @property {URL} lifestyle_image_link
+ * Attribute used to include the URL for a lifestyle image for your product
+ * @property {Text} short_title Short product name. Only available for Demand Gen Ads, including
+ * YouTube, Gmail, Maps, Discover app, Google Display Network, and Google Video Partners.
+ * @property {?Text} shipping_label
+ * Label that you assign to a product to help assign correct
+ * shipping times and transit costs in Merchant Center account settings
+ * @property {?Text} shipping_weight The weight of the product used to
+ * calculate the shipping cost
+ * @property {?Text} shipping_length The length of the product used to
+ * calculate the shipping cost by dimensional weight
+ * @property {?Text} shipping_width The width of the product used to
+ * calculate the shipping cost by dimensional weight
+ * @property {?Text} shipping_height The height of the product used to
+ * calculate the shipping cost by dimensional weight
+ */

package/business/Product/GoogleMerchantAPI.js

@@ -0,0 +1,276 @@
+/**
+ * Typedefs, constants, support functions and database operations related to Products
+ * @module GoogleProduct
+ */
+//////////////////////////////////////////////////////////////////////
+// Constants
+
+import { index, string } from "mathjs";
+
+/**
+ * @typedef {string} SKU
+ */
+/**
+ * @typedef {string} Name
+ */
+
+/**
+ * Google Merchant API Size/Fit Options
+ * @typedef {"regular"|"petite"|"maternity"|"big"|"tall"|"plus"} SizeTypeEnumeration
+ */
+
+/**
+ * Google Merchant API Size System/Country Options
+ * @typedef {"US"|"UK"|"EU"|"DE"|"FR"|"JP"|"CN"|"IT"|"BR"|"MEX"|"AU"} SizeSystemEnumeration
+ */
+
+/**
+ * Google Merchant API Variant-identifying dimensions and their values
+ * @typedef {object} GoogleAPIVariantOption
+ * @property {Text} name
+ * @property {Text} value
+ */
+
+/**
+ * Google Merchant API User-, merchant-, and manufacturer-authored questions and answers about the product.
+ * @typedef {object} QAObject
+ * @property {Text} question Max. 1000 characters.
+ * @property {Text} answer Max. 1000 characters.
+ */
+
+/**
+ * a Google Product record
+ * @typedef {object} GoogleProductAPI
+ * @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)
+ * @property {Text} item_group_title name for a group of products that come in different versions (variants)
+ * @property {string} description Basic description of the product
+ * @property {URL} link Your product’s landing page
+ * @property {URL} image_link The URL of your product’s main image
+ * @property {?URL} additional_image_link The URL of your product’s main image
+ * @property {?URL} video_link Additional link to show a video of your product.
+ * @property {?URL} virtual_model_link Additional link to show a 3D model of your product.
+ * @property {?URL} mobile_link
+ * Your product’s mobile-optimized landing page when you have a different URL for mobile and desktop traffic
+ * @property {"in_stock"|"out_of_stock"|"preorder"|"backorder"} availability
+ * Accurately submit the product's availability and match the availability
+ * from your landing page, checkout pages, and structured data (for
+ * example, “in_stock” or “out_of_stock” in your Schema.org markup).
+ * If an item is out of stock, the price must still be clearly visible
+ * on the landing page.
+ * Provide the availability date [availability_date] attribute if you
+ * submit preorder [preorder] or backorder [backorder] as the availability value.
+ * @property {string|ISO8601} availability_date
+ * Use this attribute if your product's availability is set to preorder.
+ * Provide a value up to one year in the future.
+ * The availability date should also be added to the product’s landing
+ * 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
+ * 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
+ * submittingthe COGS for your products, you gain insights about
+ * 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 {?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 {Text} mpn
+ * The Manufacturer Part Number (MPN) of the product, or the product to which the offer refers.
+ * @property {"no"|"yes"} adult
+ * @property {Text} age_group newborn | infant | toddler | kids | adult
+ * @property {"male"|"female"|"unisex"} gender male female unisex
+ * @property {Text} color The color of the product.
+ * @property {?"new"|"refurbished"|"used"|null} condition
+ * @property {?Text} material A material that something is made from, e.g. leather, wool, cotton, paper.
+ * @property {?Text} pattern A pattern that something has
+ * @property {?Text}product_length Your product's length
+ * @property {?Text}product_width Your product's width
+ * @property {?Text}product_height Your product's height
+ * Use the same unit of measurement for each product dimension attribute
+ * (including product length, width, and height). Otherwise, the
+ * information won't be displayed.
+ * @property {?Text} product_highlight The most relevant highlights of your products
+ * @property {?Text} product_weight Your product's weight
+ * @property {?Array.QAObject} question_and_answer User-, merchant-, and
+ * manufacturer-authored questions and answers about the product.
+ * @property {Text} size
+ * @property {SizeTypeEnumeration} size_type Your apparel product’s cut
+ * @property {SizeSystemEnumeration} size_system
+ * The country of the size system used by your produc
+ * @property {Array.GoogleAPIVariantOption} variant_option
+ * Variant-identifying dimensions and their values
+ * @property {?URL} ads_redirect
+ * A URL used to specify additional parameters for your product page.
+ * Customers will be sent to this URL rather than the value that you
+ * submit for the link [link] or mobile link [mobile_link] attributes
+ * @property {?Text} custom_label_0
+ * Label that you assign to a product to help organize bidding and
+ * reporting in Shopping campaigns
+ * @property {?Text} custom_label_1
+ * Label that you assign to a product to help organize bidding and
+ * reporting in Shopping campaigns
+ * @property {?Text} custom_label_2
+ * Label that you assign to a product to help organize bidding and
+ * reporting in Shopping campaigns
+ * @property {?Text} custom_label_3
+ * Label that you assign to a product to help organize bidding and
+ * reporting in Shopping campaigns
+ * @property {?Text} custom_label_4
+ * Label that you assign to a product to help organize bidding and
+ * reporting in Shopping campaigns
+ * @property {?Text} promotion_id An identifier that allows you to
+ * match products to promotions
+ * @property {?URL} lifestyle_image_link
+ * Attribute used to include the URL for a lifestyle image for your product
+ * @property {?Text} short_title Short product name. Only available for Demand Gen Ads, including
+ * YouTube, Gmail, Maps, Discover app, Google Display Network, and Google Video Partners.
+ * @property {?Text} shipping_label
+ * Label that you assign to a product to help assign correct
+ * shipping times and transit costs in Merchant Center account settings
+ * @property {?Text} shipping_weight The weight of the product used to
+ * calculate the shipping cost
+ * @property {?Text} shipping_length The length of the product used to
+ * calculate the shipping cost by dimensional weight
+ * @property {?Text} shipping_width The width of the product used to
+ * calculate the shipping cost by dimensional weight
+ * @property {?Text} shipping_height The height of the product used to
+ * calculate the shipping cost by dimensional weight
+ */
+
+/**
+ * @type {GoogleProductAPI}
+ */
+export const GoogleAPIProductMap = {
+   //id needs programmatic processing
+   id: "variants[index].sku", //id of Product also used as sku
+   title: "name", //title (name) of Product
+   item_group_id: Text,
+   item_group_title: Text,
+   description: "description",
+   link: "URL",
+   //image_link and image_additional_links need programmatic process
+   image_link: "variants[index].image.URL",
+   additional_image_link: "images[all]",
+   video_link: null,
+   virtual_model_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.",
+   google_product_category: "google_product_category",
+   product_type: string | null,
+   brand: "brand.name",
+   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",
+   product_highlight: Text | null,
+   product_weight: "variants[index].productMeasurements.weight.value&' '&variants[index].productMeasurements.weight.unit",
+   question_and_answer: [
+      {
+         question: Text,
+         answer: Text,
+      },
+   ],
+   size: Text | null,
+   size_type: "regular" | "petite" | "maternity" | "big" | "tall" | "plus",
+   size_system: "US" | "UK" | "EU" | "DE" | "FR" | "JP" | "CN" | "IT" | "BR" | "MEX" | "AU",
+   variant_option: [{
+      name: Text,
+      value: Text,
+   },],
+   ads_redirect: URL | null,
+   custom_label_0: Text | null,
+   custom_label_1: Text | null,
+   custom_label_2: Text | null,
+   custom_label_3: Text | null,
+   custom_label_4: Text | null,
+   promotion_id: Text | null,
+   lifestyle_image_link: URL | null,
+   short_title: Text | null,
+   shipping_length: Text | null,
+   shipping_width: Text | null,
+   shipping_height: Text | null,
+   shipping_label: Text | null,
+}
+
+/**
+ * 
+ * @param {string} field 
+ * @param {Product} InventoryProduct 
+ */
+function GoogleProductAPIField(field, InventoryProduct) {
+
+}
+
+const GoogleProductCategory = {
+   "Animals & Pet Supplies": {
+      index: 1,
+      "Live Animals": {
+         index: 3237,
+      },
+      "Pet Supplies": {
+         index: 2,
+         "Bird Supplies": {
+            index: 3,
+            "Bird Cage Accessories": {
+               index: 7385,
+               "Bird Cage Bird Baths": {
+                  index: 499954,
+               },
+               "Bird Cage Food & Water Dishes": {
+                  index: 7386
+               },
+            },
+            "Bird Cages & Stands": {
+               index: 4989,
+            },
+            "Bird Food": {
+               index: 4990,
+            },
+            "Bird Gyms & Playstands": {
+               index: 7398,
+            },
+            "Bird Ladders & Perches": {
+               index: 4991,
+            },
+            "Bird Toys": {
+               index: 4992,
+            },
+            "Bird Treats": {
+               index: 4993,
+            },
+         },
+         "Cat Supplies": {
+            index: 4,
+            "": {
+
+            }
+         }
+
+      }
+   }
+};