wlwy-package 4.0.0-beta.2 → 4.0.0-beta.21

package/dist/types/utils/form.d.ts

@@ -0,0 +1,9 @@
+import type { CreateFormRulesOptions, CreateFormRulesPrompt, FormRules } from './type';
+export declare function resolveRequiredMessage(prompt: CreateFormRulesPrompt, label?: string): string;
+/**
+ * 批量生成表单必填校验规则（ant-design-vue Form rules）
+ *
+ * - 未传 `prompt` 时不生成必填 message（有 prompt 才按 label 拼「请输入/请选择」）
+ * - `type: 'string' | 'boolean'` 忽略；其余 type / len / max / min / pattern 另生成约束规则
+ */
+export declare function createFormRules(options: CreateFormRulesOptions): FormRules;

package/dist/types/utils/formatCellValue.d.ts

@@ -0,0 +1,88 @@
+export interface FormatCellTemporalOptions {
+    /** dayjs 格式串；未传则用各 `type` 默认 */
+    format?: string;
+    /** IANA 时区，如 `Asia/Shanghai`；未传则按本地时区；有 `utc: true` 时忽略 */
+    timeZone?: string;
+    /** 按 UTC 格式化；优先级高于 timeZone */
+    utc?: boolean;
+}
+export interface FormatCellDateOnlyOptions extends FormatCellTemporalOptions {
+    type: 'date';
+}
+export interface FormatCellTimeOnlyOptions extends FormatCellTemporalOptions {
+    type: 'time';
+}
+export interface FormatCellDateTimeOptions extends FormatCellTemporalOptions {
+    type: 'datetime';
+}
+export interface FormatCellRawOptions {
+    type: 'raw';
+}
+export interface FormatCellNumberOptions {
+    type: 'number';
+    /** 小数位数：0 为整数，1 为一位小数，以此类推 */
+    precision?: number;
+    /** 是否使用千分位分组；未传则跟随 `Intl.NumberFormat` 默认（通常为 true） */
+    useGrouping?: boolean;
+}
+export interface FormatCellPercentOptions {
+    type: 'percent';
+    /** `ratio`：`0.12` → 12%；`hundred`：`12` → 12% */
+    valueScale?: 'ratio' | 'hundred';
+}
+export interface FormatCellBooleanOptions {
+    type: 'boolean';
+    trueText?: string;
+    falseText?: string;
+}
+/** 枚举项（`map` 为数组时的元素形状） */
+export interface FormatCellEnumEntry {
+    key: string | number;
+    text: string | number;
+}
+/** 枚举查表数据：`Record` 或 `{ key, text }[]` */
+export type FormatCellEnumMap = Record<string, string> | FormatCellEnumEntry[];
+/**
+ * 宿主可对 `type: 'enum'` 的选项做声明合并扩展（勿在本接口上写必填字段，否则与合并语义冲突）。
+ *
+ * `name` 的强类型约束请通过 {@link useEnum} 的 `formatCell` 使用 `keyof R`。
+ *
+ * @example
+ * ```ts
+ * declare module 'wlwy-package' {
+ *   interface FormatCellEnumOptionsExtension {
+ *     columnKey?: string
+ *   }
+ * }
+ * ```
+ */
+export interface FormatCellEnumOptionsExtension {
+}
+export interface FormatCellEnumOptions extends FormatCellEnumOptionsExtension {
+    type: 'enum';
+    /** 枚举名；仅 `useEnum().formatCell` 解析，需配合注册表。与 `map` 同时存在时忽略 */
+    name?: string;
+    /** 查表数据；未传时须由 `useEnum` 根据 `name` 注入 */
+    map?: FormatCellEnumMap;
+}
+/** 将 {@link FormatCellEnumMap} 规范为 `Record<string, string>` */
+export declare function normalizeEnumMap(map: FormatCellEnumMap): Record<string, string>;
+export interface FormatCellI18nOptions {
+    type: 'i18n';
+    /** vue-i18n 插值参数 */
+    values?: Record<string, unknown>;
+}
+export type FormatCellOptions = FormatCellRawOptions | FormatCellDateOnlyOptions | FormatCellTimeOnlyOptions | FormatCellDateTimeOptions | FormatCellNumberOptions | FormatCellPercentOptions | FormatCellBooleanOptions | FormatCellEnumOptions | FormatCellI18nOptions;
+/** 非「空单元格」场景：非法日期/数字等原样展示 */
+export declare function preserveRawCellValue(value: unknown): string;
+/**
+ * 单元格格式化核心：不包含「空值 → placeholder」逻辑，调用方需先处理占位或与 {@link formatCellValue} 配合使用。
+ */
+export declare function formatCellValueCore(value: unknown, options: FormatCellOptions): string;
+/**
+ * 表格/描述列表等场景的单元格格式化：按 `options.type` 输出字符串；
+ * 无法识别为日期/数字等时 **原样字符串化**，不使用 `Invalid Date`。
+ *
+ * @param emptyPlaceholder 空值占位符，默认 `-`；日期/时间类型额外将 `0` / `'0'` 视为空
+ */
+export declare function formatCellValue(value: unknown, options: FormatCellOptions, emptyPlaceholder?: string): string;

