@dereekb/dbx-web 9.19.4 → 9.20.0

package/lib/extension/index.d.ts

@@ -1 +1,2 @@
+export * from './model';
 export * from './widget';

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

@@ -0,0 +1,8 @@
+export * from './state';
+export * from './model.module';
+export * from './model.state.service';
+export * from './model.tracker.service';
+export * from './model.tracker';
+export * from './model.tracker.view.storage';
+export * from './model.types.service';
+export * from './model.types';

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

@@ -0,0 +1,19 @@
+import { ModuleWithProviders } from '@angular/core';
+import { SimpleStorageAccessorFactory } from '@dereekb/dbx-core';
+import { DbxModelViewTrackerStorage } from './model.tracker.view.storage';
+import * as i0 from "@angular/core";
+import * as i1 from "@angular/common";
+import * as i2 from "../../layout/list/list.layout.module";
+import * as i3 from "@dereekb/dbx-core";
+import * as i4 from "@ngrx/effects";
+import * as i5 from "@ngrx/store";
+export declare function appObjectViewTrackerStorageFactory(storageAccessorFactory: SimpleStorageAccessorFactory): DbxModelViewTrackerStorage;
+/**
+ * Contains components related to displaying content related to models identified only by their model key.
+ */
+export declare class DbxModelInfoModule {
+    static forRoot(): ModuleWithProviders<DbxModelInfoModule>;
+    static ɵfac: i0.ɵɵFactoryDeclaration<DbxModelInfoModule, never>;
+    static ɵmod: i0.ɵɵNgModuleDeclaration<DbxModelInfoModule, never, [typeof i1.CommonModule, typeof i2.DbxListLayoutModule, typeof i3.DbxInjectionComponentModule, typeof i4.EffectsFeatureModule, typeof i5.StoreFeatureModule], never>;
+    static ɵinj: i0.ɵɵInjectorDeclaration<DbxModelInfoModule>;
+}

package/lib/extension/model/model.state.service.d.ts

@@ -0,0 +1,14 @@
+import { Store } from '@ngrx/store';
+import { DbxModelObjectViewedParams } from './state/actions/model.actions';
+import { DbxModelFullState } from './state/state';
+import * as i0 from "@angular/core";
+export declare class DbxModelObjectStateService {
+    readonly store: Store<DbxModelFullState>;
+    constructor(store: Store<DbxModelFullState>);
+    /**
+     * Emit a model viewed event.
+     */
+    emitModelViewEvent({ modelKeyTypeNamePair }: DbxModelObjectViewedParams): void;
+    static ɵfac: i0.ɵɵFactoryDeclaration<DbxModelObjectStateService, never>;
+    static ɵprov: i0.ɵɵInjectableDeclaration<DbxModelObjectStateService>;
+}

package/lib/extension/model/model.tracker.d.ts

@@ -0,0 +1,18 @@
+import { UnixDateTimeNumber, ModelKeyTypePair, Maybe, ModelKey } from '@dereekb/util';
+export interface DbxModelViewTrackerEvent {
+    d?: UnixDateTimeNumber;
+    m: ModelKeyTypePair;
+    folder?: Maybe<string>;
+}
+export interface DbxModelViewTrackerEventSet {
+    /**
+     * The latest date/time number.
+     */
+    l: UnixDateTimeNumber;
+    /**
+     * List of events.
+     */
+    e: DbxModelViewTrackerEvent[];
+}
+export declare function allDbxModelViewTrackerEventSetModelKeys(eventSet: DbxModelViewTrackerEventSet): ModelKey[];
+export declare function allDbxModelViewTrackerEventModelKeys(events: DbxModelViewTrackerEvent[]): ModelKey[];

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

