@revisium/schema-toolkit-ui 0.4.0 → 0.6.0

package/README.md

@@ -97,7 +97,7 @@ const vm = new RowEditorVM(tableSchema, existingRowData, {
   refSchemas: { ... },
   callbacks: {
     onSearchForeignKey: async (tableId, search) => { ... },
-    onUploadFile: async (fileId, file) => { ... },
+    onUploadFile: async ({ rowId, fileId, file }) => { ... },
     onOpenFile: (url) => window.open(url, '_blank', 'noopener,noreferrer'),
     onNavigateToForeignKey: (tableId, rowId) => { ... },
   },
@@ -154,7 +154,7 @@ import type { ITableDataSource } from '@revisium/schema-toolkit-ui';
 
 const dataSource: ITableDataSource = {
   async fetchMetadata() {
-    // Return { schema, columns, viewState, readonly }
+    // Return { schema, columns, viewState, readonly, refSchemas? }
   },
   async fetchRows(query) {
     // query: { where, orderBy, search, first, after }
@@ -168,7 +168,7 @@ const dataSource: ITableDataSource = {
     // Return { ok, error? }
   },
   async saveView(viewState) {
-    // Persist column/filter/sort/search settings
+    // Persist column order, widths, pins, and sort settings
     // Return { ok, error? }
   },
 };
@@ -238,10 +238,35 @@ All callbacks are optional and passed via `TableEditorOptions.callbacks`:
 | `onOpenRow` | `(rowId: string) => void` | Navigate to row detail view |
 | `onDuplicateRow` | `(rowId: string) => void` | Duplicate a row |
 | `onSearchForeignKey` | `SearchForeignKeySearchFn` | Foreign key search handler |
+| `onUploadFile` | `(params: { rowId: string; fileId: string; file: File }) => Promise<Record<string, unknown> \| null>` | Upload a file for a file field |
+| `onOpenFile` | `(url: string) => void` | Open/preview a file URL |
 | `onCopyPath` | `(path: string) => void` | Copy JSON path to clipboard |
+| `onReadonlyEditAttempt` | `() => void` | Called when the user tries to edit a read-only cell (double-click, Enter, typing). Use this to show a toast/notification. Throttled internally (2 s). |
 
 In read-only mode (`fetchMetadata` returns `readonly: true`), delete and duplicate actions are hidden automatically. Open row still works.
 
+#### File columns
+
+File fields (`$ref` to the File schema) are automatically resolved into:
+- A **parent file column** (`FilterFieldType.File`) that displays the `fileName` and supports inline editing of the file name
+- **Sub-field columns** (e.g., `avatar.status`, `avatar.url`) for each primitive property of the file object
+
+Sub-field columns are hidden by default but can be added via the "+" column button. File columns are excluded from filters and sorts.
+
+To enable file upload/preview in the table, pass `onUploadFile` and `onOpenFile` in `TableEditorCallbacks`. The file cell shows upload and preview buttons on hover when these callbacks are provided. File schemas must be passed through `fetchMetadata` as `refSchemas` in the `TableMetadata` return value:
+
+```tsx
+async fetchMetadata() {
+  return {
+    schema,
+    columns,
+    viewState,
+    readonly: false,
+    refSchemas: { [SystemSchemaIds.File]: fileSchema },
+  };
+}
+```
+
 #### View model API
 
 ```tsx