opencode-novel 0.0.1

package/dist/tools/novel-export/types.d.ts

@@ -0,0 +1,109 @@
+import type { Diagnostic } from "../../shared/errors/diagnostics";
+export type NovelExportFormat = "md" | "html" | "epub" | "docx";
+export type NovelChapterOrder = "by_id" | "by_timeline" | "custom";
+export type NovelDocxTemplate = "default" | "manuscript";
+export type NovelExportPreflightCheck = "index" | "continuity" | "foreshadowing" | "style" | "structure" | "scene" | "arc" | "pacing";
+export type NovelExportPreflightFailOn = "error" | "warn";
+export type NovelExportArgs = {
+    rootDir?: string;
+    manuscriptDir?: string;
+    format?: NovelExportFormat;
+    outputDir?: string;
+    title?: string;
+    chapterOrder?: NovelChapterOrder;
+    customOrder?: string[];
+    includeFrontmatter?: boolean;
+    writeFile?: boolean;
+    docxTemplate?: NovelDocxTemplate;
+    preflight?: boolean;
+    preflightChecks?: NovelExportPreflightCheck[];
+    preflightFailOn?: NovelExportPreflightFailOn;
+};
+export type NovelExportPreflightSummary = {
+    enabled: boolean;
+    blocked: boolean;
+    checks: NovelExportPreflightCheck[];
+    failOn: NovelExportPreflightFailOn;
+    stats: {
+        errors: number;
+        warns: number;
+        infos: number;
+    };
+    reports: {
+        indexOutputDir?: string;
+        continuityReportPath?: string;
+        foreshadowingReportPath?: string;
+        styleReportPath?: string;
+        structureReportPath?: string;
+        sceneReportPath?: string;
+        arcReportPath?: string;
+        pacingReportPath?: string;
+    };
+};
+export type NovelExportManifest = {
+    version: 1;
+    title: string;
+    formats: NovelExportFormat[];
+    chapterOrder: NovelChapterOrder;
+    includeFrontmatter: boolean;
+    docxTemplate?: NovelDocxTemplate;
+    preflight?: {
+        enabled: boolean;
+        blocked: boolean;
+        failOn: NovelExportPreflightFailOn;
+        checks: NovelExportPreflightCheck[];
+    };
+    chapters: Array<{
+        chapter_id: string;
+        path: string;
+        title?: string;
+        contentSha256: string;
+    }>;
+    outputs: Array<{
+        format: NovelExportFormat;
+        outputPath: string;
+        contentSha256: string;
+    }>;
+};
+export type NovelExportResultJsonV1 = {
+    version: 1;
+    format: NovelExportFormat;
+    outputPath?: string;
+    manifestPath?: string;
+    docxTemplate?: NovelDocxTemplate;
+    chapters: {
+        chapter_id: string;
+        title?: string;
+        path: string;
+    }[];
+    stats: {
+        chapters: number;
+        durationMs: number;
+    };
+    preflight?: NovelExportPreflightSummary;
+    nextSteps?: string[];
+    diagnostics: Diagnostic[];
+};
+export type NovelExportResultJsonV2 = {
+    version: 2;
+    formats: NovelExportFormat[];
+    outputs: {
+        format: NovelExportFormat;
+        outputPath?: string;
+    }[];
+    manifestPath?: string;
+    docxTemplate?: NovelDocxTemplate;
+    chapters: {
+        chapter_id: string;
+        title?: string;
+        path: string;
+    }[];
+    stats: {
+        chapters: number;
+        durationMs: number;
+    };
+    preflight?: NovelExportPreflightSummary;
+    nextSteps?: string[];
+    diagnostics: Diagnostic[];
+};
+export type NovelExportResultJson = NovelExportResultJsonV1 | NovelExportResultJsonV2;

package/dist/tools/novel-foreshadowing-audit/index.d.ts

@@ -0,0 +1,2 @@
+export { createNovelForeshadowingAuditTool } from "./tool";
+export type { NovelForeshadowingArgs, NovelForeshadowingResultJson, ThreadAuditItem, } from "./types";

