@izumisy-tailor/tailor-data-viewer 0.2.22 → 0.2.23

package/README.md

@@ -11,7 +11,7 @@ A low-level React component library for building data table interfaces with Tail
 - **`DataTable.*` Compound Components**: Data-bound table with sort indicators, cell renderers, and `useDataTable` integration
 - **`useDataTable` Hook**: Integrates data, column visibility, row operations (optimistic updates), and props generators
 - **Column Definition Helpers**: `field()` for data columns with sort/filter, `display()` for render-only columns
-- **Metadata-based Inference**: `inferColumnHelper()` auto-derives sort/filter config from generated table metadata
+- **Metadata-based Inference**: `createColumnHelper().inferColumns()` auto-derives sort/filter config from generated table metadata
 - **Utility Components**: `ColumnSelector`, `CsvButton`, `SearchFilterForm`, `Pagination` — all props-based, spreadable from hooks
 - **Multi-sort Support**: Multiple simultaneous sort fields
 - **Optimistic Updates**: `updateRow`, `deleteRow`, `insertRow` with rollback
@@ -49,27 +49,27 @@ npm install react react-dom
 import {
   useCollection,
   useDataTable,
-  Collection,
   DataTable,
   Pagination,
-  field,
-  display,
+  createColumnHelper,
 } from "@izumisy-tailor/tailor-data-viewer/component";
 import "@izumisy-tailor/tailor-data-viewer/styles/theme.css";
 
 // 1. Define columns
