@dereekb/dbx-firebase 9.2.0 → 9.3.2

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

@@ -43,6 +43,10 @@ export declare class DbxFirebaseCollectionChangeTriggerInstance<S extends DbxFir
 /**
  * Creates a new DbxFirebaseCollectionChangeWatcher, set the modes to "auto", and creates a new DbxFirebaseCollectionChangeTriggerInstance.
  *
+ * If no trigger function is provided it will default to resetting the store.
+ *
+ * NOTE: Don't forget to initialize the DbxFirebaseCollectionChangeTriggerInstance and handle other lifecycle changes.
+ *
  * @param store
  * @param triggerFunction
  * @returns

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

@@ -1,11 +1,11 @@
-import { DocumentDataWithId, FirestoreItemPageIterationInstance, FirestoreQueryConstraint, IterationQueryDocChangeWatcher } from '@dereekb/firebase';
+import { DocumentDataWithIdAndKey, FirestoreItemPageIterationInstance, FirestoreQueryConstraint, IterationQueryDocChangeWatcher } from '@dereekb/firebase';
 import { PageListLoadingState } from '@dereekb/rxjs';
 import { Maybe, ArrayOrValue } from '@dereekb/util';
 import { Observable } from 'rxjs';
 export interface DbxFirebaseCollectionLoaderAccessor<T = unknown> {
     readonly constraints$: Observable<Maybe<ArrayOrValue<FirestoreQueryConstraint>>>;
     readonly firestoreIteration$: Observable<FirestoreItemPageIterationInstance<T>>;
-    readonly pageLoadingState$: Observable<PageListLoadingState<DocumentDataWithId<T>>>;
+    readonly pageLoadingState$: Observable<PageListLoadingState<DocumentDataWithIdAndKey<T>>>;
     readonly queryChangeWatcher$: Observable<IterationQueryDocChangeWatcher<T>>;
     /**
      * Restarts the loader and refreshes items from the beginning.

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

@@ -1,6 +1,6 @@
 import { PageListLoadingState } from '@dereekb/rxjs';
 import { BehaviorSubject, Subject, Observable } from 'rxjs';
-import { DocumentDataWithId, FirebaseQueryItemAccumulator, FirestoreCollectionLike, FirestoreDocument, FirestoreItemPageIterationInstance, FirestoreItemPageIteratorFilter, FirestoreQueryConstraint, IterationQueryDocChangeWatcher } from '@dereekb/firebase';
+import { DocumentDataWithIdAndKey, DocumentReference, FirebaseQueryItemAccumulator, FirebaseQuerySnapshotAccumulator, FirestoreCollectionLike, FirestoreDocument, FirestoreItemPageIterationInstance, FirestoreItemPageIteratorFilter, FirestoreQueryConstraint, IterationQueryDocChangeWatcher } from '@dereekb/firebase';
 import { ArrayOrValue, Destroyable, Initialized, Maybe } from '@dereekb/util';
 import { DbxFirebaseCollectionLoader, DbxFirebaseCollectionLoaderAccessor } from './collection.loader';
 export interface DbxFirebaseCollectionLoaderInstanceInitConfig<T, D extends FirestoreDocument<T> = FirestoreDocument<T>> {
@@ -26,8 +26,16 @@ export declare class DbxFirebaseCollectionLoaderInstance<T = unknown, D extends
     readonly iteratorFilter$: Observable<FirestoreItemPageIteratorFilter>;
     readonly firestoreIteration$: Observable<FirestoreItemPageIterationInstance<T>>;
     readonly queryChangeWatcher$: Observable<IterationQueryDocChangeWatcher<T>>;
+    readonly snapshotAccumulator$: Observable<FirebaseQuerySnapshotAccumulator<T>>;
+    readonly snapshotAccumulatorDocumentRefs$: Observable<DocumentReference<T>[][]>;
+    readonly snapshotAccumulatorDocuments$: Observable<D[][]>;
     readonly accumulator$: Observable<FirebaseQueryItemAccumulator<T>>;
-    readonly pageLoadingState$: Observable<PageListLoadingState<DocumentDataWithId<T>>>;
+    readonly accumulatorItems$: Observable<DocumentDataWithIdAndKey<T>[][]>;
+    readonly hasDocuments$: Observable<boolean>;
+    readonly allDocumentRefs$: Observable<DocumentReference<T>[]>;
+    readonly allDocuments$: Observable<D[]>;
+    readonly allDocumentData$: Observable<DocumentDataWithIdAndKey<T>[]>;
+    readonly pageLoadingState$: Observable<PageListLoadingState<DocumentDataWithIdAndKey<T>>>;
     constructor(_initConfig?: DbxFirebaseCollectionLoaderInstanceInitConfig<T, D> | undefined);
     init(): void;
     destroy(): void;

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

@@ -1,4 +1,4 @@
-import { DocumentDataWithId, FirestoreModelKey, DocumentReference, FirestoreDocument, FirestoreModelId, DocumentSnapshot } from '@dereekb/firebase';
+import { DocumentDataWithIdAndKey, FirestoreModelKey, DocumentReference, FirestoreDocument, FirestoreModelId, DocumentSnapshot } from '@dereekb/firebase';
 import { ObservableOrValue, PageListLoadingState } from '@dereekb/rxjs';
 import { Maybe, ArrayOrValue } from '@dereekb/util';
 import { Observable } from 'rxjs';
@@ -29,7 +29,7 @@ export interface DbxLimitedFirebaseDocumentLoader<T = unknown, D extends Firesto
     /**
      * Data from the documents.
      */
