@dereekb/dbx-firebase 9.15.2 → 9.15.3

package/lib/model/store/store.document.d.ts

@@ -1,5 +1,5 @@
 import { Observable, Subscription } from 'rxjs';
-import { DocumentSnapshot, DocumentReference, FirestoreCollection, FirestoreDocument, DocumentDataWithIdAndKey, FirestoreModelId, FirestoreModelKey, FirestoreCollectionLike, FirestoreModelIdentity, FirestoreModelCollectionAndIdPair, FirestoreModelCollectionAndIdPairObject } from '@dereekb/firebase';
+import { DocumentSnapshot, DocumentReference, FirestoreCollection, FirestoreDocument, DocumentDataWithIdAndKey, FirestoreModelId, FirestoreModelKey, FirestoreCollectionLike, FirestoreModelIdentity, FirestoreModelCollectionAndIdPair, FirestoreModelCollectionAndIdPairObject, FirestoreAccessorStreamMode } from '@dereekb/firebase';
 import { LoadingState, ObservableOrValue } from '@dereekb/rxjs';
 import { Maybe } from '@dereekb/util';
 import { LockSetComponent, LockSetComponentStore } from '@dereekb/dbx-core';
@@ -13,6 +13,7 @@ export interface DbxFirebaseDocumentStore<T, D extends FirestoreDocument<T> = Fi
     readonly inputKey$: Observable<FirestoreModelKey>;
     readonly currentInputRef$: Observable<Maybe<DocumentReference<T>>>;
     readonly inputRef$: Observable<DocumentReference<T>>;
+    readonly streamMode$: Observable<FirestoreAccessorStreamMode>;
     readonly currentDocument$: Observable<Maybe<D>>;
     readonly document$: Observable<D>;
     readonly id$: Observable<FirestoreModelId>;
@@ -31,13 +32,26 @@ export interface DbxFirebaseDocumentStore<T, D extends FirestoreDocument<T> = Fi
     readonly currentExists$: Observable<boolean>;
     readonly exists$: Observable<boolean>;
     readonly modelIdentity$: Observable<FirestoreModelIdentity>;
-    setId: (observableOrValue: ObservableOrValue<Maybe<FirestoreModelId>>) => Subscription;
-    setKey: (observableOrValue: ObservableOrValue<Maybe<FirestoreModelKey>>) => Subscription;
-    setRef: (observableOrValue: ObservableOrValue<Maybe<DocumentReference<T>>>) => Subscription;
+    /**
+     * Sets the id of the document to load.
+     */
+    readonly setId: (observableOrValue: ObservableOrValue<Maybe<FirestoreModelId>>) => Subscription;
+    /**
+     * Sets the key of the document to load.
+     */
+    readonly setKey: (observableOrValue: ObservableOrValue<Maybe<FirestoreModelKey>>) => Subscription;
+    /**
+     * Sets the ref of the document to load.
+     */
+    readonly setRef: (observableOrValue: ObservableOrValue<Maybe<DocumentReference<T>>>) => Subscription;
     /**
      * Clears the key/id/ref and current document from the store.
      */
-    clearRefs: () => void;
+    readonly clearRefs: () => void;
+    /**
+     * Sets the stream mode.
+     */
+    readonly setStreamMode: (observableOrValue: ObservableOrValue<FirestoreAccessorStreamMode>) => Subscription;
     /**
      * Sets the FirestoreCollection to retrieve documents from.
      */
