@dereekb/dbx-firebase 12.6.10 → 12.6.11

package/lib/model/modules/model/entities/index.d.ts

@@ -0,0 +1,5 @@
+export * from './model.entities.component';
+export * from './model.entities.popover.component';
+export * from './model.entities.popover.button.component';
+export * from './model.entities.source.directive';
+export * from './model.entities.widget.service';

package/lib/model/modules/model/entities/model.entities.component.d.ts

@@ -0,0 +1,25 @@
+import { OnDestroy } from '@angular/core';
+import { DbxFirebaseModelEntity, DbxFirebaseModelEntityWithKeyAndStore } from './model.entities';
+import { Observable } from 'rxjs';
+import { Maybe } from '@dereekb/util';
+import { LoadingState } from '@dereekb/rxjs';
+import * as i0 from "@angular/core";
+export declare class DbxFirebaseModelEntitiesComponent implements OnDestroy {
+    /**
+     * All input entities.
+     */
+    readonly entities: import("@angular/core").InputSignal<Observable<LoadingState<DbxFirebaseModelEntity[]>> | undefined>;
+    readonly entities$: Observable<LoadingState<DbxFirebaseModelEntity[]>>;
+    /**
+     * Whether the accordion should allow multiple expanded panels.
+     */
+    readonly multi: import("@angular/core").InputSignal<boolean>;
+    readonly entitiesWithKeysState$: Observable<LoadingState<DbxFirebaseModelEntityWithKeyAndStore[]>>;
+    readonly entitiesWithKeys$: Observable<Maybe<DbxFirebaseModelEntityWithKeyAndStore<any, import("dist/packages/firebase/src").FirestoreDocument<any, import("dist/packages/firebase/src").FirestoreModelIdentity>>[]>>;
+    readonly entitiesWithKeysSignal: import("@angular/core").Signal<Maybe<DbxFirebaseModelEntityWithKeyAndStore<any, import("dist/packages/firebase/src").FirestoreDocument<any, import("dist/packages/firebase/src").FirestoreModelIdentity>>[]>>;
+    readonly hasNoEntitiesSignal: import("@angular/core").Signal<boolean>;
+    readonly context: import("@dereekb/rxjs").MutableLoadingStateContext<unknown, LoadingState<DbxFirebaseModelEntityWithKeyAndStore<any, import("dist/packages/firebase/src").FirestoreDocument<any, import("dist/packages/firebase/src").FirestoreModelIdentity>>[]>, import("@dereekb/rxjs").LoadingContextEvent & LoadingState<DbxFirebaseModelEntityWithKeyAndStore<any, import("dist/packages/firebase/src").FirestoreDocument<any, import("dist/packages/firebase/src").FirestoreModelIdentity>>[]>>;
+    ngOnDestroy(): void;
+    static ɵfac: i0.ɵɵFactoryDeclaration<DbxFirebaseModelEntitiesComponent, never>;
+    static ɵcmp: i0.ɵɵComponentDeclaration<DbxFirebaseModelEntitiesComponent, "dbx-firebase-model-entities", never, { "entities": { "alias": "entities"; "required": false; "isSignal": true; }; "multi": { "alias": "multi"; "required": false; "isSignal": true; }; }, {}, never, ["[empty]"], true, never>;
+}

package/lib/model/modules/model/entities/model.entities.d.ts

@@ -0,0 +1,49 @@
+import { type FirestoreDocument, type FirestoreModelIdentity } from '@dereekb/firebase';
+import { type Maybe, type ModelKey } from '@dereekb/util';
+import { type DbxFirebaseDocumentReadOnlyStore } from '../../store/store';
+import { type LoadingState } from '@dereekb/rxjs';
+import { type Observable } from 'rxjs';
+/**
+ * Provides a source of entities.
+ */
+export declare abstract class DbxFirebaseModelEntitiesSource {
+    /**
+     * Observable of a LoadingState of entity values.
+     */
+    abstract readonly entities$: Observable<LoadingState<DbxFirebaseModelEntity[]>>;
+}
+/**
+ * A model entity.
+ */
+export interface DbxFirebaseModelEntity {
+    /**
+     * Model identity for the entity.
+     *
+     * Used for sorting/grouping by expected entity type.
+     */
+    readonly modelIdentity: FirestoreModelIdentity;
+    /**
+     * An associated store for the document, if it is available.
+     */
+    readonly store?: Maybe<DbxFirebaseDocumentReadOnlyStore<any, any>>;
+}
+export interface DbxFirebaseModelEntityWithStore<T = any, D extends FirestoreDocument<T> = FirestoreDocument<T>> extends DbxFirebaseModelEntity {
+    /**
+     * An associated store for the document, if it is available.
+     */
+    readonly store: DbxFirebaseDocumentReadOnlyStore<T, D>;
+}
+/**
+ * An entity that has a key.
+ */
+export interface DbxFirebaseModelEntityWithKey extends DbxFirebaseModelEntity {
+    /**
+     * The key of the target document.
+     */
+    readonly key: ModelKey;
+}
+/**
+ * An entity that has a key and a store.
+ */
+export interface DbxFirebaseModelEntityWithKeyAndStore<T = any, D extends FirestoreDocument<T> = FirestoreDocument<T>> extends Omit<DbxFirebaseModelEntityWithKey, 'store'>, DbxFirebaseModelEntityWithStore<T, D> {
+}

package/lib/model/modules/model/entities/model.entities.entity.component.d.ts

@@ -0,0 +1,18 @@
+import { DbxFirebaseModelEntity } from './model.entities';
+import { DbxFirebaseModelEntitiesWidgetService } from './model.entities.widget.service';
+import { DbxFirebaseModelTypesService } from '../model.types.service';
+import * as i0 from "@angular/core";
+export declare class DbxFirebaseModelEntitiesEntityComponent {
+    readonly widgetService: DbxFirebaseModelEntitiesWidgetService;
+    readonly modelTypesService: DbxFirebaseModelTypesService;
+    /**
+     * The input entity
+     */
+    readonly entity: import("@angular/core").InputSignal<DbxFirebaseModelEntity>;
+    readonly modelIdentity: import("@angular/core").Signal<import("dist/packages/firebase/src").FirestoreModelIdentity>;
+    readonly entity$: import("rxjs").Observable<DbxFirebaseModelEntity>;
+    readonly store$: import("rxjs").Observable<import("@dereekb/dbx-firebase").DbxFirebaseDocumentReadOnlyStore<any, any>>;
+    readonly loadingState$: import("rxjs").Observable<import("@dereekb/rxjs").LoadingState<any>>;
+    static ɵfac: i0.ɵɵFactoryDeclaration<DbxFirebaseModelEntitiesEntityComponent, never>;
+    static ɵcmp: i0.ɵɵComponentDeclaration<DbxFirebaseModelEntitiesEntityComponent, "dbx-firebase-model-entities-entity", never, { "entity": { "alias": "entity"; "required": true; "isSignal": true; }; }, {}, never, never, true, never>;
+}

package/lib/model/modules/model/entities/model.entities.popover.button.component.d.ts

@@ -0,0 +1,18 @@
+import { ElementRef } from '@angular/core';
+import { AbstractPopoverRefDirective } from '@dereekb/dbx-web';
+import { NgPopoverRef } from 'ng-overlay-container';
+import { DbxFirebaseModelEntitiesPopoverConfigWithoutOrigin } from './model.entities.popover.component';
+import { Maybe } from '@dereekb/util';
+import { DbxFirebaseModelEntitiesSource } from './model.entities';
+import * as i0 from "@angular/core";
+export type DbxFirebaseModelEntitiesPopoverButtonConfig = DbxFirebaseModelEntitiesPopoverConfigWithoutOrigin;
+export declare class DbxFirebaseModelEntitiesPopoverButtonComponent extends AbstractPopoverRefDirective<unknown, unknown> {
+    private readonly _dbxPopoverService;
+    readonly entitiesSource: DbxFirebaseModelEntitiesSource;
+    readonly buttonElement: import("@angular/core").Signal<ElementRef<any>>;
+    readonly config: import("@angular/core").InputSignal<DbxFirebaseModelEntitiesPopoverConfigWithoutOrigin | undefined>;
+    protected _makePopoverRef(origin?: Maybe<ElementRef>): NgPopoverRef<unknown, unknown>;
+    showEntitiesPopover(): void;
+    static ɵfac: i0.ɵɵFactoryDeclaration<DbxFirebaseModelEntitiesPopoverButtonComponent, never>;
+    static ɵcmp: i0.ɵɵComponentDeclaration<DbxFirebaseModelEntitiesPopoverButtonComponent, "dbx-firebase-model-entities-popover-button", never, { "config": { "alias": "config"; "required": false; "isSignal": true; }; }, {}, never, never, true, never>;
+}

package/lib/model/modules/model/entities/model.entities.popover.component.d.ts

@@ -0,0 +1,45 @@
+import { ElementRef } from '@angular/core';
+import { NgPopoverRef } from 'ng-overlay-container';
+import { AbstractPopoverDirective, DbxPopoverKey, DbxPopoverService } from '@dereekb/dbx-web';
+import { Observable } from 'rxjs';
+import { LoadingState } from '@dereekb/rxjs';
+import { DbxFirebaseModelEntity } from './model.entities';
+import * as i0 from "@angular/core";
+export interface DbxFirebaseModelEntitiesPopoverConfig {
+    /**
+     * Custom icon
+     *
+     * Defaults to "history"
+     */
+    readonly icon?: string;
+    /**
+     * Custom header text
+     *
+     * Defaults to "Entities"
+     */
+    readonly header?: string;
+    /**
+     * Custom empty text when no entities exist.
+     */
+    readonly emptyText?: string;
+    /**
+     * Origin to add the popover to.
+     */
+    readonly origin: ElementRef;
+    /**
+     * Observable of entities to display.
+     */
+    readonly entities$: Observable<LoadingState<DbxFirebaseModelEntity[]>>;
+}
+export type DbxFirebaseModelEntitiesPopoverConfigWithoutOrigin = Omit<DbxFirebaseModelEntitiesPopoverConfig, 'origin' | 'entities$'>;
+export declare const DEFAULT_DBX_FIREBASE_MODEL_ENTITIES_COMPONENT_POPOVER_KEY = "entities";
+export declare class DbxFirebaseModelEntitiesPopoverComponent extends AbstractPopoverDirective<unknown, DbxFirebaseModelEntitiesPopoverConfig> {
+    readonly entities$: Observable<LoadingState<DbxFirebaseModelEntity[]>> | undefined;
+    static openPopover(popupService: DbxPopoverService, { origin, header, icon, emptyText, entities$ }: DbxFirebaseModelEntitiesPopoverConfig, popoverKey?: DbxPopoverKey): NgPopoverRef;
+    get config(): DbxFirebaseModelEntitiesPopoverConfig;
+    readonly icon: string;
+    readonly header: string;
+    readonly emptyText: string;
+    static ɵfac: i0.ɵɵFactoryDeclaration<DbxFirebaseModelEntitiesPopoverComponent, never>;
+    static ɵcmp: i0.ɵɵComponentDeclaration<DbxFirebaseModelEntitiesPopoverComponent, "ng-component", never, {}, {}, never, never, true, never>;
+}

package/lib/model/modules/model/entities/model.entities.source.directive.d.ts

@@ -0,0 +1,8 @@
+import { DbxFirebaseModelEntitiesSource } from './model.entities';
+import { DbxFirebaseDocumentStoreContextStore } from '../../store/store.document.context.store';
+import * as i0 from "@angular/core";
+export declare const dbxFirebaseDocumentStoreContextModelEntitiesSourceFactory: (storeContextStore: DbxFirebaseDocumentStoreContextStore) => DbxFirebaseModelEntitiesSource;
+export declare class DbxFirebaseDocumentStoreContextModelEntitiesSourceDirective {
+    static ɵfac: i0.ɵɵFactoryDeclaration<DbxFirebaseDocumentStoreContextModelEntitiesSourceDirective, never>;
+    static ɵdir: i0.ɵɵDirectiveDeclaration<DbxFirebaseDocumentStoreContextModelEntitiesSourceDirective, "[dbxFirebaseDocumentStoreContextModelEntitiesSource]", never, {}, {}, never, never, true, never>;
+}

package/lib/model/modules/model/entities/model.entities.widget.service.d.ts

@@ -0,0 +1,44 @@
+import { Type } from '@angular/core';
+import { ArrayOrValue, Maybe } from '@dereekb/util';
+import { FirestoreModelIdentity } from '@dereekb/firebase';
+import * as i0 from "@angular/core";
+export interface DbxFirebaseModelEntitiesWidgetEntry {
+    /**
+     * Widget type to respond to.
+     */
+    readonly identity: FirestoreModelIdentity;
+    /**
+     * Widget component class to use.
+     */
+    readonly componentClass: Type<unknown>;
+}
+/**
+ * Configuration provided in the root module for configuring entries.
+ */
+export declare abstract class DbxFirebaseModelEntitiesWidgetServiceConfig {
+    /**
+     * Entries to register.
+     */
+    abstract entries: DbxFirebaseModelEntitiesWidgetEntry[];
+}
+/**
+ * Service used to register widgets used for model entities.
+ */
+export declare class DbxFirebaseModelEntitiesWidgetService {
+    private readonly _entries;
+    constructor(initialConfig: DbxFirebaseModelEntitiesWidgetServiceConfig);
+    /**
+     * Used to register one or more entries.
+     *
+     * If an entry with the same identity is already registered, this will override it by default.
+     *
+     * @param entries
+     * @param override
+     */
+    register(entries: ArrayOrValue<DbxFirebaseModelEntitiesWidgetEntry>, override?: boolean): void;
+    getAllRegisteredWidgetIdentities(): FirestoreModelIdentity[];
+    getWidgetEntry(identity: FirestoreModelIdentity): Maybe<DbxFirebaseModelEntitiesWidgetEntry>;
+    getWidgetEntries(identities: Iterable<FirestoreModelIdentity>): DbxFirebaseModelEntitiesWidgetEntry[];
+    static ɵfac: i0.ɵɵFactoryDeclaration<DbxFirebaseModelEntitiesWidgetService, never>;
+    static ɵprov: i0.ɵɵInjectableDeclaration<DbxFirebaseModelEntitiesWidgetService>;
+}

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

@@ -1,4 +1,5 @@
 export * from './history';
+export * from './entities';
 export * from './model.types.service';
 export * from './model.types.module';
 export * from './model.types.list.component';

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

@@ -1,4 +1,5 @@
 export * from './model.store.module';
+export * from './store';
 export * from './store.collection';
 export * from './store.collection.crud';
 export * from './store.collection.change.directive';
@@ -15,3 +16,6 @@ export * from './store.subcollection';
 export * from './store.subcollection.document';
 export * from './store.subcollection.directive';
 export * from './store.subcollection.rxjs';
+export * from './store.document.context.store';
+export * from './store.document.context.store.link';
+export * from './store.document.context.store.directive';

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

@@ -0,0 +1,79 @@
+import { type LockSetComponent } from '@dereekb/dbx-core';
+import { type FirestoreDocument, type FirestoreCollectionLike, type FirestoreCollection, type FirestoreModelId, type FirestoreModelKey, type DocumentReference, type FirestoreAccessorStreamMode, type FlatFirestoreModelKey, type TwoWayFlatFirestoreModelKey, type FirestoreModelCollectionAndIdPair, type FirestoreModelCollectionAndIdPairObject, type DocumentSnapshot, type DocumentDataWithIdAndKey, type FirestoreModelIdentity } from '@dereekb/firebase';
+import { type LoadingState, type ObservableOrValue } from '@dereekb/rxjs';
+import { type Maybe } from '@dereekb/util';
+import { type Observable, type Subscription } from 'rxjs';
+/**
+ * Provides read-only accessors to a single model/document.
+ */
+export interface DbxFirebaseDocumentReadOnlyStore<T, D extends FirestoreDocument<T> = FirestoreDocument<T>> {
+    readonly firestoreCollectionLike$: Observable<FirestoreCollectionLike<T, D>>;
+    readonly firestoreCollection$: Observable<FirestoreCollection<T, D>>;
+    readonly currentInputId$: Observable<Maybe<FirestoreModelId>>;
+    readonly inputId$: Observable<FirestoreModelId>;
+    readonly currentInputKey$: Observable<Maybe<FirestoreModelKey>>;
+    readonly inputKey$: Observable<FirestoreModelKey>;
+    readonly currentInputRef$: Observable<Maybe<DocumentReference<T>>>;
+    readonly inputRef$: Observable<DocumentReference<T>>;
+    readonly streamMode$: Observable<FirestoreAccessorStreamMode>;
+    readonly currentDocument$: Observable<Maybe<D>>;
+    readonly document$: Observable<D>;
+    readonly currentId$: Observable<Maybe<FirestoreModelId>>;
+    readonly currentKey$: Observable<Maybe<FirestoreModelKey>>;
+    readonly id$: Observable<FirestoreModelId>;
+    readonly key$: Observable<FirestoreModelKey>;
+    readonly ref$: Observable<DocumentReference<T>>;
+    readonly hasRef$: Observable<boolean>;
+    readonly flatKey$: Observable<FlatFirestoreModelKey>;
+    readonly twoWayFlatKey$: Observable<TwoWayFlatFirestoreModelKey>;
+    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<DocumentDataWithIdAndKey<T>>>;
+    readonly data$: Observable<DocumentDataWithIdAndKey<T>>;
+    readonly dataLoadingState$: Observable<LoadingState<DocumentDataWithIdAndKey<T>>>;
+    readonly isLoadingData$: Observable<boolean>;
+    readonly currentExists$: Observable<boolean>;
+    readonly exists$: Observable<boolean>;
+    readonly modelIdentity$: Observable<FirestoreModelIdentity>;
+}
+/**
+ * Provides accessors to a single model/document.
+ */
+export interface DbxFirebaseDocumentStore<T, D extends FirestoreDocument<T> = FirestoreDocument<T>> extends DbxFirebaseDocumentReadOnlyStore<T, D>, LockSetComponent {
+    /**
+     * Sets the id of the document to load.
+     */
+    readonly setId: (observableOrValue: ObservableOrValue<Maybe<FirestoreModelId>>) => Subscription;
+    /**
+     * Sets the key of the document to load.
+     */
+    readonly setKey: (observableOrValue: ObservableOrValue<Maybe<FirestoreModelKey>>) => Subscription;
+    /**
+     * Sets the key of the document to load using a TwoWayFlatFirestoreModelKey.
+     */
+    readonly setFlatKey: (observableOrValue: ObservableOrValue<Maybe<TwoWayFlatFirestoreModelKey>>) => Subscription;
+    /**
+     * Sets the ref of the document to load.
+     */
+    readonly setRef: (observableOrValue: ObservableOrValue<Maybe<DocumentReference<T>>>) => Subscription;
+    /**
+     * Clears the key/id/ref and current document from the store.
+     */
+    readonly clearRefs: () => void;
+    /**
+     * Sets the stream mode.
+     */
+    readonly setStreamMode: (observableOrValue: ObservableOrValue<FirestoreAccessorStreamMode>) => Subscription;
+    /**
+     * Sets the FirestoreCollection to retrieve documents from.
+     */
+    readonly setFirestoreCollection: (() => void) | ((observableOrValue: ObservableOrValue<Maybe<FirestoreCollection<T, D>>>) => Subscription);
+    /**
+     * Sets the FirestoreCollectionLike to retrieve documents from.
+     */
+    readonly setFirestoreCollectionLike: (() => void) | ((observableOrValue: ObservableOrValue<Maybe<FirestoreCollectionLike<T, D>>>) => Subscription);
+}

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

@@ -0,0 +1,59 @@
+import { ComponentStore } from '@ngrx/component-store';
+import { DbxFirebaseDocumentStore } from './store';
+import { FirestoreModelIdentity } from '@dereekb/firebase';
+import { Maybe } from '@dereekb/util';
+import { Observable } from 'rxjs';
+import * as i0 from "@angular/core";
+/**
+ * A unique number for a store entry.
+ */
+export type DbxFirebaseDocumentStoreContextStoreEntryNumber = number;
+/**
+ * A specifiy entry in the store.
+ *
+ * Used for caching information about a specific store.
+ */
+export interface DbxFirebaseDocumentStoreContextStoreEntry {
+    /**
+     * The number the entry was assigned when added to the store.
+     */
+    readonly entryNumber: DbxFirebaseDocumentStoreContextStoreEntryNumber;
+    /**
+     * The referenced document store.
+     */
+    readonly store: DbxFirebaseDocumentStore<unknown>;
+    readonly modelIdentity?: Maybe<FirestoreModelIdentity>;
+}
+export interface DbxFirebaseDocumentStoreContextStoreEntryWithIdentity extends Omit<DbxFirebaseDocumentStoreContextStoreEntry, 'modelIdentity'> {
+    readonly modelIdentity: FirestoreModelIdentity;
+}
+export interface DbxFirebaseDocumentStoreContextStoreState {
+    /**
+     * The next entry number to use for a new store.
+     */
+    readonly nextEntryNumber: DbxFirebaseDocumentStoreContextStoreEntryNumber;
+    /**
+     * The current number of entries
+     */
+    readonly currentEntryCount: number;
+    /**
+     * The map of all current stores.
+     *
+     * The map uses the store as the key for it's corresponding entry that contains additional information about the store.
+     */
+    readonly stores: Map<DbxFirebaseDocumentStore<unknown>, DbxFirebaseDocumentStoreContextStoreEntry>;
+    /**
+     * The last time the stores map was changed.
+     */
+    readonly lastStoresChangeAt: Date;
+}
+export declare class DbxFirebaseDocumentStoreContextStore extends ComponentStore<DbxFirebaseDocumentStoreContextStoreState> {
+    constructor();
+    readonly stores$: Observable<Map<DbxFirebaseDocumentStore<unknown, import("@dereekb/firebase").FirestoreDocument<unknown, FirestoreModelIdentity>>, DbxFirebaseDocumentStoreContextStoreEntry>>;
+    readonly lastStoresChangeAt$: Observable<Maybe<Date>>;
+    readonly entriesGroupedByIdentity$: Observable<DbxFirebaseDocumentStoreContextStoreEntryWithIdentity[]>;
+    readonly addStore: (observableOrValue: DbxFirebaseDocumentStore<unknown, import("@dereekb/firebase").FirestoreDocument<unknown, FirestoreModelIdentity>> | Observable<DbxFirebaseDocumentStore<unknown, import("@dereekb/firebase").FirestoreDocument<unknown, FirestoreModelIdentity>>>) => import("rxjs").Subscription;
+    readonly removeStore: (observableOrValue: DbxFirebaseDocumentStore<unknown, import("@dereekb/firebase").FirestoreDocument<unknown, FirestoreModelIdentity>> | Observable<DbxFirebaseDocumentStore<unknown, import("@dereekb/firebase").FirestoreDocument<unknown, FirestoreModelIdentity>>>) => import("rxjs").Subscription;
+    static ɵfac: i0.ɵɵFactoryDeclaration<DbxFirebaseDocumentStoreContextStore, never>;
+    static ɵprov: i0.ɵɵInjectableDeclaration<DbxFirebaseDocumentStoreContextStore>;
+}

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

@@ -0,0 +1,8 @@
+import * as i0 from "@angular/core";
+/**
+ * Directive that provides a DbxFirebaseDocumentStoreContextStore.
+ */
+export declare class DbxFirebaseDocumentStoreContextStoreDirective {
+    static ɵfac: i0.ɵɵFactoryDeclaration<DbxFirebaseDocumentStoreContextStoreDirective, never>;
+    static ɵdir: i0.ɵɵDirectiveDeclaration<DbxFirebaseDocumentStoreContextStoreDirective, "[dbxFirebaseDocumentStoreContextStore]", never, {}, {}, never, never, true, never>;
+}

package/lib/model/modules/store/store.document.context.store.link.d.ts

@@ -0,0 +1,17 @@
+import { InjectionToken, type Provider } from '@angular/core';
+import { DbxFirebaseDocumentStoreContextStore } from './store.document.context.store';
+import { type DbxFirebaseDocumentStore } from './store';
+/**
+ * Injection token for DbxFirebaseDocumentStoreContextStore.
+ */
+export declare const DBX_FIREBASE_DOCUMENT_STORE_CONTEXT_STORE_TOKEN: InjectionToken<DbxFirebaseDocumentStoreContextStore[]>;
+/**
+ * Provides the DbxFirebaseDocumentStoreContextStore.
+ */
+export declare function provideDbxFirebaseDocumentStoreContextStore(): Provider[];
+/**
+ * Links a DbxFirebaseDocumentStore to parent DbxFirebaseDocumentStoreContextStore instances.
+ *
+ * This should be called in an injectable context.
+ */
+export declare function linkDocumentStoreToParentContextStores(store: DbxFirebaseDocumentStore<any, any>): void;

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

@@ -2,7 +2,7 @@ import { type ModelFirebaseCreateFunction, type ModelFirebaseDeleteFunction, typ
 import { type LoadingState } from '@dereekb/rxjs';
 import { type PartialOnKeys } from '@dereekb/util';
 import { type Observable } from 'rxjs';
-import { type DbxFirebaseDocumentStore } from './store.document';
+import { type DbxFirebaseDocumentStore } from './store';
 export type DbxFirebaseDocumentStoreCreateFunction<I, O extends OnCallCreateModelResult = OnCallCreateModelResult> = (params: I) => Observable<LoadingState<O>>;
 /**
  * Creates a function for a store that DbxFirebaseDocumentStore captures the ModelFirebaseCreateFunction result and sets the key of the created value.

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

@@ -1,82 +1,12 @@
 import { Observable, Subscription } from 'rxjs';
-import { DocumentSnapshot, DocumentReference, FirestoreCollection, FirestoreDocument, DocumentDataWithIdAndKey, FirestoreModelId, FirestoreModelKey, FirestoreCollectionLike, FirestoreModelIdentity, FirestoreModelCollectionAndIdPair, FirestoreModelCollectionAndIdPairObject, FirestoreAccessorStreamMode, TwoWayFlatFirestoreModelKey, FlatFirestoreModelKey } from '@dereekb/firebase';
-import { LoadingState, ObservableOrValue } from '@dereekb/rxjs';
+import { DocumentSnapshot, DocumentReference, FirestoreCollection, FirestoreDocument, DocumentDataWithIdAndKey, FirestoreModelId, FirestoreModelKey, FirestoreCollectionLike, FirestoreModelIdentity, FirestoreModelCollectionAndIdPair, FirestoreModelCollectionAndIdPairObject, FirestoreAccessorStreamMode, FlatFirestoreModelKey } from '@dereekb/firebase';
+import { LoadingState } from '@dereekb/rxjs';
 import { Maybe } from '@dereekb/util';
-import { LockSetComponent, LockSetComponentStore } from '@dereekb/dbx-core';
+import { LockSetComponentStore } from '@dereekb/dbx-core';
+import { DbxFirebaseDocumentStore } from './store';
 import * as i0 from "@angular/core";
-export interface DbxFirebaseDocumentStore<T, D extends FirestoreDocument<T> = FirestoreDocument<T>> extends LockSetComponent {
-    readonly firestoreCollectionLike$: Observable<FirestoreCollectionLike<T, D>>;
-    readonly firestoreCollection$: Observable<FirestoreCollection<T, D>>;
-    readonly currentInputId$: Observable<Maybe<FirestoreModelId>>;
-    readonly inputId$: Observable<FirestoreModelId>;
-    readonly currentInputKey$: Observable<Maybe<FirestoreModelKey>>;
-    readonly inputKey$: Observable<FirestoreModelKey>;
-    readonly currentInputRef$: Observable<Maybe<DocumentReference<T>>>;
-    readonly inputRef$: Observable<DocumentReference<T>>;
-    readonly streamMode$: Observable<FirestoreAccessorStreamMode>;
-    readonly currentDocument$: Observable<Maybe<D>>;
-    readonly document$: Observable<D>;
-    readonly id$: Observable<FirestoreModelId>;
-    readonly key$: Observable<FirestoreModelKey>;
-    readonly ref$: Observable<DocumentReference<T>>;
-    readonly hasRef$: Observable<boolean>;
-    readonly flatKey$: Observable<FlatFirestoreModelKey>;
-    readonly twoWayFlatKey$: Observable<TwoWayFlatFirestoreModelKey>;
-    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<DocumentDataWithIdAndKey<T>>>;
-    readonly data$: Observable<DocumentDataWithIdAndKey<T>>;
-    readonly dataLoadingState$: Observable<LoadingState<DocumentDataWithIdAndKey<T>>>;
-    readonly isLoadingData$: Observable<boolean>;
-    readonly currentExists$: Observable<boolean>;
-    readonly exists$: Observable<boolean>;
-    readonly modelIdentity$: Observable<FirestoreModelIdentity>;
-    /**
-     * Sets the id of the document to load.
-     */
-    readonly setId: (observableOrValue: ObservableOrValue<Maybe<FirestoreModelId>>) => Subscription;
-    /**
-     * Sets the key of the document to load.
-     */
-    readonly setKey: (observableOrValue: ObservableOrValue<Maybe<FirestoreModelKey>>) => Subscription;
-    /**
-     * Sets the key of the document to load using a TwoWayFlatFirestoreModelKey.
-     */
-    readonly setFlatKey: (observableOrValue: ObservableOrValue<Maybe<TwoWayFlatFirestoreModelKey>>) => Subscription;
-    /**
-     * Sets the ref of the document to load.
-     */
-    readonly setRef: (observableOrValue: ObservableOrValue<Maybe<DocumentReference<T>>>) => Subscription;
-    /**
-     * Clears the key/id/ref and current document from the store.
-     */
-    readonly clearRefs: () => void;
-    /**
-     * Sets the stream mode.
-     */
-    readonly setStreamMode: (observableOrValue: ObservableOrValue<FirestoreAccessorStreamMode>) => Subscription;
-    /**
-     * Sets the FirestoreCollection to retrieve documents from.
-     */
-    readonly setFirestoreCollection: (() => void) | ((observableOrValue: ObservableOrValue<Maybe<FirestoreCollection<T, D>>>) => Subscription);
-    /**
-     * Sets the FirestoreCollectionLike to retrieve documents from.
-     */
-    readonly setFirestoreCollectionLike: (() => void) | ((observableOrValue: ObservableOrValue<Maybe<FirestoreCollectionLike<T, D>>>) => Subscription);
-}
-export interface DbxFirebaseDocumentStoreContextState<T, D extends FirestoreDocument<T> = FirestoreDocument<T>> {
-    readonly firestoreCollectionLike?: Maybe<FirestoreCollectionLike<T, D>>;
-    readonly firestoreCollection?: Maybe<FirestoreCollection<T, D>>;
-    readonly streamMode?: FirestoreAccessorStreamMode;
-    readonly id?: Maybe<FirestoreModelId>;
-    readonly key?: Maybe<FirestoreModelKey>;
-    readonly ref?: Maybe<DocumentReference<T>>;
-}
 export declare class AbstractDbxFirebaseDocumentStore<T, D extends FirestoreDocument<T> = FirestoreDocument<T>, C extends DbxFirebaseDocumentStoreContextState<T, D> = DbxFirebaseDocumentStoreContextState<T, D>> extends LockSetComponentStore<C> implements DbxFirebaseDocumentStore<T, D> {
+    protected constructor(initialState?: C);
     readonly currentFirestoreCollectionLike$: Observable<Maybe<FirestoreCollectionLike<T, D>>>;
     readonly currentFirestoreCollection$: Observable<Maybe<FirestoreCollection<T, D>>>;
     readonly firestoreCollectionLike$: Observable<FirestoreCollectionLike<T, D>>;
@@ -95,6 +25,8 @@ export declare class AbstractDbxFirebaseDocumentStore<T, D extends FirestoreDocu
     readonly hasRef$: Observable<boolean>;
     readonly document$: Observable<D>;
     readonly documentLoadingState$: Observable<LoadingState<D>>;
+    readonly currentId$: Observable<Maybe<FirestoreModelId>>;
+    readonly currentKey$: Observable<Maybe<FirestoreModelKey>>;
     readonly id$: Observable<FirestoreModelId>;
     readonly key$: Observable<FirestoreModelKey>;
     readonly keyModelIds$: Observable<FirestoreModelId[]>;
@@ -124,7 +56,7 @@ export declare class AbstractDbxFirebaseDocumentStore<T, D extends FirestoreDocu
     readonly clearRefs: () => void;
     readonly setFirestoreCollection: (() => void) | ((observableOrValue: Maybe<FirestoreCollection<T, D>> | Observable<Maybe<FirestoreCollection<T, D>>>) => Subscription);
     readonly setFirestoreCollectionLike: (() => void) | ((observableOrValue: Maybe<FirestoreCollectionLike<T, D, import("@dereekb/firebase").LimitedFirestoreDocumentAccessor<T, D>>> | Observable<Maybe<FirestoreCollectionLike<T, D, import("@dereekb/firebase").LimitedFirestoreDocumentAccessor<T, D>>>>) => Subscription);
-    static ɵfac: i0.ɵɵFactoryDeclaration<AbstractDbxFirebaseDocumentStore<any, any, any>, never>;
+    static ɵfac: i0.ɵɵFactoryDeclaration<AbstractDbxFirebaseDocumentStore<any, any, any>, [{ optional: true; }]>;
     static ɵprov: i0.ɵɵInjectableDeclaration<AbstractDbxFirebaseDocumentStore<any, any, any>>;
 }
 /**
@@ -156,3 +88,11 @@ export declare class AbstractRootSingleItemDbxFirebaseDocument<T, D extends Fire
     readonly setRef: (observableOrValue: Maybe<DocumentReference<T>> | Observable<Maybe<DocumentReference<T>>>) => Subscription;
     readonly clearRefs: () => void;
 }
+export interface DbxFirebaseDocumentStoreContextState<T, D extends FirestoreDocument<T> = FirestoreDocument<T>> {
+    readonly firestoreCollectionLike?: Maybe<FirestoreCollectionLike<T, D>>;
+    readonly firestoreCollection?: Maybe<FirestoreCollection<T, D>>;
+    readonly streamMode?: FirestoreAccessorStreamMode;
+    readonly id?: Maybe<FirestoreModelId>;
+    readonly key?: Maybe<FirestoreModelKey>;
+    readonly ref?: Maybe<DocumentReference<T>>;
+}

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

@@ -1,7 +1,7 @@
 import { OnDestroy, Provider, Type } from '@angular/core';
 import { DocumentReference, FirestoreAccessorStreamMode, FirestoreDocument, FirestoreModelKey, FirestoreModelId, TwoWayFlatFirestoreModelKey } from '@dereekb/firebase';
 import { ModelKey, type Maybe } from '@dereekb/util';
-import { DbxFirebaseDocumentStore } from './store.document';
+import { DbxFirebaseDocumentStore } from './store';
 import { Observable, Subscription } from 'rxjs';
 import { DbxRouteModelIdDirectiveDelegate, DbxRouteModelKeyDirectiveDelegate } from '@dereekb/dbx-core';
 import { DbxFirebaseDocumentStoreTwoWayKeyProvider } from './store.document.twoway.key.source';

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

@@ -1,7 +1,8 @@
 import { Observable, Subscription } from 'rxjs';
 import { FirestoreDocument, FirestoreCollectionWithParentFactory, FirestoreCollection, DocumentReference, FirestoreModelKey } from '@dereekb/firebase';
 import { type Maybe } from '@dereekb/util';
-import { AbstractDbxFirebaseDocumentStore, DbxFirebaseDocumentStore, DbxFirebaseDocumentStoreContextState } from './store.document';
+import { AbstractDbxFirebaseDocumentStore, DbxFirebaseDocumentStoreContextState } from './store.document';
+import { DbxFirebaseDocumentStore } from './store';
 import { DbxFirebaseComponentStoreWithParentSetParentStoreEffectFunction, DbxFirebaseComponentStoreWithParent, DbxFirebaseComponentStoreWithParentContextState, DbxFirebaseComponentStoreWithParentSetParentEffectFunction } from './store.subcollection.rxjs';
 import * as i0 from "@angular/core";
 export interface DbxFirebaseDocumentWithParentStoreContextState<T, PT, D extends FirestoreDocument<T> = FirestoreDocument<T>, PD extends FirestoreDocument<PT> = FirestoreDocument<PT>> extends DbxFirebaseDocumentStoreContextState<T, D>, DbxFirebaseComponentStoreWithParentContextState<T, PT, D, PD> {

package/lib/model/modules/store/store.subcollection.rxjs.d.ts

@@ -4,7 +4,7 @@ import { type ObservableOrValue } from '@dereekb/rxjs';
 import { type Maybe } from '@dereekb/util';
 import { type ComponentStore } from '@ngrx/component-store';
 import { type Observable, type Subscription } from 'rxjs';
-import { type DbxFirebaseDocumentStore } from './store.document';
+import { type DbxFirebaseDocumentStore } from './store';
 export interface DbxFirebaseComponentStoreWithParentContextState<T, PT, D extends FirestoreDocument<T> = FirestoreDocument<T>, PD extends FirestoreDocument<PT> = FirestoreDocument<PT>> {
     readonly parent?: Maybe<PD>;
     readonly collectionFactory?: Maybe<FirestoreCollectionWithParentFactory<T, PT, D, PD>>;

package/lib/modules/storagefile/storagefile.upload.module.d.ts

@@ -10,7 +10,7 @@ import * as i4 from "./container/storagefile.upload.sync.directive";
 import * as i5 from "./container/storagefile.upload.initialize.document.directive";
 import * as i6 from "./store/storagefile.collection.store.directive";
 import * as i7 from "./store/storagefile.document.store.directive";
-export declare const importsAndExports: (typeof DbxActionModule | typeof DbxActionSnackbarErrorDirective | typeof DbxFirebaseStorageFileCollectionStoreDirective | typeof DbxFirebaseStorageFileDocumentStoreDirective | typeof DbxFirebaseStorageFileUploadActionHandlerDirective | typeof DbxFirebaseStorageFileUploadInitializeDocumentDirective | typeof DbxFirebaseStorageFileUploadStoreDirective | typeof DbxFirebaseStorageFileUploadSyncDirective | typeof DbxFileUploadComponent | typeof DbxLoadingComponent | typeof DbxActionLoadingContextDirective | typeof DbxFileUploadActionSyncDirective)[];
+export declare const importsAndExports: (typeof DbxActionModule | typeof DbxLoadingComponent | typeof DbxActionSnackbarErrorDirective | typeof DbxFirebaseStorageFileCollectionStoreDirective | typeof DbxFirebaseStorageFileDocumentStoreDirective | typeof DbxFirebaseStorageFileUploadActionHandlerDirective | typeof DbxFirebaseStorageFileUploadInitializeDocumentDirective | typeof DbxFirebaseStorageFileUploadStoreDirective | typeof DbxFirebaseStorageFileUploadSyncDirective | typeof DbxFileUploadComponent | typeof DbxActionLoadingContextDirective | typeof DbxFileUploadActionSyncDirective)[];
 /**
  * Convenience module for importing various modules/components that are relevant to the storage file upload feature.
  *

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@dereekb/dbx-firebase",
-  "version": "12.6.10",
+  "version": "12.6.11",
   "peerDependencies": {
     "@angular/core": "^18.0.0",
     "@dereekb/dbx-analytics": "*",