@dereekb/firebase 0.0.1

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

@@ -0,0 +1,29 @@
+import { CollectionReference } from "@firebase/firestore";
+import { FirestoreDocument, FirestoreDocumentAccessor, FirestoreDocumentAccessorFactory, FirestoreDocumentAccessorFactoryFunction, FirestoreDocumentAccessorInstanceConfig } from "./document";
+import { FirestoreItemPageIterationBaseConfig, FirestoreItemPageIterationFactory, FirestoreItemPageIterationFactoryFunction, FirestoreItemPageIterationInstance, FirestoreItemPageIteratorFilter } from "./iterator";
+import { FirestoreDocumentContext } from "./context";
+import { FirestoreCollectionReference } from "./reference";
+/**
+ * FirestoreCollection configuration
+ */
+export interface FirestoreCollectionConfig<T, D extends FirestoreDocument<T> = FirestoreDocument<T>> extends FirestoreItemPageIterationBaseConfig<T>, FirestoreDocumentAccessorInstanceConfig<T, D> {
+}
+/**
+ * Instance that provides several accessors for accessing documents of a collection.
+ */
+export declare class FirestoreCollection<T, D extends FirestoreDocument<T> = FirestoreDocument<T>> implements FirestoreCollectionReference<T>, FirestoreItemPageIterationFactory<T>, FirestoreDocumentAccessorFactory<T, D> {
+    readonly config: FirestoreCollectionConfig<T, D>;
+    protected readonly _iterationFactory: FirestoreItemPageIterationFactoryFunction<T>;
+    protected readonly _documentAccessorFactory: FirestoreDocumentAccessorFactoryFunction<T, D>;
+    constructor(config: FirestoreCollectionConfig<T, D>);
+    get collection(): CollectionReference<T>;
+    firestoreIteration(filter?: FirestoreItemPageIteratorFilter): FirestoreItemPageIterationInstance<T>;
+    documentAccessor(context?: FirestoreDocumentContext<T>): FirestoreDocumentAccessor<T, D>;
+}
+/**
+ * Creates a new FirestoreCollection instance from the input config.
+ *
+ * @param config
+ * @returns
+ */
+export declare function makeFirestoreCollection<T, D extends FirestoreDocument<T>>(config: FirestoreCollectionConfig<T, D>): FirestoreCollection<T, D>;

package/src/lib/firestore/firestore.js

@@ -0,0 +1,37 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.makeFirestoreCollection = exports.FirestoreCollection = void 0;
+const document_1 = require("./document");
+const iterator_1 = require("./iterator");
+/**
+ * Instance that provides several accessors for accessing documents of a collection.
+ */
+class FirestoreCollection {
+    constructor(config) {
+        this.config = config;
+        this._iterationFactory = (0, iterator_1.firestoreItemPageIterationFactory)(this.config);
+        this._documentAccessorFactory = (0, document_1.firestoreDocumentAccessorFactory)(this.config);
+    }
+    get collection() {
+        return this.config.collection;
+    }
+    // MARK: FirestoreItemPageIterationFactory<T>
+    firestoreIteration(filter) {
+        return this._iterationFactory(filter);
+    }
+    documentAccessor(context) {
+        return this._documentAccessorFactory(context);
+    }
+}
+exports.FirestoreCollection = FirestoreCollection;
+/**
+ * Creates a new FirestoreCollection instance from the input config.
+ *
+ * @param config
+ * @returns
+ */
+function makeFirestoreCollection(config) {
+    return new FirestoreCollection(config);
+}
+exports.makeFirestoreCollection = makeFirestoreCollection;
+//# sourceMappingURL=firestore.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"firestore.js","sourceRoot":"","sources":["../../../../../../packages/firebase/src/lib/firestore/firestore.ts"],"names":[],"mappings":";;;AACA,yCAAiO;AACjO,yCAAwP;AAUxP;;GAEG;AACH,MAAa,mBAAmB;IAM9B,YAAqB,MAAuC;QAAvC,WAAM,GAAN,MAAM,CAAiC;QAHzC,sBAAiB,GAAiD,IAAA,4CAAiC,EAAC,IAAI,CAAC,MAAM,CAAC,CAAC;QACjH,6BAAwB,GAAmD,IAAA,2CAAgC,EAAC,IAAI,CAAC,MAAM,CAAC,CAAC;IAE5E,CAAC;IAEjE,IAAI,UAAU;QACZ,OAAO,IAAI,CAAC,MAAM,CAAC,UAAU,CAAC;IAChC,CAAC;IAED,6CAA6C;IAC7C,kBAAkB,CAAC,MAAwC;QACzD,OAAO,IAAI,CAAC,iBAAiB,CAAC,MAAM,CAAC,CAAC;IACxC,CAAC;IAED,gBAAgB,CAAC,OAAqC;QACpD,OAAO,IAAI,CAAC,wBAAwB,CAAC,OAAO,CAAC,CAAC;IAChD,CAAC;CAEF;AArBD,kDAqBC;AAED;;;;;GAKG;AACH,SAAgB,uBAAuB,CAAoC,MAAuC;IAChH,OAAO,IAAI,mBAAmB,CAAC,MAAM,CAAC,CAAC;AACzC,CAAC;AAFD,0DAEC"}

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

