@leaddreamer/ESBusiness

Business Logic for the Events Services system, wrapped around FirebaseWrapper, to be shared between Back and Front End. This particular library only provides the business "logic" - not browser services.

Modules

ESBusiness: Business Logic for the Event Services system, wrapped around FirebaseWrapper, to be shared between Back and Front End. This particular library only provides the business "logic" - not browser services.
PricingLogic: A collection of Business logic and database functions. Sahred between ReactJS frontEnd and NodeJS BackEnd
Commodities: Typedefs, constants, support functions and database operations related to Commodity Matrials users
LineItems: Typedefs, constants, support functions and database operations related to LineItem Matrials users
Payment: "Payment Descriptor" handling operations. These descriptors represent paymentMethods, each tied to an individual user. These do not particularly represent a paymentProvider - they are meant as an abstraction above a specific payment processor.
People: Typedefs, constants, support functions and database operations related to individual users
Product: Typedefs, constants, support functions and database operations related to Products
Stages: Typedefs, constants, support functions and database operations related to product creation stages users
Boilerplate: Shared constants and symbols

ESBusiness

Business Logic for the Event Services system, wrapped around FirebaseWrapper, to be shared between Back and Front End. This particular library only provides the business "logic" - not browser services.

ESBusiness
- static
  - .databasePromise(firebase, config, thisLogger) ⇒ Promise.Firebase
- inner
  - ~FirebaseConfigObject : object

ESBusiness.databasePromise(firebase, config, thisLogger) ⇒ `Promise.Firebase`

all-in-one wrapper for a solid subset of CLIENT-SIDE Firebase functions, with a consistent interface. There is a parallel set for ADMIN-SIDE functions as well. Call/initialize with Firebase Configuration settings in an object as described below

Kind: static method of ESBusiness

Param	Type	Description
firebase	`Firebase`
config	`FirebaseConfigObject`	Firebase Admin object
thisLogger	`callback`

Example

//this specifically loads ALL the subsections, specifically for
//the Browser.  See later (tbd) notes for NodeJS

import FirebaseWrapper from "@leaddreamer/firebase-wrapper";
FirebaseWrapper(config); //see below
export * from "@leaddreamer/firebase-wrapper";

ESBusiness~FirebaseConfigObject : `object`

only authDomain, databaseURL and storageBucket are present when called from a cloud environment

Kind: inner typedef of ESBusiness
Properties

Name	Type	Description
apiKey	`string`	required api Key from Firebase Console,
appId	`string`	required app ID from Firebase Console
projectId	`string`	required Firebase projectID from Firebase console
authDomain	`string`	(optional) auth domain from Firebase Console
databaseURL	`string`	(optional) Firestore database URL from Firebase console
storageBucket:	`string`	(optional) URL of Firestore Storage Bucket
messagingSenderId:	`string`	(optional) ID for Messaing service from Firebase Console
measurementId:	`string`	(optional) Analytics/Measurement ID from Firebase Console
mapsAPIKey	`string`	(optional) App ID for Google Maps API, from Google

PricingLogic

A collection of Business logic and database functions. Sahred between ReactJS frontEnd and NodeJS BackEnd

Commodities

Typedefs, constants, support functions and database operations related to Commodity Matrials users

Commodities
- static
  - .createCommodity ⇒ Promise.Commodity
  - .deleteCommodity(commodity, person) ⇒ Promise.<void>
  - .deleteCommodityById(commodity, person) ⇒ Promise.<void>
  - .updateCommodityByID(commodity, person) ⇒ promise.Commodity
  - .updateCommodity(commodity, person) ⇒ promise.Commodity
  - .knownCommodity(Id, person) ⇒ Promise.boolean
  - .fetchCommodities(person) ⇒ Array.Commodity
  - .fetchCommoditiesPaginated(limit, person) ⇒ PaginatedFetch
  - .fetchCommodity(commodityId, person) ⇒ Promise.Commodity
  - .fetchCommodityName(commodityId, person) ⇒ Promise.string
  - .summarizeCommodity(commodity) ⇒ string
- inner
  - ~CommodityDefault : Commodity
  - ~CommodityDefaultForm : Commodity
  - ~Commodity : object
  - ~PaginatedFetch : object

Commodities.createCommodity ⇒ `Promise.Commodity`

Kind: static constant of Commodities

Param	Type	Description
commodity	`Commodity`	minimal record of user account
person	`Person`	minimal record of person this commodity belongs to (if any)

Commodities.deleteCommodity(commodity, person) ⇒ `Promise.<void>`

Kind: static method of Commodities

Param	Type	Description
commodity	`CommodityDefault`
person	`Person`	minimal record of person this commodity belongs to (if any)

Commodities.deleteCommodityById(commodity, person) ⇒ `Promise.<void>`

