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

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/PrivateData/index.js

@@ -0,0 +1,176 @@
+/**
+ * Functions for managing (potentially)private data for a user or organization.
+ * Unified structure as a sub-record of fan, organization, or CityManager accounts
+ * @module PrivateData
+ */
+import {
+  fetchRecord,
+  typedWrite,
+  writeBack,
+  deleteRecordByRefPath,
+} from "@leaddreamer/firebase-wrapper";
+import { Forms, fillForm } from "@leaddreamer/staticforms";
+import { PRIVATEDATA, ADDRESSES, USER, MCC } from "../boilerplate/index.js";
+import { fetchAddresses } from "../Addresses/index.js";
+
+//////////////////////////////////////////////////////////////////////
+// definitions
+
+/**
+ * @external AddressType
+ */
+/**
+ * @typedef {object} contact
+ * @property {?string} contact.Id
+ * @property {!string} contact.first_name
+ * @property {!string} contact.last_name
+ * @property {!string} contact.tel
+ * @property {?string} contact.email - must be filled in to make profile public
+ */
+/**
+ * @typedef {object} PrivateData
+ * @property {?string} email - must be filled in to make profile public
+ * @property {contact} contact
+ * @property {!string} tel
+ * @property {AddressType} business_address
+ * @property {AddressType} mailing_address
+ * @property {AddressType} billing_address
+ */
+/**
+ * @constant
+ * @type {PrivateData}
+ * @default
+ */
+const PrivateDefault = {
+  Id: null,
+  email: null,
+  contact: null,
+  business_address: null,
+  mailing_address: null,
+  billing_address: null,
+  tel: null,
+  tax_rate: null,
+  //tax_id: null,
+  openIssues: false,
+};
+
+/**
+ * @constant
+ * @type {PrivateData}
+ * @default
+ */
+const PrivateAccountForm = {
+  refPath: "hidden:text",
+  email: "email",
+  contact: `object:${USER}`,
+  business_address: `lookupLink:${ADDRESSES}`,
+  mailing_address: `lookupLink:${ADDRESSES}`,
+  billing_address: `lookupLink:${ADDRESSES}`,
+  tel: "tel",
+};
+
+Forms.Base[PRIVATEDATA] = PrivateDefault;
+Forms.BaseForm[PRIVATEDATA] = PrivateAccountForm;
+Forms.AccountForm[PRIVATEDATA] = PrivateAccountForm;
+
+//////////////////////////////////////////////////////////////////////
+// Utilities
+
+/**
+ * Fecthes the PrivateData (email, tel, addresses, etc) for a Fan account
+ * @param {AccountType} account
+ * @returns {Promise.PrivateData}
+ */
+export async function fetchPrivateData(account) {
+  let addresses = [];
+  try {
+    addresses = await fetchAddresses(account);
+  } catch (err) {}
+  const addressMap = new Map();
+  if (addresses.length) {
+    addresses.forEach((address) => {
+      addressMap.set(address.Id, address);
+    });
+  }
+
+  let privateData = await fetchRecord(
+    PRIVATEDATA,
+    account.Id,
+    account.refPath,
+  );
+
+  let addressEntries = {};
+  ["business_address", "billing_address", "mailing_address"].forEach(
+    (entry) => {
+      const isLink =
+        entry && privateData[entry] && !privateData[entry]?.address_line_1;
+      if (isLink) {
+        addressEntries[entry] = {
+          ...addressMap.get(privateData[entry]),
+        };
+      }
+    },
+  ); //hacky way to repeat same effort
+
+  privateData = {
+    ...privateData,
+    ...addressEntries
+  };
+    
+  return privateData;
+}
+
+/**
+ * @external WriteBatch
+ * @typedef {WriteBatch|Transaction|void} ChainType
+ */
+
+/**
+ * @async
+ * @function
+ * @static
+ * Creates the Business information document
+ * @param {AccountType} account
+ * @param {?ChainType} batch - batching object.  Transaction will be added to the batch
+ * @returns {Promise<ChainType>} WriteBatch, Transaction or Void
+ */
+export async function createPrivateData(account, batch = null) {
+  return typedWrite(
+    {
+      ...Forms.Base[PRIVATEDATA],
+      ...fillForm(account, PRIVATEDATA), //sanitize
+    }, //data
+    account, //parent
+    PRIVATEDATA, //type
+    batch,
+  );
+}
+
+/**
+ * Writes the "private" data to the database
+ * @param {PrivateData} privateData
+ * @returns {Promise<PrivateData>}
+ */
+export async function savePrivateData(privateData, batch = null) {
+  return writeBack(privateData, batch);
+}
+
+/**
+ * Deletes a PrivateData record (rarely used if ever)
+ * @param {PrivateData} privateData
+ * @param {!string} privateData.refPath
+ * @returns {Promise<void>}
+ */
+export async function deletePrivateData(privateData, batch = null) {
+  return deleteRecordByRefPath(privateData.refPath, batch);
+}
+
+/**
+ * creates the "base path" (refPath) to store addresses based on an account (refPath)
+ * @param {Record} account
+ * @param {!string} account.refPath
+ * @returns {string}
+ */
+export function privateDataPath(account) {
+  return `${account.refPath}/${PRIVATEDATA}/${account.Id}`;
+}

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";
 
 //////////////////////////////////////////////////////////////////////
 
@@ -334,3 +334,5 @@ export function choicesForm(fieldname) {
     ? Forms.Choices[fieldname]
     : {};
 }
+
+export * from "./other.js";