@dereekb/firebase 10.0.19 → 10.0.20

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@dereekb/firebase",
-  "version": "10.0.19",
+  "version": "10.0.20",
   "exports": {
     ".": {
       "types": "./src/index.d.ts",

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

@@ -4,8 +4,8 @@ import { type FullFirestoreQueryConstraintHandlersMapping } from './../../common
 import { type FirestoreQueryConstraintFunctionsDriver, type FirestoreQueryDriver } from '../../common/firestore/driver/query';
 import { type Query } from '../../common/firestore/types';
 export interface FirebaseFirestoreQueryBuilder {
-    query: Query;
-    constraints: QueryConstraint[];
+    readonly query: Query;
+    readonly constraints: QueryConstraint[];
 }
 export declare function addConstraintToBuilder(builder: FirebaseFirestoreQueryBuilder, constraint: ArrayOrValue<QueryConstraint>): FirebaseFirestoreQueryBuilder;
 export declare const FIRESTORE_CLIENT_QUERY_CONSTRAINT_HANDLER_MAPPING: FullFirestoreQueryConstraintHandlersMapping<FirebaseFirestoreQueryBuilder>;

package/src/lib/client/function/development.function.d.ts

@@ -8,7 +8,7 @@ export declare const FIREBASE_DEVELOPMENT_FUNCTIONS_MAP_KEY = "developmentFuncti
  * Base map of all development functions enabled by the server.
  */
 export type FirebaseDevelopmentFunctionTypeMap = {
-    scheduledFunction: [ScheduledFunctionDevelopmentFirebaseFunctionParams, ScheduledFunctionDevelopmentFirebaseFunctionResult];
+    readonly scheduledFunction: [ScheduledFunctionDevelopmentFirebaseFunctionParams, ScheduledFunctionDevelopmentFirebaseFunctionResult];
 };
 /**
  * Base DevelopmentFirebaseFunctionMap for all development functions enabled by the server (via firebaseServerDevFunctions())
@@ -16,5 +16,5 @@ export type FirebaseDevelopmentFunctionTypeMap = {
  * Is used by dbx-firebase
  */
 export declare abstract class FirebaseDevelopmentFunctions {
-    abstract scheduledFunction: FirebaseFunction<ScheduledFunctionDevelopmentFirebaseFunctionParams, ScheduledFunctionDevelopmentFirebaseFunctionResult>;
+    abstract readonly scheduledFunction: FirebaseFunction<ScheduledFunctionDevelopmentFirebaseFunctionParams, ScheduledFunctionDevelopmentFirebaseFunctionResult>;
 }

package/src/lib/client/function/function.callable.d.ts

@@ -1,8 +1,8 @@
 import { type FactoryWithInput, type Maybe, type PromiseOrValue } from '@dereekb/util';
 import { type HttpsCallable } from 'firebase/functions';
 export interface MapHttpsCallable<I, O, A, B> {
-    mapInput?: FactoryWithInput<PromiseOrValue<A>, Maybe<I>>;
-    mapOutput?: FactoryWithInput<PromiseOrValue<O>, Maybe<B>>;
+    readonly mapInput?: FactoryWithInput<PromiseOrValue<A>, Maybe<I>>;
+    readonly mapOutput?: FactoryWithInput<PromiseOrValue<O>, Maybe<B>>;
 }
 /**
  * Maps input and output values when using HttpsCallable.

package/src/lib/client/function/function.d.ts

@@ -14,13 +14,13 @@ export type FirebaseFunction<I = unknown, O = unknown> = (input: I) => Promise<O
  * Type with keys corresponding to functions on the corresponding server for a client.
  */
 export type FirebaseFunctionTypeMap = {
-    [key: FirebaseFunctionKey]: FirebaseFunctionType;
+    readonly [key: FirebaseFunctionKey]: FirebaseFunctionType;
 };
 /**
  * A FirebaseFunction map. Its types are relative to a FirebaseFunctionTypeMap.
  */
 export type FirebaseFunctionMap<M extends FirebaseFunctionTypeMap> = {
-    [K in keyof M]: FirebaseFunctionMapFunction<M, K>;
+    readonly [K in keyof M]: FirebaseFunctionMapFunction<M, K>;
 };
 /**
  * Typings for a function within a FirebaseFunctionMap.

package/src/lib/client/function/function.factory.d.ts

@@ -2,10 +2,10 @@ import { type ClassLikeType, type Getter, type Maybe } from '@dereekb/util';
 import { type Functions, type HttpsCallableOptions } from 'firebase/functions';
 import { type FirebaseFunctionMap, type FirebaseFunctionTypeMap } from './function';
 export interface FirebaseFunctionTypeConfig {
-    options?: HttpsCallableOptions;
+    readonly options?: HttpsCallableOptions;
 }
 export type FirebaseFunctionTypeConfigMap<M extends FirebaseFunctionTypeMap> = {
-    [K in keyof M]: Maybe<FirebaseFunctionTypeConfig>;
+    readonly [K in keyof M]: Maybe<FirebaseFunctionTypeConfig>;
 };
 /**
  * Used for building a FirebaseFunctionMap<M> for a specific Functions instance.
@@ -21,10 +21,10 @@ export type FirebaseFunctionGetter<T> = Getter<T> & {
  * Map of all firebase functions in the app.
  */
 export type FirebaseFunctionsMap = {
-    [key: FirebaseFunctionMapKey]: FirebaseFunctionTypeMap;
+    readonly [key: FirebaseFunctionMapKey]: FirebaseFunctionTypeMap;
 };
 export type FirebaseFunctionsConfigMap<M extends FirebaseFunctionsMap> = {
-    [K in keyof M]: FirebaseFunctionsConfigMapEntry<M[K]>;
+    readonly [K in keyof M]: FirebaseFunctionsConfigMapEntry<M[K]>;
 };
 export type FirebaseFunctionsConfigMapEntry<M extends FirebaseFunctionTypeMap> = [ClassLikeType, FirebaseFunctionMapFactory<M>];
 /**
@@ -35,6 +35,6 @@ export type LazyFirebaseFunctionsFactory<M extends FirebaseFunctionsMap> = (func
  * Map of FirebaseFunctionGetter values that are lazy-loaded via the getter.
  */
 export type LazyFirebaseFunctions<M extends FirebaseFunctionsMap> = {
-    [K in keyof M]: FirebaseFunctionGetter<FirebaseFunctionMap<M[K]>>;
+    readonly [K in keyof M]: FirebaseFunctionGetter<FirebaseFunctionMap<M[K]>>;
 };
 export declare function lazyFirebaseFunctionsFactory<M extends FirebaseFunctionsMap, C extends FirebaseFunctionsConfigMap<M> = FirebaseFunctionsConfigMap<M>>(configMap: C): LazyFirebaseFunctionsFactory<M>;

package/src/lib/client/function/model.function.factory.d.ts

@@ -13,7 +13,7 @@ export type ModelFirebaseCrudFunctionSpecifier = string;
  * Provides a reference to a ModelFirebaseCrudFunctionSpecifier if available.
  */
 export type ModelFirebaseCrudFunctionSpecifierRef = {
-    specifier?: ModelFirebaseCrudFunctionSpecifier;
+    readonly specifier?: ModelFirebaseCrudFunctionSpecifier;
 };
 export type ModelFirebaseCrudFunction<I, O = void> = FirebaseFunction<I, O>;
 export type ModelFirebaseCreateFunction<I, O extends OnCallCreateModelResult = OnCallCreateModelResult> = ModelFirebaseCrudFunction<I, O>;
@@ -27,16 +27,16 @@ export type ModelFirebaseCrudFunctionTypeMapEntry = MaybeNot | Partial<ModelFire
 export type ModelFirebaseCrudFunctionTypeMapEntryWithReturnType<I = unknown, O = unknown> = [I, O];
 export type ModelFirebaseCrudFunctionTypeSpecifierConfig = Record<string | number, unknown | ModelFirebaseCrudFunctionTypeMapEntryWithReturnType>;
 export type ModelFirebaseCrudFunctionCreateTypeConfig = {
-    create: unknown | ModelFirebaseCrudFunctionTypeSpecifierConfig;
+    readonly create: unknown | ModelFirebaseCrudFunctionTypeSpecifierConfig;
 };
 export type ModelFirebaseCrudFunctionReadTypeConfig = {
-    read: unknown | ModelFirebaseCrudFunctionTypeSpecifierConfig;
+    readonly read: unknown | ModelFirebaseCrudFunctionTypeSpecifierConfig;
 };
 export type ModelFirebaseCrudFunctionUpdateTypeConfig = {
-    update: unknown | ModelFirebaseCrudFunctionTypeSpecifierConfig;
+    readonly update: unknown | ModelFirebaseCrudFunctionTypeSpecifierConfig;
 };
 export type ModelFirebaseCrudFunctionDeleteTypeConfig = {
-    delete: unknown | ModelFirebaseCrudFunctionTypeSpecifierConfig;
+    readonly delete: unknown | ModelFirebaseCrudFunctionTypeSpecifierConfig;
 };
 export declare const MODEL_FUNCTION_FIREBASE_CRUD_FUNCTION_SPECIFIER_DEFAULT = "_";
 export type ModelFirebaseCrudFunctionSpecifierDefault = typeof MODEL_FUNCTION_FIREBASE_CRUD_FUNCTION_SPECIFIER_DEFAULT;

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

@@ -20,16 +20,28 @@ export interface FirebaseAuthUserIdRef {
  * Firebase Auth Token interface
  */
 export interface FirebaseAuthToken {
-    email?: Maybe<string>;
-    emailVerified?: Maybe<boolean>;
-    phoneNumber?: Maybe<PhoneNumber>;
-    creationTime?: Maybe<ISO8601DateString>;
-    lastSignInTime?: Maybe<ISO8601DateString>;
+    readonly email?: Maybe<string>;
+    readonly emailVerified?: Maybe<boolean>;
+    readonly phoneNumber?: Maybe<PhoneNumber>;
+    /**
+     * The date the user was created.
+     */
+    readonly creationTime?: Maybe<ISO8601DateString>;
+    /**
+     * The last time the user signed in.
+     *
+     * This is not necessarily the last time they used the app, just the last time the auth system gave them a refresh token.
+     */
+    readonly lastSignInTime?: Maybe<ISO8601DateString>;
+    /**
+     * The last time the user refreshed their token. The best indicator of recent activity.
+     */
+    readonly lastRefreshTime?: Maybe<ISO8601DateString>;
 }
-export interface FirebaseAuthDetails extends FirebaseAuthToken, FirebaseAuthUserIdRef {
-    disabled?: Maybe<boolean>;
-    displayName?: Maybe<string>;
-    photoURL?: Maybe<WebsiteUrl>;
+export interface FirebaseAuthDetails extends FirebaseAuthToken, Readonly<FirebaseAuthUserIdRef> {
+    readonly disabled?: Maybe<boolean>;
+    readonly displayName?: Maybe<string>;
+    readonly photoURL?: Maybe<WebsiteUrl>;
 }
 /**
  * A string key used to test for ownership of a particular set of objects.

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

@@ -1,9 +1,9 @@
 import { type ReadableError } from '@dereekb/util';
 import { type FirebaseErrorCode } from '../error';
 export interface FirebaseAuthError {
-    code: FirebaseErrorCode;
-    name: string;
-    customData: unknown;
+    readonly code: FirebaseErrorCode;
+    readonly name: string;
+    readonly customData: unknown;
 }
 export declare const FIREBASE_AUTH_USER_NOT_FOUND_ERROR = "auth/user-not-found";
 export declare const FIREBASE_AUTH_WRONG_PASSWORD = "auth/wrong-password";

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

@@ -4,10 +4,10 @@ import { type Observable, type OperatorFunction } from 'rxjs';
 import { type DocumentReferenceRef } from '../reference';
 import { type PickProperties } from 'ts-essentials';
 export interface FirestoreDocumentDeleteParams {
-    precondition?: Precondition;
+    readonly precondition?: Precondition;
 }
 export interface FirestoreDocumentUpdateParams {
-    precondition?: Precondition;
+    readonly precondition?: Precondition;
 }
 /**
  * Used for performing increment updates.

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

@@ -8,7 +8,7 @@ export type FirestoreDataConverterFactory<T> = FactoryWithInput<FirestoreDataCon
  * Ref to a FirestoreDataConverterFactory.
  */
 export interface FirestoreDataConverterFactoryRef<T> {
-    converterFactory: FirestoreDataConverterFactory<T>;
+    readonly converterFactory: FirestoreDataConverterFactory<T>;
 }
 /**
  * Factory used to provide an optional custom FirestoreDataConverter based on the input reference.

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

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

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

@@ -6,14 +6,14 @@ export type FirestoreQueryConstraintType = string;
  * A constraint. Used by drivers to apply native firebase query constraints.
  */
 export interface FirestoreQueryConstraint<T = unknown> {
-    type: FirestoreQueryConstraintType;
-    data: T;
+    readonly type: FirestoreQueryConstraintType;
+    readonly data: T;
 }
 export declare function firestoreQueryConstraint<T = unknown>(type: string, data: T): FirestoreQueryConstraint<T>;
 export declare function firestoreQueryConstraintFactory(type: string): <T = unknown>(data: T) => FirestoreQueryConstraint<T>;
 export declare const FIRESTORE_LIMIT_QUERY_CONSTRAINT_TYPE = "limit";
 export interface LimitQueryConstraintData {
-    limit: number;
+    readonly limit: number;
 }
 /**
  * Limits the maximum number of documents to return.
@@ -24,7 +24,7 @@ export interface LimitQueryConstraintData {
 export declare function limit(limit: number): FirestoreQueryConstraint<LimitQueryConstraintData>;
 export declare const FIRESTORE_LIMIT_TO_LAST_QUERY_CONSTRAINT_TYPE = "limit_to_last";
 export interface LimitToLastQueryConstraintData {
-    limit: number;
+    readonly limit: number;
 }
 /**
  * Returns the last matching documents in the query, up to the limit.
@@ -55,9 +55,9 @@ export type WhereFilterOp = WhereFilterOpValue | WhereFilterOpArrayValue;
  */
 export declare const FIRESTORE_MAX_WHERE_IN_FILTER_ARGS_COUNT = 10;
 export interface WhereQueryConstraintData {
-    fieldPath: string | FieldPath;
-    opStr: WhereFilterOp;
-    value: unknown;
+    readonly fieldPath: string | FieldPath;
+    readonly opStr: WhereFilterOp;
+    readonly value: unknown;
 }
 /**
  * Configures a Firebase where query.
@@ -76,8 +76,8 @@ export declare function whereDocumentId(opStr: WhereFilterOp, value: unknown): F
 export declare const FIRESTORE_ORDER_BY_QUERY_CONSTRAINT_TYPE = "order_by";
 export type OrderByDirection = SortingOrder;
 export interface OrderByQueryConstraintData {
-    fieldPath: FieldPathOrStringPath;
-    directionStr?: OrderByDirection;
+    readonly fieldPath: FieldPathOrStringPath;
+    readonly directionStr?: OrderByDirection;
 }
 export declare function orderBy<T>(fieldPath: StringKeyPropertyKeys<T>, directionStr?: OrderByDirection): FirestoreQueryConstraint<OrderByQueryConstraintData>;
 export declare function orderBy(fieldPath: FieldPathOrStringPath, directionStr?: OrderByDirection): FirestoreQueryConstraint<OrderByQueryConstraintData>;
@@ -91,21 +91,21 @@ export interface StartAtQueryConstraintData<T = DocumentData> {
 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[];
+    readonly 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>;
+    readonly snapshot: DocumentSnapshot<T>;
 }
 export declare function startAfter<T = DocumentData>(snapshot: DocumentSnapshot<T>): FirestoreQueryConstraint<StartAfterQueryConstraintData<T>>;
 export declare const FIRESTORE_END_AT_QUERY_CONSTRAINT_TYPE = "end_at";
 export interface EndAtQueryConstraintData<T = DocumentData> {
-    snapshot: DocumentSnapshot<T>;
+    readonly snapshot: DocumentSnapshot<T>;
 }
 export declare const FIRESTORE_END_AT_VALUE_QUERY_CONSTRAINT_TYPE = "end_at_path";
 export interface EndAtValueQueryConstraintData {
-    fieldValues: unknown[];
+    readonly fieldValues: unknown[];
 }
 export declare function endAtValue(...fieldValues: unknown[]): FirestoreQueryConstraint<EndAtValueQueryConstraintData>;
 /**
@@ -116,7 +116,7 @@ export declare function endAtValue(...fieldValues: unknown[]): FirestoreQueryCon
 export declare function endAt<T = DocumentData>(snapshot: DocumentSnapshot<T>): FirestoreQueryConstraint<EndAtQueryConstraintData<T>>;
 export declare const FIRESTORE_END_BEFORE_QUERY_CONSTRAINT_TYPE = "end_before";
 export interface EndBeforeQueryConstraintData<T = DocumentData> {
-    snapshot: DocumentSnapshot<T>;
+    readonly snapshot: DocumentSnapshot<T>;
 }
 /**
  *
@@ -129,7 +129,7 @@ export declare function endBefore<T = DocumentData>(snapshot: DocumentSnapshot<T
  */
 export type FirestoreQueryConstraintHandlerFunction<B, D = unknown> = (builder: B, data: D, constraint: FirestoreQueryConstraint<D>) => B;
 export type FirestoreQueryConstraintHandlerMap<B> = {
-    [key: string]: Maybe<FirestoreQueryConstraintHandlerFunction<B, any>>;
+    readonly [key: string]: Maybe<FirestoreQueryConstraintHandlerFunction<B, any>>;
 };
 /**
  * The full list of known firestore query constraints, and the data associated with it.

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

@@ -9,11 +9,11 @@ export interface FirestoreItemPageIteratorFilter extends ItemPageLimit {
     /**
      * Overrides the default limit, if applicable.
      */
-    limit?: Maybe<number>;
+    readonly limit?: Maybe<number>;
     /**
      * Constraints to query on.
      */
-    constraints?: Maybe<ArrayOrValue<FirestoreQueryConstraint>>;
+    readonly constraints?: Maybe<ArrayOrValue<FirestoreQueryConstraint>>;
 }
 export interface FirestoreItemPageIterationBaseConfig<T> extends QueryLikeReferenceRef<T>, FirestoreQueryDriverRef, ItemPageLimit {
     /**
@@ -21,7 +21,7 @@ export interface FirestoreItemPageIterationBaseConfig<T> extends QueryLikeRefere
      *
      * Defaults to 50
      */
-    itemsPerPage?: number;
+    readonly itemsPerPage?: number;
 }
 export interface FirestoreItemPageIterationConfig<T> extends FirestoreItemPageIterationBaseConfig<T>, ItemPageIterationConfig<FirestoreItemPageIteratorFilter> {
 }

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

@@ -1,9 +1,9 @@
 import { type DocumentReference, type QuerySnapshot } from './../types';
 import { Observable } from 'rxjs';
 export interface StreamDocsWithOnSnapshotFunctionParams<O> {
-    next: (value?: O | undefined) => void;
-    error: (err?: unknown) => void;
-    complete: () => void;
+    readonly next: (value?: O | undefined) => void;
+    readonly error: (err?: unknown) => void;
+    readonly complete: () => void;
 }
 export type StreamDocsUnsubscribeFunction = () => void;
 /**

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

@@ -108,7 +108,7 @@ export type MapConfiguredFirestoreFieldConfig<V, D = unknown> = MapConfiguredFir
 export type DefaultMapConfiguredFirestoreFieldConfig<V, D = unknown> = Omit<FirestoreFieldConfigWithDefault<V, D>, 'fromData' | 'toData' | 'default'> & Partial<Pick<FirestoreFieldConfigWithDefault<V, D>, 'default'>>;
 export type OptionalMapConfiguredFirestoreFieldConfig<V, D = unknown> = Omit<BaseFirestoreFieldConfig<V, D>, 'fromData' | 'toData' | 'defaultBeforeSave'>;
 export interface FirestoreStringConfig<S extends string = string> extends DefaultMapConfiguredFirestoreFieldConfig<S, S> {
-    transform?: TransformStringFunctionConfigInput<S>;
+    readonly transform?: TransformStringFunctionConfigInput<S>;
 }
 export declare const DEFAULT_FIRESTORE_STRING_FIELD_VALUE = "";
 export declare function firestoreString<S extends string = string>(config?: FirestoreStringConfig<S>): FirestoreModelFieldMapFunctionsConfig<S, S>;
@@ -123,7 +123,7 @@ export declare function optionalFirestoreUID(): ModelFieldMapFunctionsConfig<May
 export declare const firestoreModelKeyString: FirestoreModelFieldMapFunctionsConfig<string, string>;
 export declare const firestoreModelIdString: FirestoreModelFieldMapFunctionsConfig<string, string>;
 export type FirestoreDateFieldConfig = DefaultMapConfiguredFirestoreFieldConfig<Date, string> & {
-    saveDefaultAsNow?: boolean;
+    readonly saveDefaultAsNow?: boolean;
 };
 export declare function firestoreDate(config?: FirestoreDateFieldConfig): FirestoreModelFieldMapFunctionsConfig<Date, string>;
 export type OptionalFirestoreDateFieldConfig = OptionalFirestoreFieldConfig<Date, ISO8601DateString>;
@@ -133,8 +133,8 @@ export declare function firestoreBoolean(config: FirestoreBooleanFieldConfig): F
 export type OptionalFirestoreBooleanFieldConfig = OptionalOneTypeFirestoreFieldConfig<boolean>;
 export declare function optionalFirestoreBoolean(config?: OptionalFirestoreBooleanFieldConfig): ModelFieldMapFunctionsConfig<Maybe<boolean>, Maybe<boolean>>;
 export interface FirestoreNumberConfig<N extends number = number> extends MapConfiguredFirestoreFieldConfigWithDefault<N, N> {
-    saveDefault?: Maybe<boolean>;
-    transform?: TransformNumberFunctionConfigInput<N>;
+    readonly saveDefault?: Maybe<boolean>;
+    readonly transform?: TransformNumberFunctionConfigInput<N>;
 }
 export declare function firestoreNumber<N extends number = number>(config: FirestoreNumberConfig<N>): FirestoreModelFieldMapFunctionsConfig<N, N>;
 export type OptionalFirestoreNumberFieldConfig<N extends number = number> = OptionalOneTypeFirestoreFieldConfig<N> & Pick<FirestoreNumberConfig<N>, 'transform'>;
@@ -353,11 +353,11 @@ export type FirestoreSubObjectFieldConfig<T extends object, O extends object = F
      *
      * Is false by default.
      */
-    saveDefaultObject?: boolean;
+    readonly saveDefaultObject?: boolean;
     /**
      * The fields to use for conversion.
      */
-    objectField: ToModelMapFunctionsInput<T, O>;
+    readonly objectField: ToModelMapFunctionsInput<T, O>;
 };
 export type FirestoreSubObjectFieldMapFunctionsConfig<T extends object, O extends object = FirestoreModelData<T>> = FirestoreModelFieldMapFunctionsConfig<T, O> & ModelMapFunctionsRef<T, O>;
 /**
@@ -422,15 +422,15 @@ export declare const MAX_FIRESTORE_MAP_ZOOM_LEVEL_VALUE: ZoomLevel;
  */
 export declare const firestoreMapZoomLevel: FirestoreModelFieldMapFunctionsConfig<number, number>;
 export interface FirestoreBitwiseSetConfig<D extends number = number> extends DefaultMapConfiguredFirestoreFieldConfig<Set<D>, BitwiseEncodedSet> {
-    maxIndex?: number;
+    readonly maxIndex?: number;
 }
 export declare function firestoreBitwiseSet<D extends number = number>(config: FirestoreBitwiseSetConfig<D>): FirestoreModelFieldMapFunctionsConfig<Set<D>, number>;
 export interface FirestoreBitwiseSetMapConfig<D extends number = number, K extends string = string> extends Omit<FirestoreEncodedObjectMapFieldConfig<Set<D>, BitwiseEncodedSet, K>, 'encoder' | 'decoder'> {
-    maxIndex?: number;
+    readonly maxIndex?: number;
 }
 export declare function firestoreBitwiseSetMap<D extends number = number, K extends string = string>(config: FirestoreBitwiseSetMapConfig<D, K>): FirestoreModelFieldMapFunctionsConfig<FirestoreEncodedObjectMapFieldValueType<Set<D>, K>, FirestoreMapFieldType<number, K>>;
 export interface FirestoreBitwiseObjectMapConfig<T extends object, K extends string = string> extends Omit<FirestoreEncodedObjectMapFieldConfig<T, BitwiseEncodedSet, K>, 'encoder' | 'decoder'> {
-    dencoder: BitwiseObjectDencoder<T>;
+    readonly dencoder: BitwiseObjectDencoder<T>;
 }
 export declare function firestoreBitwiseObjectMap<T extends object, K extends string = string>(config: FirestoreBitwiseObjectMapConfig<T, K>): FirestoreModelFieldMapFunctionsConfig<FirestoreEncodedObjectMapFieldValueType<T, K>, FirestoreMapFieldType<number, K>>;
 /**

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

@@ -4,7 +4,7 @@ import { type Getter } from '@dereekb/util';
 export type FirebaseModelLoaderContext = FirebaseTransactionContext;
 export type FirebaseModelGetFirestoreCollectionFunction<C extends FirebaseModelLoaderContext, T, D extends FirestoreDocument<T>> = (context: C) => FirestoreCollectionLike<T, D>;
 export interface FirebaseModelCollectionLoader<C extends FirebaseModelLoaderContext, T, D extends FirestoreDocument<T>> {
-    getFirestoreCollection: FirebaseModelGetFirestoreCollectionFunction<C, T, D>;
+    readonly getFirestoreCollection: FirebaseModelGetFirestoreCollectionFunction<C, T, D>;
 }
 export interface FirebaseModelLoader<C extends FirebaseModelLoaderContext, T, D extends FirestoreDocument<T>> extends ModelLoader<C, D> {
     /**
@@ -19,7 +19,7 @@ export interface FirebaseModelLoader<C extends FirebaseModelLoaderContext, T, D
 }
 export declare function firebaseModelLoader<C extends FirebaseModelLoaderContext, T, D extends FirestoreDocument<T>>(getFirestoreCollection: FirebaseModelGetFirestoreCollectionFunction<C, T, D>): FirebaseModelLoader<C, T, D>;
 export interface InContextFirebaseModelCollectionLoader<T, D extends FirestoreDocument<T>> {
-    getFirestoreCollection: Getter<FirestoreCollectionLike<T, D>>;
+    readonly getFirestoreCollection: Getter<FirestoreCollectionLike<T, D>>;
 }
 export interface InContextFirebaseModelLoader<T, D extends FirestoreDocument<T>> extends InContextModelLoader<D> {
     loadModelForKey(key: FirestoreModelKey): D;

package/src/lib/common/storage/accessor/path.model.d.ts

@@ -11,7 +11,7 @@ export interface ModelStorageSlashPathFactoryConfig {
      *
      * This value is merged with the BASE_MODEL_STORAGE_FILE_PATH (/model/) base path configured for all ModelStorageSlashPathFactory values
      */
-    basePath?: string;
+    readonly basePath?: string;
 }
 /**
  * Factory for SlashPath values using input ReadFirestoreModelKeyInput values.

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

@@ -20,11 +20,11 @@ export interface FirebaseStorageContextFactoryConfig {
     /**
      * The default bucket
      */
-    defaultBucketId?: StorageBucketId;
+    readonly defaultBucketId?: StorageBucketId;
     /**
      * Whether or not to force using the default bucket id.
      */
-    forceBucket?: boolean;
+    readonly forceBucket?: boolean;
 }
 /**
  * Creates a new FirebaseStorageContextFactory given the input FirebaseStorageDrivers.

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

@@ -74,12 +74,12 @@ export interface StorageListFilesOptions {
      * If set, limits the total number of `prefixes` and `items` to return.
      * The default and maximum maxResults is 1000.
      */