Kind: static method of Commodities

Param	Type	Description
commodity	`CommodityDefault`	minimal record of user account
commodity.Id	`string`	record Id of account
person	`Person`	minimal record of person this commodity belongs to (if any)

Commodities.updateCommodityByID(commodity, person) ⇒ `promise.Commodity`

writes record back to database. Assumes only Id is valid

Kind: static method of Commodities
Returns: promise.Commodity - a copy of the data written

Param	Type	Description
commodity	`Commodity`	a partially-populated commodity record for updates
person	`Person`	minimal record of person this commodity belongs to (if any)

Commodities.updateCommodity(commodity, person) ⇒ `promise.Commodity`

writes record back to database. Assumes only Id is valid

Kind: static method of Commodities
Returns: promise.Commodity - a copy of the data written

Param	Type	Description
commodity	`Commodity`	a partially-populated commodity record for updates
person	`Person`	minimal record of person this commodity belongs to (if any)

Commodities.knownCommodity(Id, person) ⇒ `Promise.boolean`

Checks if this is a known Commodity Id

Kind: static method of Commodities
Returns: Promise.boolean - true is this Id is in database

Param	Type	Description
Id	`string`	Id value to check
person	`Person`	minimal record of person this commodity belongs to (if any)

Commodities.fetchCommodities(person) ⇒ `Array.Commodity`

Fetches ALL Commodity records. Not very useful

Kind: static method of Commodities

Param	Type	Description
person	`Person`	minimal record of person this commodity belongs to (if any)

Commodities.fetchCommoditiesPaginated(limit, person) ⇒ `PaginatedFetch`

Fetchs an object to fetch pages of commodity data, ascending by name, "limit" at a time

Kind: static method of Commodities
Returns: PaginatedFetch - object with pagination methods

Param	Type	Description
limit	`number`
person	`Person`	minimal record of person this commodity belongs to (if any)

Commodities.fetchCommodity(commodityId, person) ⇒ `Promise.Commodity`

Fetches a single Commodity record by Id

Kind: static method of Commodities

Param	Type	Description
commodityId	`string`
person	`Person`	minimal record of person this commodity belongs to (if any)

Commodities.fetchCommodityName(commodityId, person) ⇒ `Promise.string`

Fetches and returns the summarized name from a Commodity record

Kind: static method of Commodities
Returns: Promise.string - the summarized name from the record

Param	Type	Description
commodityId	`string`
person	`Person`	minimal record of person this commodity belongs to (if any)

Commodities.summarizeCommodity(commodity) ⇒ `string`

Returns a standardized formatted name string

Kind: static method of Commodities
Returns: string - formatted name string

Param	Type
commodity	`Commodity`

Commodities~CommodityDefault : `Commodity`

Kind: inner constant of Commodities
Default: {"Id":null,"refPath":null,"description":null,"unit":null,"rate":0,"HighValue":true,"image":null}
Read only: true

Commodities~CommodityDefaultForm : `Commodity`

Kind: inner constant of Commodities
Default: {"description":"text","unit":"lookup:units","rate":"number","HighValue":"boolean","image":"url"}
Read only: true

Commodities~Commodity : `object`

a record

Kind: inner typedef of Commodities
Properties

Name	Type	Description
Id	`string`	Id of document (redundant for convenience)
refPath	`string`	if from database, full path to document
description	`string`	description, e.g. "Wire, Silver, Sterling, 20ga"
unit	`string`	usage/measurement unit (for unit conversion)
rate	`number`	the per unit cost of this commodity
HighValue	`boolean`	boolean flag to indicate "High Value" (lower markup) commodities
image	`url`	a reference image for the commodity

Commodities~PaginatedFetch : `object`

An object to allow for paginating a table read from Firestore. REQUIRES a sorting choice

Kind: inner typedef of Commodities
Properties

Name	Type	Description
Query	`Query`	that forms basis for the table read
limit	`number`	page size
snapshot	`QuerySnapshot`	last successful snapshot/page fetched
status	`enum`	status of pagination object
PageForward	`method`	pages the fetch forward
PageBack	`method`	pages the fetch backward

LineItems

Typedefs, constants, support functions and database operations related to LineItem Matrials users

LineItems
- static
  - .createLineItem ⇒ Promise.LineItem
  - .deleteLineItem(lineItem) ⇒ Promise.<void>
  - .deleteLineItemById(lineItem, minimal) ⇒ Promise.<void>
  - .updateLineItemByID(lineItem, product) ⇒ promise.LineItem
  - .updateLineItem(lineItem, product) ⇒ promise.LineItem
  - .knownLineItem(Id, product) ⇒ Promise.boolean
  - .fetchLineItems() ⇒ Array.LineItem
  - .fetchProductLineItems(product, stage) ⇒ Array.LineItem
  - .paginateProductLineItems(product, stage, limit) ⇒ PaginatedFetch
  - .fetchLineItem(lineItemId, product) ⇒ Promise.LineItem
  - .fetchLineItemName(lineItemId, product) ⇒ Promise.string
  - .summarizeLineItem(lineItem) ⇒ string
