@leaddreamer/esbrowser v0.1.0-beta.60

@SaltSweetSpirits/ESBrowser

Browser functions for the Event Services system, wrapped around ESBusiness and indirectly firebase-wrapper, for the Front End.

Modules

Functions

ESBrowser

Browser functions for the Event Services system, wrapped around ESBusiness and indirectly firebase-wrapper, for the Front End.

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

ESBrowser.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 passes Starts the database, and initiates the user authentication system

Kind: static method of ESBrowser

ESBrowser~FirebaseConfigObject : object

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

Kind: inner typedef of ESBrowser
Properties

Browser

Browser-specific Event Services business logic and database operations

Campaigns

Business and Database support functions for the Browser

Campaigns.listenCampaigns(organization, dataCallBack, errCallBack) ⇒ callback

Sets up a listener for all the Campaigns for a particular Organization

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

CityManager

CityManager browser support operations

• CityManager
  • static
    • .subscribeCityManager ⇒ string
    • .createCityManagerAccount(cityManagerForm) ⇒ Promise.Credential
    • .loginCityManager(cityManager_roles) ⇒ Promise.Credential
    • .logoutCityManager() ⇒ Promise.Credential
    • .makeActiveCityManager(cityManager_role) ⇒ Promise.<null>
    • .retireActiveCityManager() ⇒ ActionItem
    • .listenCityManager(uid) ⇒ callback
  • inner
    • ~disableCityManager() ⇒ null

CityManager.subscribeCityManager ⇒ string

Sets up CityManager listeners and populates City Manager role in Redux Surprisingly, entirely synchronous with async side effects

Kind: static constant of CityManager
Returns: string - key to listener store for cityManager listener

CityManager.createCityManagerAccount(cityManagerForm) ⇒ Promise.Credential

Makes a call to the backend to have an artist account created. (security requires this to be done ina secure environment)

Kind: static method of CityManager

CityManager.loginCityManager(cityManager_roles) ⇒ Promise.Credential

Kind: static method of CityManager

CityManager.logoutCityManager() ⇒ Promise.Credential

Disables the local (client) CityManager, and removes the CityManager credential. All other logout activity is async

Kind: static method of CityManager

CityManager.makeActiveCityManager(cityManager_role) ⇒ Promise.<null>

accepts the selected "cityManager_role" and uses it to login & setup control of the indicated CityManager account.

Kind: static method of CityManager

CityManager.retireActiveCityManager() ⇒ ActionItem

Runs all unsubscribes and disables cityManager settings in Redux store. Entirely Synchronous (with possible async side effects)

Kind: static method of CityManager

CityManager.listenCityManager(uid) ⇒ callback

Sets up a listener specifically to the Redux store; returns the unsubscribe function will be called AT LEAST ONCE with initial document

Kind: static method of CityManager
Returns: callback - an unsubscribe function

CityManager~disableCityManager() ⇒ null

disables the active CityManager in the client (no credential change)

Kind: inner method of CityManager

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

CloudEvents

Event support Cloud Functions

• CloudEvents
  • .httpsOnCallCreateLocalEvent(event) ⇒ Promise.<void>
  • .confirmEvent(eventId) ⇒ Promise.<void>
  • .fixEventSummary(eventId) ⇒ Promise.<void>
  • .cancelEvent(eventId) ⇒ Promise.<void>

CloudEvents.httpsOnCallCreateLocalEvent(event) ⇒ Promise.<void>

Creates an event from scratch by an organization

Kind: static method of CloudEvents

CloudEvents.confirmEvent(eventId) ⇒ Promise.<void>

This function verifies credentials (cityManager of correct region for event), calculates the correct artist/venue shares, then initiates the required transfers to accounts connected to artist/venue. Receipts (on success) will be attached to artist/venue by webhook. Note security checks are at SERVER/CLOUD FUNCTION. Note this function STARTS the process (marks the event) - the BACKEND executes the operation asynchronously to not delay FRONTEND

Kind: static method of CloudEvents
Returns: Promise.<void> - - does NOT necessarily mean it succeeded.

CloudEvents.fixEventSummary(eventId) ⇒ Promise.<void>

This function re-calculates the summary (from pledgeTickets) for a event.

