@leaddreamer/inventorylogic 0.0.3-beta.38 → 0.0.3-beta.4

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/index.js";
+import { UNITS, MATERIAL, COMMODITIES, COMMODITY, COMPONENT_RANGE } from "../boilerplate";
 
 //////////////////////////////////////////////////////////////////////
 // Constants

package/business/LineItem/index.js

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

package/business/Markups/index.js

@@ -3,10 +3,10 @@
  * users
  * @module Markups
  */
-import { updateRecord } from "@leaddreamer/firebase-wrapper"; 
+import { updateRecord } from "@leaddreamer/firebase-wrapper";
 import { Forms, fillForm } from "@leaddreamer/staticforms";
 
-import { MARKUPS, STAGE, FABRICATION, WHOLESALE, RETAIL, BASE, HIGHVALUE, SERVICE, MATERIAL } from "../boilerplate/index.js";
+import { MARKUPS, STAGE, FABRICATION, WHOLESALE, RETAIL, BASE, HIGHVALUE, SERVICE, MATERIAL } from "../boilerplate";
 
 //////////////////////////////////////////////////////////////////////
 // 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/index.js";
+import { PAYMENT, RECEIPTS, CARDS } from "../boilerplate";
 
 //////////////////////////////////////////////////////////////////////
 // definitions

package/business/Product/index.js

@@ -5,148 +5,23 @@
 import { updateRecord} from "@leaddreamer/firebase-wrapper";
 import { Forms, fillForm } from "@leaddreamer/staticforms";
 
-import { PRODUCT, MARKUPS, ISBN_LENGTH } from "../boilerplate/index.js";
-import { typedRecordFromChild } from "../Utilities/index.js"
+import { PRODUCT, MARKUPS, ISBN_LENGTH } from "../boilerplate";
+import { typedRecordFromChild } from "../Utilities"
 
 //////////////////////////////////////////////////////////////////////
 // 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
- */
-
 /**
- * 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
+ * a record
  * @typedef {object} Product
- * @property {?string} Id Database Id of document (redundant for convenience)
+ * @property {?string} Id 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 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
+ * @property {string} description
+ * @property {string} sku
+ * @property {module:Markups~Stage} markups
+ * @property {boolean} projectQ flag for product/project
+ * @property {dateTime} created
+ * @property {dateTime} modified
  */
 
 /**
@@ -156,33 +31,15 @@ import { typedRecordFromChild } from "../Utilities/index.js"
  * @default
  */
 const ProductDefault = {
+  Id: null,
+  refPath: null,
   name: `A Product`,
   description: 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
-  }
+  sku: null,
+  markups: null,
+  projectQ: false,
+  created: null,
+  modified: null,
 };
 
 /**

package/business/User/index.js

@@ -17,8 +17,8 @@ import {
 } from "@leaddreamer/firebase-wrapper";
 import { Forms } from "@leaddreamer/staticforms";
 
-import { USER, USERS } from "../boilerplate/index.js";
-import { typedRecordFromChild } from "../Utilities/index.js"
+import { USER, USERS } from "../boilerplate";
+import { typedRecordFromChild } from "../Utilities"
 
 //////////////////////////////////////////////////////////////////////
 // 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/index.js";
+import { ADDRESSES } from "../boilerplate";
 
 //////////////////////////////////////////////////////////////////////
 

package/business/boilerplate/index.js

@@ -7,14 +7,6 @@
 // generic constants
 export const UNSUBSCRIBEKEYS = `unsubscribeKeys`;
 export const ADDRESSES = "Addresses";
-export const BUSINESS = `Business`; //mostly used for URL of management tree
-export const BRANDS = `Brands`;
-export const MANAGEDBRANDS = `ManagedBrands`;
-export const ORGANIZATIONS = `Organizations`;
-export const MANAGEDORGANIZATIONS = `ManagedOrganizations`;
-export const PRIVATEDATA = `PrivateData`;
-export const BUSINESSDATA = `BusinessData`;
-export const LOGISTICS = `logistics`;
 export const COMMODITY = `Commodity`;
 export const COMMODITIES = COMMODITY;
 export const LINEITEM = `LineItem`;
@@ -22,22 +14,14 @@ export const LINEITEMS = LINEITEM;
 export const LABORRATES = `LaborRates`;
 export const PRODUCT = `Products`;
 export const PRODUCTS = PRODUCT;
-export const PAYMENT = `Payment`;
-export const PAYMENTS = PAYMENT;
-export const CARDS = `Cards`;
-export const TRANSFERS = `Transfers`;
-export const FUNDAMENTALS = `Fundamentals`;
-export const PAYOUTRATES = `PayoutRates`;
-export const RATES = `Rates`;
-export const MCC = `MCC`;
-export const BUSINESS_TYPE = `business_type`;
-export const ACCESS = `access`;
-export const ACCESSTO = `accessTo`;
 export const STAGE = `stages`;
 export const STAGES = STAGE;
 export const MATERIAL = `material`;
 export const MATERIALS = MATERIAL;
+export const PAYMENT = `Payment`;
+export const PAYMENTS = PAYMENT;
 export const RECEIPTS = `Receipts`;
+export const CARDS = `Cards`;
 export const UNITS = "units";
 export const UNIT = UNITS;
 export const USER = "User";
@@ -53,13 +37,6 @@ export const FABRICATION = `fabrication`;
 export const WHOLESALE = `wholesale`;
 export const RETAIL = `retail`;
 
-//Payment System Constants
-export const PAYMENT_SUCCEEDED = `succeeded`;
-
-//Stripe
-export const CUSTOMER = `customer`;
-export const CUSTOMERADDRESS = `customerAddress`;
-
 export const fakerJSON = {
   COMPONENT_RANGE: {
     min: 0.01,

package/business/index.js

@@ -3,15 +3,12 @@
  * frontEnd and NodeJS BackEnd
  * @module InventoryLogic
  */
