@dereekb/dbx-firebase 8.4.0 → 8.5.2

package/lib/model/loader/collection.change.watcher.d.ts

@@ -0,0 +1,52 @@
+import { FirestoreDocument, IterationQueryDocChangeWatcherEvent } from '@dereekb/firebase';
+import { Destroyable } from '@dereekb/util';
+import { Observable } from 'rxjs';
+import { DbxFirebaseCollectionStore } from '../store/store.collection';
+/**
+ * DbxFirebaseCollectionChangeWatcher trigger modes
+ * - auto: will automatically call trigger
+ * - off: will never call trigger
+ */
+export declare type DbxFirebaseCollectionChangeWatcherTriggerMode = 'auto' | 'off';
+export declare type DbxFirebaseCollectionChangeWatcherEvent = Pick<IterationQueryDocChangeWatcherEvent<unknown>, 'time' | 'type'>;
+/**
+ * Used to watch a DbxFirebaseCollectionStore for when the query changes and
+ */
+export interface DbxFirebaseCollectionChangeWatcher {
+    /**
+     * Current mode
+     */
+    readonly mode$: Observable<DbxFirebaseCollectionChangeWatcherTriggerMode>;
+    /**
+     * Stream of events
+     */
+    readonly event$: Observable<DbxFirebaseCollectionChangeWatcherEvent>;
+    readonly hasChangeAvailable$: Observable<boolean>;
+    /**
+     * Current trigger state. Based on the hasChangeAvailable$ state and current mode.
+     */
+    readonly triggered$: Observable<boolean>;
+    /**
+     * Trigger emitter. Only emits when triggered$ is/becomes true.
+     */
+    readonly trigger$: Observable<void>;
+    mode: DbxFirebaseCollectionChangeWatcherTriggerMode;
+}
+/**
+ * DbxFirebaseCollectionChangeWatcher instance
+ */
+export declare class DbxFirebaseCollectionChangeWatcherInstance<T = unknown, D extends FirestoreDocument<T> = FirestoreDocument<T>, S extends DbxFirebaseCollectionStore<T, D> = DbxFirebaseCollectionStore<T, D>> implements Destroyable {
+    readonly store: S;
+    private _mode;
+    private _sub;
+    readonly mode$: Observable<DbxFirebaseCollectionChangeWatcherTriggerMode>;
+    readonly event$: Observable<DbxFirebaseCollectionChangeWatcherEvent>;
+    readonly hasChangeAvailable$: Observable<boolean>;
+    readonly triggered$: Observable<boolean>;
+    readonly trigger$: Observable<void>;
+    constructor(store: S);
+    destroy(): void;
+    get mode(): DbxFirebaseCollectionChangeWatcherTriggerMode;
+    set mode(mode: DbxFirebaseCollectionChangeWatcherTriggerMode);
+}
+export declare function dbxFirebaseCollectionChangeWatcher<T = unknown, D extends FirestoreDocument<T> = FirestoreDocument<T>, S extends DbxFirebaseCollectionStore<T, D> = DbxFirebaseCollectionStore<T, D>>(store: S): DbxFirebaseCollectionChangeWatcherInstance<T, D, S>;

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

@@ -30,10 +30,22 @@ export interface DbxLimitedFirebaseDocumentLoader<T = unknown, D extends Firesto
      * Data from the documents.
      */
     readonly data$: Observable<DocumentDataWithId<T>[]>;
+    /**
+     * Snapshot stream of the documents
+     */
+    readonly snapshotsStream$: Observable<DocumentSnapshot<T>[]>;
+    /**
+     * Data stream of the documents.
+     */
+    readonly dataStream$: Observable<DocumentDataWithId<T>[]>;
     /**
      * Loading state for the document data.
      */
     readonly pageLoadingState$: Observable<PageListLoadingState<DocumentDataWithId<T>>>;
+    /**
+     * Loading state for the streamed document data.
+     */
+    readonly pageLoadingStateStream$: Observable<PageListLoadingState<DocumentDataWithId<T>>>;
     /**
      * Sets the keys of the models to load.
      *

package/lib/model/loader/document.loader.instance.d.ts

@@ -21,7 +21,16 @@ export declare class DbxLimitedFirebaseDocumentLoaderInstance<T = unknown, D ext
     readonly refs$: Observable<DocumentReference<unknown>[]>;
     readonly snapshots$: Observable<DocumentSnapshot<T>[]>;
     readonly data$: Observable<DocumentDataWithId<T>[]>;
+    /**
+     * Snapshot stream of the documents
+     */
+    readonly snapshotsStream$: Observable<DocumentSnapshot<T>[]>;
+    /**
+     * Data streamd of the documents.
+     */
+    readonly dataStream$: Observable<DocumentDataWithId<T>[]>;
     readonly pageLoadingState$: Observable<PageListLoadingState<DocumentDataWithId<T>>>;
+    readonly pageLoadingStateStream$: Observable<PageListLoadingState<DocumentDataWithId<T>>>;
     constructor(_initConfig: DbxFirebaseDocumentLoaderInstanceInitConfig<T, D, A>);
     destroy(): void;
     restart(): void;