Kind: static method of CloudEvents
Returns: Promise.<void> - - does NOT necessarily mean it succeeded.

CloudEvents.cancelEvent(eventId) ⇒ Promise.<void>

This function verifies credentials (cityManager of correct region for event), marks each pledgeTicket and corresponding receipt as REFUNDING then issues a refund through the payment system on all charges. Note security checks are at SERVER/CLOUD FUNCTION Note this function STARTS the process (marks the event) - the BACKEND executes the operation asynchronously to not delay FRONTEND

Kind: static method of CloudEvents
Returns: Promise.<void> - - does NOT necessarily mean it succeeded.

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

CloudPaymentProcessing

Cloud Functions to secure manage paymentProcessing accounts

• CloudPaymentProcessing
  • .accountStatus ⇒ Promise.AccountStatus
  • .onboardAccount(accountObject) ⇒ Promise.AccountStatus

CloudPaymentProcessing.accountStatus ⇒ Promise.AccountStatus

Cloud function to check PaymentProcessor account status

Kind: static constant of CloudPaymentProcessing

CloudPaymentProcessing.onboardAccount(accountObject) ⇒ Promise.AccountStatus

Cloud function to onboard a paymentProcessor account

Kind: static method of CloudPaymentProcessing

Events

• Events
  • .ListenEvents(campaign, dataCallBack, errCallBack) ⇒ callback
  • .ListenListing(organization, dataCallback, errCallback, startDate) ⇒ callback
  • .ListenOrganizationEvents(organization, dataCallback, errCallback, startDate) ⇒ callback
  • .ListenOrganizationCounterEvents(organization, dataCallback, errCallback, startDate) ⇒ callback
  • .ListenOrganizationShows(organization, dataCallback, errCallback) ⇒ callback
  • .ListenOrganizationCounterShows(organization, dataCallback, errCallback) ⇒ callback

Events.ListenEvents(campaign, dataCallBack, errCallBack) ⇒ callback

Sets up a listener for all the Events for a particular Campaign

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

Events.ListenListing(organization, dataCallback, errCallback, startDate) ⇒ callback

Listener for Organization Owner shows (after a certain date)

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

Events.ListenOrganizationEvents(organization, dataCallback, errCallback, startDate) ⇒ callback

Listener for Organization Owner shows (after a certain date)

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

Events.ListenOrganizationCounterEvents(organization, dataCallback, errCallback, startDate) ⇒ callback

Listener for Organization Counter events (after a certain date)

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

Events.ListenOrganizationShows(organization, dataCallback, errCallback) ⇒ callback

Listener for Organization Owner shows (booked events)

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

Events.ListenOrganizationCounterShows(organization, dataCallback, errCallback) ⇒ callback

Listener for Organization counter shows (booked events)

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

Favorites

Intended for managing Fan favorites. Unfinished

Favorites.favoritesMapMaker(favoriteRecords) ⇒ Map

transforms array into keyed Map()

Kind: static method of Favorites

Fundamentals

• Fundamentals
  • .ListenFundamentals() ⇒ callback
  • .ListenMCCs() ⇒ 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

Genres

Database handling functions for Genres

• Genres
  • static
    • .fetchGenres() ⇒ Array.GenreObject
    • .fetchGenre(genreID) ⇒ GenreObject
    • .fetchFormattedGenre(genreID) ⇒ GenreObject
  • inner
    • ~ListenGenres() ⇒ callback

Genres.fetchGenres() ⇒ Array.GenreObject

Kind: static method of Genres

Genres.fetchGenre(genreID) ⇒ GenreObject

Fetch a single GenreObject from the store by Id

Kind: static method of Genres

Genres.fetchFormattedGenre(genreID) ⇒ GenreObject

Fetch a single GenreObject from the store by Id and returns as formatted string

Kind: static method of Genres

Genres~ListenGenres() ⇒ callback

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

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

Organizations

Browser-specific Business logic and database operations

• Organizations
  • .createOrganizationAccount(organizationForm) ⇒ Promise
  • .loginOrganization(organization_role) ⇒ Promise
  • .logoutOrganization() ⇒ Promise
  • .makeActiveOrganization(organization_role) ⇒ Promise.<void>
  • .retireActiveOrganization() ⇒ void
  • .subscribeOrganization(organizationID) ⇒ string
  • .listenOrganization(uid) ⇒ callback
  • .disableOrganization() ⇒ void
  • .listenOrganizations(dataCallback, errCallback) ⇒ callback
  • .listenOrganizationsPaginated(dataCallback, errCallback, pageSize, optional) ⇒ PaginatedListener