-    readonly data$: Observable<DocumentDataWithId<T>[]>;
+    readonly data$: Observable<DocumentDataWithIdAndKey<T>[]>;
     /**
      * Snapshot stream of the documents
      */
@@ -37,15 +37,15 @@ export interface DbxLimitedFirebaseDocumentLoader<T = unknown, D extends Firesto
     /**
      * Data stream of the documents.
      */
-    readonly dataStream$: Observable<DocumentDataWithId<T>[]>;
+    readonly dataStream$: Observable<DocumentDataWithIdAndKey<T>[]>;
     /**
      * Loading state for the document data.
      */
-    readonly pageLoadingState$: Observable<PageListLoadingState<DocumentDataWithId<T>>>;
+    readonly pageLoadingState$: Observable<PageListLoadingState<DocumentDataWithIdAndKey<T>>>;
     /**
      * Loading state for the streamed document data.
      */
-    readonly pageLoadingStateStream$: Observable<PageListLoadingState<DocumentDataWithId<T>>>;
+    readonly pageLoadingStateStream$: Observable<PageListLoadingState<DocumentDataWithIdAndKey<T>>>;
     /**
      * Sets the keys of the models to load.
      *

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

@@ -1,6 +1,6 @@
 import { ObservableOrValue, PageListLoadingState, SubscriptionObject } from '@dereekb/rxjs';
 import { BehaviorSubject, Subject, Observable } from 'rxjs';
-import { DocumentDataWithId, DocumentReference, DocumentSnapshot, FirestoreDocument, FirestoreDocumentAccessor, FirestoreModelKey, LimitedFirestoreDocumentAccessor } from '@dereekb/firebase';
+import { DocumentDataWithIdAndKey, DocumentReference, DocumentSnapshot, FirestoreDocument, FirestoreDocumentAccessor, FirestoreModelKey, LimitedFirestoreDocumentAccessor } from '@dereekb/firebase';
 import { ArrayOrValue, Destroyable, Maybe } from '@dereekb/util';
 import { DbxFirebaseDocumentLoader, DbxLimitedFirebaseDocumentLoader } from './document.loader';
 export interface DbxFirebaseDocumentLoaderInstanceInitConfig<T, D extends FirestoreDocument<T> = FirestoreDocument<T>, A extends LimitedFirestoreDocumentAccessor<T, D> = LimitedFirestoreDocumentAccessor<T, D>> {
@@ -20,7 +20,7 @@ export declare class DbxLimitedFirebaseDocumentLoaderInstance<T = unknown, D ext
     readonly ids$: Observable<string[]>;
     readonly refs$: Observable<DocumentReference<unknown>[]>;
     readonly snapshots$: Observable<DocumentSnapshot<T>[]>;
-    readonly data$: Observable<DocumentDataWithId<T>[]>;
+    readonly data$: Observable<DocumentDataWithIdAndKey<T>[]>;
     /**
      * Snapshot stream of the documents
      */
