@dereekb/firebase 1.2.0 → 3.0.0

package/src/lib/client/function/function.factory.js

@@ -0,0 +1,36 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.lazyFirebaseFunctionsFactory = exports.firebaseFunctionMapFactory = void 0;
+const util_1 = require("@dereekb/util");
+const functions_1 = require("firebase/functions");
+function firebaseFunctionMapFactory(configMap) {
+    return (functionsInstance) => {
+        const mapFn = (config, key) => {
+            let httpCallableOptions;
+            if (config) {
+                httpCallableOptions = config.options;
+            }
+            const fn = (0, functions_1.httpsCallable)(functionsInstance, key, httpCallableOptions);
+            return fn;
+        };
+        const result = (0, util_1.mapObjectMap)(configMap, mapFn);
+        return result;
+    };
+}
+exports.firebaseFunctionMapFactory = firebaseFunctionMapFactory;
+function lazyFirebaseFunctionsFactory(configMap) {
+    return (functions) => {
+        const mapFn = (config, key) => {
+            const type = config[0];
+            const factory = config[1];
+            const getter = (0, util_1.cachedGetter)(() => factory(functions));
+            getter._type = type;
+            getter._key = key;
+            return getter;
+        };
+        const result = (0, util_1.mapObjectMap)(configMap, mapFn);
+        return result;
+    };
+}
+exports.lazyFirebaseFunctionsFactory = lazyFirebaseFunctionsFactory;
+//# sourceMappingURL=function.factory.js.map

package/src/lib/client/function/function.factory.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"function.factory.js","sourceRoot":"","sources":["../../../../../../../packages/firebase/src/lib/client/function/function.factory.ts"],"names":[],"mappings":";;;AAAA,wCAAyF;AACzF,kDAAoF;AAiBpF,SAAgB,0BAA0B,CAAoC,SAA2C;IACvH,OAAO,CAAC,iBAA4B,EAAE,EAAE;QACtC,MAAM,KAAK,GAAG,CAAoB,MAA2C,EAAE,GAAM,EAAE,EAAE;YACvF,IAAI,mBAAqD,CAAC;YAE1D,IAAI,MAAM,EAAE;gBACV,mBAAmB,GAAG,MAAM,CAAC,OAAO,CAAC;aACtC;YAED,MAAM,EAAE,GAAsC,IAAA,yBAAa,EAAC,iBAAiB,EAAE,GAAa,EAAE,mBAAmB,CAAC,CAAC;YACnH,OAAO,EAAE,CAAC;QACZ,CAAC,CAAC;QAEF,MAAM,MAAM,GAA2B,IAAA,mBAAY,EAAmC,SAAS,EAAE,KAAK,CAAC,CAAC;QACxG,OAAO,MAAM,CAAC;IAChB,CAAC,CAAC;AACJ,CAAC;AAhBD,gEAgBC;AA+BD,SAAgB,4BAA4B,CAA0G,SAAY;IAChK,OAAO,CAAC,SAAoB,EAAE,EAAE;QAE9B,MAAM,KAAK,GAAG,CAAoB,MAA6C,EAAE,GAAM,EAAE,EAAE;YACzF,MAAM,IAAI,GAAG,MAAM,CAAC,CAAC,CAAC,CAAC;YACvB,MAAM,OAAO,GAAqC,MAAM,CAAC,CAAC,CAAC,CAAC;YAC5D,MAAM,MAAM,GAAG,IAAA,mBAAY,EAAC,GAAG,EAAE,CAAC,OAAO,CAAC,SAAS,CAAC,CAA4C,CAAC;YACjG,MAAM,CAAC,KAAK,GAAG,IAAI,CAAC;YACpB,MAAM,CAAC,IAAI,GAAG,GAAa,CAAC;YAC5B,OAAO,MAAM,CAAC;QAChB,CAAC,CAAC;QAEF,MAAM,MAAM,GAA6B,IAAA,mBAAY,EAAC,SAAS,EAAE,KAAY,CAAC,CAAC;QAC/E,OAAO,MAAM,CAAC;IAChB,CAAC,CAAC;AACJ,CAAC;AAfD,oEAeC"}

package/src/lib/client/function/function.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=function.js.map

package/src/lib/client/function/function.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"function.js","sourceRoot":"","sources":["../../../../../../../packages/firebase/src/lib/client/function/function.ts"],"names":[],"mappings":""}

package/src/lib/client/function/index.d.ts

@@ -0,0 +1,2 @@
+export * from './function';
+export * from './function.factory';

package/src/lib/client/function/index.js

@@ -0,0 +1,6 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const tslib_1 = require("tslib");
+tslib_1.__exportStar(require("./function"), exports);
+tslib_1.__exportStar(require("./function.factory"), exports);
+//# sourceMappingURL=index.js.map

package/src/lib/client/function/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../../../../packages/firebase/src/lib/client/function/index.ts"],"names":[],"mappings":";;;AAAA,qDAA2B;AAC3B,6DAAmC"}

package/src/lib/client/index.d.ts

@@ -0,0 +1,2 @@
+export * from './firestore';
+export * from './function';

package/src/lib/client/index.js

