A set of helper-wrapper functions around firebase firestore, storage and auth. Intent is to treat Firestore as a hierarchical record-oriented database; originally conceived to port from one database to another.

FirebaseWrapper

A set of helper-wrapper functions around firebase firestore, storage and auth. all-in-one wrapper for a solid subset of CLIENT-SIDE Firebase functions, with a consistent interface. There is a parallel set for ADMIN-SIDE functions as well. Intent is to treat Firestore as a hierarchical record-oriented database; originally conceived to port from one database to another. NOTE: Most helpers return PROMISE.REJECT if no documents are returned. it is assumed projects using this library might want to have an explicitly error trap for such events.

FirebaseAuthWrapper/authAdmin

A set of helpers around Firebase admin SDK auth. Specific to use in Cloud Functions

FirebaseAuthWrapper/authClient

A set of helper-wrapper functions around firebase firestore, storage and auth. Intent is to treat Firestore as a hierarchical record-oriented database; originally conceived to port from one database to another.

FirebaseCloudFunctionsWrapper

A set of helper-wrapper functions around firebase firestore, storage and auth. Intent is to treat Firestore as a hierarchical record-oriented database; originally conceived to port from one database to another.

FirebaseFirestoreWrapper

A set of helper-wrapper functions around firebase firestore, storage and auth. Intent is to treat Firestore as a hierarchical record-oriented database; originally conceived to port from one database to another.

FirebaseStorageWrapper

A set of helper-wrapper functions around firebase firestore, storage and auth. Intent is to treat Firestore as a hierarchical record-oriented database; originally conceived to port from one database to another.

FirebaseStorageAdminEmulator

A set of helper-wrapper functions around firebase storage Intent is to treat Firestore as a hierarchical record-oriented database and Storage as a parallel structure originally conceived to port from one database to another.

FirebaseWrapper

A set of helper-wrapper functions around firebase firestore, storage and auth. all-in-one wrapper for a solid subset of CLIENT-SIDE Firebase functions, with a consistent interface. There is a parallel set for ADMIN-SIDE functions as well. Intent is to treat Firestore as a hierarchical record-oriented database; originally conceived to port from one database to another. NOTE: Most helpers return PROMISE.REJECT if no documents are returned. it is assumed projects using this library might want to have an explicitly error trap for such events.

PAGINATE_INIT : number

PAGINATE_PENDING : number

PAGINATE_UPDATED : number

PAGINATE_END : number

PAGINATE_DEFAULT : number

PAGINATE_CHOICES : number

A set of helper-wrapper functions around firebase firestore, storage and auth. all-in-one wrapper for a solid subset of CLIENT-SIDE Firebase functions, with a consistent interface. There is a parallel set for ADMIN-SIDE functions as well. Intent is to treat Firestore as a hierarchical record-oriented database; originally conceived to port from one database to another. NOTE: Most helpers return PROMISE.REJECT if no documents are returned. it is assumed projects using this library might want to have an explicitly error trap for such events.

• FirebaseWrapper
  • static
    • .FirebaseWrapper(config) ⇒
    • .FirebaseWrapper(config) ⇒
  • inner
    • ~FirebaseConfigObject : Object
    • ~FirebaseConfigObject : Object

Kind: static method of FirebaseWrapper
Returns: none

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

Kind: static method of FirebaseWrapper
Returns: none

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

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

Kind: inner typedef of FirebaseWrapper
Properties

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

Kind: inner typedef of FirebaseWrapper
Properties

A set of helpers around Firebase admin SDK auth. Specific to use in Cloud Functions

• FirebaseAuthWrapper/authAdmin
  • static
    • .FirebaseAuthAdminWrapper(firebase)
  • inner
    • ~getUser(userID) ⇒ Promise.<userData>
    • ~DeleteUser(userID) ⇒ Promise
    • ~setCustomClaims(uid, customClaim)
    • ~addCustomClaims(uid, customClaim)
    • ~clearCustomClaims(uid)
    • ~PageUsers(pageSize, pageToken)

Initializes the administrative Auth service of the provided firebase app. Also instantiates various constants and helper functions

Kind: static method of FirebaseAuthWrapper/authAdmin

asynchronously fetches user data from Firestore Authentication

Kind: inner method of FirebaseAuthWrapper/authAdmin

deletes a single user from the authentication system, identified by user ID

Kind: inner method of FirebaseAuthWrapper/authAdmin

sets custom claims on user object overwrites other needed settings

Kind: inner method of FirebaseAuthWrapper/authAdmin

adds/merges to new claims to user customClaims

Kind: inner method of FirebaseAuthWrapper/authAdmin

removes all current customClaims on user (sets to null)

Kind: inner method of FirebaseAuthWrapper/authAdmin

pages through the full list of users. Woefully inefficient.

Kind: inner method of FirebaseAuthWrapper/authAdmin

A set of helper-wrapper functions around firebase firestore, storage and auth. Intent is to treat Firestore as a hierarchical record-oriented database; originally conceived to port from one database to another.

Example

import * as firebase from "firebase/app";
import "firebase/auth";
import FirebaseAuth from "@leaddreamer/firebase-wrapper/FirebaseAuthWrapper";
//the next is optional - if you want the React component
import StyledFirebaseAuth from "react-firebaseui/StyledFirebaseAuth";
import {config} from "wherever-you-put-it";

