@wordrhyme/auto-crud 0.5.0 → 0.10.0

package/dist/index.d.cts

@@ -1,4 +1,4 @@
-import * as react_jsx_runtime2 from "react/jsx-runtime";
+import * as react_jsx_runtime1 from "react/jsx-runtime";
 import { z } from "zod";
 import * as _tanstack_react_table0 from "@tanstack/react-table";
 import { Column, ColumnDef, ColumnSort, Row, RowData, Table, TableOptions, TableState } from "@tanstack/react-table";
@@ -86,6 +86,33 @@ interface UseAutoCrudResourceOptions<TSchema extends z.ZodObject<z.ZodRawShape>,
    * - ToastAdapter: 注入自定义 toast 实现
    */
   toast?: ToastAdapter | false;
+  /**
+   * 自定义导出数据获取函数（escape hatch）
+   *
+   * 通常不需要传此参数：
+   * - 导出选中行：纯客户端，零配置
+   * - 导出筛选结果：router 有 export procedure 时自动可用
+   *
+   * 仅当需要完全自定义导出逻辑时才使用（如队列导出、自定义接口等）
+   * 传入后优先级高于 router.export
+   */
+  exportFetcher?: (params: any) => Promise<{
+    data: Record<string, unknown>[];
+    total: number;
+    hasMore: boolean;
+  }>;
+}
+/**
+ * 导入结果类型（与服务端保持一致）
+ */
+interface ImportResult {
+  success: number;
+  updated: number;
+  skipped: number;
+  failed: Array<{
+    row: number;
+    errors: string[];
+  }>;
 }
 /**
  * Hook 返回值类型
@@ -103,6 +130,7 @@ interface UseAutoCrudResourceReturn<TSchema extends z.ZodObject<z.ZodRawShape>,
     isCreating: boolean;
     isUpdating: boolean;
     isDeleting: boolean;
+    isImporting: boolean;
   };
   handlers: {
     openCreate: () => void;
@@ -117,10 +145,15 @@ interface UseAutoCrudResourceReturn<TSchema extends z.ZodObject<z.ZodRawShape>,
     deleteMany: (rows: TListItem[]) => void;
     updateMany: (rows: TListItem[], data: Record<string, unknown>) => void;
     setVariant: (variant: ModalVariant$1) => void;
+    /** 导入数据（router 有 import 路由时自动可用） */
+    import: ((rows: Record<string, unknown>[]) => Promise<ImportResult>) | null;
+    /** 导出筛选结果（router 有 export procedure 或传入 exportFetcher 时自动可用）。导出选中行由 AutoCrudTable 内部处理 */
+    export: (() => Promise<Record<string, unknown>[]>) | null;
   };
 }
 /**
  * tRPC Router 接口定义（宽松类型以兼容实际 tRPC router）
+ * import 为可选 — 传入 router 时自动检测是否存在
  */
 interface CrudRouter {
   list: {
@@ -141,6 +174,27 @@ interface CrudRouter {
   updateMany?: {
     useMutation: (opts?: any) => any;
   };
+  /** 导入路由（mutation，由 createCrudRouter 自动生成） */
+  import?: {
+    useMutation: (opts?: any) => any;
+  };
+  /** 导出路由（query，由 createCrudRouter 自动生成） */
+  export?: {
+    useQuery: (input?: any, opts?: any) => any;
+  };
+}
+/**
+ * 自动生成的查询参数（由内部 URL 状态管理生成）
+ */
+interface AutoQueryParams {
+  page: number;
+  perPage: number;
+  sort: Array<{
+    id: string;
+    desc: boolean;
+  }>;
+  filters: any[];
+  joinOperator: "and" | "or";
 }
 /**
  * Hook 配置参数
@@ -148,10 +202,24 @@ interface CrudRouter {
 interface UseAutoCrudResourceParams<TSchema extends z.ZodObject<z.ZodRawShape>, TListItem> {
   /** tRPC router (如 trpc.tasks) */
   router: CrudRouter;
-  /** 列表查询参数 */
-  queryInput?: any;
   /** Zod schema */
   schema: TSchema;
+  /**
+   * 查询参数变换函数
+   *
+   * 默认零配置：hook 内部自动管理 URL 状态（分页、排序、筛选），
+   * 传入此函数可注入额外参数或修改自动生成的参数。
+   *
+   * @example
+   * ```tsx
+   * // 注入租户 ID
+   * query: (params) => ({ ...params, tenantId: currentTenant.id })
+   *
+   * // 覆盖默认分页
+   * query: (params) => ({ ...params, perPage: 20 })
+   * ```
+   */
+  query?: (params: AutoQueryParams) => Record<string, unknown>;
   /** 其他配置选项 */
   options?: UseAutoCrudResourceOptions<TSchema, TListItem>;
 }
@@ -160,7 +228,8 @@ interface UseAutoCrudResourceParams<TSchema extends z.ZodObject<z.ZodRawShape>,
  */
 declare function useAutoCrudResource<TSchema extends z.ZodObject<z.ZodRawShape>, TListItem = z.output<TSchema>>({
   router,
-  queryInput,
+  schema,
+  query: queryTransform,
   options
 }: UseAutoCrudResourceParams<TSchema, TListItem>): UseAutoCrudResourceReturn<TSchema, TListItem>;
 //#endregion
@@ -178,6 +247,8 @@ interface CrudOperationPermissions {
   delete?: boolean;
   /** 是否允许导出 */
   export?: boolean;
+  /** 是否允许导入 */
+  import?: boolean;
 }
 /**
  * AutoCrudTable 权限配置
@@ -243,7 +314,7 @@ declare function AutoTableActionBar<TData>({
   enableExport,
   enableDelete,
   extraActions
-}: AutoTableActionBarProps<TData>): react_jsx_runtime2.JSX.Element;
+}: AutoTableActionBarProps<TData>): react_jsx_runtime1.JSX.Element;
 //#endregion
 //#region src/lib/schema-bridge/types.d.ts
 /**
@@ -369,6 +440,10 @@ interface AutoTableProps<T extends z.ZodObject<z.ZodRawShape>> {
   initialSorting?: any[];
   /** 是否启用导出功能 (默认 true) */
   enableExport?: boolean;
+  /** 选中行数变化回调（用于外层组件获知选中状态） */
+  onSelectedCountChange?: (count: number) => void;
+  /** 获取选中行数据的回调（由外层组件调用） */
+  getSelectedRows?: React.MutableRefObject<(() => z.infer<T>[]) | null>;
 }
 declare function AutoTable<T extends z.ZodObject<z.ZodRawShape>>({
   schema,
@@ -385,8 +460,10 @@ declare function AutoTable<T extends z.ZodObject<z.ZodRawShape>>({
   batchUpdateFields,
   actionBarExtra,
   initialSorting,
-  enableExport
-}: AutoTableProps<T>): react_jsx_runtime2.JSX.Element;
+  enableExport,
+  onSelectedCountChange,
+  getSelectedRows
+}: AutoTableProps<T>): react_jsx_runtime1.JSX.Element;
 //#endregion
 //#region src/components/auto-crud/auto-crud-table.d.ts
 /**
@@ -468,9 +545,9 @@ interface AutoCrudTableProps<TSchema extends z.ZodObject<z.ZodRawShape>> {
   /** 扩展点 */
   slots?: {
     /** 工具栏左侧插槽 */
-    toolbarStart?: React.ReactNode;
+    toolbarStart?: React$1.ReactNode;
     /** 工具栏右侧插槽 */
-    toolbarEnd?: React.ReactNode;
+    toolbarEnd?: React$1.ReactNode;
     /** 自定义行操作 */
     rowActions?: (row: z.output<TSchema>) => Array<{
       label: string;
@@ -489,6 +566,7 @@ interface AutoCrudTableProps<TSchema extends z.ZodObject<z.ZodRawShape>> {
    *     update: user.role === 'admin' || user.role === 'editor',
    *     delete: user.role === 'admin',
    *     export: true,
+   *     import: true,
    *   },
    *   deny: user.role === 'user' ? ['salary', 'ssn'] : [],
    * }), [user.role]);