Organizations.createOrganizationAccount(organizationForm) ⇒ Promise

Makes a call to the backend to have an organization account created. (security requires this to be done in a secure environment)

Kind: static method of Organizations

Organizations.loginOrganization(organization_role) ⇒ Promise

"login" to control of managed organization in specified role

Kind: static method of Organizations

Organizations.logoutOrganization() ⇒ Promise

Kind: static method of Organizations

Organizations.makeActiveOrganization(organization_role) ⇒ Promise.<void>

accepts the selected "organization_role" and uses it login & setup control of the indicated organization.

Kind: static method of Organizations

Organizations.retireActiveOrganization() ⇒ void

marks the current actiively managed organization to be "retired" This STARTS the action - it does not complete initial

Kind: static method of Organizations

Organizations.subscribeOrganization(organizationID) ⇒ string

Sets up a listener/subscriber object in the Store for a specified organization

Kind: static method of Organizations
Returns: string - the key where this listener was stored in the listener strcuture

Organizations.listenOrganization(uid) ⇒ callback

Sets up a listener specifically to the Redux store returns the unsubscribe function; will be called AT LEAST ONCE with initial document

Kind: static method of Organizations
Returns: callback - an unsubscribe function

Organizations.disableOrganization() ⇒ void

Dispatches the action to disable management of the currently managed organization

Kind: static method of Organizations

Organizations.listenOrganizations(dataCallback, errCallback) ⇒ callback

Sets up and returns a listener object for ALL organization records. Not very useful

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

Organizations.listenOrganizationsPaginated(dataCallback, errCallback, pageSize, optional) ⇒ PaginatedListener

Sets up and returns a paginated listener object for organization records. Allows paging through large number of records, while listenming for changes

Kind: static method of Organizations
Returns: PaginatedListener - Paginated Listener Class object

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

Regions

• Regions
  • .fetchRegions() ⇒ Array.RegionType
  • .fetchRegion() ⇒ RegionType
  • .fetchFormattedRegion() ⇒ string
  • .ListenRegions() ⇒ callback

Regions.fetchRegions() ⇒ Array.RegionType

returns an array of Region Objects (or err)

Kind: static method of Regions

Regions.fetchRegion() ⇒ RegionType

Returns specified RegionObject

Kind: static method of Regions

Regions.fetchFormattedRegion() ⇒ string

Returns specified RegionObject as a formatted string

Kind: static method of Regions
Returns: string - formatted Region

Regions.ListenRegions() ⇒ callback

Kind: static method of Regions

Roles

• Roles
  • .ListenRoles() ⇒ callback
  • .offerAccess(parent, offer) ⇒ Promise

Roles.ListenRoles() ⇒ callback

Kind: static method of Roles

Roles.offerAccess(parent, offer) ⇒ Promise

Kind: static method of Roles

Skills

• Skills
  • .fetchFormattedSkill ⇒ SkillObject
  • .fetchSkills() ⇒ Array.SkillObject
  • .fetchSkill(skillID) ⇒ SkillObject
  • .ListenSkills() ⇒ callback

Skills.fetchFormattedSkill ⇒ SkillObject

Fetch a single SkillObject from the store by Id and returns as formatted string

Kind: static constant of Skills

Skills.fetchSkills() ⇒ Array.SkillObject

Kind: static method of Skills

Skills.fetchSkill(skillID) ⇒ SkillObject

Fetch a single SkillObject from the store by Id

Kind: static method of Skills

Skills.ListenSkills() ⇒ callback

Kind: static method of Skills
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
  • 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~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()
    • .editInPlaceSelectStyles()
  • inner
    • ~saltsweetspirits_constants
    • ~saltsweetspirits_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.editInPlaceSelectStyles()

Edit In Place constants all the below accomplishes a "select-in-place"

Kind: static method of Constants

Constants~saltsweetspirits_constants

Kind: inner constant of Constants
Default: {"company_name":"SaltSweetSpirits","twitter_account":"SaltSweetSpirits","facebook_account":"SaltSweetSpirits","instagram_account":"SaltSweetSpirits","linkedin_account":"SaltSweetSpirits","email_account":"info@SaltSweetSpirits.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~saltsweetspirits_dark

Kind: inner constant of Constants
Default: {"company_name":"SaltSweetSpirits","twitter_account":"SaltSweetSpirits","facebook_account":"SaltSweetSpirits","instagram_account":"SaltSweetSpirits","linkedin_account":"SaltSweetSpirits","email_account":"info@SaltSweetSpirits.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: "saltsweetspirits_dark","saltsweetspirits_constants"

PledgeTickets

• PledgeTickets
  • .listenPledgeTickets(event, dataCallback, errCallback) ⇒ callback
  • .browserCheckIn(pledgeTicket, newCheckIn) ⇒ Promise

PledgeTickets.listenPledgeTickets(event, dataCallback, errCallback) ⇒ callback

Attaches a listener to the event's pledgetickets (if any) returns the unsubscribe function; will be called AT LEAST ONCE with initial document

Kind: static method of PledgeTickets
Returns: callback - a unsubscribe function to dismiss the listener

PledgeTickets.browserCheckIn(pledgeTicket, newCheckIn) ⇒ Promise

Calls Function Server to securely create a CheckIn

Kind: static method of PledgeTickets

ConfigureStore

Customzied Redux Store and support - legacy naming

• ConfigureStore
  • static
    • .store : ReduxStore
  • inner
    • ~asyncReducers : object
    • ~listeners : object
    • ~injectReducer(key, asyncReducer)
    • ~injectListener(key, listener, deleteOnSub)
    • ~runListener(key)
    • ~deferred()
    • ~unsubscribeListeners()
    • ~createReducer(asyncReducers)
    • ~ReduxStore : object

ConfigureStore.store : ReduxStore

Kind: static constant of ConfigureStore

ConfigureStore~asyncReducers : object

Initializes a dictionary to keep track of the registered async reducers

Kind: inner property of ConfigureStore

ConfigureStore~listeners : object

Initializes a dictionary to keep track of registered defered inits

Kind: inner property of ConfigureStore

ConfigureStore~injectReducer(key, asyncReducer)

Kind: inner method of ConfigureStore

ConfigureStore~injectListener(key, listener, deleteOnSub)

Kind: inner method of ConfigureStore

ConfigureStore~runListener(key)

Runs a specific listener by Key

Kind: inner method of ConfigureStore

ConfigureStore~deferred()

Runs all defered listeners

Kind: inner method of ConfigureStore

ConfigureStore~unsubscribeListeners()

Calls all listener's unsubscribe functions

Kind: inner method of ConfigureStore

ConfigureStore~createReducer(asyncReducers)

takes an array of reducers (possibly async) and returns a single reducer structure

Kind: inner method of ConfigureStore

ConfigureStore~ReduxStore : object

Kind: inner typedef of ConfigureStore

ReduxStore

Redux Store and State modules

CampaignsRedux

Redux slice

CityManagerRedux

CityManager Redux store & actions

FundamentalsRedux

GenresRedux

ImagesRedux

OrganizationRedux

Organization Redux store & actions

PaymentRedux

PeopleRedux

RegionsRedux

RolesRedux

SkillsRedux

BoilerplateRedux

Generic Redux functions and constants

• BoilerplateRedux
  • static
    • .setGeneric ⇒ ActionItem
    • .BROWSINGDATE
    • .genericReduxAction(sliceName, specific, payload) ⇒ ActionItem
    • .selectGeneric(state, sliceName, which)
    • .getGeneric(sliceName, which)
  • inner
    • ~ActionItem : object

BoilerplateRedux.setGeneric ⇒ ActionItem

Creates and dispatches an ActionItem based on the "slice" name, specific action type, and payload

Kind: static constant of BoilerplateRedux

BoilerplateRedux.BROWSINGDATE

Kind: static constant of BoilerplateRedux

BoilerplateRedux.genericReduxAction(sliceName, specific, payload) ⇒ ActionItem

Creates and returns an ActionItem based on the "slice" name, specific action type, and payload

Kind: static method of BoilerplateRedux

BoilerplateRedux.selectGeneric(state, sliceName, which)

gets Redux information by "slice" (really, which reducer) and "which" (table name) Synchronous to state changes

Kind: static method of BoilerplateRedux

BoilerplateRedux.getGeneric(sliceName, which)

gets Redux information by "slice" (really, which reducer) and "which" (table name) Asynchronous to state changes

Kind: static method of BoilerplateRedux

BoilerplateRedux~ActionItem : object

Kind: inner typedef of BoilerplateRedux
Properties

CampaignsActions

Action Support

• CampaignsActions
  • .SET_CAMPAIGNS
  • .setCampaigns(campaigns) ⇒ ActionObject

CampaignsActions.SET_CAMPAIGNS

Kind: static constant of CampaignsActions

CampaignsActions.setCampaigns(campaigns) ⇒ ActionObject

action function to store campaigns in Reducer

Kind: static method of CampaignsActions

CityManagerActions

CityManager Redux actions

• CityManagerActions
  • .SET_ACTIVE_CITYMANAGER
  • .CREATE_NEW_CITYMANAGER
  • .CREATE_NEW_AND_USE_CITYMANAGER
  • .ADD_CITYMANAGER
  • .REPLACE_CITYMANAGER
  • .SAVE_CITYMANAGER
  • .CLEAR_CITYMANAGER
  • .CITYMANAGER_REDUCER
  • .CITYMANAGER_EVENTS
  • .setActiveCityManagerAction(cityManager) ⇒ ActionItem
  • .setActiveCityManager(organization) ⇒ ActionItem
  • .setCityManagerInflight(inflight) ⇒ ActionItem
  • .getCityManagerInflight(state) ⇒ boolean
  • .fetchCityManagerInflight() ⇒ boolean
  • .getActiveCityManager(state) ⇒ CityManagerType

CityManagerActions.SET_ACTIVE_CITYMANAGER

Kind: static constant of CityManagerActions
Default: "SET_ACTIVE_CITYMANAGER"

CityManagerActions.CREATE_NEW_CITYMANAGER

Kind: static constant of CityManagerActions
Default: "CREATE_NEW_CITYMANAGER"

CityManagerActions.CREATE_NEW_AND_USE_CITYMANAGER

Kind: static constant of CityManagerActions
Default: "CREATE_NEW_AND_USE_CITYMANAGER"

CityManagerActions.ADD_CITYMANAGER

Kind: static constant of CityManagerActions
Default: "ADD_CITYMANAGER"

CityManagerActions.REPLACE_CITYMANAGER

Kind: static constant of CityManagerActions
Default: "REPLACE_CITYMANAGER"

CityManagerActions.SAVE_CITYMANAGER

Kind: static constant of CityManagerActions
Default: "SAVE_CITYMANAGER"

CityManagerActions.CLEAR_CITYMANAGER

Kind: static constant of CityManagerActions
Default: "CLEAR_CITYMANAGER"

CityManagerActions.CITYMANAGER_REDUCER

Kind: static constant of CityManagerActions
Default: CITYMANAGER

CityManagerActions.CITYMANAGER_EVENTS

Kind: static constant of CityManagerActions
Default: "Events"

CityManagerActions.setActiveCityManagerAction(cityManager) ⇒ ActionItem

Kind: static method of CityManagerActions

CityManagerActions.setActiveCityManager(organization) ⇒ ActionItem

Creates and dispatches the action

Kind: static method of CityManagerActions

CityManagerActions.setCityManagerInflight(inflight) ⇒ ActionItem

Creates and dispatches the cityManager update inflight status

Kind: static method of CityManagerActions

CityManagerActions.getCityManagerInflight(state) ⇒ boolean

Retrieves the item from synchronous passed (i.e. active) state

Kind: static method of CityManagerActions

CityManagerActions.fetchCityManagerInflight() ⇒ boolean

reads the item from current state. Asynchronous to state changes

Kind: static method of CityManagerActions

CityManagerActions.getActiveCityManager(state) ⇒ CityManagerType

Retrieves the item from synchronous passed (i.e. active) state

Kind: static method of CityManagerActions

GenresActions

• GenresActions
  • .LOAD_GENRES
  • .loadGenres(genres) ⇒ ActionItem
  • .updateGenres(genres) ⇒ ActionItem
  • .genreList() ⇒ Array.GenreObject
  • .selectGenres(state) ⇒ Array.GenreObject

GenresActions.LOAD_GENRES

Kind: static constant of GenresActions
Default: "LOAD_GENRES"

GenresActions.loadGenres(genres) ⇒ ActionItem

creates a loadGenres ActionItem

Kind: static method of GenresActions

GenresActions.updateGenres(genres) ⇒ ActionItem

creates and dispatches a loadGenres ActionItem

Kind: static method of GenresActions

GenresActions.genreList() ⇒ Array.GenreObject

creates a muttable copy of Gneres from the redux sture

Kind: static method of GenresActions

GenresActions.selectGenres(state) ⇒ Array.GenreObject

Returns a state slice for lifecycle operations

Kind: static method of GenresActions

OrganizationActions

Redux actions related to Organizations

• OrganizationActions
  • .SET_ACTIVE_ORGANIZATION
  • .ORG_REDUCER
  • .setActiveOrganizationAction(organization) ⇒ ActionItem
  • .setActiveOrganization(organization) ⇒ ActionItem
  • .setOrganizationBrowsingDate(date) ⇒ ActionItem
  • .getOrganizationBrowsingDate(state) ⇒ dateString
  • .setOrganizationRegionPreference(region) ⇒ ActionItem
  • .getOrganizationRegionPreference(state) ⇒ RegionType
  • .fetchOrganizationRegionPreference() ⇒ RegionType
  • .setOrganizationListPreference(isList) ⇒ ActionItem
  • .getOrganizationListPreference(state) ⇒ boolean
  • .fetchOrganizationListPreference() ⇒ boolean
  • .setOrganizationCalendarView(view) ⇒ ActionItem
  • .getOrganizationCalendarView(state) ⇒ CalendarViewType
  • .fetchOrganizationCalendarView() ⇒ CalendarViewType
  • .setOrganizationInflight(inflight) ⇒ ActionItem
  • .getOrganizationInflight(state) ⇒ boolean
  • .fetchOrganizationInflight() ⇒ boolean
  • .setOrganizationGenresPreference(genres)
  • .getOrganizationGenresPreference(state)
  • .fetchOrganizationGenresPreference(state)
  • .readActiveOrganization() ⇒ OrganizationType
  • .getActiveOrganization(state) ⇒ Organization
  • .getActiveOrganizationID(state) ⇒ boolean

OrganizationActions.SET_ACTIVE_ORGANIZATION

Kind: static constant of OrganizationActions
Read only: true

OrganizationActions.ORG_REDUCER

Kind: static constant of OrganizationActions
Read only: true

OrganizationActions.setActiveOrganizationAction(organization) ⇒ ActionItem

creates the action item for dispatching

Kind: static method of OrganizationActions

OrganizationActions.setActiveOrganization(organization) ⇒ ActionItem

Creates and dispatches the action

Kind: static method of OrganizationActions

OrganizationActions.setOrganizationBrowsingDate(date) ⇒ ActionItem

Kind: static method of OrganizationActions

OrganizationActions.getOrganizationBrowsingDate(state) ⇒ dateString

Kind: static method of OrganizationActions

OrganizationActions.setOrganizationRegionPreference(region) ⇒ ActionItem

Creates and dispatches the action item

Kind: static method of OrganizationActions

OrganizationActions.getOrganizationRegionPreference(state) ⇒ RegionType

Retrieves the item from synchronous passed (i.e. active) state

Kind: static method of OrganizationActions

OrganizationActions.fetchOrganizationRegionPreference() ⇒ RegionType

reads the item from current state. Asynchronous to state changes

Kind: static method of OrganizationActions

OrganizationActions.setOrganizationListPreference(isList) ⇒ ActionItem

Creates and dispatches the organization listing choice

Kind: static method of OrganizationActions

OrganizationActions.getOrganizationListPreference(state) ⇒ boolean

Retrieves the item from synchronous passed (i.e. active) state

Kind: static method of OrganizationActions

OrganizationActions.fetchOrganizationListPreference() ⇒ boolean

reads the item from current state. Asynchronous to state changes

Kind: static method of OrganizationActions

OrganizationActions.setOrganizationCalendarView(view) ⇒ ActionItem

Creates and dispatches the organization callendar view choice

Kind: static method of OrganizationActions

OrganizationActions.getOrganizationCalendarView(state) ⇒ CalendarViewType

Retrieves the item from synchronous passed (i.e. active) state

Kind: static method of OrganizationActions

OrganizationActions.fetchOrganizationCalendarView() ⇒ CalendarViewType

reads the item from current state. Asynchronous to state changes

Kind: static method of OrganizationActions

OrganizationActions.setOrganizationInflight(inflight) ⇒ ActionItem

Creates and dispatches the organization update inflight choice

Kind: static method of OrganizationActions

OrganizationActions.getOrganizationInflight(state) ⇒ boolean

Retrieves the item from synchronous passed (i.e. active) state

Kind: static method of OrganizationActions

OrganizationActions.fetchOrganizationInflight() ⇒ boolean

reads the item from current state. Asynchronous to state changes

Kind: static method of OrganizationActions

OrganizationActions.setOrganizationGenresPreference(genres)

sets the preferences in Redux

Kind: static method of OrganizationActions

OrganizationActions.getOrganizationGenresPreference(state)

selector from state

Kind: static method of OrganizationActions

OrganizationActions.fetchOrganizationGenresPreference(state)

asynchronous selector from state

Kind: static method of OrganizationActions

OrganizationActions.readActiveOrganization() ⇒ OrganizationType

reads the item from current state. Asynchronous to state changes

Kind: static method of OrganizationActions

OrganizationActions.getActiveOrganization(state) ⇒ Organization

Retrieves the item from synchronous passed (i.e. active) state

Kind: static method of OrganizationActions

OrganizationActions.getActiveOrganizationID(state) ⇒ boolean

Retrieves the item from synchronous passed (i.e. active) state

Kind: static method of OrganizationActions

SkillsActions

• SkillsActions
  • .LOAD_SKILLS
  • .loadSkills(skills) ⇒ ActionItem
  • .updateSkills(skills) ⇒ ActionItem
  • .skillList() ⇒ Array.SkillObject
  • .selectSkills(state) ⇒ Array.SkillObject

SkillsActions.LOAD_SKILLS

Kind: static constant of SkillsActions
Default: "LOAD_SKILLS"

SkillsActions.loadSkills(skills) ⇒ ActionItem

Returns an ActionItem

Kind: static method of SkillsActions

SkillsActions.updateSkills(skills) ⇒ ActionItem

Creates and Dispathes an ActionItem

Kind: static method of SkillsActions

SkillsActions.skillList() ⇒ Array.SkillObject

Kind: static method of SkillsActions

SkillsActions.selectSkills(state) ⇒ Array.SkillObject

Kind: static method of SkillsActions

CampaignReducer

Reducer Support

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

module.exports(state, action) ⇒ ReduxSlice ⏏

Campaign Reducer

Kind: Exported function

module.exports~InitialState

Kind: inner constant of module.exports
Default: []

CityManagerReducer

CityManager Redux reducers

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

module.exports(state, action) ⇒ ReduxSlice ⏏

reducer

Kind: Exported function

module.exports~InitialState

Initial State

Kind: inner constant of module.exports
Default: {"cityManager":null,"activeCityManager":null}

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: {}

GenresReducer

• GenresReducer
  • 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: {"genres":null}

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}

OrganizationReducer

module.exports(state, action) ⇒ ReduxSlice ⏏

reducer

Kind: Exported function

PaymentReducer

module.exports(state, action) ⇒ ReduxSlice ⏏

reducer

Kind: Exported function

PeopleReducer

module.exports(state, action) ⇒ ReduxSlice ⏏

reducer

Kind: Exported function

RegionsReducer

module.exports(state, action) ⇒ ReduxSlice ⏏

reducer

Kind: Exported function

RolesReducer

module.exports(state, action) ⇒ ReduxSlice ⏏

reducer

Kind: Exported function

SkillsReducer

module.exports(state, action) ⇒ ReduxSlice ⏏

reducer

Kind: Exported function

getRole(roleId) ⇒ Role

Kind: global function

© 2020-2023 Tracy Hall