package/dist/tools/novel-foreshadowing-audit/render.d.ts

@@ -0,0 +1,5 @@
+import type { ThreadAuditItem } from "./types";
+export declare function renderForeshadowingAuditMd(options: {
+    items: ThreadAuditItem[];
+    stats: Record<string, number>;
+}): string;

package/dist/tools/novel-foreshadowing-audit/tool.d.ts

@@ -0,0 +1,6 @@
+import { type ToolDefinition } from "@opencode-ai/plugin";
+import type { NovelConfig } from "../../config/schema";
+export declare function createNovelForeshadowingAuditTool(deps: {
+    projectRoot: string;
+    config: NovelConfig;
+}): ToolDefinition;

package/dist/tools/novel-foreshadowing-audit/types.d.ts

@@ -0,0 +1,40 @@
+import type { Diagnostic, DiagnosticEvidence } from "../../shared/errors/diagnostics";
+export type NovelForeshadowingArgs = {
+    rootDir?: string;
+    manuscriptDir?: string;
+    outputDir?: string;
+    writeReport?: boolean;
+    strictMode?: boolean;
+};
+export type ThreadAuditItem = {
+    thread_id: string;
+    path: string;
+    type?: string;
+    status?: string;
+    opened_in?: string;
+    expected_close_by?: string;
+    closed_in?: string | null;
+    issues: {
+        severity: "error" | "warn" | "info";
+        code: string;
+        message: string;
+        evidence?: DiagnosticEvidence[];
+        suggestedFix?: string;
+        repro?: string;
+    }[];
+    suggestedNextStep?: string;
+};
+export type NovelForeshadowingResultJson = {
+    version: 1;
+    reportPath?: string;
+    stats: {
+        open: number;
+        in_progress: number;
+        closed: number;
+        abandoned: number;
+        durationMs: number;
+    };
+    items: ThreadAuditItem[];
+    nextSteps?: string[];
+    diagnostics: Diagnostic[];
+};

package/dist/tools/novel-graph/index.d.ts

@@ -0,0 +1,2 @@
+export { createNovelGraphTool } from "./tool";
+export type { NovelGraphArgs, NovelGraphKind, NovelGraphResultJson } from "./types";

package/dist/tools/novel-graph/render.d.ts

@@ -0,0 +1,5 @@
+export declare function renderMermaidGraphTd(options: {
+    title: string;
+    nodes: string[];
+    edges: string[];
+}): string;

package/dist/tools/novel-graph/tool.d.ts

@@ -0,0 +1,6 @@
+import { type ToolDefinition } from "@opencode-ai/plugin";
+import type { NovelConfig } from "../../config/schema";
+export declare function createNovelGraphTool(deps: {
+    projectRoot: string;
+    config: NovelConfig;
+}): ToolDefinition;

package/dist/tools/novel-graph/types.d.ts

@@ -0,0 +1,21 @@
+import type { Diagnostic } from "../../shared/errors/diagnostics";
+export type NovelGraphKind = "relationships" | "factions";
+export type NovelGraphArgs = {
+    rootDir?: string;
+    manuscriptDir?: string;
+    outputDir?: string;
+    kind: NovelGraphKind;
+    writeFile?: boolean;
+    preferExplicitRelations?: boolean;
+    cooccurrenceMinWeight?: number;
+};
+export type NovelGraphResultJson = {
+    version: 1;
+    kind: NovelGraphKind;
+    graphPath?: string;
+    stats: {
+        nodes: number;
+        edges: number;
+    };
+    diagnostics: Diagnostic[];
+};

package/dist/tools/novel-import/index.d.ts

@@ -0,0 +1,2 @@
+export { createNovelImportTool } from "./tool";
+export type { ImportMapItem, NovelImportArgs, NovelImportMode, NovelImportResultJson, } from "./types";

package/dist/tools/novel-import/tool.d.ts

@@ -0,0 +1,7 @@
+import { type ToolDefinition } from "@opencode-ai/plugin";
+import type { NovelConfig } from "../../config/schema";
+/** 创建小说导入工具定义。 */
+export declare function createNovelImportTool(deps: {
+    projectRoot: string;
+    config: NovelConfig;
+}): ToolDefinition;

