@dereekb/dbx-firebase 8.5.2 → 8.6.1

package/lib/index.d.ts

@@ -3,4 +3,5 @@ export * from './firebase';
 export * from './firestore';
 export * from './function';
 export * from './model';
+export * from './router';
 export * from './module';

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

@@ -0,0 +1,64 @@
+import { ObservableOrValue } from '@dereekb/rxjs';
+import { Destroyable, Maybe, Initialized } from '@dereekb/util';
+import { DbxFirebaseCollectionChangeWatcher } from './collection.change.watcher';
+import { DbxFirebaseCollectionLoaderAccessor } from './collection.loader';
+export declare type DbxFirebaseCollectionChangeTriggerFunction<S extends DbxFirebaseCollectionLoaderAccessor<any>> = (instance: DbxFirebaseCollectionChangeTriggerInstance<S>) => ObservableOrValue<void>;
+/**
+ * Restarts the store.
+ *
+ * @param instance
+ * @returns
+ */
+export declare const DEFAULT_FIREBASE_COLLECTION_CHANGE_TRIGGER_FUNCTION: DbxFirebaseCollectionChangeTriggerFunction<any>;
+export interface DbxFirebaseCollectionChangeTriggerInstanceConfig<S extends DbxFirebaseCollectionLoaderAccessor<any>> {
+    readonly watcher: DbxFirebaseCollectionChangeWatcher<S> & Partial<Destroyable>;
+    /**
+     * Whether or not to also destroy the watcher when the trigger instance is destroyed.
+     *
+     * Defaults to false.
+     */
+    readonly destroyWatcherOnDestroy?: boolean;
+    /**
+     * Initial trigger function to use.
+     *
+     * By default restarts the store.
+     */
+    readonly triggerFunction?: Maybe<DbxFirebaseCollectionChangeTriggerFunction<S>>;
+}
+export interface DbxFirebaseCollectionChangeTrigger<S extends DbxFirebaseCollectionLoaderAccessor<any>> {
+    readonly watcher: DbxFirebaseCollectionChangeWatcher<S>;
+    triggerFunction?: Maybe<DbxFirebaseCollectionChangeTriggerFunction<S>>;
+}
+export declare class DbxFirebaseCollectionChangeTriggerInstance<S extends DbxFirebaseCollectionLoaderAccessor<any>> implements DbxFirebaseCollectionChangeTrigger<S>, Initialized, Destroyable {
+    readonly config: DbxFirebaseCollectionChangeTriggerInstanceConfig<S>;
+    readonly watcher: DbxFirebaseCollectionChangeWatcher<S>;
+    private _triggerFunction;
+    private _sub;
+    constructor(config: DbxFirebaseCollectionChangeTriggerInstanceConfig<S>);
+    init(): void;
+    destroy(): void;
+    get triggerFunction(): Maybe<DbxFirebaseCollectionChangeTriggerFunction<S>>;
+    set triggerFunction(triggerFunction: Maybe<DbxFirebaseCollectionChangeTriggerFunction<S>>);
+}
+/**
+ * Creates a new DbxFirebaseCollectionChangeWatcher, set the modes to "auto", and creates a new DbxFirebaseCollectionChangeTriggerInstance.
+ *
+ * @param store
+ * @param triggerFunction
+ * @returns
+ */
+export declare function dbxFirebaseCollectionChangeTriggerForStore<S extends DbxFirebaseCollectionLoaderAccessor<any>>(store: S, triggerFunction?: Maybe<DbxFirebaseCollectionChangeTriggerFunction<S>>): DbxFirebaseCollectionChangeTriggerInstance<S>;
+export declare function dbxFirebaseCollectionChangeTriggerForWatcher<S extends DbxFirebaseCollectionLoaderAccessor<any>>(watcher: DbxFirebaseCollectionChangeWatcher<S>, triggerFunction?: Maybe<DbxFirebaseCollectionChangeTriggerFunction<S>>): DbxFirebaseCollectionChangeTriggerInstance<S>;
+export declare function dbxFirebaseCollectionChangeTrigger<S extends DbxFirebaseCollectionLoaderAccessor<any>>(config: DbxFirebaseCollectionChangeTriggerInstanceConfig<S>): DbxFirebaseCollectionChangeTriggerInstance<S>;
+/**
+ * @deprecated
+ */
+export declare const dbxFirebaseCollectionChangeTriggerInstance: typeof dbxFirebaseCollectionChangeTrigger;
+/**
+ * @deprecated
+ */
+export declare const dbxFirebaseCollectionChangeTriggerInstanceForStore: typeof dbxFirebaseCollectionChangeTriggerForStore;
+/**
+ * @deprecated
+ */
+export declare const dbxFirebaseCollectionChangeTriggerInstanceForWatcher: typeof dbxFirebaseCollectionChangeTriggerForWatcher;

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

