@transitrix/diagrams 1.0.0 → 1.1.0

package/src/webview/__tests__/entry.test.ts

@@ -1,64 +1,64 @@
-import { describe, expect, it } from 'vitest';
-
-import { api, render } from '../entry.js';
-
-const VALID_GOALS_DOC = `
-notation: goals
-id: GOALS-WEBVIEW-1
-name: "Webview entry smoke test"
-goal_types:
-  - { name: "Strategy", level: 0 }
-goals:
-  - id: GOAL-MOON-1
-    name: "Reach the moon"
-    type: "Strategy"
-    level: 0
-`;
-
-describe('webview/entry — Step 2 host API', () => {
-  it('exposes a version + supportedKinds + render() trio', () => {
-    expect(api.version).toMatch(/^\d+\.\d+\.\d+/);
-    expect(api.supportedKinds).toContain('goals');
-    expect(typeof api.render).toBe('function');
-  });
-
-  it('parses + validates + renders SVG for a well-formed goals document', () => {
-    const r = render('goals', VALID_GOALS_DOC);
-    expect(r.notation).toBe('goals');
-    expect(r.status).toBe('ok');
-    expect(r.errors).toEqual([]);
-    // Step 3 wires the goals renderer — SVG must now be non-empty and contain
-    // the goal name from the YAML.
-    expect(r.svg).toContain('<svg ');
-    expect(r.svg).toContain('Reach the moon');
-  });
-
-  it('returns YAML-PARSE on malformed input — no exception escapes to the host', () => {
-    const r = render('goals', 'goals:\n  - id: g1\n    name: [unterminated');
-    expect(r.status).toBe('error');
-    expect(r.errors[0].code).toBe('YAML-PARSE');
-  });
-
-  it('returns KIND-UNKNOWN for a non-Transitrix notation kind', () => {
-    const r = render('plantuml', VALID_GOALS_DOC);
-    expect(r.status).toBe('error');
-    expect(r.errors[0].code).toBe('KIND-UNKNOWN');
-  });
-
-  it('routes non-goals kinds to their validator after Step 4 (no NOTATION-NOT-WIRED)', () => {
-    // Every supported kind is now wired to its validator + renderer. A
-    // malformed fgca document must surface a structured validation error from
-    // the fgca validator — never the Step-2/3 "not wired" placeholder.
-    const r = render('fgca', 'changes: []\n');
-    expect(r.status).toBe('error');
-    expect(r.errors.length).toBeGreaterThan(0);
-    expect(r.errors.every((e) => e.code !== 'NOTATION-NOT-WIRED')).toBe(true);
-  });
-
-  it('surfaces goals validation errors structurally (e.g. missing notation header)', () => {
-    const r = render('goals', 'goals: []\n');
-    expect(r.status).toBe('error');
-    // parseCanonicalGoals emits GOALS-* codes for canonical-shape violations.
-    expect(r.errors.some((e) => e.code.startsWith('GOALS-'))).toBe(true);
-  });
-});
+import { describe, expect, it } from 'vitest';
+
+import { api, render } from '../entry.js';
+
+const VALID_GOALS_DOC = `
+notation: goals
+id: GOALS-WEBVIEW-1
+name: "Webview entry smoke test"
+goal_types:
+  - { name: "Strategy", level: 0 }
+goals:
+  - id: GOAL-MOON-1
+    name: "Reach the moon"
+    type: "Strategy"
+    level: 0
+`;
+
+describe('webview/entry — Step 2 host API', () => {
+  it('exposes a version + supportedKinds + render() trio', () => {
+    expect(api.version).toMatch(/^\d+\.\d+\.\d+/);
+    expect(api.supportedKinds).toContain('goals');
+    expect(typeof api.render).toBe('function');
+  });
+
+  it('parses + validates + renders SVG for a well-formed goals document', () => {
+    const r = render('goals', VALID_GOALS_DOC);
+    expect(r.notation).toBe('goals');
+    expect(r.status).toBe('ok');
+    expect(r.errors).toEqual([]);
+    // Step 3 wires the goals renderer — SVG must now be non-empty and contain
+    // the goal name from the YAML.
+    expect(r.svg).toContain('<svg ');
+    expect(r.svg).toContain('Reach the moon');
+  });
+
+  it('returns YAML-PARSE on malformed input — no exception escapes to the host', () => {
+    const r = render('goals', 'goals:\n  - id: g1\n    name: [unterminated');
+    expect(r.status).toBe('error');
+    expect(r.errors[0].code).toBe('YAML-PARSE');
+  });
+
+  it('returns KIND-UNKNOWN for a non-Transitrix notation kind', () => {
+    const r = render('plantuml', VALID_GOALS_DOC);
+    expect(r.status).toBe('error');
+    expect(r.errors[0].code).toBe('KIND-UNKNOWN');
+  });
+
+  it('routes non-goals kinds to their validator after Step 4 (no NOTATION-NOT-WIRED)', () => {
+    // Every supported kind is now wired to its validator + renderer. A
+    // malformed fgca document must surface a structured validation error from
+    // the fgca validator — never the Step-2/3 "not wired" placeholder.
+    const r = render('fgca', 'changes: []\n');
+    expect(r.status).toBe('error');
+    expect(r.errors.length).toBeGreaterThan(0);
+    expect(r.errors.every((e) => e.code !== 'NOTATION-NOT-WIRED')).toBe(true);
+  });
+
+  it('surfaces goals validation errors structurally (e.g. missing notation header)', () => {
+    const r = render('goals', 'goals: []\n');
+    expect(r.status).toBe('error');
+    // parseCanonicalGoals emits GOALS-* codes for canonical-shape violations.
+    expect(r.errors.some((e) => e.code.startsWith('GOALS-'))).toBe(true);
+  });
+});