@@ -513,7 +591,7 @@ declare function AutoCrudTable<TSchema extends z.ZodObject<z.ZodRawShape>>({
   form: formConfig,
   slots,
   permissions
-}: AutoCrudTableProps<TSchema>): react_jsx_runtime2.JSX.Element;
+}: AutoCrudTableProps<TSchema>): react_jsx_runtime1.JSX.Element;
 //#endregion
 //#region src/components/auto-crud/auto-form.d.ts
 interface AutoFormProps<T extends z.ZodObject<z.ZodRawShape>> {
@@ -545,7 +623,7 @@ declare function AutoFormInner<T extends z.ZodObject<z.ZodRawShape>>({
   labelAlign,
   labelWidth,
   showSubmitButton
-}: AutoFormProps<T>, ref: React.Ref<AutoFormRef>): react_jsx_runtime2.JSX.Element;
+}: AutoFormProps<T>, ref: React.Ref<AutoFormRef>): react_jsx_runtime1.JSX.Element;
 declare const AutoForm: <T extends z.ZodObject<z.ZodRawShape>>(props: AutoFormProps<T> & {
   ref?: React.Ref<AutoFormRef>;
 }) => ReturnType<typeof AutoFormInner>;
@@ -759,12 +837,12 @@ declare const filterItemSchema: z.ZodObject<{
   variant: z.ZodEnum<{
     number: "number";
     boolean: "boolean";
-    date: "date";
     text: "text";
+    range: "range";
+    date: "date";
+    dateRange: "dateRange";
     select: "select";
     multiSelect: "multiSelect";
-    dateRange: "dateRange";
-    range: "range";
   }>;
   operator: z.ZodEnum<{
     iLike: "iLike";
@@ -840,7 +918,7 @@ declare function AutoTableSimpleFilters<TData>({
   shallow,
   filters: externalFilters,
   onFiltersChange
-}: AutoTableSimpleFiltersProps<TData>): react_jsx_runtime2.JSX.Element | null;
+}: AutoTableSimpleFiltersProps<TData>): react_jsx_runtime1.JSX.Element | null;
 //#endregion
 //#region src/components/auto-crud/form-modal.d.ts
 type ModalVariant = "dialog" | "sheet";
