@tnotesjs/core 0.2.0 → 0.2.2

package/utils/tocNodeId.test.ts

@@ -0,0 +1,60 @@
+/**
+ * utils/tocNodeId.test.ts
+ */
+
+import { describe, expect, it } from 'vitest'
+
+import {
+  computeSidebarNodeId,
+  enrichSidebarNodeIds,
+  nodeIdForNote,
+  parseNodeId,
+} from './tocNodeId'
+
+import type { SidebarNodeLike } from './tocNodeId'
+
+describe('tocNodeId', () => {
+  it('computes note nodeId', () => {
+    expect(
+      computeSidebarNodeId({
+        text: '✅ 0019. Author',
+        link: '/notes/0019. Author/README',
+        tocLineIndex: 0,
+      }),
+    ).toBe(nodeIdForNote('0019'))
+  })
+
+  it('computes folder nodeId from tocLineIndex', () => {
+    expect(
+      computeSidebarNodeId({
+        text: 'build',
+        folderPath: ['build'],
+        tocLineIndex: 12,
+      }),
+    ).toBe('line:12')
+  })
+
+  it('enriches tree recursively', () => {
+    const tree = enrichSidebarNodeIds<SidebarNodeLike>([
+      {
+        text: 'Parent',
+        link: '/notes/0019. Author/README',
+        tocLineIndex: 0,
+        items: [{ text: 'Child', link: '/notes/0039. new/README', tocLineIndex: 1 }],
+      },
+    ])
+    expect(tree[0].nodeId).toBe('note:0019')
+    expect(tree[0].items?.[0].nodeId).toBe('note:0039')
+  })
+
+  it('parses nodeId kinds', () => {
+    expect(parseNodeId('note:0019')).toEqual({
+      kind: 'note',
+      noteIndex: '0019',
+    })
+    expect(parseNodeId('line:34')).toEqual({
+      kind: 'line',
+      tocLineIndex: 34,
+    })
+  })
+})

package/utils/tocNodeId.ts

@@ -0,0 +1,97 @@
+/**
+ * utils/tocNodeId.ts
+ *
+ * 语雀式拖拽 nodeId：dev 确定性 id，不写 TOC.md。
+ */
+
+export type TocMoveAction = 'moveAfter' | 'prependChild'
+
+export interface SidebarNodeLike {
+  text: string
+  link?: string
+  folderPath?: string[]
+  tocLineIndex?: number
+  nodeId?: string
+  items?: SidebarNodeLike[]
+}
+
+function extractNoteIndexFromLink(link?: string): string | null {
+  if (!link) return null
+  const match = link.match(/\/notes\/(\d{4})\./)
+  return match ? match[1] : null
+}
+
+export interface SidebarNodeLike {
+  text: string
+  link?: string
+  folderPath?: string[]
+  tocLineIndex?: number
+  nodeId?: string
+  items?: SidebarNodeLike[]
+}
+
+export function nodeIdForNote(noteIndex: string): string {
+  return `note:${noteIndex}`
+}
+
+export function nodeIdForFolder(folderPath: string[]): string {
+  return `folder:${folderPath.join('/')}`
+}
+
+export function nodeIdForLine(tocLineIndex: number): string {
+  return `line:${tocLineIndex}`
+}
+
+export function computeSidebarNodeId(item: SidebarNodeLike): string {
+  if (item.nodeId) return item.nodeId
+
+  const noteIndex = extractNoteIndexFromLink(item.link)
+  if (noteIndex) return nodeIdForNote(noteIndex)
+
+  if (item.tocLineIndex !== undefined && !item.link) {
+    return nodeIdForLine(item.tocLineIndex)
+  }
+
+  if (item.folderPath?.length) {
+    return nodeIdForFolder(item.folderPath)
+  }
+
+  if (item.tocLineIndex !== undefined) {
+    return nodeIdForLine(item.tocLineIndex)
+  }
+
+  return `text:${item.text}`
+}
+
+export function enrichSidebarNodeIds<T extends SidebarNodeLike>(items: T[]): T[] {
+  return items.map((item) => {
+    const nodeId = computeSidebarNodeId(item)
+    const next = { ...item, nodeId } as T
+    if (item.items?.length) {
+      next.items = enrichSidebarNodeIds(item.items) as T['items']
+    }
+    return next
+  })
+}
+
+export function parseNodeId(nodeId: string): {
+  kind: 'note' | 'folder' | 'line' | 'text'
+  noteIndex?: string
+  folderPath?: string[]
+  tocLineIndex?: number
+} {
+  if (nodeId.startsWith('note:')) {
+    return { kind: 'note', noteIndex: nodeId.slice(5) }
+  }
+  if (nodeId.startsWith('folder:')) {
+    const path = nodeId.slice(7)
+    return {
+      kind: 'folder',
+      folderPath: path ? path.split('/') : [],
+    }
+  }
+  if (nodeId.startsWith('line:')) {
+    return { kind: 'line', tocLineIndex: Number(nodeId.slice(5)) }
+  }
+  return { kind: 'text' }
+}

