@cardenelabs/dragon 0.8.0 → 0.9.0

package/dist/index.d.ts

@@ -439,6 +439,25 @@ type DslPhase = {
     sets?: DslSet[];
     body?: string;
     badge?: string;
+    /**
+     * その段で左の起点から描くもの (`draw: line`、 #1312)。
+     *
+     * 受ける語は今のところ `line` だけ。 折れ線 (`type: line`) の図で、その段の間に線が
+     * 左端から右へ伸び、点と値の数字は線の先が届いた時に現れる。
+     *
+     * **最上位ではなく段に置く**。 記法は動き (`tween` / `set` / `focus` / `badge`) を段に、
+     * 静的な性質 (`eyebrow` / `axes`) を最上位に書く分け方を既に持つ。 線が伸びるのは動き。
+     *
+     * 相手の名前は書かせない = 折れ線は図全体を 1 箱で描くため相手が 1 つに決まる。
+     */
+    draw?: string;
+    /**
+     * `draw` を書いた行 (#1312)。 知らせの行番号に使う。
+     *
+     * 段の `pos` は `- step:` の行を指すため、そこを使うと「段の 3 行目に書いた `draw` が
+     * 効かない」 を段の先頭行として知らせることになる。
+     */
+    drawPos?: Position;
     pos: Position;
 };
 /** state lerp (遷移) */
