@dereekb/dbx-firebase 12.6.21 → 13.0.0

package/lib/firebase/firebase.options.d.ts

@@ -1,36 +0,0 @@
-import { InjectionToken } from '@angular/core';
-import { type PersistentCacheSettings } from 'firebase/firestore';
-import { type FirebaseOptions } from 'firebase/app';
-import { type DbxFirebaseAppCheckConfig } from './appcheck';
-import { type DbxFirebaseEmulatorsConfig } from './emulators';
-export declare const DBX_FIREBASE_APP_OPTIONS_TOKEN: InjectionToken<DbxFirebaseAppOptions>;
-/**
- * Extends FirebaseOptions with additional properties for configuring the underlying client-side Firebase services.
- */
-export interface DbxFirebaseAppOptions extends FirebaseOptions {
-    readonly emulators: DbxFirebaseEmulatorsConfig;
-    /**
-     * Firebase AppCheck handling
-     */
-    readonly appCheck?: DbxFirebaseAppCheckConfig;
-    /**
-     * Passed to the Functions initialization to set the domain to use when sending requests.
-     */
-    readonly functionsRegionOrCustomDomain?: string | undefined;
-    /**
-     * Whether or not to call enableMultiTabIndexedDbPersistence() for firestore at setup time.
-     *
-     * True by default.
-     */
-    readonly enableMultiTabIndexedDbPersistence?: boolean;
-    /**
-     * Whether or not to call enableIndexedDbPersistence() for firestore at setup time.
-     *
-     * True by default if enableMultiTabIndexedDbPersistence is false.
-     */
-    readonly enableIndexedDbPersistence?: boolean;
-    /**
-     * Optional persistent cache setting to pass to the Firestore cache.
-     */
-    readonly persistentCacheSettings?: Omit<PersistentCacheSettings, 'tabManager'>;
-}

package/lib/firebase/firebase.options.environment.d.ts

@@ -1,10 +0,0 @@
-import { type ProvideDbxFirebaseLoginConfig } from '../auth/login/firebase.login.providers';
-import { type DbxFirebaseAppOptions } from './firebase.options';
-/**
- * Convenience type used in .environment.ts files for building configuration.
- */
-export type DbxFirebaseEnvironmentOptions = DbxFirebaseAppOptions & Pick<ProvideDbxFirebaseLoginConfig, 'enabledLoginMethods'>;
-/**
- * @deprecated use DbxFirebaseEnvironmentOptions instead.
- */
-export type DbxFirebaseOptions = DbxFirebaseEnvironmentOptions;

package/lib/firebase/firebase.providers.d.ts

@@ -1,51 +0,0 @@
-import { type EnvironmentProviders } from '@angular/core';
-import { type DbxFirebaseAppOptions } from './firebase.options';
-import { type Maybe } from '@dereekb/util';
-/**
- * Configuration for provideDbxFirebaseApp().
- */
-export interface ProvideDbxFirebaseAppConfig {
-    /**
-     * DbxFirebaseAppOptions for the app.
-     *
-     * Is automatically configured as a provider for the DBX_FIREBASE_APP_OPTIONS_TOKEN.
-     */
-    readonly dbxFirebaseAppOptions: DbxFirebaseAppOptions;
-    /**
-     * Whether or not to provide Firestore configuration.
-     *
-     * True by default.
-     */
-    readonly provideFirestore?: Maybe<boolean>;
-    /**
-     * Whether or not to provide App Check configuration.
-     *
-     * True by default.
-     */
-    readonly provideAppCheck?: Maybe<boolean>;
-    /**
-     * Whether or not to provide Auth configuration.
-     *
-     * True by default.
-     */
-    readonly provideAuth?: Maybe<boolean>;
-    /**
-     * Whether or not to provide Storage configuration.
-     *
-     * True by default.
-     */
-    readonly provideStorage?: Maybe<boolean>;
-    /**
-     * Whether or not to provide Functions configuration.
-     *
-     * True by default.
-     */
-    readonly provideFunctions?: Maybe<boolean>;
-}
-/**
- * Provides EnvironmentProviders for all Firebase services.
- *
- * @param config
- * @returns EnvironmentProviders
- */
-export declare function provideDbxFirebaseApp(config: ProvideDbxFirebaseAppConfig): EnvironmentProviders;

package/lib/firebase/index.d.ts