-    maxResults?: number;
+    readonly maxResults?: number;
     /**
      * The `nextPageToken` from a previous call to `list()`. If provided,
      * listing is resumed from the previous position.
      */
-    pageToken?: string;
+    readonly pageToken?: string;
 }
 export interface StorageListItemResult extends StoragePathRef {
     /**
@@ -107,15 +107,15 @@ export interface StorageListFilesResult<R = unknown> {
     /**
      * The raw result.
      */
-    raw: R;
+    readonly raw: R;
     /**
      * Options used to retrieve the result.
      */
-    options: StorageListFilesOptions | undefined;
+    readonly options: StorageListFilesOptions | undefined;
     /**
      * Whether or not there are more results available.
      */
-    hasNext: boolean;
+    readonly hasNext: boolean;
     /**
      * Returns true if any files or folders exist in the results.
      */

package/src/lib/common/storage/driver/driver.d.ts

@@ -5,6 +5,6 @@ export type FirebaseStorageDriverType = 'production' | 'testing';
  * Implements all FirebaseStorage related driver reference interfaces.
  */
 export interface FirebaseStorageDrivers extends FirebaseStorageAccessorDriverRef {
-    storageDriverIdentifier?: FirebaseStorageDriverIdentifier;
-    storageDriverType: FirebaseStorageDriverType;
+    readonly storageDriverIdentifier?: FirebaseStorageDriverIdentifier;
+    readonly storageDriverType: FirebaseStorageDriverType;
 }

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

@@ -9,7 +9,7 @@ export type StorageBucketId = string;
  * A reference to a StorageBucketId
  */
 export interface StorageBucketIdRef {
-    bucketId: StorageBucketId;
+    readonly bucketId: StorageBucketId;
 }
 /**
  * A filepath to a file or folder.
@@ -24,7 +24,7 @@ export interface StorageSlashPathRef {
      *
      * For example, if a file is at the path '<bucket>/full/path/image.png', the pathString is 'full/path/image.png'.
      */
-    pathString: StorageSlashPath;
+    readonly pathString: StorageSlashPath;
 }
 /**
  * A bucket and path pair.
@@ -47,7 +47,7 @@ export interface StoragePathFactoryConfig extends StorageBucketIdRef {
      *
      * False by default.
      */
