@wordrhyme/auto-crud 1.3.6 → 1.3.9

package/README.md

@@ -268,7 +268,7 @@ interface AutoCrudTableProps<TSchema> {
     batchFields?: (string | BatchUpdateField)[]; // 批量更新字段
     /** @deprecated 新代码请使用 actions.batch */
     batchActions?: BatchActionConfig<z.output<TSchema>>;
-    defaultSort?: any[]; // 默认排序
+    defaultSort?: any[]; // 手动 resource 的 UI 默认排序；useAutoCrudResource 请配置 options.defaultSort
   };
   form?: {
     overrides?: Record<string, any>; // 表单覆盖配置
@@ -280,11 +280,13 @@ interface AutoCrudTableProps<TSchema> {
    * 旧写法 actions={[...]} 仍表示行操作；
    * 新写法 actions={{ toolbar, row, batch }} 可集中配置三类操作。
    */
-  actions?: RowActionConfig<z.output<TSchema>> | {
-    toolbar?: ToolbarActionConfig;
-    row?: RowActionConfig<z.output<TSchema>>;
-    batch?: BatchActionConfig<z.output<TSchema>>;
-  };
+  actions?:
+    | RowActionConfig<z.output<TSchema>>
+    | {
+        toolbar?: ToolbarActionConfig;
+        row?: RowActionConfig<z.output<TSchema>>;
+        batch?: BatchActionConfig<z.output<TSchema>>;
+      };
   /** @deprecated 新代码请使用 actions.toolbar */
   toolbar?: ToolbarActionConfig;
   /** @deprecated 新代码请使用 actions.toolbar */
@@ -302,6 +304,11 @@ interface AutoCrudTableProps<TSchema> {
 interface UseAutoCrudResourceConfig<TData> {
   dataSource: DataSource<TData>; // 数据源
   schema: z.ZodType<TData>; // Zod Schema
+  options?: {
+    defaultSort?: Array<{ id: string; desc: boolean }> | false;
+    // undefined: schema 有 createdAt 时默认 createdAt desc
+    // false: 不应用默认排序
+  };
 }
 ```
 
@@ -539,11 +546,11 @@ table={{
 
 `toolbar` 数组控制页面顶部右侧工具栏的按钮，设计思路完全对齐行操作 `actions`。旧 prop `toolbarActions` 仍兼容读取，但新代码请使用 `toolbar`。
 
-内置操作类型：`create`（新建）、`import`（导入）、`export`（导出）。
+内置操作类型：`refresh`（刷新）、`create`（新建）、`import`（导入）、`export`（导出）。
 
 ### 只添加自定义按钮（内置保持默认）
 
-只传 `type: "custom"` 项时，所有内置按钮（导入、导出、新建）保持原样，custom 项按 `position` 插入首部或尾部。
+只传 `type: "custom"` 项时，所有内置按钮（刷新、导入、导出、新建）保持原样，custom 项按 `position` 插入首部或尾部。
 
 ```tsx
 <AutoCrudTable
@@ -556,7 +563,7 @@ table={{
     { type: 'custom', component: <Button variant="outline">批量标签</Button> }, // 默认 position: "end"
   ]}
 />
-// 渲染顺序: 分类管理 · [导入] · [导出] · [新建] · 批量标签
+// 渲染顺序: 分类管理 · [刷新] · [导入] · [导出] · [新建] · 批量标签
 ```
 
 ### 调整内置按钮顺序
@@ -662,7 +669,7 @@ table={{
 
 ```tsx
 <AutoCrudTable
-  // defaults 即内置三个按钮的信息，在此数组里你可以随意 map、过滤或插值
+  // defaults 即内置按钮的信息，在此数组里你可以随意 map、过滤或插值
   toolbar={(defaults) =>
     defaults.map((btn) =>
       btn.type === 'create'
@@ -690,7 +697,7 @@ type ToolbarActionConfig =
   | ((defaults: ToolbarBuiltinActionItem[]) => ToolbarActionItem[]);
 
 type ToolbarBuiltinActionItem = ActionMeta & {
-  type: 'create' | 'import' | 'export';
+  type: 'refresh' | 'create' | 'import' | 'export';
   onClick?: () => void; // 覆盖默认行为
   label?: string; // 覆盖默认文案
   component?: React.ReactNode | ((context: AutoCrudToolbarContext) => React.ReactNode);
@@ -708,10 +715,34 @@ interface AutoCrudToolbarContext {
   rowIds: string[];
   selectedRowIds: string[];
   selectedCount: number;
+  refresh?: () => Promise<unknown>;
+  openImport?: () => void;
+  exportData?: () => Promise<void>;
   openCreate?: () => void;
+  isRefreshing: boolean;
+  isExporting: boolean;
 }
 ```
 
+`AutoCrudToolbarContext` 是工具栏自定义组件的正式 command contract。自定义按钮需要复用 AutoCrud 内置能力时，直接调用 context 中的命令，不要绕过内部状态重新实现。
+
+例如业务侧希望把默认“新建”按钮替换成“手动创建”，可以替换 `type: "create"` 的组件并调用 `openCreate`：
+
+```tsx
+<AutoCrudTable
+  toolbar={[
+    {
+      type: 'create',
+      component: ({ openCreate }) => (
+        <Button onClick={() => openCreate?.()}>手动创建</Button>
+      ),
+    },
+  ]}
+/>
+```
+
+这里“手动创建”只是业务按钮文案，不是新的 AutoCrud 流程；它仍然打开 AutoCrud 原生的新建弹窗。`openCreate`、`openImport`、`exportData` 会按对应权限和能力可选暴露，扩展方应使用 `?.()` 或自行控制 disabled 状态。
+
 ### 工具栏扩展 Resolver
 
 宿主应用可以通过 `setToolbarResolver` 为指定 CRUD 注入额外工具栏动作。resolver 是普通纯函数，不是 React Hook；不要在 resolver 内调用 `useRouter`、`useMemo` 等 React Hooks。
@@ -776,7 +807,12 @@ crudActions.register({
   actions={{
     row: [
       { type: 'custom', label: '分配', onClick: (row) => assign(row.id) },
-      { type: 'custom', label: '预览', onClick: (row) => preview(row), position: 'start' },
+      {
+        type: 'custom',
+        label: '预览',
+        onClick: (row) => preview(row),
+        position: 'start',
+      },
     ],
   }}
 />
@@ -849,7 +885,9 @@ type RowCustomActionItem<T> = ActionMeta & {
   type: 'custom';
   label?: string;
   onClick?: (row: T) => void;
-  component?: React.ReactNode | ((context: AutoCrudRowActionContext<T>) => React.ReactNode);
+  component?:
+    | React.ReactNode
+    | ((context: AutoCrudRowActionContext<T>) => React.ReactNode);
   position?: 'start' | 'end'; // 仅无内置项时生效，默认 end
   separator?: boolean;
   variant?: 'default' | 'destructive';
@@ -992,7 +1030,7 @@ import {
   createSelectColumn, // 创建选择列
   createActionsColumn, // 创建操作列
   createFormSchema, // Zod Schema → Formily Schema
-  createEditFormSchema, // 创建编辑表单 Schema（排除 id, createdAt, updatedAt）
+  createEditFormSchema, // 创建编辑表单 Schema（排除平台托管字段）
 } from '@wordrhyme/auto-crud';
 ```
 
@@ -1254,7 +1292,15 @@ function CustomCrudPage() {
   });
 
   const formSchema = createFormSchema(taskSchema, {
-    exclude: ["id", "createdAt", "updatedAt"],
+    exclude: [
+      "id",
+      "createdAt",
+      "updatedAt",
+      "createdBy",
+      "createdByType",
+      "updatedBy",
+      "updatedByType",
+    ],
   });
 
   return (