@@ -1,9 +0,0 @@
-export * from './appcheck';
-export * from './emulators';
-export * from './firebase.providers';
-export * from './firebase.module';
-export * from './firebase.emulator.module';
-export * from './firebase.emulator.service';
-export * from './firebase.emulator.providers';
-export * from './firebase.options';
-export * from './firebase.options.environment';

package/lib/firestore/firebase.firestore.context.service.d.ts

@@ -1,10 +0,0 @@
-import { FirestoreContext } from '@dereekb/firebase';
-import * as i0 from "@angular/core";
-/**
- * Service that provides access to the app's FirestoreContext.
- */
-export declare class DbxFirestoreContextService {
-    readonly firestoreContext: FirestoreContext<import("@dereekb/firebase").Firestore>;
-    static ɵfac: i0.ɵɵFactoryDeclaration<DbxFirestoreContextService, never>;
-    static ɵprov: i0.ɵɵInjectableDeclaration<DbxFirestoreContextService>;
-}

package/lib/firestore/firebase.firestore.d.ts

@@ -1,5 +0,0 @@
-import { InjectionToken } from '@angular/core';
-/**
- * Token to access the FirestoreContext value.
- */
-export declare const DBX_FIRESTORE_CONTEXT_TOKEN: InjectionToken<unknown>;

package/lib/firestore/firebase.firestore.module.d.ts

@@ -1,15 +0,0 @@
-import { ModuleWithProviders } from '@angular/core';
-import { ProvideDbxFirebaseFirestoreCollectionConfig } from './firebase.firestore.providers';
-import * as i0 from "@angular/core";
-export type DbxFirebaseFirestoreCollectionModuleConfig<T> = ProvideDbxFirebaseFirestoreCollectionConfig<T>;
-/**
- * Used to initialize the FirestoreCollection for a DbxFirebase app.
- *
- * @deprecated use provideDbxFirestoreCollection() instead.
- */
-export declare class DbxFirebaseFirestoreCollectionModule {
-    static forRoot<T>(config: DbxFirebaseFirestoreCollectionModuleConfig<T>): ModuleWithProviders<DbxFirebaseFirestoreCollectionModule>;
-    static ɵfac: i0.ɵɵFactoryDeclaration<DbxFirebaseFirestoreCollectionModule, never>;
-    static ɵmod: i0.ɵɵNgModuleDeclaration<DbxFirebaseFirestoreCollectionModule, never, never, never>;
-    static ɵinj: i0.ɵɵInjectorDeclaration<DbxFirebaseFirestoreCollectionModule>;
-}

package/lib/firestore/firebase.firestore.providers.d.ts

@@ -1,62 +0,0 @@
-import { type EnvironmentProviders } from '@angular/core';
-import { type FirestoreContext, NotificationFirestoreCollections, StorageFileFirestoreCollections, SystemStateFirestoreCollections } from '@dereekb/firebase';
-import { type ClassLikeType } from '@dereekb/util';
-/**
- * Provider factory for the SystemStateFirestoreCollections.
- *
- * @param appCollection The app collection class to use.
- * @returns Provider factory for the SystemStateFirestoreCollections.
- */
-export declare function provideSystemStateFirestoreCollections(appCollection: SystemStateFirestoreCollections): SystemStateFirestoreCollections;
-/**
- * Provider factory for the NotificationFirestoreCollections.
- *
- * @param appCollection The app collection class to use.
- * @returns Provider factory for the NotificationFirestoreCollections.
- */
-export declare function provideNotificationFirestoreCollections(appCollection: NotificationFirestoreCollections): NotificationFirestoreCollections;
-/**
- * Provider factory for the StorageFileFirestoreCollections.
- *
- * @param appCollection The app collection class to use.
- * @returns Provider factory for the StorageFileFirestoreCollections.
- */
-export declare function provideStorageFileFirestoreCollections(appCollection: StorageFileFirestoreCollections): StorageFileFirestoreCollections;
-/**
- * Configuration for provideDbxFirestoreCollection().
- */
-export interface ProvideDbxFirebaseFirestoreCollectionConfig<T> {
-    /**
-     * The app collection class to use.
-     */
-    readonly appCollectionClass: ClassLikeType<T>;
-    /**
-     * The collection factory to use.
-     */
-    readonly collectionFactory: (context: FirestoreContext) => T;
-    /**
-     * Whether or not to provide the SystemStateFirestoreCollections.
-     *
-     * True by default.
-     */
-    readonly provideSystemStateFirestoreCollections?: boolean;
-    /**
-     * Whether or not to provide the NotificationFirestoreCollections.
-     *
-     * False by default.
-     */
-    readonly provideNotificationFirestoreCollections?: boolean;
-    /**
-     * Whether or not to provide the StorageFileFirestoreCollections.
-     *
-     * False by default.
-     */
-    readonly provideStorageFileFirestoreCollections?: boolean;
-}
-/**
- * Creates EnvironmentProviders for the DBX_FIRESTORE_CONTEXT_TOKEN, appCollectionClass, and optionally the SystemStateFirestoreCollections and NotificationFirestoreCollections.
- *
- * @param config Configuration for the providers.
- * @returns EnvironmentProviders
- */
-export declare function provideDbxFirestoreCollection<T>(config: ProvideDbxFirebaseFirestoreCollectionConfig<T>): EnvironmentProviders;