((myconfig) {
try {
  firebase.app();
} catch (err) {
  firebase.initializeApp(myconfig);
}
FirebaseAuth(firebase, StyledFirebaseAuth);
})(config)

• FirebaseAuthWrapper/authClient
  • static
    • .FirebaseAuth : object
    • .FirebaseAuthSignInOptions : string
    • .FirebaseAuthClient(firebase)
    • .fetchToken(user) ⇒ external:promise
    • .fetchJWT(user) ⇒ Promise.<JWT>
    • .refreshAuthUser() ⇒ Promise.<void>
    • .doCreateUserWithEmailAndPassword(email, password) ⇒ Promise.<UserCredential>
    • .doSignInWithEmailAndPassword(email, password) ⇒ Promise.<UserCredential>
    • .doSignInWithGoogle()
    • .doSignInWithFacebook()
    • .doSignInWithTwitter()
    • .doSignOut()
    • .doPasswordReset()
    • .doSendEmailVerification()
    • .doPasswordUpdate()
    • .createAnonymousUser() ⇒ Promise.<UserCredential>
    • .attachAuthUserListener() ⇒ callback
    • .setPersistence()
  • inner
    • ~fromJSON() : object
    • ~AdditionalUserInfo : object
    • ~User : object
    • ~UserCredential : object
    • ~AuthChangeProcess : function

Kind: static property of FirebaseAuthWrapper/authClient

Kind: static property of FirebaseAuthWrapper/authClient

Initializes the Auth service of the provided firebase app. Also instantiates various constants and helper functions

Kind: static method of FirebaseAuthWrapper/authClient

fetches our specific custom claim values from firebase auth

Kind: static method of FirebaseAuthWrapper/authClient
Fulfil: Returns a user token object
Reject: returns err

Fetch a JWT token for authenticated signed requests

Kind: static method of FirebaseAuthWrapper/authClient
Fulfil: Returnsa JWT token
Reject: returns an err

triggers an update of the Firebase Auth user object. A listener can be set to monitor these changes

Kind: static method of FirebaseAuthWrapper/authClient

Creates AND SIGNS IN an authenticated user with the provided email and password Creates a new user account associated with the specified email address and password. On successful creation of the user account, this user will also be signed in to your application. User account creation can fail if the account already exists or the password is invalid. Note: The email address acts as a unique identifier for the user and enables an email-based password reset. This function will create a new user account and set the initial user password.

Kind: static method of FirebaseAuthWrapper/authClient

SIGNS IN an existing authenticated user with the provided email and password Creates a new user account associated with the specified email address and password. On successful creation of the user account, this user will also be signed in to your application. User account creation can fail if the account already exists or the password is invalid. Note: The email address acts as a unique identifier for the user and enables an email-based password reset. This function will create a new user account and set the initial user password.

Kind: static method of FirebaseAuthWrapper/authClient

Kind: static method of FirebaseAuthWrapper/authClient

Kind: static method of FirebaseAuthWrapper/authClient

Kind: static method of FirebaseAuthWrapper/authClient

Kind: static method of FirebaseAuthWrapper/authClient

Kind: static method of FirebaseAuthWrapper/authClient

Kind: static method of FirebaseAuthWrapper/authClient

Kind: static method of FirebaseAuthWrapper/authClient

Kind: static method of FirebaseAuthWrapper/authClient

Kind: static method of FirebaseAuthWrapper/authClient
Returns: callback - unsubscribe function
Properties

Kind: static method of FirebaseAuthWrapper/authClient

Kind: inner method of FirebaseAuthWrapper/authClient
Properties

Kind: inner typedef of FirebaseAuthWrapper/authClient
Properties

See https://firebase.google.com/docs/reference/js/firebase.User

Kind: inner typedef of FirebaseAuthWrapper/authClient

Kind: inner typedef of FirebaseAuthWrapper/authClient
Properties

Kind: inner typedef of FirebaseAuthWrapper/authClient

A set of helper-wrapper functions around firebase firestore, storage and auth. Intent is to treat Firestore as a hierarchical record-oriented database; originally conceived to port from one database to another.

• FirebaseCloudFunctionsWrapper
  • .FirebaseCloudFunctions(firebase)
  • .CloudFunctions() ⇒ external:promise
  • .treeFromParams(Params) ⇒ RecordTree

Initializes the FirebaseCLoud function support

Kind: static method of FirebaseCloudFunctionsWrapper

Example

import * as firebase from "firebase/app";
import "firebase/functions";
import FirebaseFunctions from "@leaddreamer/firebase-wrapper/FirebaseCloudFunctionsWrapper";
import {config} from "whereever-you-put-it";

((myconfig) {
try {
  firebase.app();
} catch (err) {
  firebase.initializeApp(myconfig);
}
FirebaseFunctions(firebase);
})(config)

Kind: static method of FirebaseCloudFunctionsWrapper
Fulfil: result as returns from call
Reject: err as returned from call
Example

result = await CloudFunctions("MyGloriousFunction")(argumentToFunction);

Kind: static method of FirebaseCloudFunctionsWrapper
Sync:

A set of helper-wrapper functions around firebase firestore, storage and auth. Intent is to treat Firestore as a hierarchical record-oriented database; originally conceived to port from one database to another.

