@dereekb/firebase 13.0.5 → 13.0.7

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@dereekb/firebase",
-  "version": "13.0.5",
+  "version": "13.0.7",
   "exports": {
     "./test": {
       "module": "./test/index.esm.js",
@@ -17,10 +17,10 @@
     }
   },
   "peerDependencies": {
-    "@dereekb/date": "13.0.5",
-    "@dereekb/model": "13.0.5",
-    "@dereekb/rxjs": "13.0.5",
-    "@dereekb/util": "13.0.5",
+    "@dereekb/date": "13.0.7",
+    "@dereekb/model": "13.0.7",
+    "@dereekb/rxjs": "13.0.7",
+    "@dereekb/util": "13.0.7",
     "@firebase/rules-unit-testing": "5.0.0",
     "class-transformer": "^0.5.1",
     "class-validator": "^0.15.1",

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

@@ -1,12 +1,13 @@
 import { type Observable, type OperatorFunction } from 'rxjs';
 import { type DocumentDataWithIdAndKey, type DocumentSnapshot } from '../types';
 import { type FirestoreDocument, type FirestoreDocumentData } from './document';
+import { type FirestoreDocumentSnapshotDataPair, type FirestoreDocumentSnapshotDataPairWithData } from './document.utility';
 /**
  * Creates an Observable that emits arrays of document snapshots for multiple documents.
  *
  * This function streams the latest snapshots for each document in the provided array.
  * Each time any document in the array changes, a new array containing the latest snapshots
- * of all documents is emitted. Results are shared with multiple subscribers through shareReplay.
+ * of all documents is emitted.
  *
  * If the input array is empty, an Observable that emits an empty array is returned.
  *
@@ -15,13 +16,29 @@ import { type FirestoreDocument, type FirestoreDocumentData } from './document';
  * @returns Observable that emits arrays of DocumentSnapshots whenever any document changes
  */
 export declare function latestSnapshotsFromDocuments<D extends FirestoreDocument<any>>(documents: D[]): Observable<DocumentSnapshot<FirestoreDocumentData<D>>[]>;
+/**
+ * Creates an Observable that streams and transforms snapshots for multiple documents using `combineLatest`.
+ *
+ * Pipes each document's `accessor.stream()` through the provided `operator` before combining.
+ * This ensures the transformation runs per-document when only one document changes, rather than
+ * re-mapping all snapshots on every emission.
+ *
+ * {@link latestSnapshotsFromDocuments} delegates to this function with an identity operator.
+ *
+ * Returns `of([])` for an empty input array.
+ *
+ * @param documents - Documents to stream from
+ * @param operator - RxJS operator applied to each document's snapshot stream individually
+ * @returns Observable emitting an array of transformed values whenever any document changes
+ */
+export declare function mapLatestSnapshotsFromDocuments<D extends FirestoreDocument<any>, O>(documents: D[], operator: OperatorFunction<DocumentSnapshot<FirestoreDocumentData<D>>, O>): Observable<O[]>;
 /**
  * Creates an Observable that emits arrays of document data for multiple documents.
  *
  * This function streams the latest data for each document in the provided array.
  * Each time any document in the array changes, a new array containing the latest data
  * of all documents is emitted. Document data includes both the document content and
- * metadata like document ID and key. Results are shared with multiple subscribers.
+ * metadata like document ID and key.
  *
  * Non-existent documents are filtered out of the results automatically.
  *
@@ -29,7 +46,7 @@ export declare function latestSnapshotsFromDocuments<D extends FirestoreDocument
  * @param documents - Array of document instances to stream data for
  * @returns Observable that emits arrays of document data whenever any document changes
  */
-export declare function latestDataFromDocuments<D extends FirestoreDocument<any>>(documents: D[]): Observable<DocumentDataWithIdAndKey<FirestoreDocumentData<D>>[]>;
+export declare function streamDocumentSnapshotsData<D extends FirestoreDocument<any>>(documents: D[]): Observable<DocumentDataWithIdAndKey<FirestoreDocumentData<D>>[]>;
 /**
  * Creates an RxJS operator that transforms arrays of DocumentSnapshots into arrays of document data.
  *
@@ -41,3 +58,38 @@ export declare function latestDataFromDocuments<D extends FirestoreDocument<any>
  * @returns An operator that transforms arrays of DocumentSnapshots into arrays of document data
  */
 export declare function dataFromDocumentSnapshots<T>(): OperatorFunction<DocumentSnapshot<T>[], DocumentDataWithIdAndKey<T>[]>;
+/**
+ * Streams {@link FirestoreDocumentSnapshotDataPair}s for multiple documents using `combineLatest`.
+ *
+ * Each document's `accessor.stream()` is individually piped to produce a `{ document, snapshot, data }` triplet,
+ * then all streams are combined via `combineLatest`. This ensures the mapping only runs for the document
+ * that actually changed. The `data` field has `id` and `key` fields injected via {@link documentDataWithIdAndKey},
+ * and will be `undefined` for documents that don't exist in Firestore.
+ *
+ * Returns `of([])` for an empty input array.
+ *
+ * This is the streaming equivalent of {@link import('./document.utility').getDocumentSnapshotDataPairs}.
+ *
+ * @param documents - Documents to stream snapshot-data pairs for
+ * @returns Observable emitting snapshot-data pairs whenever any document changes
+ */
+export declare function streamDocumentSnapshotDataPairs<D extends FirestoreDocument<any>>(documents: D[]): Observable<FirestoreDocumentSnapshotDataPair<D>[]>;
+/**
+ * Streams {@link FirestoreDocumentSnapshotDataPairWithData}s for multiple documents, filtering out non-existent documents.
+ *
+ * Builds on {@link streamDocumentSnapshotDataPairs} and filters each emission to include only pairs where
+ * `data` is non-nullish (i.e., the document exists in Firestore). The filtered array may be shorter than
+ * the input `documents` array and may change length over time as documents are created or deleted.
+ *
+ * Returns `of([])` for an empty input array.
+ *
+ * This is the streaming equivalent of {@link import('./document.utility').getDocumentSnapshotDataPairsWithData}.
+ *
+ * @param documents - Documents to stream snapshot-data pairs for
+ * @returns Observable emitting snapshot-data pairs for existing documents only, whenever any document changes
+ */
+export declare function streamDocumentSnapshotDataPairsWithData<D extends FirestoreDocument<any>>(documents: D[]): Observable<FirestoreDocumentSnapshotDataPairWithData<D>[]>;
+/**
+ * @deprecated Use {@link streamDocumentSnapshotsData} instead.
+ */
+export declare const latestDataFromDocuments: typeof streamDocumentSnapshotsData;