@dereekb/firebase 13.6.13 → 13.6.15

package/index.cjs.js

@@ -765,11 +765,17 @@ function _ts_generator$l(thisArg, body) {
     get: function get() {
         return undefined;
     },
-    set: function set() {},
-    invalidate: function invalidate() {}
+    set: function set() {
+    // noop
+    },
+    invalidate: function invalidate() {
+    // noop
+    }
 };
 /**
  * Returns the singleton noop {@link FirestoreCollectionDocumentCache}.
+ *
+ * @returns A noop document cache that discards all operations.
  */ function noopFirestoreCollectionDocumentCache() {
     return NOOP_FIRESTORE_COLLECTION_DOCUMENT_CACHE;
 }
@@ -794,13 +800,21 @@ function _ts_generator$l(thisArg, body) {
     get: function get() {
         return undefined;
     },
-    set: function set() {},
-    invalidate: function invalidate() {},
-    clear: function clear() {},
+    set: function set() {
+    // noop
+    },
+    invalidate: function invalidate() {
+    // noop
+    },
+    clear: function clear() {
+    // noop
+    },
     instance: function instance() {
         return NOOP_FIRESTORE_COLLECTION_CACHE_INSTANCE;
     },
-    destroy: function destroy() {}
+    destroy: function destroy() {
+    // noop
+    }
 };
 /**
  * Returns the singleton noop {@link FirestoreCollectionCache} that discards all operations.
@@ -813,6 +827,8 @@ function _ts_generator$l(thisArg, body) {
  * cache.get('path/to/doc'); // always returns undefined
  * cache.set('path/to/doc', { data }); // no-op
  * ```
+ *
+ * @returns The singleton noop collection cache.
  */ function noopFirestoreCollectionCache() {
     return NOOP_FIRESTORE_COLLECTION_CACHE;
 }
@@ -829,14 +845,24 @@ function _ts_generator$l(thisArg, body) {
     isEnabled: function isEnabled() {
         return false;
     },
-    setEnabled: function setEnabled() {},
-    clearAll: function clearAll() {},
+    setEnabled: function setEnabled() {
+    // noop
+    },
+    clearAll: function clearAll() {
+    // noop
+    },
     isEnabledForType: function isEnabledForType() {
         return false;
     },
-    setEnabledForType: function setEnabledForType() {},
-    clearForType: function clearForType() {},
-    destroy: function destroy() {}
+    setEnabledForType: function setEnabledForType() {
+    // noop
+    },
+    clearForType: function clearForType() {
+    // noop
+    },
+    destroy: function destroy() {
+    // noop
+    }
 };
 /**
  * Returns the singleton noop {@link FirestoreContextCache}.
@@ -850,6 +876,8 @@ function _ts_generator$l(thisArg, body) {
  * cache.cacheForCollection('user', { defaultTtl: 0 }); // returns noop collection cache
  * cache.isEnabled(); // false
  * ```
+ *
+ * @returns The singleton noop context cache.
  */ function noopFirestoreContextCache() {
     return NOOP_FIRESTORE_CONTEXT_CACHE;
 }