package/dist/types/utils/getPrefixTitle.d.ts

@@ -0,0 +1,5 @@
+import type { HandlerMode } from '../type';
+/**
+ * 拼接表单模式前缀与标题（中文无空格，英文加空格）
+ */
+export declare function getTitle(title: string, mode?: HandlerMode): string;

package/dist/types/utils/index.d.ts

@@ -0,0 +1,50 @@
+import type { PickMultipleResult, TargetsType } from './type';
+export type { PickMultipleFn, MaybePromise, DefaultValueType, CreateFormRulesOptions, CreateFormRulesField, CreateFormRulesPrompt, FormRule, FormRules, } from './type';
+export { createFormRules } from './form';
+export { resolveDefaultValue, whenDefaultValueResolved, isEmptyFormValue } from './resolveDefaultValue';
+export { createRefInstanceProxy, type CreateRefInstanceProxyOptions } from './createRefInstanceProxy';
+export { getTitle } from './getPrefixTitle';
+export { formatCellValue, formatCellValueCore, normalizeEnumMap, preserveRawCellValue, type FormatCellOptions, type FormatCellEnumMap, type FormatCellEnumEntry, type FormatCellEnumOptionsExtension, type FormatCellTemporalOptions, type FormatCellDateOnlyOptions, type FormatCellTimeOnlyOptions, type FormatCellDateTimeOptions, type FormatCellRawOptions, type FormatCellNumberOptions, type FormatCellPercentOptions, type FormatCellBooleanOptions, type FormatCellEnumOptions, type FormatCellI18nOptions, } from './formatCellValue';
+/**
+ *  列表语言翻译
+ *
+ * @template T
+ * @param {Array<T>} list
+ * @param {string} [fChild='children']
+ * @param {string} [fCode='languageCode']
+ * @return {*}  {Array<T>}
+ */
+export declare function listTranslation<T>(list: Array<T>, fChild?: string, fCode?: string): Array<T>;
+/**
+ * 新开浏览器标签页
+ *
+ * @export
+ * @param {string} url
+ */
+export declare function newWin(url: string): void;
+/**
+ * 判断是否是外链
+ *
+ * @export
+ * @param {string} url
+ * @return {*}
+ */
+export declare function isExternalLink(url: string): boolean;
+/**
+ * Object key值横杠转驼峰
+ * @param obj
+ * @returns
+ */
+export declare function kebabToCamel<T extends Record<string, any>>(obj: T): {
+    [K in keyof T as K extends `${infer Prefix}-${infer Rest}` ? `${Prefix}${Capitalize<Rest>}` : K]?: T[K];
+};
+/**
+ * 收集多个对象属性
+ *
+ * @template T
+ * @template K
+ * @param {T} obj
+ * @param {TargetsType<T, K>} targets
+ * @return {*}  {PickMultipleResult<T, K>}
+ */
+export declare function pickMultiple<T extends object, K extends string>(obj: T, targets: TargetsType<T, K>): PickMultipleResult<T, K>;

package/dist/types/utils/localStorage.d.ts