@@ -0,0 +1,6 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const tslib_1 = require("tslib");
+tslib_1.__exportStar(require("./firestore"), exports);
+tslib_1.__exportStar(require("./function"), exports);
+//# sourceMappingURL=index.js.map

package/src/lib/client/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../../../packages/firebase/src/lib/client/index.ts"],"names":[],"mappings":";;;AAAA,sDAA4B;AAC5B,qDAA2B"}

package/src/lib/common/auth/auth.d.ts

@@ -0,0 +1,4 @@
+/**
+ * Firebase User Identifier (UID)
+ */
+export declare type FirebaseAuthUserId = string;

package/src/lib/common/auth/auth.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=auth.js.map

package/src/lib/common/auth/auth.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"auth.js","sourceRoot":"","sources":["../../../../../../../packages/firebase/src/lib/common/auth/auth.ts"],"names":[],"mappings":""}

package/src/lib/common/auth/index.d.ts

@@ -0,0 +1 @@
+export * from './auth';

package/src/lib/common/auth/index.js

@@ -0,0 +1,5 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const tslib_1 = require("tslib");
+tslib_1.__exportStar(require("./auth"), exports);
+//# sourceMappingURL=index.js.map

package/src/lib/common/auth/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../../../../packages/firebase/src/lib/common/auth/index.ts"],"names":[],"mappings":";;;AAAA,iDAAuB"}

package/src/lib/common/firestore/accessor/accessor.batch.d.ts

@@ -0,0 +1,3 @@
+import { WriteBatch } from "../types";
+import { FirestoreDocumentDataAccessorFactory } from "./accessor";
+export declare type WriteBatchAccessorFactory = <T>(writeBatch: WriteBatch) => FirestoreDocumentDataAccessorFactory<T>;

package/src/lib/common/firestore/accessor/accessor.batch.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=accessor.batch.js.map

package/src/lib/common/firestore/accessor/accessor.batch.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"accessor.batch.js","sourceRoot":"","sources":["../../../../../../../../packages/firebase/src/lib/common/firestore/accessor/accessor.batch.ts"],"names":[],"mappings":""}

package/src/lib/common/firestore/accessor/accessor.d.ts

@@ -0,0 +1,87 @@
+import { Maybe } from "@dereekb/util";
+import { WriteResult, SnapshotOptions, DocumentReference, DocumentSnapshot, UpdateData, WithFieldValue, PartialWithFieldValue, SetOptions, Precondition } from "../types";
+import { Observable, OperatorFunction } from 'rxjs';
+import { DocumentReferenceRef } from '../reference';
+export interface FirestoreDocumentDeleteParams {
+    precondition?: Precondition;
+}
+export interface FirestoreDocumentUpdateParams {
+    precondition?: Precondition;
+}
+/**
+ * Firestore database accessor instance used to retrieve and make changes to items in the database.
+ */
+export interface FirestoreDocumentDataAccessor<T> extends DocumentReferenceRef<T> {
+    /**
+     * Returns a database stream of DocumentSnapshots.
+     */
+    stream(): Observable<DocumentSnapshot<T>>;
+    /**
+     * Returns the current snapshot.
+     */
+    get(): Promise<DocumentSnapshot<T>>;
+    /**
+     * Whether or not the target object currently exists.
+     */
+    exists(): Promise<boolean>;
+    /**
+     * Deletes the document
+     */
+    delete(params?: FirestoreDocumentDeleteParams): Promise<WriteResult | void>;
+    /**
+     * Sets the data in the database. Can additionally pass options to configure merging of fields.
+     *
+     * @param data
+     */
+    set(data: PartialWithFieldValue<T>, options: SetOptions): Promise<WriteResult | void>;
+    set(data: WithFieldValue<T>): Promise<WriteResult | void>;
+    /**
+     * Directly updates the data in the database. If the document doesn't exist, it will fail.
+     *
+     * NOTE: Update will skip any conversions and directly set the data.
+     * If you rely on the converter/conversion functionality, use set() with merge: true instead of update.
+     *
+     * @param data
+     */
+    update(data: UpdateData<T>, params?: FirestoreDocumentUpdateParams): Promise<WriteResult | void>;
+}
+/**
+ * Contextual interface used for making a FirestoreDocumentModifier for a specific document.
+ */
+export interface FirestoreDocumentDataAccessorFactory<T> {
+    /**
+     * Creates a new FirestoreDocumentDataAccessor for the input ref.
+     *
+     * @param ref
+     */
+    accessorFor(ref: DocumentReference<T>): FirestoreDocumentDataAccessor<T>;
+}
+/**
+ * Maps data from the given snapshot stream.
+ *
+ * Maybe values are filtered from the stream until data is provided.
+ *
+ * @param stream
+ * @param options
+ * @returns
+ */
+export declare function dataFromSnapshotStream<T>(stream: Observable<DocumentSnapshot<T>>, options?: SnapshotOptions): Observable<T>;
+/**
+ * OperatorFunction to map data from the snapshot.
+ *
+ * @param options
+ * @returns
+ */
+export declare function mapDataFromSnapshot<T>(options?: SnapshotOptions): OperatorFunction<DocumentSnapshot<T>, Maybe<T>>;
+/**
+ * Creates or updates the target object using the input data.
+ *
+ * First checks that the data exists before writing to the datastore.
+ *
+ * If it does not exist, will call set without merge options in order to fully initialize the object's data.
+ * If it does exist, update is done using set + merge on all defined values.
+ *
+ * @param data
+ */
+export declare type CreateOrUpdateWithAccessorSetFunction<T> = (data: Partial<T>) => Promise<WriteResult | void>;
+export declare function createOrUpdateWithAccessorSet<T>(accessor: FirestoreDocumentDataAccessor<T>): (data: Partial<T>) => Promise<WriteResult | void>;

