@dereekb/dbx-firebase 9.22.11 → 9.23.0

package/lib/model/model.module.d.ts

@@ -1,8 +1,9 @@
 import * as i0 from "@angular/core";
 import * as i1 from "./modules/store/model.store.module";
-import * as i2 from "./modules/model/model.types.module";
+import * as i2 from "./modules/model/model.history.module";
+import * as i3 from "./modules/model/model.types.module";
 export declare class DbxFirebaseModelModule {
     static ɵfac: i0.ɵɵFactoryDeclaration<DbxFirebaseModelModule, never>;
-    static ɵmod: i0.ɵɵNgModuleDeclaration<DbxFirebaseModelModule, never, never, [typeof i1.DbxFirebaseModelStoreModule, typeof i2.DbxFirebaseModelTypesModule]>;
+    static ɵmod: i0.ɵɵNgModuleDeclaration<DbxFirebaseModelModule, never, never, [typeof i1.DbxFirebaseModelStoreModule, typeof i2.DbxFirebaseModelHistoryModule, typeof i3.DbxFirebaseModelTypesModule]>;
     static ɵinj: i0.ɵɵInjectorDeclaration<DbxFirebaseModelModule>;
 }

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

@@ -1,3 +1,8 @@
+export * from './model.history.component';
+export * from './model.history.module';
+export * from './model.history.popover.button.component';
+export * from './model.history.popover.component';
+export * from './model.sourceselect.history';
 export * from './model.tracker.service';
 export * from './model.types.service';
 export * from './model.types.module';

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

@@ -0,0 +1,20 @@
+import { OnDestroy } from '@angular/core';
+import { AnchorForValueFunction } from '@dereekb/dbx-web';
+import { Maybe } from '@dereekb/util';
+import { DbxFirebaseModelTrackerHistoryFilter, DbxFirebaseModelTrackerService } from './model.tracker.service';
+import { DbxFirebaseModelTypesServiceInstancePair } from './model.types.service';
+import * as i0 from "@angular/core";
+export declare class DbxFirebaseModelHistoryComponent implements OnDestroy {
+    readonly dbxFirebaseModelTrackerService: DbxFirebaseModelTrackerService;
+    private _historyFilter;
+    anchorForItem?: Maybe<AnchorForValueFunction<DbxFirebaseModelTypesServiceInstancePair>>;
+    get historyFilter(): Maybe<DbxFirebaseModelTrackerHistoryFilter>;
+    set historyFilter(historyFilter: Maybe<DbxFirebaseModelTrackerHistoryFilter>);
+    readonly historyFilter$: import("rxjs").Observable<Maybe<DbxFirebaseModelTrackerHistoryFilter>>;
+    readonly historyPairs$: import("rxjs").Observable<DbxFirebaseModelTypesServiceInstancePair<any, string>[]>;
+    readonly state$: import("rxjs").Observable<import("@dereekb/rxjs").LoadingState<DbxFirebaseModelTypesServiceInstancePair<any, string>[]>>;
+    constructor(dbxFirebaseModelTrackerService: DbxFirebaseModelTrackerService);
+    ngOnDestroy(): void;
+    static ɵfac: i0.ɵɵFactoryDeclaration<DbxFirebaseModelHistoryComponent, never>;
+    static ɵcmp: i0.ɵɵComponentDeclaration<DbxFirebaseModelHistoryComponent, "dbx-firebase-model-history", never, { "anchorForItem": "anchorForItem"; "historyFilter": "historyFilter"; }, {}, never, ["[empty]"], false>;
+}

package/lib/model/modules/model/model.history.module.d.ts

@@ -0,0 +1,12 @@
+import * as i0 from "@angular/core";
+import * as i1 from "./model.history.component";
+import * as i2 from "./model.history.popover.button.component";
+import * as i3 from "./model.history.popover.component";
+import * as i4 from "@angular/common";
+import * as i5 from "@dereekb/dbx-web";
+import * as i6 from "./model.types.module";
+export declare class DbxFirebaseModelHistoryModule {
+    static ɵfac: i0.ɵɵFactoryDeclaration<DbxFirebaseModelHistoryModule, never>;
+    static ɵmod: i0.ɵɵNgModuleDeclaration<DbxFirebaseModelHistoryModule, [typeof i1.DbxFirebaseModelHistoryComponent, typeof i2.DbxFirebaseModelHistoryPopoverButtonComponent, typeof i3.DbxFirebaseModelHistoryPopoverComponent], [typeof i4.CommonModule, typeof i5.DbxButtonModule, typeof i5.DbxRouterListModule, typeof i5.DbxPopoverInteractionModule, typeof i5.DbxModelInfoModule, typeof i5.DbxListLayoutModule, typeof i6.DbxFirebaseModelTypesModule], [typeof i1.DbxFirebaseModelHistoryComponent, typeof i2.DbxFirebaseModelHistoryPopoverButtonComponent, typeof i3.DbxFirebaseModelHistoryPopoverComponent]>;
+    static ɵinj: i0.ɵɵInjectorDeclaration<DbxFirebaseModelHistoryModule>;
+}

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

