@leaddreamer/pricingbrowser v0.1.0-beta.1

@SaltSweetSpirits/PricingBrowser

Browser functions for the Pricing as a Service system, wrapped around pricinglogic and indirectly firebase-wrapper, for the Front End.

Modules

PricingBrowser

Browser functions for the Pricing as a Service system, wrapped around pricinglogic and indirectly firebase-wrapper, for the Front End.

• PricingBrowser
  • static
    • .startBrowser(config) ⇒ Promise
  • inner
    • ~FirebaseConfigObject : object

PricingBrowser.startBrowser(config) ⇒ Promise

starts the database and redux systems in the browser the client-specific firebase instance must be passed the client-specific config object must be passed Starts the database, and initiates the user authentication system Usually, but not always, started on launch

Kind: static method of PricingBrowser

PricingBrowser~FirebaseConfigObject : object

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

Kind: inner typedef of PricingBrowser
Properties

Browser

Browser-specific Event Services business logic and database operations

CloudCustomerPayment

Customer payment account cloud functions

• CloudCustomerPayment
  • static
    • .capturePaymentMethod(personId) ⇒ Promise.secret_object
    • .setFanCard(personId, PDSummary) ⇒ Promise.<void>
    • .deleteFanCard(personId, PDSummary) ⇒ Promise.<void>
  • inner
    • ~secret_object : object

CloudCustomerPayment.capturePaymentMethod(personId) ⇒ Promise.secret_object

Prepares to capture a payment method for a user

Kind: static method of CloudCustomerPayment
Returns: Promise.secret_object - - client secret

CloudCustomerPayment.setFanCard(personId, PDSummary) ⇒ Promise.<void>

Securely sets the particular paymentMethod as active

Kind: static method of CloudCustomerPayment

CloudCustomerPayment.deleteFanCard(personId, PDSummary) ⇒ Promise.<void>

Kind: static method of CloudCustomerPayment

CloudCustomerPayment~secret_object : object

Payment System "secret" for secure front-end

Kind: inner typedef of CloudCustomerPayment
Properties

CloudFunctions

Project specific Cloud functions

• CloudFunctions
  • static
    • .httpsOnCallSlipDates ⇒ Promise.boolean
    • .requestCancelPledge ⇒ Promise
    • .authClaims(user) ⇒ Promise.Credential
    • .changeCredential(credential) ⇒ Promise.<void>
    • .httpsOnCallCredentials(credential) ⇒ Promise
    • .httpsOnCallCreateAccounts(data) ⇒ Promise.PaymentAccount
    • .httpsOnCallOfferAccess(offer) ⇒ Promise
    • .httpsOnCallCheckIn(checkin) ⇒ Promise
    • .fixPledgeTicket(pledgeTicket) ⇒ Promise.secret_object
  • inner
    • ~Credential : object
    • ~AccountRequestData : object

CloudFunctions.httpsOnCallSlipDates ⇒ Promise.boolean

Admin/Test function to push all dated object "shiftDays" forward

Kind: static constant of CloudFunctions

CloudFunctions.requestCancelPledge ⇒ Promise

Request to cancel a pledgeTicket (needs payment check)

Kind: static constant of CloudFunctions

CloudFunctions.authClaims(user) ⇒ Promise.Credential

fetches our specific custom claim values from user Token

Kind: static method of CloudFunctions

CloudFunctions.changeCredential(credential) ⇒ Promise.<void>

use a "credential" object to add a new server-side role to a user

Kind: static method of CloudFunctions

CloudFunctions.httpsOnCallCredentials(credential) ⇒ Promise

Cloud function to set credentials object

Kind: static method of CloudFunctions

CloudFunctions.httpsOnCallCreateAccounts(data) ⇒ Promise.PaymentAccount

Securely creates an oganization account

Kind: static method of CloudFunctions

CloudFunctions.httpsOnCallOfferAccess(offer) ⇒ Promise

Cloud function for organizatin to offer user access control

Kind: static method of CloudFunctions

CloudFunctions.httpsOnCallCheckIn(checkin) ⇒ Promise

Cloud function to allow Organization to CheckIn a user/ticket to an event

Kind: static method of CloudFunctions

CloudFunctions.fixPledgeTicket(pledgeTicket) ⇒ Promise.secret_object

"Fix" a pledgeTicket - ie setup to take new payment

Kind: static method of CloudFunctions

CloudFunctions~Credential : object