package/src/lib/common/firestore/accessor/accessor.default.d.ts

@@ -0,0 +1,2 @@
+import { FirestoreDocumentDataAccessorFactory } from "./accessor";
+export declare type DefaultFirestoreAccessorFactory<T> = () => FirestoreDocumentDataAccessorFactory<T>;

package/src/lib/common/firestore/accessor/accessor.default.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=accessor.default.js.map

package/src/lib/common/firestore/accessor/accessor.default.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"accessor.default.js","sourceRoot":"","sources":["../../../../../../../../packages/firebase/src/lib/common/firestore/accessor/accessor.default.ts"],"names":[],"mappings":""}

package/src/lib/{firestore → common/firestore/accessor}/accessor.js

@@ -1,8 +1,10 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.mapDataFromSnapshot = exports.dataFromSnapshotStream = void 0;
+exports.createOrUpdateWithAccessorSet = exports.mapDataFromSnapshot = exports.dataFromSnapshotStream = void 0;
 const rxjs_1 = require("@dereekb/rxjs");
+const util_1 = require("@dereekb/util");
 const rxjs_2 = require("rxjs");
+// MARK: Utility
 /**
  * Maps data from the given snapshot stream.
  *
@@ -26,4 +28,18 @@ function mapDataFromSnapshot(options) {
     return (0, rxjs_2.map)((x) => x.data(options));
 }
 exports.mapDataFromSnapshot = mapDataFromSnapshot;
+function createOrUpdateWithAccessorSet(accessor) {
+    return (data) => {
+        return accessor.exists().then((exists) => {
+            if (exists) {
+                const update = (0, util_1.filterUndefinedValues)(data);
+                return accessor.set(update, { merge: true });
+            }
+            else {
+                return accessor.set(data);
+            }
+        });
+    };
+}
+exports.createOrUpdateWithAccessorSet = createOrUpdateWithAccessorSet;
 //# sourceMappingURL=accessor.js.map

package/src/lib/common/firestore/accessor/accessor.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"accessor.js","sourceRoot":"","sources":["../../../../../../../../packages/firebase/src/lib/common/firestore/accessor/accessor.ts"],"names":[],"mappings":";;;AAAA,wCAA4C;AAC5C,wCAA6D;AAE7D,+BAAyD;AA+DzD,gBAAgB;AAChB;;;;;;;;GAQG;AACH,SAAgB,sBAAsB,CAAI,MAAuC,EAAE,OAAyB;IAC1G,OAAO,MAAM,CAAC,IAAI,CAAC,mBAAmB,CAAC,OAAO,CAAC,EAAE,IAAA,kBAAW,GAAE,CAAC,CAAC;AAClE,CAAC;AAFD,wDAEC;AAED;;;;;GAKG;AACH,SAAgB,mBAAmB,CAAI,OAAyB;IAC9D,OAAO,IAAA,UAAG,EAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC,CAAC;AACrC,CAAC;AAFD,kDAEC;AAcD,SAAgB,6BAA6B,CAAI,QAA0C;IACzF,OAAO,CAAC,IAAgB,EAAE,EAAE;QAC1B,OAAO,QAAQ,CAAC,MAAM,EAAE,CAAC,IAAI,CAAC,CAAC,MAAM,EAAE,EAAE;YACvC,IAAI,MAAM,EAAE;gBACV,MAAM,MAAM,GAAG,IAAA,4BAAqB,EAAC,IAAI,CAAC,CAAC;gBAC3C,OAAO,QAAQ,CAAC,GAAG,CAAC,MAAM,EAAE,EAAE,KAAK,EAAE,IAAI,EAAE,CAAC,CAAC;aAC9C;iBAAM;gBACL,OAAO,QAAQ,CAAC,GAAG,CAAC,IAAyB,CAAC,CAAC;aAChD;QACH,CAAC,CAAC,CAAC;IACL,CAAC,CAAC;AACJ,CAAC;AAXD,sEAWC"}

package/src/lib/common/firestore/accessor/accessor.transaction.d.ts

@@ -0,0 +1,3 @@
+import { Transaction } from "../types";
+import { FirestoreDocumentDataAccessorFactory } from "./accessor";
+export declare type TransactionAccessorFactory<T = any> = (transaction: Transaction) => FirestoreDocumentDataAccessorFactory<T>;

package/src/lib/common/firestore/accessor/accessor.transaction.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=accessor.transaction.js.map

package/src/lib/common/firestore/accessor/accessor.transaction.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"accessor.transaction.js","sourceRoot":"","sources":["../../../../../../../../packages/firebase/src/lib/common/firestore/accessor/accessor.transaction.ts"],"names":[],"mappings":""}

package/src/lib/common/firestore/accessor/context.batch.d.ts

@@ -0,0 +1,7 @@
+import { WriteBatch } from "../types";
+import { FirestoreDocumentContext, FirestoreDocumentContextType } from "./context";
+export declare type WriteBatchFirestoreDocumentContextFactory = <T>(writeBatch: WriteBatch) => WriteBatchFirestoreDocumentContext<T>;
+export interface WriteBatchFirestoreDocumentContext<T> extends FirestoreDocumentContext<T> {
+    readonly contextType: FirestoreDocumentContextType.BATCH;
+    readonly batch: WriteBatch;
+}

package/src/lib/common/firestore/accessor/context.batch.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=context.batch.js.map

package/src/lib/common/firestore/accessor/context.batch.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"context.batch.js","sourceRoot":"","sources":["../../../../../../../../packages/firebase/src/lib/common/firestore/accessor/context.batch.ts"],"names":[],"mappings":""}

package/src/lib/common/firestore/accessor/context.default.d.ts

@@ -0,0 +1,5 @@
+import { FirestoreDocumentContext, FirestoreDocumentContextType } from "./context";
+export declare type DefaultFirestoreDocumentContextFactory = <T>() => FirestoreDocumentContext<T>;
+export interface DefaultFirestoreDocumentContext<T> extends FirestoreDocumentContext<T> {
+    readonly contextType: FirestoreDocumentContextType.NONE;
+}

package/src/lib/common/firestore/accessor/context.default.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=context.default.js.map

package/src/lib/common/firestore/accessor/context.default.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"context.default.js","sourceRoot":"","sources":["../../../../../../../../packages/firebase/src/lib/common/firestore/accessor/context.default.ts"],"names":[],"mappings":""}

package/src/lib/common/firestore/accessor/context.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"context.js","sourceRoot":"","sources":["../../../../../../../../packages/firebase/src/lib/common/firestore/accessor/context.ts"],"names":[],"mappings":";;;AAEA;;;;GAIG;AACH,IAAY,4BAIX;AAJD,WAAY,4BAA4B;IACtC,6CAAa,CAAA;IACb,2DAA2B,CAAA;IAC3B,+CAAe,CAAA;AACjB,CAAC,EAJW,4BAA4B,GAA5B,oCAA4B,KAA5B,oCAA4B,QAIvC"}

package/src/lib/common/firestore/accessor/context.transaction.d.ts

@@ -0,0 +1,7 @@
+import { Transaction } from "../types";
+import { FirestoreDocumentContext, FirestoreDocumentContextType } from "./context";
+export declare type TransactionFirestoreDocumentContextFactory = <T>(transaction: Transaction) => TransactionFirestoreDocumentContext<T>;
+export interface TransactionFirestoreDocumentContext<T> extends FirestoreDocumentContext<T> {
+    readonly contextType: FirestoreDocumentContextType.TRANSACTION;
+    readonly transaction: Transaction;
+}

package/src/lib/common/firestore/accessor/context.transaction.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=context.transaction.js.map

package/src/lib/common/firestore/accessor/context.transaction.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"context.transaction.js","sourceRoot":"","sources":["../../../../../../../../packages/firebase/src/lib/common/firestore/accessor/context.transaction.ts"],"names":[],"mappings":""}

package/src/lib/common/firestore/accessor/document.d.ts

@@ -0,0 +1,121 @@
+import { Observable } from 'rxjs';
+import { FirestoreAccessorDriverRef } from '../driver/accessor';
+import { DocumentReference, CollectionReference, Transaction, WriteBatch, DocumentSnapshot, SnapshotOptions, WriteResult } from '../types';
+import { FirestoreDocumentDataAccessor } from './accessor';
+import { CollectionReferenceRef, DocumentReferenceRef } from '../reference';
+import { FirestoreDocumentContext } from './context';
+export interface FirestoreDocument<T, A extends FirestoreDocumentDataAccessor<T> = FirestoreDocumentDataAccessor<T>> extends DocumentReferenceRef<T>, CollectionReferenceRef<T> {
+    readonly accessor: A;
+    readonly id: string;
+}
+/**
+ * Abstract FirestoreDocument implementation that extends a FirestoreDocumentDataAccessor.
+ */
+export declare abstract class AbstractFirestoreDocument<T, D extends AbstractFirestoreDocument<T, any, any>, A extends FirestoreDocumentDataAccessor<T> = FirestoreDocumentDataAccessor<T>> implements FirestoreDocument<T, A>, FirestoreDocumentAccessorRef<T, D>, CollectionReferenceRef<T> {
+    readonly accessor: A;
+    readonly documentAccessor: FirestoreDocumentAccessor<T, D>;
+    readonly stream$: Observable<DocumentSnapshot<T>>;
+    readonly data$: Observable<T>;
+    constructor(accessor: A, documentAccessor: FirestoreDocumentAccessor<T, D>);
+    get id(): string;
+    get documentRef(): DocumentReference<T>;
+    get collection(): CollectionReference<T>;
+    snapshot(): Promise<DocumentSnapshot<T>>;
+    snapshotData(options?: SnapshotOptions): Promise<T | undefined>;
+    createOrUpdate(data: Partial<T>): Promise<WriteResult | void>;
+}
+export interface FirestoreDocumentAccessorRef<T, D extends FirestoreDocument<T> = FirestoreDocument<T>> {
+    readonly documentAccessor: FirestoreDocumentAccessor<T, D>;
+}
+export interface FirestoreDocumentAccessor<T, D extends FirestoreDocument<T> = FirestoreDocument<T>> extends CollectionReferenceRef<T>, FirestoreAccessorDriverRef {
+    readonly databaseContext: FirestoreDocumentContext<T>;
+    /**
+     * Creates a new document.
+     */
+    newDocument(): D;
+    /**
+     * Loads a document from the datastore with the given id/path.
+     *
+     * @param ref
+     */
+    loadDocumentForPath(path: string, ...pathSegments: string[]): D;
+    /**
+     * Loads a document from the datastore.
+     *
+     * @param ref
+     */
+    loadDocument(ref: DocumentReference<T>): D;
+    /**
+     * Loads a document from an existing FirestoreDocument
+     *
+     * @param document
+     */
+    loadDocumentFrom(document: FirestoreDocument<T>): D;
+    /**
+     *
+     * @param path
+     * @param pathSegments
+     */
+    documentRefForPath(path: string, ...pathSegments: string[]): DocumentReference<T>;
+}
+/**
+ * Used to generate a FirestoreDocument from an input FirestoreDocumentDataAccessor instance.
+ */
+export declare type FirestoreDocumentFactoryFunction<T, D extends FirestoreDocument<T> = FirestoreDocument<T>> = (accessor: FirestoreDocumentDataAccessor<T>, documentAccessor: FirestoreDocumentAccessor<T, D>) => D;
+/**
+ * Factory function used for creating a FirestoreDocumentAccessor.
+ */
+export declare type FirestoreDocumentAccessorFactoryFunction<T, D extends FirestoreDocument<T> = FirestoreDocument<T>> = (context?: FirestoreDocumentContext<T>) => FirestoreDocumentAccessor<T, D>;
+/**
+ * Factory type used for creating a FirestoreDocumentAccessor.
+ */
+export interface FirestoreDocumentAccessorFactory<T, D extends FirestoreDocument<T> = FirestoreDocument<T>> {
+    /**
+     * Creates a new FirestoreDocumentAccessor using the given context.
+     *
+     * @param context Optional context to retrieve items from.
+     */
+    readonly documentAccessor: FirestoreDocumentAccessorFactoryFunction<T, D>;
+}
+/**
+ * FirestoreDocumentAccessor configuration.
+ */
+export interface FirestoreDocumentAccessorFactoryConfig<T, D extends FirestoreDocument<T> = FirestoreDocument<T>> extends CollectionReferenceRef<T>, FirestoreAccessorDriverRef {
+    readonly makeDocument: FirestoreDocumentFactoryFunction<T, D>;
+}
+export declare function firestoreDocumentAccessorFactory<T, D extends FirestoreDocument<T> = FirestoreDocument<T>>(config: FirestoreDocumentAccessorFactoryConfig<T, D>): FirestoreDocumentAccessorFactoryFunction<T, D>;
+export interface FirestoreDocumentAccessorForTransactionFactory<T, D extends FirestoreDocument<T> = FirestoreDocument<T>> {
+    /**
+     * Creates a new FirestoreDocumentAccessor for a Transaction.
+     */
+    documentAccessorForTransaction(transaction: Transaction): FirestoreDocumentAccessor<T, D>;
+}
+export interface FirestoreDocumentAccessorForWriteBatchFactory<T, D extends FirestoreDocument<T> = FirestoreDocument<T>> {
+    /**
+     * Creates a new FirestoreDocumentAccessor for a WriteBatch.
+     */
+    documentAccessorForWriteBatch(writeBatch: WriteBatch): FirestoreDocumentAccessor<T, D>;
+}
+export interface FirestoreDocumentAccessorContextExtensionConfig<T, D extends FirestoreDocument<T> = FirestoreDocument<T>> extends FirestoreAccessorDriverRef {
+    readonly documentAccessor: FirestoreDocumentAccessorFactoryFunction<T, D>;
+}
+export interface FirestoreDocumentAccessorContextExtension<T, D extends FirestoreDocument<T> = FirestoreDocument<T>> extends FirestoreDocumentAccessorFactory<T, D>, FirestoreDocumentAccessorForTransactionFactory<T, D>, FirestoreDocumentAccessorForWriteBatchFactory<T, D> {
+}
+export declare function firestoreDocumentAccessorContextExtension<T, D extends FirestoreDocument<T> = FirestoreDocument<T>>({ documentAccessor, firestoreAccessorDriver }: FirestoreDocumentAccessorContextExtensionConfig<T, D>): FirestoreDocumentAccessorContextExtension<T, D>;
+export interface FirestoreDocumentWithParent<P, T, A extends FirestoreDocumentDataAccessor<T> = FirestoreDocumentDataAccessor<T>> extends FirestoreDocument<T, A> {
+    readonly parent: DocumentReference<P>;
+}
+export declare abstract class AbstractFirestoreDocumentWithParent<P, T, D extends AbstractFirestoreDocument<T, any, any>, A extends FirestoreDocumentDataAccessor<T> = FirestoreDocumentDataAccessor<T>> extends AbstractFirestoreDocument<T, D, A> implements FirestoreDocumentWithParent<P, T, A> {
+    readonly parent: DocumentReference<P>;
+    constructor(parent: DocumentReference<P>, accessor: A, documentAccessor: FirestoreDocumentAccessor<T, D>);
+}
+export interface FirestoreSingleDocumentAccessor<T, D extends FirestoreDocument<T> = FirestoreDocument<T>> {
+    loadDocument(): D;
+    loadDocumentForTransaction(transaction: Transaction): D;
+    loadDocumentForWriteBatch(writeBatch: WriteBatch): D;
+}
+export interface FirestoreSingleDocumentAccessorConfig<T, D extends FirestoreDocument<T> = FirestoreDocument<T>> {
+    readonly singleItemIdentifier: string;
+    readonly accessors: FirestoreDocumentAccessorContextExtension<T, D>;
+}
+export declare function firestoreSingleDocumentAccessor<T, D extends FirestoreDocument<T> = FirestoreDocument<T>>(config: FirestoreSingleDocumentAccessorConfig<T, D>): FirestoreSingleDocumentAccessor<T, D>;

