imean-service-engine-htmx-plugin 2.0.0 → 2.1.0

package/dist/index.d.mts

@@ -82,24 +82,31 @@ interface FieldMetadata {
     searchable?: boolean;
     /** 是否可排序 */
     sortable?: boolean;
+    /** 是否可用于筛选（默认 true，设置为 false 时不会出现在筛选表单中） */
+    filterable?: boolean;
     /** 自定义渲染函数 */
     render?: (value: any, item: any) => any;
 }
 /**
- * Model Schema 接口
- * 类型通过 schema 的 z.infer 推断，无需显式传递泛型
- */
-interface ModelSchema {
-    /** Zod Schema（用于数据验证和类型推断） */
-    schema: z.ZodObject<any>;
-    /** 字段元数据（可选，用于自定义字段标签、描述等） */
-    fields?: Record<string, FieldMetadata>;
-    /** 列表显示字段（可选，用于列表页显示哪些字段） */
-    listFields?: string[];
-    /** 详情显示字段（可选，用于详情页显示哪些字段） */
-    detailFields?: string[];
-    /** 表单字段（可选，用于表单页显示哪些字段，默认排除 id、createdAt、updatedAt） */
-    formFields?: string[];
+ * 模型字段信息
+ * 从 Zod Schema 一次性解析出的字段元数据
+ */
+interface ModelField {
+    /** 字段名 */
+    name: string;
+    /** 字段标签（从 schema description 提取） */
+    label: string;
+    /** 字段类型 */
+    type: FormField["type"];
+    /** 是否必填 */
+    required: boolean;
+    /** 选项（用于 select 类型） */
+    options?: Array<{
+        value: string | number;
+        label: string;
+    }>;
+    /** 原始 Zod Schema（用于验证等） */
+    schema: any;
 }
 /**
  * Feature 类型
@@ -119,7 +126,7 @@ interface Notification {
 }
 /**
  * Feature 上下文
- * 类型通过 model.modelSchema.schema 的 z.infer 推断
+ * 类型通过 model.schema 的 z.infer 推断
  */
 interface FeatureContext {
     /** PageModel 实例 */
@@ -167,7 +174,7 @@ interface FeatureContext {
 }
 /**
  * Feature 接口
- * 类型通过 context.model.modelSchema.schema 的 z.infer 推断
+ * 类型通过 context.model.schema 的 z.infer 推断
  */
 interface Feature {
     /** Feature 名称 */
@@ -313,7 +320,11 @@ interface FormField {
 
 /**
  * Feature 注册表
- * 类型通过 model.modelSchema.schema 的 z.infer 推断
+ */
+
+/**
+ * Feature 注册表
+ * 类型通过 model.schema 的 z.infer 推断
  */
 declare class FeatureRegistry {
     private features;
@@ -347,70 +358,6 @@ declare class FeatureRegistry {
      * 快捷方法：注册自定义 Feature
      */
     custom(name: string, feature: Feature): void;
-    /**
-     * 一键启用所有 CRUD Feature
-     * 类型通过 model.modelSchema.schema 的 z.infer 推断
-     */
-    crud<T extends {
-        id: string | number;
-    } = any>(options: {
-        /** 权限前缀 */
-        permissionPrefix: string;
-        /** 获取列表数据的函数 */
-        getList: (params: ListParams) => Promise<ListResult<T>>;
-        /** 获取单条数据的函数 */
-        getItem: (id: string | number) => Promise<T | null>;
-        /** 创建数据的函数 */
-        createItem: (data: Partial<T>) => Promise<T>;
-        /** 更新数据的函数 */
-        updateItem: (id: string | number, data: Partial<T>) => Promise<T | null>;
-        /** 删除数据的函数（可选） */
-        deleteItem?: (id: string | number) => Promise<boolean>;
-        /** 自定义权限（可选） */
-        permissions?: {
-            list?: string;
-            read?: string;
-            create?: string;
-            edit?: string;
-            delete?: string;
-        };
-        /** 是否启用某些 Feature（可选） */
-        features?: {
-            list?: boolean;
-            detail?: boolean;
-            create?: boolean;
-            edit?: boolean;
-            delete?: boolean;
-        };
-        /** 弹窗大小配置（可选） */
-        dialogSizes?: {
-            list?: DialogSize;
-            detail?: DialogSize;
-            create?: DialogSize;
-            edit?: DialogSize;
-            delete?: DialogSize;
-        };
-        /** 是否允许点击遮罩关闭配置（可选） */
-        closeOnBackdropClick?: {
-            list?: boolean;
-            detail?: boolean;
-            create?: boolean;
-            edit?: boolean;
-            delete?: boolean;
-        };
-        /** 动态标题配置（可选） */
-        getTitles?: {
-            detail?: (item: T, context: FeatureContext) => string | Promise<string>;
-            edit?: (item: T, context: FeatureContext) => string | Promise<string>;
-            create?: (context: FeatureContext) => string | Promise<string>;
-        };
-        /** 动态描述配置（可选） */
-        getDescriptions?: {
-            detail?: (item: T, context: FeatureContext) => string | Promise<string> | undefined;
-            edit?: (item: T, context: FeatureContext) => string | Promise<string> | undefined;
-            create?: (context: FeatureContext) => string | Promise<string> | undefined;
-        };
-    }): void;
     /**
      * 获取所有注册的 Feature
      */
@@ -428,81 +375,24 @@ declare class FeatureRegistry {
 
 /**
  * PageModel 基类
- * 类型通过 modelSchema.schema 的 z.infer 推断，无需显式传递泛型
+ * 不再包含 schema，schema 由各个 Feature 指定
  */
 declare abstract class PageModel {
     readonly modelName: string;
     readonly features: FeatureRegistry;
-    protected modelSchema?: ModelSchema;
     private metadata;
     /**
      * 构造函数
      * @param modelName 模型/页面名称（用于路由和权限）
-     * @param schema 模型 Schema（可选，不提供则为普通页面）
      * @param metadata 页面元数据（可选，如果提供则不需要实现 getMetadata）
      */
-    constructor(modelName: string, schema?: ModelSchema, metadata?: PageMetadata);
-    /**
-     * 获取推断的类型（如果有 schema）
-     * 使用方式：type ModelType = z.infer<typeof pageModel.getSchema()!.schema>
-     */
-    getInferredType(): z.ZodObject<any> | undefined;
+    constructor(modelName: string, metadata?: PageMetadata);
     /**
      * 获取页面元数据
      * 如果构造函数提供了 metadata，直接返回
      * 否则调用子类实现
      */
     getMetadata(): PageMetadata;
-    /**
-     * 判断是否有数据模型（有 Schema）
-     */
-    hasModel(): boolean;
-    /**
-     * 获取模型 Schema（可选）
-     */
-    getSchema?(): ModelSchema | undefined;
-    /**
-     * 验证数据（仅用于有数据模型的场景）
-     */
-    validate(data: unknown): {
-        success: true;
-        data: any;
-    } | {
-        success: false;
-        error: string;
-    };
-    /**
-     * 获取表单字段（仅用于有数据模型的场景）
-     */
-    getFormFields(): FormField[];
-    /**
-     * 创建表单字段
-     */
-    private createFormField;
-    /**
-     * 从 Zod enum schema 中提取选项
-     */
-    private extractEnumOptions;
-    /**
-     * 判断字段是否为必填
-     */
-    private isRequiredField;
-    /**
-     * 推断字段类型
-     */
-    private inferFieldType;
-    /**
-     * 获取列表字段（仅用于有数据模型的场景）
-     */
-    getListFields(): string[];
-    /**
-     * 获取详情字段（仅用于有数据模型的场景）
-     */
-    getDetailFields(): string[];
-    /**
-     * 获取字段标签
-     */
-    getFieldLabel(fieldName: string): string;
 }
 
 /**
@@ -525,6 +415,10 @@ declare abstract class BaseFeature implements Feature {
     dialogSize?: DialogSize;
     /** 是否允许点击遮罩区域关闭弹窗（默认 true，设置为 false 时只能通过关闭按钮关闭） */
     closeOnBackdropClick?: boolean;
+    /** Schema（可选，由子类在构造函数中设置） */
+    protected schema?: z.ZodObject<any>;
+    /** 解析后的字段列表（可选，由子类在构造函数中设置） */
+    protected fields?: ModelField[];
     constructor(options: {
         name: string;
         type: FeatureType;
@@ -638,6 +532,7 @@ declare abstract class BaseFormFeature<T extends {
      * 处理请求
      */
     handle(context: FeatureContext): Promise<any>;
+    protected formFieldNames?: string[];
     /**
      * 渲染表单页面
      */
@@ -694,13 +589,15 @@ declare class CustomFeature extends BaseFeature {
 
 /**
  * 默认创建 Feature
- * 类型通过 context.model.modelSchema.schema 的 z.infer 推断
+ * 类型通过 schema 的 z.infer 推断
  */
 declare class DefaultCreateFeature<T extends {
     id: string | number;
 } = any> extends BaseFormFeature<T> {
     private createItem;
     constructor(options: {
+        /** 表单数据的 Schema（用于验证和字段推断） */
+        schema: z.ZodObject<any>;
         createItem: (data: Partial<T>) => Promise<T>;
         permissionPrefix: string;
         permission?: string;
@@ -710,6 +607,8 @@ declare class DefaultCreateFeature<T extends {
         getTitle?: (context: FeatureContext) => string | Promise<string>;
         /** 获取动态描述（可选，接收 context，返回描述字符串） */
         getDescription?: (context: FeatureContext) => string | Promise<string> | undefined;
+        /** 表单字段名（可选，不提供则显示 schema 中的所有字段） */
+        formFieldNames?: string[];
     });
     getFormAction(): "create";
     getRoutes(): ({
@@ -732,7 +631,7 @@ declare class DefaultCreateFeature<T extends {
 
 /**
  * 默认删除 Feature
- * 类型通过 context.model.modelSchema.schema 的 z.infer 推断
+ * 类型通过 context.model.schema 的 z.infer 推断
  */
 declare class DefaultDeleteFeature<T extends {
     id: string | number;
@@ -756,7 +655,7 @@ declare class DefaultDeleteFeature<T extends {
 
 /**
  * 默认详情 Feature
- * 类型通过 context.model.modelSchema.schema 的 z.infer 推断
+ * 类型通过 schema 的 z.infer 推断
  */
 declare class DefaultDetailFeature<T extends {
     id: string | number;
@@ -765,7 +664,10 @@ declare class DefaultDetailFeature<T extends {
     private deleteItem?;
     private titleGetter?;
     private descriptionGetter?;
+    private detailFieldNames?;
     constructor(options: {
+        /** 详情数据的 Schema（用于字段推断和显示） */
+        schema: z.ZodObject<any>;
         getItem: (id: string | number) => Promise<T | null>;
         deleteItem?: (id: string | number) => Promise<boolean>;
         permissionPrefix: string;
@@ -776,6 +678,8 @@ declare class DefaultDetailFeature<T extends {
         getTitle?: (item: T, context: FeatureContext) => string | Promise<string>;
         /** 获取动态描述（可选，接收 item 和 context，返回描述字符串） */
         getDescription?: (item: T, context: FeatureContext) => string | Promise<string> | undefined;
+        /** 详情显示字段名（可选，不提供则显示 schema 中的所有字段） */
+        detailFieldNames?: string[];
     });
     getTitle(context: FeatureContext): Promise<string>;
     getDescription(context: FeatureContext): Promise<string | undefined>;
@@ -793,7 +697,7 @@ declare class DefaultDetailFeature<T extends {
 
 /**
  * 默认编辑 Feature
- * 类型通过 context.model.modelSchema.schema 的 z.infer 推断
+ * 类型通过 schema 的 z.infer 推断
  */
 declare class DefaultEditFeature<T extends {
     id: string | number;
@@ -801,6 +705,8 @@ declare class DefaultEditFeature<T extends {
     private getItem;
     private updateItem;
     constructor(options: {
+        /** 表单数据的 Schema（用于验证和字段推断） */
+        schema: z.ZodObject<any>;
         getItem: (id: string | number) => Promise<T | null>;
         updateItem: (id: string | number, data: Partial<T>) => Promise<T | null>;
         permissionPrefix: string;
@@ -811,6 +717,8 @@ declare class DefaultEditFeature<T extends {
         getTitle?: (item: T, context: FeatureContext) => string | Promise<string>;
         /** 获取动态描述（可选，接收 item 和 context，返回描述字符串） */
         getDescription?: (item: T, context: FeatureContext) => string | Promise<string> | undefined;
+        /** 表单字段名（可选，不提供则显示 schema 中的所有字段） */
+        formFieldNames?: string[];
     });
     getFormAction(): "edit";
     getRoutes(): ({
@@ -837,14 +745,18 @@ declare class DefaultEditFeature<T extends {
 
 /**
  * 默认列表 Feature
- * 类型通过 context.model.modelSchema.schema 的 z.infer 推断
+ * 类型通过 schema 的 z.infer 推断
  */
 declare class DefaultListFeature<T extends {
     id: string | number;
 } = any> extends BaseFeature {
     private getList;
     private deleteItem?;
+    private listFieldNames?;
+    private filterSchema?;
     constructor(options: {
+        /** 列表数据的 Schema（用于字段推断和显示） */
+        schema: z.ZodObject<any>;
         /** 获取列表数据的函数 */
         getList: (params: ListParams) => Promise<ListResult<T>>;
         /** 删除数据的函数（可选，不提供则列表不显示删除操作） */
@@ -857,6 +769,10 @@ declare class DefaultListFeature<T extends {
         dialogSize?: DialogSize;
         /** 是否允许点击遮罩区域关闭弹窗 */
         closeOnBackdropClick?: boolean;
+        /** 列表显示字段名（可选，不提供则显示 schema 中的所有字段） */
+        listFieldNames?: string[];
+        /** 筛选表单的 Schema（可选，不提供则不显示筛选表单） */
+        filterSchema?: z.ZodObject<any>;
     });
     getRoutes(): {
         method: "get";
@@ -989,4 +905,4 @@ declare function ErrorAlert(props: ErrorAlertProps): hono_jsx_jsx_dev_runtime.JS
  */
 declare function LoadingBar(): hono_jsx_jsx_dev_runtime.JSX.Element;
 
-export { type AuthProvider, BaseFeature, CustomFeature, DefaultCreateFeature, DefaultDeleteFeature, DefaultDetailFeature, DefaultEditFeature, DefaultListFeature, Dialog, type DialogProps, type DialogSize, ErrorAlert, type ErrorAlertProps, type Feature, type FeatureContext, type FeatureType, type FieldMetadata, HtmxAdminPlugin, type HtmxAdminPluginOptions, type ListParams, type ListResult, LoadingBar, type ModelSchema, type NavItemConfig, type Notification, type NotificationType$1 as NotificationType, type PageMetadata, PageModel, type PermissionResult, type UserInfo, checkUserPermission, getUserInfo, modelNameToPath, parseListParams };
+export { type AuthProvider, BaseFeature, CustomFeature, DefaultCreateFeature, DefaultDeleteFeature, DefaultDetailFeature, DefaultEditFeature, DefaultListFeature, Dialog, type DialogProps, type DialogSize, ErrorAlert, type ErrorAlertProps, type Feature, type FeatureContext, type FeatureType, type FieldMetadata, HtmxAdminPlugin, type HtmxAdminPluginOptions, type ListParams, type ListResult, LoadingBar, type NavItemConfig, type Notification, type NotificationType$1 as NotificationType, type PageMetadata, PageModel, type PermissionResult, type UserInfo, checkUserPermission, getUserInfo, modelNameToPath, parseListParams };