-    replaceBucket?: boolean;
+    readonly replaceBucket?: boolean;
 }
 /**
  * Creates a StoragePathFactory.
@@ -60,7 +60,7 @@ export declare function storagePathFactory(config: StoragePathFactoryConfig): St
  * A reference to a StoragePath
  */
 export interface StoragePathRef {
-    storagePath: StoragePath;
+    readonly storagePath: StoragePath;
 }
 export type GoogleCloudStorageBucketPrefix<S extends StorageBucketId = StorageBucketId> = `gs://${S}`;
 export type GoogleCloudStorageDefaultBucketFilePath<P extends StorageSlashPath = StorageSlashPath> = P;

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

@@ -4,16 +4,16 @@ export type FirebaseStorageLikeStorage = {
     /**
      * The maximum time to retry uploads in milliseconds.
      */
-    maxUploadRetryTime: number;
+    readonly maxUploadRetryTime: number;
     /**
      * The maximum time to retry operations other than uploads or downloads in
      * milliseconds.
      */
-    maxOperationRetryTime: number;
+    readonly maxOperationRetryTime: number;
 };
 export type GoogleCloudLikeStorage = {
-    baseUrl: string;
-    projectId: string;
+    readonly baseUrl: string;
+    readonly projectId: string;
 };
 /**
  * Cast to the local type's Storage if direct access is needed. In most cases, direct access to this type is unncessary.
@@ -114,19 +114,19 @@ export type StorageUploadTask = {
 export type StorageClientUploadResult = unknown;
 export type StorageUploadResult = StorageClientUploadResult | unknown;
 export interface StorageUploadOptions {
-    resumable?: boolean;
+    readonly resumable?: boolean;
     /**
      * String format to handle the upload as. Required if the input is a string.
      */
