@timlassiter11/yatl 1.0.3 → 1.0.4

package/dist/index.d.mts

@@ -5,18 +5,6 @@ type NestedKeyOf<ObjectType> = ObjectType extends object ? {
     [Key in keyof ObjectType & (string | number)]: NonNullable<ObjectType[Key]> extends unknown[] ? `${Key}` : NonNullable<ObjectType[Key]> extends object ? // Recurse with the non-nullable type
     `${Key}` | `${Key}.${NestedKeyOf<NonNullable<ObjectType[Key]>>}` : `${Key}`;
 }[keyof ObjectType & (string | number)] : never;
-declare const createRegexTokenizer: (exp?: string) => (value: string) => {
-    value: string;
-    quoted: boolean;
-}[];
-declare const whitespaceTokenizer: (value: string) => {
-    value: string;
-    quoted: boolean;
-}[];
-declare function findColumn<T extends {
-    field: string;
-}>(field: string, columns: T[]): T | undefined;
-
 /**
  * Default type for the table.
  */
@@ -140,6 +128,15 @@ interface BaseColumnOptions<T> {
      * or just for searching and filtering.
      */
     role?: ColumnRole;
+    /**
+     * Whether the column is sortable.
+     */
+    sortable?: boolean;
+    /**
+     * A function to use for sorting the column.
+     * This overrides the default sorting behavior.
+     */
+    sorter?: SortValueCallback;
     /**
      * Whether the column is searchable.
      */
@@ -172,10 +169,6 @@ interface DisplayColumnOptions<T> extends BaseColumnOptions<T> {
      * The title to display in the header.
      */
     title?: string;
-    /**
-     * Whether the column is sortable.
-     */
-    sortable?: boolean;
     /**
      * Whether the column should be resizable.
      */
@@ -193,16 +186,6 @@ interface DisplayColumnOptions<T> extends BaseColumnOptions<T> {
      * NOTE: Search highlighting will not work for this cell when used.
      */
     cellRenderer?: CellRenderCallback<T>;
-    /**
-     * A function to use for sorting the column.
-     * This overrides the default sorting behavior.
-     */
-    sorter?: ComparatorCallback;
-    /**
-     * A function to derive a comparable value from the cell's original value, specifically for sorting this column.
-     * This can be used to preprocess and cache values (e.g., convert to lowercase, extract numbers) before comparison.
-     */
-    sortValue?: SortValueCallback;
 }
 /**
  * Internal column definition used for searching and filtering
@@ -346,6 +329,15 @@ declare class YatlStateChangeEvent<T> extends YatlEvent<{
     constructor(state: TableState<T>, triggers: string[]);
 }
 
+declare const createRegexTokenizer: (exp?: string) => (value: string) => {
+    value: string;
+    quoted: boolean;
+}[];
+declare const whitespaceTokenizer: (value: string) => {
+    value: string;
+    quoted: boolean;
+}[];
+
 /**
  * Represents a dynamic and interactive table with features like sorting, searching, filtering,
  * column resizing, column rearranging, and virtual scrolling.
@@ -357,7 +349,8 @@ declare class YatlTable<T extends object = UnspecifiedRecord> extends LitElement
     private _enableSearchTokenization;
     private _enableSearchScoring;
     private _columns;
-    private _columnStates;
+    private _columnDefinitionMap;
+    private _columnStateMap;
     private _columnOrder;
     private _storageOptions;
     private _data;
@@ -452,6 +445,7 @@ declare class YatlTable<T extends object = UnspecifiedRecord> extends LitElement
      */
     get columns(): ColumnOptions<T>[];
     set columns(columns: ColumnOptions<T>[]);
+    get displayColumns(): DisplayColumnOptions<T>[];
     /**
      * The current order of the columns.
      * * **NOTE:** This includes hidden columns but not internal columns
@@ -541,6 +535,8 @@ declare class YatlTable<T extends object = UnspecifiedRecord> extends LitElement
     get data(): T[];
     set data(value: T[]);
     get filteredData(): T[];
+    getColumn(field: NestedKeyOf<T>): ColumnOptions<T> | undefined;
+    getDisplayColumn(field: NestedKeyOf<T>): DisplayColumnOptions<T> | undefined;
     /**
      * Gets a copy of the current state of the table.
      */
@@ -639,7 +635,7 @@ declare class YatlTable<T extends object = UnspecifiedRecord> extends LitElement
     protected renderHeaderCell(field: NestedKeyOf<T>): TemplateResult<1> | typeof nothing;
     protected renderHeader(): TemplateResult<1>;
     protected renderCellContents(value: unknown, column: DisplayColumnOptions<T>, row: T): unknown;
-    protected renderCell(field: NestedKeyOf<T>, row: T): TemplateResult<1> | typeof nothing;
+    protected renderCell(field: NestedKeyOf<T>, row: T): TemplateResult<1> | typeof nothing | undefined;
     protected renderRow(row: T, index: number): TemplateResult<1>;
     protected renderBody(): TemplateResult<1>;
     protected renderFooter(): TemplateResult<1> | typeof nothing;
@@ -670,15 +666,17 @@ declare class YatlTable<T extends object = UnspecifiedRecord> extends LitElement
     private sortRows;
     private createMetadata;
     private updateInternalQuery;
-    private getColumns;
-    private getColumnData;
     /**
      * Gets the width of each column in the
      * order they will appear in the grid.
      */
     private getGridWidths;
     private scheduleSave;
-    private getColumnState;
+    /**
+     * Gets the column state associated with the given field.
+     * If the state doesn't exist, a default state will be created.
+     */
+    private getOrCreateColumnState;
     private saveStateToStorage;
     private loadStateFromStorage;
     private handleHeaderClicked;
@@ -716,4 +714,4 @@ declare global {
     }
 }
 
-export { type BaseColumnOptions, type CellPartsCallback, type CellRenderCallback, type ColumnFilterCallback, type ColumnInitOptions, type ColumnOptions, type ColumnRole, type ColumnState, type ComparatorCallback, type Compareable, type DisplayColumnOptions, type FilterCallback, type Filters, type InternalColumnOptions, type NestedKeyOf, type QueryToken, type RestorableColumnState, type RestorableTableState, type RowPartsCallback, type SortOrder, type SortState, type SortValueCallback, type StorageOptions, type TableState, type TokenizerCallback, type UnspecifiedRecord, type ValueFormatterCallback, YatlChangeEvent, YatlColumnReorderEvent, YatlColumnResizeEvent, YatlColumnToggleEvent, YatlEvent, YatlRowClickEvent, YatlSearchEvent, YatlSortEvent, YatlStateChangeEvent, YatlTable, createRegexTokenizer, findColumn, whitespaceTokenizer };
+export { type BaseColumnOptions, type CellPartsCallback, type CellRenderCallback, type ColumnFilterCallback, type ColumnInitOptions, type ColumnOptions, type ColumnRole, type ColumnState, type ComparatorCallback, type Compareable, type DisplayColumnOptions, type FilterCallback, type Filters, type InternalColumnOptions, type NestedKeyOf, type QueryToken, type RestorableColumnState, type RestorableTableState, type RowPartsCallback, type SortOrder, type SortState, type SortValueCallback, type StorageOptions, type TableState, type TokenizerCallback, type UnspecifiedRecord, type ValueFormatterCallback, YatlChangeEvent, YatlColumnReorderEvent, YatlColumnResizeEvent, YatlColumnToggleEvent, YatlEvent, YatlRowClickEvent, YatlSearchEvent, YatlSortEvent, YatlStateChangeEvent, YatlTable, createRegexTokenizer, whitespaceTokenizer };

package/dist/index.d.ts

@@ -5,18 +5,6 @@ type NestedKeyOf<ObjectType> = ObjectType extends object ? {
     [Key in keyof ObjectType & (string | number)]: NonNullable<ObjectType[Key]> extends unknown[] ? `${Key}` : NonNullable<ObjectType[Key]> extends object ? // Recurse with the non-nullable type
     `${Key}` | `${Key}.${NestedKeyOf<NonNullable<ObjectType[Key]>>}` : `${Key}`;
 }[keyof ObjectType & (string | number)] : never;
-declare const createRegexTokenizer: (exp?: string) => (value: string) => {
-    value: string;
-    quoted: boolean;
-}[];
-declare const whitespaceTokenizer: (value: string) => {
-    value: string;
-    quoted: boolean;
-}[];
-declare function findColumn<T extends {
-    field: string;
-}>(field: string, columns: T[]): T | undefined;
-
 /**
  * Default type for the table.
  */
@@ -140,6 +128,15 @@ interface BaseColumnOptions<T> {
      * or just for searching and filtering.
      */
     role?: ColumnRole;
+    /**
+     * Whether the column is sortable.
+     */
+    sortable?: boolean;
+    /**
+     * A function to use for sorting the column.
+     * This overrides the default sorting behavior.
+     */
+    sorter?: SortValueCallback;
     /**
      * Whether the column is searchable.
      */
@@ -172,10 +169,6 @@ interface DisplayColumnOptions<T> extends BaseColumnOptions<T> {
      * The title to display in the header.
      */
     title?: string;
-    /**
-     * Whether the column is sortable.
-     */
-    sortable?: boolean;
     /**
      * Whether the column should be resizable.
      */
@@ -193,16 +186,6 @@ interface DisplayColumnOptions<T> extends BaseColumnOptions<T> {
      * NOTE: Search highlighting will not work for this cell when used.
      */
     cellRenderer?: CellRenderCallback<T>;
-    /**
-     * A function to use for sorting the column.
-     * This overrides the default sorting behavior.
-     */
-    sorter?: ComparatorCallback;
-    /**
-     * A function to derive a comparable value from the cell's original value, specifically for sorting this column.
-     * This can be used to preprocess and cache values (e.g., convert to lowercase, extract numbers) before comparison.
-     */
-    sortValue?: SortValueCallback;
 }
 /**
  * Internal column definition used for searching and filtering
@@ -346,6 +329,15 @@ declare class YatlStateChangeEvent<T> extends YatlEvent<{
     constructor(state: TableState<T>, triggers: string[]);
 }
 
+declare const createRegexTokenizer: (exp?: string) => (value: string) => {
+    value: string;
+    quoted: boolean;
+}[];
+declare const whitespaceTokenizer: (value: string) => {
+    value: string;
+    quoted: boolean;
+}[];
+
 /**
  * Represents a dynamic and interactive table with features like sorting, searching, filtering,
  * column resizing, column rearranging, and virtual scrolling.
@@ -357,7 +349,8 @@ declare class YatlTable<T extends object = UnspecifiedRecord> extends LitElement
     private _enableSearchTokenization;
     private _enableSearchScoring;
     private _columns;
-    private _columnStates;
+    private _columnDefinitionMap;
+    private _columnStateMap;
     private _columnOrder;
     private _storageOptions;
     private _data;
@@ -452,6 +445,7 @@ declare class YatlTable<T extends object = UnspecifiedRecord> extends LitElement
      */
     get columns(): ColumnOptions<T>[];
     set columns(columns: ColumnOptions<T>[]);
+    get displayColumns(): DisplayColumnOptions<T>[];
     /**
      * The current order of the columns.
      * * **NOTE:** This includes hidden columns but not internal columns
@@ -541,6 +535,8 @@ declare class YatlTable<T extends object = UnspecifiedRecord> extends LitElement
     get data(): T[];
     set data(value: T[]);
     get filteredData(): T[];
+    getColumn(field: NestedKeyOf<T>): ColumnOptions<T> | undefined;
+    getDisplayColumn(field: NestedKeyOf<T>): DisplayColumnOptions<T> | undefined;
     /**
      * Gets a copy of the current state of the table.
      */
@@ -639,7 +635,7 @@ declare class YatlTable<T extends object = UnspecifiedRecord> extends LitElement
     protected renderHeaderCell(field: NestedKeyOf<T>): TemplateResult<1> | typeof nothing;
     protected renderHeader(): TemplateResult<1>;
     protected renderCellContents(value: unknown, column: DisplayColumnOptions<T>, row: T): unknown;
-    protected renderCell(field: NestedKeyOf<T>, row: T): TemplateResult<1> | typeof nothing;
+    protected renderCell(field: NestedKeyOf<T>, row: T): TemplateResult<1> | typeof nothing | undefined;
     protected renderRow(row: T, index: number): TemplateResult<1>;
     protected renderBody(): TemplateResult<1>;
     protected renderFooter(): TemplateResult<1> | typeof nothing;
@@ -670,15 +666,17 @@ declare class YatlTable<T extends object = UnspecifiedRecord> extends LitElement
     private sortRows;
     private createMetadata;
     private updateInternalQuery;
-    private getColumns;
-    private getColumnData;
     /**
      * Gets the width of each column in the
      * order they will appear in the grid.
      */
     private getGridWidths;
     private scheduleSave;
-    private getColumnState;
+    /**
+     * Gets the column state associated with the given field.
+     * If the state doesn't exist, a default state will be created.
+     */
+    private getOrCreateColumnState;
     private saveStateToStorage;
     private loadStateFromStorage;
     private handleHeaderClicked;
@@ -716,4 +714,4 @@ declare global {
     }
 }
 
-export { type BaseColumnOptions, type CellPartsCallback, type CellRenderCallback, type ColumnFilterCallback, type ColumnInitOptions, type ColumnOptions, type ColumnRole, type ColumnState, type ComparatorCallback, type Compareable, type DisplayColumnOptions, type FilterCallback, type Filters, type InternalColumnOptions, type NestedKeyOf, type QueryToken, type RestorableColumnState, type RestorableTableState, type RowPartsCallback, type SortOrder, type SortState, type SortValueCallback, type StorageOptions, type TableState, type TokenizerCallback, type UnspecifiedRecord, type ValueFormatterCallback, YatlChangeEvent, YatlColumnReorderEvent, YatlColumnResizeEvent, YatlColumnToggleEvent, YatlEvent, YatlRowClickEvent, YatlSearchEvent, YatlSortEvent, YatlStateChangeEvent, YatlTable, createRegexTokenizer, findColumn, whitespaceTokenizer };
+export { type BaseColumnOptions, type CellPartsCallback, type CellRenderCallback, type ColumnFilterCallback, type ColumnInitOptions, type ColumnOptions, type ColumnRole, type ColumnState, type ComparatorCallback, type Compareable, type DisplayColumnOptions, type FilterCallback, type Filters, type InternalColumnOptions, type NestedKeyOf, type QueryToken, type RestorableColumnState, type RestorableTableState, type RowPartsCallback, type SortOrder, type SortState, type SortValueCallback, type StorageOptions, type TableState, type TokenizerCallback, type UnspecifiedRecord, type ValueFormatterCallback, YatlChangeEvent, YatlColumnReorderEvent, YatlColumnResizeEvent, YatlColumnToggleEvent, YatlEvent, YatlRowClickEvent, YatlSearchEvent, YatlSortEvent, YatlStateChangeEvent, YatlTable, createRegexTokenizer, whitespaceTokenizer };