@@ -0,0 +1,20 @@
+import { Maybe, ModelKeyTypeNamePair } from '@dereekb/util';
+import { Observable } from 'rxjs';
+import { DbxModelViewTrackerEvent, DbxModelViewTrackerEventSet } from './model.tracker';
+import { DbxModelViewTrackerStorage } from './model.tracker.view.storage';
+import * as i0 from "@angular/core";
+/**
+ * Service used for tracking/logging different kinds of events on objects.
+ */
+export declare class DbxModelTrackerService {
+    private readonly viewTrackerStorage;
+    private _defaultFolder;
+    constructor(viewTrackerStorage: DbxModelViewTrackerStorage);
+    get defaultFolder(): Maybe<string>;
+    set defaultFolder(folder: Maybe<string>);
+    trackViewedObject(modelKeyTypeNamePair: ModelKeyTypeNamePair, folder?: Maybe<string>): void;
+    getAllViewEvents(folder?: Maybe<string>): Observable<DbxModelViewTrackerEvent[]>;
+    getViewEventSet(folder?: Maybe<string>): Observable<DbxModelViewTrackerEventSet>;
+    static ɵfac: i0.ɵɵFactoryDeclaration<DbxModelTrackerService, never>;
+    static ɵprov: i0.ɵɵInjectableDeclaration<DbxModelTrackerService>;
+}

package/lib/extension/model/model.tracker.view.storage.d.ts

@@ -0,0 +1,23 @@
+import { StorageAccessor } from '@dereekb/dbx-core';
+import { Maybe } from '@dereekb/util';
+import { Observable } from 'rxjs';
+import { DbxModelViewTrackerEventSet, DbxModelViewTrackerEvent } from './model.tracker';
+import * as i0 from "@angular/core";
+/**
+ * Used for managing DbxModelViewTrackerEvent storage.
+ */
+export declare class DbxModelViewTrackerStorage {
+    readonly storageAccessor: StorageAccessor<DbxModelViewTrackerEventSet>;
+    static readonly OBJECT_VIEW_TRACKER_STORAGE_LIST_KEY = "dbxModelViewTrackerEvents";
+    static readonly MAX_EVENTS = 60;
+    constructor(storageAccessor: StorageAccessor<DbxModelViewTrackerEventSet>);
+    protected get storageKey(): string;
+    protected get maxEventsToKeep(): number;
+    addEvent(event: DbxModelViewTrackerEvent): Observable<void>;
+    getAllEvents(folder?: Maybe<string>): Observable<DbxModelViewTrackerEvent[]>;
+    getEventSet(folder?: Maybe<string>): Observable<DbxModelViewTrackerEventSet>;
+    private _getEventSetForStorageKey;
+    getStorageKeyForFolder(folder?: Maybe<string>): string;
+    static ɵfac: i0.ɵɵFactoryDeclaration<DbxModelViewTrackerStorage, never>;
+    static ɵprov: i0.ɵɵInjectableDeclaration<DbxModelViewTrackerStorage>;
+}

package/lib/extension/model/model.types.d.ts

@@ -0,0 +1,27 @@
+import { SegueRef } from '@dereekb/dbx-core';
+import { FactoryWithRequiredInput, ModelKey, ModelTypeString } from '@dereekb/util';
+export interface DbxModelTypeConfiguration {
+    /**
+     * Popup label that can be used for these types.
+     */
+    label?: string;
+    /**
+     * Name used in analytics events. If not provided, label is used by default.
+     */
+    analyticsName?: string;
+    /**
+     * Model type this configuration is for.
+     */
+    modelType: ModelTypeString;
+    /**
+     * Sref factory for viewing objects of this type.
+     */
+    sref?: FactoryWithRequiredInput<SegueRef, ModelKey>;
+    /**
+     * Icon used to represent this model.
+     */
+    icon?: string;
+}
+export interface DbxModelTypeConfigurationMap {
+    [key: string]: DbxModelTypeConfiguration;
+}

package/lib/extension/model/model.types.service.d.ts