-    stringFormat?: StorageDataStringType;
+    readonly stringFormat?: StorageDataStringType;
     /**
      * ContentType for the upload.
      */
-    contentType?: string;
+    readonly contentType?: string;
     /**
      * other metadata to attach to the file.
      */
-    metadata?: StorageMetadata;
+    readonly metadata?: StorageMetadata;
 }
 /**
  * Storage metadata for a Storage object.
@@ -137,78 +137,78 @@ export interface StorageMetadata {
     /**
      * The bucket this object is contained in.
      */
-    bucket: string;
+    readonly bucket: string;
     /**
      * The full path of this object.
      *
      * For example, if a file is at the path '<bucket>/full/path/image.png', the pathString is 'full/path/image.png'.
      */
-    fullPath: string;
+    readonly fullPath: string;
     /**
      * The object's generation.
      * {@link https://cloud.google.com/storage/docs/metadata#generation-number}
      */
-    generation: string;
+    readonly generation: string;
     /**
      * The object's metageneration.
      * {@link https://cloud.google.com/storage/docs/metadata#generation-number}
      */
-    metageneration: string;
+    readonly metageneration: string;
     /**
      * The short name of this object, which is the last component of the full path.
      * For example, if fullPath is 'full/path/image.png', name is 'image.png'.
      */
