@dereekb/dbx-firebase 5.0.0 → 5.2.0

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,23 +1,24 @@
 import { LockSetComponentStore } from '@dereekb/dbx-core';
-import { FirestoreCollection, FirestoreCollectionWithParentFactory, FirestoreDocument } from "@dereekb/firebase";
-import { ObservableOrValue } from "@dereekb/rxjs";
-import { Maybe } from "@dereekb/util";
-import { ComponentStore } from "@ngrx/component-store";
-import { Observable, Subscription } from "rxjs";
-import { DbxFirebaseDocumentStore } from "./store.document";
+import { FirestoreCollectionLike, FirestoreCollectionWithParentFactory, FirestoreDocument } from '@dereekb/firebase';
+import { ObservableOrValue } from '@dereekb/rxjs';
+import { Maybe } from '@dereekb/util';
+import { ComponentStore } from '@ngrx/component-store';
+import { Observable, Subscription } from 'rxjs';
+import { DbxFirebaseDocumentStore } from './store.document';
 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>>;
 }
+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/lib/style/_config.scss

@@ -1,18 +1,20 @@
-@use "sass:map";
+@use 'sass:map';
 @use './variables';
 
 // theme
 @function define-dbx-firebase-theme-config($theme-config, $input-dbx-firebase-theme-config: null) {
-
   @if ($input-dbx-firebase-theme-config == null) {
     $input-dbx-firebase-theme-config: ();
   }
-  
+
   $dbx-firebase-theme-config: ();
 
-  @return map.merge($theme-config, (
-    'dbx-firebase': $dbx-firebase-theme-config
-  ));
+  @return map.merge(
+    $theme-config,
+    (
+      'dbx-firebase': $dbx-firebase-theme-config
+    )
+  );
 }
 
 @function get-dbx-firebase-theme-config($theme-config) {

package/lib/style/_core.scss

@@ -1,4 +1,4 @@
-@use "sass:map";
+@use 'sass:map';
 @use './all-core';
 @use './all-typography';
 @use './config';

package/lib/style/_mixin.scss

@@ -1,3 +1,3 @@
-@use "sass:map";
+@use 'sass:map';
 @use './config';
 @use './variables';

package/lib/style/_theming.scss

@@ -1,16 +1,6 @@
-@forward '@angular/material'show define-light-theme,
-define-dark-theme,
-define-palette,
-get-contrast-color-from-palette,
-get-color-from-palette,
-get-color-config,
-get-typography-config,
-get-density-config,
-elevation;
+@forward '@angular/material' show define-light-theme, define-dark-theme, define-palette, get-contrast-color-from-palette, get-color-from-palette, get-color-config, get-typography-config, get-density-config, elevation;
 
-@forward 'node_modules/@angular/material/core/theming/theming'
-show private-check-duplicate-theme-styles,
-$theme-ignore-duplication-warnings;
+@forward 'node_modules/@angular/material/core/theming/theming' show private-check-duplicate-theme-styles, $theme-ignore-duplication-warnings;
 
 @forward 'node_modules/@angular/material/core/typography/typography-utils';
 

package/lib/style/_variables.scss

@@ -1 +1 @@
-@use "sass:map";
+@use 'sass:map';

package/package.json

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