@dereekb/dbx-firebase 5.0.1 → 5.2.1

package/lib/auth/appcheck/appcheck.d.ts

@@ -0,0 +1,8 @@
+/**
+ * Enables debug token generation for AppCheck by setting FIREBASE_APPCHECK_DEBUG_TOKEN in the browser's self/window.
+ *
+ * https://firebase.google.com/docs/app-check/web/debug-provider
+ *
+ * @param enable
+ */
+export declare function enableAppCheckDebugTokenGeneration(enable?: boolean): void;

package/lib/auth/appcheck/appcheck.interceptor.d.ts

@@ -0,0 +1,19 @@
+import { DbxFirebaseOptions } from '../../firebase/options';
+import { HttpInterceptor, HttpRequest, HttpHandler, HttpEvent } from '@angular/common/http';
+import { Observable } from 'rxjs';
+import { AppCheck } from '@angular/fire/app-check';
+import * as i0 from "@angular/core";
+/**
+ * HTTP Interceptor that sets the X-Firebase-AppCheck for any requests to the routes configured in DbxFirebaseOptions.
+ */
+export declare class DbxFirebaseAppCheckHttpInterceptor implements HttpInterceptor {
+    private dbxFirebaseOptions;
+    private appCheck;
+    private _isEnabled;
+    private _appCheckRoutes;
+    constructor(dbxFirebaseOptions: DbxFirebaseOptions, appCheck: AppCheck);
+    intercept(req: HttpRequest<unknown>, next: HttpHandler): Observable<HttpEvent<unknown>>;
+    private matchesAnyRoute;
+    static ɵfac: i0.ɵɵFactoryDeclaration<DbxFirebaseAppCheckHttpInterceptor, never>;
+    static ɵprov: i0.ɵɵInjectableDeclaration<DbxFirebaseAppCheckHttpInterceptor>;
+}

package/lib/auth/appcheck/index.d.ts

@@ -0,0 +1,2 @@
+export * from './appcheck';
+export * from './appcheck.interceptor';

package/lib/auth/index.d.ts

@@ -1,3 +1,4 @@
+export * from './appcheck';
 export * from './login';
 export * from './service';
 export * from './firebase.auth.module';

package/lib/firebase/appcheck.d.ts

@@ -0,0 +1,21 @@
+import { AppCheckOptions } from '@firebase/app-check';
+export interface DbxFirebaseAppCheckConfig extends Partial<Omit<AppCheckOptions, 'provider'>> {
+    reCaptchaV3: string;
+    /**
+     * Whether or not to enable AppCheck debug tokens. AppCheck tokens are only printed into the console, and more actions must be taken.
+     * See https://firebase.google.com/docs/app-check/web/debug-provider for more info.
+     *
+     * Debug tokens are only generated when emulators are disabled, and allowDebugTokens is true.
+     */
+    allowDebugTokens?: boolean;
+    /**
+     * If true, disables AppCheck initialization for this app.
+     */
+    disabled?: boolean;
+    /**
+     * List of routes that app check is authorized to hit.
+     *
+     * If not defined, /api/* allowed by default.
+     */
+    appCheckRoutes?: string[];
+}

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

@@ -1,11 +1,12 @@
-import { ModuleWithProviders, InjectionToken } from '@angular/core';
+import { ModuleWithProviders } from '@angular/core';
 import { FirebaseOptions } from 'firebase/app';
 import * as i0 from "@angular/core";
 import * as i1 from "@angular/fire/firestore";
-import * as i2 from "@angular/fire/auth";
-import * as i3 from "@angular/fire/storage";
-import * as i4 from "@angular/fire/functions";
-import * as i5 from "@angular/fire/app";
+import * as i2 from "@angular/fire/app-check";
+import * as i3 from "@angular/fire/auth";
+import * as i4 from "@angular/fire/storage";
+import * as i5 from "@angular/fire/functions";
+import * as i6 from "@angular/fire/app";
 /**
  * Default firebase firestore provider module.
  */
@@ -14,12 +15,22 @@ export declare class DbxFirebaseDefaultFirestoreProviderModule {
     static ɵmod: i0.ɵɵNgModuleDeclaration<DbxFirebaseDefaultFirestoreProviderModule, never, [typeof i1.FirestoreModule], never>;
     static ɵinj: i0.ɵɵInjectorDeclaration<DbxFirebaseDefaultFirestoreProviderModule>;
 }
