@tnotesjs/core 0.5.0 → 0.6.1

package/dist/types-CpsEy8lA.d.cts

@@ -0,0 +1,221 @@
+import { N as NoteConfig, T as TNotesConfig } from './note-oGm44Rw8.cjs';
+
+/**
+ * utils/tocHelpers.ts
+ *
+ * 根目录 TOC.md 解析、序列化与 sidebar 树构建
+ */
+
+/** 目录节点 */
+interface TocFolderNode {
+    kind: 'folder';
+    title: string;
+    indent: number;
+    tocLineIndex: number;
+    children: TocTreeNode[];
+}
+/** 笔记节点（可有 children，语雀式父笔记） */
+interface TocNoteNode {
+    kind: 'note';
+    noteIndex: string;
+    indent: number;
+    tocLineIndex: number;
+    children: TocTreeNode[];
+}
+type TocTreeNode = TocFolderNode | TocNoteNode;
+/** Sidebar 项（与 VitePress sidebar 结构一致） */
+interface TocSidebarItem {
+    text: string;
+    link?: string;
+    collapsed?: boolean;
+    items?: TocSidebarItem[];
+    /** 纯目录节点路径（从根到当前目录的标题链，仅 UI 展示） */
+    folderPath?: string[];
+    /** TOC.md 中对应行的 0-based 行号（CRUD/拖拽主键） */
+    tocLineIndex?: number;
+    /** dev 拖拽用确定性 nodeId（不写 TOC.md） */
+    nodeId?: string;
+}
+
+type WorkspaceDiagnosticSeverity = 'error' | 'warning' | 'info';
+interface WorkspaceDiagnostic {
+    code: string;
+    message: string;
+    severity: WorkspaceDiagnosticSeverity;
+    path?: string;
+}
+type WorkspaceHealth = {
+    status: 'ready';
+    diagnostics: WorkspaceDiagnostic[];
+} | {
+    status: 'invalid';
+    diagnostics: WorkspaceDiagnostic[];
+} | {
+    status: 'future-schema';
+    diagnostics: WorkspaceDiagnostic[];
+};
+/**
+ * Core only edits known fields, but it must retain fields introduced by a
+ * knowledge base or by a newer Core release.
+ */
+type WorkspaceNoteConfig = NoteConfig & Record<string, unknown>;
+type WorkspaceKnowledgeBaseConfig = TNotesConfig & Record<string, unknown>;
+interface WorkspaceNoteSummary {
+    uuid: string;
+    index: string;
+    title: string;
+    dirName: string;
+    directoryPath: string;
+    readmePath: string;
+    configPath: string;
+    config: WorkspaceNoteConfig;
+    revision: string;
+}
+interface KnowledgeBaseSnapshot {
+    id: string;
+    rootPath: string;
+    config: WorkspaceKnowledgeBaseConfig | null;
+    health: WorkspaceHealth;
+    toc: TocTreeNode[];
+    sidebar: TocSidebarItem[];
+    notes: WorkspaceNoteSummary[];
+    revision: string;
+}
+interface NoteDocument extends WorkspaceNoteSummary {
+    content: string;
+}
+interface ChangedFile {
+    path: string;
+    kind: 'created' | 'updated' | 'deleted' | 'renamed';
+    previousPath?: string;
+}
+interface MutationResult<T> {
+    value: T;
+    changedFiles: ChangedFile[];
+    snapshotRevision: string;
+}
+interface WorkspaceLogger {
+    debug?(message: string, details?: unknown): void;
+    info?(message: string, details?: unknown): void;
+    warn?(message: string, details?: unknown): void;
+    error?(message: string, details?: unknown): void;
+}
+interface CreateWorkspaceOptions {
+    rootPath: string;
+    logger?: WorkspaceLogger;
+    format?: {
+        prettier?: boolean;
+    };
+}
+interface SaveNoteInput {
+    noteUuid: string;
+    content: string;
+    expectedRevision: string;
+    prettier?: boolean;
+}
+type NotePlacement = {
+    type: 'root';
+    placement?: 'start' | 'end';
+} | {
+    type: 'note';
+    targetNoteUuid: string;
+    placement: 'before' | 'after' | 'inside';
+} | {
+    type: 'folder';
+    folderPath: string[];
+    placement: 'before' | 'after' | 'inside';
+};
+interface CreateNoteInput {
+    title: string;
+    placement?: NotePlacement;
+    config?: Partial<Pick<WorkspaceNoteConfig, 'description' | 'enableDiscussions'>>;
+    expectedSnapshotRevision?: string;
+}
+interface RenameNoteInput {
+    noteUuid: string;
+    title: string;
+    expectedRevision: string;
+}
+interface UpdateNoteConfigInput {
+    noteUuid: string;
+    updates: Partial<Pick<WorkspaceNoteConfig, 'done' | 'description' | 'enableDiscussions'>>;
+    expectedRevision: string;
+}
+type TocEntryRef = {
+    type: 'note';
+    noteUuid: string;
+} | {
+    type: 'folder';
+    folderPath: string[];
+} | {
+    type: 'line';
+    tocLineIndex: number;
+};
+interface MoveTocEntryInput {
+    source: TocEntryRef;
+    target: TocEntryRef;
+    placement: 'before' | 'after' | 'inside';
+    expectedSnapshotRevision: string;
+}
+interface CreateTocGroupInput {
+    title: string;
+    placement?: NotePlacement;
+    expectedSnapshotRevision: string;
+}
+interface RenameTocGroupInput {
+    folderPath: string[];
+    title: string;
+    expectedSnapshotRevision: string;
+}
+interface DeletePreviewItem {
+    noteUuid: string;
+    index: string;
+    title: string;
+    directoryPath: string;
+}
+interface DeleteTocEntryPreview {
+    entry: TocEntryRef;
+    notes: DeletePreviewItem[];
+    filePaths: string[];
+    directoryPaths: string[];
+    snapshotRevision: string;
+}
+interface DeleteTocEntryInput {
+    entry: TocEntryRef;
+    expectedSnapshotRevision: string;
+}
+interface WriteAttachmentInput {
+    noteUuid: string;
+    fileName: string;
+    data: Uint8Array;
+}
+interface AttachmentResult {
+    absolutePath: string;
+    markdownPath: string;
+}
+interface TNotesWorkspace {
+    inspect(): Promise<KnowledgeBaseSnapshot>;
+    refresh(): Promise<KnowledgeBaseSnapshot>;
+    reconcileTocCompletion(): Promise<MutationResult<KnowledgeBaseSnapshot>>;
+    notes: {
+        read(noteUuid: string): Promise<NoteDocument>;
+        save(input: SaveNoteInput): Promise<MutationResult<NoteDocument>>;
+        create(input: CreateNoteInput): Promise<MutationResult<NoteDocument>>;
+        rename(input: RenameNoteInput): Promise<MutationResult<NoteDocument>>;
+        updateConfig(input: UpdateNoteConfigInput): Promise<MutationResult<NoteDocument>>;
+    };
+    toc: {
+        move(input: MoveTocEntryInput): Promise<MutationResult<KnowledgeBaseSnapshot>>;
+        createGroup(input: CreateTocGroupInput): Promise<MutationResult<KnowledgeBaseSnapshot>>;
+        renameGroup(input: RenameTocGroupInput): Promise<MutationResult<KnowledgeBaseSnapshot>>;
+        previewDelete(entry: TocEntryRef): Promise<DeleteTocEntryPreview>;
+        deleteEntry(input: DeleteTocEntryInput): Promise<MutationResult<KnowledgeBaseSnapshot>>;
+        setDone(input: UpdateNoteConfigInput): Promise<MutationResult<NoteDocument>>;
+    };
+    attachments: {
+        writeLocal(input: WriteAttachmentInput): Promise<MutationResult<AttachmentResult>>;
+    };
+    dispose(): Promise<void>;
+}
+
+export type { AttachmentResult as A, CreateWorkspaceOptions as C, DeletePreviewItem as D, KnowledgeBaseSnapshot as K, MoveTocEntryInput as M, NoteDocument as N, RenameNoteInput as R, SaveNoteInput as S, TNotesWorkspace as T, UpdateNoteConfigInput as U, WorkspaceDiagnostic as W, ChangedFile as a, CreateNoteInput as b, CreateTocGroupInput as c, DeleteTocEntryInput as d, DeleteTocEntryPreview as e, MutationResult as f, NotePlacement as g, RenameTocGroupInput as h, TocEntryRef as i, WorkspaceHealth as j, WorkspaceKnowledgeBaseConfig as k, WorkspaceLogger as l, WorkspaceNoteConfig as m, WorkspaceNoteSummary as n, WriteAttachmentInput as o };