package/lib/firestore/index.d.ts

@@ -1,4 +0,0 @@
-export * from './firebase.firestore';
-export * from './firebase.firestore.module';
-export * from './firebase.firestore.providers';
-export * from './firebase.firestore.context.service';

package/lib/function/firebase.function.module.d.ts

@@ -1,16 +0,0 @@
-import { ModuleWithProviders } from '@angular/core';
-import { ProvideDbxFirebaseFunctionsConfig } from './firebase.function.providers';
-import { FirebaseFunctionsMap } from '@dereekb/firebase';
-import * as i0 from "@angular/core";
-export type DbxFirebaseFunctionsModuleConfig<T, M extends FirebaseFunctionsMap = FirebaseFunctionsMap> = ProvideDbxFirebaseFunctionsConfig<T, M>;
-/**
- * Used to initialize the LazyFirebaseFunctions type for a DbxFirebase app.
- *
- * @deprecated use provideDbxFirebaseFunctions() instead.
- */
-export declare class DbxFirebaseFunctionsModule {
-    static forRoot<T, M extends FirebaseFunctionsMap = FirebaseFunctionsMap>(config: DbxFirebaseFunctionsModuleConfig<T, M>): ModuleWithProviders<DbxFirebaseFunctionsModule>;
-    static ɵfac: i0.ɵɵFactoryDeclaration<DbxFirebaseFunctionsModule, never>;
-    static ɵmod: i0.ɵɵNgModuleDeclaration<DbxFirebaseFunctionsModule, never, never, never>;
-    static ɵinj: i0.ɵɵInjectorDeclaration<DbxFirebaseFunctionsModule>;
-}

package/lib/function/firebase.function.providers.d.ts

@@ -1,43 +0,0 @@
-import { type EnvironmentProviders } from '@angular/core';
-import { Functions } from '@angular/fire/functions';
-import { type FirebaseFunctionsConfigMap, type FirebaseFunctionsMap } from '@dereekb/firebase';
-import { type ClassLikeType } from '@dereekb/util';
-/**
- * Configuration for provideDbxFirebaseFunctions().
- */
-export interface ProvideDbxFirebaseFunctionsConfig<T, M extends FirebaseFunctionsMap = FirebaseFunctionsMap> {
-    /**
-     * The token to use for the functions getter.
-     *
-     * This is typically your LazyFirebaseFunctions result type.
-     */
-    functionsGetterToken: ClassLikeType<T>;
-    /**
-     * Factory function to retrieve the functions getter instance.
-     *
-     * @param functions The Firebase functions instance.
-     * @returns The functions getter instance.
-     */
-    functionsGetterFactory: (functions: Functions) => T;
-    /**
-     * Key of the functions config to use to inject FirebaseDevelopmentFunctions using that same provider.
-     *
-     * Defaults to "developmentFunctions". If false, will not be injected automatically.
-     */
-    developmentFunctionsKey?: string | false;
-    /**
-     * Optional functions config map to provide.
-     *
-     * If provided, will inject all the types with factory functions so they can be injected into the app.
-     */
-    functionsConfigMap?: FirebaseFunctionsConfigMap<M>;
-}
-/**
- * Creates EnvironmentProviders for the LazyFirebaseFunctions type for a DbxFirebase app.
- *
- * Also provides FirebaseDevelopmentFunctions if developmentFunctionsKey is provided.
- *
- * @param config Configuration for provideDbxFirebaseFunctions().
- * @returns EnvironmentProviders for the LazyFirebaseFunctions type.
- */
-export declare function provideDbxFirebaseFunctions<T, M extends FirebaseFunctionsMap = FirebaseFunctionsMap>(config: ProvideDbxFirebaseFunctionsConfig<T, M>): EnvironmentProviders;