package/src/lib/common/firestore/accessor/document.js

@@ -0,0 +1,106 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.firestoreSingleDocumentAccessor = exports.AbstractFirestoreDocumentWithParent = exports.firestoreDocumentAccessorContextExtension = exports.firestoreDocumentAccessorFactory = exports.AbstractFirestoreDocument = void 0;
+const accessor_1 = require("./accessor");
+/**
+ * Abstract FirestoreDocument implementation that extends a FirestoreDocumentDataAccessor.
+ */
+class AbstractFirestoreDocument {
+    constructor(accessor, documentAccessor) {
+        this.accessor = accessor;
+        this.documentAccessor = documentAccessor;
+        this.stream$ = this.accessor.stream();
+        this.data$ = (0, accessor_1.dataFromSnapshotStream)(this.stream$);
+    }
+    get id() {
+        return this.documentRef.id;
+    }
+    get documentRef() {
+        return this.accessor.documentRef;
+    }
+    get collection() {
+        return this.documentAccessor.collection;
+    }
+    snapshot() {
+        return this.accessor.get();
+    }
+    snapshotData(options) {
+        return this.snapshot().then(x => x.data(options));
+    }
+    createOrUpdate(data) {
+        return (0, accessor_1.createOrUpdateWithAccessorSet)(this.accessor)(data);
+    }
+}
+exports.AbstractFirestoreDocument = AbstractFirestoreDocument;
+function firestoreDocumentAccessorFactory(config) {
+    const { firestoreAccessorDriver, collection } = config;
+    return (context) => {
+        const databaseContext = context !== null && context !== void 0 ? context : config.firestoreAccessorDriver.defaultContextFactory();
+        const dataAccessorFactory = databaseContext.accessorFactory;
+        function loadDocument(ref) {
+            const accessor = dataAccessorFactory.accessorFor(ref);
+            return config.makeDocument(accessor, documentAccessor);
+        }
+        ;
+        function documentRefForPath(path, ...pathSegments) {
+            return firestoreAccessorDriver.doc(collection, path, ...pathSegments);
+        }
+        const documentAccessor = {
+            newDocument() {
+                const newDocRef = firestoreAccessorDriver.doc(collection);
+                return this.loadDocument(newDocRef);
+            },
+            loadDocumentForPath(path, ...pathSegments) {
+                if (!path) {
+                    throw new Error('Path was not provided to loadDocumentForPath(). Use newDocument() for generating an id.');
+                }
+                return this.loadDocument(documentRefForPath(path, ...pathSegments));
+            },
+            loadDocumentFrom(document) {
+                return loadDocument(document.documentRef);
+            },
+            loadDocument,
+            documentRefForPath,
+            firestoreAccessorDriver,
+            databaseContext,
+            collection
+        };
+        return documentAccessor;
+    };
+}
+exports.firestoreDocumentAccessorFactory = firestoreDocumentAccessorFactory;
+function firestoreDocumentAccessorContextExtension({ documentAccessor, firestoreAccessorDriver }) {
+    return {
+        documentAccessor,
+        documentAccessorForTransaction(transaction) {
+            return documentAccessor(firestoreAccessorDriver.transactionContextFactory(transaction));
+        },
+        documentAccessorForWriteBatch(writeBatch) {
+            return documentAccessor(firestoreAccessorDriver.writeBatchContextFactory(writeBatch));
+        }
+    };
+}
+exports.firestoreDocumentAccessorContextExtension = firestoreDocumentAccessorContextExtension;
+class AbstractFirestoreDocumentWithParent extends AbstractFirestoreDocument {
+    constructor(parent, accessor, documentAccessor) {
+        super(accessor, documentAccessor);
+        this.parent = parent;
+    }
+}
+exports.AbstractFirestoreDocumentWithParent = AbstractFirestoreDocumentWithParent;
+function firestoreSingleDocumentAccessor(config) {
+    const { singleItemIdentifier: identifier, accessors } = config;
+    return {
+        loadDocument() {
+            return accessors.documentAccessor().loadDocumentForPath(identifier);
+        },
+        loadDocumentForTransaction(transaction) {
+            return accessors.documentAccessorForTransaction(transaction).loadDocumentForPath(identifier);
+        },
+        loadDocumentForWriteBatch(writeBatch) {
+            return accessors.documentAccessorForWriteBatch(writeBatch).loadDocumentForPath(identifier);
+        }
+    };
+}
+exports.firestoreSingleDocumentAccessor = firestoreSingleDocumentAccessor;
+//# sourceMappingURL=document.js.map

