@dereekb/dbx-web 13.4.0 → 13.4.2

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@dereekb/dbx-web",
-  "version": "13.4.0",
+  "version": "13.4.2",
   "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.4.0",
-    "@dereekb/date": "13.4.0",
-    "@dereekb/dbx-core": "13.4.0",
-    "@dereekb/rxjs": "13.4.0",
-    "@dereekb/util": "13.4.0",
+    "@dereekb/browser": "13.4.2",
+    "@dereekb/date": "13.4.2",
+    "@dereekb/dbx-core": "13.4.2",
+    "@dereekb/rxjs": "13.4.2",
+    "@dereekb/util": "13.4.2",
     "@ngbracket/ngx-layout": "^21.0.0",
     "@ngrx/component-store": "^21.0.0",
     "@ngrx/effects": "^21.0.0",

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

@@ -2,7 +2,7 @@ import * as _dereekb_dbx_web_calendar from '@dereekb/dbx-web/calendar';
 import * as rxjs from 'rxjs';
 import { Observable } from 'rxjs';
 import * as _angular_core from '@angular/core';
-import { EnvironmentProviders } from '@angular/core';
+import { Provider } from '@angular/core';
 import { CalendarEvent } from 'angular-calendar';
 import * as _dereekb_util from '@dereekb/util';
 import { Maybe } from '@dereekb/util';
@@ -29,6 +29,13 @@ interface CalendarViewDateRange {
      */
     readonly isMaxDateVisible: boolean;
 }
+/**
+ * Compares two {@link CalendarViewDateRange} values for equality by checking type, start/end dates, distance, and min/max visibility flags.
+ *
+ * @param a - First calendar view date range to compare.
+ * @param b - Second calendar view date range to compare.
+ * @returns Whether the two date ranges are considered equal.
+ */
 declare function isCalendarViewDateRangeEqual(a: CalendarViewDateRange, b: CalendarViewDateRange): boolean;
 interface CalendarState<T = any> {
     /**
@@ -60,6 +67,13 @@ interface CalendarState<T = any> {
      */
     readonly showPageButtons?: boolean;
 }
+/**
+ * Computes the visible date range for the given calendar state based on display type (month, week, or day)
+ * and the optional navigation range limit.
+ *
+ * @param calendarState - The current calendar state containing display type, date, and navigation limits.
+ * @returns The computed visible date range including start, end, distance, and min/max visibility flags.
+ */
 declare function visibleDateRangeForCalendarState(calendarState: CalendarState): CalendarViewDateRange;
 declare class DbxCalendarStore<T = any> extends ComponentStore<CalendarState<T>> {
     constructor();
@@ -117,7 +131,23 @@ declare class DbxCalendarStore<T = any> extends ComponentStore<CalendarState<T>>
     static ɵfac: _angular_core.ɵɵFactoryDeclaration<DbxCalendarStore<any>, never>;
     static ɵprov: _angular_core.ɵɵInjectableDeclaration<DbxCalendarStore<any>>;
 }
+/**
+ * Returns an updated calendar state after tapping a date. Only updates if the date differs from the current one
+ * and falls within the navigation range limit. Toggles `dateTappedTwice` when the same day is tapped again.
+ *
+ * @param state - The current calendar state.
+ * @param date - The date that was tapped.
+ * @returns The updated calendar state reflecting the tapped date.
+ */
 declare function updateCalendarStateWithTappedDate(state: CalendarState, date: Date): CalendarState<any>;