@@ -0,0 +1,16 @@
+import { ElementRef } from '@angular/core';
+import { AbstractPopoverRefDirective, DbxPopoverService } from '@dereekb/dbx-web';
+import { NgPopoverRef } from 'ng-overlay-container';
+import { DbxFirebaseModelHistoryPopoverParams } from './model.history.popover.component';
+import * as i0 from "@angular/core";
+export declare type DbxFirebaseModelHistoryPopoverButtonConfig = DbxFirebaseModelHistoryPopoverParams;
+export declare class DbxFirebaseModelHistoryPopoverButtonComponent extends AbstractPopoverRefDirective<unknown, unknown> {
+    private readonly popupService;
+    buttonElement: ElementRef;
+    config?: DbxFirebaseModelHistoryPopoverButtonConfig;
+    constructor(popupService: DbxPopoverService);
+    protected _makePopoverRef(origin?: ElementRef): NgPopoverRef<unknown, unknown>;
+    showHistoryPopover(): void;
+    static ɵfac: i0.ɵɵFactoryDeclaration<DbxFirebaseModelHistoryPopoverButtonComponent, never>;
+    static ɵcmp: i0.ɵɵComponentDeclaration<DbxFirebaseModelHistoryPopoverButtonComponent, "dbx-firebase-model-history-popover-button", never, { "config": "config"; }, {}, never, never, false>;
+}

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

@@ -0,0 +1,50 @@
+import { ElementRef } from '@angular/core';
+import { NgPopoverRef } from 'ng-overlay-container';
+import { AbstractPopoverDirective, AnchorForValueFunction, DbxPopoverComponent, DbxPopoverKey, DbxPopoverService } from '@dereekb/dbx-web';
+import { Maybe } from '@dereekb/util';
+import { DbxFirebaseModelTypesServiceInstancePair } from './model.types.service';
+import { DbxFirebaseModelTrackerHistoryFilter } from './model.tracker.service';
+import * as i0 from "@angular/core";
+export interface DbxFirebaseModelHistoryPopoverParams {
+    /**
+     * Custom icon
+     *
+     * Defaults to "history"
+     */
+    icon?: string;
+    /**
+     * Custom header text
+     *
+     * Defaults to "History"
+     */
+    header?: string;
+    /**
+     * Custom empty text when no items exist.
+     */
+    emptyText?: string;
+    /**
+     * Origin to add the popover to.
+     */
+    origin: ElementRef;
+    /**
+     * Optional config to pass to the DbxFirebaseHistoryComponent
+     */
+    historyFilter?: Maybe<DbxFirebaseModelTrackerHistoryFilter>;
+    /**
+     * Anchor
+     */
+    anchorForItem?: Maybe<AnchorForValueFunction<DbxFirebaseModelTypesServiceInstancePair>>;
+}
+export declare const DEFAULT_FIREBASE_HISTORY_COMPONENT_POPOVER_KEY = "history";
+export declare class DbxFirebaseModelHistoryPopoverComponent extends AbstractPopoverDirective<unknown, DbxFirebaseModelHistoryPopoverParams> {
+    static openPopover(popupService: DbxPopoverService, { origin, header, icon, emptyText, historyFilter, anchorForItem }: DbxFirebaseModelHistoryPopoverParams, popoverKey?: DbxPopoverKey): NgPopoverRef;
+    constructor(popover: DbxPopoverComponent<unknown, DbxFirebaseModelHistoryPopoverParams>);
+    get params(): DbxFirebaseModelHistoryPopoverParams;
+    get icon(): string;
+    get header(): string;
+    get emptyText(): string;
+    get historyFilter(): Maybe<DbxFirebaseModelTrackerHistoryFilter>;
+    get anchorForItem(): Maybe<AnchorForValueFunction<DbxFirebaseModelTypesServiceInstancePair<any, string>>>;
+    static ɵfac: i0.ɵɵFactoryDeclaration<DbxFirebaseModelHistoryPopoverComponent, never>;
+    static ɵcmp: i0.ɵɵComponentDeclaration<DbxFirebaseModelHistoryPopoverComponent, "ng-component", never, {}, {}, never, never, false>;
+}

package/lib/model/modules/model/model.sourceselect.history.d.ts