• FirebaseFirestoreWrapper
  • static
    • .MAX_CONCURRENCY : number
    • .FirebaseFirestore(firebase)
    • .createUniqueReference(tablePath, refPath) ⇒ DocumentReference
    • .writeRecord(tablePath, data, refPath, batch, mergeOption) ⇒ Promise.<Record>
    • .writeRecordByRefPath(data, refPath, Transaction, mergeOption) ⇒ Promise.<Record>
    • .writeBack(data, Transaction, mergeOption) ⇒ Promise.<Record>
    • .collectRecords(tablePath, refPath) ⇒ Promise.<Array.<Record>>
    • .collectRecordsByFilter(tablePath, refPath, [filterArray], [sortArray], limit) ⇒ Promise.<Array.<Record>>
    • .collectRecordsInGroup(tableName) ⇒ Promise.<Array.<Record>>
    • .collectRecordsInGroupByFilter(tableName, [filterArray], [sortArray], limit) ⇒ Promise.<Array.<Record>>
    • .fetchRecord(tablePath, Id, refPath, batch) ⇒ Promise.<(Record|WriteBatch|Transaction)>
    • .fetchRecordByRefPath(docRefPath, batch) ⇒ Promise.<Record>
    • .fetchRecordByFilter(table, [filterArray], refPath, batch) ⇒ Promise.<(Record|WriteBatch|Transaction)>
    • .fetchRecordInGroupByFilter(table, [filterArray], batch) ⇒ Promise.<(Record|WriteBatch|Transaction)>
    • .deleteRecord(table, record, refPath, batch) ⇒ Promise.<(Record|WriteBatch|Transaction)>
    • .deleteRecordByRefPath(docRefPath, batch) ⇒ Promise.<(Record|WriteBatch|Transaction)>
    • .updateRecordFields(recordUpdate) ⇒ Promise.<Record>
    • .updateRecordByRefPath(docRefPath, data, batch) ⇒ Promise.<(Record|WriteBatch|Transaction)>
    • .writeArrayValue(fieldName, fieldValue, docRefPath, batch) ⇒ Promise.<(Record|WriteBatch|Transaction)>
    • .localBatchReturn(incomingBatch, internalBatch) ⇒ WriteBatch | Transaction
    • Batch
      • .runTransaction(updateFunction) ⇒ Promise.<object>
      • .openWriteBatch() ⇒ WriteBatch
      • .closeWriteBatch(batch) ⇒ Promise.<void>
      • .openBulkWriter() ⇒ BulkWriter
      • .closeBulkWriter(bulkWriter) ⇒ Promise.<void>
    • FieldPath
      • .documentId : Object
    • FieldValue
      • .deleteFieldValue : Object
      • .serverTimestampFieldValue : Object
      • .incrementFieldValue(n) ⇒
      • .decrementFieldValue(n) ⇒
      • .arrayRemoveFieldValue(elements) ⇒ sentinelValue
      • .arrayUnionFieldValue(elements) ⇒
    • Listeners
      • .ListenRecords(tablePath, refPath, dataCallback, errCallback) ⇒ unsubscribe
      • .ListenQuery(tablePath, refPath, dataCallback, errCallback, [filterArray], [sortArray]) ⇒ unsubscribe
      • .ListenCollectionGroupRecords(tablePath, refPath, dataCallback, errCallback) ⇒ callback
      • .ListenCollectionGroupQuery(table, [filterArray], [sortArray], dataCallback, errCallback) ⇒ unsubscribe
      • .ListenRecord(tablePath, Id, refPath, dataCallback, errCallback) ⇒ unsubscribe
    • Paginator
      • .PaginateFetch
        • new exports.PaginateFetch(table, filterArray, sortArray, refPath, limit)
        • .limit : number
        • .status : PagingStatus
        • .PageForward() ⇒ Promise.<RecordArray>
        • .PageBack() ⇒ Promise.<RecordArray>
      • .PaginateGroupFetch
        • new exports.PaginateGroupFetch(group, [filterArray], [sortArray], limit)
        • .limit : number
        • .status : PagingStatus
        • .PageForward() ⇒ Promise.<RecordArray>
        • .PageBack() ⇒ Promise.<RecordArray>
      • .PaginatedListener
        • new exports.PaginatedListener(tablePath, refPath, dataCallback, errCallback, limit, [filterArray], [sortArray])
        • .limit : number
        • .status : number
        • .PageForward() ⇒ unsubscribe
        • .PageBack() ⇒ unsubscribe
        • .ChangeLimit(newLimit) ⇒ unsubscribe
        • .ChangeFilter([filterArray]) ⇒ unsubscribe
        • .unsubscribe()
    • Tree Slice
      • .ownerFilter(owner, queryFilter) ⇒ filterObject
      • .listenSlice(owner, collectionName, dataCallback, response, errCallback, response) ⇒ callback
      • .fetchSlice(owner, collectionName) ⇒ QuerySnapshot
      • .querySlice(owner, collectionName, queryFilter) ⇒ QuerySnapshot
      • .listenQuerySlice(owner, collectionName, filterArray, dataCallback, response, errCallback, response) ⇒ callback
      • .ownerType(record) ⇒ string
      • .ownerId(record) ⇒ string
      • .ownerRefPath(record) ⇒ string
      • .ownerByChild(record) ⇒ Record
      • .ownerByOwnerType(ownerId, ownerType) ⇒ Record
      • .fetchOwner(record) ⇒ Document
    • Typed
      • .recordType(record) ⇒ string
      • .recordId() ⇒ string
      • .typedWrite(data, parent, type, batch) ⇒ Promise.<Record>
      • .typedWriteByTree(data, tree, type, batch) ⇒ Promise
      • .typedWriteByChild(data, tree, type, batch) ⇒ Promise
      • .typedCreate(data, parent, type, batch) ⇒ Promise
      • .treeFromChild(child) ⇒ RecordTree
      • .typedTablePathFromTree(tree, type, branchType) ⇒ string
      • .typedRefPathFromTree(tree, type) ⇒ string
      • .typedIdFromChild(child, type)
      • .typedTablePathFromChild(child, type) ⇒ string
      • .typedRefPathFromChild(child, type) ⇒ string
      • .typedFetchFromChild(child, refPath, type, batch) ⇒ Promise.<RecordObject>
      • .typedFetchFromTree(tree, refPath, type, batch) ⇒ Promise.<RecordObject>
      • .typedCollectFromTree(tree, type, batch) ⇒ Promise.<RecordArray>
      • .typedCollectFromChild(child, type, batch)
  • inner
    • ~timestamp
      • new timestamp()

