befly-shared 1.3.2 → 1.3.4

package/package.json

@@ -1,23 +1,28 @@
 {
     "name": "befly-shared",
-    "version": "1.3.2",
+    "version": "1.3.4",
     "private": false,
     "description": "Befly 纯函数与纯常量共享包（不包含 Node/浏览器特定实现）",
     "license": "Apache-2.0",
     "author": "chensuiyi <bimostyle@qq.com>",
     "files": [
         "package.json",
+        "types/",
         "utils/"
     ],
     "type": "module",
     "exports": {
-        "./utils/*": "./utils/*.ts"
+        "./utils/*": "./utils/*.ts",
+        "./types/*": "./types/*.ts"
     },
     "scripts": {
         "test": "bun test"
     },
+    "dependencies": {
+        "es-toolkit": "^1.43.0"
+    },
     "engines": {
         "bun": ">=1.3.0"
     },
-    "gitHead": "7dd54bc1ed484139fa52ce5408f1a6c166e2a928"
+    "gitHead": "564115664323c9d73351945129aa7d57d440eb58"
 }

package/types/arrayToTree.ts

@@ -0,0 +1,11 @@
+/**
+ * arrayToTree 类型定义（类型模块，仅供 type 引用）。
+ */
+
+export type ArrayToTreeResult<T extends Record<string, any>> = {
+    flat: Array<T>;
+    tree: Array<T>;
+    map: Map<string, T>;
+};
+
+export type ArrayToTree = <T extends Record<string, any>>(items: T[], id?: string, pid?: string, children?: string, sort?: string) => ArrayToTreeResult<T>;

package/types/deepTransformKeys.ts

@@ -0,0 +1,16 @@
+/**
+ * deepTransformKeys 类型定义（类型模块，仅供 type 引用）。
+ *
+ * 注意：types 模块不包含运行时实现；运行时请从 befly-shared/utils/* 引入。
+ */
+
+export type KeyTransformer = (key: string) => string;
+
+export type PresetTransform = "camel" | "snake" | "kebab" | "pascal" | "upper" | "lower";
+
+export interface TransformOptions {
+    maxDepth?: number;
+    excludeKeys?: string[];
+}
+
+export type DeepTransformKeys = <T = any>(data: any, transformer: KeyTransformer | PresetTransform, options?: TransformOptions) => T;

package/types/genShortId.ts

@@ -0,0 +1,5 @@
+/**
+ * genShortId 类型定义（类型模块，仅供 type 引用）。
+ */
+
+export type GenShortId = () => string;

package/types/hashPassword.ts

@@ -0,0 +1,5 @@
+/**
+ * hashPassword 类型定义（类型模块，仅供 type 引用）。
+ */
+
+export type HashPassword = (password: string, salt?: string) => Promise<string>;

package/types/normalizePathnameListInput.ts

@@ -0,0 +1,5 @@
+/**
+ * normalizePathnameListInput 类型定义（类型模块，仅供 type 引用）。
+ */
+
+export type NormalizePathnameListInput = (value: unknown, fieldLabel: string, forbidMethodPrefix: boolean) => string[];

package/types/scanViewsDir.ts

@@ -0,0 +1,25 @@
+/**
+ * scanViewsDir 相关纯函数的类型定义（类型模块，仅供 type 引用）。
+ */
+
+export type ViewDirMeta = {
+    title: string;
+    order?: number;
+};
+
+export type MenuNodeLike<T> = {
+    name?: string;
+    path?: string;
+    sort?: number;
+    children?: T[];
+};
+
+export type CleanDirName = (name: string) => string;
+
+export type NormalizeMenuPath = (path: string) => string;
+
+export type NormalizeMenuTree = <T extends MenuNodeLike<T>>(menus: T[]) => T[];
+
+export type ExtractScriptSetupBlock = (vueContent: string) => string | null;
+
+export type ExtractDefinePageMetaFromScriptSetup = (scriptSetup: string) => ViewDirMeta | null;

package/types/withDefaultColumns.ts

@@ -0,0 +1,5 @@
+/**
+ * withDefaultColumns 类型定义（类型模块，仅供 type 引用）。
+ */
+
+export type WithDefaultColumns = (columns: any[], customConfig?: Record<string, any>) => any[];

package/utils/hashPassword.ts

@@ -0,0 +1,27 @@
+/**
+ * 密码哈希工具
+ * 使用 SHA-256 + 盐值对密码进行单向哈希
+ */
+
+/**
+ * 使用 SHA-256 对密码进行哈希
+ * @param password - 原始密码
+ * @param salt - 盐值，默认为 befly
+ * @returns 哈希后的密码（十六进制字符串）
+ */
+export async function hashPassword(password: string, salt: string = "befly"): Promise<string> {
+    const data = password + salt;
+
+    // 将字符串转换为 Uint8Array
+    const encoder = new TextEncoder();
+    const dataBuffer = encoder.encode(data);
+
+    // 使用 Web Crypto API 进行 SHA-256 哈希
+    const hashBuffer = await crypto.subtle.digest("SHA-256", dataBuffer);
+
+    // 将 ArrayBuffer 转换为十六进制字符串
+    const hashArray = Array.from(new Uint8Array(hashBuffer));
+    const hashHex = hashArray.map((b) => b.toString(16).padStart(2, "0")).join("");
+
+    return hashHex;
+}