@@ -0,0 +1,12 @@
+export * from './accessor';
+export * from './accessor.batch';
+export * from './accessor.default';
+export * from './accessor.transaction';
+export * from './document';
+export * from './reference';
+export * from './context.batch';
+export * from './context.default';
+export * from './context.transaction';
+export * from './context';
+export * from './firestore';
+export * from './iterator';

package/src/lib/firestore/index.js

@@ -0,0 +1,16 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const tslib_1 = require("tslib");
+(0, tslib_1.__exportStar)(require("./accessor"), exports);
+(0, tslib_1.__exportStar)(require("./accessor.batch"), exports);
+(0, tslib_1.__exportStar)(require("./accessor.default"), exports);
+(0, tslib_1.__exportStar)(require("./accessor.transaction"), exports);
+(0, tslib_1.__exportStar)(require("./document"), exports);
+(0, tslib_1.__exportStar)(require("./reference"), exports);
+(0, tslib_1.__exportStar)(require("./context.batch"), exports);
+(0, tslib_1.__exportStar)(require("./context.default"), exports);
+(0, tslib_1.__exportStar)(require("./context.transaction"), exports);
+(0, tslib_1.__exportStar)(require("./context"), exports);
+(0, tslib_1.__exportStar)(require("./firestore"), exports);
+(0, tslib_1.__exportStar)(require("./iterator"), exports);
+//# sourceMappingURL=index.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../../../packages/firebase/src/lib/firestore/index.ts"],"names":[],"mappings":";;;AAAA,0DAA2B;AAC3B,gEAAiC;AACjC,kEAAmC;AACnC,sEAAuC;AACvC,0DAA2B;AAC3B,2DAA4B;AAC5B,+DAAgC;AAChC,iEAAkC;AAClC,qEAAsC;AACtC,yDAA0B;AAC1B,2DAA4B;AAC5B,0DAA2B"}

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

@@ -0,0 +1,49 @@
+import { PageLoadingState, ItemPageIterator, ItemPageIterationInstance, ItemPageIterationConfig, ItemPageIteratorDelegate, MappedPageItemIterationInstance } from '@dereekb/rxjs';
+import { QueryDocumentSnapshot, QueryConstraint, QuerySnapshot } from "@firebase/firestore";
+import { Maybe } from '@dereekb/util';
+import { FirestoreCollectionReference } from './reference';
+export interface FirestoreItemPageIteratorFilter {
+    queryConstraints?: Maybe<QueryConstraint[]>;
+}
+export interface FirestoreItemPageIterationBaseConfig<T> extends FirestoreCollectionReference<T> {
+    itemsPerPage: number;
+}
+export interface FirestoreItemPageIterationConfig<T> extends FirestoreItemPageIterationBaseConfig<T>, ItemPageIterationConfig<FirestoreItemPageIteratorFilter> {
+}
+export interface FirestoreItemPageQueryResult<T> {
+    /**
+     * The relevant docs for this page result. This value will omit the cursor.
+     */
+    docs: QueryDocumentSnapshot<T>[];
+    /**
+     * The raw snapshot returned from the query.
+     */
+    snapshot: QuerySnapshot<T>;
+}
+export declare type FirestoreItemPageIteratorDelegate<T> = ItemPageIteratorDelegate<FirestoreItemPageQueryResult<T>, FirestoreItemPageIteratorFilter, FirestoreItemPageIterationConfig<T>>;
+export declare type InternalFirestoreItemPageIterationInstance<T> = ItemPageIterationInstance<FirestoreItemPageQueryResult<T>, FirestoreItemPageIteratorFilter, FirestoreItemPageIterationConfig<T>>;
+export declare function makeFirestoreItemPageIteratorDelegate<T>(): FirestoreItemPageIteratorDelegate<T>;
+export declare class FirestoreItemPageIterationInstance<T> extends MappedPageItemIterationInstance<QueryDocumentSnapshot<T>[], FirestoreItemPageQueryResult<T>, PageLoadingState<QueryDocumentSnapshot<T>[]>, PageLoadingState<FirestoreItemPageQueryResult<T>>, InternalFirestoreItemPageIterationInstance<T>> {
+    constructor(snapshotIteration: InternalFirestoreItemPageIterationInstance<T>);
+    get snapshotIteration(): InternalFirestoreItemPageIterationInstance<T>;
+}
+/**
+ * FirestoreItemPageIteration factory.
+ */
+export interface FirestoreItemPageIterationFactory<T> {
+    firestoreIteration(filter?: FirestoreItemPageIteratorFilter): FirestoreItemPageIterationInstance<T>;
+}
+/**
+ * Function that creates a FirestoreItemPageIterationInstance from the input filter.
+ */
+export declare type FirestoreItemPageIterationFactoryFunction<T> = (filter?: FirestoreItemPageIteratorFilter) => FirestoreItemPageIterationInstance<T>;
+/**
+ * Creates a new factory function that can build FirestoreItemPageIterationInstance values from just the input filter.
+ *
+ * @param baseConfig
+ * @returns FirestoreItemPageIterationInstance
+ */
+export declare function firestoreItemPageIterationFactory<T>(baseConfig: FirestoreItemPageIterationBaseConfig<T>): FirestoreItemPageIterationFactoryFunction<T>;
+export declare const FIRESTORE_ITEM_PAGE_ITERATOR_DELEGATE: FirestoreItemPageIteratorDelegate<any>;
+export declare const FIRESTORE_ITEM_PAGE_ITERATOR: ItemPageIterator<FirestoreItemPageQueryResult<any>, FirestoreItemPageIteratorFilter, FirestoreItemPageIterationConfig<any>>;
+export declare function firestoreItemPageIteration<T>(config: FirestoreItemPageIterationConfig<T>): FirestoreItemPageIterationInstance<T>;