-export * from "./boilerplate/index.js";
-export * from "./Addresses/index.js";
-export * from "./BusinessData/index.js";
-export * from "./Commodities/index.js";
-export * from "./Fundamentals/index.js";
-export * from "./LineItem/index.js";
-export * from "./Markups/index.js";
-export * from "./Payment/index.js";
-export * from "./PrivateData/index.js";
-export * from "./Product/index.js";
-export * from "./User/index.js";
-export * from "./Utilities/index.js";
+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";

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/index.js";
+import { UNITS } from "../boilerplate";
 
 //////////////////////////////////////////////////////////////////////
 // Constants

package/index.js

@@ -54,7 +54,7 @@ export function databaseStart(firebase, config, thisLogger = null) {
   return FirebaseWrapper(firebase, config, thisLogger);
 }
 
-export * from "./business/index.js";
+export * from "./business";
 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.38",
+  "version": "0.0.3-beta.4",
   "description": "Business & Database Logic for Inventory Services",
   "repository": {
     "type": "git",
@@ -26,33 +26,17 @@
     "*.md",
     "/*/*.md"
   ],
-  "source": "index.js",
-  "exports": {
-    ".": {
-      "node": {
-        "import": "./index.js",
-        "require": "./dist/index.js"
-      },
-      "default": "./index.js"
-    },
-    "./inventorylogic": {
-      "node": {
-        "import": "./index.js",
-        "require": "./dist/index.js"
-      },
-      "default": "./index.js"
-    }
-  },
+  "module": "index.js",
   "scripts": {
     "reinstall": "rm -rf node_modules && npm install",
-    "mybuild": "parcel build --dist-dir './dist'",
-    "release:rebuild": "$npm_execpath version minor --git-tag-version && $npm_execpath run docs && $npm_execpath run mybuild",
+    "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",
+    "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 && $npm_execpath run mybuild",
     "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"
   },
