dsh-novel-write-engine 0.0.0-stage → 0.1.1

package/lib/types/client/dto.d.ts

@@ -0,0 +1,61 @@
+/** Wire DTOs of the panel route. Versioned so a stale tab can say "refresh". */
+export interface PhaseDto {
+    id: string;
+    done: boolean;
+    active: boolean;
+}
+export interface BlockingDto {
+    code: string;
+    scope?: string;
+    detail: string;
+    hint?: string;
+}
+export interface SummaryDto {
+    schemaVersion: number;
+    panelId: string;
+    title: string;
+    genre: string;
+    platform: string;
+    chapter: number;
+    stage: string;
+    revision: number;
+    totalWords: number;
+    totalChapters: number;
+    phases: PhaseDto[];
+    blocking: BlockingDto[];
+    next?: {
+        tool: string;
+        reason: string;
+    };
+    /** True only when the book target is reached; done alone means the chapter is archived. */
+    finished?: boolean;
+}
+export interface ChapterRowDto {
+    num: number;
+    title: string;
+    wordCount: number;
+    score: number;
+    stage: string;
+    status: 'passed' | 'blocked' | 'draft';
+    details?: string;
+}
+export interface ChaptersDto {
+    schemaVersion: number;
+    panelId: string;
+    rows: ChapterRowDto[];
+}
+export interface GatesDto {
+    schemaVersion: number;
+    panelId: string;
+    stage: string;
+    blocking: BlockingDto[];
+    explanations: string[];
+}
+export interface PanelPayloadDto {
+    schemaVersion: number;
+    summary: SummaryDto;
+    chapters: ChaptersDto;
+    gates: GatesDto;
+    error?: string;
+    empty?: true;
+}

package/lib/types/client/index.d.ts

@@ -0,0 +1,17 @@
+import { NovelIcon, NovelPanel } from './panel.js';
+/** The subset of the browser context this half needs; kept structural on purpose. */
+export interface ClientContext {
+    effect?: (body: () => undefined | (() => void), label?: string) => void;
+    slots: {
+        inject: (name: string, body: () => unknown) => unknown;
+        register: (options: Record<string, unknown>, component: (props: never) => unknown) => unknown;
+    };
+}
+export declare const name = "dsh-novel-write-engine";
+export declare const inject: string[];
+/**
+ * Register the sidebar entry and the main page. The sidebar id must equal the
+ * `main` key; that pairing is what makes the icon open this page.
+ */
+export declare function apply(ctx: ClientContext): void;
+export { NovelPanel, NovelIcon };

package/lib/types/client/panel.d.ts

@@ -0,0 +1,14 @@
+import { type ReactElement } from 'react';
+import { buildView, type PanelView } from './viewmodel.js';
+/**
+ * Pure view: given a view model, return the element tree. Keeping the hooks in
+ * `NovelPanel` makes every visual state renderable without a browser.
+ */
+export declare function panelElement(view: PanelView, loading: boolean, onRefresh: () => void): ReactElement;
+/** Stateful wrapper: fetch once, refresh on demand and after returning to the tab. */
+export declare function NovelPanel(): ReactElement;
+/** Sidebar icon: a small book mark, inheriting the current text colour. */
+export declare function NovelIcon({ size }: {
+    size?: number;
+}): ReactElement;
+export { buildView };

package/lib/types/client/viewmodel.d.ts

@@ -0,0 +1,66 @@
+import type { PanelPayloadDto } from './dto.js';
+/** One human-facing progress step. */
+export interface PanelPhase {
+    id: string;
+    label: string;
+    done: boolean;
+    active: boolean;
+}
+/** One archived or active chapter, projected for a card rather than a raw table row. */
+export interface PanelChapter {
+    num: string;
+    title: string;
+    words: string;
+    wordCount: number;
+    score: string;
+    scoreValue: number;
+    scorePercent: number;
+    badge: string;
+    tone: 'ok' | 'bad' | 'muted';
+    details: string;
+    stageLabel: string;
+}
+/** Everything the panel renders, derived from the wire payload alone. */
+export interface PanelView {
+    state: 'ready' | 'loading' | 'empty' | 'error' | 'outdated';
+    title: string;
+    subtitle: string;
+    stageLabel: string;
+    /** The whole book reached its configured target; stage `done` alone is only one chapter. */
+    finished: boolean;
+    revisionLabel: string;
+    phases: PanelPhase[];
+    rows: PanelChapter[];
+    blocking: Array<{
+        code: string;
+        scope: string;
+        detail: string;
+        hint: string;
+    }>;
+    blockingTitle: string;
+    stats: {
+        chapters: number;
+        words: number;
+        averageScore: number;
+        blocking: number;
+    };
+    nextTitle: string;
+    nextDetail: string;
+    nextTool: string;
+    emptyCommand: string;
+    /** Compatibility fields used by older cards and tests. */
+    revision: string;
+    next: string;
+}
+export declare const PANEL_SCHEMA_VERSION = 1;
+/**
+ * Project the wire payload into strings. Version mismatch wins over everything
+ * else: a stale panel must never render data from another schema as if it were
+ * current.
+ */
+export declare function buildView(payload: PanelPayloadDto | null, error?: string | null): PanelView;
+/** Fetch the panel payload; failures become a plain message, never a throw. */
+export declare function fetchPanel(fetcher: typeof fetch, path: string, signal?: AbortSignal): Promise<{
+    payload: PanelPayloadDto | null;
+    error: string | null;
+}>;