package/lib/function/index.d.ts

@@ -1,2 +0,0 @@
-export * from './firebase.function.module';
-export * from './firebase.function.providers';

package/lib/index.d.ts

@@ -1,13 +0,0 @@
-export * from './analytics';
-export * from './auth';
-export * from './development';
-export * from './firebase';
-export * from './firestore';
-export * from './function';
-export * from './model';
-export * from './modules';
-export * from './pipe';
-export * from './router';
-export * from './storage';
-export * from './module';
-export * from './providers';

package/lib/model/error.d.ts

@@ -1,2 +0,0 @@
-export declare const DBX_FIREBASE_MODEL_DOES_NOT_EXIST_ERROR = "DOES_NOT_EXIST";
-export declare function modelDoesNotExistError(): import("@dereekb/util").ReadableErrorWithCode<import("@dereekb/util").ReadableError>;

package/lib/model/index.d.ts

@@ -1,6 +0,0 @@
-export * from './loader';
-export * from './service';
-export * from './modules';
-export * from './system';
-export * from './error';
-export * from './model.module';

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

@@ -1,57 +0,0 @@
-import { type ObservableOrValue } from '@dereekb/rxjs';
-import { type Destroyable, type Maybe, type Initialized } from '@dereekb/util';
-import { type DbxFirebaseCollectionChangeWatcher } from './collection.change.watcher';
-import { type DbxFirebaseCollectionLoaderAccessor } from './collection.loader';
-export 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>;
-    setTriggerFunction?: Maybe<DbxFirebaseCollectionChangeTriggerFunction<S>>;
-}
-export declare class DbxFirebaseCollectionChangeTriggerInstance<S extends DbxFirebaseCollectionLoaderAccessor<any>> implements DbxFirebaseCollectionChangeTrigger<S>, Initialized, Destroyable {
-    readonly watcher: DbxFirebaseCollectionChangeWatcher<S>;
-    private readonly _config;
-    private readonly _triggerFunction;
-    private readonly _sub;
-    constructor(config: DbxFirebaseCollectionChangeTriggerInstanceConfig<S>);
-    get 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.
- *
- * 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
- */
-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>;

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

@@ -1,44 +0,0 @@
-import { type IterationQueryDocChangeWatcherEvent } from '@dereekb/firebase';
-import { type Destroyable } from '@dereekb/util';
-import { type Observable } from 'rxjs';
-import { type DbxFirebaseCollectionLoaderAccessor } from './collection.loader';
-/**
- * DbxFirebaseCollectionChangeWatcher trigger modes
- * - auto: will automatically call trigger
- * - off: will never call trigger
- */
-export type DbxFirebaseCollectionChangeWatcherTriggerMode = 'auto' | 'off';
-export type DbxFirebaseCollectionChangeWatcherEvent = Pick<IterationQueryDocChangeWatcherEvent<unknown>, 'time' | 'type'>;
-/**
- * Used to watch a DbxFirebaseCollectionLoaderAccessor for when the query changes and
- */
-export interface DbxFirebaseCollectionChangeWatcher<S extends DbxFirebaseCollectionLoaderAccessor<any>> {
-    readonly store: S;
-    /**
-     * Current mode observable
-     */
-    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>;
-}
-/**
- * DbxFirebaseCollectionChangeWatcher instance that can be destroyed and the mode changed.
- */
-export interface DbxFirebaseCollectionChangeWatcherInstance<S extends DbxFirebaseCollectionLoaderAccessor<any>> extends DbxFirebaseCollectionChangeWatcher<S>, Destroyable {
-    /**
-     * Changes the mode
-     */
-    setMode(mode: DbxFirebaseCollectionChangeWatcherTriggerMode): void;
-}
-export declare function dbxFirebaseCollectionChangeWatcher<S extends DbxFirebaseCollectionLoaderAccessor<any>>(store: S, initialMode?: DbxFirebaseCollectionChangeWatcherTriggerMode): DbxFirebaseCollectionChangeWatcherInstance<S>;

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

@@ -1,61 +0,0 @@
-import { type DocumentDataWithIdAndKey, type FirebaseQueryItemAccumulator, type FirebaseQueryItemAccumulatorNextPageUntilResultsCountFunction, type FirebaseQuerySnapshotAccumulator, type FirestoreItemPageIterationInstance, type FirestoreQueryConstraint, type IterationQueryDocChangeWatcher } from '@dereekb/firebase';
-import { type ItemAccumulatorNextPageUntilResultsCountResult, type PageListLoadingState } from '@dereekb/rxjs';
-import { type Maybe, type ArrayOrValue, type PageNumber } from '@dereekb/util';
-import { type Observable } from 'rxjs';
-export interface DbxFirebaseCollectionLoaderAccessor<T = unknown> {
-    readonly constraints$: Observable<Maybe<ArrayOrValue<FirestoreQueryConstraint>>>;
-    readonly firestoreIteration$: Observable<FirestoreItemPageIterationInstance<T>>;
-    readonly pageLoadingState$: Observable<PageListLoadingState<DocumentDataWithIdAndKey<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.
-     *
-     * Changing this updates the iteration, but does not reset it.
-     */
-    maxPages: Maybe<number>;
-    /**
-     * Number of items to load per page.
-     *
-     * Changing this will reset the iteration.
-     */
-    itemsPerPage: Maybe<number>;
-    /**
-     * Sets the constraints on the model loader.
-     *
-     * @param constraints
-     */
-    setConstraints(constraints: Maybe<ArrayOrValue<FirestoreQueryConstraint>>): void;
-    /**
-     * 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,110 +0,0 @@
-import { type PageListLoadingState, type ItemAccumulatorNextPageUntilResultsCountResult } from '@dereekb/rxjs';
-import { BehaviorSubject, Subject, type Observable } from 'rxjs';
-import { type DocumentDataWithIdAndKey, type DocumentReference, type FirebaseQueryItemAccumulator, type FirebaseQueryItemAccumulatorNextPageUntilResultsCountFunction, type FirebaseQuerySnapshotAccumulator, type FirestoreCollectionLike, type FirestoreDocument, type FirestoreItemPageIterationInstance, type FirestoreItemPageIteratorFilter, type FirestoreModelKey, type FirestoreQueryConstraint, type IterationQueryDocChangeWatcher } from '@dereekb/firebase';
-import { type ArrayOrValue, type Destroyable, type GetterOrValue, type Initialized, type Maybe, type PageNumber } from '@dereekb/util';
-import { type DbxFirebaseCollectionLoaderAccessor, type DbxFirebaseCollectionLoaderWithAccumulator } from './collection.loader';
-/**
- * The store mode.
- *
- * - query: The store will load documents from a query, using the given collection.
- * - references: The store will load documents from the input references (keys, refs, etc.).
- */
-export type DbxFirebaseCollectionMode = 'query' | 'references';
-export interface DbxFirebaseCollectionLoaderInstanceInitConfig<T, D extends FirestoreDocument<T> = FirestoreDocument<T>> {
-    readonly collection?: Maybe<FirestoreCollectionLike<T, D>>;
-    readonly collectionMode?: DbxFirebaseCollectionMode;
-    readonly collectionKeys?: Maybe<FirestoreModelKey[]>;
-    readonly collectionRefs?: Maybe<DocumentReference<T>[]>;
-    readonly maxPages?: Maybe<number>;
-    readonly itemsPerPage?: Maybe<number>;
-    readonly constraints?: Maybe<ArrayOrValue<FirestoreQueryConstraint>>;
-    /**
-     * Whether or not to wait for non-null constraints before beginning the iteration.
-     *
-     * Defaults to true.
-     */
-    readonly waitForNonNullConstraints?: Maybe<boolean>;
-}
-export type DbxFirebaseCollectionLoaderInstanceData<T, D extends FirestoreDocument<T> = FirestoreDocument<T>> = DbxFirebaseCollectionLoaderAccessor<T>;
-/**
- * DbxFirebaseModelLoader implementation within an instance.
- */
-export declare class DbxFirebaseCollectionLoaderInstance<T = unknown, D extends FirestoreDocument<T> = FirestoreDocument<T>> implements DbxFirebaseCollectionLoaderWithAccumulator<T>, DbxFirebaseCollectionLoaderInstanceData<T, D>, Initialized, Destroyable {
-    private readonly _maxPagesSub;
-    protected readonly _collection: BehaviorSubject<Maybe<FirestoreCollectionLike<T, D, import("@dereekb/firebase").LimitedFirestoreDocumentAccessor<T, D>>>>;
-    protected readonly _collectionMode: BehaviorSubject<DbxFirebaseCollectionMode>;
-    protected readonly _collectionRefs: BehaviorSubject<Maybe<DocumentReference<T>[]>>;
-    protected readonly _maxPages: BehaviorSubject<Maybe<number>>;
-    protected readonly _itemsPerPage: BehaviorSubject<Maybe<number>>;
-    protected readonly _constraints: BehaviorSubject<Maybe<ArrayOrValue<FirestoreQueryConstraint<unknown>>>>;
-    protected readonly _waitForNonNullConstraints: BehaviorSubject<Maybe<boolean>>;
-    protected readonly _restart: Subject<void>;
-    readonly collection$: Observable<Maybe<FirestoreCollectionLike<T, D, import("@dereekb/firebase").LimitedFirestoreDocumentAccessor<T, D>>>>;
-    readonly collectionMode$: Observable<DbxFirebaseCollectionMode>;
-    readonly currentCollectionRefs$: Observable<Maybe<DocumentReference<T>[]>>;
-    readonly collectionRefs$: Observable<DocumentReference<T>[]>;
-    readonly collectionKeys$: Observable<string[]>;
-    readonly currentConstraints$: Observable<Maybe<ArrayOrValue<FirestoreQueryConstraint<unknown>>>>;
-    readonly constraints$: Observable<Maybe<ArrayOrValue<FirestoreQueryConstraint<unknown>>>>;
-    readonly iteratorFilter$: Observable<FirestoreItemPageIteratorFilter>;
-    readonly firestoreIteration$: Observable<FirestoreItemPageIterationInstance<T>>;
-    readonly queryChangeWatcher$: Observable<IterationQueryDocChangeWatcher<T>>;
-    readonly snapshotAccumulator$: Observable<FirebaseQuerySnapshotAccumulator<T>>;
-    readonly hasNext$: Observable<boolean>;
-    readonly canLoadMore$: Observable<boolean>;
-    readonly hasNextAndCanLoadMore$: Observable<boolean>;
-    readonly snapshotAccumulatorDocumentRefs$: Observable<DocumentReference<T>[][]>;
-    readonly snapshotAccumulatorDocuments$: Observable<D[][]>;
-    readonly accumulator$: Observable<FirebaseQueryItemAccumulator<T>>;
-    readonly accumulatorPage$: Observable<PageNumber>;
-    /**
-     * Passthrough for currentAllItems$ from the accumulator.
-     */
-    readonly currentAccumulatorItems$: Observable<DocumentDataWithIdAndKey<T>[][]>;
-    /**
-     * Passthrough for allItems$ from the accumulator.
-     */
-    readonly accumulatorItems$: Observable<DocumentDataWithIdAndKey<T>[][]>;
-    /**
-     * Returns true if the first page result has one or more documents.
-     */
-    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>);
-    init(): void;
-    destroy(): void;
-    get collectionMode(): DbxFirebaseCollectionMode;
-    set collectionMode(mode: DbxFirebaseCollectionMode);
-    get collectionKeys(): Maybe<FirestoreModelKey[]>;
-    set collectionKeys(keys: Maybe<FirestoreModelKey[]>);
-    get collectionRefs(): Maybe<DocumentReference<T>[]>;
-    set collectionRefs(refs: Maybe<DocumentReference<T>[]>);
-    get maxPages(): Maybe<number>;
-    set maxPages(maxPages: Maybe<number>);
-    get itemsPerPage(): Maybe<number>;
-    set itemsPerPage(itemsPerPage: Maybe<number>);
-    get constraints(): Maybe<ArrayOrValue<FirestoreQueryConstraint>>;
-    set constraints(constraints: Maybe<ArrayOrValue<FirestoreQueryConstraint>>);
-    get waitForNonNullConstraints(): Maybe<boolean>;
-    set waitForNonNullConstraints(waitForNonNullConstraints: Maybe<boolean>);
-    get collection(): Maybe<FirestoreCollectionLike<T, D>>;
-    set collection(collection: Maybe<FirestoreCollectionLike<T, D>>);
-    next(): void;
-    restart(): void;
-    setCollectionMode(mode: DbxFirebaseCollectionMode): void;
-    setCollectionKeys(keys: Maybe<FirestoreModelKey[]>): void;
-    setCollectionRefs(refs: Maybe<DocumentReference<T>[]>): void;
-    setMaxPages(maxPages: Maybe<number>): void;
-    setItemsPerPage(itemsPerPage: Maybe<number>): void;
-    setConstraints(constraints: Maybe<ArrayOrValue<FirestoreQueryConstraint>>): void;
-    setWaitForNonNullConstraints(waitForNonNullConstraints: Maybe<boolean>): 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>;