- inner
  - ~LineItemDefault : LineItem
  - ~LineItemDefaultForm : LineItem
  - ~LineItem : object
  - ~PaginatedFetch : object

LineItems.createLineItem ⇒ `Promise.LineItem`

Kind: static constant of LineItems

Param	Type	Description
lineItem	`LineItem`	minimal record of user account
product	`Product`	minimal record of product this lineItem belongs to

LineItems.deleteLineItem(lineItem) ⇒ `Promise.<void>`

Kind: static method of LineItems

Param	Type
lineItem	`LineItemDefault`

LineItems.deleteLineItemById(lineItem, minimal) ⇒ `Promise.<void>`

Kind: static method of LineItems

Param	Type	Description
lineItem	`LineItemDefault`	minimal record of lineItem in question
lineItem.Id	`string`	record Id of account
minimal	`Product`	record of product this lineItem belongs to

LineItems.updateLineItemByID(lineItem, product) ⇒ `promise.LineItem`

writes record back to database. Assumes only Id is valid

Kind: static method of LineItems
Returns: promise.LineItem - a copy of the data written

Param	Type	Description
lineItem	`LineItem`	a minimal lineItem record for updates
product	`Product`	minimal record of product this lineItem belongs to

LineItems.updateLineItem(lineItem, product) ⇒ `promise.LineItem`

writes record back to database. Assumes only Id is valid

Kind: static method of LineItems
Returns: promise.LineItem - a copy of the data written

Param	Type	Description
lineItem	`LineItem`	a partially-populated lineItem record for updates
product	`Product`	minimal record of product this lineItem belongs to

LineItems.knownLineItem(Id, product) ⇒ `Promise.boolean`

Checks if this is a known LineItem Id

Kind: static method of LineItems
Returns: Promise.boolean - true is this Id is in database

Param	Type	Description
Id	`string`	Id value to check
product	`Product`	minimal record of product this lineItem belongs to

LineItems.fetchLineItems() ⇒ `Array.LineItem`

Fetches ALL LineItem records. Not very useful

Kind: static method of LineItems

LineItems.fetchProductLineItems(product, stage) ⇒ `Array.LineItem`

Fetches ALL LineItem records for a specific product. Not very useful

Kind: static method of LineItems

Param	Type	Description
product	`Product`	minimal record of product this lineItem belongs to
stage	`Stage`	optional stage selection, to get a subset of the line items

LineItems.paginateProductLineItems(product, stage, limit) ⇒ `PaginatedFetch`

Fetchs an object to fetch pages of lineItem data, ascending by name, "limit" at a time

Kind: static method of LineItems
Returns: PaginatedFetch - object with pagination methods

Param	Type	Description
product	`Product`
stage	`Stage`	optional stage selection, to get a subset of the line items
limit	`number`

LineItems.fetchLineItem(lineItemId, product) ⇒ `Promise.LineItem`

Fetches a single LineItem record by Id

Kind: static method of LineItems

Param	Type	Description
lineItemId	`string`
product	`Product`	minimal record of product this lineItem belongs to

LineItems.fetchLineItemName(lineItemId, product) ⇒ `Promise.string`

Fetches and returns the summarized name from a LineItem record

Kind: static method of LineItems
Returns: Promise.string - the summarized name from the record

Param	Type	Description
lineItemId	`string`
product	`Product`	minimal record of product this lineItem belongs to

LineItems.summarizeLineItem(lineItem) ⇒ `string`

Returns a standardized formatted name string

Kind: static method of LineItems
Returns: string - formatted name string

Param	Type
lineItem	`LineItem`

LineItems~LineItemDefault : `LineItem`

Kind: inner constant of LineItems
Default: {"Id":null,"refPath":null,"stage":"fabrication","commodity":null,"description":null,"unit":null,"rate":0,"amount":0,"HighValue":true,"image":null}
Read only: true

LineItems~LineItemDefaultForm : `LineItem`

Kind: inner constant of LineItems
Default: {"product":"lookup","stage":"lookup","commodity":"lookupLink","description":"text","unit":"lookup:units","rate":"number","amount":"number","HighValue":"boolean","image":"url"}
Read only: true

LineItems~LineItem : `object`

a record

Kind: inner typedef of LineItems
Properties