+const { field, display } = createColumnHelper<Order>();
+
 const columns = [
-  field<Order>("name", {
+  field("name", {
     label: "Name",
     sort: { type: "string" },
     filter: { type: "string" },
   }),
-  field<Order>("amount", {
+  field("amount", {
     label: "Amount",
     sort: { type: "number" },
     filter: { type: "number" },
   }),
-  field<Order>("status", {
+  field("status", {
     label: "Status",
     filter: {
       type: "enum",
@@ -79,7 +79,7 @@ const columns = [
       ],
     },
   }),
-  display<Order>("actions", {
+  display("actions", {
     width: 50,
     render: (row) => <button onClick={() => handleEdit(row)}>Edit</button>,
   }),
@@ -98,13 +98,13 @@ function OrdersPage() {
   });
 
   return (
-    <Collection.Provider value={collection}>
-      <DataTable.Root {...table.rootProps}>
+    <DataTable.Provider value={table}>
+      <DataTable.Root>
         <DataTable.Headers />
         <DataTable.Body />
       </DataTable.Root>
-      <Pagination {...table} />
-    </Collection.Provider>
+      <Pagination />
+    </DataTable.Provider>
   );
 }
 ```
@@ -128,8 +128,8 @@ const collection = useCollection({
 const [result] = useQuery({ ...collection.toQueryArgs() });
 
 // Filter operations
-collection.addFilter("status", "ACTIVE", "eq");
-collection.setFilters([{ field: "status", fieldType: "enum", operator: "eq", value: "ACTIVE" }]);
+collection.addFilter("status", "eq", "ACTIVE");
+collection.setFilters([{ field: "status", operator: "eq", value: "ACTIVE" }]);
 collection.removeFilter("status");
 collection.clearFilters();
 
@@ -140,26 +140,40 @@ collection.clearSort();
 
 // Pagination
 collection.nextPage(endCursor);
-collection.prevPage();
+collection.prevPage(startCursor);
 collection.resetPage();
+
+// Page info tracking
+collection.setPageInfo(pageInfo);
+collection.hasPrevPage;  // boolean
+collection.hasNextPage;  // boolean
 ```
 
-### `Collection.Provider` / `useCollectionContext()`
+### `DataTable.Provider` / `useDataTableContext()` / `useCollectionContext()`
 
-Shares `useCollection` return value via Context. Child components access it with `useCollectionContext()`.
+`DataTable.Provider` wraps the table UI and provides both data table and collection context. All utility components (`Pagination`, `ColumnSelector`, `CsvButton`, `SearchFilterForm`) read from this context — no prop spreading needed.
+
+When `collection` is passed to `useDataTable`, `DataTable.Provider` automatically wraps a `Collection.Provider` so child components can use `useCollectionContext()`.
 
 ```tsx
-<Collection.Provider value={collection}>
+<DataTable.Provider value={table}>
   <StatusFilter />   {/* useCollectionContext() inside */}
-  <DataTable.Root {...table.rootProps}>
+  <DataTable.Root>
     <DataTable.Headers />
     <DataTable.Body />
   </DataTable.Root>
-  <Pagination {...table} />
-</Collection.Provider>
+  <Pagination />
+</DataTable.Provider>
 ```
 
-Provider is optional — for simple cases, pass params directly via props.
+For cases where you need `Collection.Provider` without `DataTable.Provider` (e.g., non-table UIs), you can use it standalone:
+
+```tsx
+<Collection.Provider value={collection}>
+  <StatusFilter />
+  <CustomKanbanBoard />
+</Collection.Provider>
+```
 
 ### Column Definition Helpers
 
@@ -189,7 +203,7 @@ display("actions", {
 
 ### Table Metadata Generator
 
-This library includes a metadata generator for [Tailor Platform SDK](https://www.npmjs.com/package/@tailor-platform/sdk) that produces type-safe table metadata with `as const` assertions. The generated metadata is used by `inferColumnHelper()` for automatic sort/filter configuration.
+This library includes a metadata generator for [Tailor Platform SDK](https://www.npmjs.com/package/@tailor-platform/sdk) that produces type-safe table metadata with `as const` assertions. The generated metadata is used by `createColumnHelper().inferColumns()` for automatic sort/filter configuration.
 
 1. Configure the generator in your `tailor.config.ts`:
 
@@ -215,15 +229,16 @@ export default defineConfig({
 tailor-sdk generate
 ```
 
-### `inferColumnHelper(tableMetadata)`
+### `createColumnHelper().inferColumns(tableMetadata)`
 
-`field()` requires manually specifying `sort`/`filter` type configs and enum `options` for every column. `inferColumnHelper()` eliminates this boilerplate by automatically deriving these from the generated table metadata. Based on each field's type (string, number, date, enum, etc.), the appropriate `SortConfig` / `FilterConfig` is set automatically, and enum fields get their options populated from the schema.
+`field()` requires manually specifying `sort`/`filter` type configs and enum `options` for every column. `inferColumns()` eliminates this boilerplate by automatically deriving these from the generated table metadata. Based on each field's type (string, number, date, enum, etc.), the appropriate `SortConfig` / `FilterConfig` is set automatically, and enum fields get their options populated from the schema.
 
 ```tsx
-import { inferColumnHelper, display } from "@izumisy-tailor/tailor-data-viewer/component";
+import { createColumnHelper } from "@izumisy-tailor/tailor-data-viewer/component";
 import { tableMetadata } from "./generated/data-viewer-metadata.generated";
 
-const { column, columns } = inferColumnHelper(tableMetadata.task);
+const { inferColumns, display } = createColumnHelper<Task>();
+const { column, columns } = inferColumns(tableMetadata.task);
 
 const taskColumns = [
   column("title"),                     // sort/filter auto-configured from metadata
@@ -237,7 +252,7 @@ const taskColumns = [
 ];
 ```
 
-`inferColumnHelper()` can be freely mixed with manual `field()` / `display()` definitions. Use `field()` for fields not in the metadata or those requiring custom configuration, and `inferColumnHelper()` for everything else.
+`inferColumns()` can be freely mixed with manual `field()` / `display()` definitions. Use `field()` for fields not in the metadata or those requiring custom configuration, and `inferColumns()` for everything else.
 
 ### `useDataTable(options)`
 
@@ -250,13 +265,19 @@ const table = useDataTable<Order>({
   loading: result.fetching,
   error: result.error,
   collection,
+  onClickRow: (row) => navigate(`/orders/${row.id}`),
+  rowActions: [
+    { id: "delete", label: "Delete", variant: "destructive", onClick: (row) => handleDelete(row.id) },
+  ],
 });
 
-// Spread props to components
-<DataTable.Root {...table.rootProps}>...</DataTable.Root>
-<ColumnSelector {...table} />
-<CsvButton {...table} />
-<Pagination {...table} />
+// Wrap with DataTable.Provider (utility components read from context)
+<DataTable.Provider value={table}>
+  <DataTable.Root>...</DataTable.Root>
+  <ColumnSelector />
+  <CsvButton filename="orders" />
+  <Pagination />
+</DataTable.Provider>
 
 // Column visibility
 table.toggleColumn("amount");
@@ -296,52 +317,63 @@ Low-level table primitives without data binding. Use for fully custom layouts or
 Pair with `useDataTable` for automatic header sorting, cell rendering, and row operations.
 
 ```tsx
-// Basic usage (spread rootProps)
-<DataTable.Root {...table.rootProps}>
-  <DataTable.Headers />
-  <DataTable.Body />
-</DataTable.Root>
+// Basic usage (wrap with DataTable.Provider)
+<DataTable.Provider value={table}>
+  <DataTable.Root>
+    <DataTable.Headers />
+    <DataTable.Body />
+  </DataTable.Root>
+</DataTable.Provider>
 
 // Custom row rendering
-<DataTable.Root {...table.rootProps}>
-  <DataTable.Headers />
-  <DataTable.Body>
-    {table.rows.map((row, rowIndex) => (
-      <DataTable.Row
-        key={row.id}
-        {...table.getRowProps(row)}
-        onClick={() => navigate(`/orders/${row.id}`)}
-      >
-        {table.visibleColumns.map((col) => (
-          <DataTable.Cell key={col.id} {...table.getCellProps(row, col, rowIndex)} />
-        ))}
-      </DataTable.Row>
-    ))}
-  </DataTable.Body>
-</DataTable.Root>
+<DataTable.Provider value={table}>
+  <DataTable.Root>
+    <DataTable.Headers />
+    <DataTable.Body>
+      {table.rows.map((row) => (
+        <DataTable.Row
+          key={row.id}
+          onClick={() => navigate(`/orders/${row.id}`)}
+        >
+          {table.visibleColumns.map((col) => (
+            <DataTable.Cell key={col.kind === "field" ? col.dataKey : col.id} />
+          ))}
+        </DataTable.Row>
+      ))}
+    </DataTable.Body>
+  </DataTable.Root>
+</DataTable.Provider>
 ```
 
 ### Utility Components
 
-All utility components are props-based and designed to be used with spread from `useDataTable` / `useCollection`.
+All utility components read from `DataTable.Provider` context.
+
+| Component | Props | Description |
+|-----------|-------|-------------|
+| `Pagination` | (none) | Previous/Next page controls |
+| `ColumnSelector` | (none) | Column visibility toggle UI |
+| `CsvButton` | `filename?` | Export visible data as CSV |
+| `SearchFilterForm` | `labels?`, `trigger?` | Multi-field filter form with operator selection |
 
-| Component | Spread from | Description |
-|-----------|------------|-------------|
-| `ColumnSelector` | `{...table}` | Column visibility toggle UI |
-| `CsvButton` | `{...table}` | Export visible data as CSV |
-| `SearchFilterForm` | `{...table, ...collection}` | Multi-field filter form with operator selection |
-| `Pagination` | `{...table}` | Previous/Next page controls |
+All utility components read from `DataTable.Provider` context — no prop spreading needed:
 
 ```tsx
-<SearchFilterForm {...table} {...collection} />
-<ColumnSelector {...table} />
-<CsvButton {...table} filename="orders-export" />
-<Pagination {...table} />
+<DataTable.Provider value={table}>
+  <SearchFilterForm />
+  <ColumnSelector />
+  <CsvButton filename="orders-export" />
+  <DataTable.Root>
+    <DataTable.Headers />
+    <DataTable.Body />
+  </DataTable.Root>
+  <Pagination />
+</DataTable.Provider>
 ```
 
 ### Optimistic Updates in Cell Renderers
 
-Use `useDataTableContext()` inside `DataTable.Root` to access row operations from custom cell renderers.
+Use `useDataTableContext()` inside `DataTable.Provider` to access row operations from custom cell renderers.
 
 ```tsx
 const StatusEditor: CellRenderer<Order> = ({ value, row }) => {

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@izumisy-tailor/tailor-data-viewer",
   "private": false,
-  "version": "0.2.22",
+  "version": "0.2.23",
   "type": "module",
   "description": "Flexible data viewer component for Tailor Platform",
   "files": [

package/src/component/field-helpers.test.ts

@@ -1,5 +1,5 @@
 import { describe, it, expect, expectTypeOf } from "vitest";
-import { createColumnHelper, inferColumnHelper } from "./field-helpers";
+import { createColumnHelper } from "./field-helpers";
 import type { TableMetadataMap } from "../generator/metadata-generator";
 import { fieldTypeToSortConfig, fieldTypeToFilterConfig } from "./types";
 import type { NodeType, TableFieldName } from "./types";
@@ -175,7 +175,7 @@ describe("fieldTypeToFilterConfig", () => {
   });
 });
 
-describe("inferColumnHelper()", () => {
+describe("createColumnHelper().inferColumns()", () => {
   const testMetadata = {
     task: {
       name: "task",
@@ -203,8 +203,19 @@ describe("inferColumnHelper()", () => {
     },
   } as const satisfies TableMetadataMap;
 
+  type TaskRow = {
+    id: string;
+    title: string;
+    status: string;
+    dueDate: string;
+    count: number;
+    isActive: boolean;
+    tags: string[];
+  };
+
   it("creates a column with auto-detected sort/filter", () => {
-    const { column } = inferColumnHelper(testMetadata.task);
+    const { inferColumns } = createColumnHelper<TaskRow>();
+    const { column } = inferColumns(testMetadata.task);
 
     const titleCol = column("title");
     expect(titleCol.kind).toBe("field");
@@ -214,7 +225,8 @@ describe("inferColumnHelper()", () => {
   });
 
   it("auto-detects enum options", () => {
-    const { column } = inferColumnHelper(testMetadata.task);
+    const { inferColumns } = createColumnHelper<TaskRow>();
+    const { column } = inferColumns(testMetadata.task);
     const statusCol = column("status");
     expect(statusCol.filter).toEqual({
       type: "enum",
@@ -229,42 +241,48 @@ describe("inferColumnHelper()", () => {
   });
 
   it("auto-detects date type", () => {
-    const { column } = inferColumnHelper(testMetadata.task);
+    const { inferColumns } = createColumnHelper<TaskRow>();
+    const { column } = inferColumns(testMetadata.task);
     const dateCol = column("dueDate");
     expect(dateCol.sort).toEqual({ type: "date" });
     expect(dateCol.filter).toEqual({ type: "date" });
   });
 
   it("disables sort with sort: false", () => {
-    const { column } = inferColumnHelper(testMetadata.task);
+    const { inferColumns } = createColumnHelper<TaskRow>();
+    const { column } = inferColumns(testMetadata.task);
     const col = column("title", { sort: false });
     expect(col.sort).toBeUndefined();
     expect(col.filter).toEqual({ type: "string" });
   });
 
   it("disables filter with filter: false", () => {
-    const { column } = inferColumnHelper(testMetadata.task);
+    const { inferColumns } = createColumnHelper<TaskRow>();
+    const { column } = inferColumns(testMetadata.task);
     const col = column("title", { filter: false });
     expect(col.sort).toEqual({ type: "string" });
     expect(col.filter).toBeUndefined();
   });
 
   it("uuid has no sort, has uuid filter", () => {
-    const { column } = inferColumnHelper(testMetadata.task);
+    const { inferColumns } = createColumnHelper<TaskRow>();
+    const { column } = inferColumns(testMetadata.task);
     const col = column("id");
     expect(col.sort).toBeUndefined();
     expect(col.filter).toEqual({ type: "uuid" });
   });
 
   it("array type has no sort/filter", () => {
-    const { column } = inferColumnHelper(testMetadata.task);
+    const { inferColumns } = createColumnHelper<TaskRow>();
+    const { column } = inferColumns(testMetadata.task);
     const col = column("tags");
     expect(col.sort).toBeUndefined();
     expect(col.filter).toBeUndefined();
   });
 
   it("columns() creates multiple columns at once", () => {
-    const { columns } = inferColumnHelper(testMetadata.task);
+    const { inferColumns } = createColumnHelper<TaskRow>();
+    const { columns } = inferColumns(testMetadata.task);
     const cols = columns(["title", "status", "dueDate"]);
     expect(cols).toHaveLength(3);
     expect(cols[0].dataKey).toBe("title");
@@ -273,7 +291,8 @@ describe("inferColumnHelper()", () => {
   });
 
   it("columns() applies overrides", () => {
-    const { columns } = inferColumnHelper(testMetadata.task);
+    const { inferColumns } = createColumnHelper<TaskRow>();
+    const { columns } = inferColumns(testMetadata.task);
     const cols = columns(["title", "status"], {
       overrides: {
         title: { label: "Custom Title", width: 300 },
@@ -284,7 +303,8 @@ describe("inferColumnHelper()", () => {
   });
 
   it("columns() applies global sort/filter options", () => {
-    const { columns } = inferColumnHelper(testMetadata.task);
+    const { inferColumns } = createColumnHelper<TaskRow>();
+    const { columns } = inferColumns(testMetadata.task);
     const cols = columns(["title", "status"], { sort: false });
     expect(cols[0].sort).toBeUndefined();
     expect(cols[1].sort).toBeUndefined();
@@ -293,7 +313,8 @@ describe("inferColumnHelper()", () => {
   });
 
   it("throws for non-existent field", () => {
-    const { column } = inferColumnHelper(testMetadata.task);
+    const { inferColumns } = createColumnHelper<TaskRow>();
+    const { column } = inferColumns(testMetadata.task);
     // @ts-expect-error - intentionally testing invalid field name
     expect(() => column("nonExistent")).toThrow(
       'Field "nonExistent" not found in table "task" metadata',

package/src/component/field-helpers.ts

@@ -140,37 +140,10 @@ export function createColumnHelper<TRow extends Record<string, unknown>>(): {
 }
 
 // =============================================================================
-// inferColumnHelper() helper
+// Internal: metadata-based column inference (used by createColumnHelper)
 // =============================================================================
 
-/**
- * Create column definition helpers from generated table metadata.
- *
- * Automatically infers sort/filter configuration from field types,
- * including enum options.
- *
- * @typeParam TRow - The row type for type-safe renderer access.
- * @param tableMetadata - A single table metadata object from the generated map.
- *
- * @example
- * ```tsx
- * import { tableMetadata } from "./generated/data-viewer-metadata.generated";
- *
- * type Task = { id: string; title: string; status: string; dueDate: string };
- *
- * const { column, columns } = inferColumnHelper<Task>(tableMetadata.task);
- *
- * const taskColumns = [
- *   column("title"),           // sort/filter auto-detected
- *   column("status"),          // enum options auto-populated
- *   column("dueDate"),         // date type auto-recognized
- *   column("title", {
- *     renderer: ({ row }) => <span>{row.title}</span>, // row: Task
- *   }),
- * ];
- * ```
- */
-export function inferColumnHelper<
+function inferColumnHelper<
   TRow extends Record<string, unknown>,
   const TTable extends TableMetadata = TableMetadata,
 >(

package/src/component/index.ts

@@ -65,7 +65,7 @@ export { useDataTable } from "./data-table/use-data-table";
 export { useDataTableContext } from "./data-table/data-table-context";
 
 // Field helpers
-export { createColumnHelper, inferColumnHelper } from "./field-helpers";
+export { createColumnHelper } from "./field-helpers";
 
 // Utility components
 export { Pagination } from "./pagination";