package/src/lib/firestore/iterator.js

@@ -0,0 +1,91 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.firestoreItemPageIteration = exports.FIRESTORE_ITEM_PAGE_ITERATOR = exports.FIRESTORE_ITEM_PAGE_ITERATOR_DELEGATE = exports.firestoreItemPageIterationFactory = exports.FirestoreItemPageIterationInstance = exports.makeFirestoreItemPageIteratorDelegate = void 0;
+const rxjs_1 = require("@dereekb/rxjs");
+const firestore_1 = require("@firebase/firestore");
+const util_1 = require("@dereekb/util");
+const rxjs_2 = require("rxjs");
+function makeFirestoreItemPageIteratorDelegate() {
+    return {
+        loadItemsForPage: (request) => {
+            const { page, iteratorConfig } = request;
+            const lastQueryResult$ = (page > 0) ? request.lastItem$ : (0, rxjs_2.of)(undefined);
+            const { collection, itemsPerPage, filter } = iteratorConfig;
+            return lastQueryResult$.pipe((0, rxjs_2.exhaustMap)((lastResult) => {
+                if ((lastResult === null || lastResult === void 0 ? void 0 : lastResult.snapshot.empty) === true) { // TODO: Shouldn't happen. Remove this later.
+                    return (0, rxjs_2.of)({ end: true });
+                }
+                else {
+                    const constraints = [];
+                    // Add filter constraints
+                    if (filter === null || filter === void 0 ? void 0 : filter.queryConstraints) {
+                        (0, util_1.mergeIntoArray)(constraints, filter.queryConstraints);
+                    }
+                    // Add cursor
+                    const cursorDocument = (lastResult) ? (0, util_1.lastValue)(lastResult.docs) : undefined;
+                    const startsAtFilter = (cursorDocument) ? (0, firestore_1.startAt)(cursorDocument) : undefined;
+                    if (startsAtFilter) {
+                        constraints.push(startsAtFilter);
+                    }
+                    // Add Limit
+                    constraints.push((0, firestore_1.limit)(itemsPerPage + ((startsAtFilter) ? 1 : 0))); // Add 1 for cursor, since results will start at our cursor.
+                    const batchQuery = (0, firestore_1.query)(collection, ...constraints);
+                    const resultPromise = (0, firestore_1.getDocs)(batchQuery).then((snapshot) => {
+                        let docs = snapshot.docs;
+                        // Remove the cursor document from the results.
+                        if (cursorDocument && docs[0].id === cursorDocument.id) {
+                            docs = docs.slice(1);
+                        }
+                        const result = {
+                            value: {
+                                docs,
+                                snapshot
+                            },
+                            end: snapshot.empty
+                        };
+                        return result;
+                    });
+                    return (0, rxjs_2.from)(resultPromise);
+                }
+            }));
+        }
+    };
+}
+exports.makeFirestoreItemPageIteratorDelegate = makeFirestoreItemPageIteratorDelegate;
+class FirestoreItemPageIterationInstance extends rxjs_1.MappedPageItemIterationInstance {
+    constructor(snapshotIteration) {
+        super(snapshotIteration, {
+            forwardDestroy: true,
+            mapValue: (x) => x.docs
+        });
+    }
+    get snapshotIteration() {
+        return this.itemIterator;
+    }
+}
+exports.FirestoreItemPageIterationInstance = FirestoreItemPageIterationInstance;
+/**
+ * Creates a new factory function that can build FirestoreItemPageIterationInstance values from just the input filter.
+ *
+ * @param baseConfig
+ * @returns FirestoreItemPageIterationInstance
+ */
+function firestoreItemPageIterationFactory(baseConfig) {
+    return (filter) => {
+        const result = firestoreItemPageIteration({
+            collection: baseConfig.collection,
+            itemsPerPage: baseConfig.itemsPerPage,
+            filter
+        });
+        return result;
+    };
+}
+exports.firestoreItemPageIterationFactory = firestoreItemPageIterationFactory;
+exports.FIRESTORE_ITEM_PAGE_ITERATOR_DELEGATE = makeFirestoreItemPageIteratorDelegate();
+exports.FIRESTORE_ITEM_PAGE_ITERATOR = new rxjs_1.ItemPageIterator(exports.FIRESTORE_ITEM_PAGE_ITERATOR_DELEGATE);
+function firestoreItemPageIteration(config) {
+    const iterator = exports.FIRESTORE_ITEM_PAGE_ITERATOR.instance(config);
+    return new FirestoreItemPageIterationInstance(iterator);
+}
+exports.firestoreItemPageIteration = firestoreItemPageIteration;
+//# sourceMappingURL=iterator.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"iterator.js","sourceRoot":"","sources":["../../../../../../packages/firebase/src/lib/firestore/iterator.ts"],"names":[],"mappings":";;;AAAA,wCAAmO;AACnO,mDAA4H;AAC5H,wCAAiE;AACjE,+BAAwD;AA2BxD,SAAgB,qCAAqC;IACnD,OAAO;QACL,gBAAgB,EAAE,CAAC,OAAuI,EAAuE,EAAE;YACjO,MAAM,EAAE,IAAI,EAAE,cAAc,EAAE,GAAG,OAAO,CAAC;YACzC,MAAM,gBAAgB,GAAuD,CAAC,IAAI,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,SAAS,CAAC,CAAC,CAAC,IAAA,SAAE,EAAC,SAAS,CAAC,CAAC;YAE5H,MAAM,EAAE,UAAU,EAAE,YAAY,EAAE,MAAM,EAAE,GAAG,cAAc,CAAC;YAE5D,OAAO,gBAAgB,CAAC,IAAI,CAC1B,IAAA,iBAAU,EAAC,CAAC,UAAU,EAAE,EAAE;gBACxB,IAAI,CAAA,UAAU,aAAV,UAAU,uBAAV,UAAU,CAAE,QAAQ,CAAC,KAAK,MAAK,IAAI,EAAE,EAAG,6CAA6C;oBACvF,OAAO,IAAA,SAAE,EAA0D,EAAE,GAAG,EAAE,IAAI,EAAE,CAAC,CAAC;iBACnF;qBAAM;oBACL,MAAM,WAAW,GAAsB,EAAE,CAAC;oBAE1C,yBAAyB;oBACzB,IAAI,MAAM,aAAN,MAAM,uBAAN,MAAM,CAAE,gBAAgB,EAAE;wBAC5B,IAAA,qBAAc,EAAC,WAAW,EAAE,MAAM,CAAC,gBAAgB,CAAC,CAAC;qBACtD;oBAED,aAAa;oBACb,MAAM,cAAc,GAAG,CAAC,UAAU,CAAC,CAAC,CAAC,CAAC,IAAA,gBAAS,EAAC,UAAU,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC;oBAC7E,MAAM,cAAc,GAAG,CAAC,cAAc,CAAC,CAAC,CAAC,CAAC,IAAA,mBAAO,EAAC,cAAc,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC;oBAE9E,IAAI,cAAc,EAAE;wBAClB,WAAW,CAAC,IAAI,CAAC,cAAc,CAAC,CAAC;qBAClC;oBAED,YAAY;oBACZ,WAAW,CAAC,IAAI,CAAC,IAAA,iBAAK,EAAC,YAAY,GAAG,CAAC,CAAC,cAAc,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAG,4DAA4D;oBAElI,MAAM,UAAU,GAAG,IAAA,iBAAK,EAAI,UAAU,EAAE,GAAG,WAAW,CAAC,CAAC;oBACxD,MAAM,aAAa,GAAqE,IAAA,mBAAO,EAAC,UAAU,CAAC,CAAC,IAAI,CAAC,CAAC,QAAQ,EAAE,EAAE;wBAC5H,IAAI,IAAI,GAAG,QAAQ,CAAC,IAAI,CAAC;wBAEzB,+CAA+C;wBAC/C,IAAI,cAAc,IAAI,IAAI,CAAC,CAAC,CAAC,CAAC,EAAE,KAAK,cAAc,CAAC,EAAE,EAAE;4BACtD,IAAI,GAAG,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC;yBACtB;wBAED,MAAM,MAAM,GAA4D;4BACtE,KAAK,EAAE;gCACL,IAAI;gCACJ,QAAQ;6BACT;4BACD,GAAG,EAAE,QAAQ,CAAC,KAAK;yBACpB,CAAC;wBAEF,OAAO,MAAM,CAAC;oBAChB,CAAC,CAAC,CAAC;oBACH,OAAO,IAAA,WAAI,EAAC,aAAa,CAAC,CAAC;iBAC5B;YACH,CAAC,CAAC,CACH,CAAC;QACJ,CAAC;KACF,CAAA;AACH,CAAC;AAxDD,sFAwDC;AAED,MAAa,kCAAsC,SAAQ,sCAM1D;IAEC,YAAY,iBAAgE;QAC1E,KAAK,CAAC,iBAAiB,EAAE;YACvB,cAAc,EAAE,IAAI;YACpB,QAAQ,EAAE,CAAC,CAAkC,EAAE,EAAE,CAAC,CAAC,CAAC,IAAI;SACzD,CAAC,CAAC;IACL,CAAC;IAED,IAAI,iBAAiB;QACnB,OAAO,IAAI,CAAC,YAAY,CAAC;IAC3B,CAAC;CAEF;AAnBD,gFAmBC;AAeD;;;;;GAKG;AACH,SAAgB,iCAAiC,CAAI,UAAmD;IACtG,OAAO,CAAC,MAAwC,EAAE,EAAE;QAClD,MAAM,MAAM,GAA0C,0BAA0B,CAAI;YAClF,UAAU,EAAE,UAAU,CAAC,UAAU;YACjC,YAAY,EAAE,UAAU,CAAC,YAAY;YACrC,MAAM;SACP,CAAC,CAAC;QAEH,OAAO,MAAM,CAAC;IAChB,CAAC,CAAC;AACJ,CAAC;AAVD,8EAUC;AAEY,QAAA,qCAAqC,GAA2C,qCAAqC,EAAS,CAAC;AAC/H,QAAA,4BAA4B,GAAG,IAAI,uBAAgB,CAA4G,6CAAqC,CAAC,CAAC;AAEnN,SAAgB,0BAA0B,CAAI,MAA2C;IACvF,MAAM,QAAQ,GAAkD,oCAA4B,CAAC,QAAQ,CAAC,MAAM,CAAC,CAAC;IAC9G,OAAO,IAAI,kCAAkC,CAAI,QAAQ,CAAC,CAAC;AAC7D,CAAC;AAHD,gEAGC"}

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