package/src/lib/common/firestore/accessor/document.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"document.js","sourceRoot":"","sources":["../../../../../../../../packages/firebase/src/lib/common/firestore/accessor/document.ts"],"names":[],"mappings":";;;AAGA,yCAAkH;AASlH;;GAEG;AACH,MAAsB,yBAAyB;IAQ7C,YAAqB,QAAW,EAAW,gBAAiD;QAAvE,aAAQ,GAAR,QAAQ,CAAG;QAAW,qBAAgB,GAAhB,gBAAgB,CAAiC;QAHnF,YAAO,GAAG,IAAI,CAAC,QAAQ,CAAC,MAAM,EAAE,CAAC;QACjC,UAAK,GAAkB,IAAA,iCAAsB,EAAC,IAAI,CAAC,OAAO,CAAC,CAAC;IAE2B,CAAC;IAEjG,IAAI,EAAE;QACJ,OAAO,IAAI,CAAC,WAAW,CAAC,EAAE,CAAC;IAC7B,CAAC;IAED,IAAI,WAAW;QACb,OAAO,IAAI,CAAC,QAAQ,CAAC,WAAW,CAAC;IACnC,CAAC;IAED,IAAI,UAAU;QACZ,OAAO,IAAI,CAAC,gBAAgB,CAAC,UAAU,CAAC;IAC1C,CAAC;IAED,QAAQ;QACN,OAAO,IAAI,CAAC,QAAQ,CAAC,GAAG,EAAE,CAAC;IAC7B,CAAC;IAED,YAAY,CAAC,OAAyB;QACpC,OAAO,IAAI,CAAC,QAAQ,EAAE,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC,CAAC;IACpD,CAAC;IAED,cAAc,CAAC,IAAgB;QAC7B,OAAO,IAAA,wCAA6B,EAAC,IAAI,CAAC,QAAQ,CAAC,CAAC,IAAI,CAAC,CAAC;IAC5D,CAAC;CAEF;AAlCD,8DAkCC;AA6ED,SAAgB,gCAAgC,CAA2D,MAAoD;IAC7J,MAAM,EAAE,uBAAuB,EAAE,UAAU,EAAE,GAAG,MAAM,CAAC;IACvD,OAAO,CAAC,OAAqC,EAAE,EAAE;QAC/C,MAAM,eAAe,GAAgC,OAAO,aAAP,OAAO,cAAP,OAAO,GAAI,MAAM,CAAC,uBAAuB,CAAC,qBAAqB,EAAE,CAAC;QAEvH,MAAM,mBAAmB,GAAG,eAAe,CAAC,eAAe,CAAC;QAE5D,SAAS,YAAY,CAAC,GAAyB;YAC7C,MAAM,QAAQ,GAAG,mBAAmB,CAAC,WAAW,CAAC,GAAG,CAAC,CAAC;YACtD,OAAO,MAAM,CAAC,YAAY,CAAC,QAAQ,EAAE,gBAAgB,CAAC,CAAC;QACzD,CAAC;QAAA,CAAC;QAEF,SAAS,kBAAkB,CAAC,IAAY,EAAE,GAAG,YAAsB;YACjE,OAAO,uBAAuB,CAAC,GAAG,CAAC,UAAU,EAAE,IAAI,EAAE,GAAG,YAAY,CAAC,CAAC;QACxE,CAAC;QAED,MAAM,gBAAgB,GAAoC;YACxD,WAAW;gBACT,MAAM,SAAS,GAAG,uBAAuB,CAAC,GAAG,CAAC,UAAU,CAAC,CAAC;gBAC1D,OAAO,IAAI,CAAC,YAAY,CAAC,SAAS,CAAC,CAAC;YACtC,CAAC;YACD,mBAAmB,CAAC,IAAY,EAAE,GAAG,YAAsB;gBACzD,IAAI,CAAC,IAAI,EAAE;oBACT,MAAM,IAAI,KAAK,CAAC,yFAAyF,CAAC,CAAC;iBAC5G;gBAED,OAAO,IAAI,CAAC,YAAY,CAAC,kBAAkB,CAAC,IAAI,EAAE,GAAG,YAAY,CAAC,CAAC,CAAC;YACtE,CAAC;YACD,gBAAgB,CAAC,QAA8B;gBAC7C,OAAO,YAAY,CAAC,QAAQ,CAAC,WAAW,CAAC,CAAC;YAC5C,CAAC;YACD,YAAY;YACZ,kBAAkB;YAClB,uBAAuB;YACvB,eAAe;YACf,UAAU;SACX,CAAC;QAEF,OAAO,gBAAgB,CAAC;IAC1B,CAAC,CAAC;AACJ,CAAC;AAxCD,4EAwCC;AA2BD,SAAgB,yCAAyC,CAA2D,EAAE,gBAAgB,EAAE,uBAAuB,EAAyD;IACtN,OAAO;QACL,gBAAgB;QAChB,8BAA8B,CAAC,WAAwB;YACrD,OAAO,gBAAgB,CAAC,uBAAuB,CAAC,yBAAyB,CAAC,WAAW,CAAC,CAAC,CAAC;QAC1F,CAAC;QACD,6BAA6B,CAAC,UAAsB;YAClD,OAAO,gBAAgB,CAAC,uBAAuB,CAAC,wBAAwB,CAAC,UAAU,CAAC,CAAC,CAAC;QACxF,CAAC;KACF,CAAC;AACJ,CAAC;AAVD,8FAUC;AAOD,MAAsB,mCAGlB,SAAQ,yBAAkC;IAE5C,YAAqB,MAA4B,EAAE,QAAW,EAAE,gBAAiD;QAC/G,KAAK,CAAC,QAAQ,EAAE,gBAAgB,CAAC,CAAC;QADf,WAAM,GAAN,MAAM,CAAsB;IAEjD,CAAC;CAEF;AATD,kFASC;AAcD,SAAgB,+BAA+B,CAA2D,MAAmD;IAC3J,MAAM,EAAE,oBAAoB,EAAE,UAAU,EAAE,SAAS,EAAE,GAAG,MAAM,CAAC;IAE/D,OAAO;QACL,YAAY;YACV,OAAO,SAAS,CAAC,gBAAgB,EAAE,CAAC,mBAAmB,CAAC,UAAU,CAAC,CAAC;QACtE,CAAC;QACD,0BAA0B,CAAC,WAAwB;YACjD,OAAO,SAAS,CAAC,8BAA8B,CAAC,WAAW,CAAC,CAAC,mBAAmB,CAAC,UAAU,CAAC,CAAC;QAC/F,CAAC;QACD,yBAAyB,CAAC,UAAsB;YAC9C,OAAO,SAAS,CAAC,6BAA6B,CAAC,UAAU,CAAC,CAAC,mBAAmB,CAAC,UAAU,CAAC,CAAC;QAC7F,CAAC;KACF,CAAC;AACJ,CAAC;AAdD,0EAcC"}

