@dereekb/firebase 13.11.2 → 13.11.3

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

@@ -12,6 +12,11 @@ import { type FirestoreDocumentData, type FirestoreDocument, type FirestoreDocum
  * @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
+ * @dbxUtilTags firestore, document, accessor, new, allocate, bulk
+ * @dbxUtilRelated make-documents
  */
 export declare function newDocuments<T, D extends FirestoreDocument<T>>(documentAccessor: FirestoreDocumentAccessor<T, D>, count: number): D[];
 /**
@@ -60,6 +65,12 @@ export interface MakeDocumentsParams<T, D extends FirestoreDocument<T> = Firesto
  * @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
  */
 export declare function makeDocuments<T, D extends FirestoreDocument<T>>(documentAccessor: FirestoreDocumentAccessor<T, D>, make: MakeDocumentsParams<T, D>): Promise<D[]>;
 /**
@@ -70,6 +81,11 @@ export declare function makeDocuments<T, D extends FirestoreDocument<T>>(documen
  *
  * @param documents - Documents to fetch snapshots for
  * @returns Snapshots in the same order as the input array
+ *
+ * @dbxUtil
+ * @dbxUtilCategory firestore
+ * @dbxUtilTags firestore, snapshot, document, fetch, parallel, batch, read
+ * @dbxUtilRelated get-document-snapshot-pair, get-document-snapshot-data-pair
  */
 export declare function getDocumentSnapshots<D extends FirestoreDocument<any>>(documents: D[]): Promise<DocumentSnapshot<FirestoreDocumentData<D>>[]>;
 /**
@@ -93,6 +109,11 @@ export type FirestoreDocumentSnapshotPair<D extends FirestoreDocument<any>> = {
  *
  * @param document - The document to fetch
  * @returns A pair containing the document and its snapshot
+ *
+ * @dbxUtil
+ * @dbxUtilCategory firestore
+ * @dbxUtilTags firestore, snapshot, pair, fetch, document, read
+ * @dbxUtilRelated get-document-snapshot-pairs, get-document-snapshot-data-pair
  */
 export declare function getDocumentSnapshotPair<D extends FirestoreDocument<any>>(document: D): Promise<FirestoreDocumentSnapshotPair<D>>;
 /**
@@ -100,6 +121,11 @@ export declare function getDocumentSnapshotPair<D extends FirestoreDocument<any>
  *
  * @param documents - Documents to fetch
  * @returns Pairs in the same order as the input array
+ *
+ * @dbxUtil
+ * @dbxUtilCategory firestore
+ * @dbxUtilTags firestore, snapshot, pair, fetch, parallel, batch, document
+ * @dbxUtilRelated get-document-snapshot-pair, get-document-snapshot-data-pairs
  */
 export declare function getDocumentSnapshotPairs<D extends FirestoreDocument<any>>(documents: D[]): Promise<FirestoreDocumentSnapshotPair<D>[]>;
 /**
@@ -139,6 +165,11 @@ export interface FirestoreDocumentSnapshotDataPairWithData<D extends FirestoreDo
  *
  * @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
+ * @dbxUtilCategory firestore
+ * @dbxUtilTags firestore, snapshot, data, pair, fetch, document, read, idkey
+ * @dbxUtilRelated get-document-snapshot-data-pairs, get-document-snapshot-pair
  */
 export declare function getDocumentSnapshotDataPair<D extends FirestoreDocument<any>>(document: D): Promise<FirestoreDocumentSnapshotDataPair<D>>;
 /**
@@ -149,6 +180,11 @@ export declare function getDocumentSnapshotDataPair<D extends FirestoreDocument<
  *
  * @param documents - Documents to fetch
  * @returns Triplets in the same order as the input array
+ *
+ * @dbxUtil
+ * @dbxUtilCategory firestore
+ * @dbxUtilTags firestore, snapshot, data, pair, fetch, parallel, batch, idkey
+ * @dbxUtilRelated get-document-snapshot-data-pair, get-document-snapshot-data-pairs-with-data
  */
 export declare function getDocumentSnapshotDataPairs<D extends FirestoreDocument<any>>(documents: D[]): Promise<FirestoreDocumentSnapshotDataPair<D>[]>;
 /**
@@ -159,6 +195,11 @@ export declare function getDocumentSnapshotDataPairs<D extends FirestoreDocument
  *
  * @param documents - Documents to fetch
  * @returns Triplets for documents that exist, in their original relative order
+ *
+ * @dbxUtil
+ * @dbxUtilCategory firestore
+ * @dbxUtilTags firestore, snapshot, data, pair, fetch, batch, exists, filter, idkey
+ * @dbxUtilRelated get-document-snapshot-data-pairs
  */
 export declare function getDocumentSnapshotDataPairsWithData<D extends FirestoreDocument<any>>(documents: D[]): Promise<FirestoreDocumentSnapshotDataPairWithData<D>[]>;
 /**
@@ -175,6 +216,11 @@ export type FirestoreDocumentSnapshotDataTuple<D extends FirestoreDocument<any>>
  *
  * @param documents - Documents to fetch
  * @returns Tuples in the same order as the input array
+ *
+ * @dbxUtil
+ * @dbxUtilCategory firestore
+ * @dbxUtilTags firestore, snapshot, data, tuple, fetch, parallel, batch
+ * @dbxUtilRelated get-document-snapshot-data-pairs
  */
 export declare function getDocumentSnapshotDataTuples<D extends FirestoreDocument<any>>(documents: D[]): Promise<FirestoreDocumentSnapshotDataTuple<D>[]>;
 /**
@@ -188,6 +234,11 @@ export declare function getDocumentSnapshotDataTuples<D extends FirestoreDocumen
  * @param document - The document to fetch data for
  * @param withId - Whether to inject `id` and `key` fields onto the data (default: `true`)
  * @returns The document's data, or `undefined` if it doesn't exist
+ *
+ * @dbxUtil
+ * @dbxUtilCategory firestore
+ * @dbxUtilTags firestore, snapshot, data, fetch, document, read, withid, idkey
+ * @dbxUtilRelated get-document-snapshots-data, get-document-snapshot-data-pair
  */
 export declare function getDocumentSnapshotData<D extends FirestoreDocument<any>>(document: D): Promise<Maybe<DocumentDataWithIdAndKey<FirestoreDocumentData<D>>>>;
 export declare function getDocumentSnapshotData<D extends FirestoreDocument<any>>(document: D, withId: true): Promise<Maybe<DocumentDataWithIdAndKey<FirestoreDocumentData<D>>>>;
@@ -203,6 +254,11 @@ export declare function getDocumentSnapshotData<D extends FirestoreDocument<any>
  * @param documents - Documents to fetch data for
  * @param withId - Whether to inject `id` and `key` fields onto each data object (default: `true`)
  * @returns Data objects for existing documents only
+ *
+ * @dbxUtil
+ * @dbxUtilCategory firestore
+ * @dbxUtilTags firestore, snapshot, data, fetch, parallel, batch, filter, withid, idkey
+ * @dbxUtilRelated get-document-snapshot-data, get-data-from-document-snapshots
  */
 export declare function getDocumentSnapshotsData<D extends FirestoreDocument<any>>(documents: D[]): Promise<DocumentDataWithIdAndKey<FirestoreDocumentData<D>>[]>;
 export declare function getDocumentSnapshotsData<D extends FirestoreDocument<any>>(documents: D[], withId: true): Promise<DocumentDataWithIdAndKey<FirestoreDocumentData<D>>[]>;
@@ -217,6 +273,11 @@ export declare function getDocumentSnapshotsData<D extends FirestoreDocument<any
  * @param snapshots - Snapshots to extract data from
  * @param withId - Whether to inject `id` and `key` fields onto each data object (default: `true`)
  * @returns Data objects for existing documents only (may be shorter than input)
+ *
+ * @dbxUtil
+ * @dbxUtilCategory firestore
+ * @dbxUtilTags firestore, snapshot, data, extract, filter, batch, withid, idkey, mapper
+ * @dbxUtilRelated get-document-snapshots-data, document-data-function
  */
 export declare function getDataFromDocumentSnapshots<T>(snapshots: DocumentSnapshot<T>[]): DocumentDataWithIdAndKey<T>[];
 export declare function getDataFromDocumentSnapshots<T>(snapshots: DocumentSnapshot<T>[], withId: true): DocumentDataWithIdAndKey<T>[];
@@ -231,6 +292,11 @@ export declare function getDataFromDocumentSnapshots<T>(snapshots: DocumentSnaps
  * @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
+ * @dbxUtilTags firestore, document, loader, accessor, snapshot, query, querysnapshot, batch
+ * @dbxUtilRelated load-documents-for-document-references, load-documents-for-keys
  */
 export declare function loadDocumentsForSnapshots<T, D extends FirestoreDocument<T>>(accessor: LimitedFirestoreDocumentAccessor<T, D>, snapshots: QuerySnapshot<T>): D[];
 /**
@@ -242,6 +308,11 @@ export declare function loadDocumentsForSnapshots<T, D extends FirestoreDocument
  * @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
+ * @dbxUtilTags firestore, document, loader, accessor, reference, value, mapper, batch
+ * @dbxUtilRelated load-documents-for-document-references, load-documents-for-keys-from-values, load-documents-for-ids-from-values
  */
 export declare function loadDocumentsForDocumentReferencesFromValues<I, T, D extends FirestoreDocument<T>>(accessor: LimitedFirestoreDocumentAccessor<T, D>, values: I[], getRef: (value: I) => DocumentReference<T>): D[];
 /**
@@ -257,6 +328,11 @@ export declare const loadDocumentsForValues: typeof loadDocumentsForDocumentRefe
  * @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
+ * @dbxUtilTags firestore, document, loader, accessor, reference, batch
+ * @dbxUtilRelated load-documents-for-document-references-from-values, load-documents-for-keys, load-documents-for-snapshots
  */
 export declare function loadDocumentsForDocumentReferences<T, D extends FirestoreDocument<T>>(accessor: LimitedFirestoreDocumentAccessor<T, D>, refs: DocumentReference<T>[]): D[];
 /**
@@ -268,6 +344,11 @@ export declare function loadDocumentsForDocumentReferences<T, D extends Firestor
  * @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
+ * @dbxUtilTags firestore, document, loader, accessor, key, path, value, mapper, batch
+ * @dbxUtilRelated load-documents-for-keys, load-documents-for-document-references-from-values, load-documents-for-ids-from-values
  */
 export declare function loadDocumentsForKeysFromValues<I, T, D extends FirestoreDocument<T>>(accessor: LimitedFirestoreDocumentAccessor<T, D>, values: I[], getKey: (value: I) => FirestoreModelKey): D[];
 /**
@@ -278,6 +359,11 @@ export declare function loadDocumentsForKeysFromValues<I, T, D extends Firestore
  * @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
+ *
+ * @dbxUtil
+ * @dbxUtilCategory firestore
+ * @dbxUtilTags firestore, document, loader, accessor, key, path, batch
+ * @dbxUtilRelated load-documents-for-keys-from-values, load-documents-for-document-references, load-documents-for-ids
  */
 export declare function loadDocumentsForKeys<T, D extends FirestoreDocument<T>>(accessor: LimitedFirestoreDocumentAccessor<T, D>, keys: FirestoreModelKey[]): D[];
 /**
@@ -290,6 +376,11 @@ export declare function loadDocumentsForKeys<T, D extends FirestoreDocument<T>>(
  * @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
+ * @dbxUtilTags firestore, document, loader, accessor, id, value, mapper, batch, collection
+ * @dbxUtilRelated load-documents-for-ids, load-documents-for-keys-from-values, load-documents-for-document-references-from-values
  */
 export declare function loadDocumentsForIdsFromValues<I, T, D extends FirestoreDocument<T>>(accessor: FirestoreDocumentAccessor<T, D>, values: I[], getId: (value: I) => FirestoreModelId): D[];
 /**
@@ -301,6 +392,11 @@ export declare function loadDocumentsForIdsFromValues<I, T, D extends FirestoreD
  * @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
+ *
+ * @dbxUtil
+ * @dbxUtilCategory firestore
+ * @dbxUtilTags firestore, document, loader, accessor, id, batch, collection
+ * @dbxUtilRelated load-documents-for-ids-from-values, load-documents-for-keys, load-documents-for-document-references
  */
 export declare function loadDocumentsForIds<T, D extends FirestoreDocument<T>>(accessor: FirestoreDocumentAccessor<T, D>, ids: FirestoreModelId[]): D[];
 /**
@@ -318,6 +414,13 @@ export type FirestoreDocumentLoader<T, D extends FirestoreDocument<T>> = (refere
  *
  * @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__
+ *
+ * @dbxUtil
+ * @dbxUtilCategory firestore
+ * @dbxUtilKind factory
+ * @dbxUtilTags firestore, document, loader, factory, transaction, accessor, context
+ * @dbxUtilRelated firestore-document-snapshot-pairs-loader, load-documents-for-document-references
  */
 export declare function firestoreDocumentLoader<T, D extends FirestoreDocument<T>>(accessorContext: LimitedFirestoreDocumentAccessorContextExtension<T, D>): FirestoreDocumentLoader<T, D>;
 /**
@@ -345,6 +448,13 @@ export type FirestoreQueryDocumentSnapshotPairsLoader<T, D extends FirestoreDocu
  *
  * @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__
+ *
+ * @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
  */
 export declare function firestoreDocumentSnapshotPairsLoader<T, D extends FirestoreDocument<T>>(accessorContext: LimitedFirestoreDocumentAccessorContextExtension<T, D>): FirestoreDocumentSnapshotPairsLoader<T, D> & FirestoreQueryDocumentSnapshotPairsLoader<T, D>;
 /**
@@ -370,6 +480,13 @@ export type FirestoreDocumentSnapshotPairsLoaderInstance<T, D extends FirestoreD
  *
  * @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__
+ *
+ * @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
  */
 export declare function firestoreDocumentSnapshotPairsLoaderInstance<T, D extends FirestoreDocument<T>>(accessor: LimitedFirestoreDocumentAccessor<T, D>): FirestoreDocumentSnapshotPairsLoaderInstance<T, D>;
 /**
@@ -392,6 +509,11 @@ export declare const firestoreQueryDocumentSnapshotPairsLoader: <T, D extends Fi
  * @param snapshot - The snapshot to extract data from
  * @param withId - Whether to inject `id` and `key` fields (default: `false`)
  * @returns The snapshot data, or `undefined` for non-existent documents
+ *
+ * @dbxUtil
+ * @dbxUtilCategory firestore
+ * @dbxUtilTags firestore, snapshot, data, extract, withid, idkey, mapper
+ * @dbxUtilRelated document-data-with-id-and-key, document-data-function, get-document-snapshot-data
  */
 export declare function documentData<T>(snapshot: QueryDocumentSnapshot<T>): DocumentDataWithIdAndKey<T>;
 export declare function documentData<T>(snapshot: QueryDocumentSnapshot<T>, withId: true): DocumentDataWithIdAndKey<T>;
@@ -418,6 +540,13 @@ export type DocumentDataWithIdAndKeyFunction<T> = ((snapshot: QueryDocumentSnaps
  *
  * @param withId - Whether the returned function should inject `id` and `key` fields
  * @returns A snapshot-to-data extraction function
+ * @__NO_SIDE_EFFECTS__
+ *
+ * @dbxUtil
+ * @dbxUtilCategory firestore
+ * @dbxUtilKind factory
+ * @dbxUtilTags firestore, snapshot, data, factory, mapper, withid, idkey, extract
+ * @dbxUtilRelated document-data, document-data-with-id-and-key, get-data-from-document-snapshots
  */
 export declare function documentDataFunction<T>(withId: true): DocumentDataWithIdAndKeyFunction<T>;
 export declare function documentDataFunction<T>(withId: false): DocumentDataFunction<T>;
@@ -434,6 +563,11 @@ export declare function documentDataFunction<T>(withId: boolean): DocumentDataWi
  *
  * @param snapshot - The snapshot to extract and augment data from
  * @returns The data object with `id` and `key` fields, or `undefined` if the document doesn't exist
+ *
+ * @dbxUtil
+ * @dbxUtilCategory firestore
+ * @dbxUtilTags firestore, snapshot, data, augment, idkey, id, key, mutate, extract
+ * @dbxUtilRelated document-data, set-id-and-key-from-snapshot-on-document-data, document-data-function
  */
 export declare function documentDataWithIdAndKey<T>(snapshot: QueryDocumentSnapshot<T>): DocumentDataWithIdAndKey<T>;
 export declare function documentDataWithIdAndKey<T>(snapshot: DocumentSnapshot<T>): Maybe<DocumentDataWithIdAndKey<T>>;
@@ -446,6 +580,11 @@ export declare function documentDataWithIdAndKey<T>(snapshot: DocumentSnapshot<T
  * @param data - The data object to augment (mutated in-place)
  * @param snapshot - Source of the `id` and `key` values
  * @returns The same data object, now typed as {@link DocumentDataWithIdAndKey}
+ *
+ * @dbxUtil
+ * @dbxUtilCategory firestore
+ * @dbxUtilTags firestore, data, augment, mutate, idkey, id, key, snapshot
+ * @dbxUtilRelated set-id-and-key-from-key-id-ref-on-document-data, document-data-with-id-and-key
  */
 export declare function setIdAndKeyFromSnapshotOnDocumentData<T>(data: T, snapshot: DocumentSnapshot<T>): DocumentDataWithIdAndKey<T>;
 /**
@@ -458,6 +597,11 @@ export declare function setIdAndKeyFromSnapshotOnDocumentData<T>(data: T, snapsh
  * @param data - The data object to augment (mutated in-place)
  * @param modelRef - Source of the `id` and `key` values
  * @returns The same data object, now typed as {@link DocumentDataWithIdAndKey}
+ *
+ * @dbxUtil
+ * @dbxUtilCategory firestore
+ * @dbxUtilTags firestore, data, augment, mutate, idkey, id, key, ref, modelref
+ * @dbxUtilRelated set-id-and-key-from-snapshot-on-document-data
  */
 export declare function setIdAndKeyFromKeyIdRefOnDocumentData<T>(data: T, modelRef: FirestoreModelKeyRef & FirestoreModelIdRef): DocumentDataWithIdAndKey<T>;
 /**
@@ -470,6 +614,11 @@ export declare function setIdAndKeyFromKeyIdRefOnDocumentData<T>(data: T, modelR
  * @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
+ * @dbxUtilTags firestore, snapshot, document, use, async, callback, default, optional
+ * @dbxUtilRelated use-document-snapshot-data, get-document-snapshot-pair
  */
 export declare function useDocumentSnapshot<D extends FirestoreDocument<any>, O = void>(document: Maybe<D>, use: UseAsync<DocumentSnapshot<FirestoreDocumentData<D>>, O>, defaultValue?: Maybe<AsyncGetterOrValue<O>>): Promise<Maybe<O>>;
 /**
@@ -483,6 +632,12 @@ export declare function useDocumentSnapshot<D extends FirestoreDocument<any>, O
  * @param use - Callback that receives the snapshot data and returns a result
  * @param defaultValue - Fallback value when the document is nullish or doesn't exist
  * @returns The result of `use`, or the default value
+ *
+ * @dbxUtil
+ * @dbxUtilCategory firestore
+ * @dbxUtilKind function
+ * @dbxUtilTags firestore, snapshot, data, document, use, async, callback, default
+ * @dbxUtilRelated use-document-snapshot, get-document-snapshot-data
  */
 export declare const useDocumentSnapshotData: <D extends FirestoreDocument<any>, O = void>(document: Maybe<D>, use: UseAsync<FirestoreDocumentData<D>, O>, defaultValue?: Maybe<AsyncGetterOrValue<O>>) => Promise<Maybe<O>>;
 /**
@@ -492,6 +647,12 @@ export declare const useDocumentSnapshotData: <D extends FirestoreDocument<any>,
  *
  * @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
  */
 export declare function firestoreModelIdFromDocument<T, D extends FirestoreDocument<T>>(document: D): FirestoreModelId;
 /**
@@ -499,6 +660,12 @@ export declare function firestoreModelIdFromDocument<T, D extends FirestoreDocum
  *
  * @param documents - Documents to extract IDs from
  * @returns Array of document IDs in the same order as the input
+ * @__NO_SIDE_EFFECTS__
+ *
+ * @dbxUtil
+ * @dbxUtilCategory firestore
+ * @dbxUtilTags firestore, document, id, accessor, batch, mapper
+ * @dbxUtilRelated firestore-model-id-from-document, firestore-model-keys-from-documents
  */
 export declare function firestoreModelIdsFromDocuments<T, D extends FirestoreDocument<T>>(documents: D[]): FirestoreModelId[];
 /**
@@ -508,6 +675,12 @@ export declare function firestoreModelIdsFromDocuments<T, D extends FirestoreDoc
  *
  * @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
  */
 export declare function firestoreModelKeyFromDocument<T, D extends FirestoreDocument<T>>(document: D): FirestoreModelKey;
 /**
@@ -515,6 +688,12 @@ export declare function firestoreModelKeyFromDocument<T, D extends FirestoreDocu
  *
  * @param documents - Documents to extract keys from
  * @returns Array of full Firestore paths in the same order as the input
+ * @__NO_SIDE_EFFECTS__
+ *
+ * @dbxUtil
+ * @dbxUtilCategory firestore
+ * @dbxUtilTags firestore, document, key, path, accessor, batch, mapper
+ * @dbxUtilRelated firestore-model-key-from-document, firestore-model-ids-from-documents
  */
 export declare function firestoreModelKeysFromDocuments<T, D extends FirestoreDocument<T>>(documents: D[]): FirestoreModelKey[];
 /**
@@ -524,6 +703,11 @@ export declare function firestoreModelKeysFromDocuments<T, D extends FirestoreDo
  *
  * @param document - The document to extract the reference from
  * @returns The underlying Firestore document reference
+ *
+ * @dbxUtil
+ * @dbxUtilCategory firestore
+ * @dbxUtilTags firestore, document, reference, accessor, mapper
+ * @dbxUtilRelated document-references-from-documents, firestore-model-key-from-document
  */
 export declare function documentReferenceFromDocument<T, D extends FirestoreDocument<T>>(document: D): DocumentReference<T>;
 /**
@@ -531,6 +715,11 @@ export declare function documentReferenceFromDocument<T, D extends FirestoreDocu
  *
  * @param documents - Documents to extract references from
  * @returns Array of document references in the same order as the input
+ *
+ * @dbxUtil
+ * @dbxUtilCategory firestore
+ * @dbxUtilTags firestore, document, reference, accessor, batch, mapper
+ * @dbxUtilRelated document-reference-from-document, firestore-model-keys-from-documents
  */
 export declare function documentReferencesFromDocuments<T, D extends FirestoreDocument<T>>(documents: D[]): DocumentReference<T>[];
 /**
@@ -603,6 +792,11 @@ 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.
  *
+ * @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
  *
@@ -620,5 +814,6 @@ 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

@@ -18,5 +18,6 @@ export type IncrementUpdateWithAccessorFunction<T> = (data: FirestoreAccessorInc
  * @returns A function that applies increment updates to the document
  *
  * @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/accessor/index.d.ts

@@ -10,6 +10,7 @@ export * from './context.transaction';
 export * from './context';
 export * from './converter';
 export * from './document';
+export * from './document.paged';
 export * from './document.utility';
 export * from './document.rxjs';
 export * from './increment';

package/src/lib/common/firestore/cache/cache.d.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>;
 /**

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

@@ -101,6 +101,7 @@ export interface MakeFirestoreContextCacheConfig {
  *   createDelegate: () => inMemoryFirestoreCollectionCacheDelegate()
  * });
  * ```
+ * @__NO_SIDE_EFFECTS__
  */
 export declare function makeFirestoreContextCache(config: MakeFirestoreContextCacheConfig): FirestoreContextCache;
 /**
@@ -116,6 +117,7 @@ export declare function makeFirestoreContextCache(config: MakeFirestoreContextCa
  * const factory = inMemoryFirestoreContextCacheFactory();
  * const contextCache = factory({ defaultTtl: 60000 });
  * ```
+ * @__NO_SIDE_EFFECTS__
  */
 export declare function inMemoryFirestoreContextCacheFactory(): FirestoreContextCacheFactory;
 /**
@@ -157,6 +159,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;
 /**