@cardenelabs/dragon 0.13.0 → 0.14.0

package/dist/index.d.ts

@@ -90,6 +90,42 @@ declare function orderByDependency(items: ReadonlyArray<{
 type DslDynShape = NonNullable<CdlDiagram["nodes"][number]["shape"]>;
 /** 値を見せる部品 (#1374)。 図形と同じ理由で描画側の型をそのまま使う */
 type DslReadout = NonNullable<CdlDiagram["readouts"]>[number];
+/** 読む人が動かすつまみ (#1389)。 部品と同じ理由で描画側の型をそのまま使う */
+type DslInput = NonNullable<CdlDiagram["inputs"]>[number];
+/** つまみの値から決まる値 (#1391)。 描画側の型に、知らせ用の記述位置だけを足す。 */
+type DslFormula = NonNullable<CdlDiagram["formulas"]>[number] & {
+    pos?: Position;
+};
+/** 巻き上げに応じて進む値 (#1393)。 描画側の型をそのまま使う */
+type DslScrollTrigger = NonNullable<CdlDiagram["scrollTriggers"]>[number];
+/**
+ * 押下などの出来事で動く仕掛け (`events:`、 #1393)。
+ *
+ * **描画側の型をそのまま使わない**。 描画側は相手を識別子で持つ (`{ kind: "node", id }`) が、
+ * 記法は識別子を書けず名前で指す。 名前から識別子への読み替えは組み立てが行うため、
+ * 記法の段階では「何をどう指したか」 だけを持つ。
+ */
+type DslEventBinding = {
+    /** 出来事の種類 (`click` / `hover` など、描画側の `CdlEventKind` と同じ語) */
+    event: NonNullable<CdlDiagram["eventBindings"]>[number]["event"];
+    /** 何を指したか。 名前は記法に書かれたまま持ち、組み立てが識別子へ直す */
+    target: {
+        kind: "node";
+        name: string;
+    } | {
+        kind: "lane";
+        name: string;
+    } | {
+        kind: "edge";
+        from: string;
+        to: string;
+    } | {
+        kind: "diagram";
+    };
+    /** 呼び出す仕掛けの名前。 実体は画面側が持つ */
+    handlerId: string;
+    pos: Position;
+};
 type PresetType = "sequence" | "flow" | "swimlane" | "er" | "state" | "topology" | "solidity" | "gantt" | "class" | "pie" | "bar" | "line" | "funnel" | "tree" | "journey" | "quadrant" | "c4" | "mind";
 type Position = {
     line: number;
@@ -164,6 +200,35 @@ type DslDocument = {
      * 箱ではないので縦列に載らない。 図全体に 1 つの並びとして持つ。
      */
     readouts?: DslReadout[];
+    /**
+     * 読む人が動かすつまみ (`inputs:`、 #1389)。 つまみが握る値は状態と同じ名前で参照できる。
+     *
+     * 部品と同じく箱ではないので縦列に載らない。 図全体に 1 つの並びとして持つ。
+     */
+    inputs?: DslInput[];
+    /**
+     * つまみの値から決まる値 (`formulas:`、 #1391)。
+     *
+     * **`values:` とは経路が別**。 あちらは段が動かす状態を読んで毎 frame 決まり直す
+     * (`derived`) のに対し、こちらはつまみが握る値を読む反応の網に載る (`formulas`)。
+     * 描画側がこの 2 つを別の欄として持つため、記法でも別の項目にする。
+     *
+     * 式は描画側の書き方。 名前は中括弧で囲っても囲わなくてもよい (描画側の parser が
+     * どちらも同じ名前として読む)。
+     */
+    formulas?: DslFormula[];
+    /**
+     * 押下などの出来事で動く仕掛け (`events:`、 #1393)。
+     *
+     * 相手は名前で指す。 組み立てが識別子へ直し、指す先が無ければ知らせる。
+     */
+    events?: DslEventBinding[];
+    /**
+     * 巻き上げに応じて進む値 (`scrolls:`、 #1393)。
+     *
+     * 画面を巻き上げた量から 0 から 1 の進み具合を作る。 描画側はこれを値として読む。
+     */
+    scrolls?: DslScrollTrigger[];
     /**
      * canvas pivot (CAR-1693 Phase 1) diagram-level layout mode。 未指定は "auto" default で
      * catalog 100+ backward compat。 "manual" は Phase 4 で drag → pos: 保存の完全 manual mode。
@@ -220,6 +285,29 @@ type DslActor = {
      * それ以外は真。 値だけを見せる図が、場所を空けるためだけの見えない箱を置くのに使う。
      */
     visibleIf?: string;
+    /**
+     * 箱の幅と高さを値に追随させる (`wBind:` / `hBind:`、 #1392)。
+     *
+     * 状態の名前を `{名前}` の形で書く。 配置計算は追随前の `posW` / `posH` を使い、
+     * 描く時だけ値に合わせて伸び縮みする (矢印の通り道が動かないようにするための分離)。
+     */
+    wBind?: string;
+    hBind?: string;
+    /**
+     * 箱の濃さ (`opacity:`、 #1392)。 0 から 1 の数か、状態の名前を書く。
+     *
+     * 書かなければ完全に見える状態になる。 `visibleIf` が出す / 出さないの 2 値なのに対し、
+     * こちらは途中の濃さを持てる。
+     */
+    opacity?: number | string;
+    /**
+     * 描く時だけ箱をずらす量 (`renderOffsetX:` / `renderOffsetY:`、 #1392)。
+     *
+     * 配置計算と矢印はずらす前の位置を使うため、円周上に並べて見せる等の見た目専用。
+     * 数か、状態の名前を書く。
+     */
+    renderOffsetX?: number | string;
+    renderOffsetY?: number | string;
     /**
      * 工程の並び (`type: gantt`) で、その工程の担当 (#1251)。
      *
@@ -351,6 +439,15 @@ type DslStep = {
     /** v0.5+ inline option */
     guard?: string;
     cardinality?: string;
+    /**
+     * 矢印を値に追随させる欄 (`widthBind:` / `strokeBind:` / `dashOffsetBind:`、 #1396)。
+     *
+     * 箱の `wBind` (#1392) と同じ形で、状態やつまみの名前を `{名前}` で書く。
+     * 太さ / 色 / 破線の位置がその値に合わせて動く。 通り道そのものは動かない。
+     */
+    widthBind?: string;
+    strokeBind?: string;
+    dashOffsetBind?: string;
     /** 矢印がどの辺から出るか (#1385)。 書かなければ描画側が自動で選ぶ */
     side?: "top" | "right" | "bottom" | "left";
     labelOffsetX?: number;
@@ -572,7 +669,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" | "draw-not-honored" | "draw-target-mismatch";
+    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" | "formula-unresolved" | "event-target-missing";
     /** 対象の名前。 光らせる相手なら書かれた指定そのまま */
     actor: string;
     /** 書かれていた行 */
@@ -821,7 +918,7 @@ type V05ParseResult = {
  * 書くと、項目を足した時に案内か一覧のどちらかが取り残される (実際に `states` / `values` が
  * 一覧に 1 件も無い状態で放置されていた)。
  */
-declare const TOP_LEVEL_KEYS: readonly ["title", "type", "actors", "flow", "states", "values", "animation", "viewport", "lanes", "groups", "eyebrow", "axes", "readouts"];
+declare const TOP_LEVEL_KEYS: readonly ["title", "type", "actors", "flow", "states", "values", "animation", "viewport", "lanes", "groups", "eyebrow", "axes", "readouts", "inputs", "formulas", "events", "scrolls"];
 /** 受け付ける図種。 記法一覧はここを見る。 */
 declare const PRESET_TYPES: ReadonlySet<PresetType>;
 /**
@@ -1071,11 +1168,13 @@ type StrippedPaint = {
 /**
  * 図の中から、 色を塗る位置に入った外部参照を落とす。
  *
- * 対象は 2 種類ある。
+ * 対象は 3 種類ある。
  *
  * - 色を塗る key (`fill` / `stroke` / `bg` 等) の値
  * - 状態の値 (`states[].initial` と、 phase が状態へ入れる値)。 状態は `{名前}` の形で
  *   `fill` に差し込まれるため、 色を塗る位置に届く
+ * - つまみの値 (`inputs[].defaultValue` / `defaultValues` / `options`)。 これらも状態を上書きし、
+ *   同じ形で paint に届く
  *
  * 説明文 (`title` / `subtitle` / `value` / `rows`) は対象外。 文字として出るだけで
  * 属性にはならないため、 URL を書く正当な用途を壊さない。
@@ -1269,6 +1368,38 @@ interface DragonJson {
      * 箱ではないので縦列に載らない。 図全体に 1 つの並びとして持つ。
      */
     readouts?: DslReadout[];
+    /**
+     * 読む人が動かすつまみ (optional、 #1389)。 記法の最上位 `inputs:` と同じ。
+     *
+     * 部品と同じく箱ではないので縦列に載らない。 図全体に 1 つの並びとして持つ。
+     */
+    inputs?: DslInput[];
+    /**
+     * つまみの値から決まる値 (optional、 #1391)。 記法の最上位 `formulas:` と同じ。
+     *
+     * 形は `{ 名前: "式" }`。 `values:` と経路が別で、式は名前を中括弧で囲わない。
+     */
+    formulas?: Record<string, string>;
+    /**
+     * 押下などの出来事で動く仕掛け (optional、 #1393)。 記法の最上位 `events:` と同じ。
+     *
+     * 相手は名前で指す (`box` / `lane` / `arrow` / `diagram` のどれか 1 つ)。
+     */
+    events?: {
+        on: string;
+        handler: string;
+        box?: string;
+        lane?: string;
+        arrow?: string;
+        diagram?: boolean;
+    }[];
+    /** 巻き上げに応じて進む値 (optional、 #1393)。 記法の最上位 `scrolls:` と同じ */
+    scrolls?: Record<string, {
+        start?: number;
+        end?: number;
+        scrub?: number;
+        label?: string;
+    }>;
     /**
      * 状態の初期値 (optional)。 記法の `states:` と同じ (#1181)。
      *
@@ -1333,6 +1464,17 @@ interface JsonActor {
      * 箱に出す題 (optional、 #1381)。 記法の `title:` と同じ。
      */
     title?: string;
+    /**
+     * 値に追随する 5 欄 (optional、 #1392)。 記法の `wBind:` / `hBind:` / `opacity:` /
+     * `renderOffsetX:` / `renderOffsetY:` と同じ。
+     *
+     * 大きさは文字列だけ (数を書いても追随のしようが無い)、濃さとずらしは数も受ける。
+     */
+    wBind?: string;
+    hBind?: string;
+    opacity?: number | string;
+    renderOffsetX?: number | string;
+    renderOffsetY?: number | string;
     /**
      * CAR-1657 unified syntax = 既存 NodeKind (28 個) に加えて parts identifier (arc-gauge 等) を
      * accept する。 未知 kind 値は parts 候補として partId に格納、 compile 側 partsCatalog で解決。
@@ -1454,6 +1596,13 @@ interface JsonStep {
     style?: EdgeStyle;
     guard?: string;
     cardinality?: string;
+    /**
+     * 矢印を値に追随させる 3 欄 (optional、 #1396)。 記法の `widthBind:` / `strokeBind:` /
+     * `dashOffsetBind:` と同じ。 描画側は文字列だけを取る。
+     */
+    widthBind?: string;
+    strokeBind?: string;
+    dashOffsetBind?: string;
     labelOffsetX?: number;
     labelOffsetY?: number;
     /** true で説明文を矢印の線の上に重ねる。 分岐図の条件ラベル用。 */
@@ -1860,6 +2009,36 @@ declare const diagramJsonSchema: {
                                 required?: undefined;
                             })[];
                         };
+                        wBind: {
+                            type: string;
+                            minLength: number;
+                            pattern: string;
+                            description: string;
+                        };
+                        hBind: {
+                            type: string;
+                            minLength: number;
+                            pattern: string;
+                            description: string;
+                        };
+                        opacity: {
+                            type: string[];
+                            minLength: number;
+                            pattern: string;
+                            description: string;
+                        };
+                        renderOffsetX: {
+                            type: string[];
+                            minLength: number;
+                            pattern: string;
+                            description: string;
+                        };
+                        renderOffsetY: {
+                            type: string[];
+                            minLength: number;
+                            pattern: string;
+                            description: string;
+                        };
                     };
                     description?: undefined;
                 })[];
