@h-ai/kit 1.0.0-beta.18 → 1.0.0-beta.19

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

@@ -1,506 +0,0 @@
-import { l as KitServerConfig, n as KitTransportConfig, j as KitConfigInput, K as KitConfig, o as KitTransportConfigInput } from './kit-types-CnfBC89D.js';
-import { z } from 'zod';
-
-/**
- * @h-ai/kit — CRUD 类型定义
- *
- * 声明式 CRUD 资源定义所需的全部类型。
- * @module kit-crud-types
- */
-/**
- * 支持的字段类型
- * @example
- * ```ts
- * import type { CrudFieldType } from '@h-ai/kit'
- *
- * const value: CrudFieldType = 'date-range'
- * void value
- * ```
- */
-type CrudFieldType = 'string' | 'number' | 'boolean' | 'date' | 'date-range' | 'datetime' | 'email' | 'url' | 'tel' | 'password' | 'textarea' | 'select' | 'multi-select' | 'radio' | 'checkbox' | 'custom';
-/**
- * 字段校验规则
- * @example
- * ```ts
- * import type { CrudFieldValidation } from '@h-ai/kit'
- *
- * const value: CrudFieldValidation = { required: true, max: 120 }
- * void value
- * ```
- */
-interface CrudFieldValidation {
-    /** 是否必填 */
-    required?: boolean;
-    /** 最小值（number）或 最小长度（string） */
-    min?: number;
-    /** 最大值（number）或 最大长度（string） */
-    max?: number;
-    /** 正则表达式 */
-    pattern?: string;
-    /** 自定义错误提示 */
-    message?: CrudText;
-}
-/**
- * 选项项（用于 select/radio 等）
- * @example
- * ```ts
- * import type { CrudFieldOption } from '@h-ai/kit'
- *
- * const value: CrudFieldOption = { label: 'Published', value: 'published' }
- * void value
- * ```
- */
-interface CrudFieldOption {
-    label: string;
-    value: string | number | boolean;
-}
-/**
- * 选项来源：静态数组或动态工厂函数
- * @example
- * ```ts
- * import type { CrudFieldOptions } from '@h-ai/kit'
- *
- * const value: CrudFieldOptions = [{ label: 'Published', value: 'published' }]
- * void value
- * ```
- */
-type CrudFieldOptions = CrudFieldOption[] | (() => CrudFieldOption[]);
-/**
- * 可解析为字符串的文本值（支持 i18n）
- * @example
- * ```ts
- * import type { CrudText } from '@h-ai/kit'
- *
- * const value: CrudText = () => 'Articles'
- * void value
- * ```
- */
-type CrudText = string | (() => string);
-/**
- * 字段定义
- * @example
- * ```ts
- * import type { CrudFieldDef } from '@h-ai/kit'
- *
- * const value: CrudFieldDef = { id: 'title', label: 'Title', type: 'string', validation: { required: true } }
- * void value
- * ```
- */
-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;
-    /** 双列表单中的占用列数；auto 按控件类型判断，默认 auto。 */
-    colSpan?: 'auto' | 1 | 2;
-    /** 列宽（列表模式） */
-    width?: string;
-    /** 列对齐方式 */
-    align?: 'left' | 'center' | 'right';
-    /** 自定义列表渲染 */
-    render?: (value: unknown, item: Record<string, unknown>) => string;
-    /** 占位符 */
-    placeholder?: CrudText;
-    /** 日期范围起始值的查询参数名；仅 date-range 字段使用，默认 `${id}Start` */
-    startKey?: string;
-    /** 日期范围结束值的查询参数名；仅 date-range 字段使用，默认 `${id}End` */
-    endKey?: string;
-    /** 默认值（新建时） */
-    defaultValue?: unknown;
-    /** 排列权重（数值越小越靠前） */
-    order?: number;
-}
-/**
- * 分页参数
- * @example
- * ```ts
- * import type { CrudPaginationParams } from '@h-ai/kit'
- *
- * const value: CrudPaginationParams = { page: 1, pageSize: 20 }
- * void value
- * ```
- */
-interface CrudPaginationParams {
-    page: number;
-    pageSize: number;
-}
-/**
- * 过滤参数（搜索 + 自定义过滤字段）
- * @example
- * ```ts
- * import type { CrudFilterParams } from '@h-ai/kit'
- *
- * const value: CrudFilterParams = { search: 'example', status: 'published' }
- * void value
- * ```
- */
-interface CrudFilterParams {
-    search?: string;
-    [key: string]: unknown;
-}
-/**
- * 分页结果
- * @example
- * ```ts
- * import type { CrudPaginatedResult } from '@h-ai/kit'
- *
- * const value: CrudPaginatedResult<{ id: string }> = { items: [], total: 0, page: 1, pageSize: 20 }
- * void value
- * ```
- */
-interface CrudPaginatedResult<T> {
-    items: T[];
-    total: number;
-    page: number;
-    pageSize: number;
-}
-/**
- * CRUD API 接口定义
- * @example
- * ```ts
- * import type { CrudApiDef } from '@h-ai/kit'
- *
- * // 应用适配层把持久化查询结果转为此结构，失败应拒绝 Promise。
- * function listAdapter(list: CrudApiDef<{ id: string }>['list']): CrudApiDef<{ id: string }> { return { list } }
- * ```
- */
-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 资源定义
- * @example
- * ```ts
- * import type { CrudApiDef, CrudResourceDef } from '@h-ai/kit'
- *
- * function articles(api: CrudApiDef<{ id: string, title: string }>): CrudResourceDef<{ id: string, title: string }> {
- *   return { name: 'article', label: 'Articles', fields: [{ id: 'title', label: 'Title', type: 'string' }], api }
- * }
- * ```
- */
-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）
- * @example
- * ```ts
- * import type { CrudTableColumn } from '@h-ai/kit'
- *
- * const value: CrudTableColumn = { key: 'title', label: 'Title' }
- * void value
- * ```
- */
-interface CrudTableColumn {
-    key: string;
-    label: string;
-    width?: string;
-    align?: 'left' | 'center' | 'right';
-    render?: (item: Record<string, unknown>) => string;
-}
-/**
- * CRUD 操作对象（由 defineCrud 返回）
- * @example
- * ```ts
- * import type { CrudOperations } from '@h-ai/kit'
- *
- * function columns(resource: CrudOperations<{ id: string }>) { return resource.toTableColumns() }
- * ```
- */
-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
- * import { kit } from '@h-ai/kit'
- *
- * import type { CrudApiDef } from '@h-ai/kit'
- *
- * function articleResource(api: CrudApiDef<{ id: string, title: string }>) {
- *   return kit.crud.define({ name: 'article', label: 'Articles', fields: [{ id: 'title', label: 'Title', type: 'string' }], api })
- * }
- * ```
- */
-declare function defineCrud<T = Record<string, unknown>>(resource: CrudResourceDef<T>): CrudOperations<T>;
-
-/**
- * @h-ai/kit — 宿主配置
- *
- * 为 `config/_kit.yml` 提供监听、传输与请求策略的默认值和校验。
- * 服务端消费完整配置；浏览器仅接收显式投影的 transport 公共字段。
- * @module kit-config
- */
-
-/**
- * `config/_kit.yml` 对应的配置 Schema。
- * @example
- * ```ts
- * import { KitConfigSchema } from '@h-ai/kit'
- *
- * const config = KitConfigSchema.parse({ server: { port: 3000 }, transport: false })
- * void config
- * ```
- */
-declare const KitConfigSchema: z.ZodPipe<z.ZodObject<{
-    server: z.ZodOptional<z.ZodObject<{
-        host: z.ZodDefault<z.ZodString>;
-        port: z.ZodDefault<z.ZodNumber>;
-    }, z.core.$strip>>;
-    transport: z.ZodOptional<z.ZodUnion<readonly [z.ZodLiteral<false>, z.ZodObject<{
-        maxPlaintextBytes: z.ZodOptional<z.ZodPipe<z.ZodUnion<readonly [z.ZodNumber, z.ZodLiteral<"auto">]>, z.ZodTransform<number | undefined, number | "auto">>>;
-        maxFutureSkewSeconds: z.ZodOptional<z.ZodNumber>;
-        maxRequestAgeSeconds: z.ZodOptional<z.ZodNumber>;
-        routePlaintextBytes: z.ZodOptional<z.ZodRecord<z.ZodCustom<`/${string}`, `/${string}`>, z.ZodNumber>>;
-        keyExchangePath: z.ZodDefault<z.ZodCustom<`/${string}`, `/${string}`>>;
-        excludePaths: z.ZodDefault<z.ZodArray<z.ZodCustom<`/${string}`, `/${string}`>>>;
-    }, z.core.$strip>]>>;
-    trustedProxies: z.ZodDefault<z.ZodUnion<readonly [z.ZodLiteral<"auto">, z.ZodArray<z.ZodUnion<readonly [z.ZodIPv4, z.ZodIPv6, z.ZodCIDRv4, z.ZodCIDRv6]>>]>>;
-    access: z.ZodDefault<z.ZodUnion<readonly [z.ZodLiteral<false>, z.ZodObject<{
-        file: z.ZodString;
-    }, z.core.$strict>, z.ZodObject<{
-        global: z.ZodOptional<z.ZodObject<{
-            allowIps: z.ZodDefault<z.ZodArray<z.ZodUnion<readonly [z.ZodIPv4, z.ZodIPv6, z.ZodCIDRv4, z.ZodCIDRv6]>>>;
-            denyIps: z.ZodDefault<z.ZodArray<z.ZodUnion<readonly [z.ZodIPv4, z.ZodIPv6, z.ZodCIDRv4, z.ZodCIDRv6]>>>;
-            timezone: z.ZodDefault<z.ZodString>;
-            windows: z.ZodDefault<z.ZodArray<z.ZodObject<{
-                days: z.ZodArray<z.ZodNumber>;
-                start: z.ZodString;
-                end: z.ZodString;
-            }, z.core.$strict>>>;
-        }, z.core.$strict>>;
-        rules: z.ZodDefault<z.ZodArray<z.ZodObject<{
-            allowIps: z.ZodDefault<z.ZodArray<z.ZodUnion<readonly [z.ZodIPv4, z.ZodIPv6, z.ZodCIDRv4, z.ZodCIDRv6]>>>;
-            denyIps: z.ZodDefault<z.ZodArray<z.ZodUnion<readonly [z.ZodIPv4, z.ZodIPv6, z.ZodCIDRv4, z.ZodCIDRv6]>>>;
-            timezone: z.ZodDefault<z.ZodString>;
-            windows: z.ZodDefault<z.ZodArray<z.ZodObject<{
-                days: z.ZodArray<z.ZodNumber>;
-                start: z.ZodString;
-                end: z.ZodString;
-            }, z.core.$strict>>>;
-            id: z.ZodString;
-            paths: z.ZodArray<z.ZodString>;
-            methods: z.ZodDefault<z.ZodArray<z.ZodEnum<{
-                GET: "GET";
-                HEAD: "HEAD";
-                POST: "POST";
-                PUT: "PUT";
-                PATCH: "PATCH";
-                DELETE: "DELETE";
-                OPTIONS: "OPTIONS";
-                CONNECT: "CONNECT";
-                TRACE: "TRACE";
-            }>>>;
-            encryption: z.ZodOptional<z.ZodEnum<{
-                required: "required";
-                disabled: "disabled";
-            }>>;
-        }, z.core.$strict>>>;
-    }, z.core.$strict>]>>;
-}, z.core.$strip>, z.ZodTransform<{
-    server: KitServerConfig;
-    transport: false | KitTransportConfig;
-    trustedProxies: string[] | "auto";
-    access: false | {
-        file: string;
-    } | {
-        rules: {
-            allowIps: string[];
-            denyIps: string[];
-            timezone: string;
-            windows: {
-                days: number[];
-                start: string;
-                end: string;
-            }[];
-            id: string;
-            paths: string[];
-            methods: ("GET" | "HEAD" | "POST" | "PUT" | "PATCH" | "DELETE" | "OPTIONS" | "CONNECT" | "TRACE")[];
-            encryption?: "required" | "disabled" | undefined;
-        }[];
-        global?: {
-            allowIps: string[];
-            denyIps: string[];
-            timezone: string;
-            windows: {
-                days: number[];
-                start: string;
-                end: string;
-            }[];
-        } | undefined;
-    };
-}, {
-    trustedProxies: string[] | "auto";
-    access: false | {
-        file: string;
-    } | {
-        rules: {
-            allowIps: string[];
-            denyIps: string[];
-            timezone: string;
-            windows: {
-                days: number[];
-                start: string;
-                end: string;
-            }[];
-            id: string;
-            paths: string[];
-            methods: ("GET" | "HEAD" | "POST" | "PUT" | "PATCH" | "DELETE" | "OPTIONS" | "CONNECT" | "TRACE")[];
-            encryption?: "required" | "disabled" | undefined;
-        }[];
-        global?: {
-            allowIps: string[];
-            denyIps: string[];
-            timezone: string;
-            windows: {
-                days: number[];
-                start: string;
-                end: string;
-            }[];
-        } | undefined;
-    };
-    server?: {
-        host: string;
-        port: number;
-    } | undefined;
-    transport?: false | {
-        keyExchangePath: `/${string}`;
-        excludePaths: `/${string}`[];
-        maxPlaintextBytes?: number | undefined;
-        maxFutureSkewSeconds?: number | undefined;
-        maxRequestAgeSeconds?: number | undefined;
-        routePlaintextBytes?: Record<`/${string}`, number> | undefined;
-    } | undefined;
-}>>;
-/**
- * 解析 transport 配置并补齐默认值。
- *
- * @param input - `config/_kit.yml` 中的 transport 配置
- * @returns 完整 transport 配置；`false` 表示关闭
- * @example
- * ```ts
- * import { resolveKitTransportConfig } from '@h-ai/kit'
- *
- * const transport = resolveKitTransportConfig({ excludePaths: ['/api/health'] })
- * if (transport) void transport.keyExchangePath
- * ```
- */
-declare function resolveKitTransportConfig(input?: false | KitTransportConfigInput): false | KitTransportConfig;
-/**
- * 解析 `config/_kit.yml` 顶层配置并补齐默认值。
- *
- * 适合同一份配置同时供 SvelteKit 服务端 hook 与浏览器端 client 读取。
- * @param input - Kit 监听和公开 transport 输入；省略字段按 Schema 补默认值。
- * @returns 已补齐默认值的配置；不合法输入抛出 ZodError。
- * @example
- * ```ts
- * import { resolveKitConfig } from '@h-ai/kit'
- *
- * const config = resolveKitConfig({ transport: false })
- * void config.server.port
- * ```
- */
-declare function resolveKitConfig(input?: KitConfigInput): KitConfig;
-
-/**
- * 设置浏览器应用语言或 Node 启动默认语言；请求中只更新当前 runWithLocale 上下文。
- *
- * 通过 @h-ai/core 的集中式 locale 管理器，一次调用即可同步所有模块。
- * 各模块的 createMessageGetter 优先读取当前 Node 请求上下文；SSR 必须包裹实际 resolve。
- * @param locale - 支持的应用默认语言；请求中应使用上下文隔离。
- * @example
- * ```ts
- * import { kit } from '@h-ai/kit'
- *
- * // 应用启动时设置默认语言；请求内使用 runWithLocale。
- * kit.i18n.setLocale('en-US')
- * ```
- */
-declare function setAllModulesLocale(locale: string): void;
-
-export { type CrudApiDef as C, KitConfigSchema as K, resolveKitTransportConfig as a, type CrudFieldDef as b, type CrudFieldOption as c, defineCrud as d, type CrudFieldOptions as e, type CrudFieldType as f, type CrudFieldValidation as g, type CrudFilterParams as h, type CrudOperations as i, type CrudPaginatedResult as j, type CrudPaginationParams as k, type CrudResourceDef as l, type CrudTableColumn as m, type CrudText as n, resolveOptions as o, resolveText as p, resolveKitConfig as r, setAllModulesLocale as s };