Name	Type	Description
Id	`string`	Id of document (redundant for convenience)
refPath	`string`	if from database, full path to document
stage	`string`	"fabrication", "wholesale", or other to be defined
commodity	`null` \| `string`	Id of a commodity item/material (optional)
description	`string` \| `null`	description, e.g. "Wire, Silver, Sterling, 20ga"
unit	`string` \| `null`	usage/measurement unit (for unit conversion)
rate	`number`	the per unit cost of this lineItem
amount	`number`	amount of material/item useed
HighValue	`boolean`	boolean flag to indicate "High Value" (lower markup) commodities
timestamp	`datetime`	initial time of creation for sorting
image	`url` \| `null`	a reference image for the lineItem

LineItems~PaginatedFetch : `object`

An object to allow for paginating a table read from Firestore. REQUIRES a sorting choice

Kind: inner typedef of LineItems
Properties

Name	Type	Description
Query	`Query`	that forms basis for the table read
limit	`number`	page size
snapshot	`QuerySnapshot`	last successful snapshot/page fetched
status	`enum`	status of pagination object
PageForward	`method`	pages the fetch forward
PageBack	`method`	pages the fetch backward

Payment

"Payment Descriptor" handling operations. These descriptors represent paymentMethods, each tied to an individual user. These do not particularly represent a paymentProvider - they are meant as an abstraction above a specific payment processor.

Payment
- static
  - .ERROR_TYPES : Object
  - .PaymentDefault : PaymentData
  - .paymentDescriptor : PaymentDescriptorType
  - .receiptDefault : ReceiptType
  - .createPaymentRecord(account, batch) ⇒ Promise.<(WriteBatch|Transaction|void)>
  - .savePaymentData(paymentData)
  - .fetchPayment(account, paymentData)
  - .fetchPaymentByPerson(accountId, type, paymentData)
  - .addPaymentDescriptor(account, descriptor, batch) ⇒ Promise.PaymentDescriptorType
  - .savePaymentDescriptor(descriptor) ⇒ Promise.PaymentDescriptorType
  - .removePaymentDescriptor(account, descriptor) ⇒ Promise.<void>
  - .fetchPaymentDescriptors(account) ⇒ Promise.Array.PaymentDescriptor
  - .listPDSummaries(account) ⇒ Promise.Array.PDSummary
  - .fetchLatestPDSummary(account) ⇒ Promise.PaymentDescriptorType
  - .fetchPDByFingerprint(account, fingerprint) ⇒ Promise.<PDSummary>
  - .fetchPDByOwnerType(accountId, type, fingerprint) ⇒ Promise.<PDSummary>
  - .replaceDefaultPDSummary(account, PDSummary) ⇒ Promise.AccountObject
  - .saveReceiptRecord(account, receipt, batch) ⇒ Promise.ReceiptType
  - .updateReceipt(receipt) ⇒ Promise.ReceiptType
  - .saveReceiptRecordByOwnerType(ownerId, type, receipt, batch) ⇒ Promise.ReceiptType
  - .anyReceiptsByMonthStamp(account, monthStamp) ⇒ Promise.Array.ReceiptType
  - .saveReceiptRecordByChild(child, receipt, batch) ⇒ Promise.ReceiptType
  - .fetchReceiptsFiltered(account, filterArray, sortArray, limit) ⇒ Promise.Array.ReceiptType
  - .fetchProblemReceipts(account) ⇒ Promise.Array.ReceiptType
  - .fetchPledgeTicketReceipt(pledgeTicket) ⇒ Promise.ReceiptType
  - .markReceiptFromPledgeTicket(pledgeTicket, label) ⇒ Promise.ReceiptType
  - .markReceipt(receipt, label) ⇒ Promise.ReceiptType
- inner
  - ~fetchReceipt(account, receiptId) ⇒ Promise.ReceiptType
  - ~PaymentData : object
  - ~PaymentDescriptorType : object
  - ~PDSummary : object
  - ~ReceiptType : object
  - ~AccountObject : OrganizationType | PersonObject

Payment.ERROR_TYPES : `Object`

Kind: static constant of Payment

Payment.PaymentDefault : `PaymentData`

Kind: static constant of Payment

Payment.paymentDescriptor : `PaymentDescriptorType`

Kind: static constant of Payment

Payment.receiptDefault : `ReceiptType`

Kind: static constant of Payment

Payment.createPaymentRecord(account, batch) ⇒ `Promise.<(WriteBatch|Transaction|void)>`

Creates the Organization Payment information document

Kind: static method of Payment
Returns: Promise.<(WriteBatch|Transaction|void)> - WriteBatch, Transaction or Void

Param	Type	Description
account	`AccountObject`
batch	`WriteBatch` \| `Transaction`	batching object. Transaction will be added to the batch

Payment.savePaymentData(paymentData)

Saves a payment data record to a given account (organization * or* person) ALL OF fans, artists and venues save the payment data in the same collection name under the parent, with the SAME Id as the parent PaymentData COMES FROM payement processor, and should INCLUDE the record Id and refPath