maximum concurrent writes

Kind: static constant of FirebaseFirestoreWrapper

Initializes the Firestore service of the provided firebase app. Also instantiates various constants and helper functions

Kind: static method of FirebaseFirestoreWrapper

Example

import * as firebase from "firebase/app";
import "firebase/firestore";
import FirebaseFirestore from "@leaddreamer/firebase-wrapper/FirebaseFirestoreWrapper";
import {config} from "whereever-you-put-it";

((myconfig) {
try {
  firebase.app();
} catch (err) {
  firebase.initializeApp(myconfig);
}
FirebaseFirestore(firebase);
})(config)

Creates a DocumentReference document to the collection referenced in parameter tablePath (relative to optional refPath). This is can be useful for Transactions and Batches, which can only get(), set() or update() existing documents. Tricksie!

Kind: static method of FirebaseFirestoreWrapper
Returns: DocumentReference - Firestore Document Reference

Writes a Firestore record to collection indicated by tablePath relative to option DocumentReference refPath

Kind: static method of FirebaseFirestoreWrapper
Returns: Promise.<Record> - - a copy of the written record

Writes given data object (or map) to the given documentReference

Kind: static method of FirebaseFirestoreWrapper
Returns: Promise.<Record> - data record as written

Writes a local-schema document back to the Firestore. Assume object/map came from the firestore

Kind: static method of FirebaseFirestoreWrapper
Returns: Promise.<Record> - record as written.

query for a SET of records

Kind: static method of FirebaseFirestoreWrapper

Kind: static method of FirebaseFirestoreWrapper
Descriptions: returns an array of documents from Firestore

query for a SET of records from a COLLECTIONGROUP - all collections of a similar name, regardless of parents. It is up to the User to ensure these are at a similar level/structure - Firestore just matches the name

Kind: static method of FirebaseFirestoreWrapper

queries for Records from a CollectionGroup, filtered by the passed array of filterObjects

Kind: static method of FirebaseFirestoreWrapper

retrieve a record from the Firestore. If a Batch object is passed, returns a chained Btahc object

Kind: static method of FirebaseFirestoreWrapper

fetches a single record from the database, using just a refPath to identify the document

Kind: static method of FirebaseFirestoreWrapper

fetches a SINGLE record from the database, using just a filter to identify the document. DANGEROUSLY assumes the filter identifies a SINGLE document, even if the query always returns an array

Kind: static method of FirebaseFirestoreWrapper

fetches a SINGLE record from the database, using just a filter to identify the document. DANGEROUSLY assumes the filter identifies a SINGLE document, even if the query always returns an array

Kind: static method of FirebaseFirestoreWrapper

deletes a single record from the database

Kind: static method of FirebaseFirestoreWrapper

deletes a single record from the database

Kind: static method of FirebaseFirestoreWrapper

update record by fields - Allows use of FieldPath options such as .delete(). Only specifically referenced fields will be affected. Assumes the originating docRef is passed as refPath: field

Kind: static method of FirebaseFirestoreWrapper

Kind: static method of FirebaseFirestoreWrapper

adds a new value to a firestore record array entry

Kind: static method of FirebaseFirestoreWrapper

Kind: static method of FirebaseFirestoreWrapper
Returns: WriteBatch | Transaction - WriteBatch, Transaction or Void

Example

export const suboperation = (data, batch = null) => {
 let myBatch = batch || openWriteBatch(); //note short circuit
 //stuff that happens in the routine
 writeRecord(table, data, parent, myBatch);
 writeRecord(otherTable, otherData, otherParent, myBatch);
 return localBatchReturn(batch, myBatch);
}

creates and runs a series of record operations (executed in the param function) as an atomic operation. A transation object is passed to the callback parameter

Kind: static method of FirebaseFirestoreWrapper
Returns: Promise.<object> - a promise with the result of updateFunction
Category: Batch

Creates a WriteBatch object tocollect actions for Batch writing to backend

