@honed/table 0.9.2 → 0.11.0

package/dist/index.d.ts

@@ -1,3 +1,4 @@
+import { Binding } from '@honed/action';
 import { BulkOperation } from '@honed/action';
 import { BulkSelection } from '@honed/action';
 import { Executable } from '@honed/action';
@@ -7,11 +8,20 @@ import { MaybeEndpoint } from '@honed/action';
 import { MaybeId } from '@honed/action';
 import { PageOperation } from '@honed/action';
 import { PageOperationData } from '@honed/action';
+import { RecordBinding } from '@honed/action';
 import { Refine } from '@honed/refine';
 import { Sort } from '@honed/refine';
 import { VisitOptions } from '@inertiajs/core';
 
-export declare interface BaseColumn<T extends Record<string, any> = Record<string, any>> {
+export declare interface Classes {
+    classes?: string;
+}
+
+export declare interface CollectionPaginate {
+    empty: boolean;
+}
+
+export declare interface Column<T extends Record<string, any> = Record<string, any>> {
     name: keyof T;
     label: string;
     type?: ColumnType;
@@ -20,19 +30,10 @@ export declare interface BaseColumn<T extends Record<string, any> = Record<strin
     badge?: boolean;
     toggleable: boolean;
     class?: string;
-    record_class?: string;
     icon?: string;
     sort?: Pick<Sort, "active" | "direction" | "next">;
 }
 
-export declare interface CollectionPaginate {
-    empty: boolean;
-}
-
-export declare interface Column<T extends Record<string, any> = Record<string, any>> extends BaseColumn<T> {
-    toggle: (options: VisitOptions) => void;
-}
-
 export declare type ColumnType = "array" | "badge" | "boolean" | "color" | "date" | "datetime" | "icon" | "image" | "numeric" | "text" | "time" | string;
 
 export declare interface CursorPaginate extends CollectionPaginate {
@@ -48,12 +49,17 @@ export declare interface EmptyState {
     operations: PageOperation[];
 }
 
-export declare interface Heading<T extends Record<string, any> = Record<string, any>> extends BaseColumn<T> {
+export declare interface Heading<T extends Record<string, any> = Record<string, any>> extends Column<T> {
     isSorting: boolean;
-    toggleSort: (options: VisitOptions) => void;
+    toggleSort: (options?: VisitOptions) => void;
+}
+
+export declare interface HonedColumn<T extends Record<string, any> = Record<string, any>> extends Column<T> {
+    toggle: (options: VisitOptions) => void;
 }
 
 export declare interface HonedTable<T extends Record<string, any> = Record<string, any>, K extends Paginate = "length-aware"> extends HonedRefine {
+    id: Exclude<MaybeId, undefined>;
     meta: Record<string, any> | null;
     emptyState: EmptyState | null;
     views: View[];
@@ -62,8 +68,16 @@ export declare interface HonedTable<T extends Record<string, any> = Record<strin
     isPageable: boolean;
     isToggleable: boolean;
     getRecordKey: (record: TableEntry<T>) => Identifier;
+    getEntry: (record: TableEntry<T>, column: Column<T> | string) => {
+        v: any;
+        e: any;
+        c: string | null;
+        f: boolean;
+    } | null;
+    getValue: (record: TableEntry<T>, column: Column<T> | string) => any;
+    getExtra: (record: TableEntry<T>, column: Column<T> | string) => any;
     headings: Heading<T>[];
-    columns: Column<T>[];
+    columns: HonedColumn<T>[];
     records: TableRecord<T>[];
     inline: boolean;
     bulk: Executable<BulkOperation>[];
@@ -86,9 +100,9 @@ export declare interface HonedTable<T extends Record<string, any> = Record<strin
     deselectAll: () => void;
     isPageSelected: boolean;
     hasSelected: boolean;
-    bindCheckbox: (record: TableEntry<T>) => void;
-    bindPage: () => void;
-    bindAll: () => void;
+    bindCheckbox: (record: TableEntry<T>) => RecordBinding<Identifier>;
+    bindPage: () => Binding;
+    bindAll: () => Binding;
 }
 
 export declare type Identifier = string | number;
@@ -104,11 +118,6 @@ export declare interface LengthAwarePaginate extends SimplePaginate {
     links: PaginatorLink[];
 }
 
-export declare interface PageBinding {
-    "onUpdate:modelValue": (checked: boolean | "indeterminate") => void;
-    modelValue: boolean;
-}
-
 export declare interface PageOption {
     value: number;
     active: boolean;
@@ -144,7 +153,7 @@ export declare interface Table<T extends Record<string, any> = Record<string, an
         operations: InlineOperation[];
     }>;
     paginate: PaginateMap[K];
-    columns: BaseColumn<T>[];
+    columns: Column<T>[];
     pages: PageOption[];
     toggleable: boolean;
     operations: {
@@ -157,14 +166,14 @@ export declare interface Table<T extends Record<string, any> = Record<string, an
     meta: Record<string, any>;
 }
 
-export declare type TableEntry<T extends Record<string, any> = any> = {
+export declare type TableEntry<T extends Record<string, any> = Record<string, any>> = {
     [K in keyof T]: {
         v: T[K];
         e: any;
         c: string | null;
         f: boolean;
     };
-};
+} & Classes;
 
 export declare interface TableOptions<T extends Record<string, any> = Record<string, any>> extends VisitOptions {
     /**
@@ -175,15 +184,16 @@ export declare interface TableOptions<T extends Record<string, any> = Record<str
 
 export declare interface TableRecord<T extends Record<string, any> = Record<string, any>> {
     operations: Executable<InlineOperation>[];
+    class: string | null;
     default: (options?: VisitOptions) => void;
     select: () => void;
     deselect: () => void;
     toggle: () => void;
     selected: boolean;
-    bind: () => any;
-    entry: (column: Column<T> | string) => TableEntry<T>[keyof T] | null;
-    value: (column: Column<T> | string) => TableEntry<T>[keyof T]["v"] | null;
-    extra: (column: Column<T> | string) => TableEntry<T>[keyof T]["e"] | null;
+    bind: () => RecordBinding<Identifier>;
+    entry: (column: HonedColumn<T> | string) => TableEntry<T>[keyof T] | null;
+    value: (column: HonedColumn<T> | string) => TableEntry<T>[keyof T]["v"] | null;
+    extra: (column: HonedColumn<T> | string) => TableEntry<T>[keyof T]["e"] | null;
 }
 
 export declare type UseTable = typeof useTable;