package/lib/model/loader/index.d.ts

@@ -1,3 +1,4 @@
+export * from './collection.change.watcher';
 export * from './collection.loader.instance';
 export * from './collection.loader';
 export * from './document.loader.instance';

package/lib/model/store/store.collection.change.directive.d.ts

@@ -1,30 +1,28 @@
-import { Observable } from 'rxjs';
 import { OnDestroy, OnInit } from '@angular/core';
-import { FirestoreDocument, IterationQueryDocChangeWatcherEvent } from '@dereekb/firebase';
+import { FirestoreDocument } from '@dereekb/firebase';
 import { Maybe } from '@dereekb/util';
 import { DbxFirebaseCollectionStore } from './store.collection';
 import { DbxFirebaseCollectionStoreDirective } from './store.collection.directive';
 import { AbstractSubscriptionDirective } from '@dereekb/dbx-core';
+import { DbxFirebaseCollectionChangeWatcher, DbxFirebaseCollectionChangeWatcherEvent, DbxFirebaseCollectionChangeWatcherTriggerMode } from '../loader/collection.change.watcher';
+import { Observable } from 'rxjs';
 import * as i0 from "@angular/core";
-/**
- * Refresh mode
- */
-export declare type DbxFirebaseCollectionChangeDirectiveMode = 'auto' | 'manual';
-export declare type DbxFirebaseCollectionChangeDirectiveEvent = Pick<IterationQueryDocChangeWatcherEvent<unknown>, 'time' | 'type'>;
 /**
  * Used to watch query doc changes and respond to them accordingly.
  */
-export declare class DbxFirebaseCollectionChangeDirective<T = unknown, D extends FirestoreDocument<T> = FirestoreDocument<T>, S extends DbxFirebaseCollectionStore<T, D> = DbxFirebaseCollectionStore<T, D>> extends AbstractSubscriptionDirective implements OnInit, OnDestroy {
+export declare class DbxFirebaseCollectionChangeDirective<T = unknown, D extends FirestoreDocument<T> = FirestoreDocument<T>, S extends DbxFirebaseCollectionStore<T, D> = DbxFirebaseCollectionStore<T, D>> extends AbstractSubscriptionDirective implements DbxFirebaseCollectionChangeWatcher, OnInit, OnDestroy {
     readonly dbxFirebaseCollectionStoreDirective: DbxFirebaseCollectionStoreDirective<T, D, S>;
-    private _mode;
-    readonly mode$: Observable<DbxFirebaseCollectionChangeDirectiveMode>;
-    readonly event$: Observable<DbxFirebaseCollectionChangeDirectiveEvent>;
+    private _watcher;
+    readonly mode$: Observable<DbxFirebaseCollectionChangeWatcherTriggerMode>;
+    readonly event$: Observable<DbxFirebaseCollectionChangeWatcherEvent>;
     readonly hasChangeAvailable$: Observable<boolean>;
+    readonly triggered$: Observable<boolean>;
+    readonly trigger$: Observable<void>;
     constructor(dbxFirebaseCollectionStoreDirective: DbxFirebaseCollectionStoreDirective<T, D, S>);
     ngOnInit(): void;
     ngOnDestroy(): void;
-    get mode(): DbxFirebaseCollectionChangeDirectiveMode;
-    set mode(mode: Maybe<DbxFirebaseCollectionChangeDirectiveMode | ''>);
+    get mode(): DbxFirebaseCollectionChangeWatcherTriggerMode;
+    set mode(mode: Maybe<DbxFirebaseCollectionChangeWatcherTriggerMode | ''>);
     restart(): void;
     static ɵfac: i0.ɵɵFactoryDeclaration<DbxFirebaseCollectionChangeDirective<any, any, any>, never>;
     static ɵdir: i0.ɵɵDirectiveDeclaration<DbxFirebaseCollectionChangeDirective<any, any, any>, "[dbxFirebaseCollectionChange]", never, { "mode": "dbxFirebaseCollectionChange"; }, {}, never>;

package/package.json

@@ -1,18 +1,18 @@
 {
   "name": "@dereekb/dbx-firebase",
-  "version": "8.4.0",
+  "version": "8.5.2",
   "peerDependencies": {
     "@angular/common": "^13.0.0",
     "@angular/core": "^13.0.0",
-    "@dereekb/util": "8.4.0",
+    "@dereekb/util": "8.5.2",
     "firebase": "^9.8.0",
     "rxjs": "^7.0.0",
     "@angular/fire": "^7.4.1",
-    "@dereekb/firebase": "8.4.0",
-    "@dereekb/dbx-core": "8.4.0",
+    "@dereekb/firebase": "8.5.2",
+    "@dereekb/dbx-core": "8.5.2",
     "@angular/material": "^13.0.0",
-    "@dereekb/dbx-web": "8.4.0",
-    "@dereekb/dbx-form": "8.4.0"
+    "@dereekb/dbx-web": "8.5.2",
+    "@dereekb/dbx-form": "8.5.2"
   },
   "dependencies": {
     "tslib": "^2.3.0"