@@ -61,8 +45,8 @@
   },
   "dependencies": {
     "@leaddreamer/firebase-wrapper": "^2.1.2-beta.0",
-    "@leaddreamer/genericutilities": "^0.2.7",
-    "@leaddreamer/staticforms": "^1.1.0",
+    "@leaddreamer/genericutilities": "^0.1.6",
+    "@leaddreamer/staticforms": "^1.0.2-beta.0",
     "lodash.clonedeep": "4.5.0",
     "mathjs": "15.2.0",
     "uuid": "14.0.1"
@@ -80,7 +64,6 @@
     }
   },
   "devDependencies": {
-    "@parcel/bundler-library": "^2.16.4",
     "accounting-js": "2.0.3",
     "jsdoc-to-markdown": "9.1.3",
     "parcel": "latest"

package/business/Addresses/index.js

@@ -1,181 +0,0 @@
-/**
- * Types and functins for handling addresses
- * @module Addresses
- *
- */
-
-import {
-  writeRecord,
-  writeBack,
-  deleteRecord,
-  deleteRecordByRefPath,
-  collectRecords,
-} from "@leaddreamer/firebase-wrapper";
-import { Forms } from "@leaddreamer/staticforms";
-import { ADDRESSES } from "../boilerplate";
-import { businessDataPath } from "../BusinessData";
-
-//////////////////////////////////////////////////////////////////////
-//Constants
-/**
- * @typedef {object} AddressType
- * @property {?string} Id - will be populated for existing record; null or
- * missing for new/minimal object
- * @property {?string} refPath - will be populated for existing record; null or
- * missing for new/minimal object
- * @property {string} address_line_1
- * @property {?string} address_line_2
- * @property {string} city
- * @property {string} region - selected from a list of supported Cities/Regions
- * @property {string} state
- * @property {zip} zip
- * @property {?maplink} mapLink - link to Google map location
- */
-/**
- * @constant
- * @type {AddressType}
- * @default
- */
-export const AddressDefault = {
-  name: null,
-  tel: null,
-  address_line_1: null,
-  address_line_2: null,
-  city: null,
-  region: null,
-  state: null,
-  zip: null,
-  maplink: null,
-};
-
-/**
- * @constant
- * @type {AddressType}
- * @default
- */
-export const AddressForm = {
-  name: "text::6",
-  tel: "tel::6",
-  address_line_1: "text::6",
-  address_line_2: "text::6",
-  city: "text::6",
-  //  region: "lookup:Regions:4",
-  state: "text::3",
-  zip: "number::3",
-};
-
-export const AddressSelectForm = {
-  address: `lookupLink:${ADDRESSES}`,
-};
-
-/**
- * @typedef {object} MapLink
- * @property {?string} placeId - as defined by Google
- * @property {?object} latlng - coordinates tuple
- * @property {string} latlng.lat - lattitude
- * @property {string} latlng.lng - longitude
- * @property {?string} url - link to place/map entry
- * @property {?string} formatted_address - printable string of address
- */
-/**
- * @readonly
- * @constant
- * @type {MapLink}
- * @default
- */
-export const maplink = {
-  placeID: null,
-  latlng: {
-    lat: null,
-    lng: null,
-  },
-  url: null,
-  formatted_address: null,
-};
-
-Forms.Base[ADDRESSES] = AddressDefault;
-Forms.BaseForm[ADDRESSES] = AddressForm;
-Forms.AccountForm[ADDRESSES] = AddressForm;
-
-/**
- * @external WriteBatch
- * @external Transaction
- * @typedef {WriteBatch|Transaction|void} ChainType
- */
-
-//////////////////////////////////////////////////////////////////////
-//Business Logic
-
-/**
- * Deletes an existing address record from the database, based on it's own refPath
- * @param {AddressType} address
- * @param {!string} address.refPath
- * @returns {Promise<void>}
- */
-export async function deleteAddress(address) {
-  //check for real reacord (i.e. refPath)
-  if (!address?.refPath) return null;
-  return deleteRecordByRefPath(address.refPath);
-}
-
-/**
- * Deletes an existing address record from the database, based on it's parent
- * record and Id
- * @param {!string} addressId
- * @param {OrganizationType} parent
- * @param {!string} parent.refPath
- * @param {ChainType} batch
- * @returns {Promise.ChainType}
- */
-export async function deleteAddressByIdAndParent(
-  addressId,
-  parent,
-  batch = null
-) {
-  //check for real reacord (i.e. refPath)
-  return deleteRecord(ADDRESSES, addressId, parent?.refPath, batch);
-}
-
-//////////////////////////////////////////////////////////////////////
-//helpers
-
-/**
- * Builds a formatted string from a provided address record
- * @param {AddressType} address
- * @returns {string}
- */
-export function formatAddress(address) {
-  let formattedString = address
-    ? (address.address_line_1 ? address.address_line_1 + ", " : "") +
-      (address.address_line_2 ? address.address_line_2 + ", " : "") +
-      (address.city ? address.city + ", " : "") +
-      (address.state ? address.state + "  " : "") +
-      (address.zip ? address.zip : "") +
-      (address.region ? " ( " + address.region + " )" : "")
-    : null;
-  return formattedString;
-}
-
-/**
- * Saves an address record to the database below the provided parentRefPath,
- * whether exsiting or not
- * @param {AddressType} address
- * @param {?string} address.refPath - if present, writes back
- * @param {string} paraentRefPath - required if new record
- * @returns {Promise<AddressType>}
- */
-export async function saveAddress(address, parentRefPath) {
-  return address?.refPath
-    ? writeBack(address)
-    : writeRecord(ADDRESSES, address, parentRefPath);
-}
-
-/**
- * Fetches all address records for an account
- * @param {Record} account
- * @param {!string} account.refPath
- * @returns {Promise<Array.AddressType>}
- */
-export async function fetchAddresses(account) {
-  return collectRecords(ADDRESSES, businessDataPath(account));
-}