@@ -517,7 +536,7 @@ interface CompileToCdlOpts {
 }
 /** 図は出せるが書いた通りにならなかった、 という知らせ。 */
 type CompileNotice = {
-    kind: "relative-position-ignored" | "focus-target-missing" | "state-override-rejected" | "external-paint-dropped" | "part-not-drawn" | "scale-reserved" | "chart-value-unreadable" | "chart-edge-dropped" | "value-shadows-state" | "value-unresolved" | "value-duplicate" | "flow-actor-missing" | "value-trigger-unresolved" | "flow-self-loop" | "lane-not-honored" | "lane-declared-empty" | "eyebrow-not-honored" | "flow-endpoint-not-honored";
+    kind: "relative-position-ignored" | "focus-target-missing" | "state-override-rejected" | "external-paint-dropped" | "part-not-drawn" | "scale-reserved" | "chart-value-unreadable" | "chart-edge-dropped" | "value-shadows-state" | "value-unresolved" | "value-duplicate" | "flow-actor-missing" | "value-trigger-unresolved" | "flow-self-loop" | "lane-not-honored" | "lane-declared-empty" | "eyebrow-not-honored" | "flow-endpoint-not-honored" | "draw-not-honored" | "draw-target-mismatch";
     /** 対象の名前。 光らせる相手なら書かれた指定そのまま */
     actor: string;
     /** 書かれていた行 */
@@ -791,6 +810,25 @@ declare function parseTextDslV05(src: string): V05ParseResult;
  * 画面側も同じ関数を使う (#1028) = 別々に持つと、片方だけが読める本文ができる。
  */
 declare function stripQuotes(s: string): string;
+/**
+ * `draw:` に書ける語と、その語が効く図種 (#1312 / #1314)。
+ *
+ * **語と図種の対応をここ 1 箇所で持つ**。 受ける語の一覧 (`DRAW_WORDS`) も、組み立て側が見る
+ * 図種の一覧 (`DRAWABLE_DOC_TYPES`) も、この表から導く。 3 つを別々に並べると、語を足した時に
+ * どれかが古いまま残る (#1310 / #1304 で 3 度直した形)。
+ *
+ * | 語 | 図種 | 起点 |
+ * |---|---|---|
+ * | `line` | `line` | 左端から右へ線が伸びる |
+ * | `bar` | `bar` | 横軸から上へ棒が伸びる |
+ * | `pie` | `pie` | 12 時から時計回りに扇が開く |
+ *
+ * いまは語と図種が同じ綴りだが、**同じものとして扱わない**。 語は書き手が書く名前で、
+ * 図種は `type:` が取る値。 片方だけ別名を足したくなった時に、対応が表に残っている形にする。
+ */
+declare const DRAW_TARGETS: ReadonlyMap<string, PresetType>;
+/** `draw:` に書ける語。 表から導く (#1314) */
+declare const DRAW_WORDS: ReadonlySet<string>;
 
 /**
  * Text DSL i18n キーワード一覧
@@ -994,6 +1032,45 @@ type StrippedPaint = {
  */
 declare function stripExternalPaint(diagram: unknown): StrippedPaint[];
 
+/** 分解した部分の種類 (#1310) */
+type トークンの種類 = "項目名" | "説明文" | "矢印" | "色名" | "値の参照" | "注記";
+/** 分解した部分 1 つ。 位置は本文の先頭からの文字数 (`slice` にそのまま渡せる) */
+type トークン = {
+    種類: トークンの種類;
+    開始: number;
+    終わり: number;
+    /** `色名` の時だけ入る、解決後の色の名前。 画面はこれで「その色」 を引く */
+    色?: Tone;
+};
+/**
+ * 記法を分解する (#1310)。
+ *
+ * 行ごとに見る。 記法は行単位で意味が決まるため、行をまたぐ状態を持たない。
+ */
+declare function 記法を分解する(src: string): トークン[];
+/**
+ * JSON を分解する (#1310)。
+ *
+ * 記法と違い鍵は英語で、記法の語彙は出ない。 したがって **鍵 / 文字列 / 数を汎用の色で塗る**。
+ *
+ * 例外は `tone` と `color` の値で、こちらは記法と同じ語彙を持つため色名として扱う。
+ * 同じ `"success"` が入口によって別の色になる状態を作らないため。
+ */
+declare function JSONを分解する(src: string): トークン[];
+/**
+ * 分解した並びを、本文を覆う区間の列に広げる (#1310)。
+ *
+ * 分解器は色が付く部分だけを返すため、間の文字が抜ける。 画面はそのまま並べると本文が
+ * 欠けるので、**色の付かない部分も種類なしの区間として挟む**。
+ *
+ * 返す区間は本文を過不足なく覆う (連結すると元の本文に戻る)。
+ */
+declare function 区間に広げる(src: string, tokens: トークン[]): Array<{
+    文字: string;
+    種類?: トークンの種類;
+    色?: Tone;
+}>;
+
 /**
  * 図を組み立てる前に、 大きすぎる入力を止める (#1005)。
  *
@@ -1121,6 +1198,15 @@ interface DragonJson {
      * 組み立て側が知らせを出す。 そちらは `actors[].eyebrow` に書く。
      */
     eyebrow?: string;
+    /**
+     * 2 軸で仕分ける図 (`type: quadrant`) の軸の名前 (#1294)。 記法の `axes:` と同じ。
+     *
+     * 書かないと「小さい / 大きい」 のままになり、何を判断する図か読めない。 区画の名前
+     * (`右上` 等) は軸の名前から決まる。
+     *
+     * 他の図種には軸が無いため、書かれていたら組み立て側が知らせる。
+     */
+    axes?: JsonAxes;
     /** 登場人物 (必須): 文字列 or { name, kind, ... } object */
     actors: (string | JsonActor)[];
     /** flow step 配列 (必須): { from, to, label, ... } */
@@ -1172,11 +1258,6 @@ interface DragonJson {
         label?: string;
         lanes: string[];
     }>;
-    /**
-     * canvas pivot (CAR-1693 Phase 1) diagram-level layout mode。 "auto" (default) は catalog 100+
-     * backward compat、 "manual" は Phase 4 で drag → pos: 保存の完全 manual mode として使う予定。
-     */
-    layout?: LayoutMode;
 }
 interface JsonActor {
     name: string;
@@ -1206,15 +1287,96 @@ interface JsonActor {
      * LLM JSON DSL では nested 明示 = `{ "state": { "v": 50 } }` が natural、 human 側の
      * inline 拡散 pattern (`- arc1: { kind: arc-gauge, v: 50 }`) とは記述形式が分岐する
      * (spec § 2.3 分岐設計、 human = YAML 手書き最適 / LLM = JSON structured 最適)。
+     *
+     * 見本でない箱に書くと誤りとして返す (#1294)。 記法側は読めない項目名として行番号付きで
+     * 知らせるため、黙って捨てると入口によって扱いが変わる。
      */
     state?: Record<string, number | string | boolean>;
+    /**
+     * 箱の色 (#1294)。 記法の `tone:` と同じ。
+     *
+     * 色の名前と別名 (`成功` / `success` 等) を受ける。 見本 (parts) では色ではなく状態の
+     * 上書きとして意味を持つため、記法と同じく見本の箱には効かない。
+     */
+    tone?: Tone | (string & {});
+    /**
+     * 色番号または色の名前 (#1294)。 記法の `色:` / `color:` と同じ。
+     *
+     * `#` で始まる値は色番号として `colorHex` に入り、見本の絵の色を変える。 それ以外は
+     * 色の名前として読む (記法の `splitColorValue` と同じ振り分け)。
+     */
+    color?: string;
+    /**
+     * 工程の並び (`type: gantt`) で、その工程の担当 (#1294)。 記法の `owner:` と同じ。
+     */
+    owner?: string;
+    /**
+     * 工程の並び (`type: gantt`) で、その工程が終わる時期 (#1294)。 記法の `end:` と同じ。
+     *
+     * 値は他の工程が書いた時期のどれかに一致させる。 一致しない値は始まりと同じ位置に落ちる
+     * (記法側と同じ扱い)。
+     */
+    end?: string;
+    /**
+     * 体験の道筋 (`type: journey`) で、その段階が起きる場所 (#1294)。 記法の `touchpoint:` と同じ。
+     */
+    touchpoint?: string;
+    /**
+     * 体験の道筋 (`type: journey`) で、その段階の改善の余地 (#1294)。 記法の `opportunity:` と同じ。
+     */
+    opportunity?: string;
+    /**
+     * 箱を置く絶対座標と大きさ (#1294)。 記法の `posX:` / `posY:` / `posW:` / `posH:` と同じ。
+     *
+     * `pos` (ずらし幅) とは別物。 こちらは auto layout を使わずに位置そのものを決める。
+     */
+    posX?: number;
+    posY?: number;
+    posW?: number;
+    posH?: number;
+    /**
+     * 箱の中の要素ごとに位置と大きさを固定する (#1294)。 記法の `nodes:` と同じ。
+     *
+     * key は箱が作る要素の名前 (`header` / `footer` / `spacer` / `s0` 等)。
+     */
+    nodes?: Record<string, JsonActorNodeOverride>;
+    /**
+     * 見本を何倍で描くか (#1294)。 記法の `scale:` / `倍率:` と同じ。
+     *
+     * 見本 (parts) にしか効かない。 見本でない箱に書くと誤りとして返す (記法側も同じく
+     * 読めない項目名として知らせる)。
+     */
+    scale?: number;
+}
+/** 2 軸で仕分ける図の軸の名前 (#1294)。 記法の `axes:` と同じ形 */
+interface JsonAxes {
+    x?: {
+        left?: string;
+        right?: string;
+    };
+    y?: {
+        bottom?: string;
+        top?: string;
+    };
+}
+/** 箱の中の要素 1 つ分の位置と大きさ (#1294)。 記法の `nodes: { header: { ... } }` と同じ */
+interface JsonActorNodeOverride {
+    posX?: number;
+    posY?: number;
+    posW?: number;
+    posH?: number;
 }
 interface JsonStep {
     from: string;
     to: string;
     label: string;
     sub?: string;
-    tone?: Tone;
+    /**
+     * 矢印の色 (#1304)。 記法の `(成功)` と同じく別名 (`成功` / `neutral` 等) も受ける。
+     *
+     * `string & {}` は箱の `tone` と同じ idiom = 正規の色名を補完に出しつつ別名も通す。
+     */
+    tone?: Tone | (string & {});
     style?: EdgeStyle;
     guard?: string;
     cardinality?: string;
@@ -1239,6 +1401,13 @@ interface JsonPhase {
     body?: string;
     /** badge label */
     badge?: string;
+    /**
+     * その段で左の起点から描くもの (#1312)。 記法の `draw: line` と同じ。
+     *
+     * 受ける語は `line` だけ (`DRAW_WORDS`)。 折れ線の図で、その段の間に線が左端から
+     * 右へ伸びる。
+     */
+    draw?: string;
     /**
      * 段の中で値を動かす (#1186)。 記法の `tween: name 100 -> 90` と同じ。
      *
@@ -1341,6 +1510,37 @@ declare const diagramJsonSchema: {
             type: string;
             description: string;
         };
+        axes: {
+            type: string;
+            additionalProperties: boolean;
+            description: string;
+            properties: {
+                x: {
+                    type: string;
+                    additionalProperties: boolean;
+                    properties: {
+                        left: {
+                            type: string;
+                        };
+                        right: {
+                            type: string;
+                        };
+                    };
+                };
+                y: {
+                    type: string;
+                    additionalProperties: boolean;
+                    properties: {
+                        bottom: {
+                            type: string;
+                        };
+                        top: {
+                            type: string;
+                        };
+                    };
+                };
+            };
+        };
         actors: {
             type: string;
             minItems: number;
@@ -1402,6 +1602,101 @@ declare const diagramJsonSchema: {
                             type: string;
                             description: string;
                         };
+                        state: {
+                            type: string;
+                            description: string;
+                            additionalProperties: {
+                                type: string[];
+                            };
+                        };
+                        tone: {
+                            type: string;
+                            description: string;
+                            enum: string[];
+                        };
+                        color: {
+                            type: string;
+                            description: string;
+                            anyOf: ({
+                                enum: string[];
+                                pattern?: undefined;
+                            } | {
+                                pattern: string;
+                                enum?: undefined;
+                            })[];
+                        };
+                        owner: {
+                            type: string;
+                            description: string;
+                        };
+                        end: {
+                            type: string;
+                            description: string;
+                        };
+                        touchpoint: {
+                            type: string;
+                            description: string;
+                        };
+                        opportunity: {
+                            type: string;
+                            description: string;
+                        };
+                        posX: {
+                            type: string;
+                            description: string;
+                        };
+                        posY: {
+                            type: string;
+                            description: string;
+                        };
+                        posW: {
+                            type: string;
+                            description: string;
+                        };
+                        posH: {
+                            type: string;
+                            description: string;
+                        };
+                        nodes: {
+                            type: string;
+                            description: string;
+                            additionalProperties: {
+                                type: string;
+                                additionalProperties: boolean;
+                                properties: {
+                                    posX: {
+                                        type: string;
+                                    };
+                                    posY: {
+                                        type: string;
+                                    };
+                                    posW: {
+                                        type: string;
+                                    };
+                                    posH: {
+                                        type: string;
+                                    };
+                                };
+                            };
+                        };
+                        scale: {
+                            type: string;
+                            description: string;
+                        };
+                        pos: {
+                            type: string;
+                            additionalProperties: boolean;
+                            description: string;
+                            required: string[];
+                            properties: {
+                                x: {
+                                    type: string;
+                                };
+                                y: {
+                                    type: string;
+                                };
+                            };
+                        };
                     };
                     description?: undefined;
                 })[];
@@ -1461,6 +1756,20 @@ declare const diagramJsonSchema: {
                         type: string;
                         description: string;
                     };
+                    pos: {
+                        type: string;
+                        additionalProperties: boolean;
+                        description: string;
+                        required: string[];
+                        properties: {
+                            x: {
+                                type: string;
+                            };
+                            y: {
+                                type: string;
+                            };
+                        };
+                    };
                 };
             };
         };
@@ -1528,6 +1837,11 @@ declare const diagramJsonSchema: {
                         type: string;
                         description: string;
                     };
+                    draw: {
+                        type: string;
+                        enum: string[];
+                        description: string;
+                    };
                     tween: {
                         type: string;
                         description: string;
@@ -1589,6 +1903,10 @@ declare const diagramJsonSchema: {
                     type: string;
                     minimum: number;
                 };
+                scale: {
+                    type: string;
+                    description: string;
+                };
             };
         };
         lanes: {
@@ -1614,6 +1932,20 @@ declare const diagramJsonSchema: {
                     lifeline: {
                         type: string;
                     };
+                    pos: {
+                        type: string;
+                        additionalProperties: boolean;
+                        description: string;
+                        required: string[];
+                        properties: {
+                            x: {
+                                type: string;
+                            };
+                            y: {
+                                type: string;
+                            };
+                        };
+                    };
                 };
             };
         };
@@ -1685,4 +2017,4 @@ interface CompileOpts {
  */
 declare function textDslToDiagram(src: string, opts?: CompileOpts): CdlDiagram;
 
-export { type AnchorBox, type CompileNotice, type CompileOpts, DIAGRAM_BOUNDARY_PADDING, type DiagramBoundingBox, type DragonJson, type DslActor, type DslAnimate, type DslDocument, type DslError, type DslGroup, type DslLane, type DslPhase, type DslSet, type DslState, type DslStep, type DslTween, type DslValue, type DslViewport, type FocusEntry, type InputSize, type JsonActor, type JsonDslError, type JsonPhase, type JsonStep, type LayoutMode, type LayoutPos, type LintIssue, type LintReport, type LintSeverity, MAX_INPUT_BYTES, MAX_INPUT_ELEMENTS, MAX_PART_SCALE, NODE_KIND_ALIAS, NODE_KIND_VALID, PRESET_TYPES, type PresetType, RELATIVE_GAP_DEFAULT, type RelativeDirection, type RelativePos, TONE_ALIAS, TOP_LEVEL_KEYS, autoFix, compileToCdl, computeDiagramBoundingBox, countBytes, countDiagramElements, countDocElements, describeOversize, describeOversizeSource, diagramJsonSchema, isColorValue, jsonToDiagram, lintDiagram, measureActorBoxes, normalizePartScale, orderByDependency, parseFocusEntry, parseRelativePos, parseTextDsl, parseTextDslV05, partBoxInFrame, partDrawsInDiagram, partIsMeasurable, partRenderSize, partScaleFactor, partTargetScale, partTargetSize, partVisualSize, partsGridCenters, pointsOutside, rectsOverlap, resolveRelativePos, stripExternalPaint, stripQuotes, textDslToDiagram, validateDragonJson, writeActorPosition };
+export { type AnchorBox, type CompileNotice, type CompileOpts, DIAGRAM_BOUNDARY_PADDING, DRAW_TARGETS, DRAW_WORDS, type DiagramBoundingBox, type DragonJson, type DslActor, type DslAnimate, type DslDocument, type DslError, type DslGroup, type DslLane, type DslPhase, type DslSet, type DslState, type DslStep, type DslTween, type DslValue, type DslViewport, type FocusEntry, type InputSize, JSONを分解する, type JsonActor, type JsonActorNodeOverride, type JsonAxes, type JsonDslError, type JsonPhase, type JsonStep, type LayoutMode, type LayoutPos, type LintIssue, type LintReport, type LintSeverity, MAX_INPUT_BYTES, MAX_INPUT_ELEMENTS, MAX_PART_SCALE, NODE_KIND_ALIAS, NODE_KIND_VALID, PRESET_TYPES, type PresetType, RELATIVE_GAP_DEFAULT, type RelativeDirection, type RelativePos, TONE_ALIAS, TOP_LEVEL_KEYS, autoFix, compileToCdl, computeDiagramBoundingBox, countBytes, countDiagramElements, countDocElements, describeOversize, describeOversizeSource, diagramJsonSchema, isColorValue, jsonToDiagram, lintDiagram, measureActorBoxes, normalizePartScale, orderByDependency, parseFocusEntry, parseRelativePos, parseTextDsl, parseTextDslV05, partBoxInFrame, partDrawsInDiagram, partIsMeasurable, partRenderSize, partScaleFactor, partTargetScale, partTargetSize, partVisualSize, partsGridCenters, pointsOutside, rectsOverlap, resolveRelativePos, stripExternalPaint, stripQuotes, textDslToDiagram, validateDragonJson, writeActorPosition, type トークン, type トークンの種類, 区間に広げる, 記法を分解する };