@dereekb/dbx-firebase 10.0.19 → 10.0.21

package/lib/auth/auth.d.ts

@@ -2,8 +2,14 @@ import { FirebaseAuthToken } from '@dereekb/firebase';
 import { ISO8601DateString, Maybe } from '@dereekb/util';
 import { User, UserInfo } from 'firebase/auth';
 export type AuthUserInfo = Omit<UserInfo, 'providerId'> & {
-    creationTime?: Maybe<ISO8601DateString>;
-    lastSignInTime?: Maybe<ISO8601DateString>;
+    /**
+     * The creation time of the user's account.
+     */
+    readonly creationTime?: Maybe<ISO8601DateString>;
+    /**
+     * The last time the user signed in and recieved a refresh token.
+     */
+    readonly lastSignInTime?: Maybe<ISO8601DateString>;
 };
 export declare function authUserInfoFromAuthUser(user: User): AuthUserInfo;
 export declare function firebaseAuthTokenFromUser(user: User): FirebaseAuthToken;

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

@@ -10,7 +10,7 @@ import * as i0 from "@angular/core";
  */
 export type AuthUserStateObsFunction = (dbxFirebaseAuthService: DbxFirebaseAuthService) => Observable<AuthUserState>;
 export declare abstract class DbxFirebaseAuthServiceDelegate {
-    fullControlOfAuthUserState?: boolean;
+    readonly fullControlOfAuthUserState?: boolean;
     abstract authUserStateObs: AuthUserStateObsFunction;
     abstract authRolesObs(dbxFirebaseAuthService: DbxFirebaseAuthService): Observable<AuthRoleSet>;
     abstract isOnboarded(dbxFirebaseAuthService: DbxFirebaseAuthService): Observable<boolean>;

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

@@ -1,6 +1,6 @@
-import { DocumentDataWithIdAndKey, FirestoreItemPageIterationInstance, FirestoreQueryConstraint, IterationQueryDocChangeWatcher } from '@dereekb/firebase';
-import { PageListLoadingState } from '@dereekb/rxjs';
-import { Maybe, ArrayOrValue } from '@dereekb/util';
+import { DocumentDataWithIdAndKey, FirebaseQueryItemAccumulator, FirebaseQueryItemAccumulatorNextPageUntilResultsCountFunction, FirebaseQuerySnapshotAccumulator, FirestoreItemPageIterationInstance, FirestoreQueryConstraint, IterationQueryDocChangeWatcher } from '@dereekb/firebase';
+import { ItemAccumulatorNextPageUntilResultsCountResult, PageListLoadingState } from '@dereekb/rxjs';
+import { Maybe, ArrayOrValue, PageNumber } from '@dereekb/util';
 import { Observable } from 'rxjs';
 export interface DbxFirebaseCollectionLoaderAccessor<T = unknown> {
     readonly constraints$: Observable<Maybe<ArrayOrValue<FirestoreQueryConstraint>>>;
@@ -38,4 +38,24 @@ export interface DbxFirebaseCollectionLoader<T = unknown> extends DbxFirebaseCol
      * Loads more items.
      */
     next(): void;
+    /**
+     * Returns an observable that loads up to the given page then emits the page number.
+     *
+     * @param page Page number to load to.
+     */
+    loadToPage(page: PageNumber): Observable<PageNumber>;
+    /**
+     * Loads results until all results have been loaded or the max page limit is reached.
+     */
+    loadAllResults(): Observable<PageNumber>;
+}
+export interface DbxFirebaseCollectionLoaderAccessorWithAccumulator<T = unknown> extends DbxFirebaseCollectionLoaderAccessor<T> {
+    readonly snapshotAccumulator$: Observable<FirebaseQuerySnapshotAccumulator<T>>;
+    readonly accumulator$: Observable<FirebaseQueryItemAccumulator<T>>;
+}
+export interface DbxFirebaseCollectionLoaderWithAccumulator<T = unknown> extends DbxFirebaseCollectionLoader<T>, DbxFirebaseCollectionLoaderAccessorWithAccumulator<T> {
+    /**
+     * Loads pages until the number of results has been reached, then emits the total number of results.
+     */
+    loadPagesUntilResultsCount(maxResultsCount: number, countFunction?: FirebaseQueryItemAccumulatorNextPageUntilResultsCountFunction<T>): Observable<ItemAccumulatorNextPageUntilResultsCountResult>;
 }

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

@@ -1,8 +1,8 @@
-import { PageListLoadingState } from '@dereekb/rxjs';
+import { PageListLoadingState, ItemAccumulatorNextPageUntilResultsCountResult } from '@dereekb/rxjs';
 import { BehaviorSubject, Subject, Observable } from 'rxjs';
-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';
+import { DocumentDataWithIdAndKey, DocumentReference, FirebaseQueryItemAccumulator, FirebaseQueryItemAccumulatorNextPageUntilResultsCountFunction, FirebaseQuerySnapshotAccumulator, FirestoreCollectionLike, FirestoreDocument, FirestoreItemPageIterationInstance, FirestoreItemPageIteratorFilter, FirestoreQueryConstraint, IterationQueryDocChangeWatcher } from '@dereekb/firebase';
+import { ArrayOrValue, Destroyable, GetterOrValue, Initialized, Maybe, PageNumber } from '@dereekb/util';
+import { DbxFirebaseCollectionLoaderAccessor, DbxFirebaseCollectionLoaderWithAccumulator } from './collection.loader';
 export interface DbxFirebaseCollectionLoaderInstanceInitConfig<T, D extends FirestoreDocument<T> = FirestoreDocument<T>> {
     collection?: Maybe<FirestoreCollectionLike<T, D>>;
     maxPages?: Maybe<number>;
@@ -13,7 +13,7 @@ export type DbxFirebaseCollectionLoaderInstanceData<T, D extends FirestoreDocume
 /**
  * DbxFirebaseModelLoader implementation within an instance.
  */
-export declare class DbxFirebaseCollectionLoaderInstance<T = unknown, D extends FirestoreDocument<T> = FirestoreDocument<T>> implements DbxFirebaseCollectionLoader<T>, DbxFirebaseCollectionLoaderInstanceData<T, D>, Initialized, Destroyable {
+export declare class DbxFirebaseCollectionLoaderInstance<T = unknown, D extends FirestoreDocument<T> = FirestoreDocument<T>> implements DbxFirebaseCollectionLoaderWithAccumulator<T>, DbxFirebaseCollectionLoaderInstanceData<T, D>, Initialized, Destroyable {
     private readonly _initConfig?;
     protected readonly _collection: BehaviorSubject<Maybe<FirestoreCollectionLike<T, D, import("@dereekb/firebase").LimitedFirestoreDocumentAccessor<T, D>>>>;
     protected readonly _maxPages: BehaviorSubject<Maybe<number>>;
@@ -30,6 +30,7 @@ export declare class DbxFirebaseCollectionLoaderInstance<T = unknown, D extends
     readonly snapshotAccumulatorDocumentRefs$: Observable<DocumentReference<T>[][]>;
     readonly snapshotAccumulatorDocuments$: Observable<D[][]>;
     readonly accumulator$: Observable<FirebaseQueryItemAccumulator<T>>;
+    readonly accumulatorPage$: Observable<PageNumber>;
     /**
      * Passthrough for currentAllItems$ from the accumulator.
      */
@@ -58,6 +59,9 @@ export declare class DbxFirebaseCollectionLoaderInstance<T = unknown, D extends
     restart(): void;
     setConstraints(constraints: Maybe<ArrayOrValue<FirestoreQueryConstraint>>): void;
     setCollection(firestoreCollection: Maybe<FirestoreCollectionLike<T, D>>): void;
+    loadPagesUntilResultsCount(maxResultsLimit: GetterOrValue<number>, countResultsFunction?: FirebaseQueryItemAccumulatorNextPageUntilResultsCountFunction<T> | undefined): Observable<ItemAccumulatorNextPageUntilResultsCountResult>;
+    loadToPage(page: PageNumber): Observable<PageNumber>;
+    loadAllResults(): Observable<PageNumber>;
 }
 export declare function dbxFirebaseCollectionLoaderInstance<T, D extends FirestoreDocument<T> = FirestoreDocument<T>>(config: DbxFirebaseCollectionLoaderInstanceInitConfig<T, D>): DbxFirebaseCollectionLoaderInstance<T, D>;
 export declare function dbxFirebaseCollectionLoaderInstanceWithCollection<T, D extends FirestoreDocument<T> = FirestoreDocument<T>>(collection: Maybe<FirestoreCollectionLike<T, D>>): DbxFirebaseCollectionLoaderInstance<T, D>;

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

@@ -1,21 +1,26 @@
 import { Observable, Subscription } from 'rxjs';
-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 { FirebaseQueryItemAccumulator, FirestoreCollectionLike, FirestoreDocument, FirestoreItemPageIterationInstance, FirestoreQueryConstraint, IterationQueryDocChangeWatcher, DocumentDataWithIdAndKey, DocumentReference, FirebaseQuerySnapshotAccumulator, FirebaseQueryItemAccumulatorNextPageUntilResultsCountFunction } from '@dereekb/firebase';
+import { ObservableOrValue, PageListLoadingState, ItemAccumulatorNextPageUntilResultsCountResult } from '@dereekb/rxjs';
+import { ArrayOrValue, Maybe, PageNumber } from '@dereekb/util';
 import { LockSetComponentStore } from '@dereekb/dbx-core';
 import { DbxFirebaseCollectionLoaderInstance, DbxFirebaseCollectionLoaderInstanceData } from '../../loader/collection.loader.instance';
-import { DbxFirebaseCollectionLoaderAccessor } from '../../loader/collection.loader';
+import { DbxFirebaseCollectionLoaderAccessorWithAccumulator } from '../../loader/collection.loader';
 import * as i0 from "@angular/core";
-export interface DbxFirebaseCollectionStore<T, D extends FirestoreDocument<T> = FirestoreDocument<T>> extends DbxFirebaseCollectionLoaderAccessor<T>, DbxFirebaseCollectionLoaderInstanceData<T, D> {
+export interface DbxFirebaseCollectionStore<T, D extends FirestoreDocument<T> = FirestoreDocument<T>> extends DbxFirebaseCollectionLoaderAccessorWithAccumulator<T>, DbxFirebaseCollectionLoaderInstanceData<T, D> {
     readonly firestoreCollection$: Observable<Maybe<FirestoreCollectionLike<T, D>>>;
     readonly loader$: Observable<DbxFirebaseCollectionLoaderInstance<T, D>>;
-    readonly firestoreIteration$: Observable<FirestoreItemPageIterationInstance<T>>;
-    readonly queryChangeWatcher$: Observable<IterationQueryDocChangeWatcher<T>>;
-    readonly accumulator$: Observable<FirebaseQueryItemAccumulator<T>>;
-    readonly pageLoadingState$: Observable<PageListLoadingState<DocumentDataWithIdAndKey<T>>>;
     readonly hasDocuments$: Observable<boolean>;
+    /**
+     * Returns all document references loaded by the accumulator.
+     */
     readonly allDocumentRefs$: Observable<DocumentReference<T>[]>;
+    /**
+     * Returns all documents loaded by the accomulator.
+     */
     readonly allDocuments$: Observable<D[]>;
+    /**
+     * Returns all documents data loaded by the accumulator.
+     */
     readonly allDocumentData$: Observable<DocumentDataWithIdAndKey<T>[]>;
     setMaxPages(observableOrValue: ObservableOrValue<Maybe<number>>): Subscription;
     setItemsPerPage(observableOrValue: ObservableOrValue<Maybe<number>>): Subscription;
@@ -42,13 +47,17 @@ export declare class AbstractDbxFirebaseCollectionStore<T, D extends FirestoreDo
     readonly constraints$: Observable<Maybe<ArrayOrValue<FirestoreQueryConstraint>>>;
     readonly firestoreIteration$: Observable<FirestoreItemPageIterationInstance<T>>;
     readonly queryChangeWatcher$: Observable<IterationQueryDocChangeWatcher<T>>;
-    readonly accumulator$: Observable<FirebaseQueryItemAccumulator<T>>;
     readonly pageLoadingState$: Observable<PageListLoadingState<DocumentDataWithIdAndKey<T>>>;
+    readonly snapshotAccumulator$: Observable<FirebaseQuerySnapshotAccumulator<T>>;
+    readonly accumulator$: Observable<FirebaseQueryItemAccumulator<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);
+    loadToPage(page: PageNumber): Observable<PageNumber>;
+    loadPagesUntilResultsCount(maxResultsCount: number, countFunction?: FirebaseQueryItemAccumulatorNextPageUntilResultsCountFunction<T> | undefined): Observable<ItemAccumulatorNextPageUntilResultsCountResult>;
+    loadAllResults(): Observable<PageNumber>;
     static ɵfac: i0.ɵɵFactoryDeclaration<AbstractDbxFirebaseCollectionStore<any, any, any>, never>;
     static ɵprov: i0.ɵɵInjectableDeclaration<AbstractDbxFirebaseCollectionStore<any, any, any>>;
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@dereekb/dbx-firebase",
-  "version": "10.0.19",
+  "version": "10.0.21",
   "peerDependencies": {
     "@angular/core": "^16.2.12",
     "@dereekb/dbx-analytics": "*",