@@ -0,0 +1,13 @@
+import { CollectionReference, DocumentReference } from "@firebase/firestore";
+/**
+ * Contains a reference to a CollectionReference.
+ */
+export interface FirestoreCollectionReference<T> {
+    readonly collection: CollectionReference<T>;
+}
+/**
+ * Contains a reference to a DocumentReference.
+ */
+export interface FirestoreDocumentReference<T> {
+    readonly documentRef: DocumentReference<T>;
+}

package/src/lib/firestore/reference.js

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

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

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

package/src/lib/index.d.ts

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

package/src/lib/index.js

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

package/src/lib/index.js.map

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

package/src/test/firebase.context.d.ts

@@ -0,0 +1,5 @@
+import { JestTestContextFactory } from '@dereekb/util';
+import { FirebaseTestingContextFixture } from './firebase';
+export declare const TESTING_AUTHORIZED_FIREBASE_USER_ID = "0";
+export declare type FirebaseTestContextFactory = JestTestContextFactory<FirebaseTestingContextFixture>;
+export declare const authorizedFirebase: FirebaseTestContextFactory;

package/src/test/firebase.context.item.d.ts

@@ -0,0 +1,41 @@
+import { AbstractWrappedFixtureWithInstance, JestTestWrappedContextFactoryBuilder, Maybe } from '@dereekb/util';
+import { Firestore, CollectionReference } from 'firebase/firestore';
+import { FirebaseTestingContextFixture } from './firebase';
+import { AbstractFirestoreDocument } from '../lib/firestore/document';
+import { FirestoreCollection } from '../lib/firestore/firestore';
+/**
+ * Data for a test item in our firestore collection.
+ */
+export interface TestItem {
+    test?: boolean;
+    value?: Maybe<string>;
+}
+export declare class TestItemDocument extends AbstractFirestoreDocument<TestItem> {
+}
+export declare const testItemCollectionPath = "test";
+/**
+ * A way to build a testItemCollection from a firestore instance.
+ *
+ * @param firestore
+ * @returns
+ */
+export declare function testItemCollection(firestore: Firestore): CollectionReference<TestItem>;
+export declare type TestItemFirestoreCollection = FirestoreCollection<TestItem, TestItemDocument>;
+export declare function testItemFirestoreCollection(firestore: Firestore): TestItemFirestoreCollection;
+export declare class TestItemCollectionFixtureInstance {
+    readonly fixture: TestItemCollectionFixture;
+    readonly testItemCollection: CollectionReference<TestItem>;
+    constructor(fixture: TestItemCollectionFixture);
+}
+/**
+ * Used to expose a CollectionReference to TestItem for simple tests.
+ */
+export declare class TestItemCollectionFixture extends AbstractWrappedFixtureWithInstance<TestItemCollectionFixtureInstance, FirebaseTestingContextFixture> {
+}
+export interface TestItemCollectionFirebaseContextConfig {
+}
+export declare function testWithTestItemFixture(config?: TestItemCollectionFirebaseContextConfig): JestTestWrappedContextFactoryBuilder<TestItemCollectionFixture, FirebaseTestingContextFixture>;
+/**
+ * Tests within an authorized context.
+ */
+export declare const authorizedTestWithTestItemCollection: import("@dereekb/util").JestTestContextFactory<TestItemCollectionFixture>;