@@ -0,0 +1,32 @@
+import { Store } from '@ngrx/store';
+import { Observable } from 'rxjs';
+import { ArrayOrValue, ModelTypeString } from '@dereekb/util';
+import { DbxModelFullState } from './state';
+import { DbxModelTypeConfiguration, DbxModelTypeConfigurationMap } from './model.types';
+import * as i0 from "@angular/core";
+export interface DbxModelTypeInfo extends DbxModelTypeConfiguration {
+    /**
+     * Whether or not a response is expected for segues
+     * to a view for objects of this type.
+     */
+    canSegueToView: boolean;
+}
+export interface DbxModelTypesMap<I extends DbxModelTypeInfo> {
+    readonly [type: string]: I;
+}
+export interface DbxModelIconsMap {
+    readonly [type: string]: string;
+}
+export declare class DbxModelTypesService<I extends DbxModelTypeInfo = DbxModelTypeInfo> {
+    readonly store: Store<DbxModelFullState>;
+    private _configs;
+    static readonly DEFAULT_ICON = "help_outline";
+    constructor(store: Store<DbxModelFullState>);
+    addTypeConfigs(configs: ArrayOrValue<DbxModelTypeConfiguration>): void;
+    addTypeConfigsMap(configs: DbxModelTypeConfigurationMap): void;
+    readonly typesMap$: Observable<DbxModelTypesMap<I>>;
+    readonly iconMap$: Observable<DbxModelIconsMap>;
+    iconForType(type: ModelTypeString): Observable<string>;
+    static ɵfac: i0.ɵɵFactoryDeclaration<DbxModelTypesService<any>, never>;
+    static ɵprov: i0.ɵɵInjectableDeclaration<DbxModelTypesService<any>>;
+}

package/lib/extension/model/state/actions/actions.d.ts

@@ -0,0 +1 @@
+export declare const dbxModelResetState: import("@ngrx/store").ActionCreator<"[App/Model] Reset State", () => import("@ngrx/store/src/models").TypedAction<"[App/Model] Reset State">>;

package/lib/extension/model/state/actions/index.d.ts

@@ -0,0 +1,3 @@
+import * as DbxModelStateActions from './actions';
+import * as DbxModelStateModelActions from './model.actions';
+export { DbxModelStateActions, DbxModelStateModelActions };

package/lib/extension/model/state/actions/model.actions.d.ts

@@ -0,0 +1,8 @@
+import { ModelKeyTypeNamePair, ModelKeyTypePair } from '@dereekb/util';
+export interface DbxModelObjectViewedParams {
+    modelKeyTypeNamePair: ModelKeyTypeNamePair;
+}
+export interface DbxModelGoToObjectViewParams {
+    modelKeyTypePair: ModelKeyTypePair;
+}
+export declare const emitObjectViewEvent: import("@ngrx/store").ActionCreator<"[App/Model/Type] Object Viewed", (props: DbxModelObjectViewedParams) => DbxModelObjectViewedParams & import("@ngrx/store/src/models").TypedAction<"[App/Model/Type] Object Viewed">>;

package/lib/extension/model/state/effects/tracker.effects.d.ts

@@ -0,0 +1,16 @@
+import { Actions } from '@ngrx/effects';
+import { DbxModelTrackerService } from '../../model.tracker.service';
+import { onDbxModel } from '..';
+import * as i0 from "@angular/core";
+/**
+ * Used to pass Object Store events to the ObjectTracker.
+ */
+export declare class DbxModelTrackerEffects {
+    private readonly actions$;
+    private readonly dbxModelTrackerService;
+    constructor(actions$: Actions, dbxModelTrackerService: DbxModelTrackerService);
+    readonly trackModelViewed$: import("rxjs").Observable<onDbxModel.DbxModelStateModelActions.DbxModelObjectViewedParams & import("@ngrx/store/src/models").TypedAction<"[App/Model/Type] Object Viewed">> & import("@ngrx/effects").CreateEffectMetadata;
+    readonly changeTrackerFolderToMatchAuth$: import("rxjs").Observable<string> & import("@ngrx/effects").CreateEffectMetadata;
+    static ɵfac: i0.ɵɵFactoryDeclaration<DbxModelTrackerEffects, never>;
+    static ɵprov: i0.ɵɵInjectableDeclaration<DbxModelTrackerEffects>;
+}