+/**
+ * Returns an updated calendar state with a new navigation range limit. If the current date falls outside
+ * the new range, it is clamped to fit within the limit.
+ *
+ * @param state - The current calendar state.
+ * @param navigationRangeLimit - The new navigation date range limit, or undefined/null to remove the limit.
+ * @returns The updated calendar state with the applied navigation range limit.
+ */
 declare function updateCalendarStateWithNavigationRangeLimit(state: CalendarState, navigationRangeLimit: Maybe<Partial<DateRange>>): {
     navigationRangeLimit: Maybe<Partial<DateRange>>;
     type: CalendarDisplayType;
@@ -132,6 +162,12 @@ interface DbxCalendarEvent<T> {
     event: CalendarEvent<T>;
     action?: string;
 }
+/**
+ * Appends time/duration subtitles to each calendar event's title and sorts the events by start date in ascending order.
+ *
+ * @param events - The calendar events to prepare and sort.
+ * @returns A new array of calendar events with updated titles, sorted by start date.
+ */
 declare function prepareAndSortCalendarEvents(events: CalendarEvent[]): CalendarEvent[];
 
 declare class DbxCalendarComponent<T> {
@@ -190,8 +226,10 @@ declare class DbxCalendarBaseComponent<T> {
 
 /**
  * Provides default configuration for the DbxCalendarModule
+ *
+ * @returns Providers that register the calendar with a date-fns date adapter.
  */
-declare function provideDbxCalendar(): EnvironmentProviders;
+declare function provideDbxCalendar(): Provider[];
 
 export { CalendarDisplayType, DbxCalendarBaseComponent, DbxCalendarComponent, DbxCalendarStore, isCalendarViewDateRangeEqual, prepareAndSortCalendarEvents, provideDbxCalendar, updateCalendarStateWithNavigationRangeLimit, updateCalendarStateWithTappedDate, visibleDateRangeForCalendarState };
 export type { CalendarState, CalendarViewDateRange, DbxCalendarEvent };

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

@@ -29,6 +29,12 @@ type MapboxZoomLevel = ZoomLevel;
 type MapboxZoomLevelRange = ZoomLevelRange;
 declare const MAPBOX_MIN_ZOOM_LEVEL: MapboxZoomLevel;
 declare const MAPBOX_MAX_ZOOM_LEVEL: MapboxZoomLevel;
+/**
+ * Clamps a numeric value to the valid Mapbox zoom level range (0 to 22).
+ *
+ * @param input - The raw zoom level number to clamp.
+ * @returns The zoom level clamped between {@link MAPBOX_MIN_ZOOM_LEVEL} and {@link MAPBOX_MAX_ZOOM_LEVEL}.
+ */
 declare function mapboxZoomLevel(input: number): MapboxZoomLevel;
 type MapboxPitch = number;
 type MapboxBearing = number;
@@ -133,6 +139,12 @@ interface MapboxViewportBoundFunctionInput {
  * Used to calculate the bounds of a view/object given the input MapboxViewportBoundFunctionInput.
  */
 type MapboxViewportBoundFunction = (input: MapboxViewportBoundFunctionInput) => LatLngBound;
+/**
+ * Creates a function that calculates the geographic bounds of a Mapbox viewport given a center point and zoom level.
+ *
+ * @param config - Configuration specifying the map canvas size and optional tile size.
+ * @returns A function that accepts a center point and zoom level and returns the corresponding {@link LatLngBound}.
+ */
 declare function mapboxViewportBoundFunction(config: MapboxViewportBoundFunctionConfig): MapboxViewportBoundFunction;
 
 type FilterMapboxBoundReadItemValueFunction<T> = (value: T) => MapboxViewportBoundFunctionItemValue;
@@ -441,9 +453,23 @@ declare class DbxMapboxInjectionStore extends ComponentStore<DbxMapboxMapInjecti
     static ɵfac: i0.ɵɵFactoryDeclaration<DbxMapboxInjectionStore, never>;
     static ɵprov: i0.ɵɵInjectableDeclaration<DbxMapboxInjectionStore>;
 }
+/**
+ * Returns an updated store state with the given injection config added or replaced in the map, keyed by its unique key.
+ *
+ * @param state - The current mapbox injection store state.
+ * @param config - The injection configuration to add or update.
+ * @returns The updated store state containing the new or replaced config.
+ */
 declare function updateDbxMapboxMapInjectionStoreStateWithInjectionConfig(state: DbxMapboxMapInjectionStoreState, config: DbxMapboxInjectionConfig): {
     map: Map<string, DbxMapboxInjectionConfig>;
 };
+/**
+ * Returns an updated store state with the injection config for the given key removed. If the key does not exist, returns the state unchanged.
+ *
+ * @param state - The current mapbox injection store state.
+ * @param key - The injection key to remove from the map.
+ * @returns The updated store state with the key removed, or the original state if the key was not present.
+ */
 declare function updateDbxMapboxMapInjectionStoreStateWithRemovedKey(state: DbxMapboxMapInjectionStoreState, key: DbxMapboxInjectionKey): DbxMapboxMapInjectionStoreState;
 
 /**
@@ -676,7 +702,7 @@ declare class DbxMapboxMarkerComponent implements OnDestroy {
     readonly marker: i0.InputSignal<Maybe<DbxMapboxMarker>>;
     readonly latLngSignal: i0.Signal<_dereekb_util.LatLngPoint | undefined>;
     readonly presentationSignal: i0.Signal<_dereekb_dbx_web_mapbox.DbxMapboxMarkerPresentation>;
-    readonly styleSignal: i0.Signal<any>;
+    readonly styleSignal: i0.Signal<Record<string, unknown>>;
     readonly presentationCssClassSignal: i0.Signal<string>;
     ngOnDestroy(): void;
     static ɵfac: i0.ɵɵFactoryDeclaration<DbxMapboxMarkerComponent, never>;

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

@@ -69,6 +69,14 @@ interface DefaultDbxTableItemGroup<T, G = unknown> extends DbxTableItemGroup<T,
     readonly groupId: typeof NO_GROUPS_ID;
     readonly default: true;
 }
+/**
+ * Creates a default (ungrouped) table item group that wraps all items under the {@link NO_GROUPS_ID} identifier.
+ *
+ * Used when no explicit grouping function is provided to the table.
+ *
+ * @param items - the array of items to include in the default group
+ * @returns a default group containing all the provided items
+ */
 declare function defaultDbxTableItemGroup<T, G = unknown>(items: T[]): DefaultDbxTableItemGroup<T, G>;
 type DbxTableGroupByFunction<T, G = unknown> = (items: T[]) => ObservableOrValue<DbxTableItemGroup<T, G>[]>;
 /**
@@ -168,6 +176,13 @@ declare class DbxTableDateHeaderComponent {
     static ɵfac: i0.ɵɵFactoryDeclaration<DbxTableDateHeaderComponent, never>;
     static ɵcmp: i0.ɵɵComponentDeclaration<DbxTableDateHeaderComponent, "ng-component", never, {}, {}, never, never, true, never>;
 }
+/**
+ * Creates a factory that produces injection component configs for rendering date column headers.
+ *
+ * The factory initializes each {@link DbxTableDateHeaderComponent} with the column's date metadata.
+ *
+ * @returns a factory function that maps a date column to its header injection config
+ */
 declare function dbxTableDateHeaderInjectionFactory(): DbxInjectionComponentConfigFactory<DbxTableColumn<Date>, DbxTableDateHeaderComponent>;
 
 interface DbxTableStoreState<I, C, T, G> {
@@ -266,6 +281,14 @@ declare class DbxTableDateRangeDayDistanceInputCellInputComponent {
     static ɵfac: i0.ɵɵFactoryDeclaration<DbxTableDateRangeDayDistanceInputCellInputComponent, never>;
     static ɵcmp: i0.ɵɵComponentDeclaration<DbxTableDateRangeDayDistanceInputCellInputComponent, "ng-component", never, {}, {}, never, never, true, never>;
 }
+/**
+ * Creates an injection component config for a date-range day-distance input cell.
+ *
+ * Initializes the component with the provided configuration for day distance, date bounds, and button format.
+ *
+ * @param componentConfig - optional configuration for the date range input (day distance, min/max dates, button format)
+ * @returns an injection component config that renders a {@link DbxTableDateRangeDayDistanceInputCellInputComponent}
+ */
 declare function dbxTableDateRangeDayDistanceInputCellInput(componentConfig?: DbxTableDateRangeDayDistanceInputCellInputComponentConfig): DbxInjectionComponentConfig<DbxTableDateRangeDayDistanceInputCellInputComponent>;
 
 declare class DbxTableDateModule {
@@ -378,7 +401,19 @@ interface DbxTableViewItemElement<T, G> {
     readonly item: T;
 }
 type DbxTableViewElement<T, G> = DbxTableViewGroupElement<T, G> | DbxTableViewItemElement<T, G>;
+/**
+ * Type guard that checks whether a table view element is a group element (header or footer).
+ *
+ * @param element - the table view element to check
+ * @returns `true` if the element represents a group header or footer row
+ */
 declare function isDbxTableViewGroupElement<T, G>(element: DbxTableViewElement<T, G>): element is DbxTableViewGroupElement<T, G>;
+/**
+ * Type guard that checks whether a table view element is an item data element.
+ *
+ * @param element - the table view element to check
+ * @returns `true` if the element represents an item data row
+ */
 declare function isDbxTableViewItemElement<T, G>(element: DbxTableViewElement<T, G>): element is DbxTableViewItemElement<T, G>;
 /**
  * A table with fixed content
@@ -386,7 +421,7 @@ declare function isDbxTableViewItemElement<T, G>(element: DbxTableViewElement<T,
 declare class DbxTableViewComponent<I, C, T, G = unknown> {
     readonly tableStore: DbxTableStore<I, C, T, G>;
     readonly table: Signal<MatTable<DbxTableViewElement<T, G>>>;
-    readonly DEFAULT_TRACK_BY_FUNCTION: TrackByFunction<any>;
+    readonly DEFAULT_TRACK_BY_FUNCTION: TrackByFunction<unknown>;
     readonly scrollDistance: i0.InputSignal<number>;
     readonly throttleScroll: i0.InputSignal<number>;
     readonly itemsColumnName = "_items";
@@ -400,7 +435,7 @@ declare class DbxTableViewComponent<I, C, T, G = unknown> {
     readonly displayedColumns$: Observable<string[]>;
     readonly displayedColumnsSignal: Signal<string[]>;
     readonly trackByFunction$: Observable<TrackByFunction<T>>;
-    readonly inputTrackByFunctionSignal: Signal<TrackByFunction<any> | TrackByFunction<T>>;
+    readonly inputTrackByFunctionSignal: Signal<TrackByFunction<unknown> | TrackByFunction<T>>;
     readonly trackElementByFunctionSignal: Signal<TrackByFunction<DbxTableViewElement<T, G>>>;
     readonly context: _dereekb_rxjs.MutableLoadingStateContext<unknown, LoadingState<_dereekb_dbx_web_table.DbxTableContextData<I, C, T>>, _dereekb_rxjs.LoadingContextEvent & LoadingState<_dereekb_dbx_web_table.DbxTableContextData<I, C, T>>>;
     readonly dataLoadingContext: _dereekb_rxjs.MutableLoadingStateContext<unknown, LoadingState<DbxTableViewElement<T, G>[]>, _dereekb_rxjs.LoadingContextEvent & LoadingState<DbxTableViewElement<T, G>[]>>;
@@ -562,7 +597,7 @@ interface DbxTableReaderDelegate<C, T, O> {
      */
     trackItem: DbxTableReaderItemTrackByFunction<T>;
 }
-interface DbxTableReaderConfig<C, T, O, G = any> {
+interface DbxTableReaderConfig<C, T, O, G = unknown> {
     /**
      * Delegate used for retrieving the data for a specific column and item/row.
      */
@@ -570,9 +605,9 @@ interface DbxTableReaderConfig<C, T, O, G = any> {
     /**
      * The table store used for retrieving the items.
      */
-    readonly tableStore: DbxTableStore<any, C, T, G>;
+    readonly tableStore: DbxTableStore<unknown, C, T, G>;
 }
-interface DbxTableReader<C, T, O, G = any> extends DbxTableReaderConfig<C, T, O, G> {
+interface DbxTableReader<C, T, O, G = unknown> extends DbxTableReaderConfig<C, T, O, G> {
     /**
      * Retrieves all cell data pairs for a specific column.
      */
@@ -594,7 +629,13 @@ interface DbxTableReader<C, T, O, G = any> extends DbxTableReaderConfig<C, T, O,
      */
     cellDataForColumnAndItem(column: DbxTableColumn<C>, item: T): Observable<Maybe<O>>;
 }
-declare function dbxTableReader<C, T, O, G = any>(config: DbxTableReaderConfig<C, T, O, G>): DbxTableReader<C, T, O, G>;
+/**
+ * Creates a {@link DbxTableReader} that provides reactive access to cell data across all columns and items in the table.
+ *
+ * @param config The reader configuration containing the delegate and table store
+ * @returns A {@link DbxTableReader} instance with observable accessors for cell data
+ */
+declare function dbxTableReader<C, T, O, G = unknown>(config: DbxTableReaderConfig<C, T, O, G>): DbxTableReader<C, T, O, G>;
 
 export { AbstractDbxTableColumnDirective, AbstractDbxTableGroupDirective, AbstractDbxTableItemDirective, DBX_TABLE_ACTIONS_COLUMN_NAME, DBX_TABLE_COLUMN_SIZE_PARENT_ELEMENT_REF_TOKEN, DBX_TABLE_ITEMS_COLUMN_NAME, DEFAULT_DBX_TABLE_DATE_RANGE_DAY_BUTTON_FORMAT, DEFAULT_DBX_TABLE_DATE_RANGE_DAY_DISTIANCE_INPUT_CELL_COMPONENT_CONFIG, DEFAULT_DBX_TABLE_READER_COLUMN_TRACK_BY, DbxColumnSizeColumnDirective, DbxTableActionCellComponent, DbxTableColumnFooterComponent, DbxTableColumnHeaderComponent, DbxTableColumnSizeDirective, DbxTableDateHeaderComponent, DbxTableDateModule, DbxTableDateRangeDayDistanceInputCellInputComponent, DbxTableDateRangeDayDistanceInputCellInputRangeSelectionStrategy, DbxTableDirective, DbxTableGroupFooterComponent, DbxTableGroupHeaderComponent, DbxTableInputCellComponent, DbxTableItemActionComponent, DbxTableItemCellComponent, DbxTableItemHeaderComponent, DbxTableModule, DbxTableStore, DbxTableSummaryEndCellComponent, DbxTableSummaryStartCellComponent, DbxTableViewComponent, NO_GROUPS_ID, dbxTableDateHeaderInjectionFactory, dbxTableDateRangeDayDistanceInputCellInput, dbxTableReader, defaultDbxTableItemGroup, isDbxTableViewGroupElement, isDbxTableViewItemElement };
 export type { DbxColumnSizeColumnValue, DbxTableColumn, DbxTableContextData, DbxTableContextDataDelegate, DbxTableDateRangeDayDistanceInputCellInputComponentConfig, DbxTableGroupByFunction, DbxTableGroupId, DbxTableItemGroup, DbxTableReader, DbxTableReaderCellDataPair, DbxTableReaderCellPair, DbxTableReaderColumnKey, DbxTableReaderColumnTrackByFunction, DbxTableReaderConfig, DbxTableReaderDelegate, DbxTableReaderItemKey, DbxTableReaderItemTrackByFunction, DbxTableStoreState, DbxTableViewDelegate, DbxTableViewElement, DbxTableViewGroupElement, DbxTableViewItemElement, DefaultDbxTableItemGroup };