@@ -875,7 +953,46 @@ declare function CrudFormModal<T extends z.ZodObject<z.ZodRawShape>>({
   title,
   labelAlign,
   labelWidth
-}: CrudFormModalProps<T>): react_jsx_runtime2.JSX.Element;
+}: CrudFormModalProps<T>): react_jsx_runtime1.JSX.Element;
+//#endregion
+//#region src/components/auto-crud/import-dialog.d.ts
+interface ImportDialogProps {
+  open: boolean;
+  onOpenChange: (open: boolean) => void;
+  /** 执行导入的回调 */
+  onImport: (rows: Record<string, unknown>[]) => Promise<ImportResult>;
+  /** 可用列名（用于生成模板） */
+  columns?: string[];
+  /** 对话框标题 */
+  title?: string;
+}
+declare function ImportDialog({
+  open,
+  onOpenChange,
+  onImport,
+  columns,
+  title
+}: ImportDialogProps): react_jsx_runtime1.JSX.Element;
+//#endregion
+//#region src/components/auto-crud/export-dialog.d.ts
+type ExportMode = "selected" | "filtered";
+interface ExportDialogProps {
+  open: boolean;
+  onOpenChange: (open: boolean) => void;
+  /** 当前选中的行数 */
+  selectedCount: number;
+  /** 执行导出 */
+  onExport: (mode: ExportMode) => Promise<void>;
+  /** 是否支持导出筛选结果（需要 exportFetcher） */
+  canExportFiltered?: boolean;
+}
+declare function ExportDialog({
+  open,
+  onOpenChange,
+  selectedCount,
+  onExport,
+  canExportFiltered
+}: ExportDialogProps): react_jsx_runtime1.JSX.Element;
 //#endregion
 //#region src/components/data-table/data-table.d.ts
 interface DataTableProps<TData> extends React$1.ComponentProps<"div"> {
@@ -888,7 +1005,7 @@ declare function DataTable<TData>({
   children,
   className,
   ...props
-}: DataTableProps<TData>): react_jsx_runtime2.JSX.Element;
+}: DataTableProps<TData>): react_jsx_runtime1.JSX.Element;
 //#endregion
 //#region src/components/data-table/data-table-advanced-toolbar.d.ts
 interface DataTableAdvancedToolbarProps<TData> extends React$1.ComponentProps<"div"> {
@@ -899,7 +1016,7 @@ declare function DataTableAdvancedToolbar<TData>({
   children,
   className,
   ...props
-}: DataTableAdvancedToolbarProps<TData>): react_jsx_runtime2.JSX.Element;
+}: DataTableAdvancedToolbarProps<TData>): react_jsx_runtime1.JSX.Element;
 //#endregion
 //#region src/components/data-table/data-table-column-header.d.ts
 interface DataTableColumnHeaderProps<TData, TValue> extends React.ComponentProps<typeof DropdownMenuTrigger> {
@@ -911,7 +1028,7 @@ declare function DataTableColumnHeader<TData, TValue>({
   label,
   className,
   ...props
-}: DataTableColumnHeaderProps<TData, TValue>): react_jsx_runtime2.JSX.Element;
+}: DataTableColumnHeaderProps<TData, TValue>): react_jsx_runtime1.JSX.Element;
 //#endregion
 //#region src/components/data-table/data-table-faceted-filter.d.ts
 interface DataTableFacetedFilterProps<TData, TValue> {
@@ -925,7 +1042,7 @@ declare function DataTableFacetedFilter<TData, TValue>({
   title,
   options,
   multiple
-}: DataTableFacetedFilterProps<TData, TValue>): react_jsx_runtime2.JSX.Element;
+}: DataTableFacetedFilterProps<TData, TValue>): react_jsx_runtime1.JSX.Element;
 //#endregion
 //#region src/components/data-table/data-table-pagination.d.ts
 interface DataTablePaginationProps<TData> extends React.ComponentProps<"div"> {
@@ -937,7 +1054,7 @@ declare function DataTablePagination<TData>({
   pageSizeOptions,
   className,
   ...props
-}: DataTablePaginationProps<TData>): react_jsx_runtime2.JSX.Element;
+}: DataTablePaginationProps<TData>): react_jsx_runtime1.JSX.Element;
 //#endregion
 //#region src/components/data-table/data-table-toolbar.d.ts
 interface DataTableToolbarProps<TData> extends React$1.ComponentProps<"div"> {
@@ -948,7 +1065,7 @@ declare function DataTableToolbar<TData>({
   children,
   className,
   ...props
-}: DataTableToolbarProps<TData>): react_jsx_runtime2.JSX.Element;
+}: DataTableToolbarProps<TData>): react_jsx_runtime1.JSX.Element;
 //#endregion
 //#region src/components/data-table/data-table-view-options.d.ts
 interface DataTableViewOptionsProps<TData> extends React$1.ComponentProps<typeof PopoverContent> {
@@ -959,7 +1076,7 @@ declare function DataTableViewOptions<TData>({
   table,
   disabled,
   ...props
-}: DataTableViewOptionsProps<TData>): react_jsx_runtime2.JSX.Element;
+}: DataTableViewOptionsProps<TData>): react_jsx_runtime1.JSX.Element;
 //#endregion
 //#region src/hooks/use-data-table.d.ts
 interface UseDataTableProps<TData> extends Omit<TableOptions<TData>, "state" | "pageCount" | "getCoreRowModel" | "manualFiltering" | "manualPagination" | "manualSorting">, Required<Pick<TableOptions<TData>, "pageCount">> {
@@ -1230,4 +1347,68 @@ declare function formatDate(date: Date | string | number | undefined, opts?: Int
  */
 declare function humanize(str: string): string;
 //#endregion
-export { type ActionsColumnConfig, AutoCrudTable, type AutoCrudTableProps, AutoForm, AutoTable, AutoTableActionBar, AutoTableSimpleFilters, type ColumnOverrides, type CreateFormSchemaOptions, type CreateTableSchemaOptions, CrudFormModal, type CrudHooks, type CrudOperationPermissions, type CrudPermissions, type DataSource, DataTable, DataTableAdvancedToolbar, DataTableColumnHeader, DataTableFacetedFilter, DataTablePagination, DataTableRowAction, DataTableToolbar, DataTableViewOptions, type EnumOption, ExtendedColumnFilter, ExtendedColumnSort, type Field, type FieldType, type Fields, FilterOperator, type FilterVariant, type FormSchemaOverrides, type JSONSchema, type JSONSchemaProperty, JoinOperator, type ListParams, type ListResult, Option, type ParsedZodField, type Parser, QueryKeys, SchemaAdapter, type SimpleFieldConfig, type SimpleFieldsConfig, type ToastAdapter, type UnifiedField, type UnifiedSchema, type UrlStateOptions, type UseAutoCrudResourceOptions, cn, createActionsColumn, createEditFormSchema, createFormSchema, createMemoryDataSource, createSelectColumn, createTRPCDataSource, createTableSchema, formatDate, getUrlParams, humanize, noopToastAdapter, parseAsArrayOf, parseAsInteger, parseAsString, parseAsStringEnum, parseZodField, setSearchParams, useAutoCrudResource, useDataTable, useQueryState, useQueryStates, useReadableFilters, useUrlState, useUrlStates };
+//#region src/lib/import.d.ts
+interface ParsedImportData {
+  headers: string[];
+  rows: Record<string, unknown>[];
+  format: "csv" | "json";
+}
+/**
+ * 解析 CSV 字符串为对象数组
+ * 支持：引号包裹、逗号转义、换行符、空值
+ */
+declare function parseCSV(content: string): {
+  headers: string[];
+  rows: Record<string, string>[];
+};
+/**
+ * 解析 JSON 字符串为对象数组
+ * 支持 JSON 数组或 { data: [...] } 格式
+ */
+declare function parseJSON(content: string): Record<string, unknown>[];
+/**
+ * 统一解析入口：根据文件扩展名自动选择解析器
+ */
+declare function parseImportFile(file: File): Promise<ParsedImportData>;
+/**
+ * 生成 CSV 模板（仅包含表头，用于下载空模板）
+ */
+declare function generateCSVTemplate(headers: string[]): string;
+/**
+ * 将数据数组转换为 CSV 字符串
+ */
+declare function dataToCSV<T extends Record<string, unknown>>(data: T[], opts?: {
+  headers?: string[];
+  excludeColumns?: string[];
+}): string;
+/**
+ * 根据 Zod Schema 将 CSV 解析出的 string 值转换为正确类型
+ *
+ * CSV 解析后所有值都是 string，需要根据 schema 字段类型进行转换：
+ * - number: parseFloat
+ * - boolean: "true"/"1"/"yes" → true, 其他 → false
+ * - date: new Date(value)
+ * - 空字符串 → undefined（让 schema 默认值生效）
+ */
+declare function coerceRowValues<T extends z.ZodObject<z.ZodRawShape>>(rows: Record<string, unknown>[], schema: T): Record<string, unknown>[];
+//#endregion
+//#region src/lib/export.d.ts
+declare function exportTableToCSV<TData>(table: Table<TData>, opts?: {
+  filename?: string;
+  excludeColumns?: (keyof TData | "select" | "actions")[];
+  onlySelected?: boolean;
+}): void;
+/**
+ * 导出原始数据数组为 CSV（用于服务端全量导出）
+ */
+declare function exportAllToCSV<T extends Record<string, unknown>>(data: T[], opts?: {
+  filename?: string;
+  headers?: string[];
+  excludeColumns?: string[];
+}): void;
+/**
+ * 下载 CSV 模板文件
+ */
+declare function downloadCSVTemplate(headers: string[], filename?: string): void;
+//#endregion
+export { type ActionsColumnConfig, AutoCrudTable, type AutoCrudTableProps, AutoForm, type AutoQueryParams, AutoTable, AutoTableActionBar, AutoTableSimpleFilters, type ColumnOverrides, type CreateFormSchemaOptions, type CreateTableSchemaOptions, CrudFormModal, type CrudHooks, type CrudOperationPermissions, type CrudPermissions, type DataSource, DataTable, DataTableAdvancedToolbar, DataTableColumnHeader, DataTableFacetedFilter, DataTablePagination, DataTableRowAction, DataTableToolbar, DataTableViewOptions, type EnumOption, ExportDialog, type ExportDialogProps, type ExportMode, ExtendedColumnFilter, ExtendedColumnSort, type Field, type FieldType, type Fields, FilterOperator, type FilterVariant, type FormSchemaOverrides, ImportDialog, type ImportDialogProps, type ImportResult, type JSONSchema, type JSONSchemaProperty, JoinOperator, type ListParams, type ListResult, Option, type ParsedImportData, type ParsedZodField, type Parser, QueryKeys, SchemaAdapter, type SimpleFieldConfig, type SimpleFieldsConfig, type ToastAdapter, type UnifiedField, type UnifiedSchema, type UrlStateOptions, type UseAutoCrudResourceOptions, type UseAutoCrudResourceParams, type UseAutoCrudResourceReturn, cn, coerceRowValues, createActionsColumn, createEditFormSchema, createFormSchema, createMemoryDataSource, createSelectColumn, createTRPCDataSource, createTableSchema, dataToCSV, downloadCSVTemplate, exportAllToCSV, exportTableToCSV, formatDate, generateCSVTemplate, getUrlParams, humanize, noopToastAdapter, parseAsArrayOf, parseAsInteger, parseAsString, parseAsStringEnum, parseCSV, parseImportFile, parseJSON, parseZodField, setSearchParams, useAutoCrudResource, useDataTable, useQueryState, useQueryStates, useReadableFilters, useUrlState, useUrlStates };