@dereekb/firebase 7.1.0 → 7.4.0

package/CHANGELOG.md

@@ -2,6 +2,34 @@
 
 This file was generated using [@jscutlery/semver](https://github.com/jscutlery/semver).
 
+# [7.4.0](https://github.com/dereekb/dbx-components/compare/v7.3.0-dev...v7.4.0) (2022-06-08)
+
+
+### Features
+
+* added grantModelRolesIfFunction and related types ([5432fab](https://github.com/dereekb/dbx-components/commit/5432fab1677c29e24eac4015c35821aba2d64e10))
+* updated FirebaseServerAuthUserContext to be synchronous ([92bfd84](https://github.com/dereekb/dbx-components/commit/92bfd849b4a6d6773c616069c3085b686938ef4d))
+
+
+
+# [7.3.0](https://github.com/dereekb/dbx-components/compare/v7.2.0-dev...v7.3.0) (2022-06-08)
+
+
+### Features
+
+* added FirestoreMap, FirestoreArrayMap snapshot fields ([bd23fd3](https://github.com/dereekb/dbx-components/commit/bd23fd372e3f2180980d7aec9c1b6ee1ec2bb3c7))
+
+
+
+# [7.2.0](https://github.com/dereekb/dbx-components/compare/v7.1.0-dev...v7.2.0) (2022-06-06)
+
+
+### Features
+
+* firestoreModeIdentity can now accept a collection name ([1e0646e](https://github.com/dereekb/dbx-components/commit/1e0646e598a0834d8b4c3d264bb5ee42626e9fc7))
+
+
+
 # [7.1.0](https://github.com/dereekb/dbx-components/compare/v7.0.1-dev...v7.1.0) (2022-06-06)
 
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@dereekb/firebase",
-  "version": "7.1.0",
+  "version": "7.4.0",
   "devDependencies": {
     "@firebase/rules-unit-testing": "^2.0.0"
   },
@@ -22,19 +22,19 @@
     "rxjs": "^7.0.0",
     "rxfire": "^6.0.3",
     "firebase": "^9.8.0",
-    "@dereekb/util": "7.1.0",
+    "@dereekb/util": "7.4.0",
     "make-error": "^1.3.0",
     "ts-essentials": "^9.1.2",
     "extra-set": "^2.2.11",
-    "@dereekb/rxjs": "7.1.0",
+    "@dereekb/rxjs": "7.4.0",
     "ms": "^3.0.0-canary.1",
-    "@dereekb/date": "7.1.0",
+    "@dereekb/model": "7.4.0",
     "class-transformer": "^0.5.1",
-    "date-fns": "^2.28.0",
     "class-validator": "^0.13.2",
+    "@dereekb/date": "7.4.0",
+    "date-fns": "^2.28.0",
     "date-fns-tz": "^1.3.0",
     "rrule": "git+https://git@github.com/dereekb/rrule.git#17adf5708d6567b4d01a3a8afd106261421ea492",
-    "@dereekb/model": "7.1.0",
     "tslib": "^2.0.0"
   }
 }

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

@@ -1,4 +1,4 @@
-import { AuthClaims, AuthRoleSet, Maybe } from '@dereekb/util';
+import { AuthClaims, AuthClaimsObject, AuthRoleSet, Maybe } from '@dereekb/util';
 import { FirebaseAuthToken } from './auth';
 /**
  * Provides a context containing FirebaseAuthContextInfo
@@ -17,14 +17,26 @@ export interface FirebaseAuthContextInfo {
     /**
      * Returns true if the user is considered a system admin.
      */
-    isAdmin?(): boolean;
+    isAdmin(): boolean;
     /**
      * Retrieves the claims in the context.
      */
-    loadClaims(): Promise<AuthClaims>;
+    getClaims<T extends AuthClaimsObject = AuthClaimsObject>(): AuthClaims<T>;
     /**
      * The auth roles provided by the token in this context.
      */
+    getAuthRoles(): AuthRoleSet;
+    /**
+     * Retrieves the claims in the context.
+     *
+     * @deprecated Claims are now available synchronously.
+     */
+    loadClaims<T extends AuthClaimsObject = AuthClaimsObject>(): Promise<AuthClaims<T>>;
+    /**
+     * The auth roles provided by the token in this context.
+     *
+     * @deprecated Auth role set is now available synchronously.
+     */
     loadAuthRoles(): Promise<AuthRoleSet>;
     /**
      * The token in the context.

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

@@ -17,18 +17,17 @@ export declare type FirestoreModelName = ModelTypeString;
  * 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> = {
+export declare type FirestoreModelIdentity<M extends FirestoreModelName = FirestoreModelName, C extends FirestoreCollectionName = FirestoreCollectionName> = {
     readonly model: M;
-    readonly collection: FirestoreModelCollectionName<M>;
+    readonly collection: C;
 };
-export declare type FirestoreCollectionNames<I extends FirestoreModelIdentity> = I extends FirestoreModelIdentity<infer M> ? FirestoreModelCollectionName<M> : never;
+/**
+ * A default collection name derived from the model name.
+ */
+export declare type FirestoreModelDefaultCollectionName<M extends FirestoreModelName> = `${Lowercase<M>}`;
 export declare type FirestoreModelNames<I extends FirestoreModelIdentity> = I extends FirestoreModelIdentity<infer M> ? M : never;
 /**
  * Creates a FirestoreModelIdentity value.
@@ -36,7 +35,8 @@ export declare type FirestoreModelNames<I extends FirestoreModelIdentity> = I ex
  * @param modelName
  * @returns
  */
-export declare function firestoreModelIdentity<M extends FirestoreModelName>(modelName: M): FirestoreModelIdentity<M>;
+export declare function firestoreModelIdentity<M extends FirestoreModelName>(modelName: M): FirestoreModelIdentity<M, FirestoreModelDefaultCollectionName<M>>;
+export declare function firestoreModelIdentity<M extends FirestoreModelName, C extends FirestoreCollectionName = FirestoreCollectionName>(modelName: M, collectionName: C): FirestoreModelIdentity<M, C>;
 /**
  * Reference to a FirestoreCollectionName
  */

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

@@ -5,15 +5,9 @@ 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) {
+function firestoreModelIdentity(modelName, collectionName) {
     return {
-        collection: modelName.toLowerCase(),
+        collection: collectionName !== null && collectionName !== void 0 ? collectionName : modelName.toLowerCase(),
         model: modelName
     };
 }

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;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"}
+{"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;AAwCtG,SAAgB,sBAAsB,CAA4F,SAAY,EAAE,cAAkB;IAChK,OAAO;QACL,UAAU,EAAE,cAAc,aAAd,cAAc,cAAd,cAAc,GAAK,SAAS,CAAC,WAAW,EAAQ;QAC5D,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/collection/collection.key.d.ts

@@ -0,0 +1,53 @@
+import { GrantedRole } from '@dereekb/model';
+import { FirebaseAuthUserId } from '../../auth';
+import { FirestoreModelId, FirestoreModelKey } from './collection';
+export declare type FirestoreModelKeyMap<T> = {
+    [key: FirestoreModelKey]: T;
+};
+/**
+ * Array of FirestoreModelKey values.
+ */
+export declare type FirestoreModelKeyArray = FirestoreModelKey[];
+/**
+ * A map with a single GrantedRole provided for a given model.
+ */
+export declare type FirestoreModelKeyGrantedRoleMap<R extends GrantedRole> = {
+    [key: FirestoreModelKey]: R;
+};
+/**
+ * A map with multiple GrantedRoles provided for a given model.
+ */
+export declare type FirestoreModelKeyGrantedRoleArrayMap<R extends GrantedRole> = {
+    [key: FirestoreModelKey]: R[];
+};
+export declare type FirestoreModelIdMap<T> = {
+    [key: FirestoreModelId]: T;
+};
+/**
+ * Array of FirestoreModelId values.
+ */
+export declare type FirestoreModelIdArray = FirestoreModelId[];
+/**
+ * A map with a single GrantedRole provided for a given model.
+ */
+export declare type FirestoreModelIdGrantedRoleMap<R extends GrantedRole> = {
+    [key: FirestoreModelId]: R;
+};
+/**
+ * A map with multiple GrantedRoles provided for a given model.
+ */
+export declare type FirestoreModelIdGrantedRoleArrayMap<R extends GrantedRole> = {
+    [key: FirestoreModelId]: R[];
+};
+/**
+ * A map with a single GrantedRole provided for a given user.
+ */
+export declare type FirebaseAuthUserGrantedRoleMap<R extends GrantedRole> = {
+    [key: FirebaseAuthUserId]: R;
+};
+/**
+ * A map with multiple GrantedRoles provided for a given user.
+ */
+export declare type FirebaseAuthUserRoleArrayMap<R extends GrantedRole> = {
+    [key: FirestoreModelKey]: R[];
+};

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

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

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

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

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

@@ -1,4 +1,5 @@
 export * from './collection';
+export * from './collection.key';
 export * from './collection.group';
 export * from './subcollection';
 export * from './subcollection.single';

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

@@ -2,6 +2,7 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 const tslib_1 = require("tslib");
 tslib_1.__exportStar(require("./collection"), exports);
+tslib_1.__exportStar(require("./collection.key"), exports);
 tslib_1.__exportStar(require("./collection.group"), exports);
 tslib_1.__exportStar(require("./subcollection"), exports);
 tslib_1.__exportStar(require("./subcollection.single"), exports);

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

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../../../../../packages/firebase/src/lib/common/firestore/collection/index.ts"],"names":[],"mappings":";;;AAAA,uDAA6B;AAC7B,6DAAmC;AACnC,0DAAgC;AAChC,iEAAuC"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../../../../../packages/firebase/src/lib/common/firestore/collection/index.ts"],"names":[],"mappings":";;;AAAA,uDAA6B;AAC7B,2DAAiC;AACjC,6DAAmC;AACnC,0DAAgC;AAChC,iEAAuC"}

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

@@ -47,8 +47,7 @@ export interface WhereQueryConstraintData {
 export declare function where<T>(fieldPath: keyof T, opStr: WhereFilterOp, value: unknown): FirestoreQueryConstraint<WhereQueryConstraintData>;
 export declare function where(fieldPath: string | FieldPath, opStr: WhereFilterOp, value: unknown): FirestoreQueryConstraint<WhereQueryConstraintData>;
 export declare const FIRESTORE_WHERE_DOCUMENT_ID_QUERY_CONSTRAINT_TYPE = "where_doc_id";
-export interface WhereDocumentIdQueryConstraintData extends Omit<WhereQueryConstraintData, 'fieldPath'> {
-}
+export declare type WhereDocumentIdQueryConstraintData = Omit<WhereQueryConstraintData, 'fieldPath'>;
 export declare function whereDocumentId(opStr: WhereFilterOp, value: unknown): FirestoreQueryConstraint<WhereDocumentIdQueryConstraintData>;
 export declare const FIRESTORE_ORDER_BY_QUERY_CONSTRAINT_TYPE = "order_by";
 export declare type OrderByDirection = SortingOrder;

package/src/lib/common/firestore/snapshot/snapshot.field.d.ts

@@ -1,4 +1,5 @@
-import { ModelFieldMapFunctionsConfig, GetterOrValue, Maybe, ModelFieldMapConvertFunction, PrimativeKey, ReadKeyFunction, ModelFieldMapFunctionsWithDefaultsConfig, FindUniqueFunction, FindUniqueStringsTransformConfig, MapFunction } from '@dereekb/util';
+import { GrantedRole } from '@dereekb/model';
+import { ModelFieldMapFunctionsConfig, GetterOrValue, Maybe, ModelFieldMapConvertFunction, PrimativeKey, ReadKeyFunction, ModelFieldMapFunctionsWithDefaultsConfig, FindUniqueFunction, FindUniqueStringsTransformConfig, MapFunction, FilterKeyValueTuplesInput, ModelKey } from '@dereekb/util';
 export interface BaseFirestoreFieldConfig<V, D = unknown> {
     fromData: ModelFieldMapConvertFunction<D, V>;
     toData: ModelFieldMapConvertFunction<V, D>;
@@ -33,6 +34,8 @@ export declare function firestoreString(config?: FirestoreStringConfig): Firesto
 export declare function optionalFirestoreString(): ModelFieldMapFunctionsConfig<Maybe<string>, Maybe<string>>;
 export declare function firestoreUID(): FirestoreModelFieldMapFunctionsConfig<string, string>;
 export declare function optionalFirestoreUID(): ModelFieldMapFunctionsConfig<Maybe<string>, Maybe<string>>;
+export declare const firestoreModelKey: FirestoreModelFieldMapFunctionsConfig<string, string>;
+export declare const firestoreModelId: FirestoreModelFieldMapFunctionsConfig<string, string>;
 export declare type FirestoreDateFieldConfig = DefaultMapConfiguredFirestoreFieldConfig<Date, string> & {
     saveDefaultAsNow?: boolean;
 };
@@ -57,6 +60,18 @@ export declare type FirestoreUniqueKeyedArrayFieldConfig<T, K extends PrimativeK
 export declare function firestoreUniqueKeyedArray<T, K extends PrimativeKey = PrimativeKey>(config: FirestoreUniqueKeyedArrayFieldConfig<T, K>): FirestoreModelFieldMapFunctionsConfig<T[], T[]>;
 export declare type FirestoreUniqueStringArrayFieldConfig = Omit<FirestoreUniqueArrayFieldConfig<string>, 'findUnique'> & FindUniqueStringsTransformConfig;
 export declare function firestoreUniqueStringArray(config: FirestoreUniqueStringArrayFieldConfig): FirestoreModelFieldMapFunctionsConfig<string[], string[]>;
+/**
+ * FirestoreField configuration for an array of ModelKey values.
+ *
+ * @returns
+ */
+export declare function firestoreModelKeyArray(): FirestoreModelFieldMapFunctionsConfig<string[], string[]>;
+/**
+ * FirestoreField configuration for an array of ModelId values.
+ *
+ * @returns
+ */
+export declare const firestoreModelIdArray: typeof firestoreModelKeyArray;
 export declare type FirestoreEncodedArrayFieldConfig<T, E extends string | number> = DefaultMapConfiguredFirestoreFieldConfig<T[], E[]> & {
     readonly convert: {
         fromData: MapFunction<E, T>;
@@ -70,6 +85,64 @@ export declare type FirestoreEncodedArrayFieldConfig<T, E extends string | numbe
  * @returns
  */
 export declare function firestoreEncodedArray<T, E extends string | number>(config: FirestoreEncodedArrayFieldConfig<T, E>): FirestoreModelFieldMapFunctionsConfig<T[], E[]>;
+/**
+ * Firestore/JSON maps only have string keys.
+ */
+export declare type FirestoreMapFieldType<T, K extends string = string> = Record<K, T>;
+export declare type FirestoreMapFieldConfig<T, K extends string = string> = DefaultMapConfiguredFirestoreFieldConfig<FirestoreMapFieldType<T, K>, FirestoreMapFieldType<T, K>> & Partial<FirestoreFieldDefault<FirestoreMapFieldType<T, K>>> & {
+    /**
+     * Optional filter to apply when saving to data.
+     *
+     * By default will filter all null/undefined values from maps.
+     */
+    mapFilter?: FilterKeyValueTuplesInput<FirestoreMapFieldType<K>>;
+    /**
+     * Optional map function to apply to each input value before
+     */
+    mapFieldValues?: MapFunction<Maybe<T>, Maybe<T>>;
+};
+/**
+ * FirestoreField configuration for a map-type object.
+ *
+ * By default it will remove all null/undefined keys from objects before saving.
+ *
+ * @param config
+ * @returns
+ */
+export declare function firestoreMap<T, K extends string = string>(config?: FirestoreMapFieldConfig<T, K>): FirestoreModelFieldMapFunctionsConfig<FirestoreMapFieldType<T, K>, FirestoreMapFieldType<T, K>>;
+/**
+ * FirestoreField configuration for a map of granted roles, keyed by model keys.
+ *
+ * Filters out models with no/null roles by default.
+ */
+export declare function firestoreModelKeyGrantedRoleMap<R extends GrantedRole>(): FirestoreModelFieldMapFunctionsConfig<FirestoreMapFieldType<R, string>, FirestoreMapFieldType<R, string>>;
+/**
+ * FirestoreField configuration for a map of granted roles, keyed by model ids.
+ *
+ * Filters out models with no/null roles by default.
+ */
+export declare const firestoreModelIdGrantedRoleMap: () => FirestoreModelFieldMapFunctionsConfig<FirestoreMapFieldType<ModelKey, string>, FirestoreMapFieldType<ModelKey, string>>;
+/**
+ * FirestoreField configuration for a map-type object with array values.
+ *
+ * @param config
+ * @returns
+ */
+export declare type FirestoreArrayMapFieldType<T, K extends string = string> = FirestoreMapFieldType<T[], K>;
+export declare type FirestoreArrayMapFieldConfig<T, K extends string = string> = FirestoreMapFieldConfig<T[], K>;
+export declare function firestoreArrayMap<T, K extends string = string>(config?: FirestoreArrayMapFieldConfig<T, K>): FirestoreModelFieldMapFunctionsConfig<FirestoreMapFieldType<T[], K>, FirestoreMapFieldType<T[], K>>;
+/**
+ * FirestoreField configuration for a map of granted roles, keyed by models keys.
+ *
+ * Filters empty roles/arrays by default.
+ */
+export declare function firestoreModelKeyGrantedRoleArrayMap<R extends GrantedRole>(): FirestoreModelFieldMapFunctionsConfig<FirestoreMapFieldType<R[], string>, FirestoreMapFieldType<R[], string>>;
+/**
+ * FirestoreField configuration for a map of granted roles, keyed by models ids.
+ *
+ * Filters empty roles/arrays by default.
+ */
+export declare const firestoreModelIdGrantedRoleArrayMap: () => FirestoreModelFieldMapFunctionsConfig<FirestoreMapFieldType<ModelKey[], string>, FirestoreMapFieldType<ModelKey[], string>>;
 export declare type FirestoreSetFieldConfig<T extends string | number> = DefaultMapConfiguredFirestoreFieldConfig<Set<T>, T[]>;
 /**
  * Do not use.

package/src/lib/common/firestore/snapshot/snapshot.field.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.firestoreSet = exports.firestoreEncodedArray = exports.firestoreUniqueStringArray = exports.firestoreUniqueKeyedArray = exports.firestoreUniqueArray = exports.optionalFirestoreArray = exports.firestoreArray = exports.optionalFirestoreNumber = exports.firestoreNumber = exports.optionalFirestoreBoolean = exports.firestoreBoolean = exports.optionalFirestoreDate = exports.firestoreDate = exports.optionalFirestoreUID = exports.firestoreUID = exports.optionalFirestoreString = exports.firestoreString = exports.firestorePassThroughField = exports.FIRESTORE_PASSTHROUGH_FIELD = exports.firestoreField = void 0;
+exports.firestoreSet = exports.firestoreModelIdGrantedRoleArrayMap = exports.firestoreModelKeyGrantedRoleArrayMap = exports.firestoreArrayMap = exports.firestoreModelIdGrantedRoleMap = exports.firestoreModelKeyGrantedRoleMap = exports.firestoreMap = exports.firestoreEncodedArray = exports.firestoreModelIdArray = exports.firestoreModelKeyArray = exports.firestoreUniqueStringArray = exports.firestoreUniqueKeyedArray = exports.firestoreUniqueArray = exports.optionalFirestoreArray = exports.firestoreArray = exports.optionalFirestoreNumber = exports.firestoreNumber = exports.optionalFirestoreBoolean = exports.firestoreBoolean = exports.optionalFirestoreDate = exports.firestoreDate = exports.firestoreModelId = exports.firestoreModelKey = exports.optionalFirestoreUID = exports.firestoreUID = exports.optionalFirestoreString = exports.firestoreString = exports.firestorePassThroughField = exports.FIRESTORE_PASSTHROUGH_FIELD = exports.firestoreField = void 0;
 const date_1 = require("@dereekb/date");
 const util_1 = require("@dereekb/util");
 const snapshot_1 = require("./snapshot");
@@ -50,6 +50,8 @@ function optionalFirestoreUID() {
     return optionalFirestoreString();
 }
 exports.optionalFirestoreUID = optionalFirestoreUID;
+exports.firestoreModelKey = firestoreString();
+exports.firestoreModelId = firestoreString();
 function firestoreDate(config = {}) {
     var _a, _b;
     return firestoreField({
@@ -124,6 +126,22 @@ function firestoreUniqueStringArray(config) {
     return firestoreUniqueArray(Object.assign(Object.assign({}, config), { findUnique }));
 }
 exports.firestoreUniqueStringArray = firestoreUniqueStringArray;
+/**
+ * FirestoreField configuration for an array of ModelKey values.
+ *
+ * @returns
+ */
+function firestoreModelKeyArray() {
+    // firestore model key paths are case-sensitive, so don't transform them.
+    return firestoreUniqueStringArray({});
+}
+exports.firestoreModelKeyArray = firestoreModelKeyArray;
+/**
+ * FirestoreField configuration for an array of ModelId values.
+ *
+ * @returns
+ */
+exports.firestoreModelIdArray = firestoreModelKeyArray;
 /**
  * A Firestore array that encodes values to either string or number values using another FirestoreModelField config for encoding/decoding.
  *
@@ -140,6 +158,70 @@ function firestoreEncodedArray(config) {
     });
 }
 exports.firestoreEncodedArray = firestoreEncodedArray;
+/**
+ * FirestoreField configuration for a map-type object.
+ *
+ * By default it will remove all null/undefined keys from objects before saving.
+ *
+ * @param config
+ * @returns
+ */
+function firestoreMap(config = {}) {
+    var _a;
+    const { mapFilter: filter = util_1.KeyValueTypleValueFilter.NULL, mapFieldValues } = config;
+    const filterFinalMapValuesFn = (0, util_1.filterFromPOJOFunction)({
+        copy: false,
+        filter
+    });
+    const makeCopy = (mapFieldValues ? (0, util_1.mapObjectMapFunction)(mapFieldValues) : util_1.copyObject);
+    return firestoreField({
+        default: (_a = config.default) !== null && _a !== void 0 ? _a : {},
+        fromData: util_1.passThrough,
+        toData: (model) => {
+            const copy = makeCopy(model);
+            return filterFinalMapValuesFn(copy);
+        }
+    });
+}
+exports.firestoreMap = firestoreMap;
+/**
+ * FirestoreField configuration for a map of granted roles, keyed by model keys.
+ *
+ * Filters out models with no/null roles by default.
+ */
+function firestoreModelKeyGrantedRoleMap() {
+    return firestoreMap({
+        mapFilter: util_1.KeyValueTypleValueFilter.EMPTY
+    });
+}
+exports.firestoreModelKeyGrantedRoleMap = firestoreModelKeyGrantedRoleMap;
+/**
+ * FirestoreField configuration for a map of granted roles, keyed by model ids.
+ *
+ * Filters out models with no/null roles by default.
+ */
+exports.firestoreModelIdGrantedRoleMap = firestoreModelKeyGrantedRoleMap;
+function firestoreArrayMap(config = {}) {
+    return firestoreMap(Object.assign({ mapFilter: util_1.KeyValueTypleValueFilter.EMPTY, mapFieldValues: util_1.filterMaybeValues }, config));
+}
+exports.firestoreArrayMap = firestoreArrayMap;
+/**
+ * FirestoreField configuration for a map of granted roles, keyed by models keys.
+ *
+ * Filters empty roles/arrays by default.
+ */
+function firestoreModelKeyGrantedRoleArrayMap() {
+    return firestoreArrayMap({
+        mapFieldValues: util_1.filterEmptyValues
+    });
+}
+exports.firestoreModelKeyGrantedRoleArrayMap = firestoreModelKeyGrantedRoleArrayMap;
+/**
+ * FirestoreField configuration for a map of granted roles, keyed by models ids.
+ *
+ * Filters empty roles/arrays by default.
+ */
+exports.firestoreModelIdGrantedRoleArrayMap = firestoreModelKeyGrantedRoleArrayMap;
 /**
  * Do not use.
  *

package/src/lib/common/firestore/snapshot/snapshot.field.js.map

@@ -1 +1 @@
-{"version":3,"file":"snapshot.field.js","sourceRoot":"","sources":["../../../../../../../../packages/firebase/src/lib/common/firestore/snapshot/snapshot.field.ts"],"names":[],"mappings":";;;AAAA,wCAA4E;AAC5E,wCAAyY;AACzY,yCAAmD;AA4BnD,SAAgB,cAAc,CAAiB,MAAkC;;IAC/E,OAAO;QACL,IAAI,EAAG,MAAgD,CAAC,OAAO;YAC7D,CAAC,CAAC;gBACE,OAAO,EAAG,MAAgD,CAAC,OAAO;gBAClE,OAAO,EAAE,MAAM,CAAC,QAAQ;aACzB;YACH,CAAC,CAAC;gBACE,YAAY,EAAG,MAAoD,CAAC,WAAW;gBAC/E,OAAO,EAAE,MAAM,CAAC,QAAQ;aACzB;QACL,EAAE,EAAE;YACF,OAAO,EAAE,CAAC,MAAA,MAAM,CAAC,iBAAiB,mCAAI,gCAAqB,CAAqB;YAChF,OAAO,EAAE,MAAM,CAAC,MAAM;SACvB;KAC6C,CAAC;AACnD,CAAC;AAhBD,wCAgBC;AAEY,QAAA,2BAA2B,GAAG,cAAc,CAAmB;IAC1E,OAAO,EAAE,IAAI;IACb,QAAQ,EAAE,kBAAW;IACrB,MAAM,EAAE,kBAAW;CACpB,CAAC,CAAC;AAEH,SAAgB,yBAAyB;IACvC,OAAO,mCAAiE,CAAC;AAC3E,CAAC;AAFD,8DAEC;AAWD,SAAgB,eAAe,CAAC,MAA8B;IAC5D,OAAO,cAAc,+BACnB,OAAO,EAAE,EAAE,IACR,MAAM,KACT,QAAQ,EAAE,kBAAW,EACrB,MAAM,EAAE,kBAAW,IACnB,CAAC;AACL,CAAC;AAPD,0CAOC;AAED,SAAgB,uBAAuB;IACrC,OAAO,yBAAyB,EAAiB,CAAC;AACpD,CAAC;AAFD,0DAEC;AAED,SAAgB,YAAY;IAC1B,OAAO,eAAe,CAAC;QACrB,OAAO,EAAE,EAAE;KACZ,CAAC,CAAC;AACL,CAAC;AAJD,oCAIC;AAED,SAAgB,oBAAoB;IAClC,OAAO,uBAAuB,EAAE,CAAC;AACnC,CAAC;AAFD,oDAEC;AAMD,SAAgB,aAAa,CAAC,SAAmC,EAAE;;IACjE,OAAO,cAAc,CAAe;QAClC,OAAO,EAAE,MAAA,MAAM,CAAC,OAAO,mCAAI,CAAC,GAAG,EAAE,CAAC,IAAI,IAAI,EAAE,CAAC;QAC7C,iBAAiB,EAAE,MAAA,MAAM,CAAC,iBAAiB,mCAAI,CAAC,MAAM,CAAC,gBAAgB,CAAC,CAAC,CAAC,uBAAgB,CAAC,CAAC,CAAC,IAAI,CAAC;QAClG,QAAQ,EAAE,CAAC,KAAa,EAAE,EAAE,CAAC,IAAA,eAAQ,EAAC,KAAK,CAAC;QAC5C,MAAM,EAAE,CAAC,KAAW,EAAE,EAAE,CAAC,IAAA,sBAAe,EAAC,KAAK,CAAC;KAChD,CAAC,CAAC;AACL,CAAC;AAPD,sCAOC;AAED,SAAgB,qBAAqB;IACnC,OAAO,cAAc,CAA6B;QAChD,OAAO,EAAE,IAAI;QACb,QAAQ,EAAE,CAAC,KAAa,EAAE,EAAE,CAAC,IAAA,eAAQ,EAAC,KAAK,CAAC;QAC5C,MAAM,EAAE,CAAC,KAAW,EAAE,EAAE,CAAC,IAAA,sBAAe,EAAC,KAAK,CAAC;KAChD,CAAC,CAAC;AACL,CAAC;AAND,sDAMC;AAID,SAAgB,gBAAgB,CAAC,MAAmC;IAClE,OAAO,cAAc,CAAmB;QACtC,OAAO,EAAE,MAAM,CAAC,OAAO;QACvB,QAAQ,EAAE,kBAAW;QACrB,MAAM,EAAE,kBAAW;KACpB,CAAC,CAAC;AACL,CAAC;AAND,4CAMC;AAED,SAAgB,wBAAwB;IACtC,OAAO,yBAAyB,EAAkB,CAAC;AACrD,CAAC;AAFD,4DAEC;AAID,SAAgB,eAAe,CAAC,MAAkC;IAChE,OAAO,cAAc,CAAiB;QACpC,OAAO,EAAE,MAAM,CAAC,OAAO;QACvB,QAAQ,EAAE,kBAAW;QACrB,MAAM,EAAE,kBAAW;KACpB,CAAC,CAAC;AACL,CAAC;AAND,0CAMC;AAED,SAAgB,uBAAuB;IACrC,OAAO,yBAAyB,EAAiB,CAAC;AACpD,CAAC;AAFD,0DAEC;AAID,SAAgB,cAAc,CAAI,MAAoC;;IACpE,OAAO,cAAc,CAAW;QAC9B,OAAO,EAAE,MAAA,MAAM,CAAC,OAAO,mCAAI,EAAE;QAC7B,QAAQ,EAAE,kBAAW;QACrB,MAAM,EAAE,kBAAW;KACpB,CAAC,CAAC;AACL,CAAC;AAND,wCAMC;AAED,SAAgB,sBAAsB;IACpC,OAAO,yBAAyB,EAAc,CAAC;AACjD,CAAC;AAFD,wDAEC;AAMD,SAAgB,oBAAoB,CAAI,MAA0C;;IAChF,MAAM,EAAE,UAAU,EAAE,GAAG,MAAM,CAAC;IAC9B,OAAO,cAAc,CAAW;QAC9B,OAAO,EAAE,MAAA,MAAM,CAAC,OAAO,mCAAI,EAAE;QAC7B,QAAQ,EAAE,UAAU;QACpB,MAAM,EAAE,UAAU;KACnB,CAAC,CAAC;AACL,CAAC;AAPD,oDAOC;AAMD,SAAgB,yBAAyB,CAA2C,MAAkD;IACpI,OAAO,oBAAoB,iCACtB,MAAM,KACT,UAAU,EAAE,IAAA,6BAAsB,EAAO,MAAM,CAAC,OAAO,CAAC,IACxD,CAAC;AACL,CAAC;AALD,8DAKC;AAID,SAAgB,0BAA0B,CAAC,MAA6C;IACtF,MAAM,UAAU,GAAG,IAAA,0BAAmB,EAAC,MAAM,CAAC,CAAC;IAC/C,OAAO,oBAAoB,iCACtB,MAAM,KACT,UAAU,IACV,CAAC;AACL,CAAC;AAND,gEAMC;AASD;;;;;GAKG;AACH,SAAgB,qBAAqB,CAA+B,MAA8C;;IAChH,MAAM,EAAE,QAAQ,EAAE,MAAM,EAAE,GAAG,MAAM,CAAC,OAAO,CAAC;IAC5C,OAAO,cAAc,CAAW;QAC9B,OAAO,EAAE,MAAA,MAAM,CAAC,OAAO,mCAAI,EAAE;QAC7B,QAAQ,EAAE,CAAC,KAAU,EAAE,EAAE,CAAE,KAAsB,CAAC,GAAG,CAAC,QAAQ,CAAC;QAC/D,MAAM,EAAE,CAAC,KAAU,EAAE,EAAE,CAAC,IAAA,wBAAiB,EAAE,KAAsB,CAAC,GAAG,CAAC,MAAM,CAAC,CAAC;KAC/E,CAAC,CAAC;AACL,CAAC;AAPD,sDAOC;AAKD;;;;;;;GAOG;AACH,SAAgB,YAAY,CAA4B,MAAkC;;IACxF,OAAO,cAAc,CAAc;QACjC,OAAO,EAAE,MAAA,MAAM,CAAC,OAAO,mCAAI,CAAC,GAAG,EAAE,CAAC,IAAI,GAAG,EAAE,CAAC;QAC5C,QAAQ,EAAE,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,GAAG,CAAC,IAAI,CAAC;QACjC,MAAM,EAAE,CAAC,GAAG,EAAE,EAAE,CAAC,KAAK,CAAC,IAAI,CAAC,GAAG,CAAC;KACjC,CAAC,CAAC;AACL,CAAC;AAND,oCAMC"}
+{"version":3,"file":"snapshot.field.js","sourceRoot":"","sources":["../../../../../../../../packages/firebase/src/lib/common/firestore/snapshot/snapshot.field.ts"],"names":[],"mappings":";;;AAEA,wCAA4E;AAC5E,wCAAmf;AACnf,yCAAmD;AA4BnD,SAAgB,cAAc,CAAiB,MAAkC;;IAC/E,OAAO;QACL,IAAI,EAAG,MAAgD,CAAC,OAAO;YAC7D,CAAC,CAAC;gBACE,OAAO,EAAG,MAAgD,CAAC,OAAO;gBAClE,OAAO,EAAE,MAAM,CAAC,QAAQ;aACzB;YACH,CAAC,CAAC;gBACE,YAAY,EAAG,MAAoD,CAAC,WAAW;gBAC/E,OAAO,EAAE,MAAM,CAAC,QAAQ;aACzB;QACL,EAAE,EAAE;YACF,OAAO,EAAE,CAAC,MAAA,MAAM,CAAC,iBAAiB,mCAAI,gCAAqB,CAAqB;YAChF,OAAO,EAAE,MAAM,CAAC,MAAM;SACvB;KAC6C,CAAC;AACnD,CAAC;AAhBD,wCAgBC;AAEY,QAAA,2BAA2B,GAAG,cAAc,CAAmB;IAC1E,OAAO,EAAE,IAAI;IACb,QAAQ,EAAE,kBAAW;IACrB,MAAM,EAAE,kBAAW;CACpB,CAAC,CAAC;AAEH,SAAgB,yBAAyB;IACvC,OAAO,mCAAiE,CAAC;AAC3E,CAAC;AAFD,8DAEC;AAWD,SAAgB,eAAe,CAAC,MAA8B;IAC5D,OAAO,cAAc,+BACnB,OAAO,EAAE,EAAE,IACR,MAAM,KACT,QAAQ,EAAE,kBAAW,EACrB,MAAM,EAAE,kBAAW,IACnB,CAAC;AACL,CAAC;AAPD,0CAOC;AAED,SAAgB,uBAAuB;IACrC,OAAO,yBAAyB,EAAiB,CAAC;AACpD,CAAC;AAFD,0DAEC;AAED,SAAgB,YAAY;IAC1B,OAAO,eAAe,CAAC;QACrB,OAAO,EAAE,EAAE;KACZ,CAAC,CAAC;AACL,CAAC;AAJD,oCAIC;AAED,SAAgB,oBAAoB;IAClC,OAAO,uBAAuB,EAAE,CAAC;AACnC,CAAC;AAFD,oDAEC;AAEY,QAAA,iBAAiB,GAAG,eAAe,EAAE,CAAC;AACtC,QAAA,gBAAgB,GAAG,eAAe,EAAE,CAAC;AAMlD,SAAgB,aAAa,CAAC,SAAmC,EAAE;;IACjE,OAAO,cAAc,CAAe;QAClC,OAAO,EAAE,MAAA,MAAM,CAAC,OAAO,mCAAI,CAAC,GAAG,EAAE,CAAC,IAAI,IAAI,EAAE,CAAC;QAC7C,iBAAiB,EAAE,MAAA,MAAM,CAAC,iBAAiB,mCAAI,CAAC,MAAM,CAAC,gBAAgB,CAAC,CAAC,CAAC,uBAAgB,CAAC,CAAC,CAAC,IAAI,CAAC;QAClG,QAAQ,EAAE,CAAC,KAAa,EAAE,EAAE,CAAC,IAAA,eAAQ,EAAC,KAAK,CAAC;QAC5C,MAAM,EAAE,CAAC,KAAW,EAAE,EAAE,CAAC,IAAA,sBAAe,EAAC,KAAK,CAAC;KAChD,CAAC,CAAC;AACL,CAAC;AAPD,sCAOC;AAED,SAAgB,qBAAqB;IACnC,OAAO,cAAc,CAA6B;QAChD,OAAO,EAAE,IAAI;QACb,QAAQ,EAAE,CAAC,KAAa,EAAE,EAAE,CAAC,IAAA,eAAQ,EAAC,KAAK,CAAC;QAC5C,MAAM,EAAE,CAAC,KAAW,EAAE,EAAE,CAAC,IAAA,sBAAe,EAAC,KAAK,CAAC;KAChD,CAAC,CAAC;AACL,CAAC;AAND,sDAMC;AAID,SAAgB,gBAAgB,CAAC,MAAmC;IAClE,OAAO,cAAc,CAAmB;QACtC,OAAO,EAAE,MAAM,CAAC,OAAO;QACvB,QAAQ,EAAE,kBAAW;QACrB,MAAM,EAAE,kBAAW;KACpB,CAAC,CAAC;AACL,CAAC;AAND,4CAMC;AAED,SAAgB,wBAAwB;IACtC,OAAO,yBAAyB,EAAkB,CAAC;AACrD,CAAC;AAFD,4DAEC;AAID,SAAgB,eAAe,CAAC,MAAkC;IAChE,OAAO,cAAc,CAAiB;QACpC,OAAO,EAAE,MAAM,CAAC,OAAO;QACvB,QAAQ,EAAE,kBAAW;QACrB,MAAM,EAAE,kBAAW;KACpB,CAAC,CAAC;AACL,CAAC;AAND,0CAMC;AAED,SAAgB,uBAAuB;IACrC,OAAO,yBAAyB,EAAiB,CAAC;AACpD,CAAC;AAFD,0DAEC;AAID,SAAgB,cAAc,CAAI,MAAoC;;IACpE,OAAO,cAAc,CAAW;QAC9B,OAAO,EAAE,MAAA,MAAM,CAAC,OAAO,mCAAI,EAAE;QAC7B,QAAQ,EAAE,kBAAW;QACrB,MAAM,EAAE,kBAAW;KACpB,CAAC,CAAC;AACL,CAAC;AAND,wCAMC;AAED,SAAgB,sBAAsB;IACpC,OAAO,yBAAyB,EAAc,CAAC;AACjD,CAAC;AAFD,wDAEC;AAMD,SAAgB,oBAAoB,CAAI,MAA0C;;IAChF,MAAM,EAAE,UAAU,EAAE,GAAG,MAAM,CAAC;IAC9B,OAAO,cAAc,CAAW;QAC9B,OAAO,EAAE,MAAA,MAAM,CAAC,OAAO,mCAAI,EAAE;QAC7B,QAAQ,EAAE,UAAU;QACpB,MAAM,EAAE,UAAU;KACnB,CAAC,CAAC;AACL,CAAC;AAPD,oDAOC;AAMD,SAAgB,yBAAyB,CAA2C,MAAkD;IACpI,OAAO,oBAAoB,iCACtB,MAAM,KACT,UAAU,EAAE,IAAA,6BAAsB,EAAO,MAAM,CAAC,OAAO,CAAC,IACxD,CAAC;AACL,CAAC;AALD,8DAKC;AAID,SAAgB,0BAA0B,CAAC,MAA6C;IACtF,MAAM,UAAU,GAAG,IAAA,0BAAmB,EAAC,MAAM,CAAC,CAAC;IAC/C,OAAO,oBAAoB,iCACtB,MAAM,KACT,UAAU,IACV,CAAC;AACL,CAAC;AAND,gEAMC;AAED;;;;GAIG;AACH,SAAgB,sBAAsB;IACpC,yEAAyE;IACzE,OAAO,0BAA0B,CAAC,EAAE,CAAC,CAAC;AACxC,CAAC;AAHD,wDAGC;AAED;;;;GAIG;AACU,QAAA,qBAAqB,GAAG,sBAAsB,CAAC;AAS5D;;;;;GAKG;AACH,SAAgB,qBAAqB,CAA+B,MAA8C;;IAChH,MAAM,EAAE,QAAQ,EAAE,MAAM,EAAE,GAAG,MAAM,CAAC,OAAO,CAAC;IAC5C,OAAO,cAAc,CAAW;QAC9B,OAAO,EAAE,MAAA,MAAM,CAAC,OAAO,mCAAI,EAAE;QAC7B,QAAQ,EAAE,CAAC,KAAU,EAAE,EAAE,CAAE,KAAsB,CAAC,GAAG,CAAC,QAAQ,CAAC;QAC/D,MAAM,EAAE,CAAC,KAAU,EAAE,EAAE,CAAC,IAAA,wBAAiB,EAAE,KAAsB,CAAC,GAAG,CAAC,MAAM,CAAC,CAAC;KAC/E,CAAC,CAAC;AACL,CAAC;AAPD,sDAOC;AAoBD;;;;;;;GAOG;AACH,SAAgB,YAAY,CAA+B,SAAwC,EAAE;;IACnG,MAAM,EAAE,SAAS,EAAE,MAAM,GAAG,+BAAwB,CAAC,IAAI,EAAE,cAAc,EAAE,GAAG,MAAM,CAAC;IACrF,MAAM,sBAAsB,GAAG,IAAA,6BAAsB,EAA8B;QACjF,IAAI,EAAE,KAAK;QACX,MAAM;KACP,CAAC,CAAC;IACH,MAAM,QAAQ,GAAG,CAAC,cAAc,CAAC,CAAC,CAAC,IAAA,2BAAoB,EAAC,cAAc,CAAC,CAAC,CAAC,CAAC,iBAAU,CAAoD,CAAC;IAEzI,OAAO,cAAc,CAA2D;QAC9E,OAAO,EAAE,MAAA,MAAM,CAAC,OAAO,mCAAK,EAAkC;QAC9D,QAAQ,EAAE,kBAAW;QACrB,MAAM,EAAE,CAAC,KAAK,EAAE,EAAE;YAChB,MAAM,IAAI,GAAG,QAAQ,CAAC,KAAK,CAAC,CAAC;YAC7B,OAAO,sBAAsB,CAAC,IAAI,CAAC,CAAC;QACtC,CAAC;KACF,CAAC,CAAC;AACL,CAAC;AAhBD,oCAgBC;AAED;;;;GAIG;AACH,SAAgB,+BAA+B;IAC7C,OAAO,YAAY,CAAuB;QACxC,SAAS,EAAE,+BAAwB,CAAC,KAAK;KAC1C,CAAC,CAAC;AACL,CAAC;AAJD,0EAIC;AAED;;;;GAIG;AACU,QAAA,8BAA8B,GAAkI,+BAA+B,CAAC;AAW7M,SAAgB,iBAAiB,CAA+B,SAA6C,EAAE;IAC7G,OAAO,YAAY,iBACjB,SAAS,EAAE,+BAAwB,CAAC,KAAK,EACzC,cAAc,EAAE,wBAAiB,IAC9B,MAAM,EACT,CAAC;AACL,CAAC;AAND,8CAMC;AAED;;;;GAIG;AACH,SAAgB,oCAAoC;IAClD,OAAO,iBAAiB,CAAuB;QAC7C,cAAc,EAAE,wBAAiB;KAClC,CAAC,CAAC;AACL,CAAC;AAJD,oFAIC;AAED;;;;GAIG;AACU,QAAA,mCAAmC,GAAsI,oCAAoC,CAAC;AAK3N;;;;;;;GAOG;AACH,SAAgB,YAAY,CAA4B,MAAkC;;IACxF,OAAO,cAAc,CAAc;QACjC,OAAO,EAAE,MAAA,MAAM,CAAC,OAAO,mCAAI,CAAC,GAAG,EAAE,CAAC,IAAI,GAAG,EAAE,CAAC;QAC5C,QAAQ,EAAE,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,GAAG,CAAC,IAAI,CAAC;QACjC,MAAM,EAAE,CAAC,GAAG,EAAE,EAAE,CAAC,KAAK,CAAC,IAAI,CAAC,GAAG,CAAC;KACjC,CAAC,CAAC;AACL,CAAC;AAND,oCAMC"}

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

@@ -1 +1 @@
-{"version":3,"file":"snapshot.js","sourceRoot":"","sources":["../../../../../../../../packages/firebase/src/lib/common/firestore/snapshot/snapshot.ts"],"names":[],"mappings":";;;AAAA,wCAAgV;AAChV,oCAAyN;AAEzN,aAAa;AACb;;GAEG;AACU,QAAA,qBAAqB,GAAG,IAAI,CAAC;AAqE1C,SAAgB,0BAA0B,CAA6D,MAAqC;;IAC1I,MAAM,WAAW,GAAgC,MAAC,MAAuD,CAAC,gBAAgB,mCAAI,IAAA,4BAAqB,EAAQ,MAAkD,CAAC,MAAM,CAAC,CAAC;IACtN,MAAM,YAAY,GAAG,IAAA,4BAAqB,EAAO,WAAW,CAAC,CAAC;IAC9D,MAAM,EAAE,IAAI,EAAE,QAAQ,EAAE,EAAE,EAAE,MAAM,EAAE,GAAG,MAAM,CAAC,SAAS,CAAC,CAAC,CAAC,IAAA,8BAAuB,EAAC,EAAE,YAAY,EAAE,SAAS,EAAE,MAAM,CAAC,SAAS,EAAE,CAAC,CAAC,CAAC,CAAC,YAAY,CAAC;IAEhJ,MAAM,IAAI,GAAwC,CAAC,KAAuB,EAAE,MAA0B,EAAE,EAAE;QACxG,MAAM,IAAI,GAAG,KAAK,CAAC,IAAI,EAAE,CAAC;QAC1B,OAAO,QAAQ,CAAC,IAAS,EAAE,MAAM,CAAC,CAAC;IACrC,CAAC,CAAC;IAEF,MAAM,EAAE,GAAsC,CAAC,KAAQ,EAAE,MAA0B,EAAE,OAA2B,EAAE,EAAE;QAClH,IAAI,SAA2C,CAAC;QAEhD,IAAI,OAAO,EAAE;YACX,MAAM,WAAW,GAAI,OAAiC,CAAC,WAAW,CAAC;YAEnE,IAAK,OAA2B,CAAC,KAAK,EAAE;gBACtC,SAAS,GAAG;oBACV,WAAW,EAAE,IAAI;iBAClB,CAAC;aACH;YAED,IAAI,WAAW,EAAE;gBACf,SAAS,mCACJ,SAAS,KACZ,MAAM,EAAE,IAAA,4BAAoB,EAAC,WAAW,CAAgB,GACzD,CAAC;aACH;SACF;QAED,OAAO,MAAM,CAAC,KAAK,EAAE,MAAM,EAAE,SAAS,CAAC,CAAC;IAC1C,CAAC,CAAC;IAEF,OAAO;QACL,IAAI;QACJ,EAAE;QACF,aAAa,EAAE,CAAC,QAA6B,EAAE,OAAyB,EAAE,EAAE,CAAC,IAAI,CAAC,QAAQ,EAAE,SAAS,EAAE,OAAO,CAAC;QAC/G,WAAW,EAAE,CAAC,WAAyD,EAAE,OAAoB,EAAE,EAAE,CAAC,EAAE,CAAC,WAAgB,EAAE,SAAS,EAAE,OAAO,CAAC;KAC3I,CAAC;AACJ,CAAC;AAvCD,gEAuCC"}
+{"version":3,"file":"snapshot.js","sourceRoot":"","sources":["../../../../../../../../packages/firebase/src/lib/common/firestore/snapshot/snapshot.ts"],"names":[],"mappings":";;;AAAA,wCAA0R;AAC1R,oCAAsM;AAEtM,aAAa;AACb;;GAEG;AACU,QAAA,qBAAqB,GAAG,IAAI,CAAC;AAqE1C,SAAgB,0BAA0B,CAA6D,MAAqC;;IAC1I,MAAM,WAAW,GAAgC,MAAC,MAAuD,CAAC,gBAAgB,mCAAI,IAAA,4BAAqB,EAAQ,MAAkD,CAAC,MAAM,CAAC,CAAC;IACtN,MAAM,YAAY,GAAG,IAAA,4BAAqB,EAAO,WAAW,CAAC,CAAC;IAC9D,MAAM,EAAE,IAAI,EAAE,QAAQ,EAAE,EAAE,EAAE,MAAM,EAAE,GAAG,MAAM,CAAC,SAAS,CAAC,CAAC,CAAC,IAAA,8BAAuB,EAAC,EAAE,YAAY,EAAE,SAAS,EAAE,MAAM,CAAC,SAAS,EAAE,CAAC,CAAC,CAAC,CAAC,YAAY,CAAC;IAEhJ,MAAM,IAAI,GAAwC,CAAC,KAAuB,EAAE,MAA0B,EAAE,EAAE;QACxG,MAAM,IAAI,GAAG,KAAK,CAAC,IAAI,EAAE,CAAC;QAC1B,OAAO,QAAQ,CAAC,IAAS,EAAE,MAAM,CAAC,CAAC;IACrC,CAAC,CAAC;IAEF,MAAM,EAAE,GAAsC,CAAC,KAAQ,EAAE,MAA0B,EAAE,OAA2B,EAAE,EAAE;QAClH,IAAI,SAA2C,CAAC;QAEhD,IAAI,OAAO,EAAE;YACX,MAAM,WAAW,GAAI,OAAiC,CAAC,WAAW,CAAC;YAEnE,IAAK,OAA2B,CAAC,KAAK,EAAE;gBACtC,SAAS,GAAG;oBACV,WAAW,EAAE,IAAI;iBAClB,CAAC;aACH;YAED,IAAI,WAAW,EAAE;gBACf,SAAS,mCACJ,SAAS,KACZ,MAAM,EAAE,IAAA,4BAAoB,EAAC,WAAW,CAAgB,GACzD,CAAC;aACH;SACF;QAED,OAAO,MAAM,CAAC,KAAK,EAAE,MAAM,EAAE,SAAS,CAAC,CAAC;IAC1C,CAAC,CAAC;IAEF,OAAO;QACL,IAAI;QACJ,EAAE;QACF,aAAa,EAAE,CAAC,QAA6B,EAAE,OAAyB,EAAE,EAAE,CAAC,IAAI,CAAC,QAAQ,EAAE,SAAS,EAAE,OAAO,CAAC;QAC/G,WAAW,EAAE,CAAC,WAAyD,EAAE,OAAoB,EAAE,EAAE,CAAC,EAAE,CAAC,WAAgB,EAAE,SAAS,EAAE,OAAO,CAAC;KAC3I,CAAC;AACJ,CAAC;AAvCD,gEAuCC"}

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

@@ -4,12 +4,6 @@ import { FirebasePermissionContext, FirebasePermissionErrorContext } from './per
  * 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/permission/permission.service.d.ts

@@ -1,6 +1,6 @@
 import { FirestoreDocument } from './../../firestore';
 import { AbstractModelPermissionService, GrantedRoleMap, InContextModelPermissionService, InModelContextModelPermissionService, ModelPermissionService } from '@dereekb/model';
-import { Maybe, PromiseOrValue } from '@dereekb/util';
+import { DecisionFunction, Getter, GetterOrValue, Maybe, PromiseOrValue } from '@dereekb/util';
 import { FirebaseModelLoader, InModelContextFirebaseModelLoader } from '../model/model.loader';
 import { FirebaseModelContext } from '../context';
 import { FirebasePermissionServiceModel } from './permission';
@@ -16,9 +16,52 @@ export declare class FirebaseModelPermissionServiceInstance<C extends FirebaseMo
     constructor(delegate: FirebasePermissionServiceInstanceDelegate<C, T, D, R>);
     roleMapForModel(output: FirebasePermissionServiceModel<T, D>, context: C, model: D): PromiseOrValue<GrantedRoleMap<R>>;
     protected outputForModel(document: D): Promise<Maybe<FirebasePermissionServiceModel<T, D>>>;
-    protected getRoleMapForOutput(output: FirebasePermissionServiceModel<T, D>, context: C, model: D): Promise<import("@dereekb/model").ContextGrantedModelRoles<FirebasePermissionServiceModel<T, D>, C, R>>;
     protected isUsableOutputForRoles(output: FirebasePermissionServiceModel<T, D>): boolean;
 }
 export declare function firebaseModelPermissionService<C extends FirebaseModelContext, T, D extends FirestoreDocument<T> = FirestoreDocument<T>, R extends string = string>(delegate: FirebasePermissionServiceInstanceDelegate<C, T, D, R>): FirebaseModelPermissionServiceInstance<C, T, D, R>;
 export declare type InContextFirebaseModelPermissionService<C, T, D extends FirestoreDocument<T> = FirestoreDocument<T>, R extends string = string> = InContextModelPermissionService<C, D, R, FirebasePermissionServiceModel<T, D>>;
 export declare type InModelContextFirebaseModelPermissionService<C, T, D extends FirestoreDocument<T> = FirestoreDocument<T>, R extends string = string> = InModelContextModelPermissionService<C, D, R, FirebasePermissionServiceModel<T, D>> & InModelContextFirebaseModelLoader<T, D>;
+export declare const grantFullAccessIfAdmin: GeneralGrantRolesIfFunction;
+export declare function grantModelRolesIfAdmin<R extends string = string>(context: FirebaseModelContext, rolesToGrantToAdmin: GetterOrValue<GrantedRoleMap<R>>, otherwise?: () => GrantedRoleMap<R>): GrantedRoleMap<R>;
+/**
+ * Convenience function that checks the input context if the user is an admin or not and grants pre-set admin roles if they are.
+ *
+ * @param context
+ * @param rolesToGrantToAdmin
+ * @param otherwise
+ * @returns
+ */
+export declare function grantModelRolesIfAdminFunction<R extends string = string>(rolesToGrantToAdmin: GetterOrValue<GrantedRoleMap<R>>): GrantRolesIfFunction<R>;
+/**
+ * DecisionFunction for a FirebaseModelContext that checks if the current user is an admin.
+ *
+ * @param context
+ * @returns
+ */
+export declare const isAdminInFirebaseModelContext: DecisionFunction<FirebaseModelContext>;
+/**
+ * Grants the configured roles if the decision is made about the context. Otherwise, returns a NoAccessRoleMap.
+ */
+export declare type GrantRolesOnlyIfFunction<R extends string = string, C extends FirebaseModelContext = FirebaseModelContext> = (context: C) => GrantedRoleMap<R>;
+export declare type GeneralGrantRolesOnlyIfFunction = <R extends string = string, C extends FirebaseModelContext = FirebaseModelContext>(context: C) => GrantedRoleMap<R>;
+/**
+ * Creates a GrantRolesOnlyIfFunction
+ *
+ * @param grantIf
+ * @param grantedRoles
+ * @returns
+ */
+export declare function grantModelRolesOnlyIfFunction<C extends FirebaseModelContext, R extends string = string>(grantIf: DecisionFunction<C>, grantedRoles: GetterOrValue<GrantedRoleMap<R>>): GrantRolesOnlyIfFunction<R, C>;
+/**
+ * Grants the configured roles if the decision is made about the context. Otherwise, invokes the otherwise function if available, or returns a NoAccessRoleMap.
+ */
+export declare type GrantRolesIfFunction<R extends string = string, C extends FirebaseModelContext = FirebaseModelContext> = (context: C, otherwise?: Getter<GrantedRoleMap<R>>) => GrantedRoleMap<R>;
+export declare type GeneralGrantRolesIfFunction = <R extends string = string, C extends FirebaseModelContext = FirebaseModelContext>(context: C, otherwise?: Getter<GrantedRoleMap<R>>) => GrantedRoleMap<R>;
+/**
+ * Creates a GrantRolesIfFunction.
+ *
+ * @param grantIf
+ * @param grantedRoles
+ * @returns
+ */
+export declare function grantModelRolesIfFunction<C extends FirebaseModelContext, R extends string = string>(grantIf: DecisionFunction<C>, grantedRoles: GetterOrValue<GrantedRoleMap<R>>): GrantRolesIfFunction<R, C>;