@dereekb/dbx-firebase 8.1.2 → 8.4.0

package/lib/auth/service/firebase.auth.service.d.ts

@@ -42,6 +42,7 @@ export declare class DbxFirebaseAuthService implements DbxAuthService {
     private _authRoleClaimsService?;
     readonly isAdminInAuthRoleSet: (authRoleSet: AuthRoleSet) => boolean;
     constructor(firebaseAuth: Auth, delegate: DbxFirebaseAuthServiceDelegate);
+    refreshToken(): Promise<IdTokenResult>;
     rolesForClaims<T extends AuthClaimsObject = AuthClaimsObject>(claims: AuthClaims<T>): AuthRoleSet;
     getAuthContextInfo(): Promise<Maybe<DbxFirebaseAuthContextInfo>>;
     loadAuthContextInfoForUser(user: Maybe<User>): Promise<Maybe<DbxFirebaseAuthContextInfo>>;

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

@@ -1,4 +1,4 @@
-import { FirestoreItemPageIterationInstance, FirestoreQueryConstraint } from '@dereekb/firebase';
+import { DocumentDataWithId, FirestoreItemPageIterationInstance, FirestoreQueryConstraint } from '@dereekb/firebase';
 import { PageListLoadingState } from '@dereekb/rxjs';
 import { Maybe, ArrayOrValue } from '@dereekb/util';
 import { Observable } from 'rxjs';
@@ -8,7 +8,7 @@ import { Observable } from 'rxjs';
 export interface DbxFirebaseCollectionLoader<T = unknown> {
     readonly constraints$: Observable<Maybe<ArrayOrValue<FirestoreQueryConstraint>>>;
     readonly firestoreIteration$: Observable<FirestoreItemPageIterationInstance<T>>;
-    readonly pageLoadingState$: Observable<PageListLoadingState<T>>;
+    readonly pageLoadingState$: Observable<PageListLoadingState<DocumentDataWithId<T>>>;
     /**
      * Maximum number of pages to load from the interation.
      *

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 { FirebaseQueryItemAccumulator, FirestoreCollectionLike, FirestoreDocument, FirestoreItemPageIterationInstance, FirestoreItemPageIteratorFilter, FirestoreQueryConstraint, IterationQueryDocChangeWatcher } from '@dereekb/firebase';
+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';
 export interface DbxFirebaseCollectionLoaderInstanceInitConfig<T, D extends FirestoreDocument<T> = FirestoreDocument<T>> {
@@ -31,7 +31,7 @@ export declare class DbxFirebaseCollectionLoaderInstance<T = unknown, D extends
     readonly firestoreIteration$: Observable<FirestoreItemPageIterationInstance<T>>;
     readonly queryChangeWatcher$: Observable<IterationQueryDocChangeWatcher<T>>;
     readonly accumulator$: Observable<FirebaseQueryItemAccumulator<T>>;
-    readonly pageLoadingState$: Observable<PageListLoadingState<T>>;
+    readonly pageLoadingState$: Observable<PageListLoadingState<DocumentDataWithId<T>>>;
     constructor(_initConfig?: DbxFirebaseCollectionLoaderInstanceInitConfig<T, D> | undefined);
     init(): void;
     destroy(): void;

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

@@ -0,0 +1,63 @@
+import { DocumentDataWithId, FirestoreModelKey, DocumentReference, FirestoreDocument, FirestoreModelId, DocumentSnapshot } from '@dereekb/firebase';
+import { ObservableOrValue, PageListLoadingState } from '@dereekb/rxjs';
+import { Maybe, ArrayOrValue } from '@dereekb/util';
+import { Observable } from 'rxjs';
+/**
+ * Abstract type that loads document snapshots from keys, refs, or documents.
+ */
+export interface DbxLimitedFirebaseDocumentLoader<T = unknown, D extends FirestoreDocument<T> = FirestoreDocument<T>> {
+    /**
+     * Keys of the documents
+     */
+    readonly keys$: Observable<FirestoreModelKey[]>;
+    /**
+     * Refs of the documents
+     */
+    readonly refs$: Observable<DocumentReference<T>[]>;
+    /**
+     * Ids of the documents
+     */
+    readonly ids$: Observable<FirestoreModelId[]>;
+    /**
+     * Documents to load.
+     */
+    readonly documents$: Observable<D[]>;
+    /**
+     * Snapshots of the documents
+     */
+    readonly snapshots$: Observable<DocumentSnapshot<T>[]>;
+    /**
+     * Data from the documents.
+     */
+    readonly data$: Observable<DocumentDataWithId<T>[]>;
+    /**
+     * Loading state for the document data.
+     */
+    readonly pageLoadingState$: Observable<PageListLoadingState<DocumentDataWithId<T>>>;
+    /**
+     * Sets the keys of the models to load.
+     *
+     * @param constraints
+     */
+    setKeys(keys: Maybe<ObservableOrValue<ArrayOrValue<FirestoreModelKey>>>): void;
+    /**
+     * Sets the document references to load.
+     *
+     * @param constraints
+     */
+    setRefs(refs: Maybe<ObservableOrValue<ArrayOrValue<DocumentReference<T>>>>): void;
+    /**
+     * Sets the documents to load from.
+     *
+     * @param constraints
+     */
+    setDocuments(docs: Maybe<ObservableOrValue<ArrayOrValue<D>>>): void;
+}
+export interface DbxFirebaseDocumentLoader<T = unknown, D extends FirestoreDocument<T> = FirestoreDocument<T>> extends DbxLimitedFirebaseDocumentLoader<T, D> {
+    /**
+     * Sets the ids of the models to load.
+     *
+     * @param constraints
+     */
+    setIds(ids: Maybe<ObservableOrValue<ArrayOrValue<FirestoreModelId>>>): void;
+}

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

@@ -0,0 +1,38 @@
+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 { 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>> {
+    readonly accessor: A;
+}
+/**
+ * DbxLimitedFirebaseDocumentLoader implementation within an instance.
+ */
+export declare class DbxLimitedFirebaseDocumentLoaderInstance<T = unknown, D extends FirestoreDocument<T> = FirestoreDocument<T>, A extends LimitedFirestoreDocumentAccessor<T, D> = LimitedFirestoreDocumentAccessor<T, D>> implements DbxLimitedFirebaseDocumentLoader<T>, Destroyable {
+    private readonly _initConfig;
+    readonly accessor: A;
+    protected readonly _documents: BehaviorSubject<Maybe<D[]>>;
+    protected readonly _restart: Subject<void>;
+    protected readonly _sub: SubscriptionObject;
+    readonly documents$: Observable<D[]>;
+    readonly keys$: Observable<string[]>;
+    readonly ids$: Observable<string[]>;
+    readonly refs$: Observable<DocumentReference<unknown>[]>;
+    readonly snapshots$: Observable<DocumentSnapshot<T>[]>;
+    readonly data$: Observable<DocumentDataWithId<T>[]>;
+    readonly pageLoadingState$: Observable<PageListLoadingState<DocumentDataWithId<T>>>;
+    constructor(_initConfig: DbxFirebaseDocumentLoaderInstanceInitConfig<T, D, A>);
+    destroy(): void;
+    restart(): void;
+    setKeys(keys: Maybe<ObservableOrValue<ArrayOrValue<FirestoreModelKey>>>): void;
+    setRefs(refs: Maybe<ObservableOrValue<ArrayOrValue<DocumentReference<T>>>>): void;
+    setDocuments(docs: Maybe<ObservableOrValue<ArrayOrValue<D>>>): void;
+}
+export declare function dbxLimitedFirebaseDocumentLoaderInstance<T, D extends FirestoreDocument<T> = FirestoreDocument<T>, A extends LimitedFirestoreDocumentAccessor<T, D> = LimitedFirestoreDocumentAccessor<T, D>>(config: DbxFirebaseDocumentLoaderInstanceInitConfig<T, D, A>): DbxLimitedFirebaseDocumentLoaderInstance<T, D, A>;
+export declare function dbxLimitedFirebaseDocumentLoaderInstanceWithAccessor<T, D extends FirestoreDocument<T> = FirestoreDocument<T>, A extends LimitedFirestoreDocumentAccessor<T, D> = LimitedFirestoreDocumentAccessor<T, D>>(accessor: A): DbxLimitedFirebaseDocumentLoaderInstance<T, D, A>;
+export declare class DbxFirebaseDocumentLoaderInstance<T = unknown, D extends FirestoreDocument<T> = FirestoreDocument<T>, A extends FirestoreDocumentAccessor<T, D> = FirestoreDocumentAccessor<T, D>> extends DbxLimitedFirebaseDocumentLoaderInstance<T, D, A> implements DbxFirebaseDocumentLoader<T>, Destroyable {
+    setIds(ids: Maybe<ObservableOrValue<ArrayOrValue<FirestoreModelKey>>>): void;
+}
+export declare function dbxFirebaseDocumentLoaderInstance<T, D extends FirestoreDocument<T> = FirestoreDocument<T>, A extends FirestoreDocumentAccessor<T, D> = FirestoreDocumentAccessor<T, D>>(config: DbxFirebaseDocumentLoaderInstanceInitConfig<T, D, A>): DbxFirebaseDocumentLoaderInstance<T, D, A>;
+export declare function dbxFirebaseDocumentLoaderInstanceWithAccessor<T, D extends FirestoreDocument<T> = FirestoreDocument<T>, A extends FirestoreDocumentAccessor<T, D> = FirestoreDocumentAccessor<T, D>>(accessor: A): DbxFirebaseDocumentLoaderInstance<T, D, A>;

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

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

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

@@ -1,5 +1,5 @@
 import { Observable, Subscription } from 'rxjs';
-import { FirebaseQueryItemAccumulator, FirestoreCollectionLike, FirestoreDocument, FirestoreItemPageIterationInstance, FirestoreQueryConstraint, IterationQueryDocChangeWatcher } from '@dereekb/firebase';
+import { FirebaseQueryItemAccumulator, FirestoreCollectionLike, FirestoreDocument, FirestoreItemPageIterationInstance, FirestoreQueryConstraint, IterationQueryDocChangeWatcher, DocumentDataWithId } from '@dereekb/firebase';
 import { ObservableOrValue, PageListLoadingState } from '@dereekb/rxjs';
 import { ArrayOrValue, Maybe } from '@dereekb/util';
 import { LockSetComponentStore } from '@dereekb/dbx-core';
@@ -11,7 +11,7 @@ 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<T>>;
+    readonly pageLoadingState$: Observable<PageListLoadingState<DocumentDataWithId<T>>>;
     setMaxPages(observableOrValue: ObservableOrValue<Maybe<number>>): Subscription;
     setItemsPerPage(observableOrValue: ObservableOrValue<Maybe<number>>): Subscription;
     setConstraints(observableOrValue: ObservableOrValue<Maybe<ArrayOrValue<FirestoreQueryConstraint>>>): Subscription;
@@ -40,7 +40,7 @@ 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<T>>;
+    readonly pageLoadingState$: Observable<PageListLoadingState<DocumentDataWithId<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<T>>;
+    readonly pageLoadingState$: import("rxjs").Observable<import("../../../../../../dist/packages/rxjs/src").PageListLoadingState<import("@dereekb/firebase").DocumentDataWithId<T>>>;
     set maxPages(maxPages: Maybe<number>);
     set itemsPerPage(itemsPerPage: Maybe<number>);
     set constraints(constraints: Maybe<ArrayOrValue<FirestoreQueryConstraint>>);

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

@@ -3,22 +3,34 @@ import { OnDestroy, OnInit } from '@angular/core';
 import { DbxRouterService, AbstractSubscriptionDirective } from '@dereekb/dbx-core';
 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 _idParamKey;
+    private _paramReader;
+    private _paramRedirect;
+    private _useDefaultParam;
+    private _useDefaultParam$;
     readonly idParamKey$: Observable<string>;
     readonly idFromParams$: Observable<Maybe<ModelKey>>;
+    readonly id$: Observable<Maybe<ModelKey>>;
     constructor(dbxFirebaseDocumentStoreDirective: DbxFirebaseDocumentStoreDirective<T>, dbxRouterService: DbxRouterService);
     ngOnInit(): void;
     ngOnDestroy(): void;
     get idParam(): string;
     set idParam(idParam: string);
+    set dbxFirebaseDocumentStoreRouteIdDefault(defaultValue: MaybeObservableOrValueGetter<ModelKey>);
+    /**
+     * Whether or not to enable the redirection. Is enabled by default.
+     */
+    set dbxFirebaseDocumentStoreRouteIdDefaultRedirect(redirect: Maybe<boolean> | '');
+    set dbxFirebaseDocumentStoreRouteIdDefaultDecision(decider: string | SwitchMapToDefaultFilterFunction<ModelKey>);
     static ɵfac: i0.ɵɵFactoryDeclaration<DbxFirebaseDocumentStoreRouteIdDirective<any>, [{ host: true; }, null]>;
-    static ɵdir: i0.ɵɵDirectiveDeclaration<DbxFirebaseDocumentStoreRouteIdDirective<any>, "[dbxFirebaseDocumentStoreRouteId]", never, { "idParam": "dbxFirebaseDocumentStoreRouteId"; }, {}, never>;
+    static ɵdir: i0.ɵɵDirectiveDeclaration<DbxFirebaseDocumentStoreRouteIdDirective<any>, "[dbxFirebaseDocumentStoreRouteId]", never, { "idParam": "dbxFirebaseDocumentStoreRouteId"; "dbxFirebaseDocumentStoreRouteIdDefault": "dbxFirebaseDocumentStoreRouteIdDefault"; "dbxFirebaseDocumentStoreRouteIdDefaultRedirect": "dbxFirebaseDocumentStoreRouteIdDefaultRedirect"; "dbxFirebaseDocumentStoreRouteIdDefaultDecision": "dbxFirebaseDocumentStoreRouteIdDefaultDecision"; }, {}, never>;
 }

package/package.json

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