Kind: inner typedef of CloudFunctions
Properties

CloudFunctions~AccountRequestData : object

Kind: inner typedef of CloudFunctions
Properties

Commodities

Typedefs, constants, support functions and database operations related to Commodity Materials Browser Support

Fundamentals

• Fundamentals
  • .ListenFundamentals() ⇒ callback
  • .ListenMCCs() ⇒ callback
  • .ListenBusinessTypes() ⇒ callback

Fundamentals.ListenFundamentals() ⇒ callback

A function that returns a function to attach as a listener, that returns a function to unsubscribe This a FAKE listener - only used to load data at start-up A function that "pretends" to be a listener, to maintain consistent structure Only loads at boot-up

Kind: static method of Fundamentals

Fundamentals.ListenMCCs() ⇒ callback

A function that returns a function to attach as a listener, that returns a function to unsubscribe A function that "pretends" to be a listener, to maintain consistent structure Only loads at boot-up

Kind: static method of Fundamentals

Fundamentals.ListenBusinessTypes() ⇒ callback

A function that returns a function to attach as a listener, that returns a function to unsubscribe A function that "pretends" to be a listener, to maintain consistent structure Only loads at boot-up

Kind: static method of Fundamentals

Images

basic Redux/Database functions for images

• Images
  • .setDefaultImage() ⇒ callback
  • .setDefaultBanner() ⇒ callback
  • .setDefaultLoading() ⇒ callback
  • .pullURLFromRecord(record, key) ⇒ Promise.string
  • .accessibleStorage(URL) ⇒ Promise.<URL>

Images.setDefaultImage() ⇒ callback

Fires off an async closure to get and set image. Could be thunk?

Kind: static method of Images

Images.setDefaultBanner() ⇒ callback

Fires off an async closure to get and set image. Could be thunk?

Kind: static method of Images

Images.setDefaultLoading() ⇒ callback

Fires off an async closure to get and set loading. Could be thunk?

Kind: static method of Images

Images.pullURLFromRecord(record, key) ⇒ Promise.string

This Utility checks if a full URL needs to be built. Image data can be => a tokenized URL, by definition public => a "private", secured URL => a filename, assumed to be stored in a structure parallel to the record path

Kind: static method of Images
Fulfil: string a "private" URL to access the file.
Reject: string

Images.accessibleStorage(URL) ⇒ Promise.<URL>

This Utility checks if URL is Secured by Storage Security Rules If the URL carries an access token, it is simply returned. If the URL does NOT have an access token, it is fetched to local stoage with authentication, and a new URL created to point to the local copy.

Kind: static method of Images
Fulfil: string a local URL to access the downloaded data
Reject: string

LineItem

Typedefs, constants, support functions and database operations related to Commodity Materials Browser Support

Payment

People

• People
  • .setClaims(newClaims) ⇒ ActionItem
  • .makeActivePerson(user) ⇒ Promise
  • .retireActivePerson() ⇒ Promise
  • .ListenPerson(user) ⇒ callback
  • .savePerson(person) ⇒ Promise
  • .savePayment(person, payment_object) ⇒ Promise
  • .CreateAnonymousFan() ⇒ Promise
  • .InitAuthListener() ⇒ callback
  • .signInSuccessWithAuthResult(authResult, redirectURL) ⇒ boolean

People.setClaims(newClaims) ⇒ ActionItem

Sets the various Redux states for all claims currently active

Kind: static method of People

People.makeActivePerson(user) ⇒ Promise

takes an authenticated user and builds the appropriate ActivePeron in the Redux store

Kind: static method of People

People.retireActivePerson() ⇒ Promise

Removes Redux records and authentication for current User

Kind: static method of People

People.ListenPerson(user) ⇒ callback

returns the unsubscribe function; will be called AT LEAST ONCE with initial document

Kind: static method of People
Returns: callback - unsubscribe function

People.savePerson(person) ⇒ Promise

Saves an (updated) PersonObject back to Database Store

Kind: static method of People

People.savePayment(person, payment_object) ⇒ Promise

Saves an (updated) PaymentObject to a specified PersonObject back to Database Store

Kind: static method of People

People.CreateAnonymousFan() ⇒ Promise

calls authentication service. Listener (below) responds to status change

Kind: static method of People

People.InitAuthListener() ⇒ callback

Starts the authentication system with status listener

Kind: static method of People
Returns: callback - unsubscribe