package/dist/types-CwBWwNVv.d.ts

@@ -0,0 +1,221 @@
+import { N as NoteConfig, T as TNotesConfig } from './note-oGm44Rw8.js';
+
+/**
+ * utils/tocHelpers.ts
+ *
+ * 根目录 TOC.md 解析、序列化与 sidebar 树构建
+ */
+
+/** 目录节点 */
+interface TocFolderNode {
+    kind: 'folder';
+    title: string;
+    indent: number;
+    tocLineIndex: number;
+    children: TocTreeNode[];
+}
+/** 笔记节点（可有 children，语雀式父笔记） */
+interface TocNoteNode {
+    kind: 'note';
+    noteIndex: string;
+    indent: number;
+    tocLineIndex: number;
+    children: TocTreeNode[];
+}
+type TocTreeNode = TocFolderNode | TocNoteNode;
+/** Sidebar 项（与 VitePress sidebar 结构一致） */
+interface TocSidebarItem {
+    text: string;
+    link?: string;
+    collapsed?: boolean;
+    items?: TocSidebarItem[];
+    /** 纯目录节点路径（从根到当前目录的标题链，仅 UI 展示） */
+    folderPath?: string[];
+    /** TOC.md 中对应行的 0-based 行号（CRUD/拖拽主键） */
+    tocLineIndex?: number;
+    /** dev 拖拽用确定性 nodeId（不写 TOC.md） */
+    nodeId?: string;
+}
+
+type WorkspaceDiagnosticSeverity = 'error' | 'warning' | 'info';
+interface WorkspaceDiagnostic {
+    code: string;
+    message: string;
+    severity: WorkspaceDiagnosticSeverity;
+    path?: string;
+}
+type WorkspaceHealth = {
+    status: 'ready';
+    diagnostics: WorkspaceDiagnostic[];
+} | {
+    status: 'invalid';
+    diagnostics: WorkspaceDiagnostic[];
+} | {
+    status: 'future-schema';
+    diagnostics: WorkspaceDiagnostic[];
+};
+/**
+ * Core only edits known fields, but it must retain fields introduced by a
+ * knowledge base or by a newer Core release.
+ */
+type WorkspaceNoteConfig = NoteConfig & Record<string, unknown>;
+type WorkspaceKnowledgeBaseConfig = TNotesConfig & Record<string, unknown>;
+interface WorkspaceNoteSummary {
+    uuid: string;
+    index: string;
+    title: string;
+    dirName: string;
+    directoryPath: string;
+    readmePath: string;
+    configPath: string;
+    config: WorkspaceNoteConfig;
+    revision: string;
+}
+interface KnowledgeBaseSnapshot {
+    id: string;
+    rootPath: string;
+    config: WorkspaceKnowledgeBaseConfig | null;
+    health: WorkspaceHealth;
+    toc: TocTreeNode[];
+    sidebar: TocSidebarItem[];
+    notes: WorkspaceNoteSummary[];
+    revision: string;
+}
+interface NoteDocument extends WorkspaceNoteSummary {
+    content: string;
+}
+interface ChangedFile {
+    path: string;
+    kind: 'created' | 'updated' | 'deleted' | 'renamed';
+    previousPath?: string;
+}
+interface MutationResult<T> {
+    value: T;
+    changedFiles: ChangedFile[];
+    snapshotRevision: string;
+}
+interface WorkspaceLogger {
+    debug?(message: string, details?: unknown): void;
+    info?(message: string, details?: unknown): void;
+    warn?(message: string, details?: unknown): void;
+    error?(message: string, details?: unknown): void;
+}
+interface CreateWorkspaceOptions {
+    rootPath: string;
+    logger?: WorkspaceLogger;
+    format?: {
+        prettier?: boolean;
+    };
+}
+interface SaveNoteInput {
+    noteUuid: string;
+    content: string;
+    expectedRevision: string;
+    prettier?: boolean;
+}
+type NotePlacement = {
+    type: 'root';
+    placement?: 'start' | 'end';
+} | {
+    type: 'note';
+    targetNoteUuid: string;
+    placement: 'before' | 'after' | 'inside';
+} | {
+    type: 'folder';
+    folderPath: string[];
+    placement: 'before' | 'after' | 'inside';
+};
+interface CreateNoteInput {
+    title: string;
+    placement?: NotePlacement;
+    config?: Partial<Pick<WorkspaceNoteConfig, 'description' | 'enableDiscussions'>>;
+    expectedSnapshotRevision?: string;
+}
+interface RenameNoteInput {
+    noteUuid: string;
+    title: string;
+    expectedRevision: string;
+}
+interface UpdateNoteConfigInput {
+    noteUuid: string;
+    updates: Partial<Pick<WorkspaceNoteConfig, 'done' | 'description' | 'enableDiscussions'>>;
+    expectedRevision: string;
+}
+type TocEntryRef = {
+    type: 'note';
+    noteUuid: string;
+} | {
+    type: 'folder';
+    folderPath: string[];
+} | {
+    type: 'line';
+    tocLineIndex: number;
+};
+interface MoveTocEntryInput {
+    source: TocEntryRef;
+    target: TocEntryRef;
+    placement: 'before' | 'after' | 'inside';
+    expectedSnapshotRevision: string;
+}
+interface CreateTocGroupInput {
+    title: string;
+    placement?: NotePlacement;
+    expectedSnapshotRevision: string;
+}
+interface RenameTocGroupInput {
+    folderPath: string[];
+    title: string;
+    expectedSnapshotRevision: string;
+}
+interface DeletePreviewItem {
+    noteUuid: string;
+    index: string;
+    title: string;
+    directoryPath: string;
+}
+interface DeleteTocEntryPreview {
+    entry: TocEntryRef;
+    notes: DeletePreviewItem[];
+    filePaths: string[];
+    directoryPaths: string[];
+    snapshotRevision: string;
+}
+interface DeleteTocEntryInput {
+    entry: TocEntryRef;
+    expectedSnapshotRevision: string;
+}
+interface WriteAttachmentInput {
+    noteUuid: string;
+    fileName: string;
+    data: Uint8Array;
+}
+interface AttachmentResult {
+    absolutePath: string;
+    markdownPath: string;
+}
+interface TNotesWorkspace {
+    inspect(): Promise<KnowledgeBaseSnapshot>;
+    refresh(): Promise<KnowledgeBaseSnapshot>;
+    reconcileTocCompletion(): Promise<MutationResult<KnowledgeBaseSnapshot>>;
+    notes: {
+        read(noteUuid: string): Promise<NoteDocument>;
+        save(input: SaveNoteInput): Promise<MutationResult<NoteDocument>>;
+        create(input: CreateNoteInput): Promise<MutationResult<NoteDocument>>;
+        rename(input: RenameNoteInput): Promise<MutationResult<NoteDocument>>;
+        updateConfig(input: UpdateNoteConfigInput): Promise<MutationResult<NoteDocument>>;
+    };
+    toc: {
+        move(input: MoveTocEntryInput): Promise<MutationResult<KnowledgeBaseSnapshot>>;
+        createGroup(input: CreateTocGroupInput): Promise<MutationResult<KnowledgeBaseSnapshot>>;
+        renameGroup(input: RenameTocGroupInput): Promise<MutationResult<KnowledgeBaseSnapshot>>;
+        previewDelete(entry: TocEntryRef): Promise<DeleteTocEntryPreview>;
+        deleteEntry(input: DeleteTocEntryInput): Promise<MutationResult<KnowledgeBaseSnapshot>>;
+        setDone(input: UpdateNoteConfigInput): Promise<MutationResult<NoteDocument>>;
+    };
+    attachments: {
+        writeLocal(input: WriteAttachmentInput): Promise<MutationResult<AttachmentResult>>;
+    };
+    dispose(): Promise<void>;
+}
+
+export type { AttachmentResult as A, CreateWorkspaceOptions as C, DeletePreviewItem as D, KnowledgeBaseSnapshot as K, MoveTocEntryInput as M, NoteDocument as N, RenameNoteInput as R, SaveNoteInput as S, TNotesWorkspace as T, UpdateNoteConfigInput as U, WorkspaceDiagnostic as W, ChangedFile as a, CreateNoteInput as b, CreateTocGroupInput as c, DeleteTocEntryInput as d, DeleteTocEntryPreview as e, MutationResult as f, NotePlacement as g, RenameTocGroupInput as h, TocEntryRef as i, WorkspaceHealth as j, WorkspaceKnowledgeBaseConfig as k, WorkspaceLogger as l, WorkspaceNoteConfig as m, WorkspaceNoteSummary as n, WriteAttachmentInput as o };