package/src/test/firebase.context.item.js

@@ -0,0 +1,75 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.authorizedTestWithTestItemCollection = exports.testWithTestItemFixture = exports.TestItemCollectionFixture = exports.TestItemCollectionFixtureInstance = exports.testItemFirestoreCollection = exports.testItemCollection = exports.testItemCollectionPath = exports.TestItemDocument = void 0;
+const util_1 = require("@dereekb/util");
+const firestore_1 = require("firebase/firestore");
+const firebase_context_1 = require("./firebase.context");
+const document_1 = require("../lib/firestore/document");
+const firestore_2 = require("../lib/firestore/firestore");
+class TestItemDocument extends document_1.AbstractFirestoreDocument {
+}
+exports.TestItemDocument = TestItemDocument;
+exports.testItemCollectionPath = 'test';
+/**
+ * A way to build a testItemCollection from a firestore instance.
+ *
+ * @param firestore
+ * @returns
+ */
+function testItemCollection(firestore) {
+    return (0, firestore_1.collection)(firestore, exports.testItemCollectionPath).withConverter({
+        toFirestore(modelObject) {
+            return {
+                test: modelObject.test || false,
+                value: modelObject.value || null
+            };
+        },
+        fromFirestore(snapshot, options) {
+            const data = snapshot.data();
+            const result = {
+                test: data['test'] || false,
+                value: data['value'] || null
+            };
+            return result;
+        }
+    });
+}
+exports.testItemCollection = testItemCollection;
+function testItemFirestoreCollection(firestore) {
+    return (0, firestore_2.makeFirestoreCollection)({
+        itemsPerPage: 50,
+        collection: testItemCollection(firestore),
+        makeDocument: (x) => new TestItemDocument(x)
+    });
+}
+exports.testItemFirestoreCollection = testItemFirestoreCollection;
+// MARK: Test Item Testing Fixture
+class TestItemCollectionFixtureInstance {
+    constructor(fixture) {
+        this.fixture = fixture;
+        this.testItemCollection = testItemCollection(this.fixture.parent.firestore);
+    }
+}
+exports.TestItemCollectionFixtureInstance = TestItemCollectionFixtureInstance;
+/**
+ * Used to expose a CollectionReference to TestItem for simple tests.
+ */
+class TestItemCollectionFixture extends util_1.AbstractWrappedFixtureWithInstance {
+}
+exports.TestItemCollectionFixture = TestItemCollectionFixture;
+function testWithTestItemFixture(config) {
+    return (0, util_1.instanceWrapJestTestContextFactory)({
+        wrapFixture: (fixture) => new TestItemCollectionFixture(fixture),
+        makeInstance: (wrap) => new TestItemCollectionFixtureInstance(wrap),
+        teardownInstance: (instance) => {
+            // instance.fixture.parent.instance.clearFirestore();
+        }
+        // TODO: Utilize config here using the setup/teardown later if needed.
+    });
+}
+exports.testWithTestItemFixture = testWithTestItemFixture;
+/**
+ * Tests within an authorized context.
+ */
+exports.authorizedTestWithTestItemCollection = testWithTestItemFixture()(firebase_context_1.authorizedFirebase);
+//# sourceMappingURL=firebase.context.item.js.map