@@ -28,9 +28,9 @@ export declare class DbxLimitedFirebaseDocumentLoaderInstance<T = unknown, D ext
     /**
      * Data streamd of the documents.
      */
-    readonly dataStream$: Observable<DocumentDataWithId<T>[]>;
-    readonly pageLoadingState$: Observable<PageListLoadingState<DocumentDataWithId<T>>>;
-    readonly pageLoadingStateStream$: Observable<PageListLoadingState<DocumentDataWithId<T>>>;
+    readonly dataStream$: Observable<DocumentDataWithIdAndKey<T>[]>;
+    readonly pageLoadingState$: Observable<PageListLoadingState<DocumentDataWithIdAndKey<T>>>;
+    readonly pageLoadingStateStream$: Observable<PageListLoadingState<DocumentDataWithIdAndKey<T>>>;
     constructor(_initConfig: DbxFirebaseDocumentLoaderInstanceInitConfig<T, D, A>);
     destroy(): void;
     restart(): void;

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

@@ -1,5 +1,5 @@
 import { Observable, Subscription } from 'rxjs';
-import { FirebaseQueryItemAccumulator, FirestoreCollectionLike, FirestoreDocument, FirestoreItemPageIterationInstance, FirestoreQueryConstraint, IterationQueryDocChangeWatcher, DocumentDataWithId } from '@dereekb/firebase';
+import { FirebaseQueryItemAccumulator, FirestoreCollectionLike, FirestoreDocument, FirestoreItemPageIterationInstance, FirestoreQueryConstraint, IterationQueryDocChangeWatcher, DocumentDataWithIdAndKey, DocumentReference } from '@dereekb/firebase';
 import { ObservableOrValue, PageListLoadingState } from '@dereekb/rxjs';
 import { ArrayOrValue, Maybe } from '@dereekb/util';
 import { LockSetComponentStore } from '@dereekb/dbx-core';
@@ -12,7 +12,11 @@ export interface DbxFirebaseCollectionStore<T, D extends FirestoreDocument<T> =
     readonly firestoreIteration$: Observable<FirestoreItemPageIterationInstance<T>>;
     readonly queryChangeWatcher$: Observable<IterationQueryDocChangeWatcher<T>>;
     readonly accumulator$: Observable<FirebaseQueryItemAccumulator<T>>;
-    readonly pageLoadingState$: Observable<PageListLoadingState<DocumentDataWithId<T>>>;
+    readonly pageLoadingState$: Observable<PageListLoadingState<DocumentDataWithIdAndKey<T>>>;
+    readonly hasDocuments$: Observable<boolean>;
+    readonly allDocumentRefs$: Observable<DocumentReference<T>[]>;
+    readonly allDocuments$: Observable<D[]>;
+    readonly allDocumentData$: Observable<DocumentDataWithIdAndKey<T>[]>;
     setMaxPages(observableOrValue: ObservableOrValue<Maybe<number>>): Subscription;
     setItemsPerPage(observableOrValue: ObservableOrValue<Maybe<number>>): Subscription;
     setConstraints(observableOrValue: ObservableOrValue<Maybe<ArrayOrValue<FirestoreQueryConstraint>>>): Subscription;
@@ -42,7 +46,11 @@ export declare class AbstractDbxFirebaseCollectionStore<T, D extends FirestoreDo
     readonly firestoreIteration$: Observable<FirestoreItemPageIterationInstance<T>>;
     readonly queryChangeWatcher$: Observable<IterationQueryDocChangeWatcher<T>>;
     readonly accumulator$: Observable<FirebaseQueryItemAccumulator<T>>;