People.signInSuccessWithAuthResult(authResult, redirectURL) ⇒ boolean

Dummt functin for auth UI. We use Async listeners to accomplish the related functions

Kind: static method of People

Product

Typedefs, constants, support functions and database operations related to Commodity Materials Browser Support

Stages

Browser support functions for "stages" Stages are Top-level (System-wide defaults), OR User-level (individual business/craftperson defaults), OR Product=level (User selected exceptions for a particular Product)

• Stages
  • .fetchStages() ⇒ Array.Stage
  • .fetchStage(stageId) ⇒ Stage
  • .ListenStages(parent) ⇒ callback

Stages.fetchStages() ⇒ Array.Stage

Kind: static method of Stages

Stages.fetchStage(stageId) ⇒ Stage

Fetch a single Stage from the store by Id

Kind: static method of Stages

Stages.ListenStages(parent) ⇒ callback

Kind: static method of Stages
Returns: callback - unsubscribe function

Utilities

Utility Browser support functions

• Utilities
  • static
    • .fetchLinkedItem(type, link, refPath) ⇒ Promise.RecordDocument
    • .fetchSubItem(type, refPath) ⇒ Promise.RecordDocument
    • .fetchType(type, refPath) ⇒ Promise.Array.RecordDocument
    • .selectAccountData(state, type)
    • .searchType(type, prompt, limit) ⇒ Promise.<HostArray>
    • .processTarget(target) ⇒ object
    • .processItemType(item, type, refPath) ⇒ Promise.RecordDocument
    • .formatLinkedItem(link, type, refPath) ⇒ Promise.string
    • .summarizeItem(item, type) ⇒ string
    • .findIconName(url) ⇒ string
    • .typedSortArray(type) ⇒ Array.SortObject
  • inner
    • ~stripDocIdFromRefPath(refPath) ⇒ string
    • ~HostArray : ArtistFormType | VenueType

Utilities.fetchLinkedItem(type, link, refPath) ⇒ Promise.RecordDocument

used generic for constructing forms for input and display

Kind: static method of Utilities

Utilities.fetchSubItem(type, refPath) ⇒ Promise.RecordDocument

some items are stored in the database as a single-record collection, using the same Id as the parent

Kind: static method of Utilities

Utilities.fetchType(type, refPath) ⇒ Promise.Array.RecordDocument

returns an entire sub-collection by "type" (sub-collection name). If refpath is omitted, assumes "type" is a top-level collection

Kind: static method of Utilities

Utilities.selectAccountData(state, type)

parameterized selector

Kind: static method of Utilities

Utilities.searchType(type, prompt, limit) ⇒ Promise.<HostArray>

This function is a parameterized selector

Kind: static method of Utilities
Returns: Promise.<HostArray> - - returns an array of results, up to limit

Utilities.processTarget(target) ⇒ object

Generic synchronous form processing function - handles values and returns results as a keyed object

Kind: static method of Utilities

Utilities.processItemType(item, type, refPath) ⇒ Promise.RecordDocument

generic form data processing for database by "type" (collection name)

Kind: static method of Utilities

Utilities.formatLinkedItem(link, type, refPath) ⇒ Promise.string

fetches a sub-record from the database and returns the result as a summary string

Kind: static method of Utilities

Utilities.summarizeItem(item, type) ⇒ string

parameterized function to return string summary of an object By default, returns the "name" property of the item.

Kind: static method of Utilities

Utilities.findIconName(url) ⇒ string

Hacky way to match Icons to urlLowerCase

Kind: static method of Utilities

Utilities.typedSortArray(type) ⇒ Array.SortObject

Firebase query support - builds default sort options

Kind: static method of Utilities

Utilities~stripDocIdFromRefPath(refPath) ⇒ string

pulls the document Id from a passed refPath string (firebase dependent)

Kind: inner method of Utilities
Returns: string - Id

Utilities~HostArray : ArtistFormType | VenueType

Kind: inner typedef of Utilities

Boilerplate

Boilerplate and generic constants and functions for browser Support

• Boilerplate
  • static
    • .subscriberGenerator(sliceName, tableName, filterArray, sortArray, reference, atRoot, transformer) ⇒ string
    • .singleRecord(records) ⇒ Record
  • inner
    • ~ListenGenerator(sliceName, tableName, filterArray, sortArray, transformer) ⇒ callback
    • ~ListenShallowGenerator(sliceName, tableName, filterArray, sortArray, reference, transformer) ⇒ callback