package/src/test/firebase.context.item.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"firebase.context.item.js","sourceRoot":"","sources":["../../../../../packages/firebase/src/test/firebase.context.item.ts"],"names":[],"mappings":";;;AAAA,wCAAoJ;AACpJ,kDAAsJ;AAEtJ,yDAAwD;AACxD,wDAAsE;AACtE,0DAA0F;AAY1F,MAAa,gBAAiB,SAAQ,oCAAmC;CAAI;AAA7E,4CAA6E;AAEhE,QAAA,sBAAsB,GAAG,MAAM,CAAC;AAE7C;;;;;GAKG;AACH,SAAgB,kBAAkB,CAAC,SAAoB;IACrD,OAAO,IAAA,sBAAU,EAAC,SAAS,EAAE,8BAAsB,CAAC,CAAC,aAAa,CAAW;QAC3E,WAAW,CAAC,WAAqC;YAC/C,OAAO;gBACL,IAAI,EAAE,WAAW,CAAC,IAAI,IAAI,KAAK;gBAC/B,KAAK,EAAE,WAAW,CAAC,KAAK,IAAI,IAAI;aACjC,CAAC;QACJ,CAAC;QACD,aAAa,CAAC,QAA6C,EAAE,OAAyB;YACpF,MAAM,IAAI,GAAG,QAAQ,CAAC,IAAI,EAAE,CAAC;YAC7B,MAAM,MAAM,GAAa;gBACvB,IAAI,EAAE,IAAI,CAAC,MAAM,CAAC,IAAI,KAAK;gBAC3B,KAAK,EAAE,IAAI,CAAC,OAAO,CAAC,IAAI,IAAI;aAC7B,CAAC;YACF,OAAO,MAAM,CAAC;QAChB,CAAC;KACF,CAAC,CAAC;AACL,CAAC;AAjBD,gDAiBC;AAID,SAAgB,2BAA2B,CAAC,SAAoB;IAC9D,OAAO,IAAA,mCAAuB,EAAC;QAC7B,YAAY,EAAE,EAAE;QAChB,UAAU,EAAE,kBAAkB,CAAC,SAAS,CAAC;QACzC,YAAY,EAAE,CAAC,CAA0C,EAAE,EAAE,CAAC,IAAI,gBAAgB,CAAC,CAAC,CAAC;KACtF,CAAC,CAAC;AACL,CAAC;AAND,kEAMC;AAED,kCAAkC;AAClC,MAAa,iCAAiC;IAI5C,YAAqB,OAAkC;QAAlC,YAAO,GAAP,OAAO,CAA2B;QAF9C,uBAAkB,GAAG,kBAAkB,CAAC,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,SAAS,CAAC,CAAC;IAErB,CAAC;CAE7D;AAND,8EAMC;AAED;;GAEG;AACH,MAAa,yBAA0B,SAAQ,yCAAoG;CAAI;AAAvJ,8DAAuJ;AAIvJ,SAAgB,uBAAuB,CAAC,MAAgD;IACtF,OAAO,IAAA,yCAAkC,EAAC;QACxC,WAAW,EAAE,CAAC,OAAO,EAAE,EAAE,CAAC,IAAI,yBAAyB,CAAC,OAAO,CAAC;QAChE,YAAY,EAAE,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,iCAAiC,CAAC,IAAI,CAAC;QACnE,gBAAgB,EAAE,CAAC,QAA2C,EAAE,EAAE;YAChE,qDAAqD;QACvD,CAAC;QACD,sEAAsE;KACvE,CAAC,CAAC;AACL,CAAC;AATD,0DASC;AAED;;GAEG;AACU,QAAA,oCAAoC,GAAG,uBAAuB,EAAE,CAAC,qCAAkB,CAAC,CAAC"}

package/src/test/firebase.context.js

