@leaddreamer/pricinglogic v0.1.0-beta.3

@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.

• 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

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

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

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

Kind: static method of Commodities

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

Kind: static method of Commodities

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

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

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

Commodities.fetchCommodities(person) ⇒ Array.Commodity

Fetches ALL Commodity records. Not very useful

Kind: static method of Commodities

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

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

Fetches a single Commodity record by Id

Kind: static method of Commodities

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

Commodities.summarizeCommodity(commodity) ⇒ string

Returns a standardized formatted name string

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

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

Commodities~PaginatedFetch : object

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

Kind: inner typedef of Commodities
Properties

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

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

Kind: static method of LineItems

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

Kind: static method of LineItems

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

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

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

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

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

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

Fetches a single LineItem record by Id

Kind: static method of LineItems

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

LineItems.summarizeLineItem(lineItem) ⇒ string

Returns a standardized formatted name string

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

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

LineItems~PaginatedFetch : object

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

Kind: inner typedef of LineItems
Properties

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

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

Kind: static method of Payment

Payment.fetchPayment(account, paymentData)

fetches a paymentData record from the database for an account ALL OF fans, artists and venues, etc save the payment data in the same collection name under the parent, with the SAME Id as the parent

Kind: static method of Payment

Payment.fetchPaymentByPerson(accountId, type, paymentData)

fetches a paymentData record from the database for an account when only accountID and type are known 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

Kind: static method of Payment

Payment.addPaymentDescriptor(account, descriptor, batch) ⇒ Promise.PaymentDescriptorType

Adds a specific paymentDescriptor to an account payment data

Kind: static method of Payment

Payment.savePaymentDescriptor(descriptor) ⇒ Promise.PaymentDescriptorType

Saves a modified paymentDescriptor back to the database

Kind: static method of Payment

Payment.removePaymentDescriptor(account, descriptor) ⇒ Promise.<void>

Removes a paymentDescriptor from an account's paymentData

Kind: static method of Payment

Payment.fetchPaymentDescriptors(account) ⇒ Promise.Array.PaymentDescriptor

fetch all customer card records IN OUR DATABASE (not payment database)

Kind: static method of Payment

Payment.listPDSummaries(account) ⇒ Promise.Array.PDSummary

fetch the front-end list of paymentDescriptors

Kind: static method of Payment

Payment.fetchLatestPDSummary(account) ⇒ Promise.PaymentDescriptorType

Kind: static method of Payment

Payment.fetchPDByFingerprint(account, fingerprint) ⇒ Promise.<PDSummary>

retreives a PD, given the account Id and Type

Kind: static method of Payment

Payment.fetchPDByOwnerType(accountId, type, fingerprint) ⇒ Promise.<PDSummary>

retreives a PD, given the account Id and Type

Kind: static method of Payment

Payment.replaceDefaultPDSummary(account, PDSummary) ⇒ Promise.AccountObject

Copies a PDSummary tobe the new default (convenience function)

Kind: static method of Payment

Payment.saveReceiptRecord(account, receipt, batch) ⇒ Promise.ReceiptType

Savess a Receipt to an account

Kind: static method of Payment

Payment.updateReceipt(receipt) ⇒ Promise.ReceiptType

Updates a (changed?) Receipt record

Kind: static method of Payment

Payment.saveReceiptRecordByOwnerType(ownerId, type, receipt, batch) ⇒ Promise.ReceiptType

Saves a new receipt to an account referrred by ID and type

Kind: static method of Payment

Payment.anyReceiptsByMonthStamp(account, monthStamp) ⇒ Promise.Array.ReceiptType

Fetches an array of receipts in any particular month by monthStampt

Kind: static method of Payment

Payment.saveReceiptRecordByChild(child, receipt, batch) ⇒ Promise.ReceiptType

Saves a receipt by a child record reference

Kind: static method of Payment

Payment.fetchReceiptsFiltered(account, filterArray, sortArray, limit) ⇒ Promise.Array.ReceiptType

