@inglorious/web 4.4.0 → 4.5.1

package/types/table.d.ts

@@ -1,248 +0,0 @@
-import type { TemplateResult } from "lit-html"
-import type { Api } from "./mount"
-import type { SelectOption } from "./select"
-
-/**
- * Represents a single row of data in the table.
- */
-export type TableRow = Record<string, any>
-
-/**
- * Represents a column definition for the table.
- */
-export interface TableColumn {
-  /** The unique identifier for the column (usually matches a property in the data). */
-  id: string
-  /** The display label for the column header. */
-  title: string
-  /** The type of data in the column. */
-  type?: "string" | "number" | "boolean" | "date"
-  /** Whether the column is sortable. */
-  isSortable?: boolean
-  /** Whether the column is filterable. */
-  isFilterable?: boolean
-  /** Filter configuration. */
-  filter?: {
-    type: "text" | "number" | "range" | "select" | "date" | "time" | "datetime"
-    options?: SelectOption[]
-    [key: string]: any
-  }
-  /** The width of the column, in pixels or as a string (e.g., '10%'). */
-  width?: number | string
-  /** Optional formatter key or function. */
-  formatter?: string | ((value: any) => any)
-  /** Custom sort function for a column, operating on two rows. */
-  sortFn?: (a: TableRow, b: TableRow) => number
-  /** Custom filter function for a column, operating on a single row. */
-  filterFn?: (row: TableRow, filterValue: any) => boolean
-  /** Custom format function. */
-  format?: (value: any) => string
-  /** Any other custom properties. */
-  [key: string]: any
-}
-
-/**
- * Represents the state of a table entity.
- */
-export interface TableEntity<T extends TableRow = TableRow> {
-  /** A unique identifier for the table entity. */
-  id: string | number
-  /** The entity type. */
-  type: string
-  /** The data array to display. */
-  data: T[]
-  /** The column definitions. */
-  columns: TableColumn[]
-  /** Sorting state. */
-  sorts: { column: string; direction: "asc" | "desc" }[]
-  /** Filtering state. */
-  filters: Record<string, any>
-  /** Search state. */
-  search: { value: string; placeholder?: string } | null
-  /** Selected row IDs. */
-  selection: (string | number)[]
-  /** Pagination state. */
-  pagination: { page: number; pageSize: number } | null
-  /** The property on a row object that uniquely identifies it. Defaults to 'id'. */
-  rowId?: string
-  /** Whether multi-select is enabled. */
-  isMultiSelect: boolean
-  /** Any other custom properties. */
-  [key: string]: any
-}
-
-/**
- * The table type implementation.
- */
-export declare const table: {
-  /**
-   * Initializes the table entity with default state.
-   * @param entity The table entity.
-   */
-  create(entity: TableEntity): void
-
-  /**
-   * Toggles sorting for a specific column.
-   * @param entity The table entity.
-   * @param columnId The ID of the column to sort by.
-   */
-  sortChange(entity: TableEntity, columnId: string): void
-
-  /**
-   * Clears all active sorts.
-   * @param entity The table entity.
-   */
-  sortsClear(entity: TableEntity): void
-
-  /**
-   * Updates the filter value for a specific column.
-   * @param entity The table entity.
-   * @param payload The filter change payload containing columnId and value.
-   */
-  filterChange(
-    entity: TableEntity,
-    payload: { columnId: string; value: any },
-  ): void
-
-  /**
-   * Clears all active filters.
-   * @param entity The table entity.
-   */
-  filtersClear(entity: TableEntity): void
-
-  /**
-   * Updates the global search term.
-   * @param entity The table entity.
-   * @param search The new search string.
-   */
-  searchChange(entity: TableEntity, search: string): void
-
-  /**
-   * Changes the current page index.
-   * @param entity The table entity.
-   * @param page The new page index (0-based).
-   */
-  pageChange(entity: TableEntity, page: number): void
-
-  /**
-   * Moves to the next page.
-   * @param entity The table entity.
-   */
-  pageNext(entity: TableEntity): void
-
-  /**
-   * Moves to the previous page.
-   * @param entity The table entity.
-   */
-  pagePrev(entity: TableEntity): void
-
-  /**
-   * Changes the page size (number of items per page).
-   * @param entity The table entity.
-   * @param pageSize The new page size.
-   */
-  pageSizeChange(entity: TableEntity, pageSize: number): void
-
-  /**
-   * Selects a specific row.
-   * @param entity The table entity.
-   * @param rowId The ID of the row to select.
-   */
-  rowSelect(entity: TableEntity, rowId: string | number): void
-
-  /**
-   * Deselects a specific row.
-   * @param entity The table entity.
-   * @param rowId The ID of the row to deselect.
-   */
-  rowDeselect(entity: TableEntity, rowId: string | number): void
-
-  /**
-   * Toggles selection for a specific row.
-   * @param entity The table entity.
-   * @param rowId The ID of the row to toggle.
-   */
-  rowToggle(entity: TableEntity, rowId: string | number): void
-
-  /**
-   * Toggles selection for all currently visible rows.
-   * @param entity The table entity.
-   */
-  rowsToggleAll(entity: TableEntity): void
-
-  /**
-   * Selects all currently visible rows.
-   * @param entity The table entity.
-   */
-  rowsSelectAll(entity: TableEntity): void
-
-  /**
-   * Clears the current row selection.
-   * @param entity The table entity.
-   */
-  selectionClear(entity: TableEntity): void
-
-  /**
-   * Renders the table component.
-   * @param entity The table entity.
-   * @param api The store API.
-   */
-  render(entity: TableEntity, api: Api): TemplateResult
-
-  /**
-   * Renders the table header.
-   * @param entity The table entity.
-   * @param api The store API.
-   */
-  renderHeader(entity: TableEntity, api: Api): TemplateResult
-
-  /**
-   * Renders the table body.
-   * @param entity The table entity.
-   * @param api The store API.
-   */
-  renderBody(entity: TableEntity, api: Api): TemplateResult
-
-  /**
-   * Renders a single row.
-   * @param entity The table entity.
-   * @param payload The payload for rendering the row.
-   * @param payload.row The data item for the row.
-   * @param payload.index The index of the row.
-   * @param api The store API.
-   */
-  renderRow(
-    entity: TableEntity,
-    payload: { row: TableRow; index: number },
-    api: Api,
-  ): TemplateResult
-
-  /**
-   * Renders a single cell.
-   * @param entity The table entity.
-   * @param payload The payload for rendering the cell.
-   * @param payload.cell The data for the cell.
-   * @param payload.index The column index of the cell.
-   * @param api The store API.
-   */
-  renderCell(
-    entity: TableEntity,
-    payload: { cell: any; index: number },
-    api: Api,
-  ): TemplateResult
-
-  /**
-   * Renders the value of a cell.
-   * @param entity The table entity.
-   * @param payload The payload for rendering the value.
-   * @param payload.value The raw value from the data item.
-   * @param payload.column The column definition.
-   * @param payload.index The column index.
-   * @param api The store API.
-   */
-  renderValue(
-    entity: TableEntity,
-    payload: { value: any; column: TableColumn; index: number },
-    api: Api,
-  ): any
-}