@@ -1,7 +1,7 @@
-import { FirestoreDocument, IterationQueryDocChangeWatcherEvent } from '@dereekb/firebase';
+import { IterationQueryDocChangeWatcherEvent } from '@dereekb/firebase';
 import { Destroyable } from '@dereekb/util';
 import { Observable } from 'rxjs';
-import { DbxFirebaseCollectionStore } from '../store/store.collection';
+import { DbxFirebaseCollectionLoaderAccessor } from './collection.loader';
 /**
  * DbxFirebaseCollectionChangeWatcher trigger modes
  * - auto: will automatically call trigger
@@ -10,9 +10,10 @@ import { DbxFirebaseCollectionStore } from '../store/store.collection';
 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
+ * Used to watch a DbxFirebaseCollectionLoaderAccessor for when the query changes and
  */
-export interface DbxFirebaseCollectionChangeWatcher {
+export interface DbxFirebaseCollectionChangeWatcher<S extends DbxFirebaseCollectionLoaderAccessor<any>> {
+    readonly store: S;
     /**
      * Current mode
      */
@@ -35,18 +36,19 @@ export interface DbxFirebaseCollectionChangeWatcher {
 /**
  * DbxFirebaseCollectionChangeWatcher instance
  */
-export declare class DbxFirebaseCollectionChangeWatcherInstance<T = unknown, D extends FirestoreDocument<T> = FirestoreDocument<T>, S extends DbxFirebaseCollectionStore<T, D> = DbxFirebaseCollectionStore<T, D>> implements Destroyable {
+export declare class DbxFirebaseCollectionChangeWatcherInstance<S extends DbxFirebaseCollectionLoaderAccessor<any>> implements Destroyable {
     readonly store: S;
-    private _mode;
-    private _sub;
+    private _initialMode;
+    private readonly _mode;
+    private readonly _sub;
     readonly mode$: Observable<DbxFirebaseCollectionChangeWatcherTriggerMode>;
     readonly event$: Observable<DbxFirebaseCollectionChangeWatcherEvent>;
     readonly hasChangeAvailable$: Observable<boolean>;
     readonly triggered$: Observable<boolean>;
     readonly trigger$: Observable<void>;
-    constructor(store: S);
+    constructor(store: S, _initialMode?: DbxFirebaseCollectionChangeWatcherTriggerMode);
     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>;
+export declare function dbxFirebaseCollectionChangeWatcher<S extends DbxFirebaseCollectionLoaderAccessor<any>>(store: S, mode?: DbxFirebaseCollectionChangeWatcherTriggerMode): DbxFirebaseCollectionChangeWatcherInstance<S>;

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

@@ -1,14 +1,21 @@
-import { DocumentDataWithId, FirestoreItemPageIterationInstance, FirestoreQueryConstraint } from '@dereekb/firebase';
+import { DocumentDataWithId, FirestoreItemPageIterationInstance, FirestoreQueryConstraint, IterationQueryDocChangeWatcher } from '@dereekb/firebase';
 import { PageListLoadingState } from '@dereekb/rxjs';
 import { Maybe, ArrayOrValue } from '@dereekb/util';
 import { Observable } from 'rxjs';
-/**
- * Abstract type that loads models from a configured collection.
- */
-export interface DbxFirebaseCollectionLoader<T = unknown> {
+export interface DbxFirebaseCollectionLoaderAccessor<T = unknown> {
     readonly constraints$: Observable<Maybe<ArrayOrValue<FirestoreQueryConstraint>>>;
     readonly firestoreIteration$: Observable<FirestoreItemPageIterationInstance<T>>;
     readonly pageLoadingState$: Observable<PageListLoadingState<DocumentDataWithId<T>>>;
+    readonly queryChangeWatcher$: Observable<IterationQueryDocChangeWatcher<T>>;
+    /**
+     * Restarts the loader and refreshes items from the beginning.
+     */
+    restart(): void;
+}
+/**
+ * Abstract type that loads models from a configured collection.
+ */
+export interface DbxFirebaseCollectionLoader<T = unknown> extends DbxFirebaseCollectionLoaderAccessor<T> {
     /**
      * Maximum number of pages to load from the interation.
      *
@@ -31,8 +38,4 @@ export interface DbxFirebaseCollectionLoader<T = unknown> {
      * Loads more items.
      */
     next(): void;
-    /**
-     * Resets/restarts the list.
-     */
-    restart(): void;
 }

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

@@ -2,18 +2,14 @@ import { PageListLoadingState } from '@dereekb/rxjs';
 import { BehaviorSubject, Subject, Observable } from 'rxjs';
 import { DocumentDataWithId, FirebaseQueryItemAccumulator, FirestoreCollectionLike, FirestoreDocument, FirestoreItemPageIterationInstance, FirestoreItemPageIteratorFilter, FirestoreQueryConstraint, IterationQueryDocChangeWatcher } from '@dereekb/firebase';
 import { ArrayOrValue, Destroyable, Initialized, Maybe } from '@dereekb/util';
-import { DbxFirebaseCollectionLoader } from './collection.loader';
+import { DbxFirebaseCollectionLoader, DbxFirebaseCollectionLoaderAccessor } from './collection.loader';
 export interface DbxFirebaseCollectionLoaderInstanceInitConfig<T, D extends FirestoreDocument<T> = FirestoreDocument<T>> {
     collection?: Maybe<FirestoreCollectionLike<T, D>>;
     maxPages?: Maybe<number>;
     itemsPerPage?: Maybe<number>;
     constraints?: Maybe<ArrayOrValue<FirestoreQueryConstraint>>;
 }
-export interface DbxFirebaseCollectionLoaderInstanceData<T, D extends FirestoreDocument<T> = FirestoreDocument<T>> {
-    readonly firestoreIteration$: Observable<FirestoreItemPageIterationInstance<T>>;
-    readonly accumulator$: Observable<FirebaseQueryItemAccumulator<T>>;
-    readonly pageLoadingState$: Observable<PageListLoadingState<T>>;
-}
+export declare type DbxFirebaseCollectionLoaderInstanceData<T, D extends FirestoreDocument<T> = FirestoreDocument<T>> = DbxFirebaseCollectionLoaderAccessor<T>;
 /**
  * DbxFirebaseModelLoader implementation within an instance.
  */

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

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

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

@@ -3,21 +3,22 @@ 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";
 /**
  * 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 DbxFirebaseCollectionChangeWatcher, OnInit, OnDestroy {
+export declare class DbxFirebaseCollectionChangeDirective<T = unknown, D extends FirestoreDocument<T> = FirestoreDocument<T>, S extends DbxFirebaseCollectionStore<T, D> = DbxFirebaseCollectionStore<T, D>> implements DbxFirebaseCollectionChangeWatcher<S>, OnInit, OnDestroy {
     readonly dbxFirebaseCollectionStoreDirective: DbxFirebaseCollectionStoreDirective<T, D, S>;
     private _watcher;
+    private _trigger;
     readonly mode$: Observable<DbxFirebaseCollectionChangeWatcherTriggerMode>;
     readonly event$: Observable<DbxFirebaseCollectionChangeWatcherEvent>;
     readonly hasChangeAvailable$: Observable<boolean>;
     readonly triggered$: Observable<boolean>;
     readonly trigger$: Observable<void>;
+    get store(): S;
     constructor(dbxFirebaseCollectionStoreDirective: DbxFirebaseCollectionStoreDirective<T, D, S>);
     ngOnInit(): void;
     ngOnDestroy(): void;

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

@@ -4,8 +4,9 @@ import { ObservableOrValue, PageListLoadingState } from '@dereekb/rxjs';
 import { ArrayOrValue, Maybe } from '@dereekb/util';
 import { LockSetComponentStore } from '@dereekb/dbx-core';
 import { DbxFirebaseCollectionLoaderInstance, DbxFirebaseCollectionLoaderInstanceData } from '../loader/collection.loader.instance';
+import { DbxFirebaseCollectionLoaderAccessor } from '../loader/collection.loader';
 import * as i0 from "@angular/core";
-export interface DbxFirebaseCollectionStore<T, D extends FirestoreDocument<T> = FirestoreDocument<T>> extends DbxFirebaseCollectionLoaderInstanceData<T, D> {
+export interface DbxFirebaseCollectionStore<T, D extends FirestoreDocument<T> = FirestoreDocument<T>> extends DbxFirebaseCollectionLoaderAccessor<T>, DbxFirebaseCollectionLoaderInstanceData<T, D> {
     readonly firestoreCollection$: Observable<Maybe<FirestoreCollectionLike<T, D>>>;
     readonly loader$: Observable<DbxFirebaseCollectionLoaderInstance<T, D>>;
     readonly firestoreIteration$: Observable<FirestoreItemPageIterationInstance<T>>;
@@ -37,6 +38,7 @@ export declare class AbstractDbxFirebaseCollectionStore<T, D extends FirestoreDo
     readonly currentFirestoreCollection$: Observable<Maybe<FirestoreCollectionLike<T, D>>>;
     readonly firestoreCollection$: Observable<FirestoreCollectionLike<T, D>>;
     readonly loader$: Observable<DbxFirebaseCollectionLoaderInstance<T, D>>;
+    readonly constraints$: Observable<Maybe<ArrayOrValue<FirestoreQueryConstraint>>>;
     readonly firestoreIteration$: Observable<FirestoreItemPageIterationInstance<T>>;
     readonly queryChangeWatcher$: Observable<IterationQueryDocChangeWatcher<T>>;
     readonly accumulator$: Observable<FirebaseQueryItemAccumulator<T>>;

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 } from '@dereekb/firebase';
+import { DocumentSnapshot, DocumentReference, FirestoreCollection, FirestoreDocument, DocumentDataWithId, FirestoreModelId, FirestoreModelKey, FirestoreCollectionLike, FirestoreModelIdentity, FirestoreModelCollectionAndIdPair, FirestoreModelKeyPairObject } from '@dereekb/firebase';
 import { LoadingState, ObservableOrValue } from '@dereekb/rxjs';
 import { Maybe } from '@dereekb/util';
 import { LockSetComponent, LockSetComponentStore } from '@dereekb/dbx-core';
@@ -18,6 +18,9 @@ export interface DbxFirebaseDocumentStore<T, D extends FirestoreDocument<T> = Fi
     readonly id$: Observable<FirestoreModelId>;
     readonly key$: Observable<FirestoreModelKey>;
     readonly ref$: Observable<DocumentReference<T>>;
+    readonly keyModelIds$: Observable<FirestoreModelId[]>;
+    readonly keyPairs$: Observable<FirestoreModelCollectionAndIdPair[]>;
+    readonly keyPairObject$: Observable<FirestoreModelKeyPairObject>;
     readonly documentLoadingState$: Observable<LoadingState<D>>;
     readonly snapshot$: Observable<DocumentSnapshot<T>>;
     readonly snapshotLoadingState$: Observable<LoadingState<DocumentSnapshot<T>>>;
@@ -68,6 +71,9 @@ export declare class AbstractDbxFirebaseDocumentStore<T, D extends FirestoreDocu
     readonly documentLoadingState$: Observable<LoadingState<D>>;
     readonly id$: Observable<FirestoreModelId>;
     readonly key$: Observable<FirestoreModelKey>;
+    readonly keyModelIds$: Observable<FirestoreModelId[]>;
+    readonly keyPairs$: Observable<FirestoreModelCollectionAndIdPair[]>;
+    readonly keyPairObject$: Observable<FirestoreModelKeyPairObject>;
     readonly ref$: Observable<DocumentReference<T>>;
     readonly snapshot$: Observable<DocumentSnapshot<T>>;
     readonly snapshotLoadingState$: Observable<LoadingState<DocumentSnapshot<T>>>;

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

@@ -5,19 +5,13 @@ import { DbxFirebaseDocumentStoreDirective } from './store.document.directive';
 import { Maybe, ModelKey } from '@dereekb/util';
 import { MaybeObservableOrValueGetter, SwitchMapToDefaultFilterFunction } from '@dereekb/rxjs';
 import * as i0 from "@angular/core";
-export declare const DBX_FIREBASE_ROUTER_SYNC_DEFAULT_ID_PARAM_KEY = "id";
-export declare const DBX_FIREBASE_ROUTER_SYNC_USE_DEFAULT_PARAM_VALUE = "0";
 /**
  * Used for synchronizing the document store id to the param of the route.
  */
 export declare class DbxFirebaseDocumentStoreRouteIdDirective<T = unknown> extends AbstractSubscriptionDirective implements OnInit, OnDestroy {
     readonly dbxFirebaseDocumentStoreDirective: DbxFirebaseDocumentStoreDirective<T>;
     readonly dbxRouterService: DbxRouterService;
-    private _paramReader;
-    private _paramRedirect;
-    private _useDefaultParam;
-    private _useDefaultParam$;
-    readonly idParamKey$: Observable<string>;
+    private _redirectInstance;
     readonly idFromParams$: Observable<Maybe<ModelKey>>;
     readonly id$: Observable<Maybe<ModelKey>>;
     constructor(dbxFirebaseDocumentStoreDirective: DbxFirebaseDocumentStoreDirective<T>, dbxRouterService: DbxRouterService);

package/lib/router/id.param.redirect.d.ts

@@ -0,0 +1,41 @@
+import { Observable } from 'rxjs';
+import { DbxRouterService, DbxRouteParamReader } from '@dereekb/dbx-core';
+import { Destroyable, Initialized, Maybe, ModelKey } from '@dereekb/util';
+import { MaybeObservableOrValueGetter, SwitchMapToDefaultFilterFunction } from '@dereekb/rxjs';
+export declare const DBX_FIREBASE_ID_ROUTER_PARAM_DEFAULT_ID_PARAM_KEY = "id";
+export declare const DBX_FIREBASE_ID_ROUTER_PARAM_DEFAULT_USE_PARAM_VALUE = "0";
+/**
+ * Used to read an id with a specific key from the current route.
+ *
+ * Can be configured to redirect to a default route if a specific value is seen.
+ */
+export interface DbxFirebaseIdRouteParamRedirect extends DbxRouteParamReader<ModelKey> {
+    readonly idFromParams$: Observable<Maybe<ModelKey>>;
+    readonly id$: Observable<Maybe<ModelKey>>;
+    setRedirectEnabled(redirect: Maybe<boolean>): void;
+    setDecider(decider: string | SwitchMapToDefaultFilterFunction<ModelKey>): void;
+}
+/**
+ * DbxFirebaseIdRouteParamRedirect instance
+ */
+export declare class DbxFirebaseIdRouteParamRedirectInstance implements DbxFirebaseIdRouteParamRedirect, DbxRouteParamReader<ModelKey>, Initialized, Destroyable {
+    readonly dbxRouterService: DbxRouterService;
+    private _paramReader;
+    private _paramRedirect;
+    private _useDefaultParamDecider;
+    private _useDefaultParam$;
+    readonly paramValue$: Observable<Maybe<string>>;
+    readonly defaultValue$: Observable<Maybe<string>>;
+    readonly value$: Observable<Maybe<string>>;
+    readonly idFromParams$: Observable<Maybe<ModelKey>>;
+    readonly id$: Observable<Maybe<ModelKey>>;
+    constructor(dbxRouterService: DbxRouterService);
+    init(): void;
+    destroy(): void;
+    get paramKey(): string;
+    set paramKey(paramKey: string);
+    setDefaultValue(defaultValue: MaybeObservableOrValueGetter<string>): void;
+    setRedirectEnabled(redirect: Maybe<boolean>): void;
+    setDecider(decider: string | SwitchMapToDefaultFilterFunction<ModelKey>): void;
+}
+export declare function dbxFirebaseIdRouteParamRedirect(dbxRouterService: DbxRouterService): DbxFirebaseIdRouteParamRedirectInstance;

package/lib/router/index.d.ts

@@ -0,0 +1 @@
+export * from './id.param.redirect';

package/package.json

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