@leaddreamer/tufbusiness v0.6.11

@leaddreamer/tufbusiness

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

Modules

Constants

Functions

Typedefs

TUFBusiness

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

• TUFBusiness
  • static
    • .FirebaseWrapper(config)
  • inner
    • ~FirebaseConfigObject : object

TUFBusiness.FirebaseWrapper(config)

Kind: static method of TUFBusiness

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";

TUFBusiness~FirebaseConfigObject : object

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

Kind: inner typedef of TUFBusiness
Properties

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 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 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.module) ~Creates the ArtistPayment information document(artist, batch)(#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.module..Creates the ArtistPayment information document) ⇒ Promise ~PaymentDescriptors(#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.module_..PaymentDescriptors) : object ~PDSummaryArray(#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.module..PDSummaryArray) : object ~receiptType(#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.module..receiptType) : object ~paymentDescriptorArray(#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.module_..paymentDescriptorArray) : paymentDescriptor

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.~Creates the ArtistPayment information document(artist, batch) ⇒ Promise Kind: inner method of 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 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.module_)
Returns: Promise - WriteBatch, Transaction or Void

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.~PaymentDescriptors : object Kind: inner typedef of 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 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.module_)
Properties

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.~PDSummaryArray : object Kind: inner typedef of 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 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.module_)
Properties

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.~receiptType : object Kind: inner typedef of 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 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.module_)
Properties

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.~paymentDescriptorArray : paymentDescriptor Kind: inner typedef of 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 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.module_)

SHARE_TYPES : enum

Kind: global enum
Read only: true

VENUE_BOOKING_STATUS : enum

Kind: global enum
Read only: true

ARTIST_BOOKING_STATUS : enum

Kind: global enum
Read only: true

updateBookingOfferArtist

Due to security rule design, bookingOffers need certain data to remain the same to protect against malicious writes. Unfortunately it means there is no way merge in only SPECIFIC fields

Kind: global constant

fetchRates ⇒ Promise

Kind: global constant
Functions: returns a Promise that resolves with the Rates record from the database

fillForm

Kind: global constant
Sync: @function fillForm creates an object using ONLY the fields in the specified "form" object useful for preventing stray data from entering database

createNewArtist(artist, manager, batch) ⇒ Promise

Kind: global function
Returns: Promise - WriteBatch, Transaction or Void

returns a Promise which resolves with an Artist Object (thisArtistID) ⇒ Promise.<ArtistFormType>

Kind: global function
Returns: Promise.<ArtistFormType> - --------------------------------------------------------------------

returns a Promise which resolves with an

array of all Artist Objects (or err)() ⇒ Promise.<ArtistFormArray> Kind: global function

returns a Promise which resolves to an array of all Artists whose

name begins with the provided prompt, optionally limited to a provided number(prompt, limit) ⇒ Promise.<ArtistFormArray> Kind: global function

fetchArtistsMemberAccess(artist) ⇒ artistMatchArray

Kind: global function
Returns: artistMatchArray - artists/acts this artist is a member of

saveArtistMemberAccess()

Kind: global function

findArtistIDFromChild

Extracts the Artists ID from the Document Path (assumes as a child)(child) ⇒ string

Kind: global function
Returns: string - Id of artist Document (which is also ID of artist)

fetchArtistFromChild

Extracts the Artists ID from the Document Path (assumes as a child)(child) ⇒ DocumentObject

Kind: global function
Returns: DocumentObject - Id of artist Document (which is also ID of artist)

crossConfirmed(bookingOffer) ⇒ boolean

function to verify both venue and artist have confirmed a booking offer (hiding implementation)

Kind: global function

simpleCanceled(bookingOffer) ⇒ boolean

Function to check whether either party has canceled the event

Kind: global function

artistShare(bookingOffer, currentAmount, fullAmount)

Kind: global function

createBusinessRecord(artist, batch) ⇒ Promise.<ChainType>

