@leaddreamer/inventorylogic 0.0.3-beta.29 → 0.0.3-beta.30

package/README.md

@@ -19,6 +19,10 @@ services.</p>
 <dd><p>A collection of Business logic and database functions.  Shared between ReactJS
 frontEnd and NodeJS BackEnd</p>
 </dd>
+<dt><a href="#module_BusinessData">BusinessData</a></dt>
+<dd><p>Functions for managing (potentially)private data for an organization.
+Unified structure as a sub-record of organization, or CityManager accounts</p>
+</dd>
 <dt><a href="#module_Commodities">Commodities</a></dt>
 <dd><p>Typedefs, constants, support functions and database operations related to Commodity Matrials
 users</p>
@@ -178,6 +182,208 @@ called from a cloud environment
 | measurementId: | <code>string</code> | (optional) Analytics/Measurement ID from Firebase Console |
 | mapsAPIKey | <code>string</code> | (optional) App ID for Google Maps API, from Google |
 
+<a name="module_BusinessData"></a>
+
+## BusinessData
+Functions for managing (potentially)private data for an organization.
+Unified structure as a sub-record of organization, or CityManager accounts
+
+
+* [BusinessData](#module_BusinessData)
+    * _static_
+        * [.fetchFullAccount(account)](#module_BusinessData.fetchFullAccount) ⇒ <code>Promise.AccountType</code>
+        * [.fetchBusinessData(account)](#module_BusinessData.fetchBusinessData) ⇒ <code>Promise.BusinessData</code>
+        * [.accountPage(account, origin)](#module_BusinessData.accountPage) ⇒ <code>string</code>
+        * [.createBusinessData(account, batch)](#module_BusinessData.createBusinessData) ⇒ <code>Promise.&lt;ChainType&gt;</code>
+        * [.saveBusinessData(businessData)](#module_BusinessData.saveBusinessData) ⇒ <code>Promise.&lt;BusinessData&gt;</code>
+        * [.deleteBusinessData(businessData)](#module_BusinessData.deleteBusinessData) ⇒ <code>Promise.&lt;void&gt;</code>
+        * [.businessDataPath(account)](#module_BusinessData.businessDataPath) ⇒ <code>string</code>
+        * [.profileComplete(account, businessData)](#module_BusinessData.profileComplete) ⇒ <code>Boolean</code>
+        * [.profileIncomplete(account, businessData)](#module_BusinessData.profileIncomplete) ⇒ <code>string</code> \| <code>null</code>
+        * [.setOpenIssues(businessData)](#module_BusinessData.setOpenIssues) ⇒ <code>Promise.boolean</code>
+        * [.clearOpenIssues(businessData)](#module_BusinessData.clearOpenIssues) ⇒ <code>Promise.boolean</code>
+    * _inner_
+        * [~BusinessDefault](#module_BusinessData..BusinessDefault) : <code>BusinessData</code>
+        * [~BusinessAccountForm](#module_BusinessData..BusinessAccountForm) : <code>BusinessData</code>
+        * [~contact](#module_BusinessData..contact) : <code>object</code>
+        * [~BusinessData](#module_BusinessData..BusinessData) : <code>object</code>
+        * [~ChainType](#module_BusinessData..ChainType) : <code>WriteBatch</code> \| <code>Transaction</code> \| <code>void</code>
+
+<a name="module_BusinessData.fetchFullAccount"></a>
+
+### BusinessData.fetchFullAccount(account) ⇒ <code>Promise.AccountType</code>
+Fetches a fulll object representation of an account, including BusinessData
+
+**Kind**: static method of [<code>BusinessData</code>](#module_BusinessData)  
+
+| Param | Type |
+| --- | --- |
+| account | <code>AccountType</code> | 
+
+<a name="module_BusinessData.fetchBusinessData"></a>
+
+### BusinessData.fetchBusinessData(account) ⇒ <code>Promise.BusinessData</code>
+Fetches the BusinessData (corporate, addresses, etc) for an account
+
+**Kind**: static method of [<code>BusinessData</code>](#module_BusinessData)  
+
+| Param | Type |
+| --- | --- |
+| account | <code>AccountType</code> | 
+
+<a name="module_BusinessData.accountPage"></a>
+
+### BusinessData.accountPage(account, origin) ⇒ <code>string</code>
+Composes a URL for an "account page" from the account, and passed base URL
+
+**Kind**: static method of [<code>BusinessData</code>](#module_BusinessData)  
+**Returns**: <code>string</code> - full URL for business accouont  
+
+| Param | Type | Description |
+| --- | --- | --- |
+| account | <code>AccountType</code> |  |
+| origin | <code>string</code> | base URL for the application |
+
+<a name="module_BusinessData.createBusinessData"></a>
+
+### BusinessData.createBusinessData(account, batch) ⇒ <code>Promise.&lt;ChainType&gt;</code>
+**Kind**: static method of [<code>BusinessData</code>](#module_BusinessData)  
+**Returns**: <code>Promise.&lt;ChainType&gt;</code> - WriteBatch, Transaction or Void  
+
+| Param | Type | Description |
+| --- | --- | --- |
+| account | <code>AccountType</code> |  |
+| batch | <code>ChainType</code> | batching object.  Transaction will be added to the batch |
+
+<a name="module_BusinessData.saveBusinessData"></a>
+
+### BusinessData.saveBusinessData(businessData) ⇒ <code>Promise.&lt;BusinessData&gt;</code>
+Writes the "Business" data to the database
+
+**Kind**: static method of [<code>BusinessData</code>](#module_BusinessData)  
+
+| Param | Type |
+| --- | --- |
+| businessData | <code>BusinessData</code> | 
+
+<a name="module_BusinessData.deleteBusinessData"></a>
+
+### BusinessData.deleteBusinessData(businessData) ⇒ <code>Promise.&lt;void&gt;</code>
+Deletes a BusinessData record (rarely used if ever)
+
+**Kind**: static method of [<code>BusinessData</code>](#module_BusinessData)  
+
+| Param | Type |
+| --- | --- |
+| businessData | <code>BusinessData</code> | 
+| businessData.refPath | <code>string</code> | 
+
+<a name="module_BusinessData.businessDataPath"></a>
+
+### BusinessData.businessDataPath(account) ⇒ <code>string</code>
+creates the "base path" (refPath) to store addresses based on an account (refPath)
+
+**Kind**: static method of [<code>BusinessData</code>](#module_BusinessData)  
+
+| Param | Type |
+| --- | --- |
+| account | <code>Record</code> | 
+| account.refPath | <code>string</code> | 
+
+<a name="module_BusinessData.profileComplete"></a>
+
+### BusinessData.profileComplete(account, businessData) ⇒ <code>Boolean</code>
+verifies that all needed information has been filled in
+
+**Kind**: static method of [<code>BusinessData</code>](#module_BusinessData)  
+
+| Param | Type | Description |
+| --- | --- | --- |
+| account | <code>AccountType</code> |  |
+| businessData | <code>BusinessData</code> | record |
+
+<a name="module_BusinessData.profileIncomplete"></a>
+
+### BusinessData.profileIncomplete(account, businessData) ⇒ <code>string</code> \| <code>null</code>
+verifies that all needed information has been filled in
+
+**Kind**: static method of [<code>BusinessData</code>](#module_BusinessData)  
+
+| Param | Type | Description |
+| --- | --- | --- |
+| account | <code>AccountType</code> |  |
+| businessData | <code>BusinessData</code> | record |
+
+<a name="module_BusinessData.setOpenIssues"></a>
+
+### BusinessData.setOpenIssues(businessData) ⇒ <code>Promise.boolean</code>
+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
+
+**Kind**: static method of [<code>BusinessData</code>](#module_BusinessData)  
+
+| Param | Type |
+| --- | --- |
+| businessData | <code>BusinessData</code> | 
+
+<a name="module_BusinessData.clearOpenIssues"></a>
+
+### BusinessData.clearOpenIssues(businessData) ⇒ <code>Promise.boolean</code>
+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
+
+**Kind**: static method of [<code>BusinessData</code>](#module_BusinessData)  
+
+| Param | Type |
+| --- | --- |
+| businessData | <code>BusinessData</code> | 
+
+<a name="module_BusinessData..BusinessDefault"></a>
+
+### BusinessData~BusinessDefault : <code>BusinessData</code>
+**Kind**: inner constant of [<code>BusinessData</code>](#module_BusinessData)  
+**Default**: <code>{&quot;Id&quot;:null,&quot;email&quot;:null,&quot;business_type&quot;:null,&quot;contact&quot;:null,&quot;business_address&quot;:null,&quot;mailing_address&quot;:null,&quot;billing_address&quot;:null,&quot;tel&quot;:null,&quot;mcc&quot;:null,&quot;tax_rate&quot;:null,&quot;openIssues&quot;:false}</code>  
+<a name="module_BusinessData..BusinessAccountForm"></a>
+
+### BusinessData~BusinessAccountForm : <code>BusinessData</code>
+**Kind**: inner constant of [<code>BusinessData</code>](#module_BusinessData)  
+**Default**: <code>{&quot;refPath&quot;:&quot;hidden:text&quot;,&quot;email&quot;:&quot;email&quot;,&quot;business_type&quot;:&quot;&quot;,&quot;contact&quot;:&quot;&quot;,&quot;business_address&quot;:&quot;&quot;,&quot;mailing_address&quot;:&quot;&quot;,&quot;billing_address&quot;:&quot;&quot;,&quot;tel&quot;:&quot;tel&quot;,&quot;mcc&quot;:&quot;&quot;}</code>  
+<a name="module_BusinessData..contact"></a>
+
+### BusinessData~contact : <code>object</code>
+**Kind**: inner typedef of [<code>BusinessData</code>](#module_BusinessData)  
+**Properties**
+
+| Name | Type | Description |
+| --- | --- | --- |
+| contact.Id | <code>string</code> |  |
+| contact.first_name | <code>string</code> |  |
+| contact.last_name | <code>string</code> |  |
+| contact.tel | <code>string</code> |  |
+| contact.email | <code>string</code> | must be filled in to make profile public |
+
+<a name="module_BusinessData..BusinessData"></a>
+
+### BusinessData~BusinessData : <code>object</code>
+**Kind**: inner typedef of [<code>BusinessData</code>](#module_BusinessData)  
+**Properties**
+
+| Name | Type | Description |
+| --- | --- | --- |
+| email | <code>string</code> | must be filled in to make profile public |
+| contact | <code>contact</code> |  |
+| tel | <code>string</code> |  |
+| business_type | <code>string</code> |  |
+| business_address | <code>AddressType</code> |  |
+| mailing_address | <code>AddressType</code> |  |
+| billing_address | <code>AddressType</code> |  |
+
+<a name="module_BusinessData..ChainType"></a>
+
+### BusinessData~ChainType : <code>WriteBatch</code> \| <code>Transaction</code> \| <code>void</code>
+**Kind**: inner typedef of [<code>BusinessData</code>](#module_BusinessData)  
 <a name="module_Commodities"></a>
 
 ## Commodities

package/business/BusinessData/index.js

@@ -0,0 +1,301 @@
+/**
+ * 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,
+  PERSON,
+  MCC,
+} from "../boilerplate";
+import { Forms, fillForm } from "../../formModule";
+import { fetchAddresses } from "../Addresses";
+
+//////////////////////////////////////////////////////////////////////
+// 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:${PERSON}`,
+  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/package.json

@@ -3,7 +3,7 @@
   "engines": {
     "node": ">=22"
   },
-  "version": "0.0.3-beta.29",
+  "version": "0.0.3-beta.30",
   "description": "Business & Database Logic for Inventory Services",
   "repository": {
     "type": "git",