Kind: static method of FirebaseFirestoreWrapper
Returns: WriteBatch - object that operations are added to for a bulk operation
Category: Batch

Dispatches an asynchronous Closure to submit Batch

Kind: static method of FirebaseFirestoreWrapper
Category: Batch

Creates a bulkWriter object to collect actions for Bulk writing to backend offers parallel operations, writes only, does NOT check for contentions, admin/Node-side only.

Kind: static method of FirebaseFirestoreWrapper
Returns: BulkWriter - object that operations are added to for a bulk operation
Category: Batch

Dispatches an asynchronous Closure to complete BulkWriter

Kind: static method of FirebaseFirestoreWrapper
Category: Batch

a fieldPath value to represent the document Id - WARNING Google Firestore has a bug, and this actually represents the FULL PATH to the document

Kind: static constant of FirebaseFirestoreWrapper
Category: FieldPath

a sentinel value used to delete a field during an update operation

Kind: static constant of FirebaseFirestoreWrapper
Category: FieldValue

a sentinel value to set a field to a server-generated timestamp during set(0 or update())

Kind: static constant of FirebaseFirestoreWrapper
Category: FieldValue

return a sentinel to incrment/decrement a field

Kind: static method of FirebaseFirestoreWrapper
Returns: a sentinel value
Category: FieldValue

return a sentinel to decrment/decrement a field NOT REALLY A FIREBASE FUNCTION Fire base has only increment; we implement this for legibility

Kind: static method of FirebaseFirestoreWrapper
Returns: a sentinel value
Category: FieldValue

returns a sentinel to remove elements from array field

Kind: static method of FirebaseFirestoreWrapper
Returns: sentinelValue - a sentinel value
Category: FieldValue

return a sentinel to add/join elements to array field

Kind: static method of FirebaseFirestoreWrapper
Returns: a sentinel value
Category: FieldValue

sets up a listener for changes to a single record

Kind: static method of FirebaseFirestoreWrapper
Returns: unsubscribe - function to be called to release subscription
Category: Listeners

Sets up a listener to a query

Kind: static method of FirebaseFirestoreWrapper
Returns: unsubscribe - function to be called to release subscription
Category: Listeners

sets up a listener for changes to a collectionGroup

Kind: static method of FirebaseFirestoreWrapper
Returns: callback - function to be called to release subscription
Category: Listeners

sets up a listener for changes to a collectionGroup by query

Kind: static method of FirebaseFirestoreWrapper
Returns: unsubscribe - function to be called to release subscription
Category: Listeners

Listen to changes to a single record

Kind: static method of FirebaseFirestoreWrapper
Returns: unsubscribe - function to be called to release subscription
Category: Listeners

Kind: static class of FirebaseFirestoreWrapper
Category: Paginator

• .PaginateFetch
  • new exports.PaginateFetch(table, filterArray, sortArray, refPath, limit)
  • .limit : number
  • .status : PagingStatus
  • .PageForward() ⇒ Promise.<RecordArray>
  • .PageBack() ⇒ Promise.<RecordArray>

constructs an object to paginate through large Firestore Tables

current limit of query results

Kind: instance property of PaginateFetch

current status of pagination -1 pending; 0 uninitialized; 1 updated;

Kind: instance property of PaginateFetch

executes the query again to fetch the next set of records

Kind: instance method of PaginateFetch
Returns: Promise.<RecordArray> - returns an array of record - the next page

executes the query again to fetch the previous set of records

Kind: instance method of PaginateFetch
Returns: Promise.<RecordArray> - returns an array of record - the next page

Kind: static class of FirebaseFirestoreWrapper
Category: Paginator

• .PaginateGroupFetch
  • new exports.PaginateGroupFetch(group, [filterArray], [sortArray], limit)
  • .limit : number
  • .status : PagingStatus
  • .PageForward() ⇒ Promise.<RecordArray>
  • .PageBack() ⇒ Promise.<RecordArray>

constructs an object to paginate through large Firestore Tables

current limit basis for listener query

Kind: instance property of PaginateGroupFetch

current status of listener -1 pending; 0 uninitialized; 1 updated;

Kind: instance property of PaginateGroupFetch

executes the query again to fetch the next set of records

Kind: instance method of PaginateGroupFetch
Returns: Promise.<RecordArray> - returns an array of record - the next page

executes the query again to fetch the previous set of records

Kind: instance method of PaginateGroupFetch
Returns: Promise.<RecordArray> - returns an array of record - the next page

Kind: static class of FirebaseFirestoreWrapper
Category: Paginator

• .PaginatedListener
  • new exports.PaginatedListener(tablePath, refPath, dataCallback, errCallback, limit, [filterArray], [sortArray])
  • .limit : number
  • .status : number
  • .PageForward() ⇒ unsubscribe
  • .PageBack() ⇒ unsubscribe
  • .ChangeLimit(newLimit) ⇒ unsubscribe
  • .ChangeFilter([filterArray]) ⇒ unsubscribe
  • .unsubscribe()

Creates an object to allow for paginating a listener for table read from Firestore. REQUIRES a sorting choice; masks some subscribe/unsubscribe action for paging forward/backward

current limit basis for listener query

Kind: instance property of PaginatedListener

current status of listener

Kind: instance property of PaginatedListener