@@ -2637,6 +2665,8 @@ function _ts_generator$h(thisArg, body) {
 /**
  * Creates an in-memory {@link FirestoreCollectionCacheDelegate} backed by a Map.
  *
+ * @returns A Map-backed delegate instance.
+ *
  * @example
  * ```ts
  * const delegate = inMemoryFirestoreCollectionCacheDelegate<UserData>();
@@ -2663,6 +2693,8 @@ function _ts_generator$h(thisArg, body) {
  *
  * Used by {@link readLoggingFirestoreContextCache} where only event emission matters.
  *
+ * @returns A no-storage delegate that discards all data.
+ *
  * @example
  * ```ts
  * const delegate = noopFirestoreCollectionCacheDelegate<UserData>();
@@ -2672,9 +2704,15 @@ function _ts_generator$h(thisArg, body) {
         get: function get() {
             return undefined;
         },
-        set: function set() {},
-        delete: function _delete() {},
-        clear: function clear() {}
+        set: function set() {
+        // noop
+        },
+        delete: function _delete() {
+        // noop
+        },
+        clear: function clear() {
+        // noop
+        }
     };
 }
 /**
@@ -16398,7 +16436,7 @@ var initializeAllStorageFilesFromUploadsParamsType = arktype.type({
 var initializeStorageFileFromUploadParamsType = arktype.type({
     'bucketId?': model.clearable('string'),
     pathString: 'string > 0',
-    'expediteProcessing?': 'boolean'
+    'expediteProcessing?': model.clearable('boolean')
 });
 var processStorageFileParamsType = targetModelParamsType.merge({
     'runImmediately?': model.clearable('boolean'),
@@ -16441,7 +16479,7 @@ var createStorageFileGroupParamsType = arktype.type({
     'storageFileId?': model.clearable(firestoreModelIdType)
 });
 var syncStorageFileWithGroupsParamsType = targetModelParamsType.merge({
-    'force?': 'boolean'
+    'force?': model.clearable('boolean')
 });
 var syncAllFlaggedStorageFilesWithGroupsParamsType = arktype.type({});
 var updateStorageFileGroupEntryParamsType = arktype.type({
@@ -16452,11 +16490,11 @@ var updateStorageFileGroupParamsType = targetModelParamsType.merge({
     'entries?': model.clearable(updateStorageFileGroupEntryParamsType.array())
 });
 var regenerateStorageFileGroupContentParamsType = targetModelParamsType.merge({
-    'force?': 'boolean'
+    'force?': model.clearable('boolean')
 });
 var regenerateAllFlaggedStorageFileGroupsContentParamsType = arktype.type({});
 var initializeStorageFileModelParamsType = targetModelParamsType.merge({
-    'throwErrorIfAlreadyInitialized?': 'boolean'
+    'throwErrorIfAlreadyInitialized?': model.clearable('boolean')
 });
 var initializeAllApplicableStorageFileGroupsParamsType = arktype.type({});
 var storageFileFunctionTypeConfigMap = {};

package/index.esm.js

@@ -763,11 +763,17 @@ function _ts_generator$l(thisArg, body) {
     get: function get() {
         return undefined;
     },
-    set: function set() {},
-    invalidate: function invalidate() {}
+    set: function set() {
+    // noop
+    },
+    invalidate: function invalidate() {
+    // noop
+    }
 };
 /**
  * Returns the singleton noop {@link FirestoreCollectionDocumentCache}.
+ *
+ * @returns A noop document cache that discards all operations.
  */ function noopFirestoreCollectionDocumentCache() {
     return NOOP_FIRESTORE_COLLECTION_DOCUMENT_CACHE;
 }
@@ -792,13 +798,21 @@ function _ts_generator$l(thisArg, body) {
     get: function get() {
         return undefined;
     },
-    set: function set() {},
-    invalidate: function invalidate() {},
-    clear: function clear() {},
+    set: function set() {
+    // noop
+    },
+    invalidate: function invalidate() {
+    // noop
+    },
+    clear: function clear() {
+    // noop
+    },
     instance: function instance() {
         return NOOP_FIRESTORE_COLLECTION_CACHE_INSTANCE;
     },
-    destroy: function destroy() {}
+    destroy: function destroy() {
+    // noop
+    }
 };
 /**
  * Returns the singleton noop {@link FirestoreCollectionCache} that discards all operations.
@@ -811,6 +825,8 @@ function _ts_generator$l(thisArg, body) {
  * cache.get('path/to/doc'); // always returns undefined
  * cache.set('path/to/doc', { data }); // no-op
  * ```
+ *
+ * @returns The singleton noop collection cache.
  */ function noopFirestoreCollectionCache() {
     return NOOP_FIRESTORE_COLLECTION_CACHE;
 }
@@ -827,14 +843,24 @@ function _ts_generator$l(thisArg, body) {
     isEnabled: function isEnabled() {
         return false;
     },
-    setEnabled: function setEnabled() {},
-    clearAll: function clearAll() {},
+    setEnabled: function setEnabled() {
+    // noop
+    },
+    clearAll: function clearAll() {
+    // noop
+    },
     isEnabledForType: function isEnabledForType() {
         return false;
     },
-    setEnabledForType: function setEnabledForType() {},
-    clearForType: function clearForType() {},
-    destroy: function destroy() {}
+    setEnabledForType: function setEnabledForType() {
+    // noop
+    },
+    clearForType: function clearForType() {
+    // noop
+    },
+    destroy: function destroy() {
+    // noop
+    }
 };
 /**
  * Returns the singleton noop {@link FirestoreContextCache}.
@@ -848,6 +874,8 @@ function _ts_generator$l(thisArg, body) {
  * cache.cacheForCollection('user', { defaultTtl: 0 }); // returns noop collection cache
  * cache.isEnabled(); // false
  * ```
+ *
+ * @returns The singleton noop context cache.
  */ function noopFirestoreContextCache() {
     return NOOP_FIRESTORE_CONTEXT_CACHE;
 }
@@ -2635,6 +2663,8 @@ function _ts_generator$h(thisArg, body) {
 /**
  * Creates an in-memory {@link FirestoreCollectionCacheDelegate} backed by a Map.
  *
+ * @returns A Map-backed delegate instance.
+ *
  * @example
  * ```ts
  * const delegate = inMemoryFirestoreCollectionCacheDelegate<UserData>();
@@ -2661,6 +2691,8 @@ function _ts_generator$h(thisArg, body) {
  *
  * Used by {@link readLoggingFirestoreContextCache} where only event emission matters.
  *
+ * @returns A no-storage delegate that discards all data.
+ *
  * @example
  * ```ts
  * const delegate = noopFirestoreCollectionCacheDelegate<UserData>();
@@ -2670,9 +2702,15 @@ function _ts_generator$h(thisArg, body) {
         get: function get() {
             return undefined;
         },
-        set: function set() {},
-        delete: function _delete() {},
-        clear: function clear() {}
+        set: function set() {
+        // noop
+        },
+        delete: function _delete() {
+        // noop
+        },
+        clear: function clear() {
+        // noop
+        }
     };
 }
 /**
@@ -16396,7 +16434,7 @@ var initializeAllStorageFilesFromUploadsParamsType = type({
 var initializeStorageFileFromUploadParamsType = type({
     'bucketId?': clearable('string'),
     pathString: 'string > 0',
-    'expediteProcessing?': 'boolean'
+    'expediteProcessing?': clearable('boolean')
 });
 var processStorageFileParamsType = targetModelParamsType.merge({
     'runImmediately?': clearable('boolean'),
@@ -16439,7 +16477,7 @@ var createStorageFileGroupParamsType = type({
     'storageFileId?': clearable(firestoreModelIdType)
 });
 var syncStorageFileWithGroupsParamsType = targetModelParamsType.merge({
-    'force?': 'boolean'
+    'force?': clearable('boolean')
 });
 var syncAllFlaggedStorageFilesWithGroupsParamsType = type({});
 var updateStorageFileGroupEntryParamsType = type({
@@ -16450,11 +16488,11 @@ var updateStorageFileGroupParamsType = targetModelParamsType.merge({
     'entries?': clearable(updateStorageFileGroupEntryParamsType.array())
 });
 var regenerateStorageFileGroupContentParamsType = targetModelParamsType.merge({
-    'force?': 'boolean'
+    'force?': clearable('boolean')
 });
 var regenerateAllFlaggedStorageFileGroupsContentParamsType = type({});
 var initializeStorageFileModelParamsType = targetModelParamsType.merge({
-    'throwErrorIfAlreadyInitialized?': 'boolean'
+    'throwErrorIfAlreadyInitialized?': clearable('boolean')
 });
 var initializeAllApplicableStorageFileGroupsParamsType = type({});
 var storageFileFunctionTypeConfigMap = {};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@dereekb/firebase",
-  "version": "13.6.13",
+  "version": "13.6.15",
   "exports": {
     "./test": {
       "module": "./test/index.esm.js",
@@ -17,10 +17,10 @@
     }
   },
   "peerDependencies": {
-    "@dereekb/util": "13.6.13",
-    "@dereekb/date": "13.6.13",
-    "@dereekb/model": "13.6.13",
-    "@dereekb/rxjs": "13.6.13",
+    "@dereekb/util": "13.6.15",
+    "@dereekb/date": "13.6.15",
+    "@dereekb/model": "13.6.15",
+    "@dereekb/rxjs": "13.6.15",
     "@firebase/rules-unit-testing": "5.0.0",
     "arktype": "^2.2.0",
     "date-fns": "^4.0.0",

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

@@ -287,6 +287,8 @@ export interface FirestoreCollectionDocumentCache<T = unknown> {
 export declare function firestoreCollectionDocumentCache<T>(collectionCache: FirestoreCollectionCache<T>, key: FirestoreModelKey): FirestoreCollectionDocumentCache<T>;
 /**
  * Returns the singleton noop {@link FirestoreCollectionDocumentCache}.
+ *
+ * @returns A noop document cache that discards all operations.
  */
 export declare function noopFirestoreCollectionDocumentCache<T>(): FirestoreCollectionDocumentCache<T>;
 /**
@@ -346,6 +348,8 @@ export interface FirestoreContextCacheFactoryRef {
  * cache.get('path/to/doc'); // always returns undefined
  * cache.set('path/to/doc', { data }); // no-op
  * ```
+ *
+ * @returns The singleton noop collection cache.
  */
 export declare function noopFirestoreCollectionCache<T>(): FirestoreCollectionCache<T>;
 /**
@@ -360,5 +364,7 @@ export declare function noopFirestoreCollectionCache<T>(): FirestoreCollectionCa
  * cache.cacheForCollection('user', { defaultTtl: 0 }); // returns noop collection cache
  * cache.isEnabled(); // false
  * ```
+ *
+ * @returns The singleton noop context cache.
  */
 export declare function noopFirestoreContextCache(): FirestoreContextCache;

package/src/lib/common/firestore/cache/cache.memory.d.ts

@@ -38,6 +38,8 @@ export interface FirestoreCollectionCacheDelegate<T> {
 /**
  * Creates an in-memory {@link FirestoreCollectionCacheDelegate} backed by a Map.
  *
+ * @returns A Map-backed delegate instance.
+ *
  * @example
  * ```ts
  * const delegate = inMemoryFirestoreCollectionCacheDelegate<UserData>();
@@ -49,6 +51,8 @@ export declare function inMemoryFirestoreCollectionCacheDelegate<T>(): Firestore
  *
  * Used by {@link readLoggingFirestoreContextCache} where only event emission matters.
  *
+ * @returns A no-storage delegate that discards all data.
+ *
  * @example
  * ```ts
  * const delegate = noopFirestoreCollectionCacheDelegate<UserData>();

package/src/lib/model/storagefile/storagefile.api.d.ts

@@ -43,7 +43,7 @@ export interface InitializeAllStorageFilesFromUploadsResult extends OnCallCreate
 export interface InitializeStorageFileFromUploadParams extends Pick<StoragePath, 'pathString'> {
     readonly bucketId?: Maybe<StorageBucketId>;
     readonly pathString: StorageSlashPath;
-    readonly expediteProcessing?: boolean;
+    readonly expediteProcessing?: Maybe<boolean>;
 }
 export declare const initializeStorageFileFromUploadParamsType: Type<InitializeStorageFileFromUploadParams>;
 /**
@@ -198,7 +198,7 @@ export interface CreateStorageFileGroupParams {
 }
 export declare const createStorageFileGroupParamsType: Type<CreateStorageFileGroupParams>;
 export interface SyncStorageFileWithGroupsParams extends TargetModelParams {
-    readonly force?: boolean;
+    readonly force?: Maybe<boolean>;
 }
 export declare const syncStorageFileWithGroupsParamsType: Type<SyncStorageFileWithGroupsParams>;
 export interface SyncStorageFileWithGroupsResult {
@@ -223,7 +223,7 @@ export interface UpdateStorageFileGroupParams extends TargetModelParams {
 }
 export declare const updateStorageFileGroupParamsType: Type<UpdateStorageFileGroupParams>;
 export interface RegenerateStorageFileGroupContentParams extends TargetModelParams {
-    readonly force?: boolean;
+    readonly force?: Maybe<boolean>;
 }
 export declare const regenerateStorageFileGroupContentParamsType: Type<RegenerateStorageFileGroupContentParams>;
 export interface RegenerateStorageFileGroupContentResult {
@@ -240,7 +240,7 @@ export interface RegenerateAllFlaggedStorageFileGroupsContentResult {
  * Used for initializing an uninitialized model like NotificationBox or NotificationSummary.
  */
 export interface InitializeStorageFileModelParams extends TargetModelParams {
-    readonly throwErrorIfAlreadyInitialized?: boolean;
+    readonly throwErrorIfAlreadyInitialized?: Maybe<boolean>;
 }
 export declare const initializeStorageFileModelParamsType: Type<InitializeStorageFileModelParams>;
 export interface InitializeAllApplicableStorageFileGroupsParams {

package/test/package.json

@@ -1,12 +1,12 @@
 {
   "name": "@dereekb/firebase/test",
-  "version": "13.6.13",
+  "version": "13.6.15",
   "peerDependencies": {
-    "@dereekb/date": "13.6.13",
-    "@dereekb/firebase": "13.6.13",
-    "@dereekb/model": "13.6.13",
-    "@dereekb/rxjs": "13.6.13",
-    "@dereekb/util": "13.6.13",
+    "@dereekb/date": "13.6.15",
+    "@dereekb/firebase": "13.6.15",
+    "@dereekb/model": "13.6.15",
+    "@dereekb/rxjs": "13.6.15",
+    "@dereekb/util": "13.6.15",
     "@firebase/rules-unit-testing": "5.0.0",
     "date-fns": "^4.0.0",
     "firebase": "^12.0.0",