package/lib/types/constants.d.ts

@@ -0,0 +1,64 @@
+import type { Genre, Platform, SceneType, Stage } from './types.js';
+/** Panel and session identifiers. */
+export declare const PLUGIN_NAME = "dsh-novel-write-engine";
+export declare const PANEL_ID = "novel-workshop";
+export declare const PANEL_ROUTE = "/api/novel-write-engine/panel";
+export declare const SKILL_NAME = "novel-write-engine";
+export declare const REMOTE_VERSION = 1;
+/** Project-relative locations. Every write goes through these constants. */
+export declare const PROJECT_FILE = "novel.yaml";
+export declare const STATE_DIR = "state";
+export declare const CHAPTERS_DIR = "chapters";
+export declare const PLAN_DIR = "plans";
+export declare const REVIEW_DIR = "reviews";
+export declare const CHECK_DIR = "checks";
+export declare const EXPORT_DIR = "exports";
+export declare const BACKUP_DIR = "backups";
+export declare const OUTLINE_DIR = "outline";
+export declare const LOCK_FILE = ".engine.lock";
+export declare const STAGING_DIR = ".staging";
+export declare const REGISTRY_FILE = "projects.yaml";
+/** Files owned by the engine under `state/`. */
+export declare const STATE_FILES: {
+    readonly pipeline: "pipeline.yaml";
+    readonly chapters: "chapters.yaml";
+    readonly characters: "characters.yaml";
+    readonly world: "world.yaml";
+    readonly locks: "locks.yaml";
+    readonly timeline: "timeline.yaml";
+    readonly foreshadows: "foreshadows.yaml";
+    readonly relationships: "relationships.yaml";
+    readonly handoff: "handoff.yaml";
+    readonly journal: "journal.jsonl";
+};
+/** Chapter file name, zero padded to three digits. */
+export declare const chapterFile: (chapter: number) => string;
+/** Kept for reference when a rollback discards the current draft. */
+export declare const deprecatedChapterFile: (chapter: number) => string;
+export declare const planWorldFile: (chapter: number) => string;
+export declare const planChapterFile: (chapter: number) => string;
+export declare const reviewFile: (chapter: number) => string;
+export declare const checkFile: (chapter: number) => string;
+/** Limits that are structural, not taste. */
+export declare const LIMITS: {
+    /** P4 <-> P5/P6 retries before a forced rollback. */
+    maxRounds: number;
+    /** Lock staleness in milliseconds. */
+    lockStaleMs: number;
+    /** How long a writer waits for the keyed mutex before failing. */
+    lockWaitMs: number;
+    /** Reading proofs shorter than this cannot be verified. */
+    minQuoteChars: number;
+};
+/** Re-exported enums make adapter code readable without importing types twice. */
+export declare const SCENE_TYPE_DEFAULT: SceneType;
+export declare const DEFAULT_GENRE: Genre;
+export declare const DEFAULT_PLATFORM: Platform;
+export declare const INITIAL_STAGE: Stage;
+/** The order used to render the nine-phase progress strip. */
+export declare const PHASE_STRIP: readonly ["P1", "P2", "P3", "P4", "P5", "P6", "P7", "P8", "P9"];
+/** Tool names, kept here so the arch test can assert one namespace. */
+export declare const TOOL_NAMES: readonly ["novel_init", "novel_status", "novel_brief", "novel_plan_world", "novel_plan_chapter", "novel_write_draft", "novel_review", "novel_revise", "novel_check", "novel_archive", "novel_word_count", "novel_state", "novel_amend", "novel_rollback", "novel_diff", "novel_export", "novel_audit", "novel_pipeline"];
+export type ToolName = (typeof TOOL_NAMES)[number];
+/** The eight high-frequency tools kept when `tools.mode = core`. */
+export declare const CORE_TOOLS: readonly ToolName[];