package/dist/tools/novel-import/types.d.ts

@@ -0,0 +1,47 @@
+import type { Diagnostic } from "../../shared/errors/diagnostics";
+import type { TextEncoding } from "../../shared/strings/text-encoding";
+export type NovelImportMode = "copy" | "analyze";
+export type NovelImportArgs = {
+    rootDir?: string;
+    fromDir?: string;
+    mode?: NovelImportMode;
+    manuscriptDir?: string;
+    encoding?: TextEncoding;
+    includeGlobs?: string[];
+    excludeGlobs?: string[];
+    writeConfigJsonc?: boolean;
+    writeReport?: boolean;
+};
+export type ImportMapItem = {
+    chapter_id: string;
+    title?: string;
+    source_path: string;
+    source_type: "md" | "txt";
+    source_heading_line: number;
+    source_range: {
+        startLine: number;
+        endLine: number;
+    };
+    output_path: string;
+    warnings?: string[];
+};
+export type NovelImportResultJson = {
+    version: 1;
+    mode: NovelImportMode;
+    fromDir: string;
+    manuscriptDir: string;
+    writtenChapters: string[];
+    conflicts: {
+        chapter_id: string;
+        existing: string;
+        written: string;
+    }[];
+    unclassified: {
+        source_path: string;
+        reason: string;
+    }[];
+    reportPath?: string;
+    importMapPath?: string;
+    nextSteps?: string[];
+    diagnostics: Diagnostic[];
+};

package/dist/tools/novel-index/index.d.ts

@@ -0,0 +1,2 @@
+export { createNovelIndexTool } from "./tool";
+export type { NovelIndexArgs, NovelIndexResultJson } from "./types";

package/dist/tools/novel-index/render.d.ts

@@ -0,0 +1,35 @@
+import type { ChapterEntity, CharacterEntity, ThreadEntity } from "../novel-scan/types";
+export declare function renderIndexMd(options: {
+    chapters: ChapterEntity[];
+    characters: CharacterEntity[];
+    threads: Array<ThreadEntity & {
+        opened_in?: string;
+        expected_close_by?: string;
+        closed_in?: string | null;
+    }>;
+    factions: Array<{
+        id: string;
+        name?: string;
+        appearances: number;
+    }>;
+    locations: Array<{
+        id: string;
+        name?: string;
+        appearances: number;
+    }>;
+    characterAppearances: Map<string, {
+        count: number;
+        first?: string;
+        last?: string;
+    }>;
+}): string;
+export declare function renderTimelineMd(options: {
+    chapters: ChapterEntity[];
+}): string;
+export declare function renderThreadsReportMd(options: {
+    threads: Array<ThreadEntity & {
+        opened_in?: string;
+        expected_close_by?: string;
+        closed_in?: string | null;
+    }>;
+}): string;

package/dist/tools/novel-index/tool.d.ts

@@ -0,0 +1,6 @@
+import { type ToolDefinition } from "@opencode-ai/plugin";
+import type { NovelConfig } from "../../config/schema";
+export declare function createNovelIndexTool(deps: {
+    projectRoot: string;
+    config: NovelConfig;
+}): ToolDefinition;

package/dist/tools/novel-index/types.d.ts

@@ -0,0 +1,41 @@
+import type { Diagnostic } from "../../shared/errors/diagnostics";
+export type NovelIndexArgs = {
+    rootDir?: string;
+    manuscriptDir?: string;
+    outputDir?: string;
+    writeDerivedFiles?: boolean;
+    forceWrite?: boolean;
+    scanMode?: "full" | "incremental";
+    writeCache?: boolean;
+};
+export type NovelIndexResultJson = {
+    version: 1;
+    generatedAt: string;
+    scanScope: {
+        manuscriptDir: string;
+        mode: "full" | "incremental";
+    };
+    outputDir: string;
+    writtenFiles: string[];
+    skippedFiles: string[];
+    stats: {
+        chapters: number;
+        characters: number;
+        threads: number;
+        durationMs: number;
+        scan: {
+            filesScanned: number;
+            durationMs: number;
+            cache: {
+                mode: "full" | "incremental";
+                loaded: boolean;
+                written: boolean;
+                fastHits: number;
+                hashHits: number;
+                misses: number;
+            };
+        };
+    };
+    nextSteps?: string[];
+    diagnostics: Diagnostic[];
+};