Fetches receipts based on a filter set

Kind: static method of Payment

Payment.fetchProblemReceipts(account) ⇒ Promise.Array.ReceiptType

Kind: static method of Payment

Payment.fetchPledgeTicketReceipt(pledgeTicket) ⇒ Promise.ReceiptType

Fetches the receipt for a pledgeTicket

Kind: static method of Payment

Payment.markReceiptFromPledgeTicket(pledgeTicket, label) ⇒ Promise.ReceiptType

Changes the paidQ label on a receipt associated with a pledgeTicket

Kind: static method of Payment

Payment.markReceipt(receipt, label) ⇒ Promise.ReceiptType

Changes the paidQ label on a receipt associated with a pledgeTicket

Kind: static method of Payment

Payment~fetchReceipt(account, receiptId) ⇒ Promise.ReceiptType

Kind: inner method of Payment

Payment~PaymentData : object

Kind: inner typedef of Payment
Properties

Payment~PaymentDescriptorType : object

Kind: inner typedef of Payment
Properties

Payment~PDSummary : object

Kind: inner typedef of Payment
Properties

Payment~ReceiptType : object

Kind: inner typedef of Payment
Properties

Payment~AccountObject : OrganizationType | PersonObject

Kind: inner typedef of Payment

People

Typedefs, constants, support functions and database operations related to individual users

• People
  • static
    • .createPerson ⇒ Promise.PersonObject
    • .deletePerson(person) ⇒ Promise.<void>
    • .deletePersonById(person) ⇒ Promise.<void>
    • .buildPersonRecords(user) ⇒ Promise.<void>
    • .updatePersonByID(person) ⇒ promise.PeopleObject
    • .updatePerson(person) ⇒ promise.PeopleObject
    • .knownPerson(Id) ⇒ Promise.boolean
    • .fetchPeople() ⇒ Array.PeopleObject
    • .fetchPeoplePaginated(limit) ⇒ PaginatedFetch
    • .fetchAnonymousPaginated(limit) ⇒ PaginatedFetch
    • .fetchPerson(personId) ⇒ Promise.PeopleObject
    • .fetchPersonName(personId) ⇒ Promise.string
    • .fetchPersonEmail(personId) ⇒ Promise.string
    • .fetchPersonPaymentById(personId) ⇒ Promise.PaymentData
    • .fetchUserByEmail(email) ⇒ Promise.PeopleObject
    • .fetchFullPerson(personIdentifier) ⇒ Promise.PeopleObject
    • .summarizePerson(person) ⇒ string
    • .fetchPersonFromChild(child) ⇒ Promise.PeopleObject
    • .personFromId(personId) ⇒ PeopleObject
  • inner
    • ~PeopleDefault : PersonObject
    • ~PeopleDefaultForm : PersonObject
    • ~PersonObject : object
    • ~PaginatedFetch : object

People.createPerson ⇒ Promise.PersonObject

Kind: static constant of People

People.deletePerson(person) ⇒ Promise.<void>

Kind: static method of People

People.deletePersonById(person) ⇒ Promise.<void>

Kind: static method of People

People.buildPersonRecords(user) ⇒ Promise.<void>

Builds a Person record from the authentication "user" data

Kind: static method of People

People.updatePersonByID(person) ⇒ promise.PeopleObject

writes record back to database. Assumes only Id is valid

Kind: static method of People
Returns: promise.PeopleObject - a copy of the data written

People.updatePerson(person) ⇒ promise.PeopleObject

writes record back to database. Assumes only Id is valid

Kind: static method of People
Returns: promise.PeopleObject - a copy of the data written

People.knownPerson(Id) ⇒ Promise.boolean

Checks if this is a known PersonObject Id

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

People.fetchPeople() ⇒ Array.PeopleObject

Fecthes ALL people records. Not very useful

Kind: static method of People

People.fetchPeoplePaginated(limit) ⇒ PaginatedFetch

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

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

