@dereekb/firebase 0.0.1

package/README.md

@@ -0,0 +1,15 @@
+# firebase
+
+This library was generated with [Nx](https://nx.dev).
+
+## Running unit tests
+
+Unit tests are run through the Docker container. This lets our tests access the emulator. Since all tests are run within the container, and the container is not configured to use service ports, it can be run at the same time as the demo.
+
+Run `nx watch firebase` to execute the unit tests and watch for changes.
+
+Run `nx test firebase` to execute the unit tests.
+
+### Firebase Related Unit Test Notes
+
+https://firebase.google.com/docs/rules/unit-tests#rut-v2-common-methods

package/package.json

@@ -0,0 +1,16 @@
+{
+  "name": "@dereekb/firebase",
+  "version": "0.0.1",
+  "main": "./src/index.js",
+  "typings": "./src/index.d.ts",
+  "dependencies": {
+    "rxjs": "^7.5.2",
+    "rxfire": "^6.0.3",
+    "@dereekb/rxjs": "0.0.1",
+    "@dereekb/util": "0.0.1",
+    "extra-set": "^2.2.11",
+    "ms": "^3.0.0-canary.1",
+    "firebase": "^9.6.4"
+  },
+  "peerDependencies": {}
+}

package/src/index.d.ts

@@ -0,0 +1,2 @@
+export * from './lib';
+export * from './test';

package/src/index.js

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

package/src/index.js.map

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

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

@@ -0,0 +1,23 @@
+import { DocumentReference, DocumentSnapshot, UpdateData, WithFieldValue, WriteBatch } from "@firebase/firestore";
+import { Observable } from "rxjs";
+import { FirestoreDocumentDataAccessor, FirestoreDocumentDataAccessorFactory } from "./accessor";
+/**
+ * FirestoreDocumentDataAccessor implementation for a batch.
+ */
+export declare class WriteBatchFirestoreDocumentDataAccessor<T> implements FirestoreDocumentDataAccessor<T> {
+    readonly batch: WriteBatch;
+    readonly documentRef: DocumentReference<T>;
+    constructor(batch: WriteBatch, documentRef: DocumentReference<T>);
+    stream(): Observable<DocumentSnapshot<T>>;
+    get(): Promise<DocumentSnapshot<T>>;
+    delete(): Promise<void>;
+    set(data: WithFieldValue<T>): Promise<void>;
+    update(data: UpdateData<T>): Promise<void>;
+}
+/**
+ * Creates a new FirestoreDocumentDataAccessorFactory for a Batch.
+ *
+ * @param batch
+ * @returns
+ */
+export declare function writeBatchAccessorFactory<T>(writeBatch: WriteBatch): FirestoreDocumentDataAccessorFactory<T>;

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

@@ -0,0 +1,46 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.writeBatchAccessorFactory = exports.WriteBatchFirestoreDocumentDataAccessor = void 0;
+const firestore_1 = require("@firebase/firestore");
+const rxjs_1 = require("rxjs");
+/**
+ * FirestoreDocumentDataAccessor implementation for a batch.
+ */
+class WriteBatchFirestoreDocumentDataAccessor {
+    constructor(batch, documentRef) {
+        this.batch = batch;
+        this.documentRef = documentRef;
+    }
+    stream() {
+        return (0, rxjs_1.from)(this.get());
+    }
+    get() {
+        return (0, firestore_1.getDoc)(this.documentRef);
+    }
+    delete() {
+        this.batch.delete(this.documentRef);
+        return Promise.resolve();
+    }
+    set(data) {
+        this.batch.set(this.documentRef, data);
+        return Promise.resolve();
+    }
+    update(data) {
+        this.batch.update(this.documentRef, data);
+        return Promise.resolve();
+    }
+}
+exports.WriteBatchFirestoreDocumentDataAccessor = WriteBatchFirestoreDocumentDataAccessor;
+/**
+ * Creates a new FirestoreDocumentDataAccessorFactory for a Batch.
+ *
+ * @param batch
+ * @returns
+ */
+function writeBatchAccessorFactory(writeBatch) {
+    return {
+        accessorFor: (ref) => new WriteBatchFirestoreDocumentDataAccessor(writeBatch, ref)
+    };
+}
+exports.writeBatchAccessorFactory = writeBatchAccessorFactory;
+//# sourceMappingURL=accessor.batch.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"accessor.batch.js","sourceRoot":"","sources":["../../../../../../packages/firebase/src/lib/firestore/accessor.batch.ts"],"names":[],"mappings":";;;AAAA,mDAA0H;AAC1H,+BAAwC;AAGxC;;GAEG;AACH,MAAa,uCAAuC;IAElD,YAAqB,KAAiB,EAAW,WAAiC;QAA7D,UAAK,GAAL,KAAK,CAAY;QAAW,gBAAW,GAAX,WAAW,CAAsB;IAAI,CAAC;IAEvF,MAAM;QACJ,OAAO,IAAA,WAAI,EAAC,IAAI,CAAC,GAAG,EAAE,CAAC,CAAC;IAC1B,CAAC;IAED,GAAG;QACD,OAAO,IAAA,kBAAM,EAAC,IAAI,CAAC,WAAW,CAAC,CAAC;IAClC,CAAC;IAED,MAAM;QACJ,IAAI,CAAC,KAAK,CAAC,MAAM,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC;QACpC,OAAO,OAAO,CAAC,OAAO,EAAE,CAAC;IAC3B,CAAC;IAED,GAAG,CAAC,IAAuB;QACzB,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,IAAI,CAAC,WAAW,EAAE,IAAI,CAAC,CAAC;QACvC,OAAO,OAAO,CAAC,OAAO,EAAE,CAAC;IAC3B,CAAC;IAED,MAAM,CAAC,IAAmB;QACxB,IAAI,CAAC,KAAK,CAAC,MAAM,CAAC,IAAI,CAAC,WAAW,EAAE,IAAI,CAAC,CAAC;QAC1C,OAAO,OAAO,CAAC,OAAO,EAAE,CAAC;IAC3B,CAAC;CAEF;AA3BD,0FA2BC;AAED;;;;;GAKG;AACH,SAAgB,yBAAyB,CAAI,UAAsB;IACjE,OAAO;QACL,WAAW,EAAE,CAAC,GAAyB,EAAE,EAAE,CAAC,IAAI,uCAAuC,CAAC,UAAU,EAAE,GAAG,CAAC;KACzG,CAAC;AACJ,CAAC;AAJD,8DAIC"}

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

@@ -0,0 +1,62 @@
+import { Maybe } from "@dereekb/util";
+import { DocumentReference, DocumentSnapshot, UpdateData, WithFieldValue } from "@firebase/firestore";
+import { SnapshotOptions } from "firebase/firestore";
+import { Observable, OperatorFunction } from 'rxjs';
+import { FirestoreDocumentReference } from './reference';
+/**
+ * Firestore database accessor instance used to retrieve and make changes to items in the database.
+ */
+export interface FirestoreDocumentDataAccessor<T> extends FirestoreDocumentReference<T> {
+    /**
+     * Returns a database stream of DocumentSnapshots.
+     */
+    stream(): Observable<DocumentSnapshot<T>>;
+    /**
+     * Returns the current snapshot.
+     */
+    get(): Promise<DocumentSnapshot<T>>;
+    /**
+     * Deletes the document
+     */
+    delete(): Promise<void>;
+    /**
+     * Sets the data in the database.
+     *
+     * @param data
+     */
+    set(data: WithFieldValue<T>): Promise<void>;
+    /**
+     * Updates the data in the database.
+     *
+     * @param data
+     */
+    update(data: UpdateData<T>): Promise<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>>;

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

@@ -0,0 +1,22 @@
+import { DocumentReference, DocumentSnapshot, UpdateData, WithFieldValue } from "@firebase/firestore";
+import { Observable } from "rxjs";
+import { FirestoreDocumentDataAccessor, FirestoreDocumentDataAccessorFactory } from "./accessor";
+/**
+ * FirestoreDocumentDataAccessor implementation for a batch.
+ */
+export declare class DefaultFirestoreDocumentDataAccessor<T> implements FirestoreDocumentDataAccessor<T> {
+    readonly documentRef: DocumentReference<T>;
+    constructor(documentRef: DocumentReference<T>);
+    stream(): Observable<DocumentSnapshot<T>>;
+    get(): Promise<DocumentSnapshot<T>>;
+    delete(): Promise<void>;
+    set(data: WithFieldValue<T>): Promise<void>;
+    update(data: UpdateData<T>): Promise<void>;
+}
+/**
+ * Creates a new FirestoreDocumentDataAccessorFactory for a Batch.
+ *
+ * @param batch
+ * @returns
+ */
+export declare function defaultFirestoreAccessorFactory<T>(): FirestoreDocumentDataAccessorFactory<T>;

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

@@ -0,0 +1,42 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.defaultFirestoreAccessorFactory = exports.DefaultFirestoreDocumentDataAccessor = void 0;
+const firestore_1 = require("@firebase/firestore");
+const firestore_2 = require("rxfire/firestore");
+/**
+ * FirestoreDocumentDataAccessor implementation for a batch.
+ */
+class DefaultFirestoreDocumentDataAccessor {
+    constructor(documentRef) {
+        this.documentRef = documentRef;
+    }
+    stream() {
+        return (0, firestore_2.fromRef)(this.documentRef);
+    }
+    get() {
+        return (0, firestore_1.getDoc)(this.documentRef);
+    }
+    delete() {
+        return (0, firestore_1.deleteDoc)(this.documentRef);
+    }
+    set(data) {
+        return (0, firestore_1.setDoc)(this.documentRef, data);
+    }
+    update(data) {
+        return (0, firestore_1.updateDoc)(this.documentRef, data);
+    }
+}
+exports.DefaultFirestoreDocumentDataAccessor = DefaultFirestoreDocumentDataAccessor;
+/**
+ * Creates a new FirestoreDocumentDataAccessorFactory for a Batch.
+ *
+ * @param batch
+ * @returns
+ */
+function defaultFirestoreAccessorFactory() {
+    return {
+        accessorFor: (ref) => new DefaultFirestoreDocumentDataAccessor(ref)
+    };
+}
+exports.defaultFirestoreAccessorFactory = defaultFirestoreAccessorFactory;
+//# sourceMappingURL=accessor.default.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"accessor.default.js","sourceRoot":"","sources":["../../../../../../packages/firebase/src/lib/firestore/accessor.default.ts"],"names":[],"mappings":";;;AAAA,mDAA4I;AAC5I,gDAA2C;AAI3C;;GAEG;AACH,MAAa,oCAAoC;IAE/C,YAAqB,WAAiC;QAAjC,gBAAW,GAAX,WAAW,CAAsB;IAAI,CAAC;IAE3D,MAAM;QACJ,OAAO,IAAA,mBAAO,EAAC,IAAI,CAAC,WAAW,CAAC,CAAC;IACnC,CAAC;IAED,GAAG;QACD,OAAO,IAAA,kBAAM,EAAC,IAAI,CAAC,WAAW,CAAC,CAAC;IAClC,CAAC;IAED,MAAM;QACJ,OAAO,IAAA,qBAAS,EAAC,IAAI,CAAC,WAAW,CAAC,CAAC;IACrC,CAAC;IAED,GAAG,CAAC,IAAuB;QACzB,OAAO,IAAA,kBAAM,EAAC,IAAI,CAAC,WAAW,EAAE,IAAI,CAAC,CAAC;IACxC,CAAC;IAED,MAAM,CAAC,IAAmB;QACxB,OAAO,IAAA,qBAAS,EAAC,IAAI,CAAC,WAAW,EAAE,IAAI,CAAC,CAAC;IAC3C,CAAC;CAEF;AAxBD,oFAwBC;AAED;;;;;GAKG;AACH,SAAgB,+BAA+B;IAC7C,OAAO;QACL,WAAW,EAAE,CAAC,GAAyB,EAAE,EAAE,CAAC,IAAI,oCAAoC,CAAC,GAAG,CAAC;KAC1F,CAAC;AACJ,CAAC;AAJD,0EAIC"}

package/src/lib/firestore/accessor.js

@@ -0,0 +1,29 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.mapDataFromSnapshot = exports.dataFromSnapshotStream = void 0;
+const rxjs_1 = require("@dereekb/rxjs");
+const rxjs_2 = require("rxjs");
+/**
+ * Maps data from the given snapshot stream.
+ *
+ * Maybe values are filtered from the stream until data is provided.
+ *
+ * @param stream
+ * @param options
+ * @returns
+ */
+function dataFromSnapshotStream(stream, options) {
+    return stream.pipe(mapDataFromSnapshot(options), (0, rxjs_1.filterMaybe)());
+}
+exports.dataFromSnapshotStream = dataFromSnapshotStream;
+/**
+ * OperatorFunction to map data from the snapshot.
+ *
+ * @param options
+ * @returns
+ */
+function mapDataFromSnapshot(options) {
+    return (0, rxjs_2.map)((x) => x.data(options));
+}
+exports.mapDataFromSnapshot = mapDataFromSnapshot;
+//# sourceMappingURL=accessor.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"accessor.js","sourceRoot":"","sources":["../../../../../../packages/firebase/src/lib/firestore/accessor.ts"],"names":[],"mappings":";;;AAAA,wCAA4C;AAI5C,+BAAyD;AA+CzD;;;;;;;;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"}

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

@@ -0,0 +1,23 @@
+import { DocumentReference, DocumentSnapshot, Transaction, UpdateData, WithFieldValue } from "@firebase/firestore";
+import { Observable } from "rxjs";
+import { FirestoreDocumentDataAccessor, FirestoreDocumentDataAccessorFactory } from "./accessor";
+/**
+ * FirestoreDocumentDataAccessor implementation for a transaction.
+ */
+export declare class TransactionFirestoreDocumentDataAccessor<T> implements FirestoreDocumentDataAccessor<T> {
+    readonly transaction: Transaction;
+    readonly documentRef: DocumentReference<T>;
+    constructor(transaction: Transaction, documentRef: DocumentReference<T>);
+    stream(): Observable<DocumentSnapshot<T>>;
+    get(): Promise<DocumentSnapshot<T>>;
+    delete(): Promise<void>;
+    set(data: WithFieldValue<T>): Promise<void>;
+    update(data: UpdateData<T>): Promise<void>;
+}
+/**
+ * Creates a new FirestoreDocumentDataAccessorFactory for a Transaction.
+ *
+ * @param transaction
+ * @returns
+ */
+export declare function transactionAccessorFactory<T>(transaction: Transaction): FirestoreDocumentDataAccessorFactory<T>;

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

@@ -0,0 +1,45 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.transactionAccessorFactory = exports.TransactionFirestoreDocumentDataAccessor = void 0;
+const rxjs_1 = require("rxjs");
+/**
+ * FirestoreDocumentDataAccessor implementation for a transaction.
+ */
+class TransactionFirestoreDocumentDataAccessor {
+    constructor(transaction, documentRef) {
+        this.transaction = transaction;
+        this.documentRef = documentRef;
+    }
+    stream() {
+        return (0, rxjs_1.from)(this.get());
+    }
+    get() {
+        return this.transaction.get(this.documentRef);
+    }
+    delete() {
+        this.transaction.delete(this.documentRef);
+        return Promise.resolve();
+    }
+    set(data) {
+        this.transaction.set(this.documentRef, data);
+        return Promise.resolve();
+    }
+    update(data) {
+        this.transaction.update(this.documentRef, data);
+        return Promise.resolve();
+    }
+}
+exports.TransactionFirestoreDocumentDataAccessor = TransactionFirestoreDocumentDataAccessor;
+/**
+ * Creates a new FirestoreDocumentDataAccessorFactory for a Transaction.
+ *
+ * @param transaction
+ * @returns
+ */
+function transactionAccessorFactory(transaction) {
+    return {
+        accessorFor: (ref) => new TransactionFirestoreDocumentDataAccessor(transaction, ref)
+    };
+}
+exports.transactionAccessorFactory = transactionAccessorFactory;
+//# sourceMappingURL=accessor.transaction.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"accessor.transaction.js","sourceRoot":"","sources":["../../../../../../packages/firebase/src/lib/firestore/accessor.transaction.ts"],"names":[],"mappings":";;;AACA,+BAAwC;AAGxC;;GAEG;AACH,MAAa,wCAAwC;IAEnD,YAAqB,WAAwB,EAAW,WAAiC;QAApE,gBAAW,GAAX,WAAW,CAAa;QAAW,gBAAW,GAAX,WAAW,CAAsB;IAAI,CAAC;IAE9F,MAAM;QACJ,OAAO,IAAA,WAAI,EAAC,IAAI,CAAC,GAAG,EAAE,CAAC,CAAC;IAC1B,CAAC;IAED,GAAG;QACD,OAAO,IAAI,CAAC,WAAW,CAAC,GAAG,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC;IAChD,CAAC;IAED,MAAM;QACJ,IAAI,CAAC,WAAW,CAAC,MAAM,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC;QAC1C,OAAO,OAAO,CAAC,OAAO,EAAE,CAAC;IAC3B,CAAC;IAED,GAAG,CAAC,IAAuB;QACzB,IAAI,CAAC,WAAW,CAAC,GAAG,CAAC,IAAI,CAAC,WAAW,EAAE,IAAI,CAAC,CAAC;QAC7C,OAAO,OAAO,CAAC,OAAO,EAAE,CAAC;IAC3B,CAAC;IAED,MAAM,CAAC,IAAmB;QACxB,IAAI,CAAC,WAAW,CAAC,MAAM,CAAC,IAAI,CAAC,WAAW,EAAE,IAAI,CAAC,CAAC;QAChD,OAAO,OAAO,CAAC,OAAO,EAAE,CAAC;IAC3B,CAAC;CAEF;AA3BD,4FA2BC;AAED;;;;;GAKG;AACH,SAAgB,0BAA0B,CAAI,WAAwB;IACpE,OAAO;QACL,WAAW,EAAE,CAAC,GAAyB,EAAE,EAAE,CAAC,IAAI,wCAAwC,CAAC,WAAW,EAAE,GAAG,CAAC;KAC3G,CAAC;AACJ,CAAC;AAJD,gEAIC"}

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

@@ -0,0 +1,9 @@
+import { WriteBatch } from "@firebase/firestore";
+import { FirestoreDocumentContext, FirestoreDocumentContextType } from "./context";
+export declare class WriteBatchFirestoreDocumentContext<T> implements FirestoreDocumentContext<T> {
+    readonly batch: WriteBatch;
+    readonly contextType = FirestoreDocumentContextType.TRANSACTION;
+    readonly accessorFactory: import("./accessor").FirestoreDocumentDataAccessorFactory<T>;
+    constructor(batch: WriteBatch);
+}
+export declare function writeBatchDocumentContext<T>(batch: WriteBatch): WriteBatchFirestoreDocumentContext<T>;

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

@@ -0,0 +1,19 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.writeBatchDocumentContext = exports.WriteBatchFirestoreDocumentContext = void 0;
+const accessor_batch_1 = require("./accessor.batch");
+const context_1 = require("./context");
+// MARK: Batch
+class WriteBatchFirestoreDocumentContext {
+    constructor(batch) {
+        this.batch = batch;
+        this.contextType = context_1.FirestoreDocumentContextType.TRANSACTION;
+        this.accessorFactory = (0, accessor_batch_1.writeBatchAccessorFactory)(this.batch);
+    }
+}
+exports.WriteBatchFirestoreDocumentContext = WriteBatchFirestoreDocumentContext;
+function writeBatchDocumentContext(batch) {
+    return new WriteBatchFirestoreDocumentContext(batch);
+}
+exports.writeBatchDocumentContext = writeBatchDocumentContext;
+//# sourceMappingURL=context.batch.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"context.batch.js","sourceRoot":"","sources":["../../../../../../packages/firebase/src/lib/firestore/context.batch.ts"],"names":[],"mappings":";;;AACA,qDAA6D;AAC7D,uCAAmF;AAEnF,cAAc;AACd,MAAa,kCAAkC;IAK7C,YAAqB,KAAiB;QAAjB,UAAK,GAAL,KAAK,CAAY;QAH7B,gBAAW,GAAG,sCAA4B,CAAC,WAAW,CAAC;QACvD,oBAAe,GAAG,IAAA,0CAAyB,EAAI,IAAI,CAAC,KAAK,CAAC,CAAC;IAE1B,CAAC;CAE5C;AAPD,gFAOC;AAED,SAAgB,yBAAyB,CAAI,KAAiB;IAC5D,OAAO,IAAI,kCAAkC,CAAI,KAAK,CAAC,CAAC;AAC1D,CAAC;AAFD,8DAEC"}

package/src/lib/firestore/context.d.ts

@@ -0,0 +1,24 @@
+import { FirestoreDocumentDataAccessorFactory } from "./accessor";
+/**
+ * A specific document context type.
+ *
+ * Used by a FirestoreDocumentContext to communicate which kind of context it was created in.
+ */
+export declare enum FirestoreDocumentContextType {
+    NONE = "none",
+    TRANSACTION = "transaction",
+    BATCH = "batch"
+}
+/**
+ * Firebase database context used for accessing and modifying documents in a specific context, such as a transaction.
+ */
+export interface FirestoreDocumentContext<T> {
+    /**
+     * Context type
+     */
+    readonly contextType: FirestoreDocumentContextType;
+    /**
+     * Database accessor
+     */
+    readonly accessorFactory: FirestoreDocumentDataAccessorFactory<T>;
+}

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

@@ -0,0 +1,2 @@
+import { FirestoreDocumentContext } from "./context";
+export declare function defaultFirestoreDocumentContext<T>(): FirestoreDocumentContext<T>;

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

@@ -0,0 +1,13 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.defaultFirestoreDocumentContext = void 0;
+const accessor_default_1 = require("./accessor.default");
+const context_1 = require("./context");
+function defaultFirestoreDocumentContext() {
+    return {
+        contextType: context_1.FirestoreDocumentContextType.NONE,
+        accessorFactory: (0, accessor_default_1.defaultFirestoreAccessorFactory)()
+    };
+}
+exports.defaultFirestoreDocumentContext = defaultFirestoreDocumentContext;
+//# sourceMappingURL=context.default.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"context.default.js","sourceRoot":"","sources":["../../../../../../packages/firebase/src/lib/firestore/context.default.ts"],"names":[],"mappings":";;;AAAA,yDAAqE;AACrE,uCAAmF;AAEnF,SAAgB,+BAA+B;IAC7C,OAAO;QACL,WAAW,EAAE,sCAA4B,CAAC,IAAI;QAC9C,eAAe,EAAE,IAAA,kDAA+B,GAAK;KACtD,CAAA;AACH,CAAC;AALD,0EAKC"}

package/src/lib/firestore/context.js

@@ -0,0 +1,15 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.FirestoreDocumentContextType = void 0;
+/**
+ * A specific document context type.
+ *
+ * Used by a FirestoreDocumentContext to communicate which kind of context it was created in.
+ */
+var FirestoreDocumentContextType;
+(function (FirestoreDocumentContextType) {
+    FirestoreDocumentContextType["NONE"] = "none";
+    FirestoreDocumentContextType["TRANSACTION"] = "transaction";
+    FirestoreDocumentContextType["BATCH"] = "batch";
+})(FirestoreDocumentContextType = exports.FirestoreDocumentContextType || (exports.FirestoreDocumentContextType = {}));
+//# sourceMappingURL=context.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"context.js","sourceRoot":"","sources":["../../../../../../packages/firebase/src/lib/firestore/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/firestore/context.transaction.d.ts

@@ -0,0 +1,9 @@
+import { Transaction } from "@firebase/firestore";
+import { FirestoreDocumentContext, FirestoreDocumentContextType } from "./context";
+export declare class TransactionFirestoreDocumentContext<T> implements FirestoreDocumentContext<T> {
+    readonly transaction: Transaction;
+    readonly contextType = FirestoreDocumentContextType.TRANSACTION;
+    readonly accessorFactory: import("./accessor").FirestoreDocumentDataAccessorFactory<T>;
+    constructor(transaction: Transaction);
+}
+export declare function transactionDocumentContext<T>(transaction: Transaction): TransactionFirestoreDocumentContext<T>;

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

@@ -0,0 +1,19 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.transactionDocumentContext = exports.TransactionFirestoreDocumentContext = void 0;
+const accessor_transaction_1 = require("./accessor.transaction");
+const context_1 = require("./context");
+// MARK: Transaction
+class TransactionFirestoreDocumentContext {
+    constructor(transaction) {
+        this.transaction = transaction;
+        this.contextType = context_1.FirestoreDocumentContextType.TRANSACTION;
+        this.accessorFactory = (0, accessor_transaction_1.transactionAccessorFactory)(this.transaction);
+    }
+}
+exports.TransactionFirestoreDocumentContext = TransactionFirestoreDocumentContext;
+function transactionDocumentContext(transaction) {
+    return new TransactionFirestoreDocumentContext(transaction);
+}
+exports.transactionDocumentContext = transactionDocumentContext;
+//# sourceMappingURL=context.transaction.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"context.transaction.js","sourceRoot":"","sources":["../../../../../../packages/firebase/src/lib/firestore/context.transaction.ts"],"names":[],"mappings":";;;AACA,iEAAoE;AACpE,uCAAmF;AAEnF,oBAAoB;AACpB,MAAa,mCAAmC;IAK9C,YAAqB,WAAwB;QAAxB,gBAAW,GAAX,WAAW,CAAa;QAHpC,gBAAW,GAAG,sCAA4B,CAAC,WAAW,CAAC;QACvD,oBAAe,GAAG,IAAA,iDAA0B,EAAI,IAAI,CAAC,WAAW,CAAC,CAAC;IAE1B,CAAC;CAEnD;AAPD,kFAOC;AAED,SAAgB,0BAA0B,CAAI,WAAwB;IACpE,OAAO,IAAI,mCAAmC,CAAI,WAAW,CAAC,CAAC;AACjE,CAAC;AAFD,gEAEC"}

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

@@ -0,0 +1,69 @@
+import { Observable } from 'rxjs';
+import { DocumentReference, CollectionReference } from '@firebase/firestore';
+import { FirestoreDocumentDataAccessor, FirestoreDocumentDataAccessorFactory } from './accessor';
+import { FirestoreCollectionReference, FirestoreDocumentReference } from './reference';
+import { FirestoreDocumentContext } from './context';
+export interface FirestoreDocument<T> extends FirestoreDocumentReference<T> {
+}
+/**
+ * Abstract FirestoreDocument implementation that extends a FirestoreDocumentDataAccessor.
+ */
+export declare abstract class AbstractFirestoreDocument<T, A extends FirestoreDocumentDataAccessor<T> = FirestoreDocumentDataAccessor<T>> {
+    readonly accessor: A;
+    readonly stream$: Observable<import("@firebase/firestore").DocumentSnapshot<T>>;
+    readonly data$: Observable<T>;
+    constructor(accessor: A);
+    get documentRef(): DocumentReference<T>;
+}
+export interface FirestoreDocumentAccessor<T, D extends FirestoreDocument<T>> {
+    readonly databaseContext: FirestoreDocumentContext<T>;
+    /**
+     * Creates a new document.
+     */
+    newDocument(): 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;
+}
+/**
+ * Factory type used for creating a FirestoreDocumentAccessor.
+ */
+export interface FirestoreDocumentAccessorFactory<T, D extends FirestoreDocument<T>> {
+    /**
+     * Creates a new FirestoreDocumentFactory using the given context.
+     *
+     * @param context Optional context to retrieve items from.
+     */
+    documentAccessor(context?: FirestoreDocumentContext<T>): FirestoreDocumentAccessor<T, D>;
+}
+/**
+ * Used to generate a FirestoreDocument from an input FirestoreDocumentDataAccessor instance.
+ */
+export declare type FirestoreDocumentFactoryFunction<T, D extends FirestoreDocument<T>> = (accessor: FirestoreDocumentDataAccessor<T>) => D;
+/**
+ * FirestoreDocumentAccessorInstance configuration.
+ */
+export interface FirestoreDocumentAccessorInstanceConfig<T, D extends FirestoreDocument<T>> extends FirestoreCollectionReference<T> {
+    readonly makeDocument: FirestoreDocumentFactoryFunction<T, D>;
+}
+export declare class FirestoreDocumentAccessorInstance<T, D extends FirestoreDocument<T>> implements FirestoreDocumentAccessor<T, D> {
+    readonly config: FirestoreDocumentAccessorInstanceConfig<T, D>;
+    readonly databaseContext: FirestoreDocumentContext<T>;
+    constructor(config: FirestoreDocumentAccessorInstanceConfig<T, D>, databaseContext?: FirestoreDocumentContext<T>);
+    get collection(): CollectionReference<T>;
+    get accessorFactory(): FirestoreDocumentDataAccessorFactory<T>;
+    newDocument(): D;
+    loadDocument(ref: DocumentReference<T>): D;
+    loadDocumentFrom(document: FirestoreDocument<T>): D;
+}
+export declare type FirestoreDocumentAccessorFactoryFunction<T, D extends FirestoreDocument<T>> = (context?: FirestoreDocumentContext<T>) => FirestoreDocumentAccessor<T, D>;
+export declare function firestoreDocumentAccessorFactory<T, D extends FirestoreDocument<T>>(config: FirestoreDocumentAccessorInstanceConfig<T, D>): FirestoreDocumentAccessorFactoryFunction<T, D>;

package/src/lib/firestore/document.js

@@ -0,0 +1,49 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.firestoreDocumentAccessorFactory = exports.FirestoreDocumentAccessorInstance = exports.AbstractFirestoreDocument = void 0;
+const firestore_1 = require("@firebase/firestore");
+const accessor_1 = require("./accessor");
+const context_default_1 = require("./context.default");
+/**
+ * Abstract FirestoreDocument implementation that extends a FirestoreDocumentDataAccessor.
+ */
+class AbstractFirestoreDocument {
+    constructor(accessor) {
+        this.accessor = accessor;
+        this.stream$ = this.accessor.stream();
+        this.data$ = (0, accessor_1.dataFromSnapshotStream)(this.stream$);
+    }
+    get documentRef() {
+        return this.accessor.documentRef;
+    }
+}
+exports.AbstractFirestoreDocument = AbstractFirestoreDocument;
+class FirestoreDocumentAccessorInstance {
+    constructor(config, databaseContext = (0, context_default_1.defaultFirestoreDocumentContext)()) {
+        this.config = config;
+        this.databaseContext = databaseContext;
+    }
+    get collection() {
+        return this.config.collection;
+    }
+    get accessorFactory() {
+        return this.databaseContext.accessorFactory;
+    }
+    newDocument() {
+        const newDocRef = (0, firestore_1.doc)(this.collection);
+        return this.loadDocument(newDocRef);
+    }
+    loadDocument(ref) {
+        const accessor = this.accessorFactory.accessorFor(ref);
+        return this.config.makeDocument(accessor);
+    }
+    loadDocumentFrom(document) {
+        return this.loadDocument(document.documentRef);
+    }
+}
+exports.FirestoreDocumentAccessorInstance = FirestoreDocumentAccessorInstance;
+function firestoreDocumentAccessorFactory(config) {
+    return (context) => new FirestoreDocumentAccessorInstance(config, context);
+}
+exports.firestoreDocumentAccessorFactory = firestoreDocumentAccessorFactory;
+//# sourceMappingURL=document.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"document.js","sourceRoot":"","sources":["../../../../../../packages/firebase/src/lib/firestore/document.ts"],"names":[],"mappings":";;;AACA,mDAAkF;AAClF,yCAAyH;AAGzH,uDAAoE;AAIpE;;GAEG;AACH,MAAsB,yBAAyB;IAK7C,YAAqB,QAAW;QAAX,aAAQ,GAAR,QAAQ,CAAG;QAHvB,YAAO,GAAG,IAAI,CAAC,QAAQ,CAAC,MAAM,EAAE,CAAC;QACjC,UAAK,GAAkB,IAAA,iCAAsB,EAAC,IAAI,CAAC,OAAO,CAAC,CAAC;IAEjC,CAAC;IAErC,IAAI,WAAW;QACb,OAAO,IAAI,CAAC,QAAQ,CAAC,WAAW,CAAC;IACnC,CAAC;CAEF;AAXD,8DAWC;AAsDD,MAAa,iCAAiC;IAE5C,YACW,MAAqD,EACrD,kBAA+C,IAAA,iDAA+B,GAAE;QADhF,WAAM,GAAN,MAAM,CAA+C;QACrD,oBAAe,GAAf,eAAe,CAAiE;IACvF,CAAC;IAEL,IAAI,UAAU;QACZ,OAAO,IAAI,CAAC,MAAM,CAAC,UAAU,CAAC;IAChC,CAAC;IAED,IAAI,eAAe;QACjB,OAAO,IAAI,CAAC,eAAe,CAAC,eAAe,CAAC;IAC9C,CAAC;IAED,WAAW;QACT,MAAM,SAAS,GAAG,IAAA,eAAG,EAAC,IAAI,CAAC,UAAU,CAAC,CAAC;QACvC,OAAO,IAAI,CAAC,YAAY,CAAC,SAAS,CAAC,CAAC;IACtC,CAAC;IAED,YAAY,CAAC,GAAyB;QACpC,MAAM,QAAQ,GAAG,IAAI,CAAC,eAAe,CAAC,WAAW,CAAC,GAAG,CAAC,CAAC;QACvD,OAAO,IAAI,CAAC,MAAM,CAAC,YAAY,CAAC,QAAQ,CAAC,CAAC;IAC5C,CAAC;IAED,gBAAgB,CAAC,QAA8B;QAC7C,OAAO,IAAI,CAAC,YAAY,CAAC,QAAQ,CAAC,WAAW,CAAC,CAAC;IACjD,CAAC;CAEF;AA7BD,8EA6BC;AAID,SAAgB,gCAAgC,CAAoC,MAAqD;IACvI,OAAO,CAAC,OAAqC,EAAE,EAAE,CAAC,IAAI,iCAAiC,CAAO,MAAM,EAAE,OAAO,CAAC,CAAC;AACjH,CAAC;AAFD,4EAEC"}