Boilerplate.subscriberGenerator(sliceName, tableName, filterArray, sortArray, reference, atRoot, transformer) ⇒ string

Sets up a listener, and starts it running, in the Listener Store SYNCHRONOUS

Kind: static method of Boilerplate
Returns: string - listenerStore slot key

Boilerplate.singleRecord(records) ⇒ Record

Some "collections" only have a signle record. This transformer simply returns the FIRST item in the collection array.

Kind: static method of Boilerplate

Boilerplate~ListenGenerator(sliceName, tableName, filterArray, sortArray, transformer) ⇒ callback

Sets up a listener for the Listener Store Assumes a CollectionGroup query

Kind: inner method of Boilerplate
Returns: callback - unsubscribe function

Boilerplate~ListenShallowGenerator(sliceName, tableName, filterArray, sortArray, reference, transformer) ⇒ callback

Sets up a listener for the Listener Store Assumes a simple Collection query

Kind: inner method of Boilerplate
Returns: callback - unsubscribe function

Constants

Browser access and themeing constants

• Constants
  • static
    • .COMPANY_NAME
    • .TWITTER_ACCOUNT
    • .FACEBOOK_ACCOUNT
    • .INSTAGRAM_ACCOUNT
    • .LINKEDIN_ACCOUNT
    • .EMAIL_ACCOUNT
    • .PAYMENT_THEME
    • .CANCELED_EVENT
    • .UNBOOKED
    • .UNBOOKED_EVENT
    • .OPEN
    • .OPEN_OFFER
    • .WORKING
    • .WORKING_OFFER
    • .BOOKED
    • .BOOKED_EVENT
    • .SHOWS_EVENT
    • .TOUR
    • .INITIAL_SHOW_COUNT
    • .NATION_ZOOM
    • .REGION_ZOOM
    • .VENUE_ZOOM
    • .LABELSTYLE
    • .REGION_MARKER
    • .labelStyle
    • .set_theme()
  • inner
    • ~pricing_constants
    • ~pricing_dark
    • ~themes

Constants.COMPANY_NAME

variable for shared Company Name

Kind: static property of Constants

Constants.TWITTER_ACCOUNT

variable for shared Twitter Name

Kind: static property of Constants

Constants.FACEBOOK_ACCOUNT

variable for shared Facebook Name

Kind: static property of Constants

Constants.INSTAGRAM_ACCOUNT

variable for shared Instagram Name

Kind: static property of Constants

Constants.LINKEDIN_ACCOUNT

variable for shared LinkedIn Name

Kind: static property of Constants

Constants.EMAIL_ACCOUNT

variable for shared Email Name

Kind: static property of Constants

Constants.PAYMENT_THEME

variable for shared Payment Name

Kind: static property of Constants

Constants.CANCELED_EVENT

Kind: static constant of Constants
Default: "Show Canceled"

Constants.UNBOOKED

Kind: static constant of Constants
Default: "unbooked"

Constants.UNBOOKED_EVENT

Kind: static constant of Constants
Default: "Tour Stop"

Constants.OPEN

Kind: static constant of Constants
Default: "open"

Constants.OPEN_OFFER

Kind: static constant of Constants
Default: "open"

Constants.WORKING

Kind: static constant of Constants
Default: "working"

Constants.WORKING_OFFER

Kind: static constant of Constants
Default: "working"

Constants.BOOKED

Kind: static constant of Constants
Default: "booked"

Constants.BOOKED_EVENT

Kind: static constant of Constants
Default: "Show"

Constants.SHOWS_EVENT

Kind: static constant of Constants
Default: "Show"

Constants.TOUR

Kind: static constant of Constants
Default: "tour"

Constants.INITIAL_SHOW_COUNT

Kind: static constant of Constants
Default: 5

Constants.NATION_ZOOM

Kind: static constant of Constants
Default: 3

Constants.REGION_ZOOM

Kind: static constant of Constants
Default: 10

Constants.VENUE_ZOOM

Kind: static constant of Constants
Default: 18

Constants.LABELSTYLE

Kind: static constant of Constants

Constants.REGION_MARKER

Kind: static constant of Constants
Default: BLUE_MARKER

Constants.labelStyle

Kind: static constant of Constants

Constants.set_theme()

Sets the theme to default/current values

Kind: static method of Constants

Constants~pricing_constants