+/**
+ * Default firebase app check provider module.
+ *
+ * Also configures the DbxFirebaseAppCheckHttpInterceptor with HTTP_INTERCEPTORS in order for appCheck to be appended to requests to the api.
+ */
+export declare class DbxFirebaseDefaultAppCheckProviderModule {
+    static ɵfac: i0.ɵɵFactoryDeclaration<DbxFirebaseDefaultAppCheckProviderModule, never>;
+    static ɵmod: i0.ɵɵNgModuleDeclaration<DbxFirebaseDefaultAppCheckProviderModule, never, [typeof i2.AppCheckModule], never>;
+    static ɵinj: i0.ɵɵInjectorDeclaration<DbxFirebaseDefaultAppCheckProviderModule>;
+}
 /**
  * Default firebase auth provider module.
  */
 export declare class DbxFirebaseDefaultAuthProviderModule {
     static ɵfac: i0.ɵɵFactoryDeclaration<DbxFirebaseDefaultAuthProviderModule, never>;
-    static ɵmod: i0.ɵɵNgModuleDeclaration<DbxFirebaseDefaultAuthProviderModule, never, [typeof i2.AuthModule], never>;
+    static ɵmod: i0.ɵɵNgModuleDeclaration<DbxFirebaseDefaultAuthProviderModule, never, [typeof i3.AuthModule], never>;
     static ɵinj: i0.ɵɵInjectorDeclaration<DbxFirebaseDefaultAuthProviderModule>;
 }
 /**
@@ -27,7 +38,7 @@ export declare class DbxFirebaseDefaultAuthProviderModule {
  */
 export declare class DbxFirebaseDefaultStorageProviderModule {
     static ɵfac: i0.ɵɵFactoryDeclaration<DbxFirebaseDefaultStorageProviderModule, never>;
-    static ɵmod: i0.ɵɵNgModuleDeclaration<DbxFirebaseDefaultStorageProviderModule, never, [typeof i3.StorageModule], never>;
+    static ɵmod: i0.ɵɵNgModuleDeclaration<DbxFirebaseDefaultStorageProviderModule, never, [typeof i4.StorageModule], never>;
     static ɵinj: i0.ɵɵInjectorDeclaration<DbxFirebaseDefaultStorageProviderModule>;
 }
 /**
@@ -35,16 +46,15 @@ export declare class DbxFirebaseDefaultStorageProviderModule {
  */
 export declare class DbxFirebaseDefaultFunctionsProviderModule {
     static ɵfac: i0.ɵɵFactoryDeclaration<DbxFirebaseDefaultFunctionsProviderModule, never>;
-    static ɵmod: i0.ɵɵNgModuleDeclaration<DbxFirebaseDefaultFunctionsProviderModule, never, [typeof i4.FunctionsModule], never>;
+    static ɵmod: i0.ɵɵNgModuleDeclaration<DbxFirebaseDefaultFunctionsProviderModule, never, [typeof i5.FunctionsModule], never>;
     static ɵinj: i0.ɵɵInjectorDeclaration<DbxFirebaseDefaultFunctionsProviderModule>;
 }
-export declare const DBX_FIREBASE_OPTIONS_TOKEN: InjectionToken<unknown>;
 /**
  * Default provider module.
  */
 export declare class DbxFirebaseDefaultFirebaseProvidersModule {
     static forRoot(firebaseOptions: FirebaseOptions): ModuleWithProviders<DbxFirebaseDefaultFirebaseProvidersModule>;
     static ɵfac: i0.ɵɵFactoryDeclaration<DbxFirebaseDefaultFirebaseProvidersModule, never>;
-    static ɵmod: i0.ɵɵNgModuleDeclaration<DbxFirebaseDefaultFirebaseProvidersModule, never, [typeof i5.FirebaseAppModule, typeof DbxFirebaseDefaultFirestoreProviderModule, typeof DbxFirebaseDefaultAuthProviderModule, typeof DbxFirebaseDefaultStorageProviderModule, typeof DbxFirebaseDefaultFunctionsProviderModule], never>;
+    static ɵmod: i0.ɵɵNgModuleDeclaration<DbxFirebaseDefaultFirebaseProvidersModule, never, [typeof i6.FirebaseAppModule, typeof DbxFirebaseDefaultAppCheckProviderModule, typeof DbxFirebaseDefaultFirestoreProviderModule, typeof DbxFirebaseDefaultAuthProviderModule, typeof DbxFirebaseDefaultStorageProviderModule, typeof DbxFirebaseDefaultFunctionsProviderModule], never>;
     static ɵinj: i0.ɵɵInjectorDeclaration<DbxFirebaseDefaultFirebaseProvidersModule>;
 }

package/lib/firebase/index.d.ts

@@ -1,3 +1,4 @@
+export * from './appcheck';
 export * from './emulators';
 export * from './firebase.module';
 export * from './firebase.emulator.module';

package/lib/firebase/options.d.ts

@@ -1,8 +1,15 @@
+import { InjectionToken } from '@angular/core';
 import { FirebaseOptions } from 'firebase/app';
 import { DbxFirebaseLoginModuleRootConfig } from '../auth/login/firebase.login.module';
+import { DbxFirebaseAppCheckConfig } from './appcheck';
 import { DbxFirebaseEmulatorsConfig } from './emulators';
