@openvulcan/dsh-vulcancode 0.0.0-stage → 0.4.0

package/node_modules/@openvulcan/dsh-vulcan-answers/lib/answer-model.d.ts

@@ -0,0 +1,258 @@
+/**
+ * Parsed `ui-*` answer component fences. Parsing is pure and total: a fence that does not match its
+ * documented syntax returns null, so the caller leaves dsh's ordinary code block in place. The syntax
+ * authority is `assets/prompts/answer-mode-interactive.md`.
+ *
+ * Ported from VulcanCode `apps/vulcan-code-web/src/components/conversation/answer-components/answer-component-model.ts`.
+ * `ui-code` (needs the host's answer-time file capture) and `ui-gallery` (needs local image access) are
+ * not offered in dsh, so their fences parse as null and stay ordinary code.
+ */
+/** Tone words that may start a cell. */
+export type AnswerTone = 'ok' | 'warn' | 'no';
+/** Checklist status: a tone or an open item. */
+export type AnswerStatus = AnswerTone | 'todo';
+/** Finding severity. `ok` is not in the prompt; models write it for a resolved or healthy item. */
+export type AnswerSeverity = 'high' | 'medium' | 'low' | 'info' | 'ok';
+/** Plan step status. */
+export type AnswerStepStatus = 'done' | 'now' | 'todo';
+/** Callout tones. */
+export type AnswerCalloutTone = 'info' | 'success' | 'warning' | 'danger';
+/** Plan marker on a tree node, flow node, flow chain or sequence message. */
+export type AnswerMark = 'add' | 'del' | 'chg';
+/** A cell that may start with a tone word; `text` is empty when the cell is only the tone word. */
+export interface AnswerTonedText {
+    tone?: AnswerTone | undefined;
+    text: string;
+}
+/** One metric; `maximum` enables a meter, and `over` marks a value above it. */
+export interface AnswerMetric {
+    label: string;
+    value: string;
+    numeric?: number | undefined;
+    maximum?: number | undefined;
+    over?: boolean | undefined;
+    unit?: string | undefined;
+    tone?: AnswerTone | undefined;
+}
+/** Key flags of an entity field. */
+export type AnswerErKey = 'PK' | 'FK' | 'UK';
+/** One entity field; `target` indexes the referenced table. */
+export interface AnswerErField {
+    name: string;
+    type?: string | undefined;
+    keys: AnswerErKey[];
+    target?: number | undefined;
+    note?: string | undefined;
+    mark?: AnswerMark | undefined;
+}
+/** One entity (table) with its fields. */
+export interface AnswerErTable {
+    name: string;
+    note?: string | undefined;
+    mark?: AnswerMark | undefined;
+    fields: AnswerErField[];
+}
+/** One symbol of a formula legend. */
+export interface AnswerMathSymbol {
+    symbol: string;
+    meaning: string;
+}
+/** One option of a decision; `recommended` marks the option the answer would pick. */
+export interface AnswerDecisionOption {
+    label: string;
+    note?: string | undefined;
+    recommended: boolean;
+}
+/** One tree node with its nested children. */
+export interface AnswerTreeNode {
+    label: string;
+    note?: string | undefined;
+    mark?: AnswerMark | undefined;
+    children: AnswerTreeNode[];
+}
+/**
+ * One changed file. Either line count may be missing when the row names only one side (`+145`); `status` is a
+ * change label such as `new` written in place of the counts.
+ */
+export interface AnswerFile {
+    path: string;
+    added?: number | undefined;
+    removed?: number | undefined;
+    status?: string | undefined;
+    note?: string | undefined;
+}
+/** Chart layouts accepted after `ui-chart`. */
+export type AnswerChartKind = 'bar' | 'hbar' | 'stack' | 'line' | 'area' | 'pie' | 'donut';
+/** Chart data: series names and one row of values per category. */
+export interface AnswerChart {
+    kind: AnswerChartKind;
+    title?: string | undefined;
+    categoryLabel: string;
+    series: string[];
+    rows: {
+        category: string;
+        values: number[];
+    }[];
+}
+/** Titled Markdown section of `ui-tabs` or `ui-columns`. */
+export interface AnswerSection {
+    title: string;
+    body: string;
+}
+/** Flow node outline. */
+export type AnswerFlowShape = 'box' | 'decision' | 'terminal' | 'store';
+/** One distinct flow node; the same label is the same node. */
+export interface AnswerFlowNode {
+    label: string;
+    shape: AnswerFlowShape;
+    mark?: AnswerMark | undefined;
+}
+/** One source line of a flow: node groups joined by hops; `label` names the last hop only. */
+export interface AnswerFlowChain {
+    groups: number[][];
+    dashed: boolean[];
+    label?: string | undefined;
+    mark?: AnswerMark | undefined;
+}
+/** One sequence row. */
+export type AnswerSequenceStep = {
+    kind: 'phase';
+    text: string;
+} | {
+    kind: 'note';
+    first: number;
+    last: number;
+    text: string;
+} | {
+    kind: 'message';
+    from: number;
+    to: number;
+    dashed: boolean;
+    text: string;
+    mark?: AnswerMark | undefined;
+};
+/** Every renderable component; row components may carry a heading written after their name. */
+export type AnswerComponent = AnswerComponentBody & {
+    heading?: string | undefined;
+};
+/** Every renderable component without its heading. */
+export type AnswerComponentBody = {
+    kind: 'kv';
+    rows: {
+        label: string;
+        value: string;
+        note?: string | undefined;
+    }[];
+} | {
+    kind: 'metrics';
+    rows: AnswerMetric[];
+} | {
+    kind: 'findings';
+    rows: {
+        severity: AnswerSeverity;
+        text: string;
+        location?: string | undefined;
+        note?: string | undefined;
+    }[];
+} | {
+    kind: 'compare';
+    header: string[];
+    rows: {
+        criterion: string;
+        cells: AnswerTonedText[];
+    }[];
+} | {
+    kind: 'checklist';
+    items: {
+        status: AnswerStatus;
+        item: string;
+        note?: string | undefined;
+        location?: string | undefined;
+    }[];
+} | {
+    kind: 'steps';
+    steps: {
+        status: AnswerStepStatus;
+        title: string;
+        text?: string | undefined;
+    }[];
+} | {
+    kind: 'timeline';
+    rows: {
+        time: string;
+        title: string;
+        text?: string | undefined;
+    }[];
+} | {
+    kind: 'cards';
+    cards: {
+        title: string;
+        text: string;
+        tag?: AnswerTonedText | undefined;
+    }[];
+} | {
+    kind: 'files';
+    files: AnswerFile[];
+    added: number;
+    removed: number;
+} | {
+    kind: 'tree';
+    nodes: AnswerTreeNode[];
+} | {
+    kind: 'chart';
+    chart: AnswerChart;
+} | {
+    kind: 'flow';
+    horizontal: boolean;
+    nodes: AnswerFlowNode[];
+    chains: AnswerFlowChain[];
+} | {
+    kind: 'sequence';
+    numbered: boolean;
+    actors: string[];
+    steps: AnswerSequenceStep[];
+} | {
+    kind: 'er';
+    horizontal: boolean;
+    tables: AnswerErTable[];
+} | {
+    kind: 'math';
+    title?: string | undefined;
+    equations: string[];
+    symbols: AnswerMathSymbol[];
+} | {
+    kind: 'decision';
+    multiple: boolean;
+    question: string;
+    options: AnswerDecisionOption[];
+} | {
+    kind: 'callout';
+    tone: AnswerCalloutTone;
+    title?: string | undefined;
+    body: string;
+} | {
+    kind: 'details';
+    title: string;
+    body: string;
+} | {
+    kind: 'tabs' | 'columns';
+    sections: AnswerSection[];
+};
+/** Fence languages this plugin renders; any other `ui-*` fence stays ordinary code. */
+export declare const SUPPORTED_ANSWER_LANGUAGES: ReadonlySet<string>;
+/**
+ * Parse one fence; `language` is `ui-<name>`, `meta` the rest of the info string, `body` the text.
+ * Returns null for unknown or unsupported names and for invalid syntax.
+ */
+export declare function parseAnswerComponent(language: string, meta: string, body: string): AnswerComponent | null;
+/**
+ * Split one row into trimmed cells; outer pipes are optional and `\|` is a literal pipe. `lenient` also
+ * keeps pipes inside balanced backtick code and pipes touching text on both sides (`fetch|iex`) as literal.
+ */
+export declare function answerCells(line: string, lenient?: boolean): string[];
+/**
+ * The file path of a path-shaped location such as `src/a.rs:42`, or null for prose: only a token without
+ * spaces or full-width punctuation and with a separator or an extension is a file. The `:line` or
+ * `:line:column` suffix is stripped.
+ */
+export declare function answerLocationPath(location: string): string | null;