befly-shared 1.0.0

package/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

package/package.json

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

package/utils/arrayToTree.ts

@@ -0,0 +1,135 @@
+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

@@ -0,0 +1,127 @@
+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

@@ -0,0 +1,148 @@
+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
+    };
+}