@@ -0,0 +1,23 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.authorizedFirebase = exports.TESTING_AUTHORIZED_FIREBASE_USER_ID = void 0;
+const firebase_1 = require("./firebase");
+exports.TESTING_AUTHORIZED_FIREBASE_USER_ID = '0';
+exports.authorizedFirebase = (0, firebase_1.firebaseTestBuilder)({
+    testEnvironment: {
+        firestore: {
+            rules: `
+      rules_version = '2';
+      service cloud.firestore {
+        match /databases/{database}/documents {
+          match /{document=**} {
+            allow read, write: if true;
+          }
+        }
+      }
+      `
+        }
+    },
+    rulesContext: { userId: exports.TESTING_AUTHORIZED_FIREBASE_USER_ID }
+});
+//# sourceMappingURL=firebase.context.js.map

package/src/test/firebase.context.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"firebase.context.js","sourceRoot":"","sources":["../../../../../packages/firebase/src/test/firebase.context.ts"],"names":[],"mappings":";;;AACA,yCAAgF;AAEnE,QAAA,mCAAmC,GAAG,GAAG,CAAC;AAI1C,QAAA,kBAAkB,GAA+B,IAAA,8BAAmB,EAAC;IAChF,eAAe,EAAE;QACf,SAAS,EAAE;YACT,KAAK,EAAE;;;;;;;;;OASN;SACF;KACF;IACD,YAAY,EAAE,EAAE,MAAM,EAAE,2CAAmC,EAAE;CAC9D,CAAC,CAAC"}

package/src/test/firebase.d.ts

@@ -0,0 +1,29 @@
+import { Firestore } from '@firebase/firestore';
+import { TestEnvironmentConfig, RulesTestEnvironment, RulesTestContext, TokenOptions } from "@firebase/rules-unit-testing";
+import { AbstractJestTestContextFixture, Maybe } from "@dereekb/util";
+export interface FirebaseTestingRulesContextConfig {
+    userId: string;
+    tokenOptions?: Maybe<TokenOptions>;
+}
+export interface FirebaseTestingConfig {
+    testEnvironment: TestEnvironmentConfig;
+    rulesContext?: Maybe<FirebaseTestingRulesContextConfig>;
+    retainFirestoreBetweenTests?: boolean;
+}
+export declare class FirebaseTestInstance {
+    readonly rulesTestEnvironment: RulesTestEnvironment;
+    readonly rulesTestContext: RulesTestContext;
+    private readonly _firestore;
+    constructor(rulesTestEnvironment: RulesTestEnvironment, rulesTestContext: RulesTestContext);
+    get firestore(): Firestore;
+    clearFirestore(): Promise<void>;
+}
+export declare class FirebaseTestingContextFixture extends AbstractJestTestContextFixture<FirebaseTestInstance> {
+    get firestore(): Firestore;
+}
+/**
+ * A JestTestContextBuilderFunction for building firebase test context factories.
+ *
+ * This can be used to easily build a testing context that sets up RulesTestEnvironment for tests that sets itself up and tears itself down.
+ */
+export declare const firebaseTestBuilder: import("@dereekb/util").JestTestContextBuilderFunction<FirebaseTestInstance, FirebaseTestingContextFixture, FirebaseTestingConfig>;

package/src/test/firebase.js

@@ -0,0 +1,67 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.firebaseTestBuilder = exports.FirebaseTestingContextFixture = exports.FirebaseTestInstance = void 0;
+const tslib_1 = require("tslib");
+const rules_unit_testing_1 = require("@firebase/rules-unit-testing");
+const util_1 = require("@dereekb/util");
+class FirebaseTestInstance {
+    constructor(rulesTestEnvironment, rulesTestContext) {
+        this.rulesTestEnvironment = rulesTestEnvironment;
+        this.rulesTestContext = rulesTestContext;
+        this._firestore = this.rulesTestContext.firestore();
+    }
+    get firestore() {
+        return this._firestore;
+    }
+    clearFirestore() {
+        return this.rulesTestEnvironment.clearFirestore();
+    }
+}
+exports.FirebaseTestInstance = FirebaseTestInstance;
+class FirebaseTestingContextFixture extends util_1.AbstractJestTestContextFixture {
+    // MARK: From Instance
+    get firestore() {
+        return this.instance.firestore;
+    }
+}
+exports.FirebaseTestingContextFixture = FirebaseTestingContextFixture;
+/**
+ * A JestTestContextBuilderFunction for building firebase test context factories.
+ *
+ * This can be used to easily build a testing context that sets up RulesTestEnvironment for tests that sets itself up and tears itself down.
+ */
+exports.firebaseTestBuilder = (0, util_1.jestTestContextBuilder)({
+    buildConfig: (input) => {
+        var _a;
+        const config = {
+            testEnvironment: (_a = input === null || input === void 0 ? void 0 : input.testEnvironment) !== null && _a !== void 0 ? _a : {},
+            rulesContext: input === null || input === void 0 ? void 0 : input.rulesContext
+        };
+        return config;
+    },
+    buildFixture: () => new FirebaseTestingContextFixture(),
+    setupInstance: (config) => (0, tslib_1.__awaiter)(void 0, void 0, void 0, function* () {
+        const rulesTestEnv = yield (0, rules_unit_testing_1.initializeTestEnvironment)(config.testEnvironment);
+        const rulesTestContext = rulesTestContextForConfig(rulesTestEnv, config.rulesContext);
+        return new FirebaseTestInstance(rulesTestEnv, rulesTestContext);
+    }),
+    teardownInstance: (instance, config) => (0, tslib_1.__awaiter)(void 0, void 0, void 0, function* () {
+        if (config.retainFirestoreBetweenTests !== true) {
+            yield instance.clearFirestore(); // Clear the firestore
+        }
+        yield instance.rulesTestEnvironment.cleanup(); // Cleanup
+    })
+});
+// MARK: Internal
+function rulesTestContextForConfig(rulesTestEnv, testingRulesConfig) {
+    var _a;
+    let rulesTestContext;
+    if (testingRulesConfig != null) {
+        rulesTestContext = rulesTestEnv.authenticatedContext(testingRulesConfig.userId, (_a = testingRulesConfig.tokenOptions) !== null && _a !== void 0 ? _a : undefined);
+    }
+    else {
+        rulesTestContext = rulesTestEnv.unauthenticatedContext();
+    }
+    return rulesTestContext;
+}
+//# sourceMappingURL=firebase.js.map