package/utils/validators.ts

@@ -0,0 +1,102 @@
+/**
+ * utils/validators.ts
+ *
+ * 验证工具函数
+ */
+
+/**
+ * Windows 和 macOS 都不允许的文件名字符
+ * Windows: < > : " / \ | ? *
+ * macOS: : (冒号会被转换为斜杠)
+ *
+ * 为了兼容性,我们禁止以下字符:
+ * - < > : " / \ | ? *
+ * - 控制字符 (0x00-0x1F)
+ */
+const INVALID_FILENAME_CHARS = /[<>:"/\\|?*\x00-\x1F]/
+
+/**
+ * Windows 保留文件名
+ */
+const WINDOWS_RESERVED_NAMES = new Set([
+  'CON',
+  'PRN',
+  'AUX',
+  'NUL',
+  'COM1',
+  'COM2',
+  'COM3',
+  'COM4',
+  'COM5',
+  'COM6',
+  'COM7',
+  'COM8',
+  'COM9',
+  'LPT1',
+  'LPT2',
+  'LPT3',
+  'LPT4',
+  'LPT5',
+  'LPT6',
+  'LPT7',
+  'LPT8',
+  'LPT9',
+])
+
+/**
+ * 验证标题是否为合法的文件夹名称
+ * @param title - 笔记标题
+ * @returns 验证结果 { valid: boolean, error?: string }
+ */
+export function validateNoteTitle(title: string): {
+  valid: boolean
+  error?: string
+} {
+  // 检查是否为空
+  if (!title || title.trim().length === 0) {
+    return { valid: false, error: '标题不能为空' }
+  }
+
+  const trimmedTitle = title.trim()
+
+  // 检查长度 (Windows 路径限制 260 字符,留足够空间)
+  if (trimmedTitle.length > 200) {
+    return { valid: false, error: '标题过长(最多200个字符)' }
+  }
+
+  // 检查是否包含非法字符
+  if (INVALID_FILENAME_CHARS.test(trimmedTitle)) {
+    return {
+      valid: false,
+      error: '标题包含非法字符(不允许: < > : " / \\ | ? *)',
+    }
+  }
+
+  // 检查是否以点或空格开头/结尾 (Windows 限制)
+  if (/^[.\s]|[.\s]$/.test(trimmedTitle)) {
+    return {
+      valid: false,
+      error: '标题不能以点或空格开头/结尾',
+    }
+  }
+
+  // 检查 Windows 保留名称
+  const upperTitle = trimmedTitle.toUpperCase()
+  if (WINDOWS_RESERVED_NAMES.has(upperTitle)) {
+    return {
+      valid: false,
+      error: `"${trimmedTitle}" 是 Windows 系统保留名称`,
+    }
+  }
+
+  // 检查是否为 Windows 保留名称加扩展名 (例如 CON.txt)
+  const baseName = trimmedTitle.split('.')[0].toUpperCase()
+  if (WINDOWS_RESERVED_NAMES.has(baseName)) {
+    return {
+      valid: false,
+      error: `"${trimmedTitle}" 包含 Windows 系统保留名称`,
+    }
+  }
+
+  return { valid: true }
+}