-    name: string;
+    readonly name: string;
     /**
      * The size of this object, in bytes.
      */
-    size: number;
+    readonly size: number;
     /**
      * A date string representing when this object was created.
      */
-    timeCreated: ISO8601DateString;
+    readonly timeCreated: ISO8601DateString;
     /**
      * A date string representing when this object was last updated.
      */
-    updated: ISO8601DateString;
+    readonly updated: ISO8601DateString;
     /**
      * A Base64-encoded MD5 hash of the object being uploaded.
      */
-    md5Hash?: string | undefined;
+    readonly md5Hash?: string | undefined;
     /**
      * Served as the 'Cache-Control' header on object download.
      */
-    cacheControl?: string | undefined;
+    readonly cacheControl?: string | undefined;
     /**
      * Served as the 'Content-Disposition' header on object download.
      */
-    contentDisposition?: string | undefined;
+    readonly contentDisposition?: string | undefined;
     /**
      * Served as the 'Content-Encoding' header on object download.
      */
-    contentEncoding?: string | undefined;
+    readonly contentEncoding?: string | undefined;
     /**
      * Served as the 'Content-Language' header on object download.
      */
-    contentLanguage?: string | undefined;
+    readonly contentLanguage?: string | undefined;
     /**
      * Served as the 'Content-Type' header on object download.
      */
-    contentType?: string | undefined;
+    readonly contentType?: string | undefined;
     /**
      * Any user-specified custom metdata.
      */
-    customMetadata?: StorageCustomMetadata | undefined;
+    readonly customMetadata?: StorageCustomMetadata | undefined;
 }
 /**
  * Additional user-defined custom metadata.
  */
 export type StorageCustomMetadata = {
-    [key: string]: string;
+    readonly [key: string]: string;
 };
 export interface StorageDeleteFileOptions {
     /**
      * Ignores errors related to the file not existing.
      */
-    ignoreNotFound?: boolean;
+    readonly ignoreNotFound?: boolean;
 }

package/test/CHANGELOG.md

@@ -2,6 +2,10 @@
 
 This file was generated using [@jscutlery/semver](https://github.com/jscutlery/semver).
 
+## [10.0.20](https://github.com/dereekb/dbx-components/compare/v10.0.19-dev...v10.0.20) (2024-02-15)
+
+
+
 ## [10.0.19](https://github.com/dereekb/dbx-components/compare/v10.0.18-dev...v10.0.19) (2024-02-13)
 
 

package/test/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@dereekb/firebase/test",
-  "version": "10.0.19",
+  "version": "10.0.20",
   "type": "commonjs",
   "peerDependencies": {
     "@dereekb/util": "*",