Kind: global function
Returns: Promise.<ChainType> - WriteBatch, Transaction or Void

verifies that all needed information has been filled in(account, Business) ⇒ Boolean

Kind: global function

verifies that all needed information has been filled in(account, Business) ⇒ string | null

Kind: global function

setOpenIssues(account) ⇒ boolean

Sets the "openIssues" flag in an account's Payment record The account's refPath is attached to the Payment system's record, and used here to find the Payment Account

Kind: global function

clearOpenIssues(account) ⇒ boolean

Clears the "openIssues" flag in an account's Payment record The account's refPath is attached to the Payment system's record, and used here to find the Payment Account

Kind: global function

createCityManager

adds a new venue record to the database(venue, batch) ⇒ Promise Kind: global function

returns a Promise which resolves to an array of all cityManagers whose

name begins with the provided prompt, optionally limited to a provided number(prompt, limit) ⇒ Promise.<CityManagerTypeArray> Kind: global function
Returns: Promise.<CityManagerTypeArray> - - array of cityManager objects

fetchCityManagerData returns the cityManagers business data(cityManager) ⇒

Kind: global function
Returns: a cityManagerData record. These records are the ONLY document in sub-collection CITYMANAGERDATA under the "cityManager" record, and have the SAME documentId as the parent "cityManager" document.

createBusinessRecord(artist, batch) ⇒ Promise

Kind: global function
Returns: Promise - WriteBatch, Transaction or Void

verifies that all needed information has been filled in(account, Business) ⇒ Boolean

Kind: global function

verifies that all needed information has been filled in(account, Business) ⇒ string | null

Kind: global function

setOpenIssues(account) ⇒ boolean

Sets the "openIssues" flag in an account's Payment record The account's refPath is attached to the Payment system's record, and used here to find the Payment Account

Kind: global function

clearOpenIssues(account) ⇒ boolean

Clears the "openIssues" flag in an account's Payment record The account's refPath is attached to the Payment system's record, and used here to find the Payment Account

Kind: global function

fetchFundamentals() ⇒ Promise.<ArtistFormArray>

returns a Promise which resolves with an array of all Fundamentals Objects (or err)

Kind: global function

returns a Promise that resolves with the Rates record from the database() ⇒ Promise

Kind: global function

fetchMCCs() ⇒ Promise.<MCCArray>

returns an array of all MCC (Merchant Commerce Code) available

Kind: global function

logMessageEvent(event) ⇒ recordDocument

Message "receipts" are saved in a MESSAGES collection directly under the relevant object. Each is saved as distinct object. They can be queried by the parent event, sorted by the timestamp, to find the latest status

Kind: global function
Returns: recordDocument - - document as written to database - note NOT the stored document, but the PRE-MERGED document including Id and refPath.

messageStatus(record) ⇒ string

fetches the most recent status message event on a particular object Could involved multiple messages, statuses, etc

Kind: global function
Returns: string - event type/status - "processed", "bounced", "delivered", etc

objectArray(record) ⇒ objectArray

fetches all of the message events associated with a partucular record, sorted by reverse timestamp

Kind: global function
Returns: objectArray - array of message events

deletePersonById(person)

Kind: global function

fetchPeoplePaginated(dataCallback, errCallback) ⇒ PaginatedListener

Kind: global function
Returns: PaginatedListener - object with unsubscribe and pagination methods

PageBack pages the fetch backward

----------------------------------------------------------------------(table, filterArray, sortArray, ref, limit) ⇒ PaginateFetch

Kind: global function
Returns: PaginateFetch - An object to allow for paginating a table read from Firestore. REQUIRES a sorting choice

Properties

Classifies a users granted accesses.()

Kind: global function

fetchAccessByUser(requested, roleType) ⇒ AccessesObject

searches all businesses/managers for a user's Id (i.e. NOT the user record version)

Kind: global function

fetchAccessByTarget(requested, target, roleType) ⇒ AccessesObject

Fetches access information for specific account

Kind: global function

