@dereekb/firebase 5.2.1 → 7.0.0

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

@@ -4,6 +4,102 @@ import { FirestoreItemPageIterationBaseConfig, FirestoreItemPageIterationFactory
 import { FirestoreQueryFactory } from '../query/query';
 import { FirestoreDrivers } from '../driver/driver';
 import { FirestoreCollectionQueryFactory } from './collection.query';
+import { ModelKey, ModelTypeString } from '@dereekb/util';
+/**
+ * The camelCase model name.
+ */
+export declare type FirestoreModelName = ModelTypeString;
+/**
+ * An all lowercase name that references a collection. Is usually the lowercase version of the FirestoreModelName.
+ *
+ * This is the part of the path that says what the collection is.
+ *
+ * Each collection name in the app should be unique, as usage of CollectionGroups would cause collections with the same name to be returned.
+ */
+export declare type FirestoreCollectionName = string;
+/**
+ * FirestoreCollectionName derived from a FirestoreModelName
+ */
+export declare type FirestoreModelCollectionName<M extends FirestoreModelName> = `${Lowercase<M>}`;
+/**
+ * A firestore model's identity
+ */
+export declare type FirestoreModelIdentity<M extends FirestoreModelName = FirestoreModelName> = {
+    readonly model: M;
+    readonly collection: FirestoreModelCollectionName<M>;
+};
+export declare type FirestoreCollectionNames<I extends FirestoreModelIdentity> = I extends FirestoreModelIdentity<infer M> ? FirestoreModelCollectionName<M> : never;
+export declare type FirestoreModelNames<I extends FirestoreModelIdentity> = I extends FirestoreModelIdentity<infer M> ? M : never;
+/**
+ * Creates a FirestoreModelIdentity value.
+ *
+ * @param modelName
+ * @returns
+ */
+export declare function firestoreModelIdentity<M extends FirestoreModelName>(modelName: M): FirestoreModelIdentity<M>;
+/**
+ * Reference to a FirestoreCollectionName
+ */
+export interface FirestoreModelNameRef<M extends FirestoreModelName = FirestoreModelName> {
+    /**
+     * Returns the FirestoreModelName for this context.
+     */
+    readonly modelType: M;
+}
+/**
+ * Reference to a FirestoreCollectionName
+ */
+export interface FirestoreCollectionNameRef {
+    /**
+     * Returns the FirestoreCollectionName for this context.
+     */
+    readonly collectionName: FirestoreCollectionName;
+}
+/**
+ * Reference to a FirestoreModelIdentity
+ */
+export interface FirestoreModelIdentityRef<M extends FirestoreModelName = FirestoreModelName> {
+    /**
+     * Returns the FirestoreModelIdentity for this context.
+     */
+    readonly modelIdentity: FirestoreModelIdentity<M>;
+}
+/**
+ * The model's id within a collection.
+ *
+ * Different from the FirestoreModelKey, which is the full path in the databse.
+ *
+ * Example:
+ *
+ * 12345
+ */
+export declare type FirestoreModelId = string;
+/**
+ * Reference to a FirestoreModelId
+ */
+export interface FirestoreModelIdRef {
+    /**
+     * Returns the FirestoreModelId for this context.
+     */
+    readonly id: FirestoreModelId;
+}
+/**
+ * The full path for a model in the Firestore database.
+ *
+ * Example:
+ *
+ * collection/12345/subcollection/67890
+ */
+export declare type FirestoreModelKey = ModelKey;
+/**
+ * Reference to a FirestoreModelKey
+ */
+export interface FirestoreModelKeyRef {
+    /**
+     * Returns the FirestoreModelKey for this context.
+     */
+    readonly key: FirestoreModelKey;
+}
 /**
  * Instance that provides several accessors for accessing documents of a collection.
  */

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

@@ -1,10 +1,23 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.makeFirestoreCollection = void 0;
+exports.makeFirestoreCollection = exports.firestoreModelIdentity = void 0;
 const document_1 = require("../accessor/document");
 const iterator_1 = require("../query/iterator");
 const query_1 = require("../query/query");
 const collection_query_1 = require("./collection.query");
+/**
+ * Creates a FirestoreModelIdentity value.
+ *
+ * @param modelName
+ * @returns
+ */
+function firestoreModelIdentity(modelName) {
+    return {
+        collection: modelName.toLowerCase(),
+        model: modelName
+    };
+}
+exports.firestoreModelIdentity = firestoreModelIdentity;
 /**
  * Creates a new FirestoreCollection from the input config.
  */

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

@@ -1 +1 @@
-{"version":3,"file":"collection.js","sourceRoot":"","sources":["../../../../../../../../packages/firebase/src/lib/common/firestore/collection/collection.ts"],"names":[],"mappings":";;;AACA,mDAc8B;AAC9B,gDAA0L;AAC1L,0CAA8E;AAE9E,yDAAsG;AAuCtG;;GAEG;AACH,SAAgB,uBAAuB,CAAoC,WAA4C;IACrH,MAAM,MAAM,GAAG,WAAyE,CAAC;IAEzF,MAAM,EAAE,UAAU,EAAE,gBAAgB,EAAE,uBAAuB,EAAE,GAAG,MAAM,CAAC;IACxE,MAAwD,CAAC,SAAS,GAAG,UAAU,CAAC;IAEjF,MAAM,kBAAkB,GAAiD,IAAA,4CAAiC,EAAC,MAAM,CAAC,CAAC;IACnH,MAAM,gBAAgB,GAAmD,IAAA,2CAAgC,EAAC,MAAM,CAAC,CAAC;IAClH,MAAM,YAAY,GAA6B,IAAA,6BAAqB,EAAC,MAAM,CAAC,CAAC;IAE7E,MAAM,yBAAyB,GAAG,IAAA,oDAAyC,EAAC,EAAE,gBAAgB,EAAE,uBAAuB,EAAE,CAAC,CAAC;IAC3H,MAAM,EAAE,aAAa,EAAE,GAAG,IAAA,kDAA+B,EAAC,YAAY,EAAE,yBAAyB,CAAC,CAAC;IACnG,MAAM,EAAE,KAAK,EAAE,GAAG,YAAY,CAAC;IAE/B,qCACE,MAAM;QACN,UAAU,EACV,SAAS,EAAE,UAAU,EACrB,gBAAgB,IACb,yBAAyB,KAC5B,kBAAkB;QAClB,KAAK;QACL,aAAa,IACb;AACJ,CAAC;AAxBD,0DAwBC"}
+{"version":3,"file":"collection.js","sourceRoot":"","sources":["../../../../../../../../packages/firebase/src/lib/common/firestore/collection/collection.ts"],"names":[],"mappings":";;;AACA,mDAc8B;AAC9B,gDAA0L;AAC1L,0CAA8E;AAE9E,yDAAsG;AAiCtG;;;;;GAKG;AACH,SAAgB,sBAAsB,CAA+B,SAAY;IAC/E,OAAO;QACL,UAAU,EAAE,SAAS,CAAC,WAAW,EAAqC;QACtE,KAAK,EAAE,SAAS;KACjB,CAAC;AACJ,CAAC;AALD,wDAKC;AA6GD;;GAEG;AACH,SAAgB,uBAAuB,CAAoC,WAA4C;IACrH,MAAM,MAAM,GAAG,WAAyE,CAAC;IAEzF,MAAM,EAAE,UAAU,EAAE,gBAAgB,EAAE,uBAAuB,EAAE,GAAG,MAAM,CAAC;IACxE,MAAwD,CAAC,SAAS,GAAG,UAAU,CAAC;IAEjF,MAAM,kBAAkB,GAAiD,IAAA,4CAAiC,EAAC,MAAM,CAAC,CAAC;IACnH,MAAM,gBAAgB,GAAmD,IAAA,2CAAgC,EAAC,MAAM,CAAC,CAAC;IAClH,MAAM,YAAY,GAA6B,IAAA,6BAAqB,EAAC,MAAM,CAAC,CAAC;IAE7E,MAAM,yBAAyB,GAAG,IAAA,oDAAyC,EAAC,EAAE,gBAAgB,EAAE,uBAAuB,EAAE,CAAC,CAAC;IAC3H,MAAM,EAAE,aAAa,EAAE,GAAG,IAAA,kDAA+B,EAAC,YAAY,EAAE,yBAAyB,CAAC,CAAC;IACnG,MAAM,EAAE,KAAK,EAAE,GAAG,YAAY,CAAC;IAE/B,qCACE,MAAM;QACN,UAAU,EACV,SAAS,EAAE,UAAU,EACrB,gBAAgB,IACb,yBAAyB,KAC5B,kBAAkB;QAClB,KAAK;QACL,aAAa,IACb;AACJ,CAAC;AAxBD,0DAwBC"}

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

@@ -8,11 +8,13 @@ export declare type FirestoreAccessorDriverCollectionGroupFunction = <T = Docume
 export declare type FirestoreAccessorDriverCollectionRefFunction = <T = DocumentData>(firestore: Firestore, path: string, ...pathSegments: string[]) => CollectionReference<T>;
 export declare type FirestoreAccessorDriverSubcollectionRefFunction = <T = DocumentData>(document: DocumentReference, path: string, ...pathSegments: string[]) => CollectionReference<T>;
 export declare type FirestoreAccessorDriverDocumentRefFunction = <T = DocumentData>(collection: CollectionReference<T>, path?: string, ...pathSegments: string[]) => DocumentReference<T>;
+export declare type FirestoreAccessorDriverFullPathDocumentRefFunction = <T = DocumentData>(firestore: Firestore, fullPath: string) => DocumentReference<T>;
 /**
  * A driver to use for query functionality.
  */
 export interface FirestoreAccessorDriver extends FirestoreTransactionFactoryDriver, FirestoreWriteBatchFactoryDriver {
     readonly doc: FirestoreAccessorDriverDocumentRefFunction;
+    readonly docAtPath: FirestoreAccessorDriverFullPathDocumentRefFunction;
     readonly collectionGroup: FirestoreAccessorDriverCollectionGroupFunction;
     readonly collection: FirestoreAccessorDriverCollectionRefFunction;
     readonly subcollection: FirestoreAccessorDriverSubcollectionRefFunction;

package/src/lib/common/firestore/driver/query.d.ts

@@ -1,12 +1,14 @@
-import { SnapshotListenOptions, Transaction } from './../types';
+import { FieldPath, SnapshotListenOptions, Transaction } from './../types';
 import { Observable } from 'rxjs';
 import { Query, QuerySnapshot } from '../types';
 import { FirestoreQueryConstraint } from '../query/constraint';
 import { Maybe } from '@dereekb/util';
 export declare type FirestoreQueryDriverQueryFunction = <T>(query: Query<T>, ...queryConstraints: FirestoreQueryConstraint[]) => Query<T>;
+export declare type FirestoreDocumentIdFieldPathAccessor = () => FieldPath;
 export interface FirestoreQueryConstraintFunctionsDriver {
     readonly availableConstraintTypes: Set<string>;
-    query: FirestoreQueryDriverQueryFunction;
+    readonly query: FirestoreQueryDriverQueryFunction;
+    readonly documentIdFieldPath: FirestoreDocumentIdFieldPathAccessor;
 }
 /**
  * A driver to use for query functionality.

package/src/lib/common/firestore/driver/query.handler.d.ts

@@ -1,7 +1,7 @@
 import { Query } from '../types';
 import { FirestoreQueryConstraintHandlerMap } from '../query/constraint';
 import { FirestoreQueryConstraintFunctionsDriver } from './query';
-export interface MakeFirestoreQueryConstraintFunctionsDriver<B> {
+export interface MakeFirestoreQueryConstraintFunctionsDriver<B> extends Omit<FirestoreQueryConstraintFunctionsDriver, 'query' | 'availableConstraintTypes'> {
     mapping: FirestoreQueryConstraintHandlerMap<B>;
     init: <T>(query: Query<T>) => B;
     build: <T>(builder: B) => Query<T>;

package/src/lib/common/firestore/driver/query.handler.js

@@ -3,7 +3,7 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.makeFirestoreQueryConstraintFunctionsDriver = void 0;
 const util_1 = require("@dereekb/util");
 function makeFirestoreQueryConstraintFunctionsDriver(config) {
-    const { mapping, init, build } = config;
+    const { mapping, init, build, documentIdFieldPath } = config;
     const constraintsMap = (0, util_1.objectToMap)(mapping);
     const availableConstraintTypes = new Set(constraintsMap.keys());
     const query = (query, ...queryConstraints) => {
@@ -19,7 +19,8 @@ function makeFirestoreQueryConstraintFunctionsDriver(config) {
     };
     return {
         availableConstraintTypes,
-        query
+        query,
+        documentIdFieldPath
     };
 }
 exports.makeFirestoreQueryConstraintFunctionsDriver = makeFirestoreQueryConstraintFunctionsDriver;

package/src/lib/common/firestore/driver/query.handler.js.map

@@ -1 +1 @@
-{"version":3,"file":"query.handler.js","sourceRoot":"","sources":["../../../../../../../../packages/firebase/src/lib/common/firestore/driver/query.handler.ts"],"names":[],"mappings":";;;AAAA,wCAA4C;AAW5C,SAAgB,2CAA2C,CAAI,MAAsD;IACnH,MAAM,EAAE,OAAO,EAAE,IAAI,EAAE,KAAK,EAAE,GAAG,MAAM,CAAC;IACxC,MAAM,cAAc,GAAG,IAAA,kBAAW,EAAC,OAAO,CAAC,CAAC;IAC5C,MAAM,wBAAwB,GAAgB,IAAI,GAAG,CAAC,cAAc,CAAC,IAAI,EAAE,CAAC,CAAC;IAC7E,MAAM,KAAK,GAAsC,CAAI,KAAe,EAAE,GAAG,gBAA4C,EAAE,EAAE;QACvH,IAAI,OAAO,GAAG,IAAI,CAAC,KAAK,CAAC,CAAC;QAE1B,gBAAgB,CAAC,OAAO,CAAC,CAAC,CAA2B,EAAE,EAAE;YACvD,MAAM,OAAO,GAAG,cAAc,CAAC,GAAG,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC;YAE3C,IAAI,CAAC,OAAO,EAAE;gBACZ,MAAM,IAAI,KAAK,CAAC,uEAAuE,CAAC,CAAC,IAAI,IAAI,CAAC,CAAC;aACpG;YAED,OAAO,GAAG,OAAO,CAAC,OAAO,EAAE,CAAC,CAAC,IAAI,EAAE,CAAC,CAAC,CAAC;QACxC,CAAC,CAAC,CAAC;QAEH,OAAO,KAAK,CAAC,OAAO,CAAC,CAAC;IACxB,CAAC,CAAC;IAEF,OAAO;QACL,wBAAwB;QACxB,KAAK;KACN,CAAC;AACJ,CAAC;AAxBD,kGAwBC"}
+{"version":3,"file":"query.handler.js","sourceRoot":"","sources":["../../../../../../../../packages/firebase/src/lib/common/firestore/driver/query.handler.ts"],"names":[],"mappings":";;;AAAA,wCAA4C;AAW5C,SAAgB,2CAA2C,CAAI,MAAsD;IACnH,MAAM,EAAE,OAAO,EAAE,IAAI,EAAE,KAAK,EAAE,mBAAmB,EAAE,GAAG,MAAM,CAAC;IAC7D,MAAM,cAAc,GAAG,IAAA,kBAAW,EAAC,OAAO,CAAC,CAAC;IAC5C,MAAM,wBAAwB,GAAgB,IAAI,GAAG,CAAC,cAAc,CAAC,IAAI,EAAE,CAAC,CAAC;IAC7E,MAAM,KAAK,GAAsC,CAAI,KAAe,EAAE,GAAG,gBAA4C,EAAE,EAAE;QACvH,IAAI,OAAO,GAAG,IAAI,CAAC,KAAK,CAAC,CAAC;QAE1B,gBAAgB,CAAC,OAAO,CAAC,CAAC,CAA2B,EAAE,EAAE;YACvD,MAAM,OAAO,GAAG,cAAc,CAAC,GAAG,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC;YAE3C,IAAI,CAAC,OAAO,EAAE;gBACZ,MAAM,IAAI,KAAK,CAAC,uEAAuE,CAAC,CAAC,IAAI,IAAI,CAAC,CAAC;aACpG;YAED,OAAO,GAAG,OAAO,CAAC,OAAO,EAAE,CAAC,CAAC,IAAI,EAAE,CAAC,CAAC,CAAC;QACxC,CAAC,CAAC,CAAC;QAEH,OAAO,KAAK,CAAC,OAAO,CAAC,CAAC;IACxB,CAAC,CAAC;IAEF,OAAO;QACL,wBAAwB;QACxB,KAAK;QACL,mBAAmB;KACpB,CAAC;AACJ,CAAC;AAzBD,kGAyBC"}

package/src/lib/common/firestore/query/constraint.d.ts

@@ -1,4 +1,5 @@
-import { ArrayOrValue, SeparateResult, SortingOrder, Maybe } from '@dereekb/util';
+import { FieldPathOrStringPath } from './../types';
+import { ArrayOrValue, SeparateResult, SortingOrder, Maybe, StringKeyPropertyKeys } from '@dereekb/util';
 import { DocumentSnapshot, DocumentData, FieldPath } from '../types';
 export declare type FirestoreQueryConstraintType = string;
 /**
@@ -48,15 +49,24 @@ export declare function where(fieldPath: string | FieldPath, opStr: WhereFilterO
 export declare const FIRESTORE_ORDER_BY_QUERY_CONSTRAINT_TYPE = "order_by";
 export declare type OrderByDirection = SortingOrder;
 export interface OrderByQueryConstraintData {
-    fieldPath: string | FieldPath;
+    fieldPath: FieldPathOrStringPath;
     directionStr?: OrderByDirection;
 }
-export declare function orderBy(fieldPath: string | FieldPath, directionStr?: OrderByDirection): FirestoreQueryConstraint<OrderByQueryConstraintData>;
+export declare function orderBy<T>(fieldPath: StringKeyPropertyKeys<T>, directionStr?: OrderByDirection): FirestoreQueryConstraint<OrderByQueryConstraintData>;
+export declare function orderBy(fieldPath: FieldPathOrStringPath, directionStr?: OrderByDirection): FirestoreQueryConstraint<OrderByQueryConstraintData>;
+export declare const FIRESTORE_ORDER_BY_DOCUMENT_ID_QUERY_CONSTRAINT_TYPE = "order_by_doc_id";
+export declare type OrderByDocumentIdQueryConstraintData = Pick<OrderByQueryConstraintData, 'directionStr'>;
+export declare function orderByDocumentId(directionStr?: OrderByDirection): FirestoreQueryConstraint<OrderByDocumentIdQueryConstraintData>;
 export declare const FIRESTORE_START_AT_QUERY_CONSTRAINT_TYPE = "start_at";
 export interface StartAtQueryConstraintData<T = DocumentData> {
     snapshot: DocumentSnapshot<T>;
 }
 export declare function startAt<T = DocumentData>(snapshot: DocumentSnapshot<T>): FirestoreQueryConstraint<StartAtQueryConstraintData<T>>;
+export declare const FIRESTORE_START_AT_VALUE_QUERY_CONSTRAINT_TYPE = "start_at_path";
+export interface StartAtValueQueryConstraintData {
+    fieldValues: unknown[];
+}
+export declare function startAtValue(...fieldValues: unknown[]): FirestoreQueryConstraint<StartAtValueQueryConstraintData>;
 export declare const FIRESTORE_START_AFTER_QUERY_CONSTRAINT_TYPE = "start_after";
 export interface StartAfterQueryConstraintData<T = DocumentData> {
     snapshot: DocumentSnapshot<T>;
@@ -66,6 +76,11 @@ export declare const FIRESTORE_END_AT_QUERY_CONSTRAINT_TYPE = "end_at";
 export interface EndAtQueryConstraintData<T = DocumentData> {
     snapshot: DocumentSnapshot<T>;
 }
+export declare const FIRESTORE_END_AT_VALUE_QUERY_CONSTRAINT_TYPE = "end_at_path";
+export interface EndAtValueQueryConstraintData {
+    fieldValues: unknown[];
+}
+export declare function endAtValue(...fieldValues: unknown[]): FirestoreQueryConstraint<EndAtValueQueryConstraintData>;
 /**
  *
  * @param snapshot
@@ -98,9 +113,12 @@ export declare type FullFirestoreQueryConstraintDataMapping = {
     [FIRESTORE_WHERE_QUERY_CONSTRAINT_TYPE]: WhereQueryConstraintData;
     [FIRESTORE_OFFSET_QUERY_CONSTRAINT_TYPE]: OffsetQueryConstraintData;
     [FIRESTORE_ORDER_BY_QUERY_CONSTRAINT_TYPE]: OrderByQueryConstraintData;
+    [FIRESTORE_ORDER_BY_DOCUMENT_ID_QUERY_CONSTRAINT_TYPE]: OrderByDocumentIdQueryConstraintData;
     [FIRESTORE_START_AT_QUERY_CONSTRAINT_TYPE]: StartAtQueryConstraintData;
+    [FIRESTORE_START_AT_VALUE_QUERY_CONSTRAINT_TYPE]: StartAtValueQueryConstraintData;
     [FIRESTORE_START_AFTER_QUERY_CONSTRAINT_TYPE]: StartAfterQueryConstraintData;
     [FIRESTORE_END_AT_QUERY_CONSTRAINT_TYPE]: EndAtQueryConstraintData;
+    [FIRESTORE_END_AT_VALUE_QUERY_CONSTRAINT_TYPE]: EndAtValueQueryConstraintData;
     [FIRESTORE_END_BEFORE_QUERY_CONSTRAINT_TYPE]: EndBeforeQueryConstraintData;
 };
 export declare type FullFirestoreQueryConstraintMapping = {

package/src/lib/common/firestore/query/constraint.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.separateConstraints = exports.replaceConstraints = exports.filterConstraintsOfType = exports.addOrReplaceLimitInConstraints = exports.endBefore = exports.FIRESTORE_END_BEFORE_QUERY_CONSTRAINT_TYPE = exports.endAt = exports.FIRESTORE_END_AT_QUERY_CONSTRAINT_TYPE = exports.startAfter = exports.FIRESTORE_START_AFTER_QUERY_CONSTRAINT_TYPE = exports.startAt = exports.FIRESTORE_START_AT_QUERY_CONSTRAINT_TYPE = exports.orderBy = exports.FIRESTORE_ORDER_BY_QUERY_CONSTRAINT_TYPE = exports.where = exports.FIRESTORE_WHERE_QUERY_CONSTRAINT_TYPE = exports.offset = exports.FIRESTORE_OFFSET_QUERY_CONSTRAINT_TYPE = exports.limitToLast = exports.FIRESTORE_LIMIT_TO_LAST_QUERY_CONSTRAINT_TYPE = exports.limit = exports.FIRESTORE_LIMIT_QUERY_CONSTRAINT_TYPE = exports.firestoreQueryConstraintFactory = exports.firestoreQueryConstraint = void 0;
+exports.separateConstraints = exports.replaceConstraints = exports.filterConstraintsOfType = exports.addOrReplaceLimitInConstraints = exports.endBefore = exports.FIRESTORE_END_BEFORE_QUERY_CONSTRAINT_TYPE = exports.endAt = exports.endAtValue = exports.FIRESTORE_END_AT_VALUE_QUERY_CONSTRAINT_TYPE = exports.FIRESTORE_END_AT_QUERY_CONSTRAINT_TYPE = exports.startAfter = exports.FIRESTORE_START_AFTER_QUERY_CONSTRAINT_TYPE = exports.startAtValue = exports.FIRESTORE_START_AT_VALUE_QUERY_CONSTRAINT_TYPE = exports.startAt = exports.FIRESTORE_START_AT_QUERY_CONSTRAINT_TYPE = exports.orderByDocumentId = exports.FIRESTORE_ORDER_BY_DOCUMENT_ID_QUERY_CONSTRAINT_TYPE = exports.orderBy = exports.FIRESTORE_ORDER_BY_QUERY_CONSTRAINT_TYPE = exports.where = exports.FIRESTORE_WHERE_QUERY_CONSTRAINT_TYPE = exports.offset = exports.FIRESTORE_OFFSET_QUERY_CONSTRAINT_TYPE = exports.limitToLast = exports.FIRESTORE_LIMIT_TO_LAST_QUERY_CONSTRAINT_TYPE = exports.limit = exports.FIRESTORE_LIMIT_QUERY_CONSTRAINT_TYPE = exports.firestoreQueryConstraintFactory = exports.firestoreQueryConstraint = void 0;
 const util_1 = require("@dereekb/util");
 function firestoreQueryConstraint(type, data) {
     return {
@@ -51,15 +51,27 @@ exports.where = where;
 // MARK: OrderBy
 exports.FIRESTORE_ORDER_BY_QUERY_CONSTRAINT_TYPE = 'order_by';
 function orderBy(fieldPath, directionStr) {
-    return firestoreQueryConstraint(exports.FIRESTORE_ORDER_BY_QUERY_CONSTRAINT_TYPE, { fieldPath, directionStr });
+    return firestoreQueryConstraint(exports.FIRESTORE_ORDER_BY_QUERY_CONSTRAINT_TYPE, { fieldPath: fieldPath, directionStr });
 }
 exports.orderBy = orderBy;
+// MARK: OrderBy
+exports.FIRESTORE_ORDER_BY_DOCUMENT_ID_QUERY_CONSTRAINT_TYPE = 'order_by_doc_id';
+function orderByDocumentId(directionStr) {
+    return firestoreQueryConstraint(exports.FIRESTORE_ORDER_BY_DOCUMENT_ID_QUERY_CONSTRAINT_TYPE, { directionStr });
+}
+exports.orderByDocumentId = orderByDocumentId;
 // MARK: Start At
 exports.FIRESTORE_START_AT_QUERY_CONSTRAINT_TYPE = 'start_at';
 function startAt(snapshot) {
     return firestoreQueryConstraint(exports.FIRESTORE_START_AT_QUERY_CONSTRAINT_TYPE, { snapshot });
 }
 exports.startAt = startAt;
+// MARK: Start At Value
+exports.FIRESTORE_START_AT_VALUE_QUERY_CONSTRAINT_TYPE = 'start_at_path';
+function startAtValue(...fieldValues) {
+    return firestoreQueryConstraint(exports.FIRESTORE_START_AT_VALUE_QUERY_CONSTRAINT_TYPE, { fieldValues });
+}
+exports.startAtValue = startAtValue;
 // MARK: Start After
 exports.FIRESTORE_START_AFTER_QUERY_CONSTRAINT_TYPE = 'start_after';
 function startAfter(snapshot) {
@@ -68,6 +80,12 @@ function startAfter(snapshot) {
 exports.startAfter = startAfter;
 // MARK: End At
 exports.FIRESTORE_END_AT_QUERY_CONSTRAINT_TYPE = 'end_at';
+// MARK: End At Value
+exports.FIRESTORE_END_AT_VALUE_QUERY_CONSTRAINT_TYPE = 'end_at_path';
+function endAtValue(...fieldValues) {
+    return firestoreQueryConstraint(exports.FIRESTORE_END_AT_VALUE_QUERY_CONSTRAINT_TYPE, { fieldValues });
+}
+exports.endAtValue = endAtValue;
 /**
  *
  * @param snapshot

package/src/lib/common/firestore/query/constraint.js.map

@@ -1 +1 @@
-{"version":3,"file":"constraint.js","sourceRoot":"","sources":["../../../../../../../../packages/firebase/src/lib/common/firestore/query/constraint.ts"],"names":[],"mappings":";;;AAAA,wCAAuI;AAavI,SAAgB,wBAAwB,CAAc,IAAY,EAAE,IAAO;IACzE,OAAO;QACL,IAAI;QACJ,IAAI;KACL,CAAC;AACJ,CAAC;AALD,4DAKC;AAED,SAAgB,+BAA+B,CAAC,IAAY;IAC1D,OAAO,CAAI,IAAO,EAAE,EAAE,CAAC,wBAAwB,CAAC,IAAI,EAAE,IAAI,CAAC,CAAC;AAC9D,CAAC;AAFD,0EAEC;AAED,cAAc;AACD,QAAA,qCAAqC,GAAG,OAAO,CAAC;AAM7D;;;;;GAKG;AACH,SAAgB,KAAK,CAAC,KAAa;IACjC,OAAO,wBAAwB,CAAC,6CAAqC,EAAE,EAAE,KAAK,EAAE,CAAC,CAAC;AACpF,CAAC;AAFD,sBAEC;AAED,sBAAsB;AACT,QAAA,6CAA6C,GAAG,eAAe,CAAC;AAM7E;;;;GAIG;AACH,SAAgB,WAAW,CAAC,KAAa;IACvC,OAAO,wBAAwB,CAAC,qDAA6C,EAAE,EAAE,KAAK,EAAE,CAAC,CAAC;AAC5F,CAAC;AAFD,kCAEC;AAED,eAAe;AACF,QAAA,sCAAsC,GAAG,QAAQ,CAAC;AAM/D,SAAgB,MAAM,CAAC,MAAc;IACnC,OAAO,wBAAwB,CAAC,8CAAsC,EAAE,EAAE,MAAM,EAAE,CAAC,CAAC;AACtF,CAAC;AAFD,wBAEC;AAED,cAAc;AACD,QAAA,qCAAqC,GAAG,OAAO,CAAC;AAY7D,SAAgB,KAAK,CAAC,SAAkB,EAAE,KAAoB,EAAE,KAAc;IAC5E,OAAO,wBAAwB,CAAC,6CAAqC,EAAE,EAAE,SAAS,EAAE,SAAmB,EAAE,KAAK,EAAE,KAAK,EAAE,CAAC,CAAC;AAC3H,CAAC;AAFD,sBAEC;AAED,gBAAgB;AACH,QAAA,wCAAwC,GAAG,UAAU,CAAC;AASnE,SAAgB,OAAO,CAAC,SAA6B,EAAE,YAA+B;IACpF,OAAO,wBAAwB,CAAC,gDAAwC,EAAE,EAAE,SAAS,EAAE,YAAY,EAAE,CAAC,CAAC;AACzG,CAAC;AAFD,0BAEC;AAED,iBAAiB;AACJ,QAAA,wCAAwC,GAAG,UAAU,CAAC;AAMnE,SAAgB,OAAO,CAAmB,QAA6B;IACrE,OAAO,wBAAwB,CAAC,gDAAwC,EAAE,EAAE,QAAQ,EAAE,CAAC,CAAC;AAC1F,CAAC;AAFD,0BAEC;AAED,oBAAoB;AACP,QAAA,2CAA2C,GAAG,aAAa,CAAC;AAMzE,SAAgB,UAAU,CAAmB,QAA6B;IACxE,OAAO,wBAAwB,CAAC,mDAA2C,EAAE,EAAE,QAAQ,EAAE,CAAC,CAAC;AAC7F,CAAC;AAFD,gCAEC;AAED,eAAe;AACF,QAAA,sCAAsC,GAAG,QAAQ,CAAC;AAM/D;;;;GAIG;AACH,SAAgB,KAAK,CAAmB,QAA6B;IACnE,OAAO,wBAAwB,CAAC,8CAAsC,EAAE,EAAE,QAAQ,EAAE,CAAC,CAAC;AACxF,CAAC;AAFD,sBAEC;AAED,mBAAmB;AACN,QAAA,0CAA0C,GAAG,YAAY,CAAC;AAMvE;;;;GAIG;AACH,SAAgB,SAAS,CAAmB,QAA6B;IACvE,OAAO,wBAAwB,CAAC,kDAA0C,EAAE,EAAE,QAAQ,EAAE,CAAC,CAAC;AAC5F,CAAC;AAFD,8BAEC;AAmCD,cAAc;AACd,SAAgB,8BAA8B,CAAC,KAAa,EAAE,iBAAsH,6CAAqC;IACvN,MAAM,OAAO,GAAG,kBAAkB,CAChC,CAAC,WAAW,EAAE,EAAE;QACd,IAAI,IAAkC,CAAC;QAEvC,IAAI,WAAW,CAAC,MAAM,EAAE;YACtB,IAAI,GAAG,WAAW,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC;SAC5B;aAAM;YACL,IAAI,GAAG,cAAc,CAAC;SACvB;QAED,OAAO;YACL,IAAI;YACJ,IAAI,EAAE;gBACJ,KAAK;aACuD;SAC/D,CAAC;IACJ,CAAC,EACD,CAAC,6CAAqC,EAAE,qDAA6C,CAAC,CACvF,CAAC;IAEF,OAAO,OAAO,CAAC;AACjB,CAAC;AAtBD,wEAsBC;AAID,SAAgB,uBAAuB,CAAC,GAAG,KAAqC;IAC9E,MAAM,gBAAgB,GAAG,IAAI,GAAG,CAAC,KAAK,CAAC,CAAC;IACxC,OAAO,CAAC,WAAW,EAAE,EAAE,CAAC,WAAW,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,gBAAgB,CAAC,GAAG,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC;AACnF,CAAC;AAHD,0DAGC;AAED,SAAgB,kBAAkB,CAAC,SAAqG,EAAE,KAAqC;IAC7K,MAAM,UAAU,GAAG,mBAAmB,CAAC,GAAG,KAAK,CAAC,CAAC;IAEjD,OAAO,CAAC,WAAW,EAAE,EAAE;QACrB,MAAM,SAAS,GAAG,UAAU,CAAC,WAAW,CAAC,CAAC;QAC1C,MAAM,YAAY,GAAG,IAAA,cAAO,EAAC,SAAS,CAAC,SAAS,CAAC,QAAQ,CAAC,CAAC,CAAC;QAC5D,OAAO,YAAY,CAAC,CAAC,CAAC,IAAA,iCAA0B,EAAC,SAAS,CAAC,QAAQ,EAAE,YAAY,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC,QAAQ,CAAC;IAC1G,CAAC,CAAC;AACJ,CAAC;AARD,gDAQC;AAED,SAAgB,mBAAmB,CAAC,GAAG,KAAqC;IAC1E,OAAO,CAAC,WAAW,EAAE,EAAE;QACrB,MAAM,gBAAgB,GAAG,IAAI,GAAG,CAAC,KAAK,CAAC,CAAC;QACxC,MAAM,SAAS,GAAG,IAAA,qBAAc,EAAC,WAAW,EAAE,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,gBAAgB,CAAC,GAAG,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC;QACpF,OAAO,SAAS,CAAC;IACnB,CAAC,CAAC;AACJ,CAAC;AAND,kDAMC"}
+{"version":3,"file":"constraint.js","sourceRoot":"","sources":["../../../../../../../../packages/firebase/src/lib/common/firestore/query/constraint.ts"],"names":[],"mappings":";;;AACA,wCAA8J;AAa9J,SAAgB,wBAAwB,CAAc,IAAY,EAAE,IAAO;IACzE,OAAO;QACL,IAAI;QACJ,IAAI;KACL,CAAC;AACJ,CAAC;AALD,4DAKC;AAED,SAAgB,+BAA+B,CAAC,IAAY;IAC1D,OAAO,CAAI,IAAO,EAAE,EAAE,CAAC,wBAAwB,CAAC,IAAI,EAAE,IAAI,CAAC,CAAC;AAC9D,CAAC;AAFD,0EAEC;AAED,cAAc;AACD,QAAA,qCAAqC,GAAG,OAAO,CAAC;AAM7D;;;;;GAKG;AACH,SAAgB,KAAK,CAAC,KAAa;IACjC,OAAO,wBAAwB,CAAC,6CAAqC,EAAE,EAAE,KAAK,EAAE,CAAC,CAAC;AACpF,CAAC;AAFD,sBAEC;AAED,sBAAsB;AACT,QAAA,6CAA6C,GAAG,eAAe,CAAC;AAM7E;;;;GAIG;AACH,SAAgB,WAAW,CAAC,KAAa;IACvC,OAAO,wBAAwB,CAAC,qDAA6C,EAAE,EAAE,KAAK,EAAE,CAAC,CAAC;AAC5F,CAAC;AAFD,kCAEC;AAED,eAAe;AACF,QAAA,sCAAsC,GAAG,QAAQ,CAAC;AAM/D,SAAgB,MAAM,CAAC,MAAc;IACnC,OAAO,wBAAwB,CAAC,8CAAsC,EAAE,EAAE,MAAM,EAAE,CAAC,CAAC;AACtF,CAAC;AAFD,wBAEC;AAED,cAAc;AACD,QAAA,qCAAqC,GAAG,OAAO,CAAC;AAY7D,SAAgB,KAAK,CAAC,SAAkB,EAAE,KAAoB,EAAE,KAAc;IAC5E,OAAO,wBAAwB,CAAC,6CAAqC,EAAE,EAAE,SAAS,EAAE,SAAmB,EAAE,KAAK,EAAE,KAAK,EAAE,CAAC,CAAC;AAC3H,CAAC;AAFD,sBAEC;AAED,gBAAgB;AACH,QAAA,wCAAwC,GAAG,UAAU,CAAC;AAWnE,SAAgB,OAAO,CAAa,SAA6D,EAAE,YAA+B;IAChI,OAAO,wBAAwB,CAAC,gDAAwC,EAAE,EAAE,SAAS,EAAE,SAAkC,EAAE,YAAY,EAAE,CAAC,CAAC;AAC7I,CAAC;AAFD,0BAEC;AAED,gBAAgB;AACH,QAAA,oDAAoD,GAAG,iBAAiB,CAAC;AAItF,SAAgB,iBAAiB,CAAC,YAA+B;IAC/D,OAAO,wBAAwB,CAAC,4DAAoD,EAAE,EAAE,YAAY,EAAE,CAAC,CAAC;AAC1G,CAAC;AAFD,8CAEC;AAED,iBAAiB;AACJ,QAAA,wCAAwC,GAAG,UAAU,CAAC;AAMnE,SAAgB,OAAO,CAAmB,QAA6B;IACrE,OAAO,wBAAwB,CAAC,gDAAwC,EAAE,EAAE,QAAQ,EAAE,CAAC,CAAC;AAC1F,CAAC;AAFD,0BAEC;AAED,uBAAuB;AACV,QAAA,8CAA8C,GAAG,eAAe,CAAC;AAM9E,SAAgB,YAAY,CAAC,GAAG,WAAsB;IACpD,OAAO,wBAAwB,CAAC,sDAA8C,EAAE,EAAE,WAAW,EAAE,CAAC,CAAC;AACnG,CAAC;AAFD,oCAEC;AAED,oBAAoB;AACP,QAAA,2CAA2C,GAAG,aAAa,CAAC;AAMzE,SAAgB,UAAU,CAAmB,QAA6B;IACxE,OAAO,wBAAwB,CAAC,mDAA2C,EAAE,EAAE,QAAQ,EAAE,CAAC,CAAC;AAC7F,CAAC;AAFD,gCAEC;AAED,eAAe;AACF,QAAA,sCAAsC,GAAG,QAAQ,CAAC;AAM/D,qBAAqB;AACR,QAAA,4CAA4C,GAAG,aAAa,CAAC;AAM1E,SAAgB,UAAU,CAAC,GAAG,WAAsB;IAClD,OAAO,wBAAwB,CAAC,oDAA4C,EAAE,EAAE,WAAW,EAAE,CAAC,CAAC;AACjG,CAAC;AAFD,gCAEC;AAED;;;;GAIG;AACH,SAAgB,KAAK,CAAmB,QAA6B;IACnE,OAAO,wBAAwB,CAAC,8CAAsC,EAAE,EAAE,QAAQ,EAAE,CAAC,CAAC;AACxF,CAAC;AAFD,sBAEC;AAED,mBAAmB;AACN,QAAA,0CAA0C,GAAG,YAAY,CAAC;AAMvE;;;;GAIG;AACH,SAAgB,SAAS,CAAmB,QAA6B;IACvE,OAAO,wBAAwB,CAAC,kDAA0C,EAAE,EAAE,QAAQ,EAAE,CAAC,CAAC;AAC5F,CAAC;AAFD,8BAEC;AAsCD,cAAc;AACd,SAAgB,8BAA8B,CAAC,KAAa,EAAE,iBAAsH,6CAAqC;IACvN,MAAM,OAAO,GAAG,kBAAkB,CAChC,CAAC,WAAW,EAAE,EAAE;QACd,IAAI,IAAkC,CAAC;QAEvC,IAAI,WAAW,CAAC,MAAM,EAAE;YACtB,IAAI,GAAG,WAAW,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC;SAC5B;aAAM;YACL,IAAI,GAAG,cAAc,CAAC;SACvB;QAED,OAAO;YACL,IAAI;YACJ,IAAI,EAAE;gBACJ,KAAK;aACuD;SAC/D,CAAC;IACJ,CAAC,EACD,CAAC,6CAAqC,EAAE,qDAA6C,CAAC,CACvF,CAAC;IAEF,OAAO,OAAO,CAAC;AACjB,CAAC;AAtBD,wEAsBC;AAID,SAAgB,uBAAuB,CAAC,GAAG,KAAqC;IAC9E,MAAM,gBAAgB,GAAG,IAAI,GAAG,CAAC,KAAK,CAAC,CAAC;IACxC,OAAO,CAAC,WAAW,EAAE,EAAE,CAAC,WAAW,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,gBAAgB,CAAC,GAAG,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC;AACnF,CAAC;AAHD,0DAGC;AAED,SAAgB,kBAAkB,CAAC,SAAqG,EAAE,KAAqC;IAC7K,MAAM,UAAU,GAAG,mBAAmB,CAAC,GAAG,KAAK,CAAC,CAAC;IAEjD,OAAO,CAAC,WAAW,EAAE,EAAE;QACrB,MAAM,SAAS,GAAG,UAAU,CAAC,WAAW,CAAC,CAAC;QAC1C,MAAM,YAAY,GAAG,IAAA,cAAO,EAAC,SAAS,CAAC,SAAS,CAAC,QAAQ,CAAC,CAAC,CAAC;QAC5D,OAAO,YAAY,CAAC,CAAC,CAAC,IAAA,iCAA0B,EAAC,SAAS,CAAC,QAAQ,EAAE,YAAY,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC,QAAQ,CAAC;IAC1G,CAAC,CAAC;AACJ,CAAC;AARD,gDAQC;AAED,SAAgB,mBAAmB,CAAC,GAAG,KAAqC;IAC1E,OAAO,CAAC,WAAW,EAAE,EAAE;QACrB,MAAM,gBAAgB,GAAG,IAAI,GAAG,CAAC,KAAK,CAAC,CAAC;QACxC,MAAM,SAAS,GAAG,IAAA,qBAAc,EAAC,WAAW,EAAE,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,gBAAgB,CAAC,GAAG,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC;QACpF,OAAO,SAAS,CAAC;IACnB,CAAC,CAAC;AACJ,CAAC;AAND,kDAMC"}

package/src/lib/common/firestore/query/constraint.template.d.ts

@@ -0,0 +1,16 @@
+import { DocumentReference } from '../types';
+import { FirestoreQueryConstraint } from './constraint';
+/**
+ * Use with a CollectionGroup query to return all child documents that are under a given parent.
+ *
+ * @param parentRef U
+ * @returns
+ */
+export declare function allChildDocumentsUnderParent<P>(parentRef: DocumentReference<P>): FirestoreQueryConstraint[];
+/**
+ * Use with a CollectionGroup query to return all child documents that are under a given path.
+ *
+ * @param parentPath
+ * @returns
+ */
+export declare function allChildDocumentsUnderParentPath(parentPath: string): FirestoreQueryConstraint[];

package/src/lib/common/firestore/query/constraint.template.js

@@ -0,0 +1,27 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.allChildDocumentsUnderParentPath = exports.allChildDocumentsUnderParent = void 0;
+const constraint_1 = require("./constraint");
+/**
+ * Use with a CollectionGroup query to return all child documents that are under a given parent.
+ *
+ * @param parentRef U
+ * @returns
+ */
+function allChildDocumentsUnderParent(parentRef) {
+    return allChildDocumentsUnderParentPath(parentRef.path);
+}
+exports.allChildDocumentsUnderParent = allChildDocumentsUnderParent;
+/**
+ * Use with a CollectionGroup query to return all child documents that are under a given path.
+ *
+ * @param parentPath
+ * @returns
+ */
+function allChildDocumentsUnderParentPath(parentPath) {
+    // https://medium.com/firebase-developers/how-to-query-collections-in-firestore-under-a-certain-path-6a0d686cebd2
+    // https://medium.com/firelayer/save-money-on-the-list-query-in-firestore-26ef9bee5474 for restricting
+    return [(0, constraint_1.orderByDocumentId)(), (0, constraint_1.startAtValue)(parentPath), (0, constraint_1.endAtValue)(parentPath + '\u0000')];
+}
+exports.allChildDocumentsUnderParentPath = allChildDocumentsUnderParentPath;
+//# sourceMappingURL=constraint.template.js.map

package/src/lib/common/firestore/query/constraint.template.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"constraint.template.js","sourceRoot":"","sources":["../../../../../../../../packages/firebase/src/lib/common/firestore/query/constraint.template.ts"],"names":[],"mappings":";;;AACA,6CAAqG;AAErG;;;;;GAKG;AACH,SAAgB,4BAA4B,CAAI,SAA+B;IAC7E,OAAO,gCAAgC,CAAC,SAAS,CAAC,IAAI,CAAC,CAAC;AAC1D,CAAC;AAFD,oEAEC;AAED;;;;;GAKG;AACH,SAAgB,gCAAgC,CAAC,UAAkB;IACjE,iHAAiH;IACjH,sGAAsG;IACtG,OAAO,CAAC,IAAA,8BAAiB,GAAE,EAAE,IAAA,yBAAY,EAAC,UAAU,CAAC,EAAE,IAAA,uBAAU,EAAC,UAAU,GAAG,QAAQ,CAAC,CAAC,CAAC;AAC5F,CAAC;AAJD,4EAIC"}

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

@@ -1,5 +1,6 @@
 export * from './accumulator';
 export * from './constraint';
+export * from './constraint.template';
 export * from './iterator';
 export * from './query';
 export * from './query.util';

package/src/lib/common/firestore/query/index.js

@@ -3,6 +3,7 @@ Object.defineProperty(exports, "__esModule", { value: true });
 const tslib_1 = require("tslib");
 tslib_1.__exportStar(require("./accumulator"), exports);
 tslib_1.__exportStar(require("./constraint"), exports);
+tslib_1.__exportStar(require("./constraint.template"), exports);
 tslib_1.__exportStar(require("./iterator"), exports);
 tslib_1.__exportStar(require("./query"), exports);
 tslib_1.__exportStar(require("./query.util"), exports);

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

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../../../../../packages/firebase/src/lib/common/firestore/query/index.ts"],"names":[],"mappings":";;;AAAA,wDAA8B;AAC9B,uDAA6B;AAC7B,qDAA2B;AAC3B,kDAAwB;AACxB,uDAA6B;AAC7B,oDAA0B"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../../../../../packages/firebase/src/lib/common/firestore/query/index.ts"],"names":[],"mappings":";;;AAAA,wDAA8B;AAC9B,uDAA6B;AAC7B,gEAAsC;AACtC,qDAA2B;AAC3B,kDAAwB;AACxB,uDAA6B;AAC7B,oDAA0B"}

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