package/src/test/firebase.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"firebase.js","sourceRoot":"","sources":["../../../../../packages/firebase/src/test/firebase.ts"],"names":[],"mappings":";;;;AACA,qEAMsC;AAEtC,wCAAsH;AAetH,MAAa,oBAAoB;IAI/B,YAAqB,oBAA0C,EAAW,gBAAkC;QAAvF,yBAAoB,GAApB,oBAAoB,CAAsB;QAAW,qBAAgB,GAAhB,gBAAgB,CAAkB;QAF3F,eAAU,GAAc,IAAI,CAAC,gBAAgB,CAAC,SAAS,EAAS,CAAC;IAE8B,CAAC;IAEjH,IAAI,SAAS;QACX,OAAO,IAAI,CAAC,UAAU,CAAC;IACzB,CAAC;IAED,cAAc;QACZ,OAAO,IAAI,CAAC,oBAAoB,CAAC,cAAc,EAAE,CAAC;IACpD,CAAC;CAIF;AAhBD,oDAgBC;AAED,MAAa,6BAA8B,SAAQ,qCAAoD;IAErG,sBAAsB;IACtB,IAAI,SAAS;QACX,OAAO,IAAI,CAAC,QAAQ,CAAC,SAAS,CAAC;IACjC,CAAC;CAEF;AAPD,sEAOC;AAED;;;;GAIG;AACU,QAAA,mBAAmB,GAAG,IAAA,6BAAsB,EAA6E;IACpI,WAAW,EAAE,CAAC,KAAsC,EAAE,EAAE;;QACtD,MAAM,MAAM,GAA0B;YACpC,eAAe,EAAE,MAAA,KAAK,aAAL,KAAK,uBAAL,KAAK,CAAE,eAAe,mCAAI,EAAE;YAC7C,YAAY,EAAE,KAAK,aAAL,KAAK,uBAAL,KAAK,CAAE,YAAY;SAClC,CAAC;QAEF,OAAO,MAAM,CAAC;IAChB,CAAC;IACD,YAAY,EAAE,GAAG,EAAE,CAAC,IAAI,6BAA6B,EAAE;IACvD,aAAa,EAAE,CAAO,MAAM,EAAE,EAAE;QAC9B,MAAM,YAAY,GAAG,MAAM,IAAA,8CAAyB,EAAC,MAAM,CAAC,eAAe,CAAC,CAAC;QAC7E,MAAM,gBAAgB,GAAG,yBAAyB,CAAC,YAAY,EAAE,MAAM,CAAC,YAAY,CAAC,CAAC;QACtF,OAAO,IAAI,oBAAoB,CAAC,YAAY,EAAE,gBAAgB,CAAC,CAAC;IAClE,CAAC,CAAA;IACD,gBAAgB,EAAE,CAAO,QAAQ,EAAE,MAAM,EAAE,EAAE;QAC3C,IAAI,MAAM,CAAC,2BAA2B,KAAK,IAAI,EAAE;YAC/C,MAAM,QAAQ,CAAC,cAAc,EAAE,CAAC,CAAE,sBAAsB;SACzD;QAED,MAAM,QAAQ,CAAC,oBAAoB,CAAC,OAAO,EAAE,CAAC,CAAE,UAAU;IAC5D,CAAC,CAAA;CACF,CAAC,CAAC;AAEH,iBAAiB;AACjB,SAAS,yBAAyB,CAAC,YAAkC,EAAE,kBAA6D;;IAClI,IAAI,gBAAkC,CAAC;IAEvC,IAAI,kBAAkB,IAAI,IAAI,EAAE;QAC9B,gBAAgB,GAAG,YAAY,CAAC,oBAAoB,CAAC,kBAAkB,CAAC,MAAM,EAAE,MAAA,kBAAkB,CAAC,YAAY,mCAAI,SAAS,CAAC,CAAC;KAC/H;SAAM;QACL,gBAAgB,GAAG,YAAY,CAAC,sBAAsB,EAAE,CAAC;KAC1D;IAED,OAAO,gBAAgB,CAAC;AAC1B,CAAC"}

package/src/test/index.d.ts

@@ -0,0 +1,3 @@
+export * from './firebase';
+export * from './firebase.context';
+export * from './firebase.context.item';

package/src/test/index.js

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

package/src/test/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../../packages/firebase/src/test/index.ts"],"names":[],"mappings":";;;AAAA,0DAA2B;AAC3B,kEAAmC;AACnC,uEAAwC"}