resets the listener query to the next page of results. Unsubscribes from the current listener, constructs a new query, and sets it as the new listener

Kind: instance method of PaginatedListener
Returns: unsubscribe - returns the unsubscriber function (for lifecycle events)

resets the listener query to the next page of results. Unsubscribes from the current listener, constructs a new query, and sets it
as the new listener

Kind: instance method of PaginatedListener
Returns: unsubscribe - returns the unsubscriber function (for lifecycle events)

sets page size limit to new value, and restarts the paged listener

Kind: instance method of PaginatedListener
Returns: unsubscribe - returns the unsubscriber function (for lifecycle events)

changes the filter on the subscription This has to unsubscribe the current listener, create a new query, then apply it as the listener

Kind: instance method of PaginatedListener
Returns: unsubscribe - returns the unsubscriber function (for lifecycle events)

IF unsubscribe function is set, run it.

Kind: instance method of PaginatedListener

Contructs a filter that selects only the "owner" section of a collectionGroup query - in other words, descendents of a particular top=level document. This takes advantage of Firestore's indexing, which "names"/indexes all documents using the FULL PATH to the document, starting from the top-most, i.e.: TOP_COLLECTION/{dociId}/NEXT_COLLECTION/{docId}/NEXT_NEXT_COLLECTION/{etc} This functions knowns NOTHING about the actual schema; it simply uses the path of the indicated "owner" as starting portion of ALL the "child" documents of the owner. It also takes advantage of the strictly alpha-numeric nature of the path string. As such, ALL children paths strings MUST be "greater than" the owner bare path, and MUST be LESS THAN the alpha-numerically "next" value: e.g. if the "owner" path is TOP_COLLECTION/abcdefg, then

/TOP_COLLECTION/abcdefh > name > //TOP_COLLECTION/abcdefg (assuming LEXICAL SORT) IMPORTANT NOTE: Because this filter uses an INEQUALITY, .sortBy() conditions are not supported

Kind: static method of FirebaseFirestoreWrapper
Category: Tree Slice

Uses the ownerFilter (above) to establish a listener to "just" the parts of a collectionGroup that are descendants of the passed "owner" record.

Kind: static method of FirebaseFirestoreWrapper
Returns: callback - function to be called to release subscription
Category: Tree Slice

Wrapper around database fetch, using ownerFilter above to select/fetch just an "owner" parent document's descendants from a collectionGroup

Kind: static method of FirebaseFirestoreWrapper
Returns: QuerySnapshot - response
Category: Tree Slice

Wrapper around database fetch, using ownerFilter above to select/fetch just an "owner" parent document's descendants from a collectionGroup

Kind: static method of FirebaseFirestoreWrapper
Returns: QuerySnapshot - response
Category: Tree Slice

Uses the ownerFilter (above) to establish a listener to "just" the parts of a collectionGroup that are descendants of the passed "owner" record.

Kind: static method of FirebaseFirestoreWrapper
Returns: callback - function to be called to release subscription
Category: Tree Slice

Returns the "type" (collection name) of the top-most parent of a record, derived from the refPath

Kind: static method of FirebaseFirestoreWrapper
Returns: string - the collection name
Category: Tree Slice

Returns the Id (documentId) of the top-most parent of a record, derived from the refPath

Kind: static method of FirebaseFirestoreWrapper
Returns: string - the Id
Category: Tree Slice

Returns the Id (documentId) of the top-most parent of a record, derived from the refPath

Kind: static method of FirebaseFirestoreWrapper
Returns: string - the Id
Category: Tree Slice

Returns the bare owner record reference to the parent (root) of a provided child

Kind: static method of FirebaseFirestoreWrapper
Returns: Record - reference to the parent (root) record
Category: Tree Slice

Kind: static method of FirebaseFirestoreWrapper
Returns: Record - reference to the parent (root) record
Category: Tree Slice

returns the record for the top-most parent of a record, derived from the refPath

Kind: static method of FirebaseFirestoreWrapper
Category: Tree Slice

Returns the "type" (collection name) the passed record is stored in, derived from the refPath

Kind: static method of FirebaseFirestoreWrapper
Returns: string - the collection name
Category: Typed

Returns the Id (documentId) of the passed record derived from the refPath

Kind: static method of FirebaseFirestoreWrapper
Returns: string - the Id
Category: Typed

optionally batched record update - abstracts batch process from specific types

Kind: static method of FirebaseFirestoreWrapper
Returns: Promise.<Record> - record, with Id & refpath
Category: Typed

optionally batched record update - abstracts batch process from specific types

Kind: static method of FirebaseFirestoreWrapper
Returns: Promise - record, with Id & refpath
Category: Typed

optionally batched record update - abstracts batch process from specific types

Kind: static method of FirebaseFirestoreWrapper
Returns: Promise - WriteBatch, Transaction or Void
Category: Typed

Creates a new document reference of the indicated type, and writes it to the backend. Specific intent is when the Id needs to be pre-specified, or shared outside this function. Normal writing action will silently create a new document, which has to then be found by query

Kind: static method of FirebaseFirestoreWrapper
Returns: Promise - WriteBatch, Transaction or Void
Category: Typed

Extracts a tree of document ID's from a child document (assumes is a child)

Kind: static method of FirebaseFirestoreWrapper
Category: Typed