package/dist/tools/novel-outline/index.d.ts

@@ -0,0 +1,2 @@
+export { createNovelOutlineTool } from "./tool";
+export type { NovelOutlineArgs, NovelOutlineMode, NovelOutlineResultJson, OutlineAct, OutlineBeat, OutlineJson, } from "./types";

package/dist/tools/novel-outline/tool.d.ts

@@ -0,0 +1,6 @@
+import { type ToolDefinition } from "@opencode-ai/plugin";
+import type { NovelConfig } from "../../config/schema";
+export declare function createNovelOutlineTool(deps: {
+    projectRoot: string;
+    config: NovelConfig;
+}): ToolDefinition;

package/dist/tools/novel-outline/types.d.ts

@@ -0,0 +1,37 @@
+import type { Diagnostic } from "../../shared/errors/diagnostics";
+export type NovelOutlineMode = "three_act" | "beat_sheet";
+export type NovelOutlineArgs = {
+    rootDir?: string;
+    title: string;
+    mode?: NovelOutlineMode;
+    acts?: number;
+    outputPath?: string;
+    writeFile?: boolean;
+};
+export type OutlineBeat = {
+    beat_id: string;
+    label: string;
+    goal: string;
+    risk: string;
+    expectedChapterSpan: string;
+};
+export type OutlineAct = {
+    act: number;
+    purpose: string;
+    conflictUpgrade: string;
+    beats: OutlineBeat[];
+};
+export type OutlineJson = {
+    title: string;
+    mode: NovelOutlineMode;
+    generatedAt: string;
+    requiredBeats: string[];
+    acts: OutlineAct[];
+    processChecklist: string[];
+};
+export type NovelOutlineResultJson = {
+    version: 1;
+    outlinePath?: string;
+    outlineJson: OutlineJson;
+    diagnostics: Diagnostic[];
+};

package/dist/tools/novel-scaffold/index.d.ts

@@ -0,0 +1,2 @@
+export { createNovelScaffoldTool } from "./tool";
+export type { NovelScaffoldArgs, NovelScaffoldResultJson } from "./types";

package/dist/tools/novel-scaffold/scaffold.d.ts

@@ -0,0 +1,18 @@
+import type { NovelConfig } from "../../config/schema";
+import type { Diagnostic } from "../../shared/errors/diagnostics";
+export declare function ensureNovelScaffold(options: {
+    rootDir: string;
+    manuscriptDirName: string;
+    config: NovelConfig;
+    bookTitle?: string;
+    writeConfigJsonc?: boolean;
+    writeTemplates?: boolean;
+    forceOverwriteTemplates?: boolean;
+}): {
+    manuscriptDir: string;
+    createdDirs: string[];
+    writtenFiles: string[];
+    skippedExisting: string[];
+    configPath?: string;
+    diagnostics: Diagnostic[];
+};

package/dist/tools/novel-scaffold/templates.d.ts

