yarramate 1.38.0 → 1.39.0

package/dist/adapters/visual-graph-entry.d.ts

@@ -1,2 +1,4 @@
 export { projectGraphForCanvas, type CanvasGraph, type CanvasNode, type CanvasEdge, } from '../graph-projection.js';
 export { foldTree, foldGraph, nestingTree, liftedEdgeId, NESTING_KIND_IDS, type FoldInput, type FoldNode, type FoldEdge, type FoldMembership, type FoldTree, type LiftedEdge, type NestingConflict, type SlotWiring, } from '../fold-tree.js';
+export { edgeLabelText, type EdgeLabelData } from '../edge-label.js';
+export { DEFAULT_LAYOUT, LAYOUT_MODES, type LayoutMode } from '../layout-mode.js';

package/dist/adapters/visual-graph-entry.js

@@ -5,3 +5,9 @@ export { projectGraphForCanvas, } from '../graph-projection.js';
 // an application is made of. `fold-tree.ts` imports nothing, so this subpath
 // stays runtime-neutral.
 export { foldTree, foldGraph, nestingTree, liftedEdgeId, NESTING_KIND_IDS, } from '../fold-tree.js';
+// What an edge says (ADR 0147) and the mode list it depends on (#587). The
+// editor entry has exported these since #576, but that entry is the mounted
+// editor, so a Worker importing one pure function from it took React and
+// cytoscape too. `edge-label.ts` and `layout-mode.ts` reach no package.
+export { edgeLabelText } from '../edge-label.js';
+export { DEFAULT_LAYOUT, LAYOUT_MODES } from '../layout-mode.js';

package/dist/edge-label.d.ts

@@ -0,0 +1,33 @@
+/**
+ * What an edge says, kept in a module that imports nothing with a runtime of
+ * its own (#587). The canvas draws with it; a host that renders the same
+ * picture somewhere else, a server-side SVG Worker, imports it from
+ * `yarramate/adapter/visual-graph` without taking elkjs, React or cytoscape.
+ * It was first published from the editor entry (#576), which is where a
+ * consumer could not use it.
+ */
+import { type LayoutMode } from './layout-mode.js';
+/** The data fields an edge's label is decided from. */
+export interface EdgeLabelData {
+    readonly name?: string | null;
+    readonly kindLabel?: string;
+    readonly coreKindLabel?: string;
+    /** An extension kind with a reading of its own (ADR 0159), else absent. */
+    readonly readingKind?: string;
+    /** A reading the endpoints decided (ADR 0160), else absent. */
+    readonly reading?: string;
+    readonly liftedCount?: number;
+}
+/**
+ * The one place that decides what an edge says (ADR 0147).
+ *
+ * A named relationship says its name. An unnamed one says its reading -
+ * "serves", or "served by" where the mode layers the served element above -
+ * unless kind labels are off, in which case the line style and arrowhead
+ * carry the kind alone. An extension kind has no reading in the table and is
+ * spelled out from its own name ("deploys to" for `deploys-to`), in the active
+ * voice whichever way it is layered, because nobody can conjugate a verb they
+ * have not seen. A lifted edge stands for several relationships and says how
+ * many.
+ */
+export declare const edgeLabelText: (data: EdgeLabelData, mode: LayoutMode, showKindLabels: boolean) => string;

package/dist/edge-label.js

@@ -0,0 +1,40 @@
+/**
+ * What an edge says, kept in a module that imports nothing with a runtime of
+ * its own (#587). The canvas draws with it; a host that renders the same
+ * picture somewhere else, a server-side SVG Worker, imports it from
+ * `yarramate/adapter/visual-graph` without taking elkjs, React or cytoscape.
+ * It was first published from the editor entry (#576), which is where a
+ * consumer could not use it.
+ */
+import { LAYERING_REVERSED_KINDS, reversesForLayering } from './layout-mode.js';
+import { humanizeKind, relationshipReading } from './relationship-reading.js';
+/**
+ * The one place that decides what an edge says (ADR 0147).
+ *
+ * A named relationship says its name. An unnamed one says its reading -
+ * "serves", or "served by" where the mode layers the served element above -
+ * unless kind labels are off, in which case the line style and arrowhead
+ * carry the kind alone. An extension kind has no reading in the table and is
+ * spelled out from its own name ("deploys to" for `deploys-to`), in the active
+ * voice whichever way it is layered, because nobody can conjugate a verb they
+ * have not seen. A lifted edge stands for several relationships and says how
+ * many.
+ */
+export const edgeLabelText = (data, mode, showKindLabels) => {
+    if (typeof data.name === 'string' && data.name !== '')
+        return data.name;
+    if (!showKindLabels)
+        return '';
+    const core = data.coreKindLabel ?? '';
+    const kind = data.kindLabel ?? core;
+    const readingKind = data.readingKind;
+    const reading = data.reading !== undefined && data.reading !== ''
+        ? data.reading
+        : readingKind !== undefined && readingKind !== core
+            ? relationshipReading(readingKind)
+            : kind !== core && kind !== ''
+                ? humanizeKind(kind)
+                : relationshipReading(core, reversesForLayering(mode) && LAYERING_REVERSED_KINDS.has(core));
+    const count = typeof data.liftedCount === 'number' ? data.liftedCount : 0;
+    return count > 1 ? `${reading} ×${count}` : reading;
+};