imean-service-engine-htmx-plugin 2.10.1 → 2.11.0

package/dist/index.d.mts

@@ -270,8 +270,9 @@ interface Feature {
 }
 /**
  * 列表查询参数
+ * @template F 筛选条件的类型（从 filterSchema 推导）
  */
-interface ListParams {
+interface ListParams<F = Record<string, any>> {
     /** 页码（从1开始） */
     page?: number;
     /** 每页数量 */
@@ -281,7 +282,7 @@ interface ListParams {
     /** 排序方向 */
     sortOrder?: "asc" | "desc";
     /** 筛选条件 */
-    filters?: Record<string, any>;
+    filters?: F;
 }
 /**
  * 列表查询结果
@@ -540,6 +541,9 @@ declare abstract class BaseModelFeature<T extends ZodObject, M = z$1.infer<T>> e
  * 表单操作类型
  */
 type FormAction = "create" | "edit";
+interface BaseFormFeatureOptions<T extends ZodObject = z$1.ZodObject, M = z$1.infer<T>> extends BaseModelFeatureOptions<T, M> {
+    actions?: ActionButton[];
+}
 /**
  * 表单 Feature 基类
  * 用于创建和编辑 Feature 的共同逻辑
@@ -570,6 +574,8 @@ declare abstract class BaseFormFeature<T extends ZodObject = z$1.ZodObject, M =
      * 获取取消按钮的跳转 URL
      */
     abstract getCancelUrl(context: FeatureContext): string | undefined;
+    protected options: BaseFormFeatureOptions<T, M>;
+    constructor(options: BaseFormFeatureOptions<T, M>);
     /**
      * 设置标题和描述到 context
      */
@@ -600,15 +606,15 @@ declare abstract class BaseFormFeature<T extends ZodObject = z$1.ZodObject, M =
  * 默认创建 Feature
  */
 declare class DefaultCreateFeature<T extends ZodObject = z$2.ZodObject, M = z$2.infer<T>> extends BaseFormFeature<T, M> {
-    private options;
     private createItem;
-    constructor(options: Omit<BaseModelFeatureOptions<T, M>, "name" | "type" | "routes" | "render" | "actions"> & {
+    constructor(createOptions: Omit<BaseFormFeatureOptions<T, M>, "name" | "type" | "routes" | "render"> & {
         schema: T;
         createItem: (data: Partial<M>) => Promise<M>;
         permission?: string;
         dialogSize?: DialogSize;
         closeOnBackdropClick?: boolean;
         groups?: FieldGroup[];
+        actions?: ActionButton[];
     });
     getFormAction(): "create";
     getSubmitUrl(context: FeatureContext): string;
@@ -662,10 +668,9 @@ declare class DefaultDetailFeature<T extends ZodObject = z$2.ZodObject, M = z$2.
  * 默认编辑 Feature
  */
 declare class DefaultEditFeature<T extends ZodObject = z$2.ZodObject, M = z$2.infer<T>, ID = keyof M> extends BaseFormFeature<T, M> {
-    private options;
     private getItem;
     private updateItem;
-    constructor(options: Omit<BaseModelFeatureOptions<T, M>, "name" | "type" | "routes" | "render" | "actions"> & {
+    constructor(editOptions: Omit<BaseModelFeatureOptions<T, M>, "name" | "type" | "routes" | "render" | "actions"> & {
         schema: T;
         getItem: (id: ID) => Promise<M | null | undefined>;
         updateItem: (id: ID, data: Partial<M>) => Promise<M | null>;
@@ -686,20 +691,26 @@ declare class DefaultEditFeature<T extends ZodObject = z$2.ZodObject, M = z$2.in
  * 默认列表 Feature
  */
 
+/**
+ * 从 filterSchema 推导 filters 的类型
+ * 如果 filterSchema 是 optional，则 filters 也是 optional
+ */
+type InferFilterType<FSchema extends z$2.ZodObject<any> | undefined> = FSchema extends z$2.ZodObject<infer Shape> ? Partial<z$2.infer<FSchema>> : Record<string, any> | undefined;
 /**
  * 默认列表 Feature
  */
-declare class DefaultListFeature<T extends ZodObject = z$2.ZodObject, M = z$2.infer<T>, ID = keyof M> extends BaseModelFeature<T, M> {
+declare class DefaultListFeature<T extends ZodObject = z$2.ZodObject, M = z$2.infer<T>, ID = keyof M, FSchema extends z$2.ZodObject<any> | undefined = z$2.ZodObject<any> | undefined> extends BaseModelFeature<T, M> {
     private options;
     private getList;
     private deleteItem?;
     private filterSchema?;
     private filterFields;
     private openMode?;
-    constructor(options: Omit<BaseModelFeatureOptions<T, M>, "name" | "type" | "routes" | "render" | "actions"> & {
-        getList: (params: ListParams) => Promise<ListResult<M>>;
+    constructor(options: Omit<BaseModelFeatureOptions<T, M>, "name" | "type" | "routes" | "render"> & {
+        getList: (params: ListParams<InferFilterType<FSchema>>) => Promise<ListResult<M>>;
         deleteItem?: (id: ID) => Promise<boolean>;
-        filterSchema?: z$2.ZodObject<any>;
+        filterSchema?: FSchema;
+        actions?: ActionButton[];
         openMode?: {
             create?: OpenMode;
             detail?: OpenMode;
@@ -756,9 +767,13 @@ declare function getUserInfo(ctx: Context, authProvider?: AuthProvider): Promise
  */
 
 /**
- * 解析列表查询参数
+ * 解析列表查询参数（带 filterSchema 类型推导）
+ */
+declare function parseListParams<FSchema extends z$2.ZodObject<any>>(ctx: Context, filterSchema: FSchema): ListParams<Partial<z$2.infer<FSchema>>>;
+/**
+ * 解析列表查询参数（不带 filterSchema）
  */
-declare function parseListParams(ctx: Context): ListParams;
+declare function parseListParams(ctx: Context, filterSchema?: undefined): ListParams<Record<string, any> | undefined>;
 
 /**
  * 路径工具函数
@@ -837,18 +852,34 @@ interface ErrorAlertProps {
  */
 declare function ErrorAlert(props: ErrorAlertProps): hono_jsx_jsx_dev_runtime.JSX.Element;
 
+/**
+ * 动态筛选组件的类型定义
+ */
+
+/**
+ * 动态筛选组件 Props
+ */
+interface DynamicFiltersProps {
+    /** 可用的筛选字段 */
+    fields: FormField[];
+    /** 列表路径（用于提交筛选表单） */
+    listPath: string;
+    /** 当前筛选参数 */
+    currentFilters?: Record<string, any> | undefined;
+}
+
 interface FilterFormProps {
     /** 筛选字段 */
     fields: FormField[];
     /** 列表路径（用于提交筛选表单） */
     listPath: string;
     /** 当前筛选参数 */
-    currentFilters?: Record<string, any>;
+    currentFilters?: Record<string, any> | undefined;
 }
 /**
- * 筛选表单组件
+ * 动态筛选组件
  */
-declare function FilterForm(props: FilterFormProps): hono_jsx_jsx_dev_runtime.JSX.Element | null;
+declare function DynamicFilters(props: FilterFormProps): hono_jsx_jsx_dev_runtime.JSX.Element | null;
 
 /**
  * 面包屑组件
@@ -1140,4 +1171,4 @@ interface SortableListProps {
  */
 declare function SortableList(props: SortableListProps): hono_jsx_jsx_dev_runtime.JSX.Element;
 
-export { type ActionButton, type AuthProvider, BaseFeature, BaseFormFeature, Breadcrumb, type BreadcrumbItem, type BreadcrumbProps, Button, type ButtonProps, Card, type CardProps, ColumnRenderer, CustomFeature, DefaultCreateFeature, DefaultDeleteFeature, DefaultDetailFeature, DefaultEditFeature, DefaultListFeature, DetailFieldRenderer, Dialog, type DialogProps, type DialogSize, EmptyState, type EmptyStateProps, ErrorAlert, type ErrorAlertProps, type Feature, type FeatureContext, type FeatureType, type FieldGroup, type FieldRenderer, type FieldRendererProps, FilterForm, type FormAction, type FormField, type FormGroup, FragmentFeature, Header, type HeaderProps, HtmxAdminPlugin, type HtmxAdminPluginOptions, type ListParams, type ListResult, LoadingBar, type ModelField, type NavItemConfig, type Notification, type NotificationType$1 as NotificationType, ObjectEditor, type ObjectEditorProps, type OpenMode, type PageMetadata, PageModel, Pagination, type PaginationProps, PermissionDeniedContent, type PermissionDeniedContentProps, PermissionDeniedPage, type PermissionResult, type ResolvedHtmxAdminPluginOptions, SortableList, type SortableListProps, StringArrayEditor, type StringArrayEditorProps, Table, type TableProps, TagsEditor, type TagsEditorProps, type UserInfo, checkUserPermission, getUserInfo, modelNameToPath, parseListParams };
+export { type ActionButton, type AuthProvider, BaseFeature, BaseFormFeature, Breadcrumb, type BreadcrumbItem, type BreadcrumbProps, Button, type ButtonProps, Card, type CardProps, ColumnRenderer, CustomFeature, DefaultCreateFeature, DefaultDeleteFeature, DefaultDetailFeature, DefaultEditFeature, DefaultListFeature, DetailFieldRenderer, Dialog, type DialogProps, type DialogSize, DynamicFilters, type DynamicFiltersProps, EmptyState, type EmptyStateProps, ErrorAlert, type ErrorAlertProps, type Feature, type FeatureContext, type FeatureType, type FieldGroup, type FieldRenderer, type FieldRendererProps, type FormAction, type FormField, type FormGroup, FragmentFeature, Header, type HeaderProps, HtmxAdminPlugin, type HtmxAdminPluginOptions, type ListParams, type ListResult, LoadingBar, type ModelField, type NavItemConfig, type Notification, type NotificationType$1 as NotificationType, ObjectEditor, type ObjectEditorProps, type OpenMode, type PageMetadata, PageModel, Pagination, type PaginationProps, PermissionDeniedContent, type PermissionDeniedContentProps, PermissionDeniedPage, type PermissionResult, type ResolvedHtmxAdminPluginOptions, SortableList, type SortableListProps, StringArrayEditor, type StringArrayEditorProps, Table, type TableProps, TagsEditor, type TagsEditorProps, type UserInfo, checkUserPermission, getUserInfo, modelNameToPath, parseListParams };

package/dist/index.d.ts

@@ -270,8 +270,9 @@ interface Feature {
 }
 /**
  * 列表查询参数
+ * @template F 筛选条件的类型（从 filterSchema 推导）
  */
-interface ListParams {
+interface ListParams<F = Record<string, any>> {
     /** 页码（从1开始） */
     page?: number;
     /** 每页数量 */
@@ -281,7 +282,7 @@ interface ListParams {
     /** 排序方向 */
     sortOrder?: "asc" | "desc";
     /** 筛选条件 */
-    filters?: Record<string, any>;
+    filters?: F;
 }
 /**
  * 列表查询结果
@@ -540,6 +541,9 @@ declare abstract class BaseModelFeature<T extends ZodObject, M = z$1.infer<T>> e
  * 表单操作类型
  */
 type FormAction = "create" | "edit";
+interface BaseFormFeatureOptions<T extends ZodObject = z$1.ZodObject, M = z$1.infer<T>> extends BaseModelFeatureOptions<T, M> {
+    actions?: ActionButton[];
+}
 /**
  * 表单 Feature 基类
  * 用于创建和编辑 Feature 的共同逻辑
@@ -570,6 +574,8 @@ declare abstract class BaseFormFeature<T extends ZodObject = z$1.ZodObject, M =
      * 获取取消按钮的跳转 URL
      */
     abstract getCancelUrl(context: FeatureContext): string | undefined;
+    protected options: BaseFormFeatureOptions<T, M>;
+    constructor(options: BaseFormFeatureOptions<T, M>);
     /**
      * 设置标题和描述到 context
      */
@@ -600,15 +606,15 @@ declare abstract class BaseFormFeature<T extends ZodObject = z$1.ZodObject, M =
  * 默认创建 Feature
  */
 declare class DefaultCreateFeature<T extends ZodObject = z$2.ZodObject, M = z$2.infer<T>> extends BaseFormFeature<T, M> {
-    private options;
     private createItem;
-    constructor(options: Omit<BaseModelFeatureOptions<T, M>, "name" | "type" | "routes" | "render" | "actions"> & {
+    constructor(createOptions: Omit<BaseFormFeatureOptions<T, M>, "name" | "type" | "routes" | "render"> & {
         schema: T;
         createItem: (data: Partial<M>) => Promise<M>;
         permission?: string;
         dialogSize?: DialogSize;
         closeOnBackdropClick?: boolean;
         groups?: FieldGroup[];
+        actions?: ActionButton[];
     });
     getFormAction(): "create";
     getSubmitUrl(context: FeatureContext): string;
@@ -662,10 +668,9 @@ declare class DefaultDetailFeature<T extends ZodObject = z$2.ZodObject, M = z$2.
  * 默认编辑 Feature
  */
 declare class DefaultEditFeature<T extends ZodObject = z$2.ZodObject, M = z$2.infer<T>, ID = keyof M> extends BaseFormFeature<T, M> {
-    private options;
     private getItem;
     private updateItem;
-    constructor(options: Omit<BaseModelFeatureOptions<T, M>, "name" | "type" | "routes" | "render" | "actions"> & {
+    constructor(editOptions: Omit<BaseModelFeatureOptions<T, M>, "name" | "type" | "routes" | "render" | "actions"> & {
         schema: T;
         getItem: (id: ID) => Promise<M | null | undefined>;
         updateItem: (id: ID, data: Partial<M>) => Promise<M | null>;
@@ -686,20 +691,26 @@ declare class DefaultEditFeature<T extends ZodObject = z$2.ZodObject, M = z$2.in
  * 默认列表 Feature
  */
 
+/**
+ * 从 filterSchema 推导 filters 的类型
+ * 如果 filterSchema 是 optional，则 filters 也是 optional
+ */
+type InferFilterType<FSchema extends z$2.ZodObject<any> | undefined> = FSchema extends z$2.ZodObject<infer Shape> ? Partial<z$2.infer<FSchema>> : Record<string, any> | undefined;
 /**
  * 默认列表 Feature
  */
-declare class DefaultListFeature<T extends ZodObject = z$2.ZodObject, M = z$2.infer<T>, ID = keyof M> extends BaseModelFeature<T, M> {
+declare class DefaultListFeature<T extends ZodObject = z$2.ZodObject, M = z$2.infer<T>, ID = keyof M, FSchema extends z$2.ZodObject<any> | undefined = z$2.ZodObject<any> | undefined> extends BaseModelFeature<T, M> {
     private options;
     private getList;
     private deleteItem?;
     private filterSchema?;
     private filterFields;
     private openMode?;
-    constructor(options: Omit<BaseModelFeatureOptions<T, M>, "name" | "type" | "routes" | "render" | "actions"> & {
-        getList: (params: ListParams) => Promise<ListResult<M>>;
+    constructor(options: Omit<BaseModelFeatureOptions<T, M>, "name" | "type" | "routes" | "render"> & {
+        getList: (params: ListParams<InferFilterType<FSchema>>) => Promise<ListResult<M>>;
         deleteItem?: (id: ID) => Promise<boolean>;
-        filterSchema?: z$2.ZodObject<any>;
+        filterSchema?: FSchema;
+        actions?: ActionButton[];
         openMode?: {
             create?: OpenMode;
             detail?: OpenMode;
@@ -756,9 +767,13 @@ declare function getUserInfo(ctx: Context, authProvider?: AuthProvider): Promise
  */
 
 /**
- * 解析列表查询参数
+ * 解析列表查询参数（带 filterSchema 类型推导）
+ */
+declare function parseListParams<FSchema extends z$2.ZodObject<any>>(ctx: Context, filterSchema: FSchema): ListParams<Partial<z$2.infer<FSchema>>>;
+/**
+ * 解析列表查询参数（不带 filterSchema）
  */
-declare function parseListParams(ctx: Context): ListParams;
+declare function parseListParams(ctx: Context, filterSchema?: undefined): ListParams<Record<string, any> | undefined>;
 
 /**
  * 路径工具函数
@@ -837,18 +852,34 @@ interface ErrorAlertProps {
  */
 declare function ErrorAlert(props: ErrorAlertProps): hono_jsx_jsx_dev_runtime.JSX.Element;
 
+/**
+ * 动态筛选组件的类型定义
+ */
+
+/**
+ * 动态筛选组件 Props
+ */
+interface DynamicFiltersProps {
+    /** 可用的筛选字段 */
+    fields: FormField[];
+    /** 列表路径（用于提交筛选表单） */
+    listPath: string;
+    /** 当前筛选参数 */
+    currentFilters?: Record<string, any> | undefined;
+}
+
 interface FilterFormProps {
     /** 筛选字段 */
     fields: FormField[];
     /** 列表路径（用于提交筛选表单） */
     listPath: string;
     /** 当前筛选参数 */
-    currentFilters?: Record<string, any>;
+    currentFilters?: Record<string, any> | undefined;
 }
 /**
- * 筛选表单组件
+ * 动态筛选组件
  */
-declare function FilterForm(props: FilterFormProps): hono_jsx_jsx_dev_runtime.JSX.Element | null;
+declare function DynamicFilters(props: FilterFormProps): hono_jsx_jsx_dev_runtime.JSX.Element | null;
 
 /**
  * 面包屑组件
@@ -1140,4 +1171,4 @@ interface SortableListProps {
  */
 declare function SortableList(props: SortableListProps): hono_jsx_jsx_dev_runtime.JSX.Element;
 
-export { type ActionButton, type AuthProvider, BaseFeature, BaseFormFeature, Breadcrumb, type BreadcrumbItem, type BreadcrumbProps, Button, type ButtonProps, Card, type CardProps, ColumnRenderer, CustomFeature, DefaultCreateFeature, DefaultDeleteFeature, DefaultDetailFeature, DefaultEditFeature, DefaultListFeature, DetailFieldRenderer, Dialog, type DialogProps, type DialogSize, EmptyState, type EmptyStateProps, ErrorAlert, type ErrorAlertProps, type Feature, type FeatureContext, type FeatureType, type FieldGroup, type FieldRenderer, type FieldRendererProps, FilterForm, type FormAction, type FormField, type FormGroup, FragmentFeature, Header, type HeaderProps, HtmxAdminPlugin, type HtmxAdminPluginOptions, type ListParams, type ListResult, LoadingBar, type ModelField, type NavItemConfig, type Notification, type NotificationType$1 as NotificationType, ObjectEditor, type ObjectEditorProps, type OpenMode, type PageMetadata, PageModel, Pagination, type PaginationProps, PermissionDeniedContent, type PermissionDeniedContentProps, PermissionDeniedPage, type PermissionResult, type ResolvedHtmxAdminPluginOptions, SortableList, type SortableListProps, StringArrayEditor, type StringArrayEditorProps, Table, type TableProps, TagsEditor, type TagsEditorProps, type UserInfo, checkUserPermission, getUserInfo, modelNameToPath, parseListParams };
+export { type ActionButton, type AuthProvider, BaseFeature, BaseFormFeature, Breadcrumb, type BreadcrumbItem, type BreadcrumbProps, Button, type ButtonProps, Card, type CardProps, ColumnRenderer, CustomFeature, DefaultCreateFeature, DefaultDeleteFeature, DefaultDetailFeature, DefaultEditFeature, DefaultListFeature, DetailFieldRenderer, Dialog, type DialogProps, type DialogSize, DynamicFilters, type DynamicFiltersProps, EmptyState, type EmptyStateProps, ErrorAlert, type ErrorAlertProps, type Feature, type FeatureContext, type FeatureType, type FieldGroup, type FieldRenderer, type FieldRendererProps, type FormAction, type FormField, type FormGroup, FragmentFeature, Header, type HeaderProps, HtmxAdminPlugin, type HtmxAdminPluginOptions, type ListParams, type ListResult, LoadingBar, type ModelField, type NavItemConfig, type Notification, type NotificationType$1 as NotificationType, ObjectEditor, type ObjectEditorProps, type OpenMode, type PageMetadata, PageModel, Pagination, type PaginationProps, PermissionDeniedContent, type PermissionDeniedContentProps, PermissionDeniedPage, type PermissionResult, type ResolvedHtmxAdminPluginOptions, SortableList, type SortableListProps, StringArrayEditor, type StringArrayEditorProps, Table, type TableProps, TagsEditor, type TagsEditorProps, type UserInfo, checkUserPermission, getUserInfo, modelNameToPath, parseListParams };