@@ -1,5 +1,5 @@
 import { FirestoreContext } from './context';
-import { CollectionReference, DocumentReference, Firestore, Query } from './types';
+import { CollectionReference, DocumentReference, Firestore, Query, Transaction } from './types';
 /**
  * Contains a reference to a Query.
  */
@@ -24,3 +24,9 @@ export interface DocumentReferenceRef<T> {
 export interface FirestoreContextReference<F extends Firestore = Firestore> {
     readonly firestoreContext: FirestoreContext<F>;
 }
+/**
+ * Contains contextual information about the current Transaction, if available.
+ */
+export interface FirebaseTransactionContext {
+    readonly transaction?: Transaction;
+}

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

@@ -1,3 +1,5 @@
+import { StringKeyPropertyKeys } from '@dereekb/util';
+import { UnionToIntersection } from 'ts-essentials';
 export declare type FirebaseFirestoreLikeFirestore = {
     type: string;
 };
@@ -18,7 +20,6 @@ export declare type PartialWithFieldValue<T> = Partial<T> | (T extends Primitive
 export declare type WithFieldValue<T> = T | (T extends Primitive ? T : T extends {} ? {
     [K in keyof T]: WithFieldValue<T[K]> | FieldValue;
 } : never);
-export declare type UnionToIntersection<U> = (U extends unknown ? (k: U) => void : never) extends (k: infer I) => void ? I : never;
 export declare type AddPrefixToKeys<Prefix extends string, T extends Record<string, unknown>> = {
     [K in keyof T & string as `${Prefix}.${K}`]+?: T[K];
 };
@@ -32,6 +33,8 @@ export declare type UpdateData<T> = T extends Primitive ? T : T extends {} ? {
 export interface FieldPath {
     isEqual(other: FieldPath): boolean;
 }
+export declare type FieldPathOrStringPath = string | FieldPath;
+export declare type FieldPathOrStringPathOf<T = object> = StringKeyPropertyKeys<T> | FieldPath;
 export declare function asTopLevelFieldPaths(input: (string | FieldPath)[]): string[];
 export declare function asTopLevelFieldPath(input: string | FieldPath): string;
 export interface Timestamp {
@@ -88,13 +91,13 @@ export interface DocumentReference<T = DocumentData> {
     withConverter<U>(converter: FirestoreDataConverter<U>): DocumentReference<U>;
     withConverter(converter: null): DocumentReference<DocumentData>;
 }
-export interface CollectionReference<T = DocumentData> extends Query<T> {
+export interface CollectionReference<T = DocumentData, P = DocumentData> extends Query<T> {
     readonly type?: 'collection';
     readonly id: string;
     readonly path: string;
-    readonly parent: DocumentReference<DocumentData> | null;
-    withConverter<U>(converter: FirestoreDataConverter<U>): CollectionReference<U>;
-    withConverter(converter: null): CollectionReference<DocumentData>;
+    readonly parent: DocumentReference<P> | null;
+    withConverter<U, P = DocumentData>(converter: FirestoreDataConverter<U>): CollectionReference<U, P>;
+    withConverter<P = DocumentData>(converter: null): CollectionReference<DocumentData, P>;
 }
 export interface CollectionGroup<T = DocumentData> extends Query<T> {
     readonly type?: 'query';

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

@@ -1 +1 @@
-{"version":3,"file":"types.js","sourceRoot":"","sources":["../../../../../../../packages/firebase/src/lib/common/firestore/types.ts"],"names":[],"mappings":";AAAA,0GAA0G;AAC1G,oBAAoB;;;AAiCpB,SAAgB,oBAAoB,CAAC,KAA6B;IAChE,OAAO,KAAK,CAAC,GAAG,CAAC,mBAAmB,CAAC,CAAC;AACxC,CAAC;AAFD,oDAEC;AAED,SAAgB,mBAAmB,CAAC,KAAyB;IAC3D,IAAI,IAAY,CAAC;IAEjB,IAAI,OAAO,KAAK,KAAK,QAAQ,EAAE;QAC7B,IAAI,GAAG,KAAK,CAAC;KACd;SAAM;QACL,MAAM,QAAQ,GAAG,KAAK,CAAC,QAAQ,EAAE,CAAC;QAClC,IAAI,GAAG,QAAQ,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC;KAC/B;IAED,OAAO,IAAI,CAAC;AACd,CAAC;AAXD,kDAWC"}
+{"version":3,"file":"types.js","sourceRoot":"","sources":["../../../../../../../packages/firebase/src/lib/common/firestore/types.ts"],"names":[],"mappings":";AAAA,0GAA0G;AAC1G,oBAAoB;;;AAsCpB,SAAgB,oBAAoB,CAAC,KAA6B;IAChE,OAAO,KAAK,CAAC,GAAG,CAAC,mBAAmB,CAAC,CAAC;AACxC,CAAC;AAFD,oDAEC;AAED,SAAgB,mBAAmB,CAAC,KAAyB;IAC3D,IAAI,IAAY,CAAC;IAEjB,IAAI,OAAO,KAAK,KAAK,QAAQ,EAAE;QAC7B,IAAI,GAAG,KAAK,CAAC;KACd;SAAM;QACL,MAAM,QAAQ,GAAG,KAAK,CAAC,QAAQ,EAAE,CAAC;QAClC,IAAI,GAAG,QAAQ,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC;KAC/B;IAED,OAAO,IAAI,CAAC;AACd,CAAC;AAXD,kDAWC"}

package/src/lib/common/function/action.d.ts

@@ -1,3 +1,7 @@
 import { TransformAndValidateFunctionResult } from '@dereekb/model';
+export declare type FirebaseFunctionCreateAction<P extends object, T> = TransformAndValidateFunctionResult<P, () => Promise<T>>;
+export declare type AsyncFirebaseFunctionCreateAction<P extends object, T> = Promise<FirebaseFunctionCreateAction<P, T>>;
 export declare type FirebaseFunctionUpdateAction<P extends object, T> = TransformAndValidateFunctionResult<P, (document: T) => Promise<T>>;
 export declare type AsyncFirebaseFunctionUpdateAction<P extends object, T> = Promise<FirebaseFunctionUpdateAction<P, T>>;
+export declare type FirebaseFunctionDeleteAction<P extends object, T> = TransformAndValidateFunctionResult<P, (document: T) => Promise<void>>;
+export declare type AsyncFirebaseFunctionDeleteAction<P extends object, T> = Promise<FirebaseFunctionUpdateAction<P, T>>;

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

@@ -1,3 +1,4 @@
 export * from './auth';
 export * from './firestore';
 export * from './function';
+export * from './model';

package/src/lib/common/index.js

@@ -4,4 +4,5 @@ const tslib_1 = require("tslib");
 tslib_1.__exportStar(require("./auth"), exports);
 tslib_1.__exportStar(require("./firestore"), exports);
 tslib_1.__exportStar(require("./function"), exports);
+tslib_1.__exportStar(require("./model"), exports);
 //# sourceMappingURL=index.js.map

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

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

package/src/lib/common/model/context.d.ts

@@ -0,0 +1,16 @@
+import { FirebaseAuthContext } from '../auth/auth.context';
+import { FirebasePermissionContext, FirebasePermissionErrorContext } from './permission';
+/**
+ * A base model context that contains info about what is current occuring.
+ */
+export interface FirebaseModelContext extends FirebasePermissionContext, FirebasePermissionErrorContext, FirebaseAuthContext {
+    /**
+     * Whether or not to return all role checks for models as true if the auth context shows the current user as an admin.
+     *
+     * Is false by default.
+     */
+    readonly adminGetsAllowAllRoles?: boolean;
+}
+export interface FirebaseAppModelContext<C> extends FirebaseModelContext {
+    readonly app: C;
+}

package/src/lib/common/model/context.js

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

package/src/lib/common/model/context.js.map

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

package/src/lib/common/model/function.d.ts

@@ -0,0 +1,29 @@
+import { ArrayOrValue } from '@dereekb/util';
+import { DocumentReferenceRef } from '../firestore/reference';
+import { FirestoreModelKey, FirestoreModelNameRef } from '../firestore/collection/collection';
+export interface OnCallTypedModelParams<T = unknown> extends FirestoreModelNameRef {
+    data: T;
+}
+/**
+ * Key used on the front-end and backend that refers to a specific function for creating models.
+ */
+export declare const CREATE_MODEL_APP_FUNCTION_KEY = "createModel";
+export declare type OnCallCreateModelParams<T = unknown> = OnCallTypedModelParams<T>;
+/**
+ * Key used on the front-end and backend that refers to a specific function for updating models.
+ */
+export declare const UPDATE_MODEL_APP_FUNCTION_KEY = "updateModel";
+export declare type OnCallUpdateModelParams<T = unknown> = OnCallTypedModelParams<T>;
+/**
+ * Key used on the front-end and backend that refers to a specific function for deleting models.
+ */
+export declare const DELETE_MODEL_APP_FUNCTION_KEY = "deleteModel";
+export declare type OnCallDeleteModelParams<T = unknown> = OnCallTypedModelParams<T>;
+export interface OnCallCreateModelResult {
+    /**
+     * Key(s)/Paths of the created object(s)
+     */
+    modelKeys: ArrayOrValue<FirestoreModelKey>;
+}
+export declare function onCallCreateModelResultWithDocs(result: ArrayOrValue<DocumentReferenceRef<unknown>>): OnCallCreateModelResult;
+export declare function onCallCreateModelResult(modelKeys: ArrayOrValue<FirestoreModelKey>): OnCallCreateModelResult;

package/src/lib/common/model/function.js

@@ -0,0 +1,27 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.onCallCreateModelResult = exports.onCallCreateModelResultWithDocs = exports.DELETE_MODEL_APP_FUNCTION_KEY = exports.UPDATE_MODEL_APP_FUNCTION_KEY = exports.CREATE_MODEL_APP_FUNCTION_KEY = void 0;
+const util_1 = require("@dereekb/util");
+/**
+ * Key used on the front-end and backend that refers to a specific function for creating models.
+ */
+exports.CREATE_MODEL_APP_FUNCTION_KEY = 'createModel';
+/**
+ * Key used on the front-end and backend that refers to a specific function for updating models.
+ */
+exports.UPDATE_MODEL_APP_FUNCTION_KEY = 'updateModel';
+/**
+ * Key used on the front-end and backend that refers to a specific function for deleting models.
+ */
+exports.DELETE_MODEL_APP_FUNCTION_KEY = 'deleteModel';
+function onCallCreateModelResultWithDocs(result) {
+    return onCallCreateModelResult((0, util_1.asArray)(result).map((x) => x.documentRef.path));
+}
+exports.onCallCreateModelResultWithDocs = onCallCreateModelResultWithDocs;
+function onCallCreateModelResult(modelKeys) {
+    return {
+        modelKeys: (0, util_1.asArray)(modelKeys)
+    };
+}
+exports.onCallCreateModelResult = onCallCreateModelResult;
+//# sourceMappingURL=function.js.map

package/src/lib/common/model/function.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"function.js","sourceRoot":"","sources":["../../../../../../../packages/firebase/src/lib/common/model/function.ts"],"names":[],"mappings":";;;AAAA,wCAAsD;AAQtD;;GAEG;AACU,QAAA,6BAA6B,GAAG,aAAa,CAAC;AAI3D;;GAEG;AACU,QAAA,6BAA6B,GAAG,aAAa,CAAC;AAG3D;;GAEG;AACU,QAAA,6BAA6B,GAAG,aAAa,CAAC;AAY3D,SAAgB,+BAA+B,CAAC,MAAmD;IACjG,OAAO,uBAAuB,CAAC,IAAA,cAAO,EAAC,MAAM,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,WAAW,CAAC,IAAI,CAAC,CAAC,CAAC;AACjF,CAAC;AAFD,0EAEC;AAED,SAAgB,uBAAuB,CAAC,SAA0C;IAChF,OAAO;QACL,SAAS,EAAE,IAAA,cAAO,EAAC,SAAS,CAAC;KAC9B,CAAC;AACJ,CAAC;AAJD,0DAIC"}

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

@@ -0,0 +1,5 @@
+export * from './model';
+export * from './permission';
+export * from './context';
+export * from './function';
+export * from './model.service';

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

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

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

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../../../../packages/firebase/src/lib/common/model/index.ts"],"names":[],"mappings":";;;AAAA,kDAAwB;AACxB,uDAA6B;AAC7B,oDAA0B;AAC1B,qDAA2B;AAC3B,0DAAgC"}

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

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

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

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