@@ -0,0 +1,52 @@
+/** 仓库信息 */
+export type WarehouseProp = {
+    warehouseId: number;
+    warehouseCode: string;
+    nameZh: string;
+    nameEn: string;
+};
+/** 按 platformCode 映射的仓库 ID 集合 */
+type WarehouseIdsProp = {
+    [key: string]: WarehouseProp['warehouseId'];
+};
+/**
+ * 读取 localStorage 中全部仓库 ID 映射
+ * @returns platformCode → warehouseId；解析失败时返回 `{}`
+ */
+export declare function getWarehouseIdObj(): WarehouseIdsProp;
+/**
+ * 根据当前仓库 ID，从仓库选择字典取仓库编码
+ * @returns 仓库编码；无当前仓库或字典无匹配项时为 `undefined`
+ */
+export declare function getWarehouseCode(): WarehouseProp['warehouseCode'] | undefined;
+/**
+ * 根据当前仓库 ID，从仓库选择字典取仓库名称
+ * @returns 仓库名称；无当前仓库或字典无匹配项时为 `undefined`
+ */
+export declare function getWarehouseName(): string | undefined;
+/**
+ * 获取当前 platformCode 对应的仓库 ID
+ * @returns 仓库 ID；无 platformCode 或未配置时为 `undefined`
+ */
+export declare function getWarehouseId(): WarehouseProp['warehouseId'] | undefined;
+/**
+ * 写入当前 platformCode 对应的仓库 ID
+ * @param id 仓库 ID
+ * @remarks 无 platformCode 时提示错误并刷新页面
+ */
+export declare function setWarehouseId(id: WarehouseProp['warehouseId']): void;
+/** 清除 localStorage 中全部仓库 ID 映射 */
+export declare function removeWarehouseId(): void;
+/**
+ * 写入平台编码
+ * @param code 平台编码
+ */
+export declare function setPlatformCode(code: string): void;
+/**
+ * 读取平台编码
+ * @returns 平台编码；未设置时为 `null`
+ */
+export declare function getPlatformCode(): string | null;
+/** 清除平台编码 */
+export declare function removePlatformCode(): void;
+export {};

package/dist/types/utils/resolveDefaultValue.d.ts

@@ -0,0 +1,12 @@
+import type { DefaultValueType, MaybePromise } from './type';
+/**
+ * 解析 defaultValue：支持静态值、Promise、同步/异步函数。
+ * 同步值原样返回（不进入微任务）；仅 Promise 结果保持异步。
+ */
+export declare function resolveDefaultValue<T>(value: DefaultValueType<T> | undefined): MaybePromise<T | undefined>;
+/**
+ * 将解析结果交给 apply：同步立即执行，异步完成后执行。
+ */
+export declare function whenDefaultValueResolved<T>(value: DefaultValueType<T> | undefined, apply: (resolved: T) => void): void | Promise<void>;
+/** 表单字段是否视为空（用于判断是否写入 defaultValue） */
+export declare function isEmptyFormValue(val: unknown): boolean;

package/dist/types/utils/type.d.ts

@@ -0,0 +1,32 @@
+import type { Rule } from 'ant-design-vue/es/form';
+export type TargetsType<T extends object, K extends string> = Record<K, (keyof T)[]>;
+export type ResultKeysType<K extends string> = K | 'default';
+export type PickMultipleResult<T extends object, K extends string> = {
+    [key in ResultKeysType<K>]: Partial<T>;
+};
+export type PickMultipleFn = <T extends object, K extends string>(obj: T, targets: TargetsType<T, K>) => PickMultipleResult<T, K>;
+/** T 或 Promise<T> */
+export type MaybePromise<T> = T | Promise<T>;
+/**
+ * 表单字段默认值：静态值 | Promise | 同步/异步工厂函数
+ * 解析后的结果类型为 T
+ */
+export type DefaultValueType<T> = MaybePromise<T> | (() => MaybePromise<T>);
+/** 默认校验文案：enter=请输入，select=请选择 */
+export type CreateFormRulesPrompt = 'enter' | 'select';
+export type CreateFormRulesField = {
+    name: string;
+    /** `string` / `boolean` 不生成 type 约束；其余 type 与 len/max/min/pattern 另生成约束规则 */
+    type?: 'string' | 'number' | 'boolean' | 'array' | 'url' | 'email' | 'date' | 'hex';
+    /** 必填文案类型；未传则不生成 message */
+    prompt?: CreateFormRulesPrompt;
+    label?: string;
+    len?: number;
+    max?: number;
+    min?: number;
+    pattern?: RegExp;
+    trigger?: 'blur' | 'change';
+};
+export type CreateFormRulesOptions = Array<string | CreateFormRulesField>;
+export type FormRule = Rule;
+export type FormRules = Record<string, Rule[]>;