befly-shared 1.0.0 → 1.0.1

package/package.json

@@ -1,23 +1,25 @@
 {
     "name": "befly-shared",
-    "version": "1.0.0",
+    "version": "1.0.1",
     "private": false,
-    "description": "Befly 纯函数与纯常量共享包（不包含 Node/浏览器特定实现）",
-    "license": "Apache-2.0",
-    "author": "chensuiyi <bimostyle@qq.com>",
-    "files": [
-        "package.json",
-        "utils"
-    ],
+    "description": "Befly Shared - 通用工具函数库",
     "type": "module",
     "exports": {
-        "./utils/*": "./utils/*.ts"
+        "./*": {
+            "import": "./utils/*.js",
+            "default": "./utils/*.js"
+        }
     },
-    "scripts": {
-        "test": "bun test"
+    "files": [
+        "utils/",
+        "package.json"
+    ],
+    "publishConfig": {
+        "access": "public",
+        "registry": "https://registry.npmjs.org"
     },
     "engines": {
         "bun": ">=1.3.0"
     },
-    "gitHead": "faa8189c7d23cf45885c03d1425cba8f5bf45df9"
+    "gitHead": "cb5f3fe922985a84d5abd02a27e50cade25ad135"
 }

package/utils/createHttp.js

@@ -0,0 +1,90 @@
+export function createHttp(options) {
+    const config = options && typeof options === "object" ? options : {};
+    const apiPath = typeof config.apiPath === "string" ? config.apiPath : "";
+    const getToken = typeof config.getToken === "function" ? config.getToken : () => "";
+
+    function shouldDrop(key, value, dropList, dropKeyMap) {
+        for (const dropValue of dropList) {
+            if (Object.is(value, dropValue)) {
+                return true;
+            }
+        }
+        if (Array.isArray(dropKeyMap[key])) {
+            for (const dropValue of dropKeyMap[key]) {
+                if (Object.is(value, dropValue)) {
+                    return true;
+                }
+            }
+        }
+        return false;
+    }
+
+    return async function requestPost(url, data, dropValues, dropKeyValue) {
+        try {
+            const fullUrl = `${apiPath}${url}`;
+            const isForm = data instanceof FormData;
+            const dropList = Array.isArray(dropValues) ? dropValues : [null, undefined];
+            const dropKeyMap = dropKeyValue && typeof dropKeyValue === "object" ? dropKeyValue : {};
+            let payloadData = data ?? {};
+            if (isForm) {
+                const nextForm = new FormData();
+                for (const entry of payloadData.entries()) {
+                    const key = entry[0];
+                    const value = entry[1];
+                    if (!shouldDrop(key, value, dropList, dropKeyMap)) {
+                        nextForm.append(key, value);
+                    }
+                }
+                payloadData = nextForm;
+            } else if (payloadData && typeof payloadData === "object") {
+                const nextData = {};
+                for (const key of Object.keys(payloadData)) {
+                    const value = payloadData[key];
+                    if (!shouldDrop(key, value, dropList, dropKeyMap)) {
+                        nextData[key] = value;
+                    }
+                }
+                payloadData = nextData;
+            }
+            const headers = new Headers();
+            if (!isForm) {
+                headers.set("Content-Type", "application/json");
+            }
+            const tokenValue = getToken();
+            if (tokenValue) {
+                headers.set("Authorization", "Bearer " + tokenValue);
+            }
+            const init = {
+                method: "POST",
+                headers: headers,
+                body: isForm ? payloadData : JSON.stringify(payloadData ?? {})
+            };
+            const res = await fetch(fullUrl, init);
+            let payload;
+            try {
+                payload = await res.json();
+            } catch {
+                if (res.ok) {
+                    return Promise.reject({ msg: "响应解析失败" });
+                }
+                payload = {
+                    code: res.status,
+                    msg: `请求失败：HTTP ${res.status}`
+                };
+            }
+            if (payload.code !== 0) {
+                return Promise.reject({
+                    msg: payload.msg ?? "请求失败",
+                    code: payload.code,
+                    detail: payload.detail
+                });
+            }
+            return Promise.resolve(payload);
+        } catch (error) {
+            if (error && typeof error === "object") {
+                return Promise.reject(error);
+            }
+            return Promise.reject({ msg: "网络连接失败" });
+        }
+    };
+}

package/utils/createHttp.md

@@ -0,0 +1,125 @@
+# createHttp
+
+## 功能说明
+
+`createHttp(options)` 用于创建一个通用 POST 请求函数，支持：
+
+- JSON 请求体自动序列化
+- `FormData` 自动直传
+- 默认值/按字段值过滤（`dropValues`、`dropKeyValue`）
+- 自动附带 Bearer Token
+- 统一响应与错误结构处理
+
+创建后返回的请求函数签名为：
+
+- `requestPost(url, data, dropValues, dropKeyValue)`
+
+---
+
+## 入参
+
+### createHttp(options)
+
+- `options.apiPath`：`string`
+    - 接口前缀，例如：`http://localhost:3000/api`
+- `options.getToken`：`() => string`
+    - 获取 token 的函数
+    - 返回空字符串时不会添加 `Authorization`
+
+### requestPost(url, data, dropValues, dropKeyValue)
+
+- `url`：`string`
+    - 业务接口路径，例如：`/core/login`
+- `data`：`object | FormData`
+    - 普通对象会按 JSON 发送
+    - `FormData` 会按表单发送
+- `dropValues`：`Array<any>`（可选）
+    - 全局过滤值列表
+    - 默认：`[null, undefined]`
+- `dropKeyValue`：`Record<string, Array<any>>`（可选）
+    - 按字段过滤值
+    - 例如：`{ page: [0], keyword: [""] }`
+
+---
+
+## 返回值
+
+### 成功
+
+返回后端 JSON 对象（要求后端 `code === 0`）。
+
+### 失败
+
+Promise reject 对象结构：
+
+- `msg`: 错误消息
+- `code`: 后端业务码（可选）
+- `detail`: 后端明细（可选）
+
+特殊情况：
+
+- 响应可读但 JSON 解析失败：`{ msg: "响应解析失败" }`
+- 非 2xx 且无法按业务格式解析：`{ code: HTTP状态码, msg: "请求失败：HTTP xxx" }`
+- 网络异常：`{ msg: "网络连接失败" }`
+
+---
+
+## 使用示例
+
+### 1）创建实例
+
+```javascript
+import { createHttp } from "befly-shared/createHttp";
+
+const $Http = createHttp({
+    apiPath: "http://localhost:3000/api",
+    getToken: () => localStorage.getItem("befly-admin-token") ?? ""
+});
+```
+
+### 2）JSON 请求
+
+```javascript
+const res = await $Http("/core/user/list", {
+    page: 1,
+    limit: 30,
+    keyword: ""
+});
+```
+
+### 3）FormData 请求
+
+```javascript
+const form = new FormData();
+form.append("file", file);
+form.append("remark", "头像");
+
+const res = await $Http("/core/upload/file", form);
+```
+
+### 4）过滤默认值
+
+```javascript
+const res = await $Http("/core/user/list", { page: 1, limit: 30, keyword: "", state: null }, [null, undefined, ""], { page: [0] });
+```
+
+---
+
+## 行为细节
+
+- 当 `data instanceof FormData` 时：
+    - 不设置 `Content-Type`（由浏览器自动带 boundary）
+    - `body` 直接传 `FormData`
+- 当 `data` 是普通对象时：
+    - 设置 `Content-Type: application/json`
+    - `body` 为 `JSON.stringify(data)`
+- 有 token 时自动设置：
+    - `Authorization: Bearer <token>`
+
+---
+
+## 注意事项
+
+- 后端响应格式建议统一为 `{ code, msg, data, detail }`
+- 仅当 `code === 0` 视为成功
+- 该实现固定为 `POST` 请求

package/utils/arrayToTree.ts

@@ -1,135 +0,0 @@
-export type ArrayToTreeResult<T extends Record<string, any>> = {
-    flat: Array<T>;
-    tree: Array<T>;
-    map: Map<string, T>;
-};
-
-/**
- * 将一维数组按 { id, pid } 组装为树形结构（纯函数 / 无副作用）。
- *
- * - 默认字段：id / pid / children / sort
- * - pid 为空字符串或父节点不存在时，视为根节点
- * - 内部会 clone 一份节点对象，并写入 children: []
- * - 默认自带递归排序：按 sort 升序；sort 缺省/非法或 < 1 视为 999999；sort 相同按 id 自然序
- */
-export function arrayToTree<T extends Record<string, any>>(items: T[], id: string = "id", pid: string = "pid", children: string = "children", sort: string = "sort"): ArrayToTreeResult<T> {
-    const idKey = typeof id === "string" && id.length > 0 ? id : "id";
-    const pidKey = typeof pid === "string" && pid.length > 0 ? pid : "pid";
-    const childrenKey = typeof children === "string" && children.length > 0 ? children : "children";
-    const sortKey = typeof sort === "string" && sort.length > 0 ? sort : "sort";
-
-    const map = new Map<string, T>();
-    const flat: T[] = [];
-
-    const safeItems = Array.isArray(items) ? items : [];
-
-    const normalizeKey = (value: unknown): string => {
-        if (typeof value === "string") {
-            return value;
-        }
-        if (typeof value === "number" && Number.isFinite(value)) {
-            return String(value);
-        }
-        return "";
-    };
-
-    for (const item of safeItems) {
-        const rawId = item ? (item as any)[idKey] : undefined;
-        const rawPid = item ? (item as any)[pidKey] : undefined;
-
-        const normalizedId = normalizeKey(rawId);
-        const normalizedPid = normalizeKey(rawPid);
-
-        const nextNode = Object.assign({}, item) as T;
-        (nextNode as any)[idKey] = normalizedId;
-        (nextNode as any)[pidKey] = normalizedPid;
-        (nextNode as any)[childrenKey] = [];
-
-        flat.push(nextNode);
-
-        if (normalizedId.length > 0) {
-            map.set(normalizedId, nextNode);
-        }
-    }
-
-    const tree: T[] = [];
-
-    for (const node of flat) {
-        const selfId = normalizeKey(node ? (node as any)[idKey] : undefined);
-        const parentId = normalizeKey(node ? (node as any)[pidKey] : undefined);
-
-        if (parentId.length > 0 && parentId !== selfId) {
-            const parent = map.get(parentId);
-            if (parent && Array.isArray((parent as any)[childrenKey])) {
-                (parent as any)[childrenKey].push(node);
-                continue;
-            }
-        }
-
-        tree.push(node);
-    }
-
-    const collator = new Intl.Collator(undefined, { numeric: true, sensitivity: "base" });
-
-    const getSortValue = (node: T): number => {
-        const raw = node ? (node as any)[sortKey] : undefined;
-        if (typeof raw !== "number") {
-            return 999999;
-        }
-        if (!Number.isFinite(raw)) {
-            return 999999;
-        }
-        if (raw < 1) {
-            return 999999;
-        }
-        return raw;
-    };
-
-    const compareNode = (a: T, b: T): number => {
-        const aSort = getSortValue(a);
-        const bSort = getSortValue(b);
-
-        if (aSort !== bSort) {
-            return aSort - bSort;
-        }
-
-        const aId = a ? (a as any)[idKey] : "";
-        const bId = b ? (b as any)[idKey] : "";
-
-        return collator.compare(typeof aId === "string" ? aId : "", typeof bId === "string" ? bId : "");
-    };
-
-    const sortTreeInPlace = (nodes: Array<T>, seen: WeakSet<object>): void => {
-        if (!Array.isArray(nodes)) {
-            return;
-        }
-
-        if (nodes.length > 1) {
-            nodes.sort(compareNode);
-        }
-
-        for (const node of nodes) {
-            if (typeof node !== "object" || node === null) {
-                continue;
-            }
-
-            if (seen.has(node)) {
-                continue;
-            }
-            seen.add(node);
-
-            const childNodes = (node as any)[childrenKey];
-            if (Array.isArray(childNodes) && childNodes.length > 0) {
-                sortTreeInPlace(childNodes, seen);
-            }
-        }
-    };
-
-    sortTreeInPlace(tree, new WeakSet<object>());
-
-    return {
-        flat: flat,
-        tree: tree,
-        map: map
-    };
-}

package/utils/buildTreeByParentPath.ts

@@ -1,127 +0,0 @@
-export type BuildTreeByParentPathOptions = {
-    pathKey?: string;
-    parentPathKey?: string;
-    childrenKey?: string;
-    normalize?: (value: unknown) => string;
-};
-
-export type BuildTreeByParentPathResult<T extends Record<string, any>> = {
-    flat: Array<T>;
-    tree: Array<T>;
-    map: Map<string, T>;
-};
-
-/**
- * 将一维数组按 { path, parentPath } 组装为树形结构（纯函数 / 无副作用）。
- *
- * - 默认字段：path / parentPath / children
- * - parentPath 为空字符串或父节点不存在时，视为根节点
- * - 内部会 clone 一份节点对象，并写入 children: []
- * - 默认自带递归排序：按 sort 升序；sort 缺省/非法或 < 1 视为 999999；sort 相同按 path 自然序
- */
-export function buildTreeByParentPath<T extends Record<string, any>>(items: T[], options?: BuildTreeByParentPathOptions): BuildTreeByParentPathResult<T> {
-    const pathKey = typeof options?.pathKey === "string" && options.pathKey.length > 0 ? options.pathKey : "path";
-    const parentPathKey = typeof options?.parentPathKey === "string" && options.parentPathKey.length > 0 ? options.parentPathKey : "parentPath";
-    const childrenKey = typeof options?.childrenKey === "string" && options.childrenKey.length > 0 ? options.childrenKey : "children";
-
-    const normalize =
-        typeof options?.normalize === "function"
-            ? options.normalize
-            : (value: unknown) => {
-                  return typeof value === "string" ? value : "";
-              };
-
-    const map = new Map<string, T>();
-    const flat: T[] = [];
-
-    const safeItems = Array.isArray(items) ? items : [];
-
-    for (const item of safeItems) {
-        const rawPath = item ? item[pathKey] : undefined;
-        const rawParentPath = item ? item[parentPathKey] : undefined;
-
-        const normalizedPath = normalize(rawPath);
-        const normalizedParentPath = normalize(rawParentPath);
-
-        const nextNode = Object.assign({}, item) as T;
-        (nextNode as any)[pathKey] = normalizedPath;
-        (nextNode as any)[parentPathKey] = normalizedParentPath;
-        (nextNode as any)[childrenKey] = [];
-
-        flat.push(nextNode);
-
-        if (typeof normalizedPath === "string" && normalizedPath.length > 0) {
-            map.set(normalizedPath, nextNode);
-        }
-    }
-
-    const tree: T[] = [];
-    for (const node of flat) {
-        const parentPath = (node as any)[parentPathKey];
-
-        if (typeof parentPath === "string" && parentPath.length > 0) {
-            const parent = map.get(parentPath);
-            if (parent && Array.isArray((parent as any)[childrenKey])) {
-                (parent as any)[childrenKey].push(node);
-                continue;
-            }
-        }
-
-        tree.push(node);
-    }
-
-    const collator = new Intl.Collator(undefined, { numeric: true, sensitivity: "base" });
-
-    const getSortValue = (node: T): number => {
-        const raw = node ? (node as any).sort : undefined;
-        if (typeof raw !== "number") {
-            return 999999;
-        }
-
-        if (!Number.isFinite(raw)) {
-            return 999999;
-        }
-
-        if (raw < 1) {
-            return 999999;
-        }
-
-        return raw;
-    };
-
-    const compareNode = (a: T, b: T): number => {
-        const aSort = getSortValue(a);
-        const bSort = getSortValue(b);
-
-        if (aSort !== bSort) {
-            return aSort - bSort;
-        }
-
-        const aPath = a ? (a as any)[pathKey] : "";
-        const bPath = b ? (b as any)[pathKey] : "";
-        return collator.compare(typeof aPath === "string" ? aPath : "", typeof bPath === "string" ? bPath : "");
-    };
-
-    const sortTreeInPlace = (nodes: Array<T>): void => {
-        if (!Array.isArray(nodes) || nodes.length <= 1) {
-            return;
-        }
-
-        nodes.sort(compareNode);
-
-        for (const node of nodes) {
-            const children = node ? (node as any)[childrenKey] : undefined;
-            if (Array.isArray(children) && children.length > 0) {
-                sortTreeInPlace(children);
-            }
-        }
-    };
-
-    sortTreeInPlace(tree);
-
-    return {
-        flat: flat,
-        tree: tree,
-        map: map
-    };
-}

package/utils/scanViewsDir.ts

@@ -1,148 +0,0 @@
-export type ViewDirMeta = {
-    title: string;
-    order?: number;
-};
-
-type MenuNodeLike<T> = {
-    name?: string;
-    path?: string;
-    sort?: number;
-    children?: T[];
-};
-
-/**
- * 清理目录名中的数字后缀
- * 如：login_1 → login, index_2 → index
- */
-export function cleanDirName(name: string): string {
-    return name.replace(/_\d+$/, "");
-}
-
-/**
- * 约束：统一 path 形态，避免隐藏菜单匹配、DB 同步出现重复
- * - 必须以 / 开头
- * - 折叠多个 /
- * - 去掉尾随 /（根 / 除外）
- */
-export function normalizeMenuPath(path: string): string {
-    let result = path;
-
-    if (!result) {
-        return "/";
-    }
-
-    if (!result.startsWith("/")) {
-        result = `/${result}`;
-    }
-
-    result = result.replace(/\/+/g, "/");
-
-    if (result.length > 1) {
-        result = result.replace(/\/+$/, "");
-    }
-
-    return result;
-}
-
-/**
- * 递归规范化并按 path 去重（同 path 的 children 合并）
- *
- * 说明：该函数是纯函数，不依赖任何运行时环境；会返回新数组，但会在内部对克隆对象做合并赋值。
- */
-export function normalizeMenuTree<T extends MenuNodeLike<T>>(menus: T[]): T[] {
-    const map = new Map<string, T>();
-
-    for (const menu of menus) {
-        const rawPath = menu.path;
-        const menuPath = rawPath ? normalizeMenuPath(rawPath) : "";
-
-        if (!menuPath) {
-            continue;
-        }
-
-        // 不使用 structuredClone：
-        // - 结构中可能出现函数/类实例等不可 clone 的值
-        // - 这里我们只需要“保留额外字段 + 递归 children 生成新数组”
-        // 用浅拷贝即可满足需求
-        const cloned = Object.assign({}, menu) as T;
-        (cloned as any).path = menuPath;
-
-        const rawChildren = menu.children;
-        if (rawChildren && rawChildren.length > 0) {
-            (cloned as any).children = normalizeMenuTree(rawChildren);
-        }
-
-        const existing = map.get(menuPath);
-        if (existing) {
-            const clonedChildren = (cloned as any).children as T[] | undefined;
-            if (clonedChildren && clonedChildren.length > 0) {
-                let existingChildren = (existing as any).children as T[] | undefined;
-                if (!existingChildren) {
-                    existingChildren = [];
-                    (existing as any).children = existingChildren;
-                }
-
-                for (const child of clonedChildren) {
-                    existingChildren.push(child);
-                }
-
-                (existing as any).children = normalizeMenuTree(existingChildren);
-            }
-
-            if (typeof cloned.sort === "number") {
-                (existing as any).sort = cloned.sort;
-            }
-
-            if (typeof cloned.name === "string" && cloned.name) {
-                (existing as any).name = cloned.name;
-            }
-        } else {
-            map.set(menuPath, cloned);
-        }
-    }
-
-    const result = Array.from(map.values());
-    result.sort((a, b) => ((a as any).sort ?? 999999) - ((b as any).sort ?? 999999));
-    return result;
-}
-
-/**
- * 只取第一个 <script ... setup ...> 块
- */
-export function extractScriptSetupBlock(vueContent: string): string | null {
-    const openTag = /<script\b[^>]*\bsetup\b[^>]*>/i.exec(vueContent);
-    if (!openTag) {
-        return null;
-    }
-
-    const start = openTag.index + openTag[0].length;
-    const closeIndex = vueContent.indexOf("</script>", start);
-    if (closeIndex < 0) {
-        return null;
-    }
-
-    return vueContent.slice(start, closeIndex);
-}
-
-/**
- * 从 <script setup> 中提取 definePage({ meta })
- *
- * 简化约束：
- * - 每个页面只有一个 definePage
- * - title 是纯字符串字面量
- * - order 是数字字面量（可选）
- * - 不考虑变量/表达式/多段 meta 组合
- */
-export function extractDefinePageMetaFromScriptSetup(scriptSetup: string): ViewDirMeta | null {
-    const titleMatch = scriptSetup.match(/definePage\s*\([\s\S]*?meta\s*:\s*\{[\s\S]*?title\s*:\s*(["'`])([^"'`]+)\1/);
-    if (!titleMatch) {
-        return null;
-    }
-
-    const orderMatch = scriptSetup.match(/definePage\s*\([\s\S]*?meta\s*:\s*\{[\s\S]*?order\s*:\s*(\d+)/);
-
-    return {
-        title: titleMatch[2],
-        order: orderMatch ? Number(orderMatch[1]) : undefined
-    };
-}