@@ -50,6 +64,7 @@ export interface DbxFirebaseDocumentStore<T, D extends FirestoreDocument<T> = Fi
 export interface DbxFirebaseDocumentStoreContextState<T, D extends FirestoreDocument<T> = FirestoreDocument<T>> {
     readonly firestoreCollectionLike?: Maybe<FirestoreCollectionLike<T, D>>;
     readonly firestoreCollection?: Maybe<FirestoreCollection<T, D>>;
+    readonly streamMode?: FirestoreAccessorStreamMode;
     readonly id?: Maybe<FirestoreModelId>;
     readonly key?: Maybe<FirestoreModelKey>;
     readonly ref?: Maybe<DocumentReference<T>>;
@@ -68,6 +83,7 @@ export declare class AbstractDbxFirebaseDocumentStore<T, D extends FirestoreDocu
     readonly inputKey$: Observable<FirestoreModelKey>;
     readonly currentInputRef$: Observable<Maybe<DocumentReference<T>>>;
     readonly inputRef$: Observable<DocumentReference<T>>;
+    readonly streamMode$: Observable<FirestoreAccessorStreamMode>;
     readonly currentDocument$: Observable<Maybe<D>>;
     /**
      * Whether or not an id/ref/key has been input and currentDocument is not null.
@@ -93,18 +109,10 @@ export declare class AbstractDbxFirebaseDocumentStore<T, D extends FirestoreDocu
     readonly exists$: Observable<boolean>;
     readonly doesNotExist$: Observable<boolean>;
     readonly modelIdentity$: Observable<FirestoreModelIdentity>;
-    /**
-     * Sets the id of the document to load.
-     */
     readonly setId: (observableOrValue: Maybe<string> | Observable<Maybe<string>>) => Subscription;
-    /**
-     * Sets the key of the document to load.
-     */
     readonly setKey: (observableOrValue: Maybe<string> | Observable<Maybe<string>>) => Subscription;
-    /**
-     * Sets the ref of the document to load.
-     */
     readonly setRef: (observableOrValue: Maybe<DocumentReference<T>> | Observable<Maybe<DocumentReference<T>>>) => Subscription;
+    readonly setStreamMode: (observableOrValue: FirestoreAccessorStreamMode | Observable<FirestoreAccessorStreamMode>) => Subscription;
     readonly clearRefs: () => void;
     readonly setFirestoreCollection: (() => void) | ((observableOrValue: Maybe<FirestoreCollection<T, D>> | Observable<Maybe<FirestoreCollection<T, D>>>) => Subscription);
     readonly setFirestoreCollectionLike: (() => void) | ((observableOrValue: Maybe<FirestoreCollectionLike<T, D, import("@dereekb/firebase").LimitedFirestoreDocumentAccessor<T, D>>> | Observable<Maybe<FirestoreCollectionLike<T, D, import("@dereekb/firebase").LimitedFirestoreDocumentAccessor<T, D>>>>) => Subscription);

package/lib/model/store/store.document.directive.d.ts

@@ -1,6 +1,6 @@
 import { Provider, Type } from '@angular/core';
-import { DocumentReference, FirestoreDocument } from '@dereekb/firebase';
-import { ModelKey } from '@dereekb/util';
+import { DocumentReference, FirestoreAccessorStreamMode, FirestoreDocument, FirestoreModelKey, FirestoreModelId } from '@dereekb/firebase';
+import { Maybe } from '@dereekb/util';
 import { DbxFirebaseDocumentStore } from './store.document';
 import * as i0 from "@angular/core";
 /**
@@ -18,10 +18,12 @@ export declare abstract class DbxFirebaseDocumentStoreDirective<T = unknown, D e
     readonly snapshotLoadingState$: import("rxjs").Observable<import("../../../../../../dist/packages/rxjs/src").LoadingState<import("@dereekb/firebase").DocumentSnapshot<T>>>;
     readonly data$: import("rxjs").Observable<import("@dereekb/firebase").DocumentDataWithIdAndKey<T>>;
     readonly loadingState$: import("rxjs").Observable<import("../../../../../../dist/packages/rxjs/src").LoadingState<import("@dereekb/firebase").DocumentDataWithIdAndKey<T>>>;
-    set id(id: ModelKey);
-    set ref(ref: DocumentReference<T>);
+    set id(id: Maybe<FirestoreModelId>);
+    set key(key: Maybe<FirestoreModelKey>);
+    set ref(ref: Maybe<DocumentReference<T>>);
+    set streamMode(streamMode: FirestoreAccessorStreamMode);
     static ɵfac: i0.ɵɵFactoryDeclaration<DbxFirebaseDocumentStoreDirective<any, any, any>, never>;
-    static ɵdir: i0.ɵɵDirectiveDeclaration<DbxFirebaseDocumentStoreDirective<any, any, any>, never, never, { "id": "id"; "ref": "ref"; }, {}, never, never, false>;
+    static ɵdir: i0.ɵɵDirectiveDeclaration<DbxFirebaseDocumentStoreDirective<any, any, any>, never, never, { "id": "id"; "key": "key"; "ref": "ref"; "streamMode": "streamMode"; }, {}, never, never, false>;
 }
 /**
  * Configures providers for a DbxFirebaseDocumentStoreDirective.

package/package.json

@@ -1,18 +1,18 @@
 {
   "name": "@dereekb/dbx-firebase",
-  "version": "9.15.2",
+  "version": "9.15.3",
   "peerDependencies": {
     "@angular/common": "^14.0.0",
     "@angular/core": "^14.0.0",
-    "@dereekb/util": "9.15.2",
+    "@dereekb/util": "9.15.3",
     "firebase": "^9.9.2",
     "rxjs": "^7.5.0",
     "@angular/fire": "^7.4.1",
-    "@dereekb/firebase": "9.15.2",
-    "@dereekb/dbx-core": "9.15.2",
+    "@dereekb/firebase": "9.15.3",
+    "@dereekb/dbx-core": "9.15.3",
     "@angular/material": "^14.0.0",
-    "@dereekb/dbx-web": "9.15.2",
-    "@dereekb/dbx-form": "9.15.2"
+    "@dereekb/dbx-web": "9.15.3",
+    "@dereekb/dbx-form": "9.15.3"
   },
   "dependencies": {
     "tslib": "^2.3.0"