@@ -0,0 +1,5 @@
+export declare function createWorldTemplate(bookTitle?: string): string;
+export declare const RULES_TEMPLATE = "# \u89C4\u5219\u6761\u6B3E\uFF08Rules\uFF09\n\n## \u89C4\u5219\u6761\u6B3E\n1. R-001\uFF1A\u2026\u2026\n2. R-002\uFF1A\u2026\u2026\n";
+export declare const GLOSSARY_TEMPLATE = "# \u540D\u8BCD\u8868\uFF08Glossary\uFF09\n\n- \u8BCD\u6761\uFF1A\u89E3\u91CA\n";
+export declare const CHARACTERS_README_TEMPLATE = "# \u89D2\u8272\u76EE\u5F55\u8BF4\u660E\n\n\u6BCF\u4E2A\u89D2\u8272\u4E00\u4E2A\u6587\u4EF6\uFF1A`<id>.md`\uFF0C\u5EFA\u8BAE\u5305\u542B frontmatter\uFF1A\n\n- id\uFF08\u5FC5\u586B\uFF09\n- name / alias\n- motivation / desire\n- arc\uFF08\u9636\u6BB5\u4E0E\u8F6C\u6298\uFF09\n- voice\uFF08\u53E3\u7656/\u53E5\u5F0F/\u7981\u7528\u8BCD\uFF09\n- relationships\uFF08\u5173\u7CFB\uFF09\n";
+export declare const THREADS_README_TEMPLATE = "# \u7EBF\u7A0B\u76EE\u5F55\u8BF4\u660E\n\n\u6BCF\u4E2A\u4F0F\u7B14/\u627F\u8BFA\u4E00\u4E2A\u6587\u4EF6\uFF1A`<thread_id>.md`\uFF0C\u5EFA\u8BAE\u5305\u542B frontmatter\uFF1A\n\n- thread_id\uFF08\u5FC5\u586B\uFF09\n- type / status\n- opened_in / expected_close_by / close_plan / closed_in\n";

package/dist/tools/novel-scaffold/tool.d.ts

@@ -0,0 +1,6 @@
+import { type ToolDefinition } from "@opencode-ai/plugin";
+import type { NovelConfig } from "../../config/schema";
+export declare function createNovelScaffoldTool(deps: {
+    projectRoot: string;
+    config: NovelConfig;
+}): ToolDefinition;

package/dist/tools/novel-scaffold/types.d.ts

@@ -0,0 +1,19 @@
+import type { Diagnostic } from "../../shared/errors/diagnostics";
+export type NovelScaffoldArgs = {
+    rootDir?: string;
+    manuscriptDir?: string;
+    bookTitle?: string;
+    writeConfigJsonc?: boolean;
+    writeTemplates?: boolean;
+    forceOverwriteTemplates?: boolean;
+};
+export type NovelScaffoldResultJson = {
+    version: 1;
+    manuscriptDir: string;
+    createdDirs: string[];
+    writtenFiles: string[];
+    skippedExisting: string[];
+    configPath?: string;
+    nextSteps?: string[];
+    diagnostics: Diagnostic[];
+};

package/dist/tools/novel-scan/helpers.d.ts