package/src/lib/common/firestore/accessor/document.utility.d.ts

@@ -0,0 +1,43 @@
+import { Maybe } from '@dereekb/util';
+import { DocumentDataWithId, DocumentReference, DocumentSnapshot, QuerySnapshot, Transaction } from '../types';
+import { FirestoreDocument, FirestoreDocumentAccessor, FirestoreDocumentAccessorContextExtension } from './document';
+export declare function newDocuments<T, D extends FirestoreDocument<T>>(documentAccessor: FirestoreDocumentAccessor<T, D>, count: number): D[];
+export interface MakeDocumentsParams<T, D extends FirestoreDocument<T> = FirestoreDocument<T>> {
+    count: number;
+    /**
+     * Initializes the input document with the returned data.
+     *
+     * This function may also optionally perform tasks with the passed document and return null/undefined.
+     */
+    init: (i: number, document: D) => Maybe<T> | Promise<Maybe<T>>;
+}
+/**
+ * Makes a number of new documents.
+ *
+ * @param documentAccessor
+ * @param make
+ * @returns
+ */
+export declare function makeDocuments<T, D extends FirestoreDocument<T>>(documentAccessor: FirestoreDocumentAccessor<T, D>, make: MakeDocumentsParams<T, D>): Promise<D[]>;
+export declare function getDocumentSnapshots<T, D extends FirestoreDocument<T>>(documents: D[]): Promise<DocumentSnapshot<T>[]>;
+export declare function loadDocumentsForSnapshots<T, D extends FirestoreDocument<T>>(accessor: FirestoreDocumentAccessor<T, D>, snapshots: QuerySnapshot<T>): D[];
+export declare function loadDocumentsForDocumentReferences<T, D extends FirestoreDocument<T>>(accessor: FirestoreDocumentAccessor<T, D>, refs: DocumentReference<T>[]): D[];
+export declare function loadDocumentsForValues<I, T, D extends FirestoreDocument<T>>(accessor: FirestoreDocumentAccessor<T, D>, values: I[], getRef: (value: I) => DocumentReference<T>): D[];
+/**
+ * Used for loading documents for the input references.
+ */
+export declare type FirestoreDocumentLoader<T, D extends FirestoreDocument<T>> = (references: DocumentReference<T>[], transaction?: Transaction) => D[];
+/**
+ * Used to make a FirestoreDocumentLoader.
+ *
+ * @param accessorContext
+ * @returns
+ */
+export declare function firestoreDocumentLoader<T, D extends FirestoreDocument<T>>(accessorContext: FirestoreDocumentAccessorContextExtension<T, D>): FirestoreDocumentLoader<T, D>;
+/**
+ * Creates a DocumentDataWithId from the input DocumentSnapshot. If the data does not exist, returns undefined.
+ *
+ * @param snapshot
+ * @returns
+ */
+export declare function documentDataWithId<T>(snapshot: DocumentSnapshot<T>): Maybe<DocumentDataWithId<T>>;