@h-ai/kit 0.1.0-alpha5

package/dist/kit-i18n-CgpNTh9G.d.ts

@@ -0,0 +1,206 @@
+/**
+ * @h-ai/kit — CRUD 类型定义
+ *
+ * 声明式 CRUD 资源定义所需的全部类型。
+ * @module kit-crud-types
+ */
+/** 支持的字段类型 */
+type CrudFieldType = 'string' | 'number' | 'boolean' | 'date' | 'datetime' | 'email' | 'url' | 'tel' | 'password' | 'textarea' | 'select' | 'multi-select' | 'radio' | 'checkbox' | 'custom';
+/** 字段校验规则 */
+interface CrudFieldValidation {
+    /** 是否必填 */
+    required?: boolean;
+    /** 最小值（number）或 最小长度（string） */
+    min?: number;
+    /** 最大值（number）或 最大长度（string） */
+    max?: number;
+    /** 正则表达式 */
+    pattern?: string;
+    /** 自定义错误提示 */
+    message?: string;
+}
+/** 选项项（用于 select/radio 等） */
+interface CrudFieldOption {
+    label: string;
+    value: string | number | boolean;
+}
+/** 选项来源：静态数组或动态工厂函数 */
+type CrudFieldOptions = CrudFieldOption[] | (() => CrudFieldOption[]);
+/** 可解析为字符串的文本值（支持 i18n） */
+type CrudText = string | (() => string);
+/** 字段定义 */
+interface CrudFieldDef {
+    /** 字段 ID（对应数据对象的 key） */
+    id: string;
+    /** 显示名称（支持 i18n 函数） */
+    label: CrudText;
+    /** 字段类型 */
+    type: CrudFieldType;
+    /** 是否在列表中显示（默认 true） */
+    inList?: boolean;
+    /** 是否是过滤项（默认 false） */
+    filterable?: boolean;
+    /** 是否只读（编辑时不可修改，默认 false） */
+    readonly?: boolean;
+    /** 是否在新建表单中显示（默认 true） */
+    inCreate?: boolean;
+    /** 是否在编辑表单中显示（默认 true） */
+    inEdit?: boolean;
+    /** 是否在详情中显示（默认 true） */
+    inDetail?: boolean;
+    /** 选项列表（select/radio/checkbox/multi-select） */
+    options?: CrudFieldOptions;
+    /** 校验规则 */
+    validation?: CrudFieldValidation;
+    /** 列宽（列表模式） */
+    width?: string;
+    /** 列对齐方式 */
+    align?: 'left' | 'center' | 'right';
+    /** 自定义列表渲染 */
+    render?: (value: unknown, item: Record<string, unknown>) => string;
+    /** 占位符 */
+    placeholder?: CrudText;
+    /** 默认值（新建时） */
+    defaultValue?: unknown;
+    /** 排列权重（数值越小越靠前） */
+    order?: number;
+}
+/** 分页参数 */
+interface CrudPaginationParams {
+    page: number;
+    pageSize: number;
+}
+/** 过滤参数（搜索 + 自定义过滤字段） */
+interface CrudFilterParams {
+    search?: string;
+    [key: string]: unknown;
+}
+/** 分页结果 */
+interface CrudPaginatedResult<T> {
+    items: T[];
+    total: number;
+    page: number;
+    pageSize: number;
+}
+/** CRUD API 接口定义 */
+interface CrudApiDef<T = Record<string, unknown>> {
+    /** 获取分页列表 */
+    list: (params: CrudPaginationParams & CrudFilterParams) => Promise<CrudPaginatedResult<T>>;
+    /** 获取单条记录 */
+    get?: (id: string) => Promise<T | null>;
+    /** 新建记录 */
+    create?: (data: Partial<T>) => Promise<T>;
+    /** 更新记录（patch） */
+    update?: (id: string, data: Partial<T>) => Promise<T>;
+    /** 删除记录 */
+    remove?: (id: string) => Promise<void>;
+}
+/** CRUD 资源定义 */
+interface CrudResourceDef<T = Record<string, unknown>> {
+    /** 资源名称（如 'user', 'role'），用于 URL 路由 */
+    name: string;
+    /** 显示名称（面包屑、标题用，支持 i18n） */
+    label: CrudText;
+    /** 主键字段名（默认 'id'） */
+    keyField?: string;
+    /** 字段列表 */
+    fields: CrudFieldDef[];
+    /** API 接口 */
+    api: CrudApiDef<T>;
+    /** 默认分页大小（默认 20） */
+    defaultPageSize?: number;
+    /** 是否支持搜索（默认 true） */
+    searchable?: boolean;
+    /** 搜索占位符 */
+    searchPlaceholder?: CrudText;
+}
+/** DataTable 列配置（适配 @h-ai/ui DataTable） */
+interface CrudTableColumn {
+    key: string;
+    label: string;
+    width?: string;
+    align?: 'left' | 'center' | 'right';
+    render?: (item: Record<string, unknown>) => string;
+}
+/** CRUD 操作对象（由 defineCrud 返回） */
+interface CrudOperations<T = Record<string, unknown>> {
+    /** 资源元信息 */
+    resource: CrudResourceDef<T>;
+    /** 获取列表列字段（inList=true） */
+    getListFields: () => CrudFieldDef[];
+    /** 获取过滤字段（filterable=true） */
+    getFilterFields: () => CrudFieldDef[];
+    /** 获取新建表单字段（inCreate=true） */
+    getCreateFields: () => CrudFieldDef[];
+    /** 获取编辑表单字段（inEdit=true） */
+    getEditFields: () => CrudFieldDef[];
+    /** 获取详情字段（inDetail=true） */
+    getDetailFields: () => CrudFieldDef[];
+    /** 构建 DataTable 列配置 */
+    toTableColumns: () => CrudTableColumn[];
+    /** 构建新建时的默认值 */
+    getDefaultValues: () => Record<string, unknown>;
+    /** API 操作代理 */
+    api: CrudApiDef<T>;
+}
+
+/**
+ * @h-ai/kit — CRUD 操作定义
+ *
+ * 声明式 CRUD 资源定义工厂函数。
+ * @module kit-crud
+ */
+
+/**
+ * 解析 CrudText 为字符串
+ */
+declare function resolveText(text: CrudText): string;
+/**
+ * 解析选项列表
+ */
+declare function resolveOptions(options: CrudFieldOptions | undefined): Array<{
+    label: string;
+    value: string | number | boolean;
+}>;
+/**
+ * 定义 CRUD 资源
+ *
+ * 返回 CrudOperations 对象，包含字段过滤、列构建和 API 代理等能力。
+ * 与 @h-ai/ui 的 CrudPage 组件配合使用。
+ *
+ * @param resource - 资源定义
+ * @returns CRUD 操作对象
+ *
+ * @example
+ * ```ts
+ * const userCrud = defineCrud({
+ *   name: 'user',
+ *   label: () => m.users_title(),
+ *   fields: [
+ *     { id: 'username', label: '用户名', type: 'string', validation: { required: true } },
+ *     { id: 'email', label: '邮箱', type: 'email' },
+ *   ],
+ *   api: { list, get, create, update, remove },
+ * })
+ * ```
+ */
+declare function defineCrud<T = Record<string, unknown>>(resource: CrudResourceDef<T>): CrudOperations<T>;
+
+/**
+ * 统一设置所有 hai 模块的默认语言
+ *
+ * 通过 @h-ai/core 的集中式 locale 管理器，一次调用即可同步所有模块。
+ * 各模块的 createMessageGetter 会读取全局 locale。
+ *
+ * @example
+ * ```ts
+ * import { kit } from '@h-ai/kit'
+ *
+ * // 在 i18n handle 中
+ * const locale = event.cookies.get('PARAGLIDE_LOCALE') ?? 'zh-CN'
+ * kit.i18n.setLocale(locale)
+ * ```
+ */
+declare function setAllModulesLocale(locale: string): void;
+
+export { type CrudApiDef as C, type CrudFieldDef as a, type CrudFieldOption as b, type CrudFieldOptions as c, defineCrud as d, type CrudFieldType as e, type CrudFieldValidation as f, type CrudFilterParams as g, type CrudOperations as h, type CrudPaginatedResult as i, type CrudPaginationParams as j, type CrudResourceDef as k, type CrudTableColumn as l, type CrudText as m, resolveText as n, resolveOptions as r, setAllModulesLocale as s };