@@ -1938,6 +2117,24 @@ declare const diagramJsonSchema: {
                             };
                         };
                     };
+                    widthBind: {
+                        type: string;
+                        minLength: number;
+                        pattern: string;
+                        description: string;
+                    };
+                    strokeBind: {
+                        type: string;
+                        minLength: number;
+                        pattern: string;
+                        description: string;
+                    };
+                    dashOffsetBind: {
+                        type: string;
+                        minLength: number;
+                        pattern: string;
+                        description: string;
+                    };
                 };
             };
         };
@@ -2527,6 +2724,208 @@ declare const diagramJsonSchema: {
                 })[];
             };
         };
+        inputs: {
+            type: string;
+            description: string;
+            items: {
+                type: string;
+                required: string[];
+                additionalProperties: boolean;
+                properties: {
+                    id: {
+                        type: string;
+                        minLength: number;
+                    };
+                    kind: {
+                        type: string;
+                        enum: string[];
+                    };
+                    autoplay: {
+                        type: string;
+                    };
+                    defaultHi: {
+                        type: string;
+                    };
+                    defaultLo: {
+                        type: string;
+                    };
+                    defaultSpeedIdx: {
+                        type: string;
+                    };
+                    defaultValue: {
+                        type: string[];
+                    };
+                    defaultValues: {
+                        type: string;
+                        items: {
+                            type: string;
+                        };
+                    };
+                    defaultX: {
+                        type: string;
+                    };
+                    defaultY: {
+                        type: string;
+                    };
+                    duration: {
+                        type: string;
+                    };
+                    label: {
+                        type: string;
+                    };
+                    loop: {
+                        type: string;
+                    };
+                    max: {
+                        type: string;
+                    };
+                    maxLength: {
+                        type: string;
+                    };
+                    min: {
+                        type: string;
+                    };
+                    options: {
+                        type: string;
+                        items: {
+                            type: string;
+                        };
+                    };
+                    placeholder: {
+                        type: string;
+                    };
+                    speeds: {
+                        type: string;
+                        items: {
+                            type: string;
+                        };
+                    };
+                    step: {
+                        type: string;
+                    };
+                    xMax: {
+                        type: string;
+                    };
+                    xMin: {
+                        type: string;
+                    };
+                    yMax: {
+                        type: string;
+                    };
+                    yMin: {
+                        type: string;
+                    };
+                };
+                oneOf: ({
+                    properties: {
+                        kind: {
+                            enum: string[];
+                        };
+                        defaultValue: {
+                            type: string;
+                        };
+                    };
+                    required: string[];
+                } | {
+                    properties: {
+                        kind: {
+                            enum: string[];
+                        };
+                        defaultValue?: undefined;
+                    };
+                    required: string[];
+                })[];
+            };
+        };
+        formulas: {
+            type: string;
+            description: string;
+            additionalProperties: {
+                type: string;
+                minLength: number;
+                pattern: string;
+            };
+            propertyNames: {
+                pattern: string;
+            };
+        };
+        events: {
+            type: string;
+            description: string;
+            items: {
+                type: string;
+                required: string[];
+                additionalProperties: boolean;
+                properties: {
+                    on: {
+                        type: string;
+                        enum: string[];
+                    };
+                    handler: {
+                        type: string;
+                        minLength: number;
+                        pattern: string;
+                    };
+                    box: {
+                        type: string;
+                        minLength: number;
+                        description: string;
+                    };
+                    lane: {
+                        type: string;
+                        minLength: number;
+                        description: string;
+                    };
+                    arrow: {
+                        type: string;
+                        minLength: number;
+                        pattern: string;
+                        description: string;
+                    };
+                    diagram: {
+                        const: boolean;
+                        description: string;
+                    };
+                };
+                oneOf: {
+                    required: string[];
+                }[];
+            };
+        };
+        scrolls: {
+            type: string;
+            description: string;
+            propertyNames: {
+                pattern: string;
+            };
+            additionalProperties: {
+                type: string;
+                additionalProperties: boolean;
+                properties: {
+                    start: {
+                        type: string;
+                        minimum: number;
+                        maximum: number;
+                        description: string;
+                    };
+                    end: {
+                        type: string;
+                        minimum: number;
+                        maximum: number;
+                        description: string;
+                    };
+                    scrub: {
+                        type: string;
+                        minimum: number;
+                        maximum: number;
+                        description: string;
+                    };
+                    label: {
+                        type: string;
+                    };
+                };
+            };
+        };
     };
 };