@cardenelabs/dragon 0.26.0 → 0.28.0

package/src/types.ts

@@ -3,7 +3,7 @@
  * docs/cdl/text-dsl-spec.md の文法を AST に変換した中間表現
  */
 
-import type { CdlDiagram, NodeKind, Tone, EdgeStyle, EdgeHead, EdgeHeadFill, EdgeReveal, ClassRelationType, SequenceMessageKind } from "@cardenelabs/cdl";
+import type { CdlDiagram, NodeKind, Tone, EdgeStyle, EdgeHead, EdgeHeadFill, EdgeReveal, RelationFocus, ClassRelationType, SequenceMessageKind } from "@cardenelabs/cdl";
 import type { DslOnlyKind } from "./v05/parser";
 import type { DslDirection, DslPalette } from "./keywords";
 
@@ -91,13 +91,13 @@ export type Position = {
 };
 
 /**
- * canvas pivot (CAR-1693 Phase 1) の DSL 表面 `pos: {x, y}` を保持する型。
- * auto layout の compute value からの offset (dx, dy) を表す。 element の `layoutPos:` が
- * undefined なら auto layout の値をそのまま採用 (catalog 100+ backward compat)、 set 済なら
- * Phase 2 の applyPosOffset pass が offset として適用する。
+ * 自動で決まった位置からのずらし (dx, dy) (#1971)。
  *
- * naming = DSL 表面 syntax は user 提案 wording (`pos:`) を維持、 内部 AST は既存 `pos: Position`
- * (source line/column) との collision 回避のため `layoutPos:` に rename する 2 層設計。
+ * JSON は `pos: { x, y }`、記法は `offsetX` / `offsetY` で書く。 内部では、行番号を持つ
+ * `pos: Position` と名前が重ならないよう `layoutPos` に入れる。
+ *
+ * 書かなければ自動の配置のまま。 書くと組み立ての出口 (`applyLayoutOffsets`) が 1 度配置してから
+ * 配置後の位置に足して置き直す。 箱と縦列は位置が動き、矢印は名前のずらしに足す。
  */
 export type LayoutPos = {
   x: number;
@@ -168,6 +168,16 @@ export type DslDocument = {
    * 段に関わらず最初から全部描く。 描き手の `CdlDiagram.edgeReveal` にそのまま渡る。
    */
   reveal?: EdgeReveal;
+  /**
+   * 箱に触れると関係する線だけを光らせるか (`relations:`、 #1757)。
+   *
+   * 既定 (`off`) は何もしない。 `hover` と書くと、箱に触れた時に その箱 ・ 繋がる線 ・
+   * 相手の箱だけが光り、他が沈む。 描き手の `CdlDiagram.relationFocus` にそのまま渡る。
+   *
+   * クラス図と ER 図は **順番を持たない** 図で、段を追う見せ方は「どの順で読ませるか」 しか
+   * 運ばない。 触れた箱の関係を光らせれば、読み手の問いにその場で答えられる。
+   */
+  relations?: RelationFocus;
   /**
    * 図の並ぶ向き (`direction:`、 #1494)。
    *
@@ -371,6 +381,14 @@ export type DslActor = {
    * 解析の時点ではパーツの定義を知らないため、 名前を決めずに持っておく。
    */
   colorHex?: string;
+  /**
+   * 部品に `color:` で書いた色の名前 (`成功` 等) (#1973)。
+   *
+   * 部品の色の状態は色番号しか受けず、色の名前は箱の色 (`tone`) にしか効かない。 部品には
+   * 箱の色を渡さないため、書いても絵が変わらない。 黙って捨てると手掛かりが残らないので、
+   * 書いた名前を残して組み立て側が知らせる。
+   */
+  partColorName?: Tone;
   /**
    * parts state override (partId set 時のみ有効)。 kind + 既存 reserved fields を除いた
    * inline option の残り (`v: 50` / `count: 100` 等) を state 名 → initial 値 map として保持。
@@ -410,35 +428,14 @@ export type DslActor = {
    */
   posRel?: RelativePos;
   /**
-   * canvas pivot UX 修正 (B1 individual node isolation)。 actor 1 件が生成する複数 sub-node
-   * (sequence の header / spacer / footer / s{N} 等) の中で「特定 sub-node だけを固定 / resize」
-   * するための nested override map。 key = sub-node id 相当の short key (`header` / `footer` /
-   * `spacer` / `s0` 等)、 value = posX/Y/W/H の 4 field。 compile 側は対応 CDL node に単独反映、
-   * 同 actor の他 sub-node は影響を受けない (lane 全体 posX とは独立経路)。
-   */
-  nodes?: Record<string, DslActorNodeOverride>;
-  /**
-   * canvas pivot (CAR-1693 Phase 1) DSL 表面 `pos: {x, y}` 由来の layout offset。 未指定は auto
-   * layout の compute value そのまま (backward compat)、 set 済なら Phase 2 の applyPosOffset で
-   * (auto x + layoutPos.x, auto y + layoutPos.y) に shift される。 既存 posX/posY (絶対座標) は
-   * 別 mechanism で、 layoutPos は auto layout からの nudge (dx, dy)。
+   * 箱の位置のずらし (#1971)。 配置後の箱の中心を (x, y) だけ動かす。 `posX` / `posY` (座標) とは
+   * 別の欄で、座標も書いた時は座標で置いた位置からずらす。 見本 (parts) は見本 1 つ分をまとめて動かす。
+   * 同じ縦列の箱に近づくと、描画側が間隔を保つようそちらを押し下げる。
    */
   layoutPos?: LayoutPos;
   pos: Position;
 };
 
-/**
- * canvas pivot UX 修正 (B1) = actor 内 sub-node 単位で「絶対座標 / サイズ」 を固定するための
- * override 値。 全 field optional、 posX / posY が両方 set 済なら CDL 側で該当 sub-node の
- * auto layout を skip、 明示座標をそのまま採用する。 posW / posH は width / height の上書き。
- */
-export type DslActorNodeOverride = {
-  posX?: number;
-  posY?: number;
-  posW?: number;
-  posH?: number;
-};
-
 /** 流れ (1 行 = 1 step) (v0.5+ ... inline option 拡張) */
 export type DslStep = {
   no: number;
@@ -465,8 +462,8 @@ export type DslStep = {
   /**
    * 矢印の先の形 (#1462)。 書かなければ従来どおり塗った三角。
    *
-   * 4 図の設計は **端の形で関係の種類を示す** = 三角 (継ぐ) / 菱 (持つ) /
-   * 開いた矢 (使う) / 鳥の足 (多)。 書けないと 4 種とも同じ三角になり、
+   * 4 図の設計は **端の形で関係の種類を示す** = 三角 (継承・実装) / 菱 (集約・コンポジション) /
+   * 開いた矢 (関連・依存) / 鳥の足 (多)。 書けないと 4 種とも同じ三角になり、
    * 線の種類 (実線 / 点線) だけで 6 種の関係を区別することになる。
    *
    * 受ける語は描画側の `EDGE_HEADS` から導く = 描画側が増やせば書けるようになる。
@@ -474,10 +471,16 @@ export type DslStep = {
   head?: EdgeHead;
   /** 出どころ側の端の形 (#1466)。 ER は端ごとに違う個数を示すので両端に要る */
   tailHead?: EdgeHead;
-  /** 端の印の塗り (#1466)。 白抜きの菱が「持つ」、塗った菱が「抱える」 */
+  /** 端の印の塗り (#1466)。 白抜きの菱が集約、塗った菱がコンポジション */
   headFill?: EdgeHeadFill;
   /** 出どころ側の印の塗り (#1466) */
   tailHeadFill?: EdgeHeadFill;
+  /**
+   * クラス図の出どころ側の多重度 (#1771)。 `sub` (行き先の端の多重度) と対。
+   *
+   * クラス図でだけ効く (関係の語 `relation` と同じ)。 engine が出どころの端の近くに添える。
+   */
+  tailSub?: string;
   /**
    * クラス図の関係の種類 (#1466)。 書くと線と端の形と塗りと付く側がまとめて決まる。
    *
@@ -500,10 +503,19 @@ export type DslStep = {
   /** true で説明文を矢印の線の上に重ねる。 分岐図の条件ラベル用。 */
   overlay?: boolean;
   /**
-   * canvas pivot (CAR-1693 Phase 1) DSL 表面 `pos: {x, y}` 由来の layout offset。 step の edge
-   * label 位置を auto layout compute から (dx, dy) shift する。 未指定は auto、 set 済は Phase 2 で適用。
+   * 矢印の位置のずらし (#1971)。 矢印の通り道は両端の箱で決まるので、名前のずらし
+   * (`labelOffsetX` / `labelOffsetY`) に足して名前だけを動かす。
    */
   layoutPos?: LayoutPos;
+  /**
+   * 部品 (parts) の端で、矢印を繋ぐ部品の中の要素の id (#1979)。 出どころ側が `fromPartNode`、
+   * 行き先側が `toPartNode`。
+   *
+   * 要素を 1 つだけ持つ部品は書かなくてもその要素に繋ぐ。 要素を 2 つ以上持つ部品は外枠を持たず
+   * 同格の要素が並ぶため、1 つを自動で選ぶと「その要素だけ」 を指す矢印に見える。 書き手が名指しする。
+   */
+  fromPartNode?: string;
+  toPartNode?: string;
   pos: Position;
 };
 
@@ -516,18 +528,25 @@ export type DslLane = {
   contain?: boolean;
   lifeline?: boolean;
   /**
-   * canvas pivot (CAR-1693 Phase 1) DSL 表面 `pos: {x, y}` 由来の layout offset。 lane の x 座標を
-   * auto layout compute から (dx, dy) shift する。 未指定は auto、 set 済は Phase 2 で適用。
+   * 縦列の位置のずらし (#1971)。 配置後の縦列の左上を (x, y) だけ動かし、中の箱も一緒に動く。
+   * 1 本でもずらすと全ての縦列を配置後の位置と大きさで固定し、動いた箱を元の位置に留めるので、
+   * 他の縦列とその箱は動かない。
    */
   layoutPos?: LayoutPos;
   pos: Position;
 };
 
-/** group 宣言 (v0.5+ top-level groups section、 topology preset 専用) */
+/**
+ * 組の宣言 (v0.5+ top-level groups section)。
+ *
+ * `lanes` に並べた縦列とその中の箱を、 縦列の位置が決まった後に 1 つの枠 (`group-{id}`) で囲む (#1972)。
+ * 図に無い縦列は除いて囲み、 1 本も無ければ枠を描かない。 間に束ねない縦列を挟むと、 その縦列ごと囲む。
+ * どちらも知らせで伝える。
+ */
 export type DslGroup = {
   id: string;
   label?: string;
-  lanes: string[]; // 内包する lane id
+  lanes: string[]; // 囲む縦列の id
   pos: Position;
 };
 

package/src/v05/input-table.generated.ts

@@ -25,7 +25,7 @@ export const つまみの表: Record<string, 図形の定義> = {
   dropdown: {
     必須: ["options", "defaultValue"],
     欄: {
-      options: "文字列の並び",
+      options: "選択肢の並び",
       defaultValue: "文字列",
       label: "文字列",
     },
@@ -33,7 +33,7 @@ export const つまみの表: Record<string, 図形の定義> = {
   "multi-select": {
     必須: ["options", "defaultValues"],
     欄: {
-      options: "文字列の並び",
+      options: "選択肢の並び",
       defaultValues: "文字列の並び",
       label: "文字列",
     },
@@ -50,7 +50,7 @@ export const つまみの表: Record<string, 図形の定義> = {
   radio: {
     必須: ["options", "defaultValue"],
     欄: {
-      options: "文字列の並び",
+      options: "選択肢の並び",
       defaultValue: "文字列",
       label: "文字列",
     },
@@ -89,7 +89,7 @@ export const つまみの表: Record<string, 図形の定義> = {
   tabs: {
     必須: ["options", "defaultValue"],
     欄: {
-      options: "文字列の並び",
+      options: "選択肢の並び",
       defaultValue: "文字列",
       label: "文字列",
     },
@@ -119,6 +119,8 @@ export const つまみの表: Record<string, 図形の定義> = {
     欄: {
       defaultValue: "真偽",
       label: "文字列",
+      onLabel: "文字列",
+      offLabel: "文字列",
     },
   },
   xypad: {

package/src/v05/parser-types.ts

@@ -13,9 +13,20 @@
  *
  * `数の並び` は #1389 で足した。 描画側のつまみに `readonly number[]` の欄が 1 つあり
  * (`timeline` の再生速度の候補)、`文字列の並び` として読むと数が文字列のまま図に載る。
+ *
+ * `選択肢の並び` は #1920 で足した。 選択肢を持つ入力欄の `options` で、要素は文字列か
+ * `{ value, label }` の組 (描画側の `CdlInputOption`)。 `文字列の並び` として読むと組を `,` で割る。
  */
 export type 欄の形 =
-  "数" | "文字列" | "数か文字列" | "文字列の並び" | "数の並び" | "向き" | "組の並び" | "真偽";
+  | "数"
+  | "文字列"
+  | "数か文字列"
+  | "文字列の並び"
+  | "数の並び"
+  | "向き"
+  | "組の並び"
+  | "真偽"
+  | "選択肢の並び";
 
 /** 1 つの種類が受ける、必須の欄と全欄の形 */
 export type 図形の定義 = { 必須: readonly string[]; 欄: Record<string, 欄の形> };