People.fetchAnonymousPaginated(limit) ⇒ PaginatedFetch

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

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

People.fetchPerson(personId) ⇒ Promise.PeopleObject

Fetches a single PeopleObject record by Id

Kind: static method of People

People.fetchPersonName(personId) ⇒ Promise.string

Fetches and returns the summarized name from a PeopleObject record

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

People.fetchPersonEmail(personId) ⇒ Promise.string

Fetches and returns the email from a PeopleObject record

Kind: static method of People
Returns: Promise.string - the email from the record

People.fetchPersonPaymentById(personId) ⇒ Promise.PaymentData

Fetches the PaymentRecord for a person using just the ID

Kind: static method of People

People.fetchUserByEmail(email) ⇒ Promise.PeopleObject

Fetch a People record by their email

Kind: static method of People

People.fetchFullPerson(personIdentifier) ⇒ Promise.PeopleObject

fetches a full person object (address, payment, private, etc) given EITHER just the Id, OR a PersonObject

Kind: static method of People

People.summarizePerson(person) ⇒ string

Returns a standardized formatted name string

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

People.fetchPersonFromChild(child) ⇒ Promise.PeopleObject

Fetches a PersonObject from any child record in any branch

Kind: static method of People

People.personFromId(personId) ⇒ PeopleObject

builds a minimal PeopleObject from an Id

Kind: static method of People

People~PeopleDefault : PersonObject

Kind: inner constant of People
Default: {"Id":null,"refPath":null,"name":null,"email":null,"tel":null,"isAnonymous":true,"payment_method":null,"admin_status":null}
Read only: true

People~PeopleDefaultForm : PersonObject

Kind: inner constant of People
Default: {"name":"text","email":"email","tel":"tel"}
Read only: true

People~PersonObject : object

Kind: inner typedef of People
Properties

People~PaginatedFetch : object

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

Kind: inner typedef of People
Properties

Product

Typedefs, constants, support functions and database operations related to Products

• Product
  • static
    • .saveProduct(person) ⇒ Promise.<void>
  • inner
    • ~ProductDefault : Product
    • ~ProductDefaultForm : Product
    • ~Product : object

Product.saveProduct(person) ⇒ Promise.<void>

Saves a Product object to the database

Kind: static method of Product

Properties

Product~ProductDefault : Product

Kind: inner constant of Product
Default: {"Id":null,"refPath":null,"name":""}
Read only: true

Product~ProductDefaultForm : Product

Kind: inner constant of Product
Default: {"name":"text"}
Read only: true

Product~Product : object

a record

Kind: inner typedef of Product
Properties

Stages

Typedefs, constants, support functions and database operations related to product creation stages users

• Stages
  • static
    • .saveStage(parent) ⇒ Promise.<void>
  • inner
    • ~StageDefault : Stage
    • ~StageDefaultForm : Stage
    • ~Stage : object

Stages.saveStage(parent) ⇒ Promise.<void>

Saves a default Stage Settings object to the database

Kind: static method of Stages

Properties

Stages~StageDefault : Stage

Kind: inner constant of Stages
Default: {"Id":null,"refPath":null,"base":2.5,"highValue":1.5,"overhead":5,"rate":20,"unit":"hour","hours":0,"minutes":0,"stage":"fabrication"}
Read only: true

Stages~StageDefaultForm : Stage

Kind: inner constant of Stages
Default: {"base":"number","highValue":"number","overhead":"number","rate":"number","unit":"lookup","hours":"number","minutes":"number","stage":"lookup"}
Read only: true

Stages~Stage : object

a record

Kind: inner typedef of Stages
Properties

Boilerplate

Shared constants and symbols

Boilerplate.recordByIdAndType ⇒ AccountType

creates and returns a minimal record from an Id and type

Kind: static constant of Boilerplate

© 2020-2023 Tracy Hall / Dreams and Logic Inc / SaltSweetSpirits