@leaddreamer/inventorylogic 0.0.3-beta.1 → 0.0.3-beta.11

package/README.md

@@ -1152,6 +1152,20 @@ Typedefs, constants, support functions and database operations related to Produc
         * [~ProductDefaultForm](#module_Product..ProductDefaultForm) : <code>Product</code>
         * [~updateProduct(product, user)](#module_Product..updateProduct) ⇒ <code>promise.LineItem</code>
         * [~summarizeProduct(product)](#module_Product..summarizeProduct) ⇒ <code>string</code>
+        * [~Recipe_Data](#module_Product..Recipe_Data) : <code>object</code>
+        * [~AttributeList](#module_Product..AttributeList) : <code>Array.String</code>
+        * [~AttributeValue](#module_Product..AttributeValue) : <code>object</code>
+        * [~ProductImage](#module_Product..ProductImage) : <code>object</code>
+        * [~CurrencyDescription](#module_Product..CurrencyDescription) : <code>object</code>
+        * [~MonetaryValue](#module_Product..MonetaryValue) : <code>object</code>
+        * [~FullProductPricing](#module_Product..FullProductPricing) : <code>object</code>
+        * [~ProductDimensions](#module_Product..ProductDimensions) : <code>object</code>
+        * [~PriceObject](#module_Product..PriceObject) : <code>object</code>
+        * [~ProductWeight](#module_Product..ProductWeight) : <code>object</code>
+        * [~ProductMeasurements](#module_Product..ProductMeasurements) : <code>object</code>
+        * [~ProductStock](#module_Product..ProductStock) : <code>object</code>
+        * [~PhysicalProductVariant](#module_Product..PhysicalProductVariant) : <code>object</code>
+        * [~MetaData](#module_Product..MetaData) : <code>object</code>
         * [~Product](#module_Product..Product) : <code>object</code>
 
 <a name="module_Product.createProduct"></a>
@@ -1178,7 +1192,7 @@ Creates a new Blank Product
 
 ### Product~ProductDefault : <code>Product</code>
 **Kind**: inner constant of [<code>Product</code>](#module_Product)  
-**Default**: <code>{&quot;Id&quot;:null,&quot;refPath&quot;:null,&quot;name&quot;:&quot;&quot;,&quot;description&quot;:null,&quot;sku&quot;:null,&quot;markups&quot;:null,&quot;projectQ&quot;:false,&quot;created&quot;:null,&quot;modified&quot;:null}</code>  
+**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;&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>  
 **Read only**: true  
 <a name="module_Product..ProductDataForm"></a>
 
@@ -1217,26 +1231,222 @@ Returns a standardized formatted name string
 | --- | --- |
 | product | <code>Unit</code> | 
 
-<a name="module_Product..Product"></a>
+<a name="module_Product..Recipe_Data"></a>
 
-### Product~Product : <code>object</code>
-a record
+### Product~Recipe\_Data : <code>object</code>
+"recipe" related values - build-stage markups, product/project Flag, created/modified dates
 
 **Kind**: inner typedef of [<code>Product</code>](#module_Product)  
 **Properties**
 
 | Name | Type | Description |
 | --- | --- | --- |
-| Id | <code>string</code> | Id of document (redundant for convenience) |
-| refPath | <code>string</code> | if from database, full path to document |
-| name | <code>string</code> | name for the Product |
-| description | <code>string</code> |  |
-| sku | <code>string</code> |  |
 | markups | <code>module:Markups~Stage</code> |  |
 | projectQ | <code>boolean</code> | flag for product/project |
 | created | <code>dateTime</code> |  |
 | modified | <code>dateTime</code> |  |
 
+<a name="module_Product..AttributeList"></a>
+
+### Product~AttributeList : <code>Array.String</code>
+A list of attributes for a product
+
+**Kind**: inner typedef of [<code>Product</code>](#module_Product)  
+<a name="module_Product..AttributeValue"></a>
+
+### Product~AttributeValue : <code>object</code>
+Array of attribute name/value pairs
+
+**Kind**: inner typedef of [<code>Product</code>](#module_Product)  
+**Properties**
+
+| Name | Type | Description |
+| --- | --- | --- |
+| attibuteName | <code>string</code> | attribute name from attribute list |
+| value | <code>string</code> | value for the particular attribute |
+
+<a name="module_Product..ProductImage"></a>
+
+### Product~ProductImage : <code>object</code>
+Image Descriptor
+
+**Kind**: inner typedef of [<code>Product</code>](#module_Product)  
+**Properties**
+
+| Name | Type | Description |
+| --- | --- | --- |
+| altText | <code>string</code> | alt text for the image - SEO etc |
+| availableFormats | <code>Array.string</code> | Available image sizes. |
+| id | <code>string</code> | unique id for this productImage |
+| orderIndex | <code>integer</code> | Position of the image in the product's image list. |
+| originalSize | <code>object</code> | Image size when first uploaded. |
+| seoOptions | <code>MetaData</code> |  |
+| URL | <code>string</code> | Absolute URL of the hosted image. |
+
+<a name="module_Product..CurrencyDescription"></a>
+
+### Product~CurrencyDescription : <code>object</code>
+Currency Description ISO 4217 currency code
+
+**Kind**: inner typedef of [<code>Product</code>](#module_Product)  
+**Properties**
+
+| Name | Type |
+| --- | --- |
+| currencyCode | <code>string</code> | 
+| defaultFractionDigits | <code>integer</code> | 
+| displayName | <code>string</code> | 
+| numericCodeAsString | <code>string</code> | 
+| symbol | <code>string</code> | 
+
+<a name="module_Product..MonetaryValue"></a>
+
+### Product~MonetaryValue : <code>object</code>
+Monetary Value Specification
+
+**Kind**: inner typedef of [<code>Product</code>](#module_Product)  
+**Properties**
+
+| Name | Type | Description |
+| --- | --- | --- |
+|  | <code>CurrencyDescription</code> |  |
+| value | <code>decimal</code> | Decimal monetary value |
+
+<a name="module_Product..FullProductPricing"></a>
+
+### Product~FullProductPricing : <code>object</code>
+Pricing Object
+
+**Kind**: inner typedef of [<code>Product</code>](#module_Product)  
+**Properties**
+
+| Name | Type |
+| --- | --- |
+| basePrice | <code>MonetaryValue</code> | 
+| onSale | <code>boolean</code> | 
+| salePrice | <code>MonetaryValue</code> | 
+
+<a name="module_Product..ProductDimensions"></a>
+
+### Product~ProductDimensions : <code>object</code>
+Dimensions Object
+
+**Kind**: inner typedef of [<code>Product</code>](#module_Product)  
+**Properties**
+
+| Name | Type | Description |
+| --- | --- | --- |
+| height | <code>float</code> |  |
+| width | <code>float</code> |  |
+| length | <code>float</code> |  |
+| unit | <code>text</code> | //​ProductDimensionsUnit |
+
+<a name="module_Product..PriceObject"></a>
+
+### Product~PriceObject : <code>object</code>
+Price Object
+
+**Kind**: inner typedef of [<code>Product</code>](#module_Product)  
+<a name="module_Product..ProductWeight"></a>
+
+### Product~ProductWeight : <code>object</code>
+Weight Object
+
+**Kind**: inner typedef of [<code>Product</code>](#module_Product)  
+**Properties**
+
+| Name | Type | Description |
+| --- | --- | --- |
+| unit | <code>text</code> | //​ProductWeightUnitEnum |
+| value | <code>float</code> |  |
+
+<a name="module_Product..ProductMeasurements"></a>
+
+### Product~ProductMeasurements : <code>object</code>
+Measurements of the variant when it's shipped. Present for PHYSICAL products only.
+
+**Kind**: inner typedef of [<code>Product</code>](#module_Product)  
+**Properties**
+
+| Name | Type |
+| --- | --- |
+| dimensions | <code>ProductDimensions</code> | 
+| weight | <code>ProductWeight</code> | 
+
+<a name="module_Product..ProductStock"></a>
+
+### Product~ProductStock : <code>object</code>
+Available stock for the variant. Present for PHYSICAL products only.
+
+**Kind**: inner typedef of [<code>Product</code>](#module_Product)  
+**Properties**
+
+| Name | Type |
+| --- | --- |
+| quantity | <code>integer</code> | 
+| unlimited | <code>boolean</code> | 
+
+<a name="module_Product..PhysicalProductVariant"></a>
+
+### Product~PhysicalProductVariant : <code>object</code>
+variant record (including inventory and pricing)
+
+**Kind**: inner typedef of [<code>Product</code>](#module_Product)  
+**Properties**
+
+| Name | Type | Description |
+| --- | --- | --- |
+| attributes | <code>Array.AttributeValue</code> | array of attribute/value pairs for a variant |
+| sku | <code>string</code> |  |
+| mpn | <code>string</code> | manufacturer part number |
+| gtin | <code>string</code> | Global Trade Item Number |
+| id | <code>string</code> | unique ID for product variant |
+| image | <code>ProductImage</code> | Image associated with this variant |
+| shippingMeasurements | <code>ProductMeasurements</code> |  |
+| stock | <code>ProductStock</code> |  |
+
+<a name="module_Product..MetaData"></a>
+
+### Product~MetaData : <code>object</code>
+Meta Information for SEO
+
+**Kind**: inner typedef of [<code>Product</code>](#module_Product)  
+**Properties**
+
+| Name | Type |
+| --- | --- |
+| title | <code>string</code> | 
+| description | <code>string</code> | 
+
+<a name="module_Product..Product"></a>
+
+### Product~Product : <code>object</code>
+a product record
+
+**Kind**: inner typedef of [<code>Product</code>](#module_Product)  
+**Properties**
+
+| 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 |
+| name | <code>string</code> | name for the Product |
+| description | <code>string</code> | Basic description of the product |
+| recipe | <code>Recipe\_Data</code> | pricing and fabrication data |
+| image_links | <code>Array:ImageLinks</code> |  |
+| type | <code>text</code> | //​ProductTypeV2Enum |
+| isVisible | <code>boolean</code> |  |
+| seoOptions | <code>MetaData</code> |  |
+| name | <code>string</code> | name for the Product |
+| seoOptions | <code>MetaData</code> |  |
+| tags | <code>Array.string</code> |  |
+| materials | <code>Array.string</code> |  |
+| patterns | <code>Array.string</code> |  |
+| URL | <code>string</code> |  |
+| urlSlug | <code>string</code> |  |
+| variantAttributes | <code>Array.string</code> |  |
+| variants | <code>Array.PhysicalProductVariant</code> |  |
+
 <a name="module_User"></a>
 
 ## User

package/business/Commodities/index.js

@@ -14,7 +14,7 @@ import {
 } from "@leaddreamer/firebase-wrapper";
 import { Forms, fillForm } from "@leaddreamer/staticforms";
 
-import { UNITS, MATERIAL, COMMODITIES, COMMODITY, COMPONENT_RANGE } from "../boilerplate";
+import { UNITS, MATERIAL, COMMODITIES, COMMODITY, COMPONENT_RANGE } from "../boilerplate/index.js";
 
 //////////////////////////////////////////////////////////////////////
 // Constants

package/business/LineItem/index.js

@@ -21,8 +21,8 @@ import {
   UNITS,
   COMPONENT_RANGE,
   COMPONENT_COUNT_RANGE,
-} from "../boilerplate";
-import {StageLevels, MaterialLevels} from "../Markups";
+} from "../boilerplate/index.js";
+import {StageLevels, MaterialLevels} from "../Markups/index.js";
 
 //////////////////////////////////////////////////////////////////////
 // Constants

package/business/Markups/index.js

@@ -6,7 +6,7 @@
 import { updateRecord } from "@leaddreamer/firebase-wrapper";
 import { Forms, fillForm } from "@leaddreamer/staticforms";
 
-import { MARKUPS, STAGE, FABRICATION, WHOLESALE, RETAIL, BASE, HIGHVALUE, SERVICE, MATERIAL } from "../boilerplate";
+import { MARKUPS, STAGE, FABRICATION, WHOLESALE, RETAIL, BASE, HIGHVALUE, SERVICE, MATERIAL } from "../boilerplate/index.js";
 
 //////////////////////////////////////////////////////////////////////
 // Constants

package/business/Payment/index.js

@@ -17,7 +17,7 @@ import {
 } from "@leaddreamer/firebase-wrapper";
 
 import { Forms, cleanType } from "@leaddreamer/staticforms";
-import { PAYMENT, RECEIPTS, CARDS } from "../boilerplate";
+import { PAYMENT, RECEIPTS, CARDS } from "../boilerplate/index.js";
 
 //////////////////////////////////////////////////////////////////////
 // definitions

package/business/Product/index.js

@@ -5,23 +5,148 @@
 import { updateRecord} from "@leaddreamer/firebase-wrapper";
 import { Forms, fillForm } from "@leaddreamer/staticforms";
 
-import { PRODUCT, MARKUPS, ISBN_LENGTH } from "../boilerplate";
-import { typedRecordFromChild } from "../Utilities"
+import { PRODUCT, MARKUPS, ISBN_LENGTH } from "../boilerplate/index.js";
+import { typedRecordFromChild } from "../Utilities/index.js"
 
 //////////////////////////////////////////////////////////////////////
 // Constants
+
+/**
+ * "recipe" related values - build-stage markups, product/project Flag, created/modified dates
+ * @typedef {object} Recipe_Data
+ * @property  {module:Markups~Stage} markups
+ * @property  {boolean} projectQ flag for product/project
+ * @property  {dateTime} created
+ * @property  {dateTime} modified
+ */
+
+/**
+ * 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 {MetaData} seoOptions
+ * @property {string} URL Absolute URL of the hosted image.
+ */
+
+/**
+ * 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
+ */
+
+/**
+ * Dimensions Object
+ * @typedef {object} ProductDimensions
+ * @property {float} height 
+ * @property {float} width 
+ * @property {float} length 
+ * @property {text} unit //​ProductDimensionsUnit
+ */
+
 /**
- * a record
+ * Price Object
+ * @typedef {object} PriceObject
+ * 
+ */
+
+/**
+ * Weight Object
+ * @typedef {object} ProductWeight
+ * @property {text} unit //​ProductWeightUnitEnum
+ * @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} sku
+ * @property {string} mpn manufacturer part number
+ * @property {string} gtin Global Trade Item Number
+ * @property {string} id unique ID for product variant
+ * @property {ProductImage} image Image associated with this variant
+ * @property {ProductMeasurements} shippingMeasurements
+ * @property {ProductStock} stock
+ */
+
+/**
+ * Meta Information for SEO
+ * @typedef {object} MetaData
+ * @property {string} title
+ * @property {string} description
+ */
+
+/**
+ * a product record
  * @typedef {object} Product
- * @property {?string} Id Id of document (redundant for convenience)
+ * @property {?string} Id Database Id of document (redundant for convenience)
  * @property {?string} refPath if from database, full path to document
  * @property {string} name name for the Product
- * @property {string} description
- * @property {string} sku
- * @property {module:Markups~Stage} markups
- * @property {boolean} projectQ flag for product/project
- * @property {dateTime} created
- * @property {dateTime} modified
+ * @property {string} description Basic description of the product
+ * @property {Recipe_Data} recipe pricing and fabrication data
+ * @property {Array:ImageLinks} image_links
+ * @property {text} type //​ProductTypeV2Enum
+ * @property {boolean} isVisible
+ * @property {MetaData} seoOptions
+ * @property {string} name name for the Product
+ * @property {MetaData} seoOptions
+ * @property {Array.string} tags
+ * @property {Array.string} materials
+ * @property {Array.string} patterns
+ * @property {string} URL
+ * @property {string} urlSlug
+ * @property {Array.string} variantAttributes
+ * @property {Array.PhysicalProductVariant} variants
  */
 
 /**
@@ -31,15 +156,33 @@ import { typedRecordFromChild } from "../Utilities"
  * @default
  */
 const ProductDefault = {
-  Id: null,
-  refPath: null,
   name: `A Product`,
   description: null,
-  sku: null,
-  markups: null,
-  projectQ: false,
-  created: null,
-  modified: null,
+  recipe: {
+    markups: null,
+    projectQ: false,
+    created: null,
+    modified: null,
+  },
+  image_links: [],
+  type: "",
+  google_product_type: "",
+  shipping_time: 0,
+  condition: "",
+  adultQ: false,
+  age_group: "adult",
+  color: [""],
+  material: [""],
+  gender: "unisex",
+  attributes_gemstones: [""],
+  pattern: "",
+  size: "",
+  weight: 0,
+  shippingMeasurements: {
+  shipping_length: 0,
+  shippin_width: 0,
+  shipping_height: 0
+  }
 };
 
 /**

package/business/User/index.js

@@ -17,8 +17,8 @@ import {
 } from "@leaddreamer/firebase-wrapper";
 import { Forms } from "@leaddreamer/staticforms";
 
-import { USER, USERS } from "../boilerplate";
-import { typedRecordFromChild } from "../Utilities"
+import { USER, USERS } from "../boilerplate/index.js";
+import { typedRecordFromChild } from "../Utilities/index.js"
 
 //////////////////////////////////////////////////////////////////////
 // Constants

package/business/Utilities/index.js

@@ -13,7 +13,7 @@ import {
   writeRecord,
 } from "@leaddreamer/firebase-wrapper";
 import { Forms } from "@leaddreamer/staticforms";
-import { ADDRESSES } from "../boilerplate";
+import { ADDRESSES } from "../boilerplate/index.js";
 
 //////////////////////////////////////////////////////////////////////
 

package/business/index.js

@@ -3,12 +3,12 @@
  * frontEnd and NodeJS BackEnd
  * @module InventoryLogic
  */
-export * from "./boilerplate";
-export * from "./Commodities";
-export * from "./LineItem";
-export * from "./Payment";
-export * from "./User";
-export * from "./Product";
-export * from "./Markups";
-export * from "./units";
-export * from "./Utilities";
+export * from "./boilerplate/index.js/index.js";
+export * from "./Commodities/index.js";
+export * from "./LineItem/index.js/index.js";
+export * from "./Payment/index.js/index.js";
+export * from "./User/index.js/index.js";
+export * from "./Product/index.js/index.js";
+export * from "./Markups/index.js";
+export * from "./units/index.js";
+export * from "./Utilities/index.js";

package/business/units/index.js

@@ -6,7 +6,7 @@
 import { writeRecord, writeBack } from "@leaddreamer/firebase-wrapper";
 import { Forms } from "@leaddreamer/staticforms";
 
-import { UNITS } from "../boilerplate";
+import { UNITS } from "../boilerplate/index.js";
 
 //////////////////////////////////////////////////////////////////////
 // Constants

package/index.js

@@ -54,7 +54,7 @@ export function databaseStart(firebase, config, thisLogger = null) {
   return FirebaseWrapper(firebase, config, thisLogger);
 }
 
-export * from "./business";
+export * from "./business/index.js";
 export * from "@leaddreamer/firebase-wrapper";
 export * from "@leaddreamer/genericutilities";
 export * from "@leaddreamer/staticforms";

package/package.json

@@ -3,7 +3,7 @@
   "engines": {
     "node": ">=22"
   },
-  "version": "0.0.3-beta.1",
+  "version": "0.0.3-beta.11",
   "description": "Business & Database Logic for Inventory Services",
   "repository": {
     "type": "git",
@@ -29,14 +29,14 @@
   "module": "index.js",
   "scripts": {
     "reinstall": "rm -rf node_modules && npm install",
-    "mybuild": "parcel build",
-    "rebuild": "$npm_execpath version patch --git-tag-version && $npm_execpath run docs",
-    "beta:rebuild": "$npm_execpath version prerelease --git-tag-version --preid=beta && $npm_execpath run docs",
+    "mybuild": "parcel build --dist-dir './dist'",
     "release:rebuild": "$npm_execpath version minor --git-tag-version && $npm_execpath run docs",
     "myprepublishOnly": "$npm_execpath run build",
     "make_docs": "jsdoc2md -c jsdoc.conf.json --template README.hbs --files *.js ./business/*.js ./business/*/*.js > README.md",
     "docs": "$npm_execpath run make_docs",
+    "beta:rebuild": "$npm_execpath version prerelease --git-tag-version --preid=beta && $npm_execpath run docs",
     "beta:publish": "$npm_execpath publish --tag=beta --access=restricted",
+    "package:rebuild": "$npm_execpath version patch --git-tag-version && $npm_execpath run docs",
     "package:publish": "$npm_execpath publish --access=restricted",
     "dry:publish": "$npm_execpath publish --dry-run"
   },