@whispering233/ai-editor-shared 0.0.15 → 0.0.20

package/dist/utils/reference-file.js

@@ -0,0 +1,131 @@
+// 参考资料文件工具纯函数（决策 43，批次十一）
+// 职责：md 文件（YAML frontmatter + markdown 正文）的解析/序列化 + 文件名 sanitize。
+// 约束（shared 硬约束）：纯 TS 无 Node 内置模块——仅字符串处理，client 可打包。
+// 契约来源：doc/design/decisions.md 决策 43（文件 = 真相源：frontmatter 自包含可重建索引）、
+//   doc/database/schema.md（reference data 字段 kind/file_name/file_mtime）。
+//
+// frontmatter 格式（决策 43 Q1=方案 A）：
+//   ---
+//   title: 五行相生相克 摘抄
+//   category: material
+//   tags: [五行, 设定]
+//   ---
+//   正文 markdown…
+// 解析容错：frontmatter 缺失/非法 → 按纯 markdown 处理（title=undefined、category=undefined、
+//   tags=[]、body=全文），调用方兜底（title=文件名去扩展名、category=material）。
+/** YAML frontmatter 边界标记（须独占一行） */
+export const FRONTMATTER_DELIMITER = "---";
+/** 提取 frontmatter 块内原始行（不含 --- 边界）与正文偏移；无 frontmatter → null */
+function splitFrontmatter(text) {
+    // 首行必须是 ---（允许前导空行？不——严格首行，Obsidian/Typora 惯例）
+    if (!text.startsWith(`${FRONTMATTER_DELIMITER}\n`))
+        return null;
+    const firstNl = text.indexOf("\n");
+    const rest = text.slice(firstNl + 1);
+    // 找闭合 ---（独占一行）
+    const lines = rest.split("\n");
+    for (let i = 0; i < lines.length; i++) {
+        if (lines[i].trim() === FRONTMATTER_DELIMITER) {
+            const body = lines.slice(i + 1).join("\n");
+            // 去掉 body 开头单个换行（--- 闭合行后紧跟空行是惯例，保留语义不吞内容）
+            // 与末尾恰一个换行（POSIX 文件末尾换行惯例；roundtrip 稳定：serialize 输出 \n → parse 去掉）
+            return { rawLines: lines.slice(0, i), body: body.replace(/^\n/, "").replace(/\n$/, "") };
+        }
+    }
+    // 有起始无闭合 → 视为无 frontmatter（容错：全文当正文）
+    return null;
+}
+/** 解析单行 `key: value`（引号剥离：'…'/"…"；值去首尾空白；无冒号 → null） */
+function parseKeyValue(line) {
+    const idx = line.indexOf(":");
+    if (idx <= 0)
+        return null;
+    const key = line.slice(0, idx).trim();
+    const raw = line.slice(idx + 1).trim();
+    if (key === "")
+        return null;
+    // 行内数组 `tags: [a, b]` → 剥离括号后逗号分片
+    if (raw.startsWith("[") && raw.endsWith("]")) {
+        return { key, value: raw.slice(1, -1) };
+    }
+    // 引号包裹值
+    const unquoted = raw.replace(/^(['"])(.*)\1$/, "$2");
+    return { key, value: unquoted.trim() };
+}
+/**
+ * 解析 md 文件文本（frontmatter + 正文；决策 43）。
+ * 容错：无 frontmatter / 起始无闭合 → 全当正文；单行值数组/引号/注释行（# 开头）跳过；
+ * 重复 key 后者覆盖；未知 key 忽略（title/category/tags 之外的字段不进入索引，但序列化时保留——
+ * 见 serializeReferenceFile 的 extraLines 参数）。
+ */
+export function parseReferenceFrontmatter(text) {
+    const block = splitFrontmatter(text);
+    if (block === null)
+        return { tags: [], extraLines: [], body: text };
+    let title;
+    let category;
+    const tags = [];
+    const unknown = [];
+    for (const line of block.rawLines) {
+        const trimmed = line.trim();
+        if (trimmed === "" || trimmed.startsWith("#"))
+            continue;
+        const kv = parseKeyValue(trimmed);
+        if (kv === null)
+            continue;
+        if (kv.key === "title")
+            title = kv.value;
+        else if (kv.key === "category")
+            category = kv.value;
+        else if (kv.key === "tags") {
+            tags.length = 0;
+            for (const part of kv.value.split(",")) {
+                const t = part.trim();
+                if (t !== "")
+                    tags.push(t);
+            }
+        }
+        else {
+            unknown.push(line); // 保留未知行（序列化时原样写回，防外部编辑器自定义字段丢失）
+        }
+    }
+    return { title, category, tags, extraLines: unknown, body: block.body };
+}
+/** 序列化参考文件全文（frontmatter + 正文；决策 43 格式） */
+export function serializeReferenceFile(input) {
+    const lines = [FRONTMATTER_DELIMITER];
+    lines.push(`title: ${input.title}`);
+    lines.push(`category: ${input.category}`);
+    lines.push(`tags: [${input.tags.join(", ")}]`);
+    for (const line of input.extraLines ?? [])
+        lines.push(line);
+    lines.push(FRONTMATTER_DELIMITER);
+    // 全部前导换行归一（body 空行分隔：frontmatter 后恰一个空行再进正文）
+    const body = input.body.replace(/^\n+/, "");
+    if (body !== "")
+        lines.push("", body);
+    return `${lines.join("\n")}\n`;
+}
+/**
+ * 文件名 sanitize（决策 43：创建时标题作文件名；禁路径分隔符/保留字符/控制字符/纯点）。
+ * 规则对齐 sanitizeBackupName（B2.6）心智：Windows 保留字符 `\ / : * ? " < > |`、控制字符、
+ * 首尾空白/点、纯点（. / ..）全部清除/替换；空结果 → "未命名"；截断 100 字符（name 上限）。
+ * 返回不含 .md 扩展名的基名（调用方自行拼接）。
+ */
+export function sanitizeReferenceFileName(name) {
+    // 保留 CJK/字母数字/空格/常见标点（- _ . （）【】、，。；：！？·），其余替换为空格后折叠
+    const cleaned = name
+        // 控制字符与路径分隔符/保留字符 → 空格
+        .replace(/[\u0000-\u001f\u007f\\/:*?"<>|]/g, " ")
+        // 连续空白折叠 + 首尾清理
+        .replace(/\s+/g, " ")
+        .trim()
+        // 首尾点清理（Windows 尾点/点号问题），保留内部点（如「1.2 节」）
+        .replace(/^\.+|\.+$/g, "")
+        .slice(0, 100)
+        .trim();
+    if (cleaned === "" || cleaned === "." || cleaned === "..")
+        return "未命名";
+    return cleaned;
+}
+//# sourceMappingURL=reference-file.js.map

package/dist/utils/reference-file.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"reference-file.js","sourceRoot":"","sources":["../../src/utils/reference-file.ts"],"names":[],"mappings":"AAAA,0BAA0B;AAC1B,kEAAkE;AAClE,sDAAsD;AACtD,qEAAqE;AACrE,yEAAyE;AACzE,EAAE;AACF,iCAAiC;AACjC,QAAQ;AACR,qBAAqB;AACrB,uBAAuB;AACvB,mBAAmB;AACnB,QAAQ;AACR,iBAAiB;AACjB,8EAA8E;AAC9E,6DAA6D;AAE7D,mCAAmC;AACnC,MAAM,CAAC,MAAM,qBAAqB,GAAG,KAAK,CAAC;AAgB3C,gEAAgE;AAChE,SAAS,gBAAgB,CAAC,IAAY;IACpC,+CAA+C;IAC/C,IAAI,CAAC,IAAI,CAAC,UAAU,CAAC,GAAG,qBAAqB,IAAI,CAAC;QAAE,OAAO,IAAI,CAAC;IAChE,MAAM,OAAO,GAAG,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC;IACnC,MAAM,IAAI,GAAG,IAAI,CAAC,KAAK,CAAC,OAAO,GAAG,CAAC,CAAC,CAAC;IACrC,gBAAgB;IAChB,MAAM,KAAK,GAAG,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC;IAC/B,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,KAAK,CAAC,MAAM,EAAE,CAAC,EAAE,EAAE,CAAC;QACtC,IAAI,KAAK,CAAC,CAAC,CAAC,CAAC,IAAI,EAAE,KAAK,qBAAqB,EAAE,CAAC;YAC9C,MAAM,IAAI,GAAG,KAAK,CAAC,KAAK,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;YAC3C,2CAA2C;YAC3C,mEAAmE;YACnE,OAAO,EAAE,QAAQ,EAAE,KAAK,CAAC,KAAK,CAAC,CAAC,EAAE,CAAC,CAAC,EAAE,IAAI,EAAE,IAAI,CAAC,OAAO,CAAC,KAAK,EAAE,EAAE,CAAC,CAAC,OAAO,CAAC,KAAK,EAAE,EAAE,CAAC,EAAE,CAAC;QAC3F,CAAC;IACH,CAAC;IACD,qCAAqC;IACrC,OAAO,IAAI,CAAC;AACd,CAAC;AAED,wDAAwD;AACxD,SAAS,aAAa,CAAC,IAAY;IACjC,MAAM,GAAG,GAAG,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC;IAC9B,IAAI,GAAG,IAAI,CAAC;QAAE,OAAO,IAAI,CAAC;IAC1B,MAAM,GAAG,GAAG,IAAI,CAAC,KAAK,CAAC,CAAC,EAAE,GAAG,CAAC,CAAC,IAAI,EAAE,CAAC;IACtC,MAAM,GAAG,GAAG,IAAI,CAAC,KAAK,CAAC,GAAG,GAAG,CAAC,CAAC,CAAC,IAAI,EAAE,CAAC;IACvC,IAAI,GAAG,KAAK,EAAE;QAAE,OAAO,IAAI,CAAC;IAC5B,kCAAkC;IAClC,IAAI,GAAG,CAAC,UAAU,CAAC,GAAG,CAAC,IAAI,GAAG,CAAC,QAAQ,CAAC,GAAG,CAAC,EAAE,CAAC;QAC7C,OAAO,EAAE,GAAG,EAAE,KAAK,EAAE,GAAG,CAAC,KAAK,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;IAC1C,CAAC;IACD,QAAQ;IACR,MAAM,QAAQ,GAAG,GAAG,CAAC,OAAO,CAAC,gBAAgB,EAAE,IAAI,CAAC,CAAC;IACrD,OAAO,EAAE,GAAG,EAAE,KAAK,EAAE,QAAQ,CAAC,IAAI,EAAE,EAAE,CAAC;AACzC,CAAC;AAED;;;;;GAKG;AACH,MAAM,UAAU,yBAAyB,CAAC,IAAY;IACpD,MAAM,KAAK,GAAG,gBAAgB,CAAC,IAAI,CAAC,CAAC;IACrC,IAAI,KAAK,KAAK,IAAI;QAAE,OAAO,EAAE,IAAI,EAAE,EAAE,EAAE,UAAU,EAAE,EAAE,EAAE,IAAI,EAAE,IAAI,EAAE,CAAC;IACpE,IAAI,KAAyB,CAAC;IAC9B,IAAI,QAA4B,CAAC;IACjC,MAAM,IAAI,GAAa,EAAE,CAAC;IAC1B,MAAM,OAAO,GAAa,EAAE,CAAC;IAC7B,KAAK,MAAM,IAAI,IAAI,KAAK,CAAC,QAAQ,EAAE,CAAC;QAClC,MAAM,OAAO,GAAG,IAAI,CAAC,IAAI,EAAE,CAAC;QAC5B,IAAI,OAAO,KAAK,EAAE,IAAI,OAAO,CAAC,UAAU,CAAC,GAAG,CAAC;YAAE,SAAS;QACxD,MAAM,EAAE,GAAG,aAAa,CAAC,OAAO,CAAC,CAAC;QAClC,IAAI,EAAE,KAAK,IAAI;YAAE,SAAS;QAC1B,IAAI,EAAE,CAAC,GAAG,KAAK,OAAO;YAAE,KAAK,GAAG,EAAE,CAAC,KAAK,CAAC;aACpC,IAAI,EAAE,CAAC,GAAG,KAAK,UAAU;YAAE,QAAQ,GAAG,EAAE,CAAC,KAAK,CAAC;aAC/C,IAAI,EAAE,CAAC,GAAG,KAAK,MAAM,EAAE,CAAC;YAC3B,IAAI,CAAC,MAAM,GAAG,CAAC,CAAC;YAChB,KAAK,MAAM,IAAI,IAAI,EAAE,CAAC,KAAK,CAAC,KAAK,CAAC,GAAG,CAAC,EAAE,CAAC;gBACvC,MAAM,CAAC,GAAG,IAAI,CAAC,IAAI,EAAE,CAAC;gBACtB,IAAI,CAAC,KAAK,EAAE;oBAAE,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;YAC7B,CAAC;QACH,CAAC;aAAM,CAAC;YACN,OAAO,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC,gCAAgC;QACtD,CAAC;IACH,CAAC;IACD,OAAO,EAAE,KAAK,EAAE,QAAQ,EAAE,IAAI,EAAE,UAAU,EAAE,OAAO,EAAE,IAAI,EAAE,KAAK,CAAC,IAAI,EAAE,CAAC;AAC1E,CAAC;AAED,2CAA2C;AAC3C,MAAM,UAAU,sBAAsB,CAAC,KAOtC;IACC,MAAM,KAAK,GAAa,CAAC,qBAAqB,CAAC,CAAC;IAChD,KAAK,CAAC,IAAI,CAAC,UAAU,KAAK,CAAC,KAAK,EAAE,CAAC,CAAC;IACpC,KAAK,CAAC,IAAI,CAAC,aAAa,KAAK,CAAC,QAAQ,EAAE,CAAC,CAAC;IAC1C,KAAK,CAAC,IAAI,CAAC,UAAU,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;IAC/C,KAAK,MAAM,IAAI,IAAI,KAAK,CAAC,UAAU,IAAI,EAAE;QAAE,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;IAC5D,KAAK,CAAC,IAAI,CAAC,qBAAqB,CAAC,CAAC;IAClC,6CAA6C;IAC7C,MAAM,IAAI,GAAG,KAAK,CAAC,IAAI,CAAC,OAAO,CAAC,MAAM,EAAE,EAAE,CAAC,CAAC;IAC5C,IAAI,IAAI,KAAK,EAAE;QAAE,KAAK,CAAC,IAAI,CAAC,EAAE,EAAE,IAAI,CAAC,CAAC;IACtC,OAAO,GAAG,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC;AACjC,CAAC;AAED;;;;;GAKG;AACH,MAAM,UAAU,yBAAyB,CAAC,IAAY;IACpD,qDAAqD;IACrD,MAAM,OAAO,GAAG,IAAI;QAClB,uBAAuB;SACtB,OAAO,CAAC,kCAAkC,EAAE,GAAG,CAAC;QACjD,gBAAgB;SACf,OAAO,CAAC,MAAM,EAAE,GAAG,CAAC;SACpB,IAAI,EAAE;QACP,yCAAyC;SACxC,OAAO,CAAC,YAAY,EAAE,EAAE,CAAC;SACzB,KAAK,CAAC,CAAC,EAAE,GAAG,CAAC;SACb,IAAI,EAAE,CAAC;IACV,IAAI,OAAO,KAAK,EAAE,IAAI,OAAO,KAAK,GAAG,IAAI,OAAO,KAAK,IAAI;QAAE,OAAO,KAAK,CAAC;IACxE,OAAO,OAAO,CAAC;AACjB,CAAC"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@whispering233/ai-editor-shared",
-  "version": "0.0.15",
+  "version": "0.0.20",
   "license": "MIT",
   "description": "前后端共享层：纯类型 + 常量 + 纯函数（零 Node 依赖）",
   "type": "module",