@dereekb/firebase 10.0.19 → 10.0.21

package/index.cjs.js

@@ -4105,8 +4105,14 @@ function firestoreObjectArray(config) {
   const sortFn = util.sortValuesFunctionOrMapIdentityWithSortRef(config);
   const {
     from,
-    to
+    to: baseTo
   } = util.toModelMapFunctions(objectField);
+  const to = x => {
+    // remove null/undefined values from each field when converting to in order to mirror firestore usage (undefined is treated like null)
+    const base = baseTo(x);
+    const filtered = util.filterNullAndUndefinedValues(base);
+    return filtered;
+  };
   return firestoreField({
     default: (_b = config.default) !== null && _b !== void 0 ? _b : () => [],
     defaultBeforeSave: config.defaultBeforeSave,
@@ -4846,6 +4852,7 @@ function iterateFirestoreDocumentSnapshots(config) {
       snapshotsPerformTasksConfig
     } = config;
     return iterateFirestoreDocumentSnapshotBatches(Object.assign(Object.assign({}, config), {
+      maxParallelCheckpoints: 1,
       iterateSnapshotBatch: docSnapshots => __awaiter(this, void 0, void 0, function* () {
         const performTasksResult = yield util.performAsyncTasks(docSnapshots, iterateSnapshot, Object.assign({
           sequential: true
@@ -4873,6 +4880,7 @@ function iterateFirestoreDocumentSnapshotPairBatches(config) {
       documentAccessor
     } = config;
     return iterateFirestoreDocumentSnapshotBatches(Object.assign(Object.assign({}, config), {
+      maxParallelCheckpoints: 1,
       iterateSnapshotBatch: snapshots => __awaiter(this, void 0, void 0, function* () {
         const pairs = snapshots.map(snapshot => {
           const document = documentAccessor.loadDocument(snapshot.ref);
@@ -4942,16 +4950,28 @@ function iterateFirestoreDocumentSnapshotCheckpoints(config) {
   return __awaiter(this, void 0, void 0, function* () {
     const {
       iterateCheckpoint,
+      waitBetweenCheckpoints,
       useCheckpointResult,
       constraintsFactory: inputConstraintsFactory,
+      dynamicConstraints: inputDynamicConstraints,
       queryFactory,
+      maxParallelCheckpoints = 1,
       limitPerCheckpoint,
       totalSnapshotsLimit = Number.MAX_SAFE_INTEGER
     } = config;
-    const constraintsFactory = util.asGetter(inputConstraintsFactory);
-    let i = 0;
-    function iterateFromCursor(cursorDocument) {
+    const constraintsInputIsFactory = typeof inputConstraintsFactory === 'function';
+    const constraintsFactory = constraintsInputIsFactory && inputDynamicConstraints !== false ? inputConstraintsFactory : util.asGetter(util.getValueFromGetter(inputConstraintsFactory));
+    let currentIndex = 0;
+    let hasReachedEnd = false;
+    let totalSnapshotsVisited = 0;
+    let cursorDocument;
+    function taskInputFactory() {
       return __awaiter(this, void 0, void 0, function* () {
+        // Perform another query, then pass the results to the task factory.
+        if (hasReachedEnd) {
+          return null; // issue no more tasks
+        }
+
         const constraints = constraintsFactory();
         const startAfterFilter = cursorDocument ? startAfter(cursorDocument) : undefined;
         if (startAfterFilter) {
@@ -4962,6 +4982,29 @@ function iterateFirestoreDocumentSnapshotCheckpoints(config) {
         }
         const query = queryFactory.query(constraints);
         const docQuerySnapshot = yield query.getDocs();
+        const docSnapshots = docQuerySnapshot.docs;
+        cursorDocument = util.lastValue(docSnapshots); // set the next cursor document
+        const newSnapshotsVisited = docSnapshots.length;
+        totalSnapshotsVisited += newSnapshotsVisited;
+        if (!cursorDocument || totalSnapshotsVisited > totalSnapshotsLimit) {
+          hasReachedEnd = true; // mark as having reached the end
+        }
+
+        const i = currentIndex;
+        currentIndex += 1; // increase our current index
+        return {
+          i,
+          docQuerySnapshot
+        };
+      });
+    }
+    const performTaskFn = util.performTasksFromFactoryInParallelFunction({
+      maxParallelTasks: maxParallelCheckpoints,
+      waitBetweenTasks: waitBetweenCheckpoints,
+      taskFactory: ({
+        i,
+        docQuerySnapshot
+      }) => __awaiter(this, void 0, void 0, function* () {
         const docSnapshots = docQuerySnapshot.docs;
         const results = yield iterateCheckpoint(docSnapshots, docQuerySnapshot);
         const checkpointResults = {
@@ -4970,30 +5013,12 @@ function iterateFirestoreDocumentSnapshotCheckpoints(config) {
           results,
           docSnapshots
         };
-        return checkpointResults;
-      });
-    }
-    let cursorDocument;
-    let totalSnapshotsVisited = 0;
-    while (true) {
-      const iterateResults = yield iterateFromCursor(cursorDocument);
-      yield useCheckpointResult === null || useCheckpointResult === void 0 ? void 0 : useCheckpointResult(iterateResults);
-      const newSnapshotsVisited = iterateResults.docSnapshots.length;
-      const hasResults = newSnapshotsVisited > 0;
-      if (hasResults) {
-        cursorDocument = hasResults ? util.lastValue(iterateResults.docSnapshots) : undefined;
-        i += 1;
-        totalSnapshotsVisited += newSnapshotsVisited;
-        // if at the limit, bail out
-        if (totalSnapshotsVisited > totalSnapshotsLimit) {
-          break;
-        }
-      } else {
-        break;
-      }
-    }
+        yield useCheckpointResult === null || useCheckpointResult === void 0 ? void 0 : useCheckpointResult(checkpointResults);
+      })
+    });
+    yield performTaskFn(taskInputFactory);
     const result = {
-      totalCheckpoints: i,
+      totalCheckpoints: currentIndex,
       totalSnapshotsVisited
     };
     return result;

package/index.esm.js

@@ -1,5 +1,5 @@
 import { increment, onSnapshot, getDoc, deleteDoc, setDoc, updateDoc, doc, collectionGroup, collection, runTransaction, writeBatch, limit as limit$1, limitToLast as limitToLast$1, orderBy as orderBy$1, documentId, where as where$1, startAt as startAt$1, startAfter as startAfter$1, endAt as endAt$1, endBefore as endBefore$1, getDocs, query } from 'firebase/firestore';
-import { cachedGetter, mergeModifiers, asArray, filterUndefinedValues, objectHasNoKeys, filterFalsyAndEmptyValues, build, wrapUseAsyncFunction, makeWithFactory, performMakeLoop, runAsyncTasksForValues, filterMaybeValues, useAsync, toModelFieldConversions, makeModelMapFunctions, modifyModelMapFunctions, assignValuesToPOJOFunction, KeyValueTypleValueFilter, asObjectCopyFactory, passThrough, isEqualToValueDecisionFunction, transformStringFunctionConfig, transformStringFunction, isDate, transformNumberFunction, sortValuesFunctionOrMapIdentityWithSortRef, isMapIdentityFunction, chainMapSameFunctions, filterUniqueFunction, unique, filterUniqueTransform, filterFromPOJOFunction, mapObjectMapFunction, copyObject, mapObjectMap, filterEmptyValues, modelFieldMapFunctions, toModelMapFunctions, latLngStringFunction, DEFAULT_LAT_LNG_STRING_VALUE, sortAscendingIndexNumberRefFunction, bitwiseSetDencoder, convertToArray, pushItemOrArrayItemsIntoArray, separateValues, UTF_8_START_CHARACTER, UTF_PRIVATE_USAGE_AREA_START, mergeArraysIntoArray, lastValue, flattenArrayOrValueArray, performAsyncTasks, batch, asGetter, groupValues, forEachInIterable, arrayToObject, takeFront, isOddNumber, objectToMap, ServerErrorResponse, toReadableError, capitalizeFirstLetter, lowercaseFirstLetter, toRelativeSlashPathStartType, mappedUseFunction, iterableToArray, getValueFromGetter, setContainsAllValues, usePromise, slashPathFactory, errorMessageContainsString } from '@dereekb/util';
+import { cachedGetter, mergeModifiers, asArray, filterUndefinedValues, objectHasNoKeys, filterFalsyAndEmptyValues, build, wrapUseAsyncFunction, makeWithFactory, performMakeLoop, runAsyncTasksForValues, filterMaybeValues, useAsync, toModelFieldConversions, makeModelMapFunctions, modifyModelMapFunctions, assignValuesToPOJOFunction, KeyValueTypleValueFilter, asObjectCopyFactory, passThrough, isEqualToValueDecisionFunction, transformStringFunctionConfig, transformStringFunction, isDate, transformNumberFunction, sortValuesFunctionOrMapIdentityWithSortRef, isMapIdentityFunction, chainMapSameFunctions, filterUniqueFunction, unique, filterUniqueTransform, filterFromPOJOFunction, mapObjectMapFunction, copyObject, mapObjectMap, filterEmptyValues, modelFieldMapFunctions, toModelMapFunctions, latLngStringFunction, DEFAULT_LAT_LNG_STRING_VALUE, sortAscendingIndexNumberRefFunction, bitwiseSetDencoder, filterNullAndUndefinedValues, convertToArray, pushItemOrArrayItemsIntoArray, separateValues, UTF_8_START_CHARACTER, UTF_PRIVATE_USAGE_AREA_START, mergeArraysIntoArray, lastValue, flattenArrayOrValueArray, performAsyncTasks, batch, asGetter, getValueFromGetter, performTasksFromFactoryInParallelFunction, groupValues, forEachInIterable, arrayToObject, takeFront, isOddNumber, objectToMap, ServerErrorResponse, toReadableError, capitalizeFirstLetter, lowercaseFirstLetter, toRelativeSlashPathStartType, mappedUseFunction, iterableToArray, setContainsAllValues, usePromise, slashPathFactory, errorMessageContainsString } from '@dereekb/util';
 import { filterMaybe, lazyFrom, itemAccumulator, ItemPageIterator, MappedPageItemIterationInstance } from '@dereekb/rxjs';
 import { from, map, combineLatest, shareReplay, of, exhaustMap, Observable, switchMap, timer, skip } from 'rxjs';
 import { UNKNOWN_WEBSITE_LINK_TYPE, decodeWebsiteLinkEncodedDataToWebsiteFileLink, encodeWebsiteFileLinkToWebsiteLinkEncodedData, AbstractModelPermissionService, grantedRoleMapReader, noAccessRoleMap, fullAccessRoleMap } from '@dereekb/model';
@@ -4327,8 +4327,14 @@ function firestoreObjectArray(config) {
   const sortFn = sortValuesFunctionOrMapIdentityWithSortRef(config);
   const {
     from,
-    to
+    to: baseTo
   } = toModelMapFunctions(objectField);
+  const to = x => {
+    // remove null/undefined values from each field when converting to in order to mirror firestore usage (undefined is treated like null)
+    const base = baseTo(x);
+    const filtered = filterNullAndUndefinedValues(base);
+    return filtered;
+  };
   return firestoreField({
     default: (_config$default9 = config.default) != null ? _config$default9 : () => [],
     defaultBeforeSave: config.defaultBeforeSave,
@@ -5323,6 +5329,7 @@ async function iterateFirestoreDocumentSnapshots(config) {
     snapshotsPerformTasksConfig
   } = config;
   return iterateFirestoreDocumentSnapshotBatches(Object.assign({}, config, {
+    maxParallelCheckpoints: 1,
     iterateSnapshotBatch: async docSnapshots => {
       const performTasksResult = await performAsyncTasks(docSnapshots, iterateSnapshot, Object.assign({
         sequential: true
@@ -5352,6 +5359,7 @@ async function iterateFirestoreDocumentSnapshotPairBatches(config) {
     documentAccessor
   } = config;
   return iterateFirestoreDocumentSnapshotBatches(Object.assign({}, config, {
+    maxParallelCheckpoints: 1,
     iterateSnapshotBatch: async snapshots => {
       const pairs = snapshots.map(snapshot => {
         const document = documentAccessor.loadDocument(snapshot.ref);
@@ -5436,15 +5444,27 @@ async function iterateFirestoreDocumentSnapshotBatches(config) {
 async function iterateFirestoreDocumentSnapshotCheckpoints(config) {
   const {
     iterateCheckpoint,
+    waitBetweenCheckpoints,
     useCheckpointResult,
     constraintsFactory: inputConstraintsFactory,
+    dynamicConstraints: inputDynamicConstraints,
     queryFactory,
+    maxParallelCheckpoints = 1,
     limitPerCheckpoint,
     totalSnapshotsLimit = Number.MAX_SAFE_INTEGER
   } = config;
-  const constraintsFactory = asGetter(inputConstraintsFactory);
-  let i = 0;
-  async function iterateFromCursor(cursorDocument) {
+  const constraintsInputIsFactory = typeof inputConstraintsFactory === 'function';
+  const constraintsFactory = constraintsInputIsFactory && inputDynamicConstraints !== false ? inputConstraintsFactory : asGetter(getValueFromGetter(inputConstraintsFactory));
+  let currentIndex = 0;
+  let hasReachedEnd = false;
+  let totalSnapshotsVisited = 0;
+  let cursorDocument;
+  async function taskInputFactory() {
+    // Perform another query, then pass the results to the task factory.
+    if (hasReachedEnd) {
+      return null; // issue no more tasks
+    }
+
     const constraints = constraintsFactory();
     const startAfterFilter = cursorDocument ? startAfter(cursorDocument) : undefined;
     if (startAfterFilter) {
@@ -5456,37 +5476,43 @@ async function iterateFirestoreDocumentSnapshotCheckpoints(config) {
     const query = queryFactory.query(constraints);
     const docQuerySnapshot = await query.getDocs();
     const docSnapshots = docQuerySnapshot.docs;
-    const results = await iterateCheckpoint(docSnapshots, docQuerySnapshot);
-    const checkpointResults = {
+    cursorDocument = lastValue(docSnapshots); // set the next cursor document
+
+    const newSnapshotsVisited = docSnapshots.length;
+    totalSnapshotsVisited += newSnapshotsVisited;
+    if (!cursorDocument || totalSnapshotsVisited > totalSnapshotsLimit) {
+      hasReachedEnd = true; // mark as having reached the end
+    }
+
+    const i = currentIndex;
+    currentIndex += 1; // increase our current index
+
+    return {
       i,
-      cursorDocument,
-      results,
-      docSnapshots
+      docQuerySnapshot
     };
-    return checkpointResults;
   }
-  let cursorDocument;
-  let totalSnapshotsVisited = 0;
-  while (true) {
-    const iterateResults = await iterateFromCursor(cursorDocument);
-    await (useCheckpointResult == null ? void 0 : useCheckpointResult(iterateResults));
-    const newSnapshotsVisited = iterateResults.docSnapshots.length;
-    const hasResults = newSnapshotsVisited > 0;
-    if (hasResults) {
-      cursorDocument = hasResults ? lastValue(iterateResults.docSnapshots) : undefined;
-      i += 1;
-      totalSnapshotsVisited += newSnapshotsVisited;
-
-      // if at the limit, bail out
-      if (totalSnapshotsVisited > totalSnapshotsLimit) {
-        break;
-      }
-    } else {
-      break;
+  const performTaskFn = performTasksFromFactoryInParallelFunction({
+    maxParallelTasks: maxParallelCheckpoints,
+    waitBetweenTasks: waitBetweenCheckpoints,
+    taskFactory: async ({
+      i,
+      docQuerySnapshot
+    }) => {
+      const docSnapshots = docQuerySnapshot.docs;
+      const results = await iterateCheckpoint(docSnapshots, docQuerySnapshot);
+      const checkpointResults = {
+        i,
+        cursorDocument,
+        results,
+        docSnapshots
+      };
+      await (useCheckpointResult == null ? void 0 : useCheckpointResult(checkpointResults));
     }
-  }
+  });
+  await performTaskFn(taskInputFactory);
   const result = {
-    totalCheckpoints: i,
+    totalCheckpoints: currentIndex,
     totalSnapshotsVisited
   };
   return result;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@dereekb/firebase",
-  "version": "10.0.19",
+  "version": "10.0.21",
   "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/accumulator.d.ts

@@ -1,4 +1,4 @@
-import { type ItemAccumulatorInstance, type ItemAccumulatorMapFunction, type PageItemIteration } from '@dereekb/rxjs';
+import { type ItemAccumulatorNextPageUntilResultsCountFunction, type ItemAccumulatorInstance, type ItemAccumulatorMapFunction, type PageItemIteration } from '@dereekb/rxjs';
 import { type MapFunction } from '@dereekb/util';
 import { type DocumentDataWithIdAndKey, type QueryDocumentSnapshotArray } from '../types';
 import { type FirestoreItemPageIterationInstance } from './iterator';
@@ -8,6 +8,7 @@ export type FirebaseQuerySnapshotAccumulator<T> = MappedFirebaseQuerySnapshotAcc
  * Mapped accumulator for QueryDocumentSnapshotArray values that returns the DocumentDataWithId values for the items returned in the query.
  */
 export type FirebaseQueryItemAccumulator<T> = MappedFirebaseQuerySnapshotAccumulator<DocumentDataWithIdAndKey<T>[], T>;
+export type FirebaseQueryItemAccumulatorNextPageUntilResultsCountFunction<T> = ItemAccumulatorNextPageUntilResultsCountFunction<DocumentDataWithIdAndKey<T>[]>;
 /**
  * Wrapper for itemAccumulator that has typings for a FirestoreItemPageIterationInstance. Can optionally map the snapshots to another type.
  *

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.