@@ -0,0 +1,32 @@
+import { FirestoreDocument, FirestoreModelIdentity } from '@dereekb/firebase';
+import { SourceSelectLoadSource } from '@dereekb/dbx-form';
+import { Observable } from 'rxjs';
+import { GrantedRole } from '@dereekb/model';
+import { MapFunction } from '@dereekb/util';
+import { DbxFirebaseModelTypesServiceInstancePair } from './model.types.service';
+import { DbxFirebaseModelTrackerHistoryFilter, DbxFirebaseModelTrackerService } from './model.tracker.service';
+export interface DbxFirebaseSourceSelectLoadSourceConfig<M, D extends FirestoreDocument<any> = any, R extends GrantedRole = GrantedRole> extends Pick<DbxFirebaseModelTrackerHistoryFilter, 'filterItem'> {
+    /**
+     * Source label. Defaults to "History".
+     */
+    label?: string;
+    /**
+     * Type of model to pull from the history.
+     */
+    identity: FirestoreModelIdentity;
+    /**
+     * Maps a result instance to the target meta type
+     */
+    mapToMeta: MapFunction<DbxFirebaseModelTypesServiceInstancePair<D, R>, Observable<M>>;
+    /**
+     * Tracker service to load history values from.
+     */
+    dbxFirebaseModelTrackerService: DbxFirebaseModelTrackerService;
+}
+/**
+ * Configures a SourceSelectLoadSource using the DbxFirebaseModelTrackerService to load models of a specific identity.
+ *
+ * @param config
+ * @returns
+ */
+export declare function dbxFirebaseSourceSelectLoadSource<M>(config: DbxFirebaseSourceSelectLoadSourceConfig<M>): SourceSelectLoadSource<M>;

package/lib/model/modules/model/model.tracker.service.d.ts

@@ -1,10 +1,41 @@
+import { ArrayOrValue, Maybe } from '@dereekb/util';
+import { FirestoreModelIdentity } from '@dereekb/firebase';
 import { Observable } from 'rxjs';
 import { DbxModelTrackerService } from '@dereekb/dbx-web';
 import { DbxFirebaseModelTypesService, DbxFirebaseModelTypesServiceInstancePair } from './model.types.service';
+import { ObservableDecisionFunction } from '@dereekb/rxjs';
 import * as i0 from "@angular/core";
+export interface DbxFirebaseModelTrackerFilterItem {
+    instancePair: DbxFirebaseModelTypesServiceInstancePair;
+    identity: FirestoreModelIdentity;
+}
+export interface DbxFirebaseModelTrackerHistoryFilter {
+    /**
+     * Whether or not to exclude the values instead of include them.
+     */
+    invertFilter?: boolean;
+    /**
+     * Identity types to filter on.
+     */
+    identity?: Maybe<ArrayOrValue<FirestoreModelIdentity>>;
+    /**
+     * Arbitrary filter function to filter individual items.
+     */
+    filterItem?: ObservableDecisionFunction<DbxFirebaseModelTrackerFilterItem>;
+}
 export declare class DbxFirebaseModelTrackerService {
     readonly dbxModelTrackerService: DbxModelTrackerService;
     readonly dbxFirebaseModelTypesService: DbxFirebaseModelTypesService;
+    readonly historyKeys$: Observable<string[]>;
+    readonly historyPairs$: Observable<DbxFirebaseModelTypesServiceInstancePair<any, string>[]>;
+    readonly filterItemHistoryPairs$: Observable<DbxFirebaseModelTrackerFilterItem[]>;
+    /**
+     * Filters from historyPairs$ using the input filter configuration, if it is provided.
+     *
+     * @param filter
+     * @returns
+     */
+    filterHistoryPairs(filter?: Maybe<DbxFirebaseModelTrackerHistoryFilter>): Observable<DbxFirebaseModelTypesServiceInstancePair[]>;
     loadHistoryKeys(): Observable<string[]>;
     loadHistoryPairs(): Observable<DbxFirebaseModelTypesServiceInstancePair[]>;
     constructor(dbxModelTrackerService: DbxModelTrackerService, dbxFirebaseModelTypesService: DbxFirebaseModelTypesService);

package/package.json

@@ -1,16 +1,16 @@
 {
   "name": "@dereekb/dbx-firebase",
-  "version": "9.22.11",
+  "version": "9.23.0",
   "peerDependencies": {
     "@angular/common": "^14.0.0",
     "@angular/core": "^14.0.0",
-    "@dereekb/dbx-analytics": "9.22.11",
+    "@dereekb/dbx-analytics": "9.23.0",
     "firebase": "^9.9.2",
     "@angular/fire": "^7.4.1",
-    "@dereekb/firebase": "9.22.11",
+    "@dereekb/firebase": "9.23.0",
     "@angular/material": "^14.2.0",
-    "@dereekb/dbx-web": "9.22.11",
-    "@dereekb/dbx-form": "9.22.11"
+    "@dereekb/dbx-web": "9.23.0",
+    "@dereekb/dbx-form": "9.23.0"
   },
   "dependencies": {
     "tslib": "^2.3.0"