@dereekb/dbx-web 13.4.1 → 13.5.0

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
@@ -594,6 +629,12 @@ interface DbxTableReader<C, T, O, G = any> extends DbxTableReaderConfig<C, T, O,
      */
     cellDataForColumnAndItem(column: DbxTableColumn<C>, item: T): Observable<Maybe<O>>;
 }
+/**
+ * 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 = any>(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 };