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

package/business/Addresses/index.js

@@ -0,0 +1,181 @@
+/**
+ * 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/index.js";
+import { businessDataPath } from "../BusinessData/index.js";
+
+//////////////////////////////////////////////////////////////////////
+//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));
+}

package/business/BusinessData/index.js

@@ -0,0 +1,300 @@
+/**
+ * Functions for managing (potentially)private data for an organization.
+ * Unified structure as a sub-record of organization, or CityManager accounts
+ * @module BusinessData
+ */
+import {
+  fetchRecord,
+  writeRecord,
+  typedWrite,
+  writeBack,
+  deleteRecordByRefPath,
+} from "@leaddreamer/firebase-wrapper";
+import {
+  BUSINESS,
+  BUSINESSDATA,
+  BUSINESS_TYPE,
+  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} BusinessData
+ * @property {?string} email - must be filled in to make profile public
+ * @property {contact} contact
+ * @property {!string} tel
+ * @property {string} business_type
+ * @property {AddressType} business_address
+ * @property {AddressType} mailing_address
+ * @property {AddressType} billing_address
+ */
+/**
+ * @constant
+ * @type {BusinessData}
+ * @default
+ */
+const BusinessDefault = {
+  Id: null,
+  email: null,
+  business_type: null,
+  contact: null,
+  business_address: null,
+  mailing_address: null,
+  billing_address: null,
+  tel: null,
+  mcc: null,
+  tax_rate: null,
+  //tax_id: null,
+  openIssues: false,
+};
+
+/**
+ * @constant
+ * @type {BusinessData}
+ * @default
+ */
+const BusinessAccountForm = {
+  refPath: "hidden:text",
+  email: "email",
+  business_type: `lookup:${BUSINESS_TYPE}`,
+  contact: `object:${USER}`,
+  business_address: `lookupLink:${ADDRESSES}`,
+  mailing_address: `lookupLink:${ADDRESSES}`,
+  billing_address: `lookupLink:${ADDRESSES}`,
+  tel: "tel",
+  mcc: `lookup:${MCC}`,
+};
+
+Forms.Base[BUSINESSDATA] = BusinessDefault;
+Forms.BaseForm[BUSINESSDATA] = BusinessAccountForm;
+Forms.AccountForm[BUSINESSDATA] = BusinessAccountForm;
+
+//////////////////////////////////////////////////////////////////////
+// Utilities
+
+/**
+ * Fetches a fulll object representation of an account, including BusinessData
+ * @param {AccountType} account
+ * @returns {Promise.AccountType}
+ */
+export async function fetchFullAccount(account) {
+  const BusinessData = await fetchBusinessData(account);
+
+  account.business = BusinessData;
+
+  return account;
+}
+
+/**
+ * Fetches the BusinessData (corporate, addresses, etc) for an account
+ * @param {AccountType} account
+ * @returns {Promise.BusinessData}
+ */
+export async function fetchBusinessData(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);
+    });
+  }
+
+  const BusinessData = await fetchRecord(
+    BUSINESSDATA,
+    account.Id,
+    account.refPath,
+  );
+
+  let addressEntries = {};
+  ["business_address", "billing_address", "mailing_address"].forEach(
+    (entry) => {
+      const isLink =
+        entry && BusinessData[entry] && !BusinessData[entry]?.address_line_1;
+      if (isLink) {
+        addressEntries[entry] = {
+          ...addressMap.get(BusinessData[entry]),
+        };
+      }
+    },
+  ); //hacky way to repeat same effort
+
+  return {
+    ...BusinessData,
+    ...addressEntries,
+  };
+}
+
+/**
+ * Composes a URL for an "account page" from the account, and passed base URL
+ * @param {!AccountType} account
+ * @param {!string} origin base URL for the application
+ * @returns {string} full URL for business accouont
+ */
+export function accountPage(account, origin) {
+  return `${origin}/${BUSINESS}/Account`; //Leads to LOGGED IN organization account page
+}
+
+/**
+ * @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 createBusinessData(account, batch = null) {
+  return typedWrite(
+    {
+      ...Forms.Base[BUSINESSDATA], //base fields with defaults
+      ...fillForm(account, BUSINESSDATA), //sanitize passed data
+    }, //data
+    account, //parent
+    BUSINESSDATA, //type
+    batch,
+  );
+}
+
+/**
+ * Writes the "Business" data to the database
+ * @param {BusinessData} businessData
+ * @returns {Promise<BusinessData>}
+ */
+export async function saveBusinessData(businessData, batch = null) {
+  return writeBack(businessData, batch);
+}
+
+/**
+ * Deletes a BusinessData record (rarely used if ever)
+ * @param {BusinessData} businessData
+ * @param {!string} businessData.refPath
+ * @returns {Promise<void>}
+ */
+export async function deleteBusinessData(businessData, batch = null) {
+  return deleteRecordByRefPath(businessData.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 businessDataPath(account) {
+  return `${account.refPath}/${BUSINESSDATA}/${account.Id}`;
+}
+
+/**
+ * verifies that all needed information has been filled in
+ * @param {AccountType} account
+ * @param {BusinessData} businessData record
+ * @returns {Boolean}
+ */
+export function profileComplete(account, businessData) {
+  if (!businessData?.business_address) return false;
+  if (!businessData?.billing_address) return false;
+  if (!businessData?.mailing_address) return false;
+  if (!businessData?.email) return false;
+  if (!businessData?.tel) return false;
+  if (!account?.website) return false;
+  if (!(account?.name || account?.corporate)) return false;
+  return true;
+}
+
+/**
+ * verifies that all needed information has been filled in
+ * @param {AccountType} account
+ * @param {BusinessData} businessData record
+ * @returns {string|null}
+ */
+export function profileIncomplete(account, businessData) {
+  let problem_string = "";
+  if (!businessData?.business_address) {
+    problem_string = problem_string.concat(`=> Business Address Missing\n`);
+  }
+  if (!businessData?.billing_address) {
+    problem_string = problem_string.concat(`=> Billing Address Missing\n`);
+  }
+  if (!businessData?.mailing_address) {
+    problem_string = problem_string.concat(`=> Mailing Address Missing\n`);
+  }
+  if (!businessData?.email) {
+    problem_string = problem_string.concat(`=> Business Email Missing\n`);
+  }
+  if (!businessData?.tel) {
+    problem_string = problem_string.concat(`=> Business Telephone Missing\n`);
+  }
+  if (!account?.website) {
+    problem_string = problem_string.concat(`=> Business Website Missing\n`);
+  }
+  if (!(account?.name || account?.corporate)) {
+    problem_string = problem_string.concat(
+      `=> Business and/or Corporate Name Missing\n`,
+    );
+  }
+  return problem_string.length ? problem_string : null;
+}
+
+/**
+ * Sets the "openIssues" flag in an account's BUSINESSDATA record
+ * The account's refPath is attached to the Payment system's record, and
+ * used here to find the Payment Account
+ * @param {BusinessData} businessData
+ * @returns {Promise.boolean}
+ */
+export async function setOpenIssues(businessData) {
+  return writeRecord(
+    BUSINESSDATA,
+    {
+      ...businessData,
+      openIssues: true,
+    },
+    businessData.refPath,
+    null,
+    true,
+  );
+}
+
+/**
+ * Clears the "openIssues" flag in an account's BUSINESSDATA record
+ * The account's refPath is attached to the Payment system's record, and
+ * used here to find the Payment Account
+ * @param {BusinessData} businessData
+ * @returns {Promise.boolean}
+ */
+export async function clearOpenIssues(businessData) {
+  return writeRecord(
+    BUSINESSDATA,
+    {
+      ...businessData,
+      openIssues: false,
+    },
+    businessData.refPath,
+    null,
+    true,
+  );
+}

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

@@ -0,0 +1,184 @@
+/**
+ * Typedefs, constants, support functions and database operations related to Fundamental
+ * setting from the Database *
+ * @module Fundamentals
+ */
+import { collectRecords } from "@leaddreamer/firebase-wrapper";
+import { Forms, fillForm } from "@leaddreamer/staticforms";
+import {
+  FUNDAMENTALS,
+  RATES,
+  PAYOUTRATES,
+  MCC,
+  BUSINESS_TYPE,
+} from "../boilerplate/index.js";
+
+//////////////////////////////////////////////////////////////////////
+// constants
+
+/**
+ * @typedef {object} OrganizationFundamentals
+ * @property {Array.string} Types Allowed organization types
+ */
+
+/**
+ * @typedef {object} Rates
+ * @property {string} Id
+ * @property {object} service_charge
+ * @property {number} service_charge.minimum
+ * @property {number} service_charge.rate - percentage
+ * @property {number} service_charge.rounding_factor
+ */
+/**
+ * @constant
+ * @type {Rates}
+ * @default
+ */
+const Rates = {
+  Id: null,
+  service_charge: {
+    minimum: 0,
+    rate: 0,
+    rounding_factor: 4,
+  },
+};
+
+/**
+ * @typedef {object} PaymentProcessor
+ * @property {number} connected_active allowed active connections
+ * @property {number} processing_concurrency
+ * @property {number} processing_rate
+ * @property {number} processing_time_window
+ * @property {number} per_payout
+ * @property {number} rate_payout
+ * @property {number} rate_payout_scale
+ */
+//For Stripe, all below are in "CENTS"
+/**
+ * @constant
+ * @type {PaymentProcessor}
+ * @default
+ */
+const paymentProcessor = {
+  connected_active: 200,
+  processing_concurrency: 10,
+  processing_rate: 25,
+  processing_time_window: 1000,
+  per_payout: 25,
+  rate_payout: 25,
+  rate_payout_scale: 10000,
+};
+
+/**
+ * @typedef {object} MCCType
+ * @property {string} Id
+ * @property {string} MCC - Merchant Class Code
+ * @property {string} name - Merchant Class Code
+ * @property {string} description - description of Merchant Class Code
+ * @property {string} long - long description of Merchant Class Code
+ * @property {string} type - Applicable business model - "Artists", "Venues" or "Brands"
+ */
+/**
+ * @constant
+ * @type {MCCType}
+ * @default
+ */
+const MCCDefault = {
+  Id: null,
+  MCC: null,
+  name: null,
+  description: null,
+  long: null,
+  type: null,
+};
+
+/**
+ * @typedef {object} BusinessType
+ * @property {string} Id
+ * @property {string} business_type - allowed business type value
+ * @property {string} name -business type value
+ * @property {string} description - description ofbusiness type value
+ */
+/**
+ * @constant
+ * @type {BusinessType}
+ * @default
+ */
+const BusinessTypeDefault = {
+  Id: null,
+  business_type: null,
+  name: null,
+  description: null,
+};
+
+/**
+ * @typedef {object} Fundamentals
+ * @property {Rates} Rates
+ * @property {PaymentProcessor} PaymentProcessor
+ * @property {object} Defaults
+ * @property {MCCType} Defaults.MCC
+ * @property {OrganizationFundamentals} Organizations
+ * @property {Array.string} Organizations.Types Allowed organization types
+ */
+
+Forms.Base[RATES] = Rates;
+Forms.Base[PAYOUTRATES] = paymentProcessor;
+Forms.Base[MCC] = MCCDefault;
+Forms.Base[BUSINESS_TYPE] = BusinessTypeDefault;
+
+//////////////////////////////////////////////////////////
+// fetches
+
+/**
+ * returns a Promise which resolves with an
+ * array of all Fundamentals Objects (or err)
+ * @returns {Promise<Fundamentals>}
+ */
+export async function fetchFundamentals() {
+  const fundamentals = await collectRecords(FUNDAMENTALS);
+  const fundamental_records = fundamentals.reduce((output, record) => {
+    const recordName = record.Id;
+    return record
+      ? {
+          ...output,
+          [recordName]: record,
+        }
+      : output;
+  }, {});
+  return fundamental_records;
+}
+
+/**
+ * returns a Promise that resolves  with the Rates record from the database
+ * @returns {Promise<Rates>}
+ */
+export async function fetchRates() {
+  const fundamentals = await fetchFundamentals();
+  return fundamentals[RATES];
+}
+
+/**
+ * returns a Promise that resolves  with the Rates record from the database
+ * @returns {Promise<PaymentProcessor>}
+ */
+export async function fetchPayoutRates() {
+  const fundamental_records = await fetchFundamentals();
+
+  return fundamental_records[PAYOUTRATES];
+}
+
+/**
+ * returns an array of all MCC (Merchant Commerce Code) available
+ * @returns {Promise<Array.MCCType>}
+ */
+export async function fetchMCCs() {
+  return collectRecords(MCC, `${FUNDAMENTALS}/Defaults`);
+}
+
+/**
+ * returns an array of all MCC (Merchant Commerce Code) available
+ * @returns {Promise<Array.BusinessType>}
+ */
+export async function fetchBusinessTypes() {
+  return collectRecords(BUSINESS_TYPE, `${FUNDAMENTALS}/Defaults`);
+}

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

@@ -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";
+import { MARKUPS, STAGE, FABRICATION, WHOLESALE, RETAIL, BASE, HIGHVALUE, SERVICE, MATERIAL } from "../boilerplate/index.js";
 
 //////////////////////////////////////////////////////////////////////
 // Constants