@dereekb/firebase 13.11.13 → 13.11.15

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

@@ -9,9 +9,9 @@ import { type FirestoreDocumentData, type FirestoreDocument, type FirestoreDocum
  * but no data is written to the database. Useful for preparing document references in bulk before
  * deciding what data to write.
  *
- * @param documentAccessor - Accessor that provides the `newDocument()` factory method
- * @param count - Number of document instances to create
- * @returns Array of `count` new document instances, each with a unique auto-generated ID
+ * @param documentAccessor - Accessor that provides the `newDocument()` factory method.
+ * @param count - Number of document instances to create.
+ * @returns Array of `count` new document instances, each with a unique auto-generated ID.
  *
  * @dbxUtil
  * @dbxUtilCategory firestore
@@ -62,15 +62,16 @@ export interface MakeDocumentsParams<T, D extends FirestoreDocument<T> = Firesto
  *
  * Documents are created sequentially (not in parallel) to allow index-dependent logic.
  *
- * @param documentAccessor - Accessor providing the document factory and collection context
- * @param make - Configuration controlling count, factory, and initialization
+ * @param documentAccessor - Accessor providing the document factory and collection context.
+ * @param make - Configuration controlling count, factory, and initialization.
  * @returns Promise resolving to all created document instances (length === `make.count`)
- * @__NO_SIDE_EFFECTS__
  *
  * @dbxUtil
  * @dbxUtilCategory firestore
  * @dbxUtilTags firestore, document, accessor, make, create, persist, bulk, fixture, seed
  * @dbxUtilRelated new-documents
+ *
+ * @__NO_SIDE_EFFECTS__
  */
 export declare function makeDocuments<T, D extends FirestoreDocument<T>>(documentAccessor: FirestoreDocumentAccessor<T, D>, make: MakeDocumentsParams<T, D>): Promise<D[]>;
 /**
@@ -79,8 +80,8 @@ export declare function makeDocuments<T, D extends FirestoreDocument<T>>(documen
  * Each document's `accessor.get()` is called concurrently. The returned array preserves
  * the same ordering as the input `documents` array.
  *
- * @param documents - Documents to fetch snapshots for
- * @returns Snapshots in the same order as the input array
+ * @param documents - Documents to fetch snapshots for.
+ * @returns Snapshots in the same order as the input array.
  *
  * @dbxUtil
  * @dbxUtilCategory firestore
@@ -107,8 +108,8 @@ export type FirestoreDocumentSnapshotPair<D extends FirestoreDocument<any>> = {
 /**
  * Fetches the current snapshot of a single document and pairs it with the document instance.
  *
- * @param document - The document to fetch
- * @returns A pair containing the document and its snapshot
+ * @param document - The document to fetch.
+ * @returns A pair containing the document and its snapshot.
  *
  * @dbxUtil
  * @dbxUtilCategory firestore
@@ -119,8 +120,8 @@ export declare function getDocumentSnapshotPair<D extends FirestoreDocument<any>
 /**
  * Fetches snapshots for multiple documents in parallel and pairs each with its document instance.
  *
- * @param documents - Documents to fetch
- * @returns Pairs in the same order as the input array
+ * @param documents - Documents to fetch.
+ * @returns Pairs in the same order as the input array.
  *
  * @dbxUtil
  * @dbxUtilCategory firestore
@@ -163,7 +164,7 @@ export interface FirestoreDocumentSnapshotDataPairWithData<D extends FirestoreDo
 /**
  * Fetches a document's snapshot, extracts its data with `id`/`key` fields, and returns all three as a triplet.
  *
- * @param document - The document to fetch
+ * @param document - The document to fetch.
  * @returns A triplet of document, snapshot, and data (data may be `undefined` if the document doesn't exist)
  *
  * @dbxUtil
@@ -178,8 +179,8 @@ export declare function getDocumentSnapshotDataPair<D extends FirestoreDocument<
  * Processes up to 200 documents concurrently via {@link runAsyncTasksForValues}.
  * The returned array preserves the same ordering as the input.
  *
- * @param documents - Documents to fetch
- * @returns Triplets in the same order as the input array
+ * @param documents - Documents to fetch.
+ * @returns Triplets in the same order as the input array.
  *
  * @dbxUtil
  * @dbxUtilCategory firestore
@@ -193,8 +194,8 @@ export declare function getDocumentSnapshotDataPairs<D extends FirestoreDocument
  * Convenience wrapper around {@link getDocumentSnapshotDataPairs} that removes entries where `data` is nullish,
  * returning only {@link FirestoreDocumentSnapshotDataPairWithData} results.
  *
- * @param documents - Documents to fetch
- * @returns Triplets for documents that exist, in their original relative order
+ * @param documents - Documents to fetch.
+ * @returns Triplets for documents that exist, in their original relative order.
  *
  * @dbxUtil
  * @dbxUtilCategory firestore
@@ -214,8 +215,8 @@ export type FirestoreDocumentSnapshotDataTuple<D extends FirestoreDocument<any>>
  * and does not inject `id`/`key` fields onto the data. The `data` value is the raw result of
  * `snapshot.data()` and may be `undefined` for non-existent documents.
  *
- * @param documents - Documents to fetch
- * @returns Tuples in the same order as the input array
+ * @param documents - Documents to fetch.
+ * @returns Tuples in the same order as the input array.
  *
  * @dbxUtil
  * @dbxUtilCategory firestore
@@ -289,9 +290,9 @@ export declare function getDataFromDocumentSnapshots<T>(snapshots: DocumentSnaps
  * Maps each document in `snapshots.docs` to a loaded document via `accessor.loadDocument(ref)`.
  * No additional data fetching occurs; the documents are loaded from their existing references.
  *
- * @param accessor - Accessor to load documents with
- * @param snapshots - Query snapshot containing the document references
- * @returns Document instances in the same order as the query results
+ * @param accessor - Accessor to load documents with.
+ * @param snapshots - Query snapshot containing the document references.
+ * @returns Document instances in the same order as the query results.
  *
  * @dbxUtil
  * @dbxUtilCategory firestore
@@ -304,10 +305,10 @@ export declare function loadDocumentsForSnapshots<T, D extends FirestoreDocument
  *
  * Convenience function that maps values through `getRef` then delegates to {@link loadDocumentsForDocumentReferences}.
  *
- * @param accessor - Accessor to load documents with
- * @param values - Source values to extract references from
- * @param getRef - Extracts a document reference from each value
- * @returns Document instances in the same order as the input values
+ * @param accessor - Accessor to load documents with.
+ * @param values - Source values to extract references from.
+ * @param getRef - Extracts a document reference from each value.
+ * @returns Document instances in the same order as the input values.
  *
  * @dbxUtil
  * @dbxUtilCategory firestore
@@ -325,9 +326,9 @@ export declare const loadDocumentsForValues: typeof loadDocumentsForDocumentRefe
  * Each reference is passed to `accessor.loadDocument()` to create a document wrapper.
  * No network calls are made; this only creates in-memory document instances bound to the given references.
  *
- * @param accessor - Accessor to load documents with
- * @param refs - Document references to load
- * @returns Document instances in the same order as the input references
+ * @param accessor - Accessor to load documents with.
+ * @param refs - Document references to load.
+ * @returns Document instances in the same order as the input references.
  *
  * @dbxUtil
  * @dbxUtilCategory firestore
@@ -340,10 +341,10 @@ export declare function loadDocumentsForDocumentReferences<T, D extends Firestor
  *
  * Convenience function that maps values through `getKey` then delegates to {@link loadDocumentsForKeys}.
  *
- * @param accessor - Accessor to load documents with
- * @param values - Source values to extract keys from
- * @param getKey - Extracts a model key (full Firestore path) from each value
- * @returns Document instances in the same order as the input values
+ * @param accessor - Accessor to load documents with.
+ * @param values - Source values to extract keys from.
+ * @param getKey - Extracts a model key (full Firestore path) from each value.
+ * @returns Document instances in the same order as the input values.
  *
  * @dbxUtil
  * @dbxUtilCategory firestore
@@ -356,9 +357,9 @@ export declare function loadDocumentsForKeysFromValues<I, T, D extends Firestore
  *
  * Each key is passed to `accessor.loadDocumentForKey()`. No network calls are made.
  *
- * @param accessor - Accessor to load documents with
+ * @param accessor - Accessor to load documents with.
  * @param keys - Full Firestore document paths (e.g. `'users/abc123'`)
- * @returns Document instances in the same order as the input keys
+ * @returns Document instances in the same order as the input keys.
  *
  * @dbxUtil
  * @dbxUtilCategory firestore
@@ -373,9 +374,9 @@ export declare function loadDocumentsForKeys<T, D extends FirestoreDocument<T>>(
  * Requires a full {@link FirestoreDocumentAccessor} (not limited) because loading by ID requires collection context.
  *
  * @param accessor - Accessor to load documents with (must have collection context for ID resolution)
- * @param values - Source values to extract IDs from
- * @param getId - Extracts a model ID from each value
- * @returns Document instances in the same order as the input values
+ * @param values - Source values to extract IDs from.
+ * @param getId - Extracts a model ID from each value.
+ * @returns Document instances in the same order as the input values.
  *
  * @dbxUtil
  * @dbxUtilCategory firestore
@@ -390,8 +391,8 @@ export declare function loadDocumentsForIdsFromValues<I, T, D extends FirestoreD
  * because ID-based loading needs the collection reference to resolve the full path. No network calls are made.
  *
  * @param accessor - Accessor to load documents with (must have collection context)
- * @param ids - Document IDs within the accessor's collection
- * @returns Document instances in the same order as the input IDs
+ * @param ids - Document IDs within the accessor's collection.
+ * @returns Document instances in the same order as the input IDs.
  *
  * @dbxUtil
  * @dbxUtilCategory firestore
@@ -412,15 +413,16 @@ export type FirestoreDocumentLoader<T, D extends FirestoreDocument<T>> = (refere
  * The returned loader resolves the appropriate accessor based on whether a transaction is provided,
  * then delegates to {@link loadDocumentsForDocumentReferences}.
  *
- * @param accessorContext - Context that provides accessors for both default and transactional use
- * @returns A loader function that converts document references to document instances
- * @__NO_SIDE_EFFECTS__
+ * @param accessorContext - Context that provides accessors for both default and transactional use.
+ * @returns A loader function that converts document references to document instances.
  *
  * @dbxUtil
  * @dbxUtilCategory firestore
  * @dbxUtilKind factory
  * @dbxUtilTags firestore, document, loader, factory, transaction, accessor, context
  * @dbxUtilRelated firestore-document-snapshot-pairs-loader, load-documents-for-document-references
+ *
+ * @__NO_SIDE_EFFECTS__
  */
 export declare function firestoreDocumentLoader<T, D extends FirestoreDocument<T>>(accessorContext: LimitedFirestoreDocumentAccessorContextExtension<T, D>): FirestoreDocumentLoader<T, D>;
 /**
@@ -446,15 +448,16 @@ export type FirestoreQueryDocumentSnapshotPairsLoader<T, D extends FirestoreDocu
  * Also satisfies the {@link FirestoreQueryDocumentSnapshotPairsLoader} type since the implementation
  * handles both {@link DocumentSnapshot} and {@link QueryDocumentSnapshot} inputs.
  *
- * @param accessorContext - Context that provides accessors for both default and transactional use
- * @returns A loader function that converts snapshots to document-snapshot-data pairs
- * @__NO_SIDE_EFFECTS__
+ * @param accessorContext - Context that provides accessors for both default and transactional use.
+ * @returns A loader function that converts snapshots to document-snapshot-data pairs.
  *
  * @dbxUtil
  * @dbxUtilCategory firestore
  * @dbxUtilKind factory
  * @dbxUtilTags firestore, snapshot, pair, loader, factory, transaction, accessor, query, context
  * @dbxUtilRelated firestore-document-snapshot-pairs-loader-instance, firestore-query-document-snapshot-pairs-loader, firestore-document-loader
+ *
+ * @__NO_SIDE_EFFECTS__
  */
 export declare function firestoreDocumentSnapshotPairsLoader<T, D extends FirestoreDocument<T>>(accessorContext: LimitedFirestoreDocumentAccessorContextExtension<T, D>): FirestoreDocumentSnapshotPairsLoader<T, D> & FirestoreQueryDocumentSnapshotPairsLoader<T, D>;
 /**
@@ -478,15 +481,16 @@ export type FirestoreDocumentSnapshotPairsLoaderInstance<T, D extends FirestoreD
  * 2. Loading the document from the snapshot's reference via `accessor.loadDocument()`
  * 3. Combining all three into a single pair object
  *
- * @param accessor - The accessor to bind for document loading
- * @returns A reusable function that converts snapshots to pairs using the bound accessor
- * @__NO_SIDE_EFFECTS__
+ * @param accessor - The accessor to bind for document loading.
+ * @returns A reusable function that converts snapshots to pairs using the bound accessor.
  *
  * @dbxUtil
  * @dbxUtilCategory firestore
  * @dbxUtilKind factory
  * @dbxUtilTags firestore, snapshot, pair, loader, factory, instance, accessor, idkey
  * @dbxUtilRelated firestore-document-snapshot-pairs-loader, document-data-with-id-and-key
+ *
+ * @__NO_SIDE_EFFECTS__
  */
 export declare function firestoreDocumentSnapshotPairsLoaderInstance<T, D extends FirestoreDocument<T>>(accessor: LimitedFirestoreDocumentAccessor<T, D>): FirestoreDocumentSnapshotPairsLoaderInstance<T, D>;
 /**
@@ -578,7 +582,7 @@ export declare function documentDataWithIdAndKey<T>(snapshot: DocumentSnapshot<T
  * is modified in-place and also returned for chaining convenience.
  *
  * @param data - The data object to augment (mutated in-place)
- * @param snapshot - Source of the `id` and `key` values
+ * @param snapshot - Source of the `id` and `key` values.
  * @returns The same data object, now typed as {@link DocumentDataWithIdAndKey}
  *
  * @dbxUtil
@@ -595,7 +599,7 @@ export declare function setIdAndKeyFromSnapshotOnDocumentData<T>(data: T, snapsh
  * The data object is modified in-place and also returned for chaining convenience.
  *
  * @param data - The data object to augment (mutated in-place)
- * @param modelRef - Source of the `id` and `key` values
+ * @param modelRef - Source of the `id` and `key` values.
  * @returns The same data object, now typed as {@link DocumentDataWithIdAndKey}
  *
  * @dbxUtil
@@ -610,10 +614,10 @@ export declare function setIdAndKeyFromKeyIdRefOnDocumentData<T>(data: T, modelR
  * If `document` is nullish, the `use` callback is not invoked and `defaultValue` is returned instead.
  * If `document` exists but the snapshot is nullish (shouldn't happen in practice), `defaultValue` is also used.
  *
- * @param document - The document to fetch, or nullish to skip
- * @param use - Callback that receives the fetched snapshot and returns a result
- * @param defaultValue - Fallback value when `document` is nullish or the snapshot is unavailable
- * @returns The result of `use`, or the default value
+ * @param document - The document to fetch, or nullish to skip.
+ * @param use - Callback that receives the fetched snapshot and returns a result.
+ * @param defaultValue - Fallback value when `document` is nullish or the snapshot is unavailable.
+ * @returns The result of `use`, or the default value.
  *
  * @dbxUtil
  * @dbxUtilCategory firestore
@@ -645,27 +649,29 @@ export declare const useDocumentSnapshotData: <D extends FirestoreDocument<any>,
  *
  * Useful as a mapper function, e.g. `documents.map(firestoreModelIdFromDocument)`.
  *
- * @param document - The document to extract the ID from
+ * @param document - The document to extract the ID from.
  * @returns The document's ID (the last segment of its Firestore path)
- * @__NO_SIDE_EFFECTS__
  *
  * @dbxUtil
  * @dbxUtilCategory firestore
  * @dbxUtilTags firestore, document, id, accessor, mapper, key
  * @dbxUtilRelated firestore-model-ids-from-documents, firestore-model-key-from-document
+ *
+ * @__NO_SIDE_EFFECTS__
  */
 export declare function firestoreModelIdFromDocument<T, D extends FirestoreDocument<T>>(document: D): FirestoreModelId;
 /**
  * Extracts document IDs from an array of {@link FirestoreDocument}s.
  *
- * @param documents - Documents to extract IDs from
- * @returns Array of document IDs in the same order as the input
- * @__NO_SIDE_EFFECTS__
+ * @param documents - Documents to extract IDs from.
+ * @returns Array of document IDs in the same order as the input.
  *
  * @dbxUtil
  * @dbxUtilCategory firestore
  * @dbxUtilTags firestore, document, id, accessor, batch, mapper
  * @dbxUtilRelated firestore-model-id-from-document, firestore-model-keys-from-documents
+ *
+ * @__NO_SIDE_EFFECTS__
  */
 export declare function firestoreModelIdsFromDocuments<T, D extends FirestoreDocument<T>>(documents: D[]): FirestoreModelId[];
 /**
@@ -673,27 +679,29 @@ export declare function firestoreModelIdsFromDocuments<T, D extends FirestoreDoc
  *
  * Useful as a mapper function, e.g. `documents.map(firestoreModelKeyFromDocument)`.
  *
- * @param document - The document to extract the key from
+ * @param document - The document to extract the key from.
  * @returns The document's full Firestore path (e.g. `'users/abc123'`)
- * @__NO_SIDE_EFFECTS__
  *
  * @dbxUtil
  * @dbxUtilCategory firestore
  * @dbxUtilTags firestore, document, key, path, accessor, mapper
  * @dbxUtilRelated firestore-model-keys-from-documents, firestore-model-id-from-document
+ *
+ * @__NO_SIDE_EFFECTS__
  */
 export declare function firestoreModelKeyFromDocument<T, D extends FirestoreDocument<T>>(document: D): FirestoreModelKey;
 /**
  * Extracts full Firestore paths from an array of {@link FirestoreDocument}s.
  *
- * @param documents - Documents to extract keys from
- * @returns Array of full Firestore paths in the same order as the input
- * @__NO_SIDE_EFFECTS__
+ * @param documents - Documents to extract keys from.
+ * @returns Array of full Firestore paths in the same order as the input.
  *
  * @dbxUtil
  * @dbxUtilCategory firestore
  * @dbxUtilTags firestore, document, key, path, accessor, batch, mapper
  * @dbxUtilRelated firestore-model-key-from-document, firestore-model-ids-from-documents
+ *
+ * @__NO_SIDE_EFFECTS__
  */
 export declare function firestoreModelKeysFromDocuments<T, D extends FirestoreDocument<T>>(documents: D[]): FirestoreModelKey[];
 /**
@@ -701,8 +709,8 @@ export declare function firestoreModelKeysFromDocuments<T, D extends FirestoreDo
  *
  * Useful as a mapper function, e.g. `documents.map(documentReferenceFromDocument)`.
  *
- * @param document - The document to extract the reference from
- * @returns The underlying Firestore document reference
+ * @param document - The document to extract the reference from.
+ * @returns The underlying Firestore document reference.
  *
  * @dbxUtil
  * @dbxUtilCategory firestore
@@ -713,8 +721,8 @@ export declare function documentReferenceFromDocument<T, D extends FirestoreDocu
 /**
  * Extracts {@link DocumentReference}s from an array of {@link FirestoreDocument}s.
  *
- * @param documents - Documents to extract references from
- * @returns Array of document references in the same order as the input
+ * @param documents - Documents to extract references from.
+ * @returns Array of document references in the same order as the input.
  *
  * @dbxUtil
  * @dbxUtilCategory firestore
@@ -792,14 +800,14 @@ export interface LimitedFirestoreDocumentAccessorSnapshotCache<T, D extends Fire
  * best suited for short-lived scopes (e.g. a single request or batch operation) where stale reads
  * are acceptable.
  *
+ * @param accessor - The accessor to wrap with caching behavior.
+ * @returns A {@link LimitedFirestoreDocumentAccessorSnapshotCache} backed by the given accessor.
+ *
  * @dbxUtil
  * @dbxUtilCategory firestore
  * @dbxUtilKind factory
  * @dbxUtilTags firestore, cache, snapshot, accessor, deduplicate, memoize, reader
  *
- * @param accessor - The accessor to wrap with caching behavior
- * @returns A {@link LimitedFirestoreDocumentAccessorSnapshotCache} backed by the given accessor
- *
  * @example
  * ```typescript
  * const cache = limitedFirestoreDocumentAccessorSnapshotCache(accessor);
@@ -814,6 +822,7 @@ export interface LimitedFirestoreDocumentAccessorSnapshotCache<T, D extends Fire
  * // Access the underlying accessor directly
  * const doc = cache.accessor.loadDocumentForKey('users/xyz');
  * ```
+ *
  * @__NO_SIDE_EFFECTS__
  */
 export declare function limitedFirestoreDocumentAccessorSnapshotCache<T, D extends FirestoreDocument<T> = FirestoreDocument<T>>(accessor: LimitedFirestoreDocumentAccessor<T, D>): LimitedFirestoreDocumentAccessorSnapshotCache<T, D>;

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

@@ -14,10 +14,11 @@ export type IncrementUpdateWithAccessorFunction<T> = (data: FirestoreAccessorInc
  *
  * Uses Firestore's built-in atomic increment operation, which is safe for concurrent updates.
  *
- * @param accessor - The document accessor to perform the increment on
- * @returns A function that applies increment updates to the document
+ * @param accessor - Accessor used to apply the increment.
+ * @returns Update function that runs the supplied increment operations.
  *
  * @see https://cloud.google.com/firestore/docs/samples/firestore-data-set-numeric-increment
+ *
  * @__NO_SIDE_EFFECTS__
  */
 export declare function incrementUpdateWithAccessorFunction<T>(accessor: FirestoreDocumentDataAccessor<T>): IncrementUpdateWithAccessorFunction<T>;

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

@@ -273,9 +273,9 @@ export interface FirestoreCollectionDocumentCache<T = unknown> {
  * Creates a {@link FirestoreCollectionDocumentCache} that delegates to the given
  * collection cache with the key pre-bound.
  *
- * @param collectionCache - The parent collection cache
- * @param key - The document path to bind
- * @returns A document-scoped cache
+ * @param collectionCache - The parent collection cache.
+ * @param key - The document path to bind.
+ * @returns A document-scoped cache.
  *
  * @example
  * ```ts
@@ -283,6 +283,7 @@ export interface FirestoreCollectionDocumentCache<T = unknown> {
  * docCache.set({ data: userData });
  * const entry = docCache.get();
  * ```
+ *
  * @__NO_SIDE_EFFECTS__
  */
 export declare function firestoreCollectionDocumentCache<T>(collectionCache: FirestoreCollectionCache<T>, key: FirestoreModelKey): FirestoreCollectionDocumentCache<T>;
@@ -343,14 +344,14 @@ export interface FirestoreContextCacheFactoryRef {
  *
  * Used when no cache driver is configured so that `.cache` is always defined.
  *
+ * @returns The singleton noop collection cache.
+ *
  * @example
  * ```ts
  * const cache = noopFirestoreCollectionCache();
  * 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>;
 /**
@@ -359,13 +360,13 @@ export declare function noopFirestoreCollectionCache<T>(): FirestoreCollectionCa
  * Used when no cache factory is configured so that `FirestoreContext.cache` is always defined,
  * avoiding null checks throughout the codebase.
  *
+ * @returns The singleton noop context cache.
+ *
  * @example
  * ```ts
  * const cache = noopFirestoreContextCache();
  * 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

@@ -7,7 +7,7 @@ import { type FirestoreContextCacheFactory, type FirestoreCacheEntry, type Fires
  *
  * Set to 5 minutes.
  */
-export declare const IN_MEMORY_CACHE_DEFAULT_TTL: Milliseconds;
+export declare const DEFAULT_IN_MEMORY_CACHE_TTL: Milliseconds;
 /**
  * Delegate that handles actual cache storage for a single collection.
  *
@@ -38,7 +38,7 @@ export interface FirestoreCollectionCacheDelegate<T> {
 /**
  * Creates an in-memory {@link FirestoreCollectionCacheDelegate} backed by a Map.
  *
- * @returns A Map-backed delegate instance.
+ * @returns Delegate backed by an in-process Map.
  *
  * @example
  * ```ts
@@ -91,8 +91,8 @@ export interface MakeFirestoreContextCacheConfig {
  * This is the shared foundation used by both {@link inMemoryFirestoreContextCache} and
  * {@link readLoggingFirestoreContextCache}.
  *
- * @param config - Configuration including default TTL and delegate factory
- * @returns A new context cache
+ * @param config - Configuration including default TTL and delegate factory.
+ * @returns A new context cache.
  *
  * @example
  * ```ts
@@ -101,6 +101,7 @@ export interface MakeFirestoreContextCacheConfig {
  *   createDelegate: () => inMemoryFirestoreCollectionCacheDelegate()
  * });
  * ```
+ *
  * @__NO_SIDE_EFFECTS__
  */
 export declare function makeFirestoreContextCache(config: MakeFirestoreContextCacheConfig): FirestoreContextCache;
@@ -110,13 +111,14 @@ export declare function makeFirestoreContextCache(config: MakeFirestoreContextCa
  * Uses simple Map-based storage with TTL-based expiration. Suitable for
  * client-side caching where the application lifecycle matches the cache lifecycle.
  *
- * @returns A factory function that creates in-memory context caches
+ * @returns A factory function that creates in-memory context caches.
  *
  * @example
  * ```ts
  * const factory = inMemoryFirestoreContextCacheFactory();
  * const contextCache = factory({ defaultTtl: 60000 });
  * ```
+ *
  * @__NO_SIDE_EFFECTS__
  */
 export declare function inMemoryFirestoreContextCacheFactory(): FirestoreContextCacheFactory;
@@ -133,8 +135,8 @@ export interface InMemoryFirestoreContextCacheConfig {
  * Creates an in-memory {@link FirestoreContextCache} that manages per-collection
  * caches with TTL-based expiration, per-type enable/disable, and event streaming.
  *
- * @param config - Optional configuration
- * @returns A new context cache
+ * @param config - Optional configuration.
+ * @returns A new context cache.
  *
  * @example
  * ```ts
@@ -151,7 +153,7 @@ export declare function inMemoryFirestoreContextCache(config?: InMemoryFirestore
  * Useful for analytics, debugging, and monitoring read patterns without the
  * memory overhead of actual caching.
  *
- * @returns A factory function that creates read-logging context caches
+ * @returns A factory function that creates read-logging context caches.
  *
  * @example
  * ```ts
@@ -159,6 +161,7 @@ export declare function inMemoryFirestoreContextCache(config?: InMemoryFirestore
  * const contextCache = factory();
  * contextCache.events$.subscribe((event) => console.log(event));
  * ```
+ *
  * @__NO_SIDE_EFFECTS__
  */
 export declare function readLoggingFirestoreContextCacheFactory(): FirestoreContextCacheFactory;
@@ -179,8 +182,8 @@ export interface ReadLoggingFirestoreContextCacheConfig {
  * Useful for tracking read patterns, debugging, and monitoring which documents
  * are accessed and how often, without the memory overhead of actual caching.
  *
- * @param config - Optional configuration
- * @returns A new read-logging context cache
+ * @param config - Optional configuration.
+ * @returns A new read-logging context cache.
  *
  * @example
  * ```ts