@dereekb/dbx-web 13.2.2 → 13.3.0

package/lib/loading/_loading.scss

@@ -17,12 +17,12 @@ $linear-line-height: 4px;
 
   $color-value: theming.$dbx-bg-color;
 
-  .loading-progress-view {
+  .loading-progress-view-indicator {
     background: none !important; // no background color
     --mat-progress-spinner-active-indicator-color: #{$color-value};
   }
 
-  .loading-progress-view.dbx-color > .mat-mdc-progress-bar {
+  .loading-progress-view-indicator.dbx-color > .mat-mdc-progress-bar {
     --mat-progress-bar-active-indicator-color: #{$color-value};
   }
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@dereekb/dbx-web",
-  "version": "13.2.2",
+  "version": "13.3.0",
   "peerDependencies": {
     "@angular/cdk": "^21.0.0",
     "@angular/common": "^21.0.0",
@@ -8,11 +8,11 @@
     "@angular/forms": "^21.0.0",
     "@angular/material": "^21.0.0",
     "@angular/platform-browser": "^21.0.0",
-    "@dereekb/browser": "13.2.2",
-    "@dereekb/date": "13.2.2",
-    "@dereekb/dbx-core": "13.2.2",
-    "@dereekb/rxjs": "13.2.2",
-    "@dereekb/util": "13.2.2",
+    "@dereekb/browser": "13.3.0",
+    "@dereekb/date": "13.3.0",
+    "@dereekb/dbx-core": "13.3.0",
+    "@dereekb/rxjs": "13.3.0",
+    "@dereekb/util": "13.3.0",
     "@ngbracket/ngx-layout": "^21.0.0",
     "@ngrx/component-store": "^21.0.0",
     "@ngrx/effects": "^21.0.0",

package/types/dereekb-dbx-web.d.ts

@@ -4384,13 +4384,14 @@ declare class DbxClickToCopyTextComponent {
     readonly contentElementRef: _angular_core.Signal<ElementRef<HTMLElement> | undefined>;
     readonly dbxClickToCopyText: _angular_core.Signal<DbxClickToCopyTextDirective | undefined>;
     readonly copyText: _angular_core.InputSignal<Maybe<string | null>>;
+    readonly showIcon: _angular_core.InputSignal<Maybe<boolean>>;
     readonly highlighted: _angular_core.InputSignal<boolean>;
     readonly clipboardSnackbarMessagesConfig: _angular_core.InputSignal<Maybe<CopyToClipboardFunctionWithSnackbarMessageSnackbarConfig>>;
     readonly clipboardSnackbarMessagesEnabled: _angular_core.InputSignal<boolean>;
     readonly clickToCopyIcon: _angular_core.InputSignal<string>;
     readonly clickIconToCopyOnly: _angular_core.InputSignal<boolean>;
     static ɵfac: _angular_core.ɵɵFactoryDeclaration<DbxClickToCopyTextComponent, never>;
-    static ɵcmp: _angular_core.ɵɵComponentDeclaration<DbxClickToCopyTextComponent, "dbx-click-to-copy-text", never, { "copyText": { "alias": "copyText"; "required": false; "isSignal": true; }; "highlighted": { "alias": "highlighted"; "required": false; "isSignal": true; }; "clipboardSnackbarMessagesConfig": { "alias": "clipboardSnackbarMessagesConfig"; "required": false; "isSignal": true; }; "clipboardSnackbarMessagesEnabled": { "alias": "clipboardSnackbarMessagesEnabled"; "required": false; "isSignal": true; }; "clickToCopyIcon": { "alias": "clickToCopyIcon"; "required": false; "isSignal": true; }; "clickIconToCopyOnly": { "alias": "clickIconToCopyOnly"; "required": false; "isSignal": true; }; }, {}, never, ["*"], true, never>;
+    static ɵcmp: _angular_core.ɵɵComponentDeclaration<DbxClickToCopyTextComponent, "dbx-click-to-copy-text", never, { "copyText": { "alias": "copyText"; "required": false; "isSignal": true; }; "showIcon": { "alias": "showIcon"; "required": false; "isSignal": true; }; "highlighted": { "alias": "highlighted"; "required": false; "isSignal": true; }; "clipboardSnackbarMessagesConfig": { "alias": "clipboardSnackbarMessagesConfig"; "required": false; "isSignal": true; }; "clipboardSnackbarMessagesEnabled": { "alias": "clipboardSnackbarMessagesEnabled"; "required": false; "isSignal": true; }; "clickToCopyIcon": { "alias": "clickToCopyIcon"; "required": false; "isSignal": true; }; "clickIconToCopyOnly": { "alias": "clickIconToCopyOnly"; "required": false; "isSignal": true; }; }, {}, never, ["*"], true, never>;
 }
 
 /**
@@ -5331,6 +5332,9 @@ declare function catchErrorServerParams<E extends ServerErrorParams, T extends s
  */
 interface DbxModelModuleStateConfiguration {
 }
+/**
+ * NgRx feature key for the model module configuration state slice.
+ */
 declare const stateFeatureKey = "model.module.config";
 
 declare const featureKey = "app.model";
@@ -5496,11 +5500,34 @@ declare class DbxModelObjectStateService {
 declare class DbxModelTrackerService {
     private readonly _viewTrackerStorage;
     private _defaultFolder;
+    /**
+     * Emits whenever a new view tracker event is recorded.
+     */
     readonly newEvent$: Observable<DbxModelViewTrackerEvent>;
+    /**
+     * The default storage folder used when no folder is specified in tracking calls.
+     */
     get defaultFolder(): Maybe<string>;
     set defaultFolder(folder: Maybe<string>);
+    /**
+     * Records a view event for the given model, optionally in a specific context and folder.
+     *
+     * @param modelKeyTypeNamePair - The model identity to track
+     * @param context - Optional view context metadata
+     * @param folder - Storage folder; defaults to {@link defaultFolder}
+     */
     trackViewedObject(modelKeyTypeNamePair: ModelKeyTypeNamePair, context?: Maybe<ModelViewContext>, folder?: Maybe<string>): void;
+    /**
+     * Returns all recorded view events for the given folder, sorted by most recent first.
+     *
+     * @param folder - Storage folder; defaults to {@link defaultFolder}
+     */
     getAllViewEvents(folder?: Maybe<string>): Observable<DbxModelViewTrackerEvent[]>;
+    /**
+     * Returns the complete event set (events and last-update timestamp) for the given folder.
+     *
+     * @param folder - Storage folder; defaults to {@link defaultFolder}
+     */
     getViewEventSet(folder?: Maybe<string>): Observable<DbxModelViewTrackerEventSet>;
     static ɵfac: _angular_core.ɵɵFactoryDeclaration<DbxModelTrackerService, never>;
     static ɵprov: _angular_core.ɵɵInjectableDeclaration<DbxModelTrackerService>;
@@ -5521,10 +5548,31 @@ declare class DbxModelViewTrackerStorage {
     readonly newEvent$: Observable<DbxModelViewTrackerEvent>;
     protected get storageKey(): string;
     protected get maxEventsToKeep(): number;
+    /**
+     * Persists a view tracker event to storage. Deduplicates by model key, sorts by date, and trims to the max event limit.
+     *
+     * @param event - The event to record
+     * @returns Observable that completes when the event has been persisted
+     */
     addTrackerEvent(event: DbxModelViewTrackerEvent): Observable<void>;
+    /**
+     * Returns all stored view events for the given folder.
+     *
+     * @param folder - Optional folder name; defaults to `'default'`
+     */
     getAllEvents(folder?: Maybe<string>): Observable<DbxModelViewTrackerEvent[]>;
+    /**
+     * Returns the complete event set for the given folder.
+     *
+     * @param folder - Optional folder name; defaults to `'default'`
+     */
     getEventSet(folder?: Maybe<string>): Observable<DbxModelViewTrackerEventSet>;
     private _getEventSetForStorageKey;
+    /**
+     * Computes the storage key for a given folder name.
+     *
+     * @param folder - Optional folder name; defaults to `'default'`
+     */
     getStorageKeyForFolder(folder?: Maybe<string>): string;
     static ɵfac: _angular_core.ɵɵFactoryDeclaration<DbxModelViewTrackerStorage, never>;
     static ɵprov: _angular_core.ɵɵInjectableDeclaration<DbxModelViewTrackerStorage>;
@@ -5608,10 +5656,31 @@ declare class DbxModelTypesService<I extends DbxModelTypeInfo = DbxModelTypeInfo
     static readonly DEFAULT_ICON = "help_outline";
     readonly injector: Injector;
     private readonly _configs;
+    /**
+     * Registers one or more model type configurations. Merges with any previously registered configs.
+     *
+     * @param configs - Single or array of model type configurations to register
+     */
     addTypeConfigs(configs: ArrayOrValue<DbxModelTypeConfiguration>): void;
+    /**
+     * Registers model type configurations from a map, merging with existing configs.
+     *
+     * @param configs - Map of model type strings to their configurations
+     */
     addTypeConfigsMap(configs: DbxModelTypeConfigurationMap): void;
+    /**
+     * Observable map of all registered model types to their resolved {@link DbxModelTypeInfo} entries.
+     */
     readonly typesMap$: Observable<DbxModelTypesMap<I>>;
+    /**
+     * Observable map of model type strings to their Material icon names.
+     */
     readonly iconMap$: Observable<DbxModelIconsMap>;
+    /**
+     * Returns an observable of the Material icon name for the given model type.
+     *
+     * @param type - The model type string to look up
+     */
     iconForType(type: ModelTypeString): Observable<string>;
     static ɵfac: _angular_core.ɵɵFactoryDeclaration<DbxModelTypesService<any>, never>;
     static ɵprov: _angular_core.ɵɵInjectableDeclaration<DbxModelTypesService<any>>;
@@ -5845,11 +5914,38 @@ declare class DbxWebFilePreviewService {
     constructor(entries: DbxWebFilePreviewServiceEntry[]);
     private _defaultPreviewComponentFunction;
     private _defaultPreviewDialogWithComponentFunction;
+    /**
+     * Registers one or more file preview entries, mapping MIME types to their preview components.
+     *
+     * @param entries - Single or array of preview entries to register
+     */
     registerPreviewEntries(entries: ArrayOrValue<DbxWebFilePreviewServiceEntry>): void;
+    /**
+     * Registers a single file preview entry for its MIME type(s).
+     *
+     * @param entry - The preview entry to register
+     */
     registerPreviewEntry(entry: DbxWebFilePreviewServiceEntry): void;
+    /**
+     * Overrides the default preview component function used when no MIME-specific entry is registered.
+     */
     setDefaultPreviewComponentFunction(previewFunction: DbxWebFilePreviewServicePreviewComponentFunction): void;
+    /**
+     * Overrides the default dialog-with-component function used when no MIME-specific dialog handler is registered.
+     */
     setDefaultPreviewDialogWithComponentFunction(previewDialogWithComponentFunction: DbxWebFilePreviewServicePreviewDialogWithComponentFunction): void;
+    /**
+     * Creates an injection component config for previewing a file. Uses a MIME-specific preview function if registered, otherwise falls back to the default.
+     *
+     * @param input - The preview input containing blob, URL, and MIME type information
+     */
     createPreviewConfig(input: DbxWebFilePreviewServicePreviewComponentFunctionInput): dist_packages_dbx_core_types_dereekb_dbx_core.DbxInjectionComponentConfig<any>;
+    /**
+     * Opens a Material dialog to preview a file. Uses a MIME-specific dialog function if registered, otherwise creates a preview component and wraps it in the default dialog.
+     *
+     * @param input - The dialog input containing file data and MIME type
+     * @returns Reference to the opened dialog
+     */
     openPreviewDialog(input: DbxWebFilePreviewServicePreviewDialogFunctionInput): MatDialogRef<any, any>;
     static ɵfac: _angular_core.ɵɵFactoryDeclaration<DbxWebFilePreviewService, [{ optional: true; }]>;
     static ɵprov: _angular_core.ɵɵInjectableDeclaration<DbxWebFilePreviewService>;
@@ -6873,8 +6969,21 @@ declare class DbxHelpContextService {
      * Observable of all currently active help context strings.
      */
     readonly activeHelpContextKeys$: Observable<Set<DbxHelpContextKey>>;
+    /**
+     * Observable array of all currently active help context key strings.
+     */
     readonly activeHelpContextKeysArray$: Observable<string[]>;
+    /**
+     * Registers a help context reference, adding its keys to the active set.
+     *
+     * @param reference - The help context reference to register
+     */
     register(reference: DbxHelpContextReference): void;
+    /**
+     * Unregisters a help context reference, removing its keys from the active set.
+     *
+     * @param reference - The help context reference to unregister
+     */
     unregister(reference: DbxHelpContextReference): void;
     static ɵfac: _angular_core.ɵɵFactoryDeclaration<DbxHelpContextService, never>;
     static ɵprov: _angular_core.ɵɵInjectableDeclaration<DbxHelpContextService>;
@@ -6989,14 +7098,29 @@ declare class DbxHelpWidgetService {
     private _defaultIcon;
     private _popoverHeaderComponentConfig;
     constructor(initialConfig?: DbxHelpWidgetServiceConfig);
+    /**
+     * Returns the component class used for unrecognized help context keys.
+     */
     getDefaultWidgetComponentClass(): Maybe<Type<unknown>>;
     setDefaultWidgetComponentClass(componentClass: Maybe<Type<unknown>>): void;
+    /**
+     * Returns the default icon used for help entries without a specific icon.
+     */
     getDefaultIcon(): Maybe<string>;
     setDefaultIcon(icon: Maybe<string>): void;
+    /**
+     * Returns the component config displayed in the popover header, if set.
+     */
     getPopoverHeaderComponentConfig(): Maybe<DbxInjectionComponentConfig>;
     setPopoverHeaderComponentConfig(componentConfig: Maybe<DbxInjectionComponentConfig>): void;
+    /**
+     * Returns the component config displayed at the top of the help list view, if set.
+     */
     getHelpListHeaderComponentConfig(): Maybe<DbxInjectionComponentConfig>;
     setHelpListHeaderComponentConfig(componentConfig: Maybe<DbxInjectionComponentConfig>): void;
+    /**
+     * Returns the component config displayed at the bottom of the help list view, if set.
+     */
     getHelpListFooterComponentConfig(): Maybe<DbxInjectionComponentConfig>;
     setHelpListFooterComponentConfig(componentConfig: Maybe<DbxInjectionComponentConfig>): void;
     /**
@@ -7008,10 +7132,29 @@ declare class DbxHelpWidgetService {
      * @param override Whether to override existing entries (default: true)
      */
     register(entries: ArrayOrValue<DbxHelpWidgetServiceEntry>, override?: boolean): boolean;
+    /**
+     * Returns all currently registered help context keys.
+     */
     getAllRegisteredHelpContextKeys(): DbxHelpContextKey[];
+    /**
+     * Retrieves the widget entry for a given help context key. Falls back to a default entry if a default widget component class is configured.
+     *
+     * @param helpContextKey - The help context key to look up
+     */
     getHelpWidgetEntry(helpContextKey: DbxHelpContextKey): Maybe<DbxHelpWidgetServiceEntry>;
+    /**
+     * Retrieves widget entries for multiple help context keys, filtering out any unresolvable keys.
+     *
+     * @param helpContextKeys - Array of help context keys to look up
+     */
     getHelpWidgetEntriesForHelpContextKeys(helpContextKeys: DbxHelpContextKey[]): DbxHelpWidgetServiceEntry[];
+    /**
+     * Checks whether a widget entry is registered for the given help context key.
+     */
     hasHelpWidgetEntry(context: DbxHelpContextKey): boolean;
+    /**
+     * Returns a cached map of help context keys to their sort priority values.
+     */
     getSortPriorityMap(): Map<string, number>;
     static ɵfac: _angular_core.ɵɵFactoryDeclaration<DbxHelpWidgetService, [{ optional: true; }]>;
     static ɵprov: _angular_core.ɵɵInjectableDeclaration<DbxHelpWidgetService>;