findUserAndGrantAccess(offer) ⇒ Promise

Kind: global function
Returns: Promise - - resolve if successful, reject if no match

addAccess(parent, accessItem, batch) ⇒ Promise

Kind: global function
Returns: Promise - WriteBatch, Transaction or Void

removeAccess(parent, accessItem, batch) ⇒ Promise

Kind: global function
Returns: Promise - WriteBatch, Transaction or Void

modifyTourStop(tourStop, batch) ⇒ Promise

Saves an updated record. Assumes sourced from database; included fields are merged with database (allows changing single fields)

Kind: global function

Updates/adds a set of perks to the provided Tour. if batch is

provided, adds these to the provided <WriteBatch|Transaction> and returns a

chained <WriteBatch|Transaction>(tourStop, tour, batch) ⇒ Promise

Kind: global function
Returns: Promise - chanied Batch or Void (if singleton)

updateTourStopByChild(tourStopRecord, child, batch)

Kind: global function

modifySummary(summary, batch) ⇒ Promise

Saves an updated record. Assumes sourced from database; included fields are merged with database (allows changing single fields)

Kind: global function

pullInventory(tourStop, tickets) ⇒ Promise

Kind: global function

pushInventory(tourStop, tickets) ⇒ Promise

Kind: global function

formatItem

Props(thisItem, thisFormat) Allows string substitution from an object field names support Dot notation field names allow ":" extension for alternate formatting

Kind: global function

compare utility for sorting objects

Props(thisItem, anotherItem, sort) ⇒ string Kind: global function

generateIterator()

An Action Iterator Generator. Cycles through the entries in the passed array, yielding the result of a function for each entry. Only cares that inputs are an array, and a function that returns a promise

Kind: global function

largerOf(args) ⇒ number

Kind: global function
Returns: number - the least of any of the arguments

refPathToBaseRecord(refPath)

uses a passed refPath to create the most basic document record form

Kind: global function

bound(value, lowerBound, upperBound) ⇒ number

clips value to given bounds

Kind: global function

adds a new venue record to the database(venue, batch) ⇒ Promise

Kind: global function

returns a Promise which resolves to an array of all Artists whose

name begins with the provided prompt, optionally limited to a provided number(prompt, limit) ⇒ Promise.<VenueTypeArray> Kind: global function
Returns: Promise.<VenueTypeArray> - - array of venue objects

updatePerks

Updates/adds a set of perks to the provided Tour. if batch is provided, adds these to the provided <WriteBatch|Transaction> and returns a chained <WriteBatch|Transaction>(perks, tour) Kind: global function

updatePledgeLevels

Updates/adds a set of pledgeLevels to the provided TourStop. if batch is provided, adds these to the provided <WriteBatch|Transaction> and returns a

chained <WriteBatch|Transaction>(pledgeLevels, tourStop) ⇒ Promise

Kind: global function
Returns: Promise - chanied Batch or Void (if singleton)

updatePledgeTicket(pledgeTicket) ⇒ Promise(void)

updates an existing pledgeTicket

Kind: global function

deletePledgeTicket(pledgeTicket) ⇒ Promise(void)

deletes a pledgeTicket. Removed from summary in background

Kind: global function

serverCheckingIn(fullCheckin) ⇒ Promise.<T>

Server Cloud Functions are passed a single consolidated object that includes the pledgeTicket refPath

Kind: global function

createCheckIn(pledgeTicket, checkIn)

Takes a pledgeTicket Record (or at least refPath) and a checkin object; stores the image in the checkin as a file and adds the URL to said file to the checkin in the pledgeTicket.

Kind: global function

fetchTourStopPledgeSummary(tourStop) ⇒ PledgeSummary

Kind: global function
Returns: PledgeSummary - //count of tickets, sum of amounts

Properties

summarizePledgeTickets(pledgeTickets) ⇒ fanSummary

summarizes a group of pledgeTickets assumes all are for the same tourStop/event

Kind: global function