package/lib/extension/model/state/index.d.ts

@@ -0,0 +1,5 @@
+export * from './state';
+export * from './actions';
+import * as onDbxModel from './actions';
+import * as fromDbxModel from './reducers';
+export { onDbxModel, fromDbxModel };

package/lib/extension/model/state/reducers/index.d.ts

@@ -0,0 +1,15 @@
+import { Action } from '@ngrx/store';
+import * as fromObjectModuleConfig from './model.module.config';
+import { DbxModelModuleStateConfiguration } from './model.module.config';
+export declare const featureKey = "app.model";
+export interface DbxModelState {
+    [fromObjectModuleConfig.stateFeatureKey]: DbxModelModuleStateConfiguration;
+}
+export interface State {
+    [featureKey]: DbxModelState;
+}
+export declare function reducers(state: DbxModelState | undefined, action: Action): {
+    "model.module.config": fromObjectModuleConfig.DbxModelModuleStateConfiguration;
+};
+export declare const selectDbxModelFeature: import("@ngrx/store").MemoizedSelector<State, DbxModelState, import("@ngrx/store").DefaultProjectorFn<DbxModelState>>;
+export declare const selectDbxModelFeatureObjectModuleConfig: import("@ngrx/store").MemoizedSelector<State, fromObjectModuleConfig.DbxModelModuleStateConfiguration, import("@ngrx/store").DefaultProjectorFn<fromObjectModuleConfig.DbxModelModuleStateConfiguration>>;

package/lib/extension/model/state/reducers/model.module.config.d.ts

@@ -0,0 +1,5 @@
+export interface DbxModelModuleStateConfiguration {
+}
+export declare const stateFeatureKey = "model.module.config";
+export declare const initialState: DbxModelModuleStateConfiguration;
+export declare const reducer: import("@ngrx/store").ActionReducer<DbxModelModuleStateConfiguration, import("@ngrx/store").Action>;

package/lib/extension/model/state/state.d.ts

@@ -0,0 +1,2 @@
+import * as fromDbxModel from './reducers';
+export declare type DbxModelFullState = fromDbxModel.State;

package/mapbox/package.json

@@ -1,11 +1,11 @@
 {
   "name": "@dereekb/dbx-web/mapbox",
-  "version": "9.19.4",
+  "version": "9.20.0",
   "peerDependencies": {
     "@angular/common": "^14.1.0",
     "@angular/core": "^14.1.0",
-    "@dereekb/dbx-core": "9.19.4",
-    "@dereekb/dbx-web": "9.19.4",
+    "@dereekb/dbx-core": "9.20.0",
+    "@dereekb/dbx-web": "9.20.0",
     "ngx-mapbox-gl": "^9.1.0",
     "mapbox-gl": "^2.9.2",
     "@mapbox/geo-viewport": "git+https://git@github.com/dereekb/geo-viewport#165513972f87dca23a20c177f4d173edc51b5e2f"

package/package.json

@@ -1,14 +1,15 @@
 {
   "name": "@dereekb/dbx-web",
-  "version": "9.19.4",
+  "version": "9.20.0",
   "peerDependencies": {
     "@angular/common": "^14.0.0",
     "@angular/core": "^14.0.0",
     "linkify-string": "4.0.0-beta.5",
     "linkifyjs": "^4.0.0-beta.5",
     "@angular/material": "^14.2.0",
-    "@dereekb/rxjs": "9.19.4",
-    "@dereekb/dbx-core": "9.19.4",
+    "@dereekb/rxjs": "9.20.0",
+    "@dereekb/dbx-core": "9.20.0",
+    "change-case": "^4.1.2",
     "@angular/flex-layout": "^14.0.0-beta.41",
     "ng-overlay-container": "^14.0.0",
     "@angular/cdk": "^14.2.0",