Builds a refPath down to a desired collection/type from an existing RecordTree Map.

Kind: static method of FirebaseFirestoreWrapper
Returns: string - constructed TablePath (collection)
Category: Typed

Builds a refPath down to a desired collection/type from an existing RecordTree Map.

Kind: static method of FirebaseFirestoreWrapper
Returns: string - constructed refPath (document)
Category: Typed

Looks up a "tree" to find the Id of the document at the requested collection level ("type")

Kind: static method of FirebaseFirestoreWrapper
Category: Typed

Builds a refPath up to a desired collection/type from an existing child in a tree

Kind: static method of FirebaseFirestoreWrapper
Returns: string - constructed refPath (collection)
Category: Typed

Builds a refPath up to a desired collection/type from an existing child in a tree

Kind: static method of FirebaseFirestoreWrapper
Returns: string - constructed refPath (document)
Category: Typed

function to fetch a document from "up" the collection/document tree of a child document

Kind: static method of FirebaseFirestoreWrapper
Category: Typed

function to fetch a document from "up" the collection/document tree of a child document

Kind: static method of FirebaseFirestoreWrapper
Category: Typed

function to collect documents from "up" the collection/document tree of a child document

Kind: static method of FirebaseFirestoreWrapper
Category: Typed

function to collect documents from "up" the collection/document tree of a child document

Kind: static method of FirebaseFirestoreWrapper
Category: Typed

Kind: inner class of FirebaseFirestoreWrapper

class for a Firestore timestamp processor

A set of helper-wrapper functions around firebase firestore, storage and auth. Intent is to treat Firestore as a hierarchical record-oriented database; originally conceived to port from one database to another.

• FirebaseStorageWrapper
  • static
    • .FirebaseStorageWrapper(firebase)
    • .makeStorageRefFromRecord(record, key, filename) ⇒ StorageReference
    • .listReference(storageReference, optionsObject) ⇒ ListResult
    • .makeFileURLFromRecord(record, key, filename) ⇒ external:promise
    • .makePrivateURLFromRecord(record, key) ⇒ string
    • .makePrivateURLFromReference(reference, key) ⇒ string
    • .makePrivateURLFromPath(fullPath) ⇒ string
    • .storeBlobByRecord(blob, record, key, filename) ⇒ UploadTask
    • .storeDataURLByRecord(dataURL, record, key, filename) ⇒
    • .getDefaultImageURL(key) ⇒ string
    • .getURLFromFilePath(filePath) ⇒ string
    • .dataURLToBlob(dataURL) ⇒ Object
  • inner
    • ~File : object
    • ~FileMetadata : object

Initializes the Auth service of the provided firebase app. Also instantiates various constants and helper functions

Kind: static method of FirebaseStorageWrapper

Example

import * as firebase from "firebase/app";
import "firebase/storage";
import FirebaseStorage from "@leaddreamer/firebase-wrapper/FirebaseStorageWrapper";
import {config} from "whereever-you-put-it";

((myconfig) {
try {
  firebase.app();
} catch (err) {
  firebase.initializeApp(myconfig);
}
FirebaseStorage(firebase);
})(config);

Kind: static method of FirebaseStorageWrapper
Returns: StorageReference - a Firestore Storage Reference

Kind: static method of FirebaseStorageWrapper

Kind: static method of FirebaseStorageWrapper
Fulfil: string a "long-lived" URL to access the file.
Reject: string

Kind: static method of FirebaseStorageWrapper
Returns: string - The resulting Security-Rule-compliant URL

Kind: static method of FirebaseStorageWrapper
Returns: string - The resulting Security-Rule-compliant URL

This function is part of a storage scheme that uses parallel structures between Firestore collection/documents and Storage paths. The concept here is all Storage items are part of/belong to Firestore documents. This function takes a full path to a Storage object and turns it into URL. If "type"is not included, the URL will return the metadata, not the contents. Note this simply makes the URL - it does not carry out any operations

Kind: static method of FirebaseStorageWrapper
Returns: string - constructed Security-Rule-compliant URL

Firestore's document sizes can be limited - 1MB - so our system stores larger digital "blobs" in a parallel Firestore Storage.

Kind: static method of FirebaseStorageWrapper
Returns: UploadTask - Firestore Storage UploadTask Object

Firestore's document sizes can be limited - 1MB - so our system stores larger digital "blobs" in a parallel Firestore Storage.

Kind: static method of FirebaseStorageWrapper
Returns: Firestore Storage UploadTask Object

Kind: static method of FirebaseStorageWrapper

Kind: static method of FirebaseStorageWrapper

Kind: static method of FirebaseStorageWrapper
Returns: Object - {ext: extension, base64: data}

Kind: inner typedef of FirebaseStorageWrapper
Properties

Kind: inner typedef of FirebaseStorageWrapper
Properties

A set of helper-wrapper functions around firebase storage Intent is to treat Firestore as a hierarchical record-oriented database and Storage as a parallel structure originally conceived to port from one database to another.