package/src/webview/__tests__/render-goals.test.ts

@@ -1,72 +1,72 @@
-/**
- * Unit tests for the host-neutral goals SVG renderer used by the IntelliJ
- * JCEF preview bundle. The IntelliJ build can't run inside Vitest, so these
- * tests are the only place the goals rendering path is exercised on the
- * webview-bundle side of the codebase.
- */
-import { describe, expect, it } from 'vitest';
-
-import type { GoalTree } from '../../goals/types.js';
-import { renderGoalsSvg } from '../render-goals.js';
-
-const SIMPLE_TREE: GoalTree = {
-  goal_types: [
-    { name: 'Strategy', level: 0 },
-    { name: 'Tactic', level: 1 },
-  ],
-  goals: [
-    { id: 1, name: 'Reach the moon', type: 'Strategy', level: 0, parent_id: 0 },
-    { id: 2, name: 'Build a rocket', type: 'Tactic', level: 1, parent_id: 1 },
-  ],
-};
-
-describe('renderGoalsSvg', () => {
-  it('produces a self-contained <svg> with embedded theme CSS', () => {
-    const svg = renderGoalsSvg(SIMPLE_TREE, { treeName: 'Apollo' });
-    expect(svg.startsWith('<svg ')).toBe(true);
-    expect(svg).toContain('xmlns="http://www.w3.org/2000/svg"');
-    expect(svg).toContain('<style>');
-    // The shared theme CSS contract: diagram classes are defined inline.
-    expect(svg).toContain('.diagram-node');
-    expect(svg).toContain('.diagram-edge');
-    // Both goal names made it into the output.
-    expect(svg).toContain('Reach the moon');
-    expect(svg).toContain('Build a rocket');
-    // The strategy → tactic parent link rendered as an edge with the arrow marker.
-    expect(svg).toContain('marker-end="url(#arrow)"');
-    // Title block is present when treeName is supplied.
-    expect(svg).toContain('Goal tree — Apollo');
-  });
-
-  it('escapes user-controlled strings (XML safety)', () => {
-    const tree: GoalTree = {
-      goal_types: [{ name: 'Strategy', level: 0 }],
-      goals: [
-        {
-          id: 1,
-          name: 'Drop <script>alert(1)</script> & friends',
-          type: 'Strategy',
-          level: 0,
-          parent_id: 0,
-        },
-      ],
-    };
-    const svg = renderGoalsSvg(tree);
-    expect(svg).not.toContain('<script>alert(1)</script>');
-    expect(svg).toContain('&lt;script&gt;');
-    expect(svg).toContain('&amp;');
-  });
-
-  it('returns an empty SVG when the tree has no goals', () => {
-    const empty: GoalTree = { goal_types: [{ name: 'Strategy', level: 0 }], goals: [] };
-    const svg = renderGoalsSvg(empty);
-    expect(svg).toContain('<svg ');
-    expect(svg).toContain('width="0"');
-    expect(svg).toContain('height="0"');
-  });
-
-  it('omits the title block when treeName is missing', () => {
-    const svg = renderGoalsSvg(SIMPLE_TREE);
-    expect(svg).not.toContain('Goal tree —');
-  });
-});
+/**
+ * Unit tests for the host-neutral goals SVG renderer used by the IntelliJ
+ * JCEF preview bundle. The IntelliJ build can't run inside Vitest, so these
+ * tests are the only place the goals rendering path is exercised on the
+ * webview-bundle side of the codebase.
+ */
+import { describe, expect, it } from 'vitest';
+
+import type { GoalTree } from '../../goals/types.js';
+import { renderGoalsSvg } from '../render-goals.js';
+
+const SIMPLE_TREE: GoalTree = {
+  goal_types: [
+    { name: 'Strategy', level: 0 },
+    { name: 'Tactic', level: 1 },
+  ],
+  goals: [
+    { id: 1, name: 'Reach the moon', type: 'Strategy', level: 0, parent_id: 0 },
+    { id: 2, name: 'Build a rocket', type: 'Tactic', level: 1, parent_id: 1 },
+  ],
+};
+
+describe('renderGoalsSvg', () => {
+  it('produces a self-contained <svg> with embedded theme CSS', () => {
+    const svg = renderGoalsSvg(SIMPLE_TREE, { treeName: 'Apollo' });
+    expect(svg.startsWith('<svg ')).toBe(true);
+    expect(svg).toContain('xmlns="http://www.w3.org/2000/svg"');
+    expect(svg).toContain('<style>');
+    // The shared theme CSS contract: diagram classes are defined inline.
+    expect(svg).toContain('.diagram-node');
+    expect(svg).toContain('.diagram-edge');
+    // Both goal names made it into the output.
+    expect(svg).toContain('Reach the moon');
+    expect(svg).toContain('Build a rocket');
+    // The strategy → tactic parent link rendered as an edge with the arrow marker.
+    expect(svg).toContain('marker-end="url(#arrow)"');
+    // Title block is present when treeName is supplied.
+    expect(svg).toContain('Goal tree — Apollo');
+  });
+
+  it('escapes user-controlled strings (XML safety)', () => {
+    const tree: GoalTree = {
+      goal_types: [{ name: 'Strategy', level: 0 }],
+      goals: [
+        {
+          id: 1,
+          name: 'Drop <script>alert(1)</script> & friends',
+          type: 'Strategy',
+          level: 0,
+          parent_id: 0,
+        },
+      ],
+    };
+    const svg = renderGoalsSvg(tree);
+    expect(svg).not.toContain('<script>alert(1)</script>');
+    expect(svg).toContain('&lt;script&gt;');
+    expect(svg).toContain('&amp;');
+  });
+
+  it('returns an empty SVG when the tree has no goals', () => {
+    const empty: GoalTree = { goal_types: [{ name: 'Strategy', level: 0 }], goals: [] };
+    const svg = renderGoalsSvg(empty);
+    expect(svg).toContain('<svg ');
+    expect(svg).toContain('width="0"');
+    expect(svg).toContain('height="0"');
+  });
+
+  it('omits the title block when treeName is missing', () => {
+    const svg = renderGoalsSvg(SIMPLE_TREE);
+    expect(svg).not.toContain('Goal tree —');
+  });
+});