@@ -0,0 +1,88 @@
+import type { Diagnostic } from "../../shared/errors/diagnostics";
+import type { ChapterEntity, ChapterSceneEntity, ChapterStructureEntity, CharacterEntity, FactionEntity, LocationEntity, NovelFileHash, ScanCacheV1, ThreadEntity } from "./types";
+export type CachedMaps = {
+    fileByPath: Map<string, NovelFileHash>;
+    chapterByPath: Map<string, ChapterEntity>;
+    characterByPath: Map<string, CharacterEntity>;
+    threadByPath: Map<string, ThreadEntity>;
+    factionByPath: Map<string, FactionEntity>;
+    locationByPath: Map<string, LocationEntity>;
+    perFileDiagnostics: Map<string, Diagnostic[]>;
+};
+export type EntityMarkdownFiles = {
+    chapterFiles: string[];
+    characterFiles: string[];
+    threadFiles: string[];
+    factionFiles: string[];
+    locationFiles: string[];
+};
+/** 递归列出目录下的 Markdown 文件，并按稳定顺序排序。 */
+export declare function listMarkdownFiles(dir: string, options?: {
+    sortLocale?: string;
+}): string[];
+/** 解析 manuscript 标准实体目录并返回对应 Markdown 文件列表。 */
+export declare function listEntityMarkdownFiles(manuscriptDir: string, options?: {
+    sortLocale?: string;
+}): EntityMarkdownFiles;
+/** 对 manuscript 根目录下的未知一级目录输出诊断信息。 */
+export declare function reportUnknownManuscriptDirs(options: {
+    manuscriptDir: string;
+    rootDir: string;
+    diagnostics: Diagnostic[];
+}): void;
+/** 读取并校验增量扫描缓存。 */
+export declare function loadScanCache(cachePath: string): ScanCacheV1 | null;
+/** 基于扫描缓存构建快速查找映射。 */
+export declare function buildCachedMaps(cache: ScanCacheV1 | null): CachedMaps;
+/** 校验实体集合中的重复 ID。 */
+export declare function validateUniqueness(diagnostics: Diagnostic[], items: Array<{
+    id: string;
+    path: string;
+}>, code: string): void;
+/** 编译配置中的命名正则，并在无效时输出诊断。 */
+export declare function compileNamingPattern(options: {
+    diagnostics: Diagnostic[];
+    kind: string;
+    pattern: string;
+    strictMode: boolean;
+}): RegExp | null;
+/** 使用配置命名规则校验实体 ID。 */
+export declare function validateIdAgainstPattern(options: {
+    diagnostics: Diagnostic[];
+    kind: string;
+    id: string;
+    file: string;
+    pattern: RegExp | null;
+    patternSource: string;
+    strictMode: boolean;
+}): void;
+/** 将未知数组值转换为字符串数组。 */
+export declare function toStringArray(value: unknown): string[] | undefined;
+/** 从 frontmatter 解析章节结构元数据。 */
+export declare function parseChapterStructure(options: {
+    raw: unknown;
+    file: string;
+    strictMode: boolean;
+    diagnostics: Diagnostic[];
+}): ChapterStructureEntity | undefined;
+export type SceneFieldName = keyof Pick<ChapterSceneEntity, "scene_id" | "objective" | "conflict" | "outcome" | "hook">;
+/** 解析章节 scenes 元数据并输出场景级诊断。 */
+export declare function parseChapterScenes(options: {
+    raw: unknown;
+    file: string;
+    strictMode: boolean;
+    requiredFields: Set<SceneFieldName>;
+    diagnostics: Diagnostic[];
+}): ChapterSceneEntity[] | undefined;
+/** 基于已定义实体 ID 校验章节中的跨实体引用。 */
+export declare function validateChapterReferences(options: {
+    diagnostics: Diagnostic[];
+    chapters: ChapterEntity[];
+    strictMode: boolean;
+    definedCharacters: Set<string>;
+    definedThreads: Set<string>;
+    definedFactions: Set<string>;
+    definedLocations: Set<string>;
+}): void;
+/** 判断值是否为普通对象（排除数组）。 */
+export declare function isPlainObject(value: unknown): value is Record<string, unknown>;

package/dist/tools/novel-scan/index.d.ts

@@ -0,0 +1,3 @@
+export { loadOrScan, scanNovelProject } from "./scan";
+export { createNovelScanTool } from "./tool";
+export type { ChapterEntity, CharacterEntity, FactionEntity, LocationEntity, NovelFileHash, NovelScanArgs, NovelScanMode, NovelScanResultJson, ScanCacheV1, ThreadEntity, } from "./types";

package/dist/tools/novel-scan/scan.d.ts

@@ -0,0 +1,17 @@
+import type { NovelConfig } from "../../config/schema";
+import type { NovelScanArgs, NovelScanResultJson, ScanCacheV1 } from "./types";
+/** 扫描 manuscript 实体、校验引用关系，并持久化增量缓存。 */
+export declare function scanNovelProject(deps: {
+    projectRoot: string;
+    config: NovelConfig;
+    args: NovelScanArgs;
+}): {
+    result: NovelScanResultJson;
+    cacheToWrite?: ScanCacheV1;
+};
+/** 加载增量扫描缓存或执行扫描，并返回标准化结果。 */
+export declare function loadOrScan(deps: {
+    projectRoot: string;
+    config: NovelConfig;
+    args?: Partial<NovelScanArgs>;
+}): NovelScanResultJson;

package/dist/tools/novel-scan/tool.d.ts

@@ -0,0 +1,6 @@
+import { type ToolDefinition } from "@opencode-ai/plugin";
+import type { NovelConfig } from "../../config/schema";
+export declare function createNovelScanTool(deps: {
+    projectRoot: string;
+    config: NovelConfig;
+}): ToolDefinition;