fetchFansTourStopPledgeSummary(fan, tourStop) ⇒ fanSummary

Kind: global function
Returns: fanSummary - fanSummary

fetchFansPledgeSummary(fan) ⇒ fanSummaryArray

Kind: global function
Returns: fanSummaryArray - fanSummary

fillPledgeTicket(pledgeTicket) ⇒ pledgeTicketType

Fills in complete info into a pledgeTicket: tourStop. perks, etc

Kind: global function

describePledgeTicket(pledgeTicket) ⇒ string

Creates a string describing a Tour Stop

Kind: global function

markPledgeTicket(pledgeTicket, label)

Changes the paidQ label on a pledgeTicket

Kind: global function

AddressType : object

Kind: global typedef
Properties

maplink : object

Kind: global typedef
Properties

ArtistFormType : object

Kind: global typedef
Properties

bandMember : object

Kind: global typedef
Properties

bookingOffer : object

Kind: global typedef
Properties

BusinessDefault : Record

Kind: global typedef
Properties

ChainType : WriteBatch | Transaction | void

Kind: global typedef

CityManagerType : object

Kind: global typedef
Properties

CityManagerDataDefault : Record

Kind: global typedef
Properties

FavoriteDefinition : Record

Kind: global typedef
Properties

FavoriteEntryDefinition : Record

Kind: global typedef
Properties

FavoriteEntryDefinitionArray : FavoriteEntryDefinition

Kind: global typedef

FavoriteListDefinition : Record

Kind: global typedef
Properties

MCCArray : object

Kind: global typedef
Properties

ArtistFormArray : ArtistFormType

Kind: global typedef

PersonObject : object

Kind: global typedef
Properties

Role : object

Kind: global typedef
Properties

RoleArray : Array:Role

Kind: global typedef

AccessOffer : object

Kind: global typedef
Properties

Access : object

This object is used to describe a user's access to an Artist's account. The user that creates an artist account is always given "Manager" access, filling in name, role and Id. A user can be invited to a role by assigning just Role and email - we will send the email inviting the user to our system (if they aren't already) They will then create a new user account if needed, and can find roles they've been invited to. When accepted, their name and Id will be copied to the access record.

Kind: global typedef
Properties

AccessesObject : object

Kind: global typedef
Properties

TourStopType : perkFormType

Kind: global typedef
Properties

LogisticsType : object

Kind: global typedef
Properties

TourFormType : perkFormType

Kind: global typedef
Properties

VenueType : string

Kind: global typedef
Properties

perkFormType : object

Kind: global typedef
Properties

perkFormTypeArray : perkFormType

Kind: global typedef

perkFormArray : perkFormType

Kind: global typedef

pledgeLevelFormType : object

Kind: global typedef
Properties

pledgeLevelFormArray : pledgeLevelFormType

Kind: global typedef

pledgeTicketType : checkinType

Kind: global typedef
Properties

checkinType : object

Kind: global typedef
Properties

fanSummary : perks

Kind: global typedef
Properties

.addTolineup(newBandmember, artist) ⇒ ArtistFormType

Kind: static function

.removeFromLineup(newBandmember, artist) ⇒ ArtistFormType

Kind: static function

.createCityManagerData(cityManager, manager, batch) ⇒ Promise

Kind: static function
Returns: Promise - WriteBatch, Transaction or Void

.updateUserAccess(accessItem, entity)

Kind: static function

.removeUserAccess(accessItem, entity)

Kind: static function

.createRole() ⇒ Role

Kind: static function
Returns: Role - result from the database operation Note the listener (below) will take care of updating the local copy

.fetchRoles() ⇒ RoleArray

Kind: static function

.normalizeAccess(accessItem)

Kind: static function

.unnormalizeAccess(accessItem)

Kind: static function

.fetchTourStopFromPledge(pledgeTicket, batch) ⇒ Promise.<DocumentObject>

Kind: static function

© 2020-2023 Tracy Hall