-    readonly pageLoadingState$: Observable<PageListLoadingState<DocumentDataWithId<T>>>;
+    readonly pageLoadingState$: Observable<PageListLoadingState<DocumentDataWithIdAndKey<T>>>;
+    readonly hasDocuments$: Observable<boolean>;
+    readonly allDocumentRefs$: Observable<DocumentReference<T>[]>;
+    readonly allDocuments$: Observable<D[]>;
+    readonly allDocumentData$: Observable<DocumentDataWithIdAndKey<T>[]>;
     readonly setFirestoreCollection: (() => void) | ((observableOrValue: FirestoreCollectionLike<T, D, import("@dereekb/firebase").LimitedFirestoreDocumentAccessor<T, D>> | Observable<FirestoreCollectionLike<T, D, import("@dereekb/firebase").LimitedFirestoreDocumentAccessor<T, D>> | null | undefined> | null | undefined) => Subscription);
     static ɵfac: i0.ɵɵFactoryDeclaration<AbstractDbxFirebaseCollectionStore<any, any, any>, never>;
     static ɵprov: i0.ɵɵInjectableDeclaration<AbstractDbxFirebaseCollectionStore<any, any, any>>;

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

@@ -9,7 +9,7 @@ import * as i0 from "@angular/core";
 export declare abstract class DbxFirebaseCollectionStoreDirective<T = unknown, D extends FirestoreDocument<T> = FirestoreDocument<T>, S extends DbxFirebaseCollectionStore<T, D> = DbxFirebaseCollectionStore<T, D>> {
     readonly store: S;
     constructor(store: S);
-    readonly pageLoadingState$: import("rxjs").Observable<import("../../../../../../dist/packages/rxjs/src").PageListLoadingState<import("@dereekb/firebase").DocumentDataWithId<T>>>;
+    readonly pageLoadingState$: import("rxjs").Observable<import("../../../../../../dist/packages/rxjs/src").PageListLoadingState<import("@dereekb/firebase").DocumentDataWithIdAndKey<T>>>;
     set maxPages(maxPages: Maybe<number>);
     set itemsPerPage(itemsPerPage: Maybe<number>);
     set constraints(constraints: Maybe<ArrayOrValue<FirestoreQueryConstraint>>);

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

@@ -1,5 +1,5 @@
 import { Observable, Subscription } from 'rxjs';
-import { DocumentSnapshot, DocumentReference, FirestoreCollection, FirestoreDocument, DocumentDataWithId, FirestoreModelId, FirestoreModelKey, FirestoreCollectionLike, FirestoreModelIdentity, FirestoreModelCollectionAndIdPair, FirestoreModelCollectionAndIdPairObject } from '@dereekb/firebase';
+import { DocumentSnapshot, DocumentReference, FirestoreCollection, FirestoreDocument, DocumentDataWithIdAndKey, FirestoreModelId, FirestoreModelKey, FirestoreCollectionLike, FirestoreModelIdentity, FirestoreModelCollectionAndIdPair, FirestoreModelCollectionAndIdPairObject } from '@dereekb/firebase';
 import { LoadingState, ObservableOrValue } from '@dereekb/rxjs';
 import { Maybe } from '@dereekb/util';
 import { LockSetComponent, LockSetComponentStore } from '@dereekb/dbx-core';
@@ -18,15 +18,17 @@ export interface DbxFirebaseDocumentStore<T, D extends FirestoreDocument<T> = Fi
     readonly id$: Observable<FirestoreModelId>;
     readonly key$: Observable<FirestoreModelKey>;
     readonly ref$: Observable<DocumentReference<T>>;
+    readonly hasRef$: Observable<boolean>;
     readonly keyModelIds$: Observable<FirestoreModelId[]>;
     readonly keyPairs$: Observable<FirestoreModelCollectionAndIdPair[]>;
     readonly keyPairObject$: Observable<FirestoreModelCollectionAndIdPairObject>;
     readonly documentLoadingState$: Observable<LoadingState<D>>;
     readonly snapshot$: Observable<DocumentSnapshot<T>>;
     readonly snapshotLoadingState$: Observable<LoadingState<DocumentSnapshot<T>>>;
-    readonly currentData$: Observable<Maybe<DocumentDataWithId<T>>>;
-    readonly data$: Observable<DocumentDataWithId<T>>;
-    readonly dataLoadingState$: Observable<LoadingState<DocumentDataWithId<T>>>;
+    readonly currentData$: Observable<Maybe<DocumentDataWithIdAndKey<T>>>;
+    readonly data$: Observable<DocumentDataWithIdAndKey<T>>;
+    readonly dataLoadingState$: Observable<LoadingState<DocumentDataWithIdAndKey<T>>>;
+    readonly currentExists$: Observable<boolean>;
     readonly exists$: Observable<boolean>;
     readonly modelIdentity$: Observable<FirestoreModelIdentity>;
     setId: (observableOrValue: ObservableOrValue<Maybe<FirestoreModelId>>) => Subscription;
@@ -67,6 +69,10 @@ export declare class AbstractDbxFirebaseDocumentStore<T, D extends FirestoreDocu
     readonly currentInputRef$: Observable<Maybe<DocumentReference<T>>>;
     readonly inputRef$: Observable<DocumentReference<T>>;
     readonly currentDocument$: Observable<Maybe<D>>;
+    /**
+     * Whether or not an id/ref/key has been input and currentDocument is not null.
+     */
+    readonly hasRef$: Observable<boolean>;
     readonly document$: Observable<D>;
     readonly documentLoadingState$: Observable<LoadingState<D>>;
     readonly id$: Observable<FirestoreModelId>;
@@ -77,9 +83,13 @@ export declare class AbstractDbxFirebaseDocumentStore<T, D extends FirestoreDocu
     readonly ref$: Observable<DocumentReference<T>>;
     readonly snapshot$: Observable<DocumentSnapshot<T>>;
     readonly snapshotLoadingState$: Observable<LoadingState<DocumentSnapshot<T>>>;
-    readonly currentData$: Observable<Maybe<DocumentDataWithId<T>>>;
-    readonly data$: Observable<DocumentDataWithId<T>>;
-    readonly dataLoadingState$: Observable<LoadingState<DocumentDataWithId<T>>>;
+    readonly currentData$: Observable<Maybe<DocumentDataWithIdAndKey<T>>>;
+    readonly data$: Observable<DocumentDataWithIdAndKey<T>>;
+    readonly dataLoadingState$: Observable<LoadingState<DocumentDataWithIdAndKey<T>>>;
+    /**
+     * Returns false while hasRef$ is false, and then returns exists$.
+     */
+    readonly currentExists$: Observable<boolean>;
     readonly exists$: Observable<boolean>;
     readonly doesNotExist$: Observable<boolean>;
     readonly modelIdentity$: Observable<FirestoreModelIdentity>;

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

@@ -16,8 +16,8 @@ export declare abstract class DbxFirebaseDocumentStoreDirective<T = unknown, D e
     readonly ref$: import("rxjs").Observable<DocumentReference<T>>;
     readonly snapshot$: import("rxjs").Observable<import("@dereekb/firebase").DocumentSnapshot<T>>;
     readonly snapshotLoadingState$: import("rxjs").Observable<import("../../../../../../dist/packages/rxjs/src").LoadingState<import("@dereekb/firebase").DocumentSnapshot<T>>>;
-    readonly data$: import("rxjs").Observable<import("@dereekb/firebase").DocumentDataWithId<T>>;
-    readonly loadingState$: import("rxjs").Observable<import("../../../../../../dist/packages/rxjs/src").LoadingState<import("@dereekb/firebase").DocumentDataWithId<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>);
     static ɵfac: i0.ɵɵFactoryDeclaration<DbxFirebaseDocumentStoreDirective<any, any, any>, never>;

package/package.json

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