@cardenelabs/dragon 0.11.0 → 0.13.0

package/dist/index.d.cts

@@ -1,4 +1,4 @@
-import { NodeKind, Tone, EdgeStyle, CdlDiagram, LaidDiagram } from '@cardenelabs/cdl';
+import { CdlDiagram, NodeKind, Tone, EdgeStyle, LaidDiagram } from '@cardenelabs/cdl';
 
 /**
  * 位置を他の要素からの相対で書くための解決。
@@ -82,6 +82,14 @@ declare function orderByDependency(items: ReadonlyArray<{
  * docs/cdl/text-dsl-spec.md の文法を AST に変換した中間表現
  */
 
+/**
+ * 箱の中に描く図形 (#1374)。 **描画側の型をそのまま使う**。
+ *
+ * 写して持つと欄が増えた時にずれる。 指した先が変われば型検査が教える。
+ */
+type DslDynShape = NonNullable<CdlDiagram["nodes"][number]["shape"]>;
+/** 値を見せる部品 (#1374)。 図形と同じ理由で描画側の型をそのまま使う */
+type DslReadout = NonNullable<CdlDiagram["readouts"]>[number];
 type PresetType = "sequence" | "flow" | "swimlane" | "er" | "state" | "topology" | "solidity" | "gantt" | "class" | "pie" | "bar" | "line" | "funnel" | "tree" | "journey" | "quadrant" | "c4" | "mind";
 type Position = {
     line: number;
@@ -150,6 +158,12 @@ type DslDocument = {
     viewport?: DslViewport;
     lanes?: Record<string, DslLane>;
     groups?: Record<string, DslGroup>;
+    /**
+     * 値を見せる部品 (`readouts:`、 #1374)。 割合の輪や数え上げを図の脇に出す。
+     *
+     * 箱ではないので縦列に載らない。 図全体に 1 つの並びとして持つ。
+     */
+    readouts?: DslReadout[];
     /**
      * canvas pivot (CAR-1693 Phase 1) diagram-level layout mode。 未指定は "auto" default で
      * catalog 100+ backward compat。 "manual" は Phase 4 で drag → pos: 保存の完全 manual mode。
@@ -186,6 +200,26 @@ type DslActor = {
     eyebrow?: string;
     value?: string;
     rows?: string[];
+    /**
+     * 箱の中に描く図形 (`shape:`、 #1374)。 水位や角度を状態で動かせる。
+     *
+     * 種類ごとに書ける欄が違う (`図形の表`)。 知らない種類と欄は読み取りが知らせる。
+     */
+    shape?: DslDynShape;
+    /**
+     * 箱に出す題 (`title:`、 #1381)。 書かなければ名前がそのまま題になる。
+     *
+     * 名前は図の中で 1 つに決まる必要がある (`focus:` と `flow:` が名前で指すため) 一方、
+     * 題は重なってよい。 同じ題の箱を並べる図と、題を持たない箱を、名前と切り離して書ける。
+     */
+    title?: string;
+    /**
+     * その箱を出すかどうかの条件 (`visibleIf:`、 #1381)。
+     *
+     * 状態を差し込める文字列で、描画側が真偽を判定する。 `"0"` / `"false"` / 空文字が偽で、
+     * それ以外は真。 値だけを見せる図が、場所を空けるためだけの見えない箱を置くのに使う。
+     */
+    visibleIf?: string;
     /**
      * 工程の並び (`type: gantt`) で、その工程の担当 (#1251)。
      *
@@ -317,6 +351,8 @@ type DslStep = {
     /** v0.5+ inline option */
     guard?: string;
     cardinality?: string;
+    /** 矢印がどの辺から出るか (#1385)。 書かなければ描画側が自動で選ぶ */
+    side?: "top" | "right" | "bottom" | "left";
     labelOffsetX?: number;
     labelOffsetY?: number;
     /** true で説明文を矢印の線の上に重ねる。 分岐図の条件ラベル用。 */
@@ -785,7 +821,7 @@ type V05ParseResult = {
  * 書くと、項目を足した時に案内か一覧のどちらかが取り残される (実際に `states` / `values` が
  * 一覧に 1 件も無い状態で放置されていた)。
  */
-declare const TOP_LEVEL_KEYS: readonly ["title", "type", "actors", "flow", "states", "values", "animation", "viewport", "lanes", "groups", "eyebrow", "axes"];
+declare const TOP_LEVEL_KEYS: readonly ["title", "type", "actors", "flow", "states", "values", "animation", "viewport", "lanes", "groups", "eyebrow", "axes", "readouts"];
 /** 受け付ける図種。 記法一覧はここを見る。 */
 declare const PRESET_TYPES: ReadonlySet<PresetType>;
 /**
@@ -1227,6 +1263,12 @@ interface DragonJson {
     actors: (string | JsonActor)[];
     /** flow step 配列 (必須): { from, to, label, ... } */
     flow: JsonStep[];
+    /**
+     * 値を見せる部品 (optional、 #1374)。 記法の最上位 `readouts:` と同じ。
+     *
+     * 箱ではないので縦列に載らない。 図全体に 1 つの並びとして持つ。
+     */
+    readouts?: DslReadout[];
     /**
      * 状態の初期値 (optional)。 記法の `states:` と同じ (#1181)。
      *
@@ -1277,6 +1319,20 @@ interface DragonJson {
 }
 interface JsonActor {
     name: string;
+    /**
+     * 箱の中に描く図形 (optional、 #1374)。 記法の `shape:` と同じ。
+     *
+     * 水位や角度を状態で動かす。 形は描画側の型が縛る。
+     */
+    shape?: DslDynShape;
+    /**
+     * その箱を出すかどうかの条件 (optional、 #1381)。 記法の `visibleIf:` と同じ。
+     */
+    visibleIf?: string;
+    /**
+     * 箱に出す題 (optional、 #1381)。 記法の `title:` と同じ。
+     */
+    title?: string;
     /**
      * CAR-1657 unified syntax = 既存 NodeKind (28 個) に加えて parts identifier (arc-gauge 等) を
      * accept する。 未知 kind 値は parts 候補として partId に格納、 compile 側 partsCatalog で解決。
@@ -1387,6 +1443,8 @@ interface JsonStep {
     to: string;
     label: string;
     sub?: string;
+    /** 矢印がどの辺から出るか (#1385)。 記法の `side:` と同じ */
+    side?: "top" | "right" | "bottom" | "left";
     /**
      * 矢印の色 (#1304)。 記法の `(成功)` と同じく別名 (`成功` / `neutral` 等) も受ける。
      *
@@ -1712,6 +1770,96 @@ declare const diagramJsonSchema: {
                                 };
                             };
                         };
+                        visibleIf: {
+                            type: string;
+                            description: string;
+                        };
+                        title: {
+                            type: string;
+                            description: string;
+                        };
+                        shape: {
+                            type: string;
+                            description: string;
+                            required: string[];
+                            properties: {
+                                kind: {
+                                    type: string;
+                                    enum: string[];
+                                };
+                                source: {
+                                    type: string[];
+                                };
+                                fillMax: {
+                                    type: string;
+                                };
+                                orient: {
+                                    type: string;
+                                    enum: string[];
+                                };
+                                radius: {
+                                    type: string[];
+                                };
+                                fillProgress: {
+                                    type: string[];
+                                };
+                                innerRadius: {
+                                    type: string;
+                                };
+                                outerRadius: {
+                                    type: string;
+                                };
+                                startAngle: {
+                                    type: string;
+                                };
+                                angle: {
+                                    type: string[];
+                                };
+                                sweepMax: {
+                                    type: string;
+                                };
+                                level: {
+                                    type: string[];
+                                };
+                                amplitude: {
+                                    type: string;
+                                };
+                                frequency: {
+                                    type: string;
+                                };
+                                waveHeight: {
+                                    type: string;
+                                };
+                                sides: {
+                                    type: string;
+                                };
+                                rotation: {
+                                    type: string[];
+                                };
+                                fill: {
+                                    type: string;
+                                };
+                                stroke: {
+                                    type: string;
+                                };
+                            };
+                            additionalProperties: boolean;
+                            oneOf: ({
+                                properties: {
+                                    kind: {
+                                        enum: string[];
+                                    };
+                                };
+                                required: string[];
+                            } | {
+                                properties: {
+                                    kind: {
+                                        enum: string[];
+                                    };
+                                };
+                                required?: undefined;
+                            })[];
+                        };
                     };
                     description?: undefined;
                 })[];
@@ -1759,6 +1907,11 @@ declare const diagramJsonSchema: {
                         type: string;
                         description: string;
                     };
+                    side: {
+                        type: string;
+                        enum: string[];
+                        description: string;
+                    };
                     labelOffsetX: {
                         type: string;
                         description: string;
@@ -1985,6 +2138,395 @@ declare const diagramJsonSchema: {
                 };
             };
         };
+        readouts: {
+            type: string;
+            description: string;
+            items: {
+                type: string;
+                required: string[];
+                additionalProperties: boolean;
+                properties: {
+                    id: {
+                        type: string;
+                        minLength: number;
+                    };
+                    kind: {
+                        type: string;
+                        enum: string[];
+                    };
+                    additionsSource: {
+                        type: string;
+                    };
+                    bodySource: {
+                        type: string;
+                    };
+                    canvasH: {
+                        type: string;
+                    };
+                    canvasW: {
+                        type: string;
+                    };
+                    caption: {
+                        type: string;
+                    };
+                    cellGap: {
+                        type: string;
+                    };
+                    cellSize: {
+                        type: string;
+                    };
+                    charMs: {
+                        type: string;
+                    };
+                    color: {
+                        type: string;
+                    };
+                    colorA: {
+                        type: string;
+                    };
+                    colorAccent: {
+                        type: string;
+                    };
+                    colorActive: {
+                        type: string;
+                    };
+                    colorActual: {
+                        type: string;
+                    };
+                    colorAdd: {
+                        type: string;
+                    };
+                    colorApplied: {
+                        type: string;
+                    };
+                    colorB: {
+                        type: string;
+                    };
+                    colorBar: {
+                        type: string;
+                    };
+                    colorBottom: {
+                        type: string;
+                    };
+                    colorDel: {
+                        type: string;
+                    };
+                    colorDiscount: {
+                        type: string;
+                    };
+                    colorDown: {
+                        type: string;
+                    };
+                    colorFocus: {
+                        type: string;
+                    };
+                    colorMap: {
+                        type: string;
+                        minItems: number;
+                        items: {
+                            type: string;
+                            required: string[];
+                            additionalProperties: boolean;
+                            properties: {
+                                status: {
+                                    type: string;
+                                };
+                                color: {
+                                    type: string;
+                                };
+                            };
+                        };
+                    };
+                    colorNeg: {
+                        type: string;
+                    };
+                    colorNew: {
+                        type: string;
+                    };
+                    colorOld: {
+                        type: string;
+                    };
+                    colorOther: {
+                        type: string;
+                    };
+                    colorPending: {
+                        type: string;
+                    };
+                    colorPlay: {
+                        type: string;
+                    };
+                    colorPos: {
+                        type: string;
+                    };
+                    colorRead: {
+                        type: string;
+                    };
+                    colorSelf: {
+                        type: string;
+                    };
+                    colorSource: {
+                        type: string;
+                    };
+                    colorStrong: {
+                        type: string;
+                    };
+                    colorTop: {
+                        type: string;
+                    };
+                    colorTotal: {
+                        type: string;
+                    };
+                    colorUnread: {
+                        type: string;
+                    };
+                    colorUp: {
+                        type: string;
+                    };
+                    colorWeak: {
+                        type: string;
+                    };
+                    colorWinner: {
+                        type: string;
+                    };
+                    colors: {
+                        type: string;
+                        items: {
+                            type: string;
+                        };
+                    };
+                    columnWidth: {
+                        type: string;
+                    };
+                    comparisonSource: {
+                        type: string;
+                    };
+                    count: {
+                        type: string;
+                    };
+                    currency: {
+                        type: string;
+                    };
+                    currentSource: {
+                        type: string;
+                    };
+                    decimals: {
+                        type: string;
+                    };
+                    deletionsSource: {
+                        type: string;
+                    };
+                    duration: {
+                        type: string;
+                    };
+                    durationMs: {
+                        type: string;
+                    };
+                    durationSource: {
+                        type: string;
+                    };
+                    fill: {
+                        type: string;
+                    };
+                    highThreshold: {
+                        type: string;
+                    };
+                    history: {
+                        type: string;
+                    };
+                    historySource: {
+                        type: string;
+                    };
+                    innerRatio: {
+                        type: string;
+                    };
+                    itemTemplate: {
+                        type: string;
+                    };
+                    kindSource: {
+                        type: string;
+                    };
+                    label: {
+                        type: string;
+                    };
+                    labelA: {
+                        type: string;
+                    };
+                    labelB: {
+                        type: string;
+                    };
+                    labelSource: {
+                        type: string;
+                    };
+                    lowThreshold: {
+                        type: string;
+                    };
+                    map: {
+                        type: string;
+                        minItems: number;
+                        items: {
+                            type: string;
+                            required: string[];
+                            additionalProperties: boolean;
+                            properties: {
+                                value: {
+                                    type: string;
+                                };
+                                color: {
+                                    type: string;
+                                };
+                                label: {
+                                    type: string;
+                                };
+                            };
+                        };
+                    };
+                    max: {
+                        type: string;
+                    };
+                    maxSize: {
+                        type: string;
+                    };
+                    membersSource: {
+                        type: string;
+                    };
+                    min: {
+                        type: string;
+                    };
+                    minSize: {
+                        type: string;
+                    };
+                    monthName: {
+                        type: string;
+                    };
+                    newSource: {
+                        type: string;
+                    };
+                    oldSource: {
+                        type: string;
+                    };
+                    pathD: {
+                        type: string;
+                    };
+                    playingSource: {
+                        type: string;
+                    };
+                    prefix: {
+                        type: string;
+                    };
+                    prevSource: {
+                        type: string;
+                    };
+                    progressSource: {
+                        type: string;
+                    };
+                    rMax: {
+                        type: string;
+                    };
+                    rMin: {
+                        type: string;
+                    };
+                    rangeAvg: {
+                        type: string;
+                    };
+                    rangeBad: {
+                        type: string;
+                    };
+                    runningSource: {
+                        type: string;
+                    };
+                    segments: {
+                        type: string;
+                    };
+                    showValue: {
+                        type: string;
+                    };
+                    size: {
+                        type: string;
+                    };
+                    source: {
+                        type: string;
+                    };
+                    sourceA: {
+                        type: string;
+                    };
+                    sourceB: {
+                        type: string;
+                    };
+                    stepsSource: {
+                        type: string;
+                    };
+                    strokeWidth: {
+                        type: string;
+                    };
+                    suffix: {
+                        type: string;
+                    };
+                    targetSource: {
+                        type: string;
+                    };
+                    textSource: {
+                        type: string;
+                    };
+                    titleSource: {
+                        type: string;
+                    };
+                    unit: {
+                        type: string;
+                    };
+                    viewH: {
+                        type: string;
+                    };
+                    viewW: {
+                        type: string;
+                    };
+                    xMax: {
+                        type: string;
+                    };
+                    xMin: {
+                        type: string;
+                    };
+                    yMax: {
+                        type: string;
+                    };
+                    yMin: {
+                        type: string;
+                    };
+                };
+                oneOf: ({
+                    properties: {
+                        kind: {
+                            enum: string[];
+                        };
+                        map?: undefined;
+                    };
+                    required: string[];
+                } | {
+                    properties: {
+                        kind: {
+                            enum: string[];
+                        };
+                        map: {
+                            type: string;
+                            minItems: number;
+                            items: {
+                                type: string;
+                                required: string[];
+                                additionalProperties: boolean;
+                                properties: {
+                                    value: {
+                                        type: string;
+                                    };
+                                    color: {
+                                        type: string;
+                                    };
+                                };
+                            };
+                        };
+                    };
+                    required: string[];
+                })[];
+            };
+        };
     };
 };