yarramate 1.24.0 → 1.25.0

package/dist/adapters/visual/protocol-contract.d.ts

@@ -267,6 +267,23 @@ export interface VisualLayoutPositions {
         readonly y: number;
     };
 }
+/**
+ * The routes the canvas was drawing when a layout was saved (ADR 0147), keyed
+ * by relationship id: absolute canvas coordinates from the source end, both
+ * endpoints included, and where along the route the label sits. Saved WITH
+ * the positions, because a route is only right for the positions it was
+ * computed for: a reader who moved one subject keeps every other edge's
+ * route, and only the moved subject's edges fall back to a straight line.
+ */
+export interface VisualLayoutRoutes {
+    readonly [relationshipId: string]: {
+        readonly points: readonly {
+            readonly x: number;
+            readonly y: number;
+        }[];
+        readonly labelAt: number | null;
+    };
+}
 /**
  * A change to a projection document, staged rather than written (ADR 0103).
  *
@@ -332,6 +349,8 @@ export interface VisualLayoutSavePayload {
      */
     readonly folded?: readonly string[];
     readonly unfolded?: readonly string[];
+    /** The routes in force at save time (ADR 0147); absent when nothing was routed. */
+    readonly routes?: VisualLayoutRoutes;
 }
 /**
  * Terminal event payload. Every reason is the runtime's to choose: only it

package/dist/adapters/visual/session-server.js

@@ -456,15 +456,16 @@ export const startVisualServer = async (options) => {
     // like a broken saved view above — presentation state must never fail a
     // session.
     const layoutDir = resolve(options.cwd, ".yarramate/visual-layout");
-    const { layouts, folds } = (() => {
+    const { layouts, folds, routes } = (() => {
         const layouts = {};
         const folds = {};
+        const routes = {};
         let entries;
         try {
             entries = readdirSync(layoutDir);
         }
         catch {
-            return { layouts, folds };
+            return { layouts, folds, routes };
         }
         for (const entry of entries) {
             if (extname(entry) !== ".yaml" && extname(entry) !== ".yml")
@@ -476,6 +477,10 @@ export const startVisualServer = async (options) => {
                     continue;
                 const sidecar = parsed;
                 layouts[sidecar.projectionId] = sidecar.positions;
+                // The routes the canvas was drawing when it saved (ADR 0147). A
+                // sidecar written before them says nothing, and the layout recomputes.
+                if (sidecar.routes !== undefined)
+                    routes[sidecar.projectionId] = sidecar.routes;
                 // A sidecar written before #473 has neither list, and says nothing
                 // about folding rather than saying "fold nothing" - the view's own
                 // default decides for it. Only a sidecar that STATES a fold overrides.
@@ -490,7 +495,7 @@ export const startVisualServer = async (options) => {
                 // Skipped sidecar: presentation state must never fail a session.
             }
         }
-        return { layouts, folds };
+        return { layouts, folds, routes };
     })();
     // `request.initialModel.graph` is the caller's compile (`buildVisualModelGraph`,
     // before invoking `yarramate-visual start`) and is only the fallback below:
@@ -505,6 +510,7 @@ export const startVisualServer = async (options) => {
         vocabulary: { conceptKinds: [], relationshipKinds: [] },
         layouts,
         ...(Object.keys(folds).length === 0 ? {} : { folds }),
+        ...(Object.keys(routes).length === 0 ? {} : { routes }),
         sourceDigests: request.initialModel.sourceDigests,
         // The request's model has no projections in it - `visual-model/v1` carries
         // a graph, not a workspace - so the fallback states nothing rather than
@@ -1424,7 +1430,7 @@ export const startVisualServer = async (options) => {
                 // never `git commit`ed. It never asks the agent anything, so it is
                 // answered here directly rather than through the pending queue a
                 // poll would drain.
-                const { projectionId, positions, folded, unfolded } = event.payload;
+                const { projectionId, positions, folded, unfolded, routes: savedRoutes } = event.payload;
                 if (!views.some((view) => view.id === projectionId)) {
                     sendFrame(socket, {
                         kind: "layout-save-result",
@@ -1446,10 +1452,16 @@ export const startVisualServer = async (options) => {
                     // sidecar written by one host is read by the other.
                     ...(folded === undefined ? {} : { folded }),
                     ...(unfolded === undefined ? {} : { unfolded }),
+                    // The routes in force, beside the positions they were computed
+                    // for (ADR 0147); a save with nothing routed writes none.
+                    ...(savedRoutes === undefined ? {} : { routes: savedRoutes }),
                 }), "utf8");
                 rendered = {
                     ...rendered,
                     layouts: { ...rendered.layouts, [projectionId]: positions },
+                    ...(savedRoutes === undefined
+                        ? {}
+                        : { routes: { ...rendered.routes, [projectionId]: savedRoutes } }),
                     ...(folded === undefined && unfolded === undefined
                         ? {}
                         : {

package/dist/adapters/visual/wire.d.ts

@@ -1,6 +1,6 @@
 import type { CanvasGraph } from '../../graph-projection.js';
 import type { PatternMembership, PatternVacancy } from '../../compiler.js';
-import type { VISUAL_PROTOCOL_VERSION, VisualApplyResultPayload, VisualAuthority, VisualBrowserInput, VisualCapabilities, VisualChoicePresentPayload, VisualDiagnostic, VisualFilterResultPayload, VisualFreezeReason, VisualKindOption, VisualPatternOption, VisualLayoutPositions, VisualLayoutSaveResultPayload, VisualResponse, VisualTerminationReason, VisualViewSummary } from './protocol-contract.js';
+import type { VISUAL_PROTOCOL_VERSION, VisualApplyResultPayload, VisualAuthority, VisualBrowserInput, VisualCapabilities, VisualChoicePresentPayload, VisualDiagnostic, VisualFilterResultPayload, VisualFreezeReason, VisualKindOption, VisualPatternOption, VisualLayoutPositions, VisualLayoutRoutes, VisualLayoutSaveResultPayload, VisualResponse, VisualTerminationReason, VisualViewSummary } from './protocol-contract.js';
 /**
  * Transport shapes the session server and the browser application both speak.
  *
@@ -77,6 +77,14 @@ export interface VisualRenderedModel {
             readonly unfolded: readonly string[];
         };
     };
+    /**
+     * The routes each saved layout was drawing (ADR 0147), keyed by projection
+     * id. A sibling of `layouts` for the reason `folds` is: a layout entry is
+     * positions, and widening it would reach every reader of it.
+     */
+    readonly routes?: {
+        readonly [projectionId: string]: VisualLayoutRoutes;
+    };
     /**
      * Which subject fills which slot of which instance (ADR 0131), and which
      * slots nothing fills (#447), forwarded so the browser can draw containment

package/dist/notation/archimate.d.ts

@@ -55,7 +55,12 @@ export interface ConceptNotation extends ShapeMeta {
 }
 export declare const CONCEPT_NOTATION: readonly ConceptNotation[];
 export declare function conceptNotationOf(kindLabel: string): ConceptNotation | null;
-export declare function kindGlyphDataUriOf(kindLabel: string): string | null;
+/**
+ * The glyph as a data URI, drawn in `ink` - the notation's own by default, or
+ * the light stroke a dark ground needs (ADR 0148). The stroke is the only
+ * thing that varies; the strokes themselves are the notation's.
+ */
+export declare function kindGlyphDataUriOf(kindLabel: string, ink?: string): string | null;
 export interface ArrowNotation {
     readonly shape: 'none' | 'diamond' | 'triangle' | 'circle' | 'vee';
     readonly fill?: 'filled' | 'hollow';

package/dist/notation/archimate.js

@@ -38,10 +38,10 @@ export const ASPECT_SHAPES = {
 const KIND_SHAPE_OVERRIDES = {
     grouping: { borderStyle: 'dashed' },
 };
-function svg(body) {
+function svg(body, ink = INK) {
     return (`<svg xmlns="http://www.w3.org/2000/svg" width="${ICON_SIZE}" height="${ICON_SIZE}" ` +
         `viewBox="0 0 ${ICON_SIZE} ${ICON_SIZE}">` +
-        `<g fill="none" stroke="${INK}" stroke-width="1" stroke-linecap="round" stroke-linejoin="round">${body}</g>` +
+        `<g fill="none" stroke="${ink}" stroke-width="1" stroke-linecap="round" stroke-linejoin="round">${body}</g>` +
         `</svg>`);
 }
 function toDataUri(svgMarkup) {
@@ -205,9 +205,14 @@ const CONCEPT_NOTATION_BY_ID = Object.fromEntries(CONCEPT_NOTATION.map((row) =>
 export function conceptNotationOf(kindLabel) {
     return CONCEPT_NOTATION_BY_ID[kindLabel] ?? null;
 }
-export function kindGlyphDataUriOf(kindLabel) {
+/**
+ * The glyph as a data URI, drawn in `ink` - the notation's own by default, or
+ * the light stroke a dark ground needs (ADR 0148). The stroke is the only
+ * thing that varies; the strokes themselves are the notation's.
+ */
+export function kindGlyphDataUriOf(kindLabel, ink = INK) {
     const glyph = CONCEPT_NOTATION_BY_ID[kindLabel]?.glyph;
-    return glyph == null ? null : toDataUri(svg(glyph));
+    return glyph == null ? null : toDataUri(svg(glyph, ink));
 }
 // The 11 rows from `graph-canvas.tsx`'s ArchiMate edge selectors (Task 11).
 const RELATIONSHIP_STYLE = {