imean-service-engine-htmx-plugin 2.2.0 → 2.3.0

package/dist/index.d.mts

@@ -2,6 +2,7 @@ import { Context } from 'hono';
 import { z } from 'zod';
 import { Plugin, PluginPriority, Microservice } from 'imean-service-engine';
 import * as hono_jsx_jsx_dev_runtime from 'hono/jsx/jsx-dev-runtime';
+import * as hono_utils_html from 'hono/utils/html';
 
 /**
  * HtmxAdminPlugin 核心类型定义
@@ -39,11 +40,17 @@ interface ActionButton {
     onClick?: string;
     /** 自定义类名 */
     className?: string;
+    /** 链接目标（如 "_blank" 表示新窗口打开） */
+    target?: string;
 }
 /**
  * 对话框大小类型
  */
 type DialogSize = "sm" | "md" | "lg" | "xl" | "full";
+/**
+ * 打开方式类型
+ */
+type OpenMode = "dialog" | "page" | "newWindow";
 /**
  * 页面元数据配置
  */
@@ -785,6 +792,7 @@ declare class DefaultListFeature<T extends {
     private listFieldNames?;
     private filterSchema?;
     private columnRenderers?;
+    private openMode?;
     constructor(options: {
         /** 列表数据的 Schema（用于字段推断和显示） */
         schema: z.ZodObject<any>;
@@ -806,6 +814,16 @@ declare class DefaultListFeature<T extends {
         filterSchema?: z.ZodObject<any>;
         /** 自定义列渲染函数（可选，key 为字段名，value 为渲染函数） */
         columnRenderers?: Record<string, (value: any, item: T) => any>;
+        /** 打开方式配置（可选，默认为 dialog）
+         * - create: 新建按钮的打开方式（默认 "dialog"）
+         * - detail: 查看按钮的打开方式（默认 "dialog"）
+         * - edit: 编辑按钮的打开方式（默认 "dialog"）
+         */
+        openMode?: {
+            create?: OpenMode;
+            detail?: OpenMode;
+            edit?: OpenMode;
+        };
     });
     getRoutes(): {
         method: "get";
@@ -859,70 +877,6 @@ declare class HtmxAdminPlugin implements Plugin {
  */
 declare function getUserInfo(ctx: Context, authProvider?: AuthProvider): Promise<UserInfo | null>;
 
-/**
- * 表单字段渲染器的 Alpine.js x-data 工具函数
- * 提供统一的模式，简化自定义表单字段渲染器的开发
- */
-interface FormFieldXDataOptions {
-    /** 字段名（用于更新隐藏字段） */
-    fieldName: string;
-    /** 数据对象的键名（如 'banners', 'items' 等） */
-    dataKey: string;
-    /** 默认值（如 [] 或 {}） */
-    defaultValue?: any;
-    /** 额外的数据属性 */
-    customData?: Record<string, any>;
-    /** 自定义方法（方法名 -> 方法体字符串） */
-    customMethods?: Record<string, string>;
-    /** 是否使用 x-effect 自动同步（默认 false，需要在方法中手动调用 updateHiddenField） */
-    autoSync?: boolean;
-}
-/**
- * 创建表单字段的 Alpine.js x-data 字符串
- *
- * @example
- * ```tsx
- * const xData = createFormFieldXData({
- *   fieldName: 'banners',
- *   dataKey: 'banners',
- *   defaultValue: [],
- *   customMethods: {
- *     addBanner() {
- *       this.banners.push({ url: '', alt: '', order: this.banners.length });
- *       this.updateHiddenField();
- *     },
- *     removeBanner(index) {
- *       this.banners.splice(index, 1);
- *       this.updateHiddenField();
- *     }
- *   }
- * });
- * ```
- */
-declare function createFormFieldXData(options: FormFieldXDataOptions): string;
-/**
- * 表单字段渲染器包装器组件的属性
- */
-interface FormFieldWrapperProps {
-    /** 字段名 */
-    fieldName: string;
-    /** 初始值（会被序列化为 JSON） */
-    initialValue: any;
-    /** x-data 字符串 */
-    xData: string;
-    /** 是否使用 x-effect 自动同步 */
-    autoSync?: boolean;
-    /** 子元素（组件 UI） */
-    children: any;
-    /** 额外的 className */
-    className?: string;
-}
-/**
- * 表单字段渲染器包装器组件
- * 自动处理隐藏字段、x-data、data-initial-value 等固定模式
- */
-declare function FormFieldWrapper(props: FormFieldWrapperProps): hono_jsx_jsx_dev_runtime.JSX.Element;
-
 /**
  * 参数解析工具函数
  */
@@ -1004,4 +958,39 @@ 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, FormFieldWrapper, 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, createFormFieldXData, getUserInfo, modelNameToPath, parseListParams };
+interface ObjectEditorProps {
+    /** 字段定义 */
+    field: any;
+    /** 当前值（对象，已解析） */
+    value: Record<string, any> | null;
+    /** 完整的初始数据 */
+    initialData?: any;
+    /** 字段名（用于更新隐藏字段） */
+    fieldName: string;
+    /** 对象的 Zod schema（用于自动渲染结构） */
+    objectSchema?: z.ZodObject<any>;
+}
+declare function ObjectEditor(props: ObjectEditorProps): hono_jsx_jsx_dev_runtime.JSX.Element;
+
+/**
+ * 字符串数组编辑器组件
+ * 支持增加、删除和拖放排序功能
+ * 使用 Alpine.js 管理状态，通过隐藏字段与表单系统同步数据
+ */
+interface StringArrayEditorProps {
+    /** 字段定义 */
+    field: any;
+    /** 当前值（字符串数组，已解析） */
+    value: string[] | null;
+    /** 完整的初始数据 */
+    initialData?: any;
+    /** 字段名（用于更新隐藏字段） */
+    fieldName: string;
+    /** 占位符文本（可选） */
+    placeholder?: string;
+    /** 是否允许空值（默认 false） */
+    allowEmpty?: boolean;
+}
+declare function StringArrayEditor(props: StringArrayEditorProps): hono_utils_html.HtmlEscapedString | Promise<hono_utils_html.HtmlEscapedString>;
+
+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, ObjectEditor, type ObjectEditorProps, type PageMetadata, PageModel, type PermissionResult, StringArrayEditor, type StringArrayEditorProps, type UserInfo, checkUserPermission, getUserInfo, modelNameToPath, parseListParams };

package/dist/index.d.ts

@@ -2,6 +2,7 @@ import { Context } from 'hono';
 import { z } from 'zod';
 import { Plugin, PluginPriority, Microservice } from 'imean-service-engine';
 import * as hono_jsx_jsx_dev_runtime from 'hono/jsx/jsx-dev-runtime';
+import * as hono_utils_html from 'hono/utils/html';
 
 /**
  * HtmxAdminPlugin 核心类型定义
@@ -39,11 +40,17 @@ interface ActionButton {
     onClick?: string;
     /** 自定义类名 */
     className?: string;
+    /** 链接目标（如 "_blank" 表示新窗口打开） */
+    target?: string;
 }
 /**
  * 对话框大小类型
  */
 type DialogSize = "sm" | "md" | "lg" | "xl" | "full";
+/**
+ * 打开方式类型
+ */
+type OpenMode = "dialog" | "page" | "newWindow";
 /**
  * 页面元数据配置
  */
@@ -785,6 +792,7 @@ declare class DefaultListFeature<T extends {
     private listFieldNames?;
     private filterSchema?;
     private columnRenderers?;
+    private openMode?;
     constructor(options: {
         /** 列表数据的 Schema（用于字段推断和显示） */
         schema: z.ZodObject<any>;
@@ -806,6 +814,16 @@ declare class DefaultListFeature<T extends {
         filterSchema?: z.ZodObject<any>;
         /** 自定义列渲染函数（可选，key 为字段名，value 为渲染函数） */
         columnRenderers?: Record<string, (value: any, item: T) => any>;
+        /** 打开方式配置（可选，默认为 dialog）
+         * - create: 新建按钮的打开方式（默认 "dialog"）
+         * - detail: 查看按钮的打开方式（默认 "dialog"）
+         * - edit: 编辑按钮的打开方式（默认 "dialog"）
+         */
+        openMode?: {
+            create?: OpenMode;
+            detail?: OpenMode;
+            edit?: OpenMode;
+        };
     });
     getRoutes(): {
         method: "get";
@@ -859,70 +877,6 @@ declare class HtmxAdminPlugin implements Plugin {
  */
 declare function getUserInfo(ctx: Context, authProvider?: AuthProvider): Promise<UserInfo | null>;
 
-/**
- * 表单字段渲染器的 Alpine.js x-data 工具函数
- * 提供统一的模式，简化自定义表单字段渲染器的开发
- */
-interface FormFieldXDataOptions {
-    /** 字段名（用于更新隐藏字段） */
-    fieldName: string;
-    /** 数据对象的键名（如 'banners', 'items' 等） */
-    dataKey: string;
-    /** 默认值（如 [] 或 {}） */
-    defaultValue?: any;
-    /** 额外的数据属性 */
-    customData?: Record<string, any>;
-    /** 自定义方法（方法名 -> 方法体字符串） */
-    customMethods?: Record<string, string>;
-    /** 是否使用 x-effect 自动同步（默认 false，需要在方法中手动调用 updateHiddenField） */
-    autoSync?: boolean;
-}
-/**
- * 创建表单字段的 Alpine.js x-data 字符串
- *
- * @example
- * ```tsx
- * const xData = createFormFieldXData({
- *   fieldName: 'banners',
- *   dataKey: 'banners',
- *   defaultValue: [],
- *   customMethods: {
- *     addBanner() {
- *       this.banners.push({ url: '', alt: '', order: this.banners.length });
- *       this.updateHiddenField();
- *     },
- *     removeBanner(index) {
- *       this.banners.splice(index, 1);
- *       this.updateHiddenField();
- *     }
- *   }
- * });
- * ```
- */
-declare function createFormFieldXData(options: FormFieldXDataOptions): string;
-/**
- * 表单字段渲染器包装器组件的属性
- */
-interface FormFieldWrapperProps {
-    /** 字段名 */
-    fieldName: string;
-    /** 初始值（会被序列化为 JSON） */
-    initialValue: any;
-    /** x-data 字符串 */
-    xData: string;
-    /** 是否使用 x-effect 自动同步 */
-    autoSync?: boolean;
-    /** 子元素（组件 UI） */
-    children: any;
-    /** 额外的 className */
-    className?: string;
-}
-/**
- * 表单字段渲染器包装器组件
- * 自动处理隐藏字段、x-data、data-initial-value 等固定模式
- */
-declare function FormFieldWrapper(props: FormFieldWrapperProps): hono_jsx_jsx_dev_runtime.JSX.Element;
-
 /**
  * 参数解析工具函数
  */
@@ -1004,4 +958,39 @@ 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, FormFieldWrapper, 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, createFormFieldXData, getUserInfo, modelNameToPath, parseListParams };
+interface ObjectEditorProps {
+    /** 字段定义 */
+    field: any;
+    /** 当前值（对象，已解析） */
+    value: Record<string, any> | null;
+    /** 完整的初始数据 */
+    initialData?: any;
+    /** 字段名（用于更新隐藏字段） */
+    fieldName: string;
+    /** 对象的 Zod schema（用于自动渲染结构） */
+    objectSchema?: z.ZodObject<any>;
+}
+declare function ObjectEditor(props: ObjectEditorProps): hono_jsx_jsx_dev_runtime.JSX.Element;
+
+/**
+ * 字符串数组编辑器组件
+ * 支持增加、删除和拖放排序功能
+ * 使用 Alpine.js 管理状态，通过隐藏字段与表单系统同步数据
+ */
+interface StringArrayEditorProps {
+    /** 字段定义 */
+    field: any;
+    /** 当前值（字符串数组，已解析） */
+    value: string[] | null;
+    /** 完整的初始数据 */
+    initialData?: any;
+    /** 字段名（用于更新隐藏字段） */
+    fieldName: string;
+    /** 占位符文本（可选） */
+    placeholder?: string;
+    /** 是否允许空值（默认 false） */
+    allowEmpty?: boolean;
+}
+declare function StringArrayEditor(props: StringArrayEditorProps): hono_utils_html.HtmlEscapedString | Promise<hono_utils_html.HtmlEscapedString>;
+
+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, ObjectEditor, type ObjectEditorProps, type PageMetadata, PageModel, type PermissionResult, StringArrayEditor, type StringArrayEditorProps, type UserInfo, checkUserPermission, getUserInfo, modelNameToPath, parseListParams };