package/utils/normalizePathnameListInput.ts

@@ -0,0 +1,58 @@
+const HTTP_METHOD_PREFIX_RE = /^(GET|POST|PUT|PATCH|DELETE|OPTIONS|HEAD)\b/i;
+
+/**
+ * 将未知输入规范化为 pathname 字符串数组。
+ *
+ * 规则（契约）：
+ * - value 为“假值”（null/undefined/""/0/false/NaN）时返回空数组 []。
+ * - value 必须是 string[]，否则抛错：`${fieldLabel} 必须是字符串数组`。
+ * - 数组元素必须满足：
+ *   - 类型为 string
+ *   - 不允许为空字符串
+ *   - 不允许包含任何空白字符（空格/制表符/换行等）
+ *   - 必须以 "/" 开头（pathname）
+ * - forbidMethodPrefix=true 时，禁止 "GET/POST/..." 等 method 前缀，并给出更明确的错误提示。
+ *
+ * 注意：该函数不会做任何隐式修复/转换（例如 trim/split/JSON.parse/去重/排序）。
+ */
+export function normalizePathnameListInput(value: unknown, fieldLabel: string, forbidMethodPrefix: boolean): string[] {
+    // “假值”统一视为空数组：null/undefined/""/0/false/NaN
+    if (!value) return [];
+
+    if (!Array.isArray(value)) {
+        throw new Error(`${fieldLabel} 必须是字符串数组`);
+    }
+
+    const out: string[] = [];
+
+    for (let i = 0; i < value.length; i += 1) {
+        const item = value[i];
+        const itemLabel = `${fieldLabel}[${i}]`;
+
+        if (typeof item !== "string") {
+            throw new Error(`${itemLabel} 必须是字符串`);
+        }
+
+        if (item.length === 0) {
+            throw new Error(`${itemLabel} 不允许为空字符串`);
+        }
+
+        // 优先给出 method 前缀提示（更明确）
+        if (forbidMethodPrefix && HTTP_METHOD_PREFIX_RE.test(item)) {
+            throw new Error(`${itemLabel} 不允许包含 method 前缀，应为 url.pathname（例如 /api/app/xxx）`);
+        }
+
+        // 不做 trim 自动转换：含任何空白字符都视为不合法
+        if (/\s/.test(item)) {
+            throw new Error(`${itemLabel} 不允许包含空白字符（空格/制表符/换行等）`);
+        }
+
+        if (!item.startsWith("/")) {
+            throw new Error(`${itemLabel} 必须是 pathname（以 / 开头）`);
+        }
+
+        out.push(item);
+    }
+
+    return out;
+}

package/utils/withDefaultColumns.ts

@@ -0,0 +1,48 @@
+/**
+ * 为表格列添加默认配置（纯函数）。
+ *
+ * 设计目标：
+ * - 不依赖浏览器/Node 特定 API
+ * - 不修改入参 columns 的对象引用（会返回新数组，并对每个列对象做浅拷贝合并）
+ *
+ * 默认行为：
+ * - base 默认：{ width: 200, ellipsis: true }
+ * - 特殊列：operation/state/id
+ * - colKey 以 At/At2 结尾时：默认 { align: "center" }
+ * - customConfig 可覆盖/扩展默认 specialColumnConfig（浅合并/替换：若传入 operation 配置，将整体替换默认 operation 配置，默认 fixed="right" 不会被保留）
+ */
+export function withDefaultColumns(columns: any[], customConfig?: Record<string, any>): any[] {
+    const safeColumns = Array.isArray(columns) ? columns : [];
+
+    const specialColumnConfig: Record<string, any> = Object.assign(
+        {
+            operation: { width: 100, align: "center", fixed: "right" },
+            state: { width: 100, align: "center" },
+            id: { width: 200, align: "center" }
+        },
+        customConfig || {}
+    );
+
+    return safeColumns.map((col) => {
+        const colKey = col && (col as any).colKey;
+
+        let specialConfig = colKey ? specialColumnConfig[colKey] : undefined;
+
+        if (!specialConfig && typeof colKey === "string" && (colKey.endsWith("At") || colKey.endsWith("At2"))) {
+            specialConfig = { align: "center" };
+        }
+
+        const base = {
+            width: 200,
+            ellipsis: true
+        };
+
+        const merged = Object.assign({}, base);
+        if (specialConfig) {
+            Object.assign(merged, specialConfig);
+        }
+        Object.assign(merged, col);
+
+        return merged;
+    });
+}