Kind: inner constant of Constants
Default: {"company_name":"Pricing","twitter_account":"Pricing","facebook_account":"Pricing","instagram_account":"Pricing","linkedin_account":"Pricing","email_account":"info@Pricing.com","logoFont":"Roboto","titleFont":"Roboto","themeFont":"Nunito","themeBackgroundColor":"#ccbebe","themeColor":"#181818","themeAccent":"#726b6b","themeShadows":"#d7ecfa","ThemeDarkColor":"#8a8a8a","themeBorderColor":"#cacaca","themeReverse":"#fefefe","themeReverseText":"#181818","palePrimaryColor":"#d7ecfa","secondaryColor":"#767676","paleSecondaryColor":"#eaeaea","successColor":"#3adb76","paleSuccessColor":"#e1faea","warningColor":"#ffae00","paleWarningColor":"#fff3d9","alertColor":"#cc4b37","paleAlertColor":"#f9ecea","themeBooked":"goldenrod","themeUnbooked":"blue","themeOpen":"green","themeWorking":"orange","themePledge":"green","themeTicket":"FireBrick","themeTour":"black","paymentTheme":"stripe"}

Constants~pricing_dark

Kind: inner constant of Constants
Default: {"company_name":"Pricing","twitter_account":"Pricing","facebook_account":"Pricing","instagram_account":"Pricing","linkedin_account":"Pricing","email_account":"info@Pricing.com","logoFont":"Roboto","titleFont":"Roboto","themeFont":"Nunito","themeBackgroundColor":"#181818","themeAccent":"#606060","themeColor":"#efefef","themeShadows":"#d7ecfa","ThemeDarkColor":"#8a8a8a","themeBorderColor":"#cacaca","themeReverse":"#fefefe","themeReverseText":"#181818","palePrimaryColor":"#606060","secondaryColor":"#767676","paleSecondaryColor":"#eaeaea","successColor":"#3adb76","paleSuccessColor":"#e1faea","warningColor":"#ffae00","paleWarningColor":"#fff3d9","alertColor":"#cc4b37","paleAlertColor":"#f9ecea","themeBooked":"goldenrod","themeUnbooked":"blue","themeOpen":"green","themeWorking":"orange","themePledge":"green","themeTicket":"FireBrick","themeTour":"black","paymentTheme":"night"}

Constants~themes

Kind: inner constant of Constants
Default: "pricing_dark","pricing_constants"

ReduxStore

Redux Store and State modules

FundamentalsRedux

ImagesRedux

PaymentRedux

PeopleRedux

StagesRedux

StagesActions

• StagesActions
  • .LOAD_STAGES
  • .loadStages(stages) ⇒ ActionItem
  • .updateStages(stages) ⇒ ActionItem
  • .stagesList() ⇒ Array.Stage
  • .selectSkills(state) ⇒ Array.Stage

StagesActions.LOAD_STAGES

Kind: static constant of StagesActions
Default: "LOAD_STAGES"

StagesActions.loadStages(stages) ⇒ ActionItem

Returns an ActionItem

Kind: static method of StagesActions

StagesActions.updateStages(stages) ⇒ ActionItem

Creates and Dispathes an ActionItem

Kind: static method of StagesActions

StagesActions.stagesList() ⇒ Array.Stage

Kind: static method of StagesActions

StagesActions.selectSkills(state) ⇒ Array.Stage

Kind: static method of StagesActions

FundamentalsReducer

• FundamentalsReducer
  • module.exports(state, action) ⇒ ReduxSlice ⏏
    • ~InitialState

module.exports(state, action) ⇒ ReduxSlice ⏏

reducer

Kind: Exported function

module.exports~InitialState

Kind: inner constant of module.exports
Default: {}

ImagesReducer

• ImagesReducer
  • module.exports(state, action) ⇒ ReduxSlice ⏏
    • ~InitialState

module.exports(state, action) ⇒ ReduxSlice ⏏

reducer

Kind: Exported function

module.exports~InitialState

Kind: inner constant of module.exports
Default: {"image":null,"banner":null,"loading":null}

PaymentReducer

module.exports(state, action) ⇒ ReduxSlice ⏏

reducer

Kind: Exported function

PeopleReducer

module.exports(state, action) ⇒ ReduxSlice ⏏

reducer

Kind: Exported function

StagesReducer

module.exports(state, action) ⇒ ReduxSlice ⏏

reducer

Kind: Exported function

© 2020-2024 Tracy Hall