• FirebaseStorageAdminEmulator
  • static
    • .FirebaseStorageAdminEmulator(firebase)
  • inner
    • ~adminRef
      • new adminRef(bucket, path)
      • .fileRef : storageRef
      • .fullPath : string
      • .name : string
      • .bucket : string
      • .parent : storageRef
      • .storage : storageApp
      • .metadata : string
    • [~child creates and returns a new adminRef object from existin path(path)](#module_FirebaseStorageAdminEmulator..child creates and returns a new adminRef object from existin path) ⇒ StorageRefEmulation
    • [~delete Deletes the referenced storage item()](#module_FirebaseStorageAdminEmulator..delete Deletes the referenced storage item) ⇒ Promise
    • [~getDownloadURL Generates a long-lived (essentially permanent until revoked) Public-Access URL for a storage item in FIREBASE (not Cloud Storage) format()](#module_FirebaseStorageAdminEmulator..getDownloadURL Generates a long-lived (essentially permanent until revoked) Public-Access URL for a storage item in FIREBASE (not Cloud Storage) format) ⇒ string
    • [~getToken Fetches (or creates as needed) a unique token for a storage object()](#module_FirebaseStorageAdminEmulator..getToken Fetches (or creates as needed) a unique token for a storage object) ⇒ Promise.<string>
    • [~getMetadata Fetches the FileMetadata for the storage object. Custom/Client metadata is located in FileMetadata.metadata()](#module_FirebaseStorageAdminEmulator..getMetadata Fetches the FileMetadata for the storage object. Custom/Client metadata is located in FileMetadata.metadata) ⇒ FileMetadata
    • ~put(data, metadata) ⇒ Promise.<object>
    • ~putString(dataString, stringFormat, metadata) ⇒ Promise.<object>

Initializes the Storage service of the provided firebase app. Also instantiates various constants and helper functions. This is a WRAPPER around CLOUD STORAGE (admin) functions to emulate FIREBASE functionality, keeping a similar API between client & cloud code. NOTE: admin "references" ARE NOT the same as client references, and are NOT interchangeable. Do not mix client & admin code (not actually possible in this wrapper)

Kind: static method of FirebaseStorageAdminEmulator

Kind: inner class of FirebaseStorageAdminEmulator

• ~adminRef
  • new adminRef(bucket, path)
  • .fileRef : storageRef
  • .fullPath : string
  • .name : string
  • .bucket : string
  • .parent : storageRef
  • .storage : storageApp
  • .metadata : string

Create a class that emulates a Firebase Storage storageRef using Firebase Admin Cloud Storage Functions. This is not an exact replica, but one with similar static members and methods. Intended for use with a higher-level Wrapper library This returns an object that has many of the same members and methods as a Firebase storageRef, but only in conjunction with the methods here, and likely only with the "wrapper" it is defined for.

used to affect file operations to emulate Firebase Storage functions

Kind: instance property of adminRef

Full path, including file name

Kind: instance property of adminRef

filename portion only

Kind: instance property of adminRef

name of containing bucket

Kind: instance property of adminRef

Cloud Storage object don't really have a parent or root

Kind: instance property of adminRef

app instance

Kind: instance property of adminRef

access token

Kind: instance property of adminRef

creates and returns a new adminRef object from existin path(path) ⇒ StorageRefEmulation Kind: inner method of FirebaseStorageAdminEmulator

Deletes the referenced storage item() ⇒ Promise Kind: inner method of FirebaseStorageAdminEmulator

Generates a long-lived (essentially permanent until revoked) Public-Access URL for a storage item in FIREBASE (not Cloud Storage) format() ⇒ string Kind: inner method of FirebaseStorageAdminEmulator

Fetches (or creates as needed) a unique token for a storage object() ⇒ Promise.<string> Kind: inner method of FirebaseStorageAdminEmulator

Fetches the FileMetadata for the storage object. Custom/Client metadata is located in FileMetadata.metadata() ⇒ FileMetadata Kind: inner method of FirebaseStorageAdminEmulator

puts a block of data (and optional metadata) into storage at location specified by adminRef

Kind: inner method of FirebaseStorageAdminEmulator

puts a string (possibly encoded data) into a storage file described by the provided reference.

Kind: inner method of FirebaseStorageAdminEmulator

A set of helper-wrapper functions around firebase firestore, storage and auth. all-in-one wrapper for a solid subset of CLIENT-SIDE Firebase functions, with a consistent interface. There is a parallel set for ADMIN-SIDE functions as well. Intent is to treat Firestore as a hierarchical record-oriented database; originally conceived to port from one database to another. NOTE: Most helpers return PROMISE.REJECT if no documents are returned. it is assumed projects using this library might want to have an explicitly error trap for such events.

• FirebaseWrapper
  • static
    • .FirebaseWrapper(config) ⇒
    • .FirebaseWrapper(config) ⇒
  • inner
    • ~FirebaseConfigObject : Object
    • ~FirebaseConfigObject : Object

Kind: static method of FirebaseWrapper
Returns: none

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

Kind: static method of FirebaseWrapper
Returns: none

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

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

Kind: inner typedef of FirebaseWrapper
Properties

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

Kind: inner typedef of FirebaseWrapper
Properties

Kind: global constant
Category: Paginate Constants

Kind: global constant
Category: Paginate Constants

Kind: global constant
Category: Paginate Constants

Kind: global constant
Category: Paginate Constants

Kind: global constant
Category: Paginate Constants

Kind: global constant
Category: Paginate Constants

© 2020-2021 Tracy Hall