@dereekb/firebase 2.0.0 → 4.0.0

package/src/lib/model/user.d.ts

@@ -0,0 +1,12 @@
+import { FirebaseAuthUserId } from "../common/auth/auth";
+/**
+ * The model is related to a user with the model's uid.
+ */
+export interface UserRelated {
+    uid: FirebaseAuthUserId;
+}
+/**
+ * The model is related to a user by the model's own identifier.
+ */
+export interface UserRelatedById {
+}

package/src/lib/model/user.js

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

package/src/lib/model/user.js.map

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

package/test/CHANGELOG.md

@@ -0,0 +1,5 @@
+# Changelog
+
+This file was generated using [@jscutlery/semver](https://github.com/jscutlery/semver).
+
+# [4.0.0](https://github.com/dereekb/dbx-components/compare/v3.0.0...v4.0.0) (2022-05-14)

package/test/README.md

@@ -0,0 +1,11 @@
+# firebase-test
+
+This library was generated with [Nx](https://nx.dev).
+
+## Running unit tests
+
+Run `nx test firebase-test` to execute the unit tests via [Jest](https://jestjs.io).
+
+## Running lint
+
+Run `nx lint firebase-test` to execute the lint via [ESLint](https://eslint.org/).

package/test/package.json

@@ -0,0 +1,28 @@
+{
+  "name": "@dereekb/firebase/test",
+  "version": "4.0.0",
+  "main": "./src/index.js",
+  "typings": "./src/index.d.ts",
+  "dependencies": {},
+  "peerDependencies": {
+    "@dereekb/util/test": "4.0.0",
+    "@dereekb/util": "4.0.0",
+    "make-error": "^1.3.0",
+    "extra-set": "^2.2.11",
+    "change-case": "^4.1.2",
+    "@dereekb/firebase": "4.0.0",
+    "rxjs": "^7.0.0",
+    "rxfire": "^6.0.3",
+    "firebase": "^9.8.0",
+    "@dereekb/rxjs": "4.0.0",
+    "ms": "^3.0.0-canary.1",
+    "@dereekb/date": "4.0.0",
+    "class-transformer": "^0.5.1",
+    "date-fns": "^2.28.0",
+    "class-validator": "^0.13.2",
+    "date-fns-tz": "^1.3.0",
+    "rrule": "git+https://git@github.com/dereekb/rrule.git#17adf5708d6567b4d01a3a8afd106261421ea492",
+    "@dereekb/model": "4.0.0",
+    "tslib": "^2.0.0"
+  }
+}

package/test/src/index.d.ts

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

package/test/src/index.js

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

package/test/src/index.js.map

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

package/test/src/lib/client/firestore.authorized.d.ts

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

package/{src/test/firebase.context.js → test/src/lib/client/firestore.authorized.js}

@@ -1,9 +1,9 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.authorizedFirebase = exports.TESTING_AUTHORIZED_FIREBASE_USER_ID = void 0;
-const firebase_1 = require("./firebase");
+exports.authorizedFirestoreFactory = exports.TESTING_AUTHORIZED_FIREBASE_USER_ID = void 0;
+const firestore_1 = require("./firestore");
 exports.TESTING_AUTHORIZED_FIREBASE_USER_ID = '0';
-exports.authorizedFirebase = (0, firebase_1.firebaseTestBuilder)({
+exports.authorizedFirestoreFactory = (0, firestore_1.firestoreTestBuilder)({
     testEnvironment: {
         firestore: {
             rules: `
@@ -20,4 +20,4 @@ exports.authorizedFirebase = (0, firebase_1.firebaseTestBuilder)({
     },
     rulesContext: { userId: exports.TESTING_AUTHORIZED_FIREBASE_USER_ID }
 });
-//# sourceMappingURL=firebase.context.js.map
+//# sourceMappingURL=firestore.authorized.js.map

package/test/src/lib/client/firestore.authorized.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"firestore.authorized.js","sourceRoot":"","sources":["../../../../../../../packages/firebase/test/src/lib/client/firestore.authorized.ts"],"names":[],"mappings":";;;AACA,2CAA+F;AAElF,QAAA,mCAAmC,GAAG,GAAG,CAAC;AAI1C,QAAA,0BAA0B,GAA+B,IAAA,gCAAoB,EAAC;IACzF,eAAe,EAAE;QACf,SAAS,EAAE;YACT,KAAK,EAAE;;;;;;;;;OASN;SACF;KACF;IACD,YAAY,EAAE,EAAE,MAAM,EAAE,2CAAmC,EAAE;CAC9D,CAAC,CAAC"}

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

@@ -0,0 +1,39 @@
+import { TestFirestoreContext, TestingFirestoreDrivers } from '../common/firestore';
+import { Maybe } from '@dereekb/util';
+import { TestEnvironmentConfig, RulesTestEnvironment, RulesTestContext, TokenOptions, EmulatorConfig } from "@firebase/rules-unit-testing";
+import { TestFirestoreContextFixture, TestFirestoreInstance } from '../common/firestore.mock';
+export interface RulesUnitTestingContextConfig {
+    userId: string;
+    tokenOptions?: Maybe<TokenOptions>;
+}
+export interface RulesUnitTestingTestEnvironmentConfig extends TestEnvironmentConfig {
+    /**
+     * List of collection names used in the environment. Is required if using testing drivers.
+     */
+    collectionNames?: string[];
+    firestore?: EmulatorConfig;
+}
+export interface RulesUnitTestingConfig {
+    clearFirestoreBetweenTests?: boolean;
+    testEnvironment: RulesUnitTestingTestEnvironmentConfig;
+    rulesContext?: Maybe<RulesUnitTestingContextConfig>;
+}
+export interface RulesUnitTestTestFirestoreContext extends TestFirestoreContext {
+    readonly rulesTestEnvironment: RulesTestEnvironment;
+    readonly rulesTestContext: RulesTestContext;
+}
+export declare function makeRulesTestFirestoreContext(drivers: TestingFirestoreDrivers, rulesTestEnvironment: RulesTestEnvironment, rulesTestContext: RulesTestContext): TestFirestoreContext;
+export declare class RulesUnitTestTestFirestoreInstance extends TestFirestoreInstance {
+    readonly rulesTestEnvironment: RulesTestEnvironment;
+    readonly rulesTestContext: RulesTestContext;
+    constructor(drivers: TestingFirestoreDrivers, rulesTestEnvironment: RulesTestEnvironment, rulesTestContext: RulesTestContext);
+}
+export declare class RulesUnitTestFirebaseTestingContextFixture extends TestFirestoreContextFixture<RulesUnitTestTestFirestoreInstance> {
+}
+/**
+ * A JestTestContextBuilderFunction for building firebase test context factories using @firebase/firebase and @firebase/rules-unit-testing. This means CLIENT TESTING ONLY. For server testing, look at @dereekb/firestore-server.
+ *
+ * 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 firestoreTestBuilder: import("@dereekb/util/test").JestTestContextBuilderFunction<RulesUnitTestTestFirestoreInstance, RulesUnitTestFirebaseTestingContextFixture, RulesUnitTestingConfig>;
+export declare function changeFirestoreLogLevelBeforeAndAfterTests(): void;

package/test/src/lib/client/firestore.js

@@ -0,0 +1,90 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.changeFirestoreLogLevelBeforeAndAfterTests = exports.firestoreTestBuilder = exports.RulesUnitTestFirebaseTestingContextFixture = exports.RulesUnitTestTestFirestoreInstance = exports.makeRulesTestFirestoreContext = void 0;
+const tslib_1 = require("tslib");
+const firestore_1 = require("../common/firestore");
+const test_1 = require("@dereekb/util/test");
+const rules_unit_testing_1 = require("@firebase/rules-unit-testing");
+const firestore_mock_1 = require("../common/firestore.mock");
+const firebase_1 = require("@dereekb/firebase");
+const firestore_2 = require("firebase/firestore");
+function makeRulesTestFirestoreContext(drivers, rulesTestEnvironment, rulesTestContext) {
+    const context = Object.assign(Object.assign({}, (0, firebase_1.firestoreContextFactory)(drivers)(rulesTestContext.firestore())), { drivers,
+        rulesTestContext,
+        rulesTestEnvironment });
+    return context;
+}
+exports.makeRulesTestFirestoreContext = makeRulesTestFirestoreContext;
+class RulesUnitTestTestFirestoreInstance extends firestore_mock_1.TestFirestoreInstance {
+    constructor(drivers, rulesTestEnvironment, rulesTestContext) {
+        super(makeRulesTestFirestoreContext(drivers, rulesTestEnvironment, rulesTestContext));
+        this.rulesTestEnvironment = rulesTestEnvironment;
+        this.rulesTestContext = rulesTestContext;
+    }
+}
+exports.RulesUnitTestTestFirestoreInstance = RulesUnitTestTestFirestoreInstance;
+class RulesUnitTestFirebaseTestingContextFixture extends firestore_mock_1.TestFirestoreContextFixture {
+}
+exports.RulesUnitTestFirebaseTestingContextFixture = RulesUnitTestFirebaseTestingContextFixture;
+/**
+ * A JestTestContextBuilderFunction for building firebase test context factories using @firebase/firebase and @firebase/rules-unit-testing. This means CLIENT TESTING ONLY. For server testing, look at @dereekb/firestore-server.
+ *
+ * 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.firestoreTestBuilder = (0, test_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 RulesUnitTestFirebaseTestingContextFixture(),
+    setupInstance: (config) => tslib_1.__awaiter(void 0, void 0, void 0, function* () {
+        const drivers = (0, firestore_1.makeTestingFirestoreDrivers)((0, firebase_1.firebaseFirestoreClientDrivers)());
+        let testEnvironment = config.testEnvironment;
+        if (config.testEnvironment.collectionNames) {
+            const pathsMap = drivers.firestoreAccessorDriver.initWithCollectionNames(config.testEnvironment.collectionNames);
+            testEnvironment = Object.assign(Object.assign({}, testEnvironment), { firestore: rewriteEmulatorConfigRulesForFuzzedCollectionNames(testEnvironment.firestore, pathsMap) });
+        }
+        const rulesTestEnv = yield (0, rules_unit_testing_1.initializeTestEnvironment)(config.testEnvironment);
+        const rulesTestContext = rulesTestContextForConfig(rulesTestEnv, config.rulesContext);
+        return new RulesUnitTestTestFirestoreInstance(drivers, rulesTestEnv, rulesTestContext);
+    }),
+    teardownInstance: (instance, config) => tslib_1.__awaiter(void 0, void 0, void 0, function* () {
+        if (config.clearFirestoreBetweenTests) {
+            yield instance.clearFirestore();
+        }
+        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;
+}
+function rewriteEmulatorConfigRulesForFuzzedCollectionNames(config, fuzzedCollectionNamesMap) {
+    if (config && config.rules) {
+        config = Object.assign(Object.assign({}, config), { rules: rewriteRulesForFuzzedCollectionNames(config.rules, fuzzedCollectionNamesMap) });
+    }
+    return config;
+}
+function rewriteRulesForFuzzedCollectionNames(rules, fuzzedCollectionNamesMap) {
+    // TODO: rewrite the rules using regex matching/replacement.
+    return rules;
+}
+// MARK: Utility
+function changeFirestoreLogLevelBeforeAndAfterTests() {
+    beforeAll(() => (0, firestore_2.setLogLevel)('error'));
+    afterAll(() => (0, firestore_2.setLogLevel)('warn'));
+}
+exports.changeFirestoreLogLevelBeforeAndAfterTests = changeFirestoreLogLevelBeforeAndAfterTests;
+//# sourceMappingURL=firestore.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"firestore.js","sourceRoot":"","sources":["../../../../../../../packages/firebase/test/src/lib/client/firestore.ts"],"names":[],"mappings":";;;;AAAA,mDAAiH;AAEjH,6CAA4D;AAC5D,qEAOsC;AACtC,6DAA8F;AAC9F,gDAA4F;AAC5F,kDAAiD;AA0BjD,SAAgB,6BAA6B,CAAC,OAAgC,EAAE,oBAA0C,EAAE,gBAAkC;IAC5J,MAAM,OAAO,mCACR,IAAA,kCAAuB,EAAC,OAAO,CAAC,CAAC,gBAAgB,CAAC,SAAS,EAAE,CAAC,KACjE,OAAO;QACP,gBAAgB;QAChB,oBAAoB,GACrB,CAAC;IAEF,OAAO,OAAO,CAAC;AACjB,CAAC;AATD,sEASC;AAED,MAAa,kCAAmC,SAAQ,sCAAqB;IAE3E,YAAY,OAAgC,EAAW,oBAA0C,EAAW,gBAAkC;QAC5I,KAAK,CAAC,6BAA6B,CAAC,OAAO,EAAE,oBAAoB,EAAE,gBAAgB,CAAC,CAAC,CAAC;QADjC,yBAAoB,GAApB,oBAAoB,CAAsB;QAAW,qBAAgB,GAAhB,gBAAgB,CAAkB;IAE9I,CAAC;CAIF;AARD,gFAQC;AAED,MAAa,0CAA2C,SAAQ,4CAA+D;CAAI;AAAnI,gGAAmI;AAEnI;;;;GAIG;AACU,QAAA,oBAAoB,GAAG,IAAA,6BAAsB,EAAyG;IACjK,WAAW,EAAE,CAAC,KAAuC,EAAE,EAAE;;QACvD,MAAM,MAAM,GAA2B;YACrC,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,0CAA0C,EAAE;IACpE,aAAa,EAAE,CAAO,MAAM,EAAE,EAAE;QAE9B,MAAM,OAAO,GAAG,IAAA,uCAA2B,EAAC,IAAA,yCAA8B,GAAE,CAAC,CAAC;QAC9E,IAAI,eAAe,GAAG,MAAM,CAAC,eAAe,CAAC;QAE7C,IAAI,MAAM,CAAC,eAAe,CAAC,eAAe,EAAE;YAC1C,MAAM,QAAQ,GAAG,OAAO,CAAC,uBAAuB,CAAC,uBAAuB,CAAC,MAAM,CAAC,eAAe,CAAC,eAAe,CAAC,CAAC;YACjH,eAAe,mCACV,eAAe,KAClB,SAAS,EAAE,kDAAkD,CAAC,eAAe,CAAC,SAAS,EAAE,QAAQ,CAAC,GACnG,CAAC;SACH;QAED,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,kCAAkC,CAAC,OAAO,EAAE,YAAY,EAAE,gBAAgB,CAAC,CAAC;IACzF,CAAC,CAAA;IACD,gBAAgB,EAAE,CAAO,QAAQ,EAAE,MAAM,EAAE,EAAE;QAC3C,IAAI,MAAM,CAAC,0BAA0B,EAAE;YACrC,MAAM,QAAQ,CAAC,cAAc,EAAE,CAAC;SACjC;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,kBAAyD;;IAC9H,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;AAED,SAAS,kDAAkD,CAAC,MAAkC,EAAE,wBAA6C;IAE3I,IAAI,MAAM,IAAI,MAAM,CAAC,KAAK,EAAE;QAC1B,MAAM,mCACD,MAAM,KACT,KAAK,EAAE,oCAAoC,CAAC,MAAM,CAAC,KAAK,EAAE,wBAAwB,CAAC,GACpF,CAAC;KACH;IAED,OAAO,MAAM,CAAC;AAChB,CAAC;AAED,SAAS,oCAAoC,CAAC,KAAyB,EAAE,wBAA6C;IAEpH,4DAA4D;IAE5D,OAAO,KAAK,CAAC;AACf,CAAC;AAED,gBAAgB;AAChB,SAAgB,0CAA0C;IACxD,SAAS,CAAC,GAAG,EAAE,CAAC,IAAA,uBAAW,EAAC,OAAO,CAAC,CAAC,CAAC;IACtC,QAAQ,CAAC,GAAG,EAAE,CAAC,IAAA,uBAAW,EAAC,MAAM,CAAC,CAAC,CAAC;AACtC,CAAC;AAHD,gGAGC"}

package/test/src/lib/client/firestore.mock.item.fixture.authorized.d.ts

@@ -0,0 +1,6 @@
+/**
+ * Convenience mock instance for tests within an authorized context.
+ *
+ * Uses @firestore/firebase. This is ONLY for the client.
+ */
+export declare const authorizedTestWithMockItemCollection: import("../../../../../../dist/packages/util/test/src").JestTestContextFactory<import("../common/firestore.mock.item.fixture").MockItemCollectionFixture>;

package/test/src/lib/client/firestore.mock.item.fixture.authorized.js

@@ -0,0 +1,12 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.authorizedTestWithMockItemCollection = void 0;
+const firestore_mock_item_fixture_1 = require("../common/firestore.mock.item.fixture");
+const firestore_authorized_1 = require("./firestore.authorized");
+/**
+ * Convenience mock instance for tests within an authorized context.
+ *
+ * Uses @firestore/firebase. This is ONLY for the client.
+ */
+exports.authorizedTestWithMockItemCollection = (0, firestore_mock_item_fixture_1.testWithMockItemFixture)()(firestore_authorized_1.authorizedFirestoreFactory);
+//# sourceMappingURL=firestore.mock.item.fixture.authorized.js.map

package/test/src/lib/client/firestore.mock.item.fixture.authorized.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"firestore.mock.item.fixture.authorized.js","sourceRoot":"","sources":["../../../../../../../packages/firebase/test/src/lib/client/firestore.mock.item.fixture.authorized.ts"],"names":[],"mappings":";;;AAAA,uFAAgF;AAChF,iEAAoE;AAEpE;;;;GAIG;AACU,QAAA,oCAAoC,GAAG,IAAA,qDAAuB,GAAE,CAAC,iDAA0B,CAAC,CAAC"}

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

@@ -0,0 +1,3 @@
+export * from './firestore.authorized';
+export * from './firestore.mock.item.fixture.authorized';
+export * from './firestore';

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

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

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

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

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

@@ -0,0 +1,35 @@
+import { FirestoreAccessorDriver, FirestoreContext, FirestoreDrivers } from '@dereekb/firebase';
+export interface TestingFirestoreAccessorDriver extends FirestoreAccessorDriver {
+    /**
+     * Gets the fuzzed path names map.
+     */
+    getFuzzedCollectionsNameMap(): Map<string, string>;
+    /**
+     * Initializes fuzzed path names for the input collections. Returns the result of getFuzzedCollectionsNameMap().
+     *
+     * This initialization step is useful for the client, where the rules file needs to be updated to reflect the collection names properly in order to ensure rules are correct.
+     * @param collectionPaths
+     */
+    initWithCollectionNames(collectionPaths: string[]): Map<string, string>;
+}
+export declare function makeTestingFirestoreAccesorDriver(driver: FirestoreAccessorDriver): TestingFirestoreAccessorDriver;
+/**
+ * Drivers used for testing. Provides additional functionality for controlling collection access to prevent cross-test contamination.
+ */
+export interface TestingFirestoreDrivers extends FirestoreDrivers {
+    driverType: 'testing';
+    firestoreAccessorDriver: TestingFirestoreAccessorDriver;
+}
+/**
+ * Extends the input drivers to generate new drivers for a testing environment.
+ *
+ * @param drivers
+ * @returns
+ */
+export declare function makeTestingFirestoreDrivers(drivers: FirestoreDrivers): TestingFirestoreDrivers;
+export interface TestingFirestoreContextExtension {
+    drivers: TestingFirestoreDrivers;
+}
+export declare type TestFirestoreContext<C = FirestoreContext> = C & TestingFirestoreContextExtension;
+export declare type ClearTestFirestoreCollectionFunction = (collectionName: string, realCollectionPath: string) => Promise<void>;
+export declare function clearTestFirestoreContextCollections(context: TestFirestoreContext, clearCollection: ClearTestFirestoreCollectionFunction): Promise<void>;

package/test/src/lib/common/firestore.js

@@ -0,0 +1,50 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.clearTestFirestoreContextCollections = exports.makeTestingFirestoreDrivers = exports.makeTestingFirestoreAccesorDriver = void 0;
+const tslib_1 = require("tslib");
+const util_1 = require("@dereekb/util");
+function makeTestingFirestoreAccesorDriver(driver) {
+    let fuzzerKey = 0;
+    const time = new Date().getTime();
+    const fuzzedMap = new Map();
+    const collection = driver.collection;
+    const fuzzedCollectionName = (path) => {
+        let fuzzedPath = fuzzedMap.get(path);
+        if (!fuzzedPath) {
+            const random = Math.ceil(Math.random() * 9999) % 9999;
+            fuzzedPath = `${time}_${random}_${path}_${fuzzerKey += 1}`;
+            fuzzedMap.set(path, fuzzedPath);
+        }
+        return fuzzedPath;
+    };
+    const fuzzedCollection = (f, path) => {
+        const fuzzedPath = fuzzedCollectionName(path);
+        return collection(f, fuzzedPath);
+    };
+    const initWithCollectionNames = (collectionPaths) => {
+        collectionPaths.forEach((x) => fuzzedCollectionName(x));
+        return fuzzedMap;
+    };
+    const injectedDriver = Object.assign(Object.assign({}, driver), { collection: fuzzedCollection, getFuzzedCollectionsNameMap: () => fuzzedMap, initWithCollectionNames });
+    return injectedDriver;
+}
+exports.makeTestingFirestoreAccesorDriver = makeTestingFirestoreAccesorDriver;
+/**
+ * Extends the input drivers to generate new drivers for a testing environment.
+ *
+ * @param drivers
+ * @returns
+ */
+function makeTestingFirestoreDrivers(drivers) {
+    return Object.assign(Object.assign({}, drivers), { driverType: 'testing', firestoreAccessorDriver: makeTestingFirestoreAccesorDriver(drivers.firestoreAccessorDriver) });
+}
+exports.makeTestingFirestoreDrivers = makeTestingFirestoreDrivers;
+function clearTestFirestoreContextCollections(context, clearCollection) {
+    return tslib_1.__awaiter(this, void 0, void 0, function* () {
+        const names = context.drivers.firestoreAccessorDriver.getFuzzedCollectionsNameMap();
+        const tuples = Array.from(names.entries());
+        yield util_1.PromiseUtility.performTasks(tuples, ([name, fuzzyPath]) => clearCollection(name, fuzzyPath));
+    });
+}
+exports.clearTestFirestoreContextCollections = clearTestFirestoreContextCollections;
+//# sourceMappingURL=firestore.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"firestore.js","sourceRoot":"","sources":["../../../../../../../packages/firebase/test/src/lib/common/firestore.ts"],"names":[],"mappings":";;;;AAAA,wCAA+C;AAkB/C,SAAgB,iCAAiC,CAAC,MAA+B;IAC/E,IAAI,SAAS,GAAG,CAAC,CAAC;IAClB,MAAM,IAAI,GAAG,IAAI,IAAI,EAAE,CAAC,OAAO,EAAE,CAAC;IAClC,MAAM,SAAS,GAAG,IAAI,GAAG,EAAkB,CAAC;IAC5C,MAAM,UAAU,GAAG,MAAM,CAAC,UAAU,CAAC;IAErC,MAAM,oBAAoB,GAAG,CAAC,IAAY,EAAE,EAAE;QAC5C,IAAI,UAAU,GAAW,SAAS,CAAC,GAAG,CAAC,IAAI,CAAE,CAAC;QAE9C,IAAI,CAAC,UAAU,EAAE;YACf,MAAM,MAAM,GAAG,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,MAAM,EAAE,GAAG,IAAI,CAAC,GAAG,IAAI,CAAC;YACtD,UAAU,GAAG,GAAG,IAAI,IAAI,MAAM,IAAI,IAAI,IAAI,SAAS,IAAI,CAAC,EAAE,CAAC;YAC3D,SAAS,CAAC,GAAG,CAAC,IAAI,EAAE,UAAU,CAAC,CAAC;SACjC;QAED,OAAO,UAAU,CAAC;IACpB,CAAC,CAAC;IAEF,MAAM,gBAAgB,GAAG,CAAI,CAAY,EAAE,IAAY,EAAE,EAAE;QACzD,MAAM,UAAU,GAAG,oBAAoB,CAAC,IAAI,CAAC,CAAC;QAC9C,OAAO,UAAU,CAAI,CAAC,EAAE,UAAU,CAAC,CAAC;IACtC,CAAC,CAAC;IAEF,MAAM,uBAAuB,GAAG,CAAC,eAAyB,EAAE,EAAE;QAC5D,eAAe,CAAC,OAAO,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,oBAAoB,CAAC,CAAC,CAAC,CAAC,CAAC;QACxD,OAAO,SAAS,CAAC;IACnB,CAAC,CAAC;IAEF,MAAM,cAAc,GAAG,gCAClB,MAAM,KACT,UAAU,EAAE,gBAAgB,EAC5B,2BAA2B,EAAE,GAAG,EAAE,CAAC,SAAS,EAC5C,uBAAuB,GACjB,CAAC;IAET,OAAO,cAAc,CAAC;AACxB,CAAC;AApCD,8EAoCC;AAUD;;;;;GAKG;AACH,SAAgB,2BAA2B,CAAC,OAAyB;IACnE,uCACK,OAAO,KACV,UAAU,EAAE,SAAS,EACrB,uBAAuB,EAAE,iCAAiC,CAAC,OAAO,CAAC,uBAAuB,CAAC,IAC3F;AACJ,CAAC;AAND,kEAMC;AAYD,SAAsB,oCAAoC,CAAC,OAA6B,EAAE,eAAqD;;QAC7I,MAAM,KAAK,GAAG,OAAO,CAAC,OAAO,CAAC,uBAAuB,CAAC,2BAA2B,EAAE,CAAC;QACpF,MAAM,MAAM,GAAG,KAAK,CAAC,IAAI,CAAC,KAAK,CAAC,OAAO,EAAE,CAAC,CAAC;QAC3C,MAAM,qBAAc,CAAC,YAAY,CAAC,MAAM,EAAE,CAAC,CAAC,IAAI,EAAE,SAAS,CAAC,EAAE,EAAE,CAAC,eAAe,CAAC,IAAI,EAAE,SAAS,CAAC,CAAC,CAAC;IACrG,CAAC;CAAA;AAJD,oFAIC"}

package/test/src/lib/common/firestore.mock.d.ts

@@ -0,0 +1,14 @@
+import { AbstractJestTestContextFixture, JestTestContextFactory } from "@dereekb/util/test";
+import { Firestore } from '@dereekb/firebase';
+import { TestFirestoreContext } from "./firestore";
+export declare class TestFirestoreInstance {
+    readonly context: TestFirestoreContext;
+    constructor(context: TestFirestoreContext);
+    get firestore(): Firestore;
+    clearFirestore(): Promise<void>;
+}
+export declare class TestFirestoreContextFixture<F extends TestFirestoreInstance = TestFirestoreInstance> extends AbstractJestTestContextFixture<F> {
+    get firestore(): Firestore;
+    get context(): TestFirestoreContext;
+}
+export declare type JestTestFirestoreContextFactory = JestTestContextFactory<TestFirestoreContextFixture>;

package/test/src/lib/common/firestore.mock.item.d.ts

@@ -0,0 +1,95 @@
+import { Maybe } from '@dereekb/util';
+import { CollectionReference, FirestoreCollection, FirestoreContext, AbstractFirestoreDocument, SingleItemFirestoreCollection, FirestoreCollectionWithParent, AbstractFirestoreDocumentWithParent } from '@dereekb/firebase';
+/**
+ * Data for a test item in our firestore collection.
+ */
+export interface MockItem {
+    test?: boolean;
+    value?: Maybe<string>;
+}
+/**
+ * FirestoreDocument for MockItem
+ */
+export declare class MockItemDocument extends AbstractFirestoreDocument<MockItem, MockItemDocument> {
+}
+/**
+ * Firestore collection path name.
+ */
+export declare const mockItemCollectionPath = "test";
+/**
+ * Used to build a FirestoreDataConverter. Fields are configured via configuration. See the SnapshotConverterFunctions for more info.
+ */
+export declare const mockItemConverter: import("@dereekb/firebase").SnapshotConverterFunctions<MockItem>;
+/**
+ * Used to build a mockItemCollection from a firestore instance with a converter setup.
+ *
+ * @param firestore
+ * @returns
+ */
+export declare function mockItemCollectionReference(context: FirestoreContext): CollectionReference<MockItem>;
+export declare type MockItemFirestoreCollection = FirestoreCollection<MockItem, MockItemDocument>;
+export declare function mockItemFirestoreCollection(firestoreContext: FirestoreContext): MockItemFirestoreCollection;
+/**
+ * Private data for each MockItem.
+ *
+ * There is only a single private data item per each MockItem.
+ */
+export interface MockItemPrivateData {
+    comments?: string;
+    createdAt?: Date;
+}
+/**
+ * FirestoreDocument for MockItem
+ */
+export declare class MockItemPrivateDataDocument extends AbstractFirestoreDocument<MockItemPrivateData, MockItemPrivateDataDocument> {
+}
+/**
+ * Firestore collection path name.
+ */
+export declare const mockItemPrivateDataCollectionPath = "private";
+export declare const mockItemPrivateDataIdentifier = "0";
+/**
+ * Used to build a FirestoreDataConverter. Fields are configured via configuration. See the SnapshotConverterFunctions for more info.
+ */
+export declare const mockItemPrivateDataConverter: import("@dereekb/firebase").SnapshotConverterFunctions<MockItemPrivateData>;
+/**
+ * Used to build a mockItemCollection from a firestore instance with a converter setup.
+ *
+ * @param firestore
+ * @returns
+ */
+export declare function mockItemPrivateDataCollectionReferenceFactory(context: FirestoreContext): (parent: MockItemDocument) => CollectionReference<MockItemPrivateData>;
+export declare type MockItemPrivateDataFirestoreCollection = SingleItemFirestoreCollection<MockItemPrivateData, MockItem, MockItemPrivateDataDocument>;
+export declare type MockItemPrivateDataFirestoreCollectionFactory = (parent: MockItemDocument) => MockItemPrivateDataFirestoreCollection;
+export declare function mockItemPrivateDataFirestoreCollection(firestoreContext: FirestoreContext): MockItemPrivateDataFirestoreCollectionFactory;
+/**
+ * Data for a sub item in our firestore collection.
+ *
+ * There may be an unlimited number of MockItemSubItems for a MockItem.
+ */
+export interface MockItemSubItem {
+    value?: Maybe<number>;
+}
+/**
+ * FirestoreDocument for MockItem
+ */
+export declare class MockItemSubItemDocument extends AbstractFirestoreDocumentWithParent<MockItem, MockItemSubItem, MockItemSubItemDocument> {
+}
+/**
+ * Firestore collection path name.
+ */
+export declare const mockItemSubItemCollectionPath = "sub";
+/**
+ * Used to build a FirestoreDataConverter. Fields are configured via configuration. See the SnapshotConverterFunctions for more info.
+ */
+export declare const mockItemSubItemConverter: import("@dereekb/firebase").SnapshotConverterFunctions<MockItemSubItem>;
+export declare function mockItemSubItemCollectionReferenceFactory(context: FirestoreContext): (parent: MockItemDocument) => CollectionReference<MockItemSubItem>;
+export declare type MockItemSubItemFirestoreCollection = FirestoreCollectionWithParent<MockItemSubItem, MockItem, MockItemSubItemDocument, MockItemDocument>;
+export declare type MockItemSubItemFirestoreCollectionFactory = (parent: MockItemDocument) => MockItemSubItemFirestoreCollection;
+export declare function mockItemSubItemFirestoreCollection(firestoreContext: FirestoreContext): MockItemSubItemFirestoreCollectionFactory;
+export declare abstract class MockItemCollections {
+    abstract readonly mockItem: MockItemFirestoreCollection;
+    abstract readonly mockItemPrivateData: MockItemPrivateDataFirestoreCollectionFactory;
+    abstract readonly mockItemSubItem: MockItemSubItemFirestoreCollectionFactory;
+}
+export declare function makeMockItemCollections(firestoreContext: FirestoreContext): MockItemCollections;

package/test/src/lib/common/firestore.mock.item.fixture.d.ts

@@ -0,0 +1,21 @@
+import { CollectionReference } from '@dereekb/firebase';
+import { AbstractWrappedFixtureWithInstance, JestTestWrappedContextFactoryBuilder } from '@dereekb/util/test';
+import { MockItemFirestoreCollection, MockItem } from './firestore.mock.item';
+import { TestFirestoreContextFixture } from './firestore.mock';
+export declare class MockItemCollectionFixtureInstance {
+    readonly fixture: MockItemCollectionFixture;
+    readonly collections: import("./firestore.mock.item").MockItemCollections;
+    get collection(): CollectionReference<MockItem>;
+    get firestoreCollection(): MockItemFirestoreCollection;
+    get mockItemPrivateDataCollection(): import("./firestore.mock.item").MockItemPrivateDataFirestoreCollectionFactory;
+    get mockItemSubItemCollection(): import("./firestore.mock.item").MockItemSubItemFirestoreCollectionFactory;
+    constructor(fixture: MockItemCollectionFixture);
+}
+/**
+ * Used to expose a CollectionReference to MockItem for simple tests.
+ */
+export declare class MockItemCollectionFixture extends AbstractWrappedFixtureWithInstance<MockItemCollectionFixtureInstance, TestFirestoreContextFixture> {
+}
+export interface MockItemCollectionFirebaseContextConfig {
+}
+export declare function testWithMockItemFixture(config?: MockItemCollectionFirebaseContextConfig): JestTestWrappedContextFactoryBuilder<MockItemCollectionFixture, TestFirestoreContextFixture>;

package/test/src/lib/common/firestore.mock.item.fixture.js

@@ -0,0 +1,43 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.testWithMockItemFixture = exports.MockItemCollectionFixture = exports.MockItemCollectionFixtureInstance = void 0;
+const test_1 = require("@dereekb/util/test");
+const firestore_mock_item_1 = require("./firestore.mock.item");
+// MARK: Test Item Testing Fixture
+class MockItemCollectionFixtureInstance {
+    constructor(fixture) {
+        this.fixture = fixture;
+        this.collections = (0, firestore_mock_item_1.makeMockItemCollections)(this.fixture.parent.context);
+    }
+    get collection() {
+        return this.firestoreCollection.collection;
+    }
+    get firestoreCollection() {
+        return this.collections.mockItem;
+    }
+    get mockItemPrivateDataCollection() {
+        return this.collections.mockItemPrivateData;
+    }
+    get mockItemSubItemCollection() {
+        return this.collections.mockItemSubItem;
+    }
+}
+exports.MockItemCollectionFixtureInstance = MockItemCollectionFixtureInstance;
+/**
+ * Used to expose a CollectionReference to MockItem for simple tests.
+ */
+class MockItemCollectionFixture extends test_1.AbstractWrappedFixtureWithInstance {
+}
+exports.MockItemCollectionFixture = MockItemCollectionFixture;
+function testWithMockItemFixture(config) {
+    return (0, test_1.instanceWrapJestTestContextFactory)({
+        wrapFixture: (fixture) => new MockItemCollectionFixture(fixture),
+        makeInstance: (wrap) => new MockItemCollectionFixtureInstance(wrap),
+        teardownInstance: (instance) => {
+            // instance.fixture.parent.instance.clearFirestore();
+        },
+        // TODO: Utilize config here using the setup/teardown later if needed.
+    });
+}
+exports.testWithMockItemFixture = testWithMockItemFixture;
+//# sourceMappingURL=firestore.mock.item.fixture.js.map

package/test/src/lib/common/firestore.mock.item.fixture.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"firestore.mock.item.fixture.js","sourceRoot":"","sources":["../../../../../../../packages/firebase/test/src/lib/common/firestore.mock.item.fixture.ts"],"names":[],"mappings":";;;AACA,6CAAkJ;AAClJ,+DAAuG;AAGvG,kCAAkC;AAClC,MAAa,iCAAiC;IAmB5C,YAAqB,OAAkC;QAAlC,YAAO,GAAP,OAAO,CAA2B;QAjB9C,gBAAW,GAAG,IAAA,6CAAuB,EAAC,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC;IAiBjB,CAAC;IAf5D,IAAI,UAAU;QACZ,OAAO,IAAI,CAAC,mBAAmB,CAAC,UAAU,CAAC;IAC7C,CAAC;IACD,IAAI,mBAAmB;QACrB,OAAO,IAAI,CAAC,WAAW,CAAC,QAAQ,CAAC;IACnC,CAAC;IAED,IAAI,6BAA6B;QAC/B,OAAO,IAAI,CAAC,WAAW,CAAC,mBAAmB,CAAC;IAC9C,CAAC;IAED,IAAI,yBAAyB;QAC3B,OAAO,IAAI,CAAC,WAAW,CAAC,eAAe,CAAC;IAC1C,CAAC;CAIF;AArBD,8EAqBC;AAED;;GAEG;AACH,MAAa,yBAA0B,SAAQ,yCAAkG;CAAI;AAArJ,8DAAqJ;AAIrJ,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"}