+export declare const DBX_FIREBASE_OPTIONS_TOKEN: InjectionToken<unknown>;
 export interface DbxFirebaseOptions extends FirebaseOptions, Pick<DbxFirebaseLoginModuleRootConfig, 'enabledLoginMethods'> {
     emulators: DbxFirebaseEmulatorsConfig;
+    /**
+     * Firebase AppCheck handling
+     */
+    appCheck?: DbxFirebaseAppCheckConfig;
     /**
      * Passed to the Functions initialization to set the domain to use when sending requests.
      */

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

@@ -1,10 +1,10 @@
 import { PageListLoadingState } from '@dereekb/rxjs';
 import { BehaviorSubject, Subject, Observable } from 'rxjs';
-import { FirebaseQueryItemAccumulator, FirestoreCollection, FirestoreDocument, FirestoreItemPageIterationInstance, FirestoreItemPageIteratorFilter, FirestoreQueryConstraint, IterationQueryDocChangeWatcher } from '@dereekb/firebase';
+import { 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>> {
-    collection?: Maybe<FirestoreCollection<T, D>>;
+    collection?: Maybe<FirestoreCollectionLike<T, D>>;
     maxPages?: Maybe<number>;
     itemsPerPage?: Maybe<number>;
     constraints?: Maybe<ArrayOrValue<FirestoreQueryConstraint>>;
@@ -19,13 +19,13 @@ export interface DbxFirebaseCollectionLoaderInstanceData<T, D extends FirestoreD
  */
 export declare class DbxFirebaseCollectionLoaderInstance<T = unknown, D extends FirestoreDocument<T> = FirestoreDocument<T>> implements DbxFirebaseCollectionLoader<T>, DbxFirebaseCollectionLoaderInstanceData<T, D>, Initialized, Destroyable {
     private readonly _initConfig?;
-    protected readonly _collection: BehaviorSubject<Maybe<FirestoreCollection<T, D>>>;
+    protected readonly _collection: BehaviorSubject<Maybe<FirestoreCollectionLike<T, D, import("@dereekb/firebase").LimitedFirestoreDocumentAccessor<T, D>>>>;
     protected readonly _maxPages: BehaviorSubject<Maybe<number>>;
     protected readonly _itemsPerPage: BehaviorSubject<Maybe<number>>;
     protected readonly _constraints: BehaviorSubject<Maybe<ArrayOrValue<FirestoreQueryConstraint<unknown>>>>;
     protected readonly _restart: Subject<void>;
     private readonly _maxPagesSub;
-    readonly collection$: Observable<Maybe<FirestoreCollection<T, D>>>;
+    readonly collection$: Observable<Maybe<FirestoreCollectionLike<T, D, import("@dereekb/firebase").LimitedFirestoreDocumentAccessor<T, D>>>>;
     readonly constraints$: Observable<Maybe<ArrayOrValue<FirestoreQueryConstraint<unknown>>>>;
     readonly iteratorFilter$: Observable<FirestoreItemPageIteratorFilter>;
     readonly firestoreIteration$: Observable<FirestoreItemPageIterationInstance<T>>;
@@ -41,12 +41,12 @@ export declare class DbxFirebaseCollectionLoaderInstance<T = unknown, D extends
     set itemsPerPage(itemsPerPage: Maybe<number>);
     get constraints(): Maybe<ArrayOrValue<FirestoreQueryConstraint>>;
     set constraints(constraints: Maybe<ArrayOrValue<FirestoreQueryConstraint>>);
-    get collection(): Maybe<FirestoreCollection<T, D>>;
-    set collection(collection: Maybe<FirestoreCollection<T, D>>);
+    get collection(): Maybe<FirestoreCollectionLike<T, D>>;
+    set collection(collection: Maybe<FirestoreCollectionLike<T, D>>);
     next(): void;
     restart(): void;
     setConstraints(constraints: Maybe<ArrayOrValue<FirestoreQueryConstraint>>): void;
-    setCollection(firestoreCollection: Maybe<FirestoreCollection<T, D>>): void;
+    setCollection(firestoreCollection: Maybe<FirestoreCollectionLike<T, D>>): void;
 }
 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<FirestoreCollection<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/store/index.d.ts

@@ -10,4 +10,5 @@ export * from './store.document.directive';
 export * from './store.document.router.directive';
 export * from './store.subcollection';
 export * from './store.subcollection.document';
+export * from './store.subcollection.directive';
 export * from './store.subcollection.rxjs';

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

@@ -1,12 +1,12 @@
 import { Observable, Subscription } from 'rxjs';
-import { FirebaseQueryItemAccumulator, FirestoreCollection, FirestoreDocument, FirestoreItemPageIterationInstance, FirestoreQueryConstraint, IterationQueryDocChangeWatcher } from '@dereekb/firebase';
+import { FirebaseQueryItemAccumulator, FirestoreCollectionLike, FirestoreDocument, FirestoreItemPageIterationInstance, FirestoreQueryConstraint, IterationQueryDocChangeWatcher } from '@dereekb/firebase';
 import { ObservableOrValue, PageListLoadingState } from '@dereekb/rxjs';
 import { ArrayOrValue, Maybe } from '@dereekb/util';
 import { LockSetComponentStore } from '@dereekb/dbx-core';
 import { DbxFirebaseCollectionLoaderInstance, DbxFirebaseCollectionLoaderInstanceData } from '../loader/collection.loader.instance';
 import * as i0 from "@angular/core";
 export interface DbxFirebaseCollectionStore<T, D extends FirestoreDocument<T> = FirestoreDocument<T>> extends DbxFirebaseCollectionLoaderInstanceData<T, D> {
-    readonly firestoreCollection$: Observable<Maybe<FirestoreCollection<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>>;
@@ -17,10 +17,10 @@ export interface DbxFirebaseCollectionStore<T, D extends FirestoreDocument<T> =
     setConstraints(observableOrValue: ObservableOrValue<Maybe<ArrayOrValue<FirestoreQueryConstraint>>>): Subscription;
     next(observableOrValue: ObservableOrValue<void>): void;
     restart(observableOrValue: ObservableOrValue<void>): void;
-    readonly setFirestoreCollection: (() => void) | ((observableOrValue: ObservableOrValue<Maybe<FirestoreCollection<T, D>>>) => Subscription);
+    readonly setFirestoreCollection: (() => void) | ((observableOrValue: ObservableOrValue<Maybe<FirestoreCollectionLike<T, D>>>) => Subscription);
 }
 export interface DbxFirebaseCollectionStoreContextState<T, D extends FirestoreDocument<T> = FirestoreDocument<T>> {
-    readonly firestoreCollection?: Maybe<FirestoreCollection<T, D>>;
+    readonly firestoreCollection?: Maybe<FirestoreCollectionLike<T, D>>;
     readonly maxPages?: Maybe<number>;
     readonly itemsPerPage?: Maybe<number>;
     readonly constraints?: Maybe<ArrayOrValue<FirestoreQueryConstraint>>;
@@ -34,14 +34,14 @@ export declare class AbstractDbxFirebaseCollectionStore<T, D extends FirestoreDo
     readonly setConstraints: (observableOrValue: Maybe<ArrayOrValue<FirestoreQueryConstraint<unknown>>> | Observable<Maybe<ArrayOrValue<FirestoreQueryConstraint<unknown>>>>) => Subscription;
     readonly next: () => void;
     readonly restart: () => void;
-    readonly currentFirestoreCollection$: Observable<Maybe<FirestoreCollection<T, D>>>;
-    readonly firestoreCollection$: Observable<FirestoreCollection<T, D>>;
+    readonly currentFirestoreCollection$: Observable<Maybe<FirestoreCollectionLike<T, D>>>;
+    readonly firestoreCollection$: Observable<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<T>>;
-    readonly setFirestoreCollection: (() => void) | ((observableOrValue: FirestoreCollection<T, D> | Observable<FirestoreCollection<T, D> | null | undefined> | null | undefined) => Subscription);
+    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

@@ -27,4 +27,4 @@ export declare abstract class DbxFirebaseCollectionStoreDirective<T = unknown, D
  * @param sourceType
  */
 export declare function provideDbxFirebaseCollectionStoreDirective<S extends DbxFirebaseCollectionStoreDirective<any, any, any>>(sourceType: Type<S>): Provider[];
-export declare function provideDbxFirebaseCollectionStoreDirective<S extends DbxFirebaseCollectionStore<any, any>, C extends DbxFirebaseCollectionStoreDirective<any, any, S> = DbxFirebaseCollectionStoreDirective<any, any, S>>(sourceType: Type<C>, storeType: Type<S>): Provider[];
+export declare function provideDbxFirebaseCollectionStoreDirective<S extends DbxFirebaseCollectionStore<any, any>, C extends DbxFirebaseCollectionStoreDirective<any, any, S> = DbxFirebaseCollectionStoreDirective<any, any, S>>(sourceType: Type<C>, storeType?: Type<S>): Provider[];

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

@@ -1,31 +1,51 @@
-import { Observable } from 'rxjs';
-import { FirestoreCollectionWithParentFactory, FirestoreDocument } from '@dereekb/firebase';
 import { Maybe } from '@dereekb/util';
+import { ObservableOrValue } from '@dereekb/rxjs';
+import { Observable, Subscription } from 'rxjs';
+import { FirestoreCollectionGroup, FirestoreCollectionWithParentFactory, FirestoreDocument } from '@dereekb/firebase';
 import { AbstractDbxFirebaseCollectionStore, DbxFirebaseCollectionStore, DbxFirebaseCollectionStoreContextState } from './store.collection';
-import { DbxFirebaseComponentStoreWithParent, DbxFirebaseComponentStoreWithParentContextState, DbxFirebaseComponentStoreWithParentSetParentEffectFunction, DbxFirebaseComponentStoreWithParentSetParentStoreEffectFunction } from './store.subcollection.rxjs';
+import { DbxFirebaseComponentStoreSetParentEffectFunction, DbxFirebaseComponentStoreWithParent, DbxFirebaseComponentStoreWithParentContextState, DbxFirebaseComponentStoreWithParentSetParentStoreEffectFunction } from './store.subcollection.rxjs';
 import * as i0 from "@angular/core";
-export interface DbxFirebaseCollectionWithParentStore<T, PT, D extends FirestoreDocument<T> = FirestoreDocument<T>, PD extends FirestoreDocument<PT> = FirestoreDocument<PT>> extends DbxFirebaseCollectionStore<T, D>, DbxFirebaseComponentStoreWithParent<T, PT, D, PD> {
-}
+/**
+ * Whether or not to load values from a parent or a group.
+ */
+export declare type DbxFirebaseComponentStoreWithParentSourceMode = 'parent' | 'group';
 export interface DbxFirebaseCollectionWithParentStoreContextState<T, PT, D extends FirestoreDocument<T> = FirestoreDocument<T>, PD extends FirestoreDocument<PT> = FirestoreDocument<PT>> extends DbxFirebaseCollectionStoreContextState<T, D>, DbxFirebaseComponentStoreWithParentContextState<T, PT, D, PD> {
+    readonly mode?: Maybe<DbxFirebaseComponentStoreWithParentSourceMode>;
+    readonly collectionGroup?: Maybe<FirestoreCollectionGroup<T, D>>;
+}
+export declare type DbxFirebaseComponentStoreWithParentSetParentSourceModeFunction = (observableOrValue: ObservableOrValue<Maybe<DbxFirebaseComponentStoreWithParentSourceMode>>) => Subscription;
+export interface DbxFirebaseCollectionWithParentStore<T, PT, D extends FirestoreDocument<T> = FirestoreDocument<T>, PD extends FirestoreDocument<PT> = FirestoreDocument<PT>> extends DbxFirebaseCollectionStore<T, D>, DbxFirebaseComponentStoreWithParent<T, PT, D, PD> {
+    readonly setSourceMode: DbxFirebaseComponentStoreWithParentSetParentSourceModeFunction;
+    readonly setCollectionGroup: (observableOrValue: FirestoreCollectionGroup<T, D> | Observable<FirestoreCollectionGroup<T, D>>) => Subscription;
+    readonly currentCollectionGroup$: Observable<Maybe<FirestoreCollectionGroup<T, D>>>;
+    readonly collectionGroup$: Observable<FirestoreCollectionGroup<T, D>>;
 }
 /**
  * Abstract DbxFirebaseCollectionStore that has a parent document from which is derives it's FiresbaseCollection from.
  */
 export declare class AbstractDbxFirebaseCollectionWithParentStore<T, PT, D extends FirestoreDocument<T> = FirestoreDocument<T>, PD extends FirestoreDocument<PT> = FirestoreDocument<PT>, C extends DbxFirebaseCollectionWithParentStoreContextState<T, PT, D, PD> = DbxFirebaseCollectionWithParentStoreContextState<T, PT, D, PD>> extends AbstractDbxFirebaseCollectionStore<T, D, C> implements DbxFirebaseCollectionWithParentStore<T, PT, D, PD> {
-    readonly setParent: DbxFirebaseComponentStoreWithParentSetParentEffectFunction<PD>;
+    constructor(state: C, defaultSourceMode?: DbxFirebaseComponentStoreWithParentSourceMode);
     readonly setParentStore: DbxFirebaseComponentStoreWithParentSetParentStoreEffectFunction<PT, PD>;
+    readonly setSourceMode: DbxFirebaseComponentStoreWithParentSetParentSourceModeFunction;
     readonly currentParent$: Observable<Maybe<PD>>;
     readonly parent$: Observable<PD>;
     readonly currentCollectionFactory$: Observable<Maybe<FirestoreCollectionWithParentFactory<T, PT, D, PD>>>;
     readonly collectionFactory$: Observable<FirestoreCollectionWithParentFactory<T, PT, D, PD>>;
+    readonly currentCollectionGroup$: Observable<Maybe<FirestoreCollectionGroup<T, D>>>;
+    readonly collectionGroup$: Observable<FirestoreCollectionGroup<T, D>>;
     /**
      * Sets the collection factory function to use.
      */
-    readonly setCollectionFactory: (observableOrValue: FirestoreCollectionWithParentFactory<T, PT, D, PD, import("@dereekb/firebase").FirestoreCollectionWithParent<T, PT, D, PD>> | Observable<FirestoreCollectionWithParentFactory<T, PT, D, PD, import("@dereekb/firebase").FirestoreCollectionWithParent<T, PT, D, PD>>>) => import("rxjs").Subscription;
+    readonly setCollectionFactory: (observableOrValue: FirestoreCollectionWithParentFactory<T, PT, D, PD, import("@dereekb/firebase").FirestoreCollectionWithParent<T, PT, D, PD>> | Observable<FirestoreCollectionWithParentFactory<T, PT, D, PD, import("@dereekb/firebase").FirestoreCollectionWithParent<T, PT, D, PD>>>) => Subscription;
+    /**
+     * Sets the collection group to use.
+     */
+    readonly setCollectionGroup: (observableOrValue: Maybe<FirestoreCollectionGroup<T, D>> | Observable<Maybe<FirestoreCollectionGroup<T, D>>>) => Subscription;
     /**
      * Sets the parent on the current state.
      */
-    readonly _setParentDocument: (() => void) | ((observableOrValue: Maybe<PD> | Observable<Maybe<PD>>) => import("rxjs").Subscription) | (PD extends void ? () => void : (observableOrValue: Maybe<PD> | Observable<Maybe<PD>>) => import("rxjs").Subscription);
-    static ɵfac: i0.ɵɵFactoryDeclaration<AbstractDbxFirebaseCollectionWithParentStore<any, any, any, any, any>, never>;
+    readonly _setParentDocument: (() => void) | ((observableOrValue: Maybe<PD> | Observable<Maybe<PD>>) => Subscription) | (PD extends void ? () => void : (observableOrValue: Maybe<PD> | Observable<Maybe<PD>>) => Subscription);
+    readonly _setParent: DbxFirebaseComponentStoreSetParentEffectFunction<PD>;
+    static ɵfac: i0.ɵɵFactoryDeclaration<AbstractDbxFirebaseCollectionWithParentStore<any, any, any, any, any>, [{ optional: true; }, { optional: true; }]>;
     static ɵprov: i0.ɵɵInjectableDeclaration<AbstractDbxFirebaseCollectionWithParentStore<any, any, any, any, any>>;
 }

package/lib/model/store/store.subcollection.directive.d.ts

@@ -0,0 +1,23 @@
+import { Provider, Type } from '@angular/core';
+import { FirestoreDocument } from '@dereekb/firebase';
+import { Maybe } from '@dereekb/util';
+import { DbxFirebaseCollectionStoreDirective } from './store.collection.directive';
+import { DbxFirebaseCollectionWithParentStore, DbxFirebaseComponentStoreWithParentSourceMode } from './store.subcollection';
+import * as i0 from "@angular/core";
+/**
+ * Abstract directive that contains a DbxFirebaseCollectionWithParentStore and provides an interface for communicating with other directives.
+ */
+export declare abstract class DbxFirebaseCollectionWithParentStoreDirective<T, PT, D extends FirestoreDocument<T> = FirestoreDocument<T>, PD extends FirestoreDocument<PT> = FirestoreDocument<PT>, S extends DbxFirebaseCollectionWithParentStore<T, PT, D, PD> = DbxFirebaseCollectionWithParentStore<T, PT, D, PD>> extends DbxFirebaseCollectionStoreDirective<T, D, S> {
+    set sourceMode(sourceMode: Maybe<DbxFirebaseComponentStoreWithParentSourceMode>);
+    static ɵfac: i0.ɵɵFactoryDeclaration<DbxFirebaseCollectionWithParentStoreDirective<any, any, any, any, any>, never>;
+    static ɵdir: i0.ɵɵDirectiveDeclaration<DbxFirebaseCollectionWithParentStoreDirective<any, any, any, any, any>, never, never, { "sourceMode": "sourceMode"; }, {}, never>;
+}
+/**
+ * Configures providers for a DbxFirebaseCollectionWithParentStoreDirective.
+ *
+ * Can optionally also provide the actual store type to include in the providers array so it is instantiated by Angular.
+ *
+ * @param sourceType
+ */
+export declare function provideDbxFirebaseCollectionWithParentStoreDirective<S extends DbxFirebaseCollectionWithParentStoreDirective<any, any, any, any, any>>(sourceType: Type<S>): Provider[];
+export declare function provideDbxFirebaseCollectionWithParentStoreDirective<S extends DbxFirebaseCollectionWithParentStore<any, any, any, any>, C extends DbxFirebaseCollectionWithParentStoreDirective<any, any, any, any, S> = DbxFirebaseCollectionWithParentStoreDirective<any, any, any, any, S>>(sourceType: Type<C>, storeType?: Type<S>): Provider[];

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

@@ -1,19 +1,20 @@
-import { Observable } from 'rxjs';
-import { FirestoreDocument, FirestoreCollectionWithParentFactory } from '@dereekb/firebase';
+import { Observable, Subscription } from 'rxjs';
+import { FirestoreDocument, FirestoreCollectionWithParentFactory, FirestoreCollection } from '@dereekb/firebase';
 import { Maybe } from '@dereekb/util';
 import { AbstractDbxFirebaseDocumentStore, DbxFirebaseDocumentStore, DbxFirebaseDocumentStoreContextState } from './store.document';
-import { DbxFirebaseComponentStoreWithParentSetParentEffectFunction, DbxFirebaseComponentStoreWithParentSetParentStoreEffectFunction, DbxFirebaseComponentStoreWithParent, DbxFirebaseComponentStoreWithParentContextState } from './store.subcollection.rxjs';
+import { DbxFirebaseComponentStoreWithParentSetParentStoreEffectFunction, DbxFirebaseComponentStoreWithParent, DbxFirebaseComponentStoreWithParentContextState, DbxFirebaseComponentStoreWithParentSetParentEffectFunction } from './store.subcollection.rxjs';
 import * as i0 from "@angular/core";
-export interface DbxFirebaseDocumentWithParentStore<T, PT, D extends FirestoreDocument<T> = FirestoreDocument<T>, PD extends FirestoreDocument<PT> = FirestoreDocument<PT>> extends DbxFirebaseDocumentStore<T, D>, DbxFirebaseComponentStoreWithParent<T, PT, D, PD> {
-}
 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> {
 }
+export interface DbxFirebaseDocumentWithParentStore<T, PT, D extends FirestoreDocument<T> = FirestoreDocument<T>, PD extends FirestoreDocument<PT> = FirestoreDocument<PT>> extends DbxFirebaseDocumentStore<T, D>, DbxFirebaseComponentStoreWithParent<T, PT, D, PD, FirestoreCollection<T, D>> {
+}
 /**
  * Abstract DbxFirebaseDocumentStore that has a parent document from which is derives it's FiresbaseCollection from.
  */
 export declare class AbstractDbxFirebaseDocumentWithParentStore<T, PT, D extends FirestoreDocument<T> = FirestoreDocument<T>, PD extends FirestoreDocument<PT> = FirestoreDocument<PT>, C extends DbxFirebaseDocumentWithParentStoreContextState<T, PT, D, PD> = DbxFirebaseDocumentWithParentStoreContextState<T, PT, D, PD>> extends AbstractDbxFirebaseDocumentStore<T, D, C> implements DbxFirebaseDocumentWithParentStore<T, PT, D, PD> {
-    readonly setParent: DbxFirebaseComponentStoreWithParentSetParentEffectFunction<PD>;
     readonly setParentStore: DbxFirebaseComponentStoreWithParentSetParentStoreEffectFunction<PT, PD>;
+    readonly setParent: DbxFirebaseComponentStoreWithParentSetParentEffectFunction<PD>;
+    readonly _setParent: DbxFirebaseComponentStoreWithParentSetParentEffectFunction<PD>;
     readonly currentParent$: Observable<Maybe<PD>>;
     readonly parent$: Observable<PD>;
     readonly currentCollectionFactory$: Observable<Maybe<FirestoreCollectionWithParentFactory<T, PT, D, PD>>>;
@@ -21,11 +22,11 @@ export declare class AbstractDbxFirebaseDocumentWithParentStore<T, PT, D extends
     /**
      * Sets the collection factory function to use.
      */
-    readonly setCollectionFactory: (observableOrValue: FirestoreCollectionWithParentFactory<T, PT, D, PD, import("@dereekb/firebase").FirestoreCollectionWithParent<T, PT, D, PD>> | Observable<FirestoreCollectionWithParentFactory<T, PT, D, PD, import("@dereekb/firebase").FirestoreCollectionWithParent<T, PT, D, PD>>>) => import("rxjs").Subscription;
+    readonly setCollectionFactory: (observableOrValue: FirestoreCollectionWithParentFactory<T, PT, D, PD, import("@dereekb/firebase").FirestoreCollectionWithParent<T, PT, D, PD>> | Observable<FirestoreCollectionWithParentFactory<T, PT, D, PD, import("@dereekb/firebase").FirestoreCollectionWithParent<T, PT, D, PD>>>) => Subscription;
     /**
      * Sets the parent on the current state.
      */
-    readonly _setParentDocument: (() => void) | ((observableOrValue: Maybe<PD> | Observable<Maybe<PD>>) => import("rxjs").Subscription) | (PD extends void ? () => void : (observableOrValue: Maybe<PD> | Observable<Maybe<PD>>) => import("rxjs").Subscription);
+    readonly _setParentDocument: (() => void) | ((observableOrValue: Maybe<PD> | Observable<Maybe<PD>>) => Subscription) | (PD extends void ? () => void : (observableOrValue: Maybe<PD> | Observable<Maybe<PD>>) => Subscription);
     static ɵfac: i0.ɵɵFactoryDeclaration<AbstractDbxFirebaseDocumentWithParentStore<any, any, any, any, any>, never>;
     static ɵprov: i0.ɵɵInjectableDeclaration<AbstractDbxFirebaseDocumentWithParentStore<any, any, any, any, any>>;
 }

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

@@ -1,5 +1,5 @@
 import { LockSetComponentStore } from '@dereekb/dbx-core';
-import { FirestoreCollection, FirestoreCollectionWithParentFactory, FirestoreDocument } from '@dereekb/firebase';
+import { FirestoreCollectionLike, FirestoreCollectionWithParentFactory, FirestoreDocument } from '@dereekb/firebase';
 import { ObservableOrValue } from '@dereekb/rxjs';
 import { Maybe } from '@dereekb/util';
 import { ComponentStore } from '@ngrx/component-store';
@@ -9,15 +9,16 @@ export interface DbxFirebaseComponentStoreWithParentContextState<T, PT, D extend
     readonly parent?: Maybe<PD>;
     readonly collectionFactory?: Maybe<FirestoreCollectionWithParentFactory<T, PT, D, PD>>;
 }
+export declare type DbxFirebaseComponentStoreSetParentEffectFunction<PD> = (parent: Observable<Maybe<PD>>) => Subscription;
 export declare type DbxFirebaseComponentStoreWithParentSetParentEffectFunction<PD> = (observableOrValue: ObservableOrValue<Maybe<PD>>) => Subscription;
 export declare type DbxFirebaseComponentStoreWithParentSetParentStoreEffectFunction<PT, PD extends FirestoreDocument<PT> = FirestoreDocument<PT>> = (observableOrValue: ObservableOrValue<DbxFirebaseDocumentStore<PT, PD>>) => Subscription;
-export interface DbxFirebaseComponentStoreWithParent<T, PT, D extends FirestoreDocument<T> = FirestoreDocument<T>, PD extends FirestoreDocument<PT> = FirestoreDocument<PT>> extends LockSetComponentStore<object>, Pick<ComponentStore<DbxFirebaseComponentStoreWithParentContextState<T, PT, D, PD>>, 'effect'> {
+export interface DbxFirebaseComponentStoreWithParent<T, PT, D extends FirestoreDocument<T> = FirestoreDocument<T>, PD extends FirestoreDocument<PT> = FirestoreDocument<PT>, A extends FirestoreCollectionLike<T, D> = FirestoreCollectionLike<T, D>> extends LockSetComponentStore<object>, Pick<ComponentStore<DbxFirebaseComponentStoreWithParentContextState<T, PT, D, PD>>, 'effect'> {
     readonly currentParent$: Observable<Maybe<PD>>;
     readonly parent$: Observable<PD>;
+    readonly currentCollectionFactory$: Observable<Maybe<FirestoreCollectionWithParentFactory<T, PT, D, PD>>>;
     readonly collectionFactory$: Observable<FirestoreCollectionWithParentFactory<T, PT, D, PD>>;
-    readonly setParent: DbxFirebaseComponentStoreWithParentSetParentEffectFunction<PD>;
+    readonly _setParent: DbxFirebaseComponentStoreSetParentEffectFunction<PD>;
     readonly _setParentDocument: (() => void) | ((observableOrValue: ObservableOrValue<Maybe<PD>>) => Subscription);
-    readonly setFirestoreCollection: (() => void) | ((observableOrValue: ObservableOrValue<Maybe<FirestoreCollection<T, D>>>) => Subscription);
+    readonly setFirestoreCollection: (() => void) | ((observableOrValue: ObservableOrValue<Maybe<A>>) => Subscription);
 }
-export declare function setParentStoreEffect<T, PT, D extends FirestoreDocument<T> = FirestoreDocument<T>, PD extends FirestoreDocument<PT> = FirestoreDocument<PT>>(store: DbxFirebaseComponentStoreWithParent<T, PT, D, PD>): DbxFirebaseComponentStoreWithParentSetParentStoreEffectFunction<PT, PD>;
-export declare function setParentEffect<T, PT, D extends FirestoreDocument<T> = FirestoreDocument<T>, PD extends FirestoreDocument<PT> = FirestoreDocument<PT>>(store: DbxFirebaseComponentStoreWithParent<T, PT, D, PD>): DbxFirebaseComponentStoreWithParentSetParentEffectFunction<PD>;
+export declare function setParentStoreEffect<T, PT, D extends FirestoreDocument<T> = FirestoreDocument<T>, PD extends FirestoreDocument<PT> = FirestoreDocument<PT>, A extends FirestoreCollectionLike<T, D> = FirestoreCollectionLike<T, D>>(store: DbxFirebaseComponentStoreWithParent<T, PT, D, PD, A>): DbxFirebaseComponentStoreWithParentSetParentStoreEffectFunction<PT, PD>;

package/package.json

@@ -1,17 +1,18 @@
 {
   "name": "@dereekb/dbx-firebase",
-  "version": "5.0.1",
+  "version": "5.2.1",
   "peerDependencies": {
     "@angular/common": "^13.0.0",
     "@angular/core": "^13.0.0",
+    "@dereekb/util": "5.2.1",
     "firebase": "^9.8.0",
-    "@dereekb/util": "5.0.1",
-    "@dereekb/dbx-core": "5.0.1",
-    "@angular/material": "^13.0.0",
-    "@dereekb/dbx-web": "5.0.1",
-    "@dereekb/dbx-form": "5.0.1",
+    "rxjs": "^7.0.0",
     "@angular/fire": "^7.3.0-canary.8d5bc12",
-    "@dereekb/firebase": "5.0.1"
+    "@dereekb/dbx-core": "5.2.1",
+    "@angular/material": "^13.0.0",
+    "@dereekb/dbx-web": "5.2.1",
+    "@dereekb/dbx-form": "5.2.1",
+    "@dereekb/firebase": "5.2.1"
   },
   "dependencies": {
     "tslib": "^2.3.0"