@leaddreamer/tufbrowser NPM

@leaddreamer/tufbrowser

Browser functions for the Tickets Unlimited system, wrapped around TUFBusiness and indirectly firebase-wrapper, for the Front End.

Modules

Constants

Functions

Typedefs

TUFBrowser

Browser functions for the Tickets Unlimited system, wrapped around TUFBusiness and indirectly firebase-wrapper, for the Front End.

TUFBrowser~FirebaseConfigObject : object

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

Kind: inner typedef of TUFBrowser
Properties

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

CloudFunctions

Project specific Auth functions

CloudFunctions Project specific Auth functions(#CloudFunctions Project specific Auth functionsmodule) * ~fetchClaims fetches our specific custom claim values from user Token()(#CloudFunctions Project specific Auth functionsmodule..fetchClaims fetches our specific custom claim values from user Token) ⇒ Credential ~changeCredentials use a credential object to add a new server-side role to a user(credential)(#CloudFunctions Project specific Auth functionsmodule_..changeCredentials use a credential object to add a new server-side role to a user) ⇒ Promise.<void> ~Credential(#CloudFunctions Project specific Auth functionsmodule..Credential) : object * ~secret_object(#CloudFunctions Project specific Auth functionsmodule..secretobject) : object * ~pledgeTicketObject(#CloudFunctions Project specific Auth functionsmodule..pledgeTicketObject) : object ~AccountRequestData(#CloudFunctions Project specific Auth functionsmodule_..AccountRequestData) : object ~personIdObject(#CloudFunctions Project specific Auth functionsmodule..personIdObject) : object * ~PDSSummaryArray(#CloudFunctions Project specific Auth functionsmodule..PDSSummaryArray) : PDSSummary

CloudFunctions

Project specific Auth functions~fetchClaims

fetches our specific custom claim values from user Token() ⇒ Credential

Kind: inner method of CloudFunctions Project specific Auth functions(#CloudFunctions Project specific Auth functionsmodule)
<a name="CloudFunctions Project specific Auth functionsmodule..changeCredentials use a credential object to add a new server-side role to a user">

CloudFunctions

Project specific Auth functions~changeCredentials

use a credential object to add a new server-side role to a user(credential) ⇒ Promise.<void>

Kind: inner method of CloudFunctions Project specific Auth functions(#CloudFunctions Project specific Auth functionsmodule_)

Param	Type	Description
credential	Credential	the new credential being requested. Verified and set at server-side

CloudFunctions

Project specific Auth functions~Credential : object Kind: inner typedef of CloudFunctions Project specific Auth functions(#CloudFunctions Project specific Auth functionsmodule_)
Properties

Name	Type	Description
artist	string	Artists's Id
venue	string	venue Id
adminStatus	boolean
superUser	boolean
employee	boolean

CloudFunctions

Project specific Auth functions~secret_object : object Kind: inner typedef of CloudFunctions Project specific Auth functions(#CloudFunctions Project specific Auth functionsmodule_)
Properties

Name	Type
payment_secret	string

CloudFunctions

Project specific Auth functions~pledgeTicketObject : object Kind: inner typedef of CloudFunctions Project specific Auth functions(#CloudFunctions Project specific Auth functionsmodule_)
Properties

Name	Type
pledgeTicket	pledgeTicket

CloudFunctions

Project specific Auth functions~AccountRequestData : object Kind: inner typedef of CloudFunctions Project specific Auth functions(#CloudFunctions Project specific Auth functionsmodule_)
Properties

Name	Type	Description
type	string	either "Artists" or "Venues"
account	ArtistFormType \| VenueType

CloudFunctions

Project specific Auth functions~personIdObject : object Kind: inner typedef of CloudFunctions Project specific Auth functions(#CloudFunctions Project specific Auth functionsmodule_)
Properties

Name	Type
personId	string

CloudFunctions

Project specific Auth functions~PDSSummaryArray : PDSSummary Kind: inner typedef of CloudFunctions Project specific Auth functions(#CloudFunctions Project specific Auth functionsmodule_)

subscribeVenue

Venue Specific subscribers

Kind: global constant

editInPlaceSelectStyles

Edit In Place constants

Kind: global constant

loginArtist

----------------------------------------------------------------------()

Kind: global function

logoutArtist

----------------------------------------------------------------------()

Kind: global function

makeActiveArtist

accepts the selected artist_role and uses it login & setup control of

the indicated artist.(artist_role) ⇒ Promise.<void>

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

Param	Type	Description
artist_role	artist_role	{ Id: {string} artistID name: {string} artist_name role: {string} management role }

listenArtist

Sets up a listener specifically to the Redux store(uid) ⇒

Kind: global function
Returns: an unsubscribe function

Param	Description
uid	UID of the Artist record for the Redux store to listen too.

listenArtists(dataCallback, errCallback) ⇒ function

Kind: global function
Returns: function - unsubscribe function

Param	Type	Description
dataCallback	function	callback
errCallback	function	callback

listenArtistsPaginated(dataCallback, errCallback) ⇒ PaginatedListener

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

Param	Type	Description
dataCallback	function	callback
errCallback	function	callback

loginCityManager(cityManager_roles)

Kind: global function

Param	Type	Description
cityManager_roles	object	----------------------------------------------------------------------

logoutCityManager

----------------------------------------------------------------------()

Kind: global function

makeActiveCityManager

accepts the selected artist_role and uses it login & setup control of

the indicated artist.(cityManager_role) ⇒ Promise.<void>

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

Param	Type	Description
cityManager_role	cityManager_role	{ Id: {string} cityManagerID name: {string} cityManager_name role: {string} management role }

Sets up a listener specifically to the Redux store(uid) ⇒

Kind: global function
Returns: an unsubscribe function

Param	Description
uid	UID of the Artist record for the Redux store to listen too.

ListenMCCs() ⇒ function

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 Onlyloads at boot-up

Kind: global function
Sync: uses colusure, so can be called sync

pullURLFromRecord(record, key) ⇒ external:promise

Kind: global function
Fulfil: string a "private" URL to access the file.
Reject: string

Param	Type	Description
record	RecordObject	A firestore document Record - the '/' separated collection/ document path is used as the path to the stored item.
key	string	An optional string identifying the specific field an stored item is associated with

accessibleStorage(URL) ⇒ Promise.<URL>

Kind: global function
Fulfil: string a local URL to access the downloaded data
Reject: string

Param	Type
URL	string

offerAccess(parent, offer)

Kind: global function

Param	Type
parent	ArtistFormType \| VenueType
offer	AccessOffer

selectType

This function is a parameterized selector(state, type) Kind: global function

Param	Type	Description
state	Store	Redux State/Store
type	"Genres" \| "Regions" \| "Skills" \| "Roles" \| "MANAGEDARTISTS" \| "MANAGEDVENUES"	type of list to select. Returns {null} for others

selectAccountData(state)

Kind: global function

Param	Type	Description
state	Store	Redux State/Store

This function is a parameterized selector(type, prompt, limit) ⇒ Promise.<HostArray>

Kind: global function
Returns: Promise.<HostArray> - - returns an array of results, up to limit

Param	Type	Description
type	"MANAGEDARTISTS" \| "MANAGEDVENUES"	type of list to select. Returns {null} for others
prompt	string	"search" string (starts-with)
limit	number	limit results (from start)

summarizeItem

parameterized function to return string summary of an object By default, returns the name property of the item.(item, type) ⇒ string Kind: global function

Param	Type	Description
item	object	data object to summarize
type	String \| "People" \| "Addresses" \| "accessControl"	- type of the object to summarize

loginVenue(venue_roles)

Kind: global function

Param	Type	Description
venue_roles	object	----------------------------------------------------------------------

logoutVenue

----------------------------------------------------------------------()

Kind: global function

makeActiveVenue

accepts the selected artist_role and uses it login & setup control of

the indicated artist.(venue_role) ⇒ Promise.<void>

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

Param	Type	Description
venue_role	venue_role	{ Id: {string} venueID name: {string} venue_name role: {string} management role }

listenVenues(dataCallback, errCallback) ⇒ function

Kind: global function
Returns: function - unsubscribe function

Param	Type	Description
dataCallback	function	callback
errCallback	function	callback

listenVenuesPaginated(dataCallback, errCallback, pageSize) ⇒ PaginatedListener

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

Param	Type	Description
dataCallback	function	callback
errCallback	function	callback
pageSize	number

listenPledgeTickets

Attaches a listener to the tourStops pledgetickets (if any)(tourStop, dataCallback, errCallback) ⇒

Kind: global function
Returns: a unsubscribe function to dismiss the listener

Param	Description
tourStop	tourStop record (with refPath) to get pledgeTickets from
dataCallback	a callback function to call when when there is an update event on the pledgeTickets attached to the tourStop
errCallback	a callback function for error conditions

browserCheckIn(pledgeTicket, checkIn)

Calls Function Server to securely create a CheckIn

Kind: global function

Param	Type
pledgeTicket	pledgeTicketType
pledgeTicket.refPath	string
checkIn	object

selectGeneric(state, sliceName, which)

gets Redux information by "slice" (really, which reducer) and "which" (table name)

Kind: global function

Param	Type	Description
state	store	Redux state/store
sliceName	string	a name to identify the reducer/state segment
which	string	the name of the sub-table

getGeneric(sliceName, which)

gets Redux information by "slice" (really, which reducer) and "which" (table name) Supplies the state locally - which may affect some async operations.

Kind: global function