@dereekb/firebase 10.0.19 → 10.0.21

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.iterate.d.ts

@@ -1,4 +1,4 @@
-import { type GetterOrValue, type PromiseOrValue, type IndexRef, type Maybe, type PerformAsyncTasksConfig, type IndexNumber, type PerformAsyncTasksResult, type FactoryWithRequiredInput } from '@dereekb/util';
+import { type GetterOrValue, type PromiseOrValue, type IndexRef, type Maybe, type PerformAsyncTasksConfig, type IndexNumber, type PerformAsyncTasksResult, type FactoryWithRequiredInput, type Milliseconds } from '@dereekb/util';
 import { type FirestoreDocument, type FirestoreDocumentSnapshotDataPair, type LimitedFirestoreDocumentAccessor } from '../accessor';
 import { type QueryDocumentSnapshot, type QuerySnapshot, type DocumentSnapshot } from '../types';
 import { type FirestoreQueryConstraint } from './constraint';
@@ -26,7 +26,7 @@ export declare function iterateFirestoreDocumentSnapshotPairs<T, R, D extends Fi
 /**
  * Config for iterateFirestoreDocumentSnapshots().
  */
-export interface IterateFirestoreDocumentSnapshotsConfig<T, R> extends Omit<IterateFirestoreDocumentSnapshotBatchesConfig<T, IterateFirestoreDocumentSnapshotsResult<T, R>>, 'iterateSnapshotBatch'> {
+export interface IterateFirestoreDocumentSnapshotsConfig<T, R> extends Omit<IterateFirestoreDocumentSnapshotBatchesConfig<T, IterateFirestoreDocumentSnapshotsResult<T, R>>, 'iterateSnapshotBatch' | 'maxParallelCheckpoints'> {
     /**
      * The iterate function per each snapshot individually
      */
@@ -134,6 +134,12 @@ export declare function iterateFirestoreDocumentSnapshotBatches<T, R>(config: It
 export interface IterateFirestoreDocumentSnapshotCheckpointsConfig<T, R> {
     readonly queryFactory: FirestoreQueryFactory<T>;
     readonly constraintsFactory: GetterOrValue<FirestoreQueryConstraint[]>;
+    /**
+     * Whether or not to call the constraints factory each time.
+     *
+     * If the constraintsFactory is a getter then this defaults to true. If constraintsFactory is a value then this is set to false.
+     */
+    readonly dynamicConstraints?: boolean;
     /**
      * Convenience paramenter to add a limit constraint to the query.
      */
@@ -142,6 +148,18 @@ export interface IterateFirestoreDocumentSnapshotCheckpointsConfig<T, R> {
      * The total number of snapshots allowed. Ends on the checkpoint that
      */
     readonly totalSnapshotsLimit?: number;
+    /**
+     * The number of max parallel checkpoints to run.
+     *
+     * By default checkpoints are run serially (max of 1), but can be run in parallel.
+     */
+    readonly maxParallelCheckpoints?: number;
+    /**
+     * The amount of time to add as a delay between beginning a new checkpoint.
+     *
+     * If in parallel this is the minimum amount of time to wait before starting a new checkpoint.
+     */
+    readonly waitBetweenCheckpoints?: Milliseconds;
     /**
      * The iterate function per each snapshot.
      */

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,14 @@
 
 This file was generated using [@jscutlery/semver](https://github.com/jscutlery/semver).
 
+## [10.0.21](https://github.com/dereekb/dbx-components/compare/v10.0.20-dev...v10.0.21) (2024-02-17)
+
+
+
+## [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.21",
   "type": "commonjs",
   "peerDependencies": {
     "@dereekb/util": "*",

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

@@ -187,6 +187,34 @@ function describeFirestoreQueryDriverTests(f) {
                             expect(result.totalSnapshotsVisited).toBe(allMockUserItems.length);
                             expect(mockUserItemsVisited.size).toBe(allMockUserItems.length);
                         }));
+                        describe('maxParallelCheckpoints>1', () => {
+                            it('should process the checkpoints in parallel.', () => tslib_1.__awaiter(this, void 0, void 0, function* () {
+                                const mockUserItemsVisited = new Set();
+                                const batchSize = 1;
+                                const maxParallelCheckpoints = 4;
+                                let currentRunningTasks = 0;
+                                let maxRunningTasks = 0;
+                                const result = yield (0, firebase_1.iterateFirestoreDocumentSnapshotBatches)({
+                                    batchSize,
+                                    limitPerCheckpoint: 1,
+                                    maxParallelCheckpoints,
+                                    iterateSnapshotBatch: (x, batchIndex) => tslib_1.__awaiter(this, void 0, void 0, function* () {
+                                        currentRunningTasks += 1;
+                                        yield (0, util_1.waitForMs)(1000);
+                                        maxRunningTasks = Math.max(maxRunningTasks, currentRunningTasks);
+                                        currentRunningTasks -= 1;
+                                    }),
+                                    useCheckpointResult: (x) => tslib_1.__awaiter(this, void 0, void 0, function* () {
+                                        x.docSnapshots.forEach((y) => mockUserItemsVisited.add(y.ref.path));
+                                    }),
+                                    queryFactory: f.instance.mockItemUserCollectionGroup,
+                                    constraintsFactory: [] // no constraints
+                                });
+                                expect(maxRunningTasks).toBe(maxParallelCheckpoints);
+                                expect(result.totalSnapshotsVisited).toBe(allMockUserItems.length);
+                                expect(mockUserItemsVisited.size).toBe(allMockUserItems.length);
+                            }));
+                        });
                         describe('batchSize=null', () => {
                             it('should iterate with a single batch', () => tslib_1.__awaiter(this, void 0, void 0, function* () {
                                 const mockUserItemsVisited = new Set();