@graphty/graph-io 0.3.42 → 0.3.44

package/dist/src/formats/graphml/styles-plain.js

@@ -0,0 +1,187 @@
+/**
+ * GraphML styles: which program wrote the file, and its styles read the way that program draws them. yEd and
+ * yFiles 3 keep their graphics in nested XML (styles-yed.ts, styles-yfiles3.ts); Gephi writes plain `r`, `g`, `b`
+ * and `size` keys; Cytoscape's GraphML export writes no visual properties at all and is recognized by its `SUID`
+ * and `shared name` keys. A GraphML file from any other writer has no styles: a key named like a style (`color`)
+ * stays data, and no program's defaults are added.
+ */
+import { canonColor } from "../../styles/canon/color.js";
+import { canonNumber } from "../../styles/canon/number.js";
+import { canonText } from "../../styles/canon/text.js";
+import { blockStyles, parseStyleBlock, STYLE_BLOCK_NAME } from "../../styles/io/block.js";
+import { StyleNotes } from "../../styles/notes.js";
+import { styleFingerprint } from "../../styles/plan/features.js";
+import { plainCell, resolveStyles } from "../../styles/plan/resolve.js";
+import { gephiRules } from "../gexf/styles.js";
+import { exactFromBlock, readYedStyles, valueColumns, yfilesColumns, } from "./styles-yed.js";
+import { readYfiles3Styles } from "./styles-yfiles3.js";
+/** Gephi's color and size keys. */
+const GEPHI_COLUMNS = ["r", "g", "b", "size"];
+/**
+ * Whether a table has Gephi's `r`, `g` and `b` columns.
+ * @param table - the node or edge table
+ * @returns true when all three are there
+ */
+function hasRgb(table) {
+    return table.has("r") && table.has("g") && table.has("b");
+}
+/**
+ * Gephi's styles: `r`, `g`, `b` as the fill of a node and the color of an edge, `size` as a node's width and
+ * height, and `label` as the label.
+ * @param snapshot - the graph
+ * @param notes - where problems are noted
+ * @param context - the work budget
+ * @returns the values
+ */
+function readGephi(snapshot, notes, context) {
+    const read = (target) => {
+        const table = target === "node" ? snapshot.nodes : snapshot.edges;
+        const n = target === "node" ? snapshot.nodeCount : snapshot.edgeCount;
+        const out = valueColumns(n);
+        const has = { rgb: hasRgb(table), size: target === "node" && table.has("size"), label: table.has("label") };
+        for (let i = 0; i < n; i++) {
+            context.budget.spend(target, 1);
+            const at = (property) => ({
+                notes,
+                target,
+                property,
+                element: i,
+                budget: context.budget,
+            });
+            readGephiRow(table, target, i, has, (property, value) => {
+                out.put(i, property, value);
+            }, at);
+        }
+        return out.values;
+    };
+    return { node: read("node"), edge: read("edge") };
+}
+/**
+ * Reads one Gephi element.
+ * @param table - the node or edge table
+ * @param target - nodes or edges
+ * @param i - the element
+ * @param has - which of Gephi's columns the table has
+ * @param has.rgb - the `r`, `g` and `b` columns
+ * @param has.size - a node `size` column
+ * @param has.label - a `label` column
+ * @param put - receives the values
+ * @param at - the sites
+ */
+function readGephiRow(table, target, i, has, put, at) {
+    if (has.rgb) {
+        const [r, g, b] = ["r", "g", "b"].map((c) => plainCell(table.value(c, i)));
+        if (r !== null && g !== null && b !== null) {
+            const property = target === "node" ? "fill" : "color";
+            put(property, canonColor({ r, g, b }, "gephi", at(property))?.color ?? null);
+        }
+    }
+    if (has.size) {
+        const v = canonNumber(plainCell(table.value("size", i)), at("width"));
+        put("width", v);
+        put("height", v);
+    }
+    if (has.label) {
+        put("label", canonText(plainCell(table.value("label", i)), at("label")));
+    }
+}
+/**
+ * For a file graphty wrote: the yEd values that are only what the writer writes for the `graphty.styles` block's own
+ * values read as the block's values (see exactFromBlock()). A block that does not parse or describes another graph
+ * changes nothing; graph-io then ignores it with a note.
+ * @param snapshot - the graph
+ * @param yed - the values read from the yEd graphics, changed in place
+ */
+function exactFromGraphtyBlock(snapshot, yed) {
+    const text = snapshot.graph.has(STYLE_BLOCK_NAME) ? plainCell(snapshot.graph.value(STYLE_BLOCK_NAME, 0)) : null;
+    if (typeof text !== "string") {
+        return;
+    }
+    const parsed = parseStyleBlock(text, styleFingerprint(snapshot));
+    const ex = parsed.ok ? blockStyles(parsed.block, snapshot, "graphml") : null;
+    if (ex === null) {
+        return;
+    }
+    exactFromBlock(yed, (target, property) => resolveStyles(ex, target, property, snapshot), { node: snapshot.nodeCount, edge: snapshot.edgeCount }, new StyleNotes());
+}
+/**
+ * The styles of a GraphML file, read the way the program that wrote it draws them, with that program's defaults
+ * beneath: yEd's and yFiles 3's nested graphics, Gephi's `r`, `g`, `b` and `size` keys, or, for Cytoscape's export,
+ * Cytoscape's default style with each node labeled by its `name`. A file from any other writer has none.
+ * @param snapshot - the graph the import built
+ * @param context - the work budget
+ * @returns the styles, or null when no writer with styles is recognized
+ */
+export function graphmlStyles(snapshot, context) {
+    const notes = new StyleNotes();
+    const readFrom = { node: yfilesColumns(snapshot.nodes), edge: yfilesColumns(snapshot.edges) };
+    const yfiles3 = readYfiles3Styles(snapshot, notes, context.budget);
+    if (yfiles3 !== null) {
+        return {
+            canonical: true,
+            dialect: "yfiles3",
+            tool: "yfiles3",
+            units: "px",
+            node: { values: yfiles3.node },
+            edge: { values: yfiles3.edge },
+            notes: notes.list(),
+            readFrom,
+        };
+    }
+    const yed = readYedStyles(snapshot, notes, context.budget);
+    if (yed !== null) {
+        exactFromGraphtyBlock(snapshot, yed);
+        return {
+            canonical: true,
+            dialect: "yed",
+            tool: "yed",
+            units: "px",
+            node: { values: yed.node },
+            edge: { values: yed.edge },
+            notes: notes.list(),
+            opacityInColor: true,
+            readFrom,
+        };
+    }
+    if (hasRgb(snapshot.nodes)) {
+        const gephi = readGephi(snapshot, notes, context);
+        const { rules, columns } = gephiRules(snapshot, gephi.node.fill, gephi.edge.color, context.budget, gephi.edge.width);
+        const used = (table) => GEPHI_COLUMNS.filter((c) => table.has(c));
+        return {
+            canonical: true,
+            dialect: "gephi",
+            tool: "gephi",
+            units: "relative",
+            node: { values: gephi.node },
+            edge: { values: gephi.edge, rules, columns },
+            notes: notes.list(),
+            readFrom: { node: used(snapshot.nodes), edge: used(snapshot.edges) },
+        };
+    }
+    if (snapshot.nodes.has("SUID") && snapshot.nodes.has("shared name")) {
+        // Cytoscape writes no visual properties into GraphML; its default style labels each node with its name
+        const label = valueColumns(snapshot.nodeCount);
+        if (snapshot.nodes.has("name")) {
+            for (let i = 0; i < snapshot.nodeCount; i++) {
+                label.put(i, "label", canonText(plainCell(snapshot.nodes.value("name", i)), {
+                    notes,
+                    target: "node",
+                    property: "label",
+                    element: i,
+                    budget: context.budget,
+                }));
+            }
+        }
+        return {
+            canonical: true,
+            dialect: "cytoscape",
+            tool: "cytoscape",
+            units: "px",
+            node: { values: label.values },
+            edge: { values: {} },
+            notes: notes.list(),
+        };
+    }
+    return null;
+}
+//# sourceMappingURL=styles-plain.js.map

package/dist/src/formats/graphml/styles-plain.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"styles-plain.js","sourceRoot":"","sources":["../../../../src/formats/graphml/styles-plain.ts"],"names":[],"mappings":"AAAA;;;;;;GAMG;AAIH,OAAO,EAAE,UAAU,EAAE,MAAM,6BAA6B,CAAC;AACzD,OAAO,EAAE,WAAW,EAAE,MAAM,8BAA8B,CAAC;AAC3D,OAAO,EAAE,SAAS,EAAE,MAAM,4BAA4B,CAAC;AACvD,OAAO,EAAE,WAAW,EAAE,eAAe,EAAE,gBAAgB,EAAE,MAAM,0BAA0B,CAAC;AAC1F,OAAO,EAAE,UAAU,EAAE,MAAM,uBAAuB,CAAC;AACnD,OAAO,EAAE,gBAAgB,EAAE,MAAM,+BAA+B,CAAC;AACjE,OAAO,EAAE,SAAS,EAAE,aAAa,EAAE,MAAM,8BAA8B,CAAC;AAExE,OAAO,EAAE,UAAU,EAAE,MAAM,mBAAmB,CAAC;AAC/C,OAAO,EACH,cAAc,EACd,aAAa,EAEb,YAAY,EAEZ,aAAa,GAChB,MAAM,iBAAiB,CAAC;AACzB,OAAO,EAAE,iBAAiB,EAAE,MAAM,qBAAqB,CAAC;AAExD,mCAAmC;AACnC,MAAM,aAAa,GAAsB,CAAC,GAAG,EAAE,GAAG,EAAE,GAAG,EAAE,MAAM,CAAC,CAAC;AAEjE;;;;GAIG;AACH,SAAS,MAAM,CAAC,KAA6B;IACzC,OAAO,KAAK,CAAC,GAAG,CAAC,GAAG,CAAC,IAAI,KAAK,CAAC,GAAG,CAAC,GAAG,CAAC,IAAI,KAAK,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC;AAC9D,CAAC;AAED;;;;;;;GAOG;AACH,SAAS,SAAS,CACd,QAAuB,EACvB,KAAiB,EACjB,OAAyB;IAEzB,MAAM,IAAI,GAAG,CAAC,MAAmB,EAAgB,EAAE;QAC/C,MAAM,KAAK,GAAG,MAAM,KAAK,MAAM,CAAC,CAAC,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC,CAAC,QAAQ,CAAC,KAAK,CAAC;QAClE,MAAM,CAAC,GAAG,MAAM,KAAK,MAAM,CAAC,CAAC,CAAC,QAAQ,CAAC,SAAS,CAAC,CAAC,CAAC,QAAQ,CAAC,SAAS,CAAC;QACtE,MAAM,GAAG,GAAG,YAAY,CAAC,CAAC,CAAC,CAAC;QAC5B,MAAM,GAAG,GAAG,EAAE,GAAG,EAAE,MAAM,CAAC,KAAK,CAAC,EAAE,IAAI,EAAE,MAAM,KAAK,MAAM,IAAI,KAAK,CAAC,GAAG,CAAC,MAAM,CAAC,EAAE,KAAK,EAAE,KAAK,CAAC,GAAG,CAAC,OAAO,CAAC,EAAE,CAAC;QAC5G,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,CAAC,EAAE,CAAC,EAAE,EAAE,CAAC;YACzB,OAAO,CAAC,MAAM,CAAC,KAAK,CAAC,MAAM,EAAE,CAAC,CAAC,CAAC;YAChC,MAAM,EAAE,GAAG,CAAC,QAAgB,EAAqC,EAAE,CAAC,CAAC;gBACjE,KAAK;gBACL,MAAM;gBACN,QAAQ;gBACR,OAAO,EAAE,CAAC;gBACV,MAAM,EAAE,OAAO,CAAC,MAAM;aACzB,CAAC,CAAC;YACH,YAAY,CACR,KAAK,EACL,MAAM,EACN,CAAC,EACD,GAAG,EACH,CAAC,QAAQ,EAAE,KAAK,EAAE,EAAE;gBAChB,GAAG,CAAC,GAAG,CAAC,CAAC,EAAE,QAAQ,EAAE,KAAK,CAAC,CAAC;YAChC,CAAC,EACD,EAAE,CACL,CAAC;QACN,CAAC;QACD,OAAO,GAAG,CAAC,MAAM,CAAC;IACtB,CAAC,CAAC;IACF,OAAO,EAAE,IAAI,EAAE,IAAI,CAAC,MAAM,CAAC,EAAE,IAAI,EAAE,IAAI,CAAC,MAAM,CAAC,EAAE,CAAC;AACtD,CAAC;AAED;;;;;;;;;;;GAWG;AACH,SAAS,YAAY,CACjB,KAA6B,EAC7B,MAAmB,EACnB,CAAS,EACT,GAA+E,EAC/E,GAAyD,EACzD,EAA2D;IAE3D,IAAI,GAAG,CAAC,GAAG,EAAE,CAAC;QACV,MAAM,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC,GAAG,CAAC,GAAG,EAAE,GAAG,EAAE,GAAG,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,SAAS,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC;QAC3E,IAAI,CAAC,KAAK,IAAI,IAAI,CAAC,KAAK,IAAI,IAAI,CAAC,KAAK,IAAI,EAAE,CAAC;YACzC,MAAM,QAAQ,GAAG,MAAM,KAAK,MAAM,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,OAAO,CAAC;YACtD,GAAG,CAAC,QAAQ,EAAE,UAAU,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE,EAAE,OAAO,EAAE,EAAE,CAAC,QAAQ,CAAC,CAAC,EAAE,KAAK,IAAI,IAAI,CAAC,CAAC;QACjF,CAAC;IACL,CAAC;IACD,IAAI,GAAG,CAAC,IAAI,EAAE,CAAC;QACX,MAAM,CAAC,GAAG,WAAW,CAAC,SAAS,CAAC,KAAK,CAAC,KAAK,CAAC,MAAM,EAAE,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,OAAO,CAAC,CAAC,CAAC;QACtE,GAAG,CAAC,OAAO,EAAE,CAAC,CAAC,CAAC;QAChB,GAAG,CAAC,QAAQ,EAAE,CAAC,CAAC,CAAC;IACrB,CAAC;IACD,IAAI,GAAG,CAAC,KAAK,EAAE,CAAC;QACZ,GAAG,CAAC,OAAO,EAAE,SAAS,CAAC,SAAS,CAAC,KAAK,CAAC,KAAK,CAAC,OAAO,EAAE,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC;IAC7E,CAAC;AACL,CAAC;AAED;;;;;;GAMG;AACH,SAAS,qBAAqB,CAAC,QAAuB,EAAE,GAAY;IAChE,MAAM,IAAI,GAAG,QAAQ,CAAC,KAAK,CAAC,GAAG,CAAC,gBAAgB,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC,QAAQ,CAAC,KAAK,CAAC,KAAK,CAAC,gBAAgB,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC;IAChH,IAAI,OAAO,IAAI,KAAK,QAAQ,EAAE,CAAC;QAC3B,OAAO;IACX,CAAC;IACD,MAAM,MAAM,GAAG,eAAe,CAAC,IAAI,EAAE,gBAAgB,CAAC,QAAQ,CAAC,CAAC,CAAC;IACjE,MAAM,EAAE,GAAG,MAAM,CAAC,EAAE,CAAC,CAAC,CAAC,WAAW,CAAC,MAAM,CAAC,KAAK,EAAE,QAAQ,EAAE,SAAS,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC;IAC7E,IAAI,EAAE,KAAK,IAAI,EAAE,CAAC;QACd,OAAO;IACX,CAAC;IACD,cAAc,CACV,GAAG,EACH,CAAC,MAAM,EAAE,QAAQ,EAAE,EAAE,CAAC,aAAa,CAAC,EAAE,EAAE,MAAM,EAAE,QAAiB,EAAE,QAAQ,CAAC,EAC5E,EAAE,IAAI,EAAE,QAAQ,CAAC,SAAS,EAAE,IAAI,EAAE,QAAQ,CAAC,SAAS,EAAE,EACtD,IAAI,UAAU,EAAE,CACnB,CAAC;AACN,CAAC;AAED;;;;;;;GAOG;AACH,MAAM,UAAU,aAAa,CAAC,QAAuB,EAAE,OAAyB;IAC5E,MAAM,KAAK,GAAG,IAAI,UAAU,EAAE,CAAC;IAC/B,MAAM,QAAQ,GAAG,EAAE,IAAI,EAAE,aAAa,CAAC,QAAQ,CAAC,KAAK,CAAC,EAAE,IAAI,EAAE,aAAa,CAAC,QAAQ,CAAC,KAAK,CAAC,EAAE,CAAC;IAC9F,MAAM,OAAO,GAAG,iBAAiB,CAAC,QAAQ,EAAE,KAAK,EAAE,OAAO,CAAC,MAAM,CAAC,CAAC;IACnE,IAAI,OAAO,KAAK,IAAI,EAAE,CAAC;QACnB,OAAO;YACH,SAAS,EAAE,IAAI;YACf,OAAO,EAAE,SAAS;YAClB,IAAI,EAAE,SAAS;YACf,KAAK,EAAE,IAAI;YACX,IAAI,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,IAAI,EAAE;YAC9B,IAAI,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,IAAI,EAAE;YAC9B,KAAK,EAAE,KAAK,CAAC,IAAI,EAAE;YACnB,QAAQ;SACX,CAAC;IACN,CAAC;IACD,MAAM,GAAG,GAAG,aAAa,CAAC,QAAQ,EAAE,KAAK,EAAE,OAAO,CAAC,MAAM,CAAC,CAAC;IAC3D,IAAI,GAAG,KAAK,IAAI,EAAE,CAAC;QACf,qBAAqB,CAAC,QAAQ,EAAE,GAAG,CAAC,CAAC;QACrC,OAAO;YACH,SAAS,EAAE,IAAI;YACf,OAAO,EAAE,KAAK;YACd,IAAI,EAAE,KAAK;YACX,KAAK,EAAE,IAAI;YACX,IAAI,EAAE,EAAE,MAAM,EAAE,GAAG,CAAC,IAAI,EAAE;YAC1B,IAAI,EAAE,EAAE,MAAM,EAAE,GAAG,CAAC,IAAI,EAAE;YAC1B,KAAK,EAAE,KAAK,CAAC,IAAI,EAAE;YACnB,cAAc,EAAE,IAAI;YACpB,QAAQ;SACX,CAAC;IACN,CAAC;IACD,IAAI,MAAM,CAAC,QAAQ,CAAC,KAAK,CAAC,EAAE,CAAC;QACzB,MAAM,KAAK,GAAG,SAAS,CAAC,QAAQ,EAAE,KAAK,EAAE,OAAO,CAAC,CAAC;QAClD,MAAM,EAAE,KAAK,EAAE,OAAO,EAAE,GAAG,UAAU,CACjC,QAAQ,EACR,KAAK,CAAC,IAAI,CAAC,IAAI,EACf,KAAK,CAAC,IAAI,CAAC,KAAK,EAChB,OAAO,CAAC,MAAM,EACd,KAAK,CAAC,IAAI,CAAC,KAAK,CACnB,CAAC;QACF,MAAM,IAAI,GAAG,CAAC,KAA6B,EAAY,EAAE,CAAC,aAAa,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC;QACpG,OAAO;YACH,SAAS,EAAE,IAAI;YACf,OAAO,EAAE,OAAO;YAChB,IAAI,EAAE,OAAO;YACb,KAAK,EAAE,UAAU;YACjB,IAAI,EAAE,EAAE,MAAM,EAAE,KAAK,CAAC,IAAI,EAAE;YAC5B,IAAI,EAAE,EAAE,MAAM,EAAE,KAAK,CAAC,IAAI,EAAE,KAAK,EAAE,OAAO,EAAE;YAC5C,KAAK,EAAE,KAAK,CAAC,IAAI,EAAE;YACnB,QAAQ,EAAE,EAAE,IAAI,EAAE,IAAI,CAAC,QAAQ,CAAC,KAAK,CAAC,EAAE,IAAI,EAAE,IAAI,CAAC,QAAQ,CAAC,KAAK,CAAC,EAAE;SACvE,CAAC;IACN,CAAC;IACD,IAAI,QAAQ,CAAC,KAAK,CAAC,GAAG,CAAC,MAAM,CAAC,IAAI,QAAQ,CAAC,KAAK,CAAC,GAAG,CAAC,aAAa,CAAC,EAAE,CAAC;QAClE,uGAAuG;QACvG,MAAM,KAAK,GAAG,YAAY,CAAC,QAAQ,CAAC,SAAS,CAAC,CAAC;QAC/C,IAAI,QAAQ,CAAC,KAAK,CAAC,GAAG,CAAC,MAAM,CAAC,EAAE,CAAC;YAC7B,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,QAAQ,CAAC,SAAS,EAAE,CAAC,EAAE,EAAE,CAAC;gBAC1C,KAAK,CAAC,GAAG,CACL,CAAC,EACD,OAAO,EACP,SAAS,CAAC,SAAS,CAAC,QAAQ,CAAC,KAAK,CAAC,KAAK,CAAC,MAAM,EAAE,CAAC,CAAC,CAAC,EAAE;oBAClD,KAAK;oBACL,MAAM,EAAE,MAAM;oBACd,QAAQ,EAAE,OAAO;oBACjB,OAAO,EAAE,CAAC;oBACV,MAAM,EAAE,OAAO,CAAC,MAAM;iBACzB,CAAC,CACL,CAAC;YACN,CAAC;QACL,CAAC;QACD,OAAO;YACH,SAAS,EAAE,IAAI;YACf,OAAO,EAAE,WAAW;YACpB,IAAI,EAAE,WAAW;YACjB,KAAK,EAAE,IAAI;YACX,IAAI,EAAE,EAAE,MAAM,EAAE,KAAK,CAAC,MAAM,EAAE;YAC9B,IAAI,EAAE,EAAE,MAAM,EAAE,EAAE,EAAE;YACpB,KAAK,EAAE,KAAK,CAAC,IAAI,EAAE;SACtB,CAAC;IACN,CAAC;IACD,OAAO,IAAI,CAAC;AAChB,CAAC"}

package/dist/src/formats/graphml/styles-yed.d.ts

@@ -0,0 +1,179 @@
+/**
+ * yEd styles (yFiles for Java 2.x GraphML): reading every realizer a yEd graphics tree holds (`y:ShapeNode`,
+ * `y:GenericNode`, `y:GroupNode`, `y:SVGNode`, `y:PolyLineEdge`, `y:BezierEdge`, ...) into the neutral style
+ * vocabulary, and writing a graph's styles back as `y:ShapeNode` and `y:PolyLineEdge` graphics. The trees are the
+ * json columns the GraphML importer keeps (tree.ts), never the typed `yfiles.*` columns read from them.
+ *
+ * The tree helpers here are shared with the yFiles 3 reader.
+ */
+import type { GraphSnapshot } from "@graphty/graph-format";
+import { type CanonSite } from "../../styles/canon/site.js";
+import type { ExporterStyleInput } from "../../styles/io/writer.js";
+import type { StyleNotes } from "../../styles/notes.js";
+import type { StyleTarget, StyleValue, StyleWorkBudget, StyleWriteCapabilities } from "../../styles/types.js";
+import type { LossNote } from "../../types.js";
+/** A tree object as tree.ts builds it: `@_<name>` attributes, `#text`, and child elements by name. */
+type Tree = Record<string, unknown>;
+/**
+ * Whether a value is a tree object.
+ * @param value - the value
+ * @returns true for a non-array object
+ */
+export declare function isTree(value: unknown): value is Tree;
+/**
+ * The local part of an element name: `y:ShapeNode` is `ShapeNode`, whatever the prefix.
+ * @param name - the name as written
+ * @returns the local name
+ */
+export declare function localOf(name: string): string;
+/**
+ * The child elements of a tree node with a local name, in file order.
+ * @param node - the tree node
+ * @param local - the local name
+ * @returns the children
+ */
+export declare function treeChildren(node: unknown, local: string): unknown[];
+/**
+ * The first child element of a tree node with a local name.
+ * @param node - the tree node
+ * @param local - the local name
+ * @returns the child, or undefined
+ */
+export declare function treeChild(node: unknown, local: string): unknown;
+/**
+ * An attribute of a tree node.
+ * @param node - the tree node
+ * @param name - the attribute name as written
+ * @returns its text, or undefined
+ */
+export declare function treeAttr(node: unknown, name: string): string | undefined;
+/**
+ * The text of an element: the element itself when it has neither attributes nor children, else its `#text`.
+ * @param node - the tree node
+ * @returns the text, or null
+ */
+export declare function treeText(node: unknown): string | null;
+/**
+ * Every column of a table the GraphML importer made from yFiles keys: the trees and the typed `yfiles.*` columns
+ * read from them. They hold the styles themselves, so the planner never explains a style with them.
+ * @param table - the node or edge table
+ * @returns their names
+ */
+export declare function yfilesColumns(table: GraphSnapshot["nodes"]): string[];
+/** One element's canonical value of a property; null leaves it unset. */
+export type PutValue = (property: string, value: StyleValue | null) => void;
+/** Where a value of an element was read, by property. */
+export type SiteOf = (property: string) => CanonSite;
+/**
+ * The shape a yEd flowchart configuration draws: a GraphML GenericNode's `configuration`, or a yEd GML node's
+ * `customconfiguration`.
+ * @param configuration - the configuration
+ * @returns the neutral shape, or null for a configuration that is not one of the flowchart shapes known here
+ */
+export declare function flowchartShape(configuration: string): string | null;
+/** yEd's font styles, as label weight and italic. */
+export declare const FONT_STYLES: ReadonlyMap<string, readonly [string, boolean]>;
+/** Canonical values per property, by element index. */
+export type ValueColumns = Record<string, (StyleValue | null)[]>;
+/**
+ * A collector of canonical values for one target.
+ * @param n - the element count
+ * @returns the values and a setter for element i
+ */
+export declare function valueColumns(n: number): {
+    readonly values: ValueColumns;
+    put(i: number, property: string, value: StyleValue | null): void;
+};
+/** What the yEd reader read. */
+export interface YedRead {
+    /** Node values. */
+    readonly node: ValueColumns;
+    /** Edge values. */
+    readonly edge: ValueColumns;
+}
+/**
+ * The yEd styles of a graph: each element's realizer read into canonical values.
+ * @param snapshot - the graph
+ * @param notes - where problems are noted
+ * @param budget - the work budget
+ * @returns the values, or null when no element has a yEd realizer
+ */
+export declare function readYedStyles(snapshot: GraphSnapshot, notes: StyleNotes, budget: StyleWorkBudget): YedRead | null;
+/**
+ * What the GraphML writer holds natively: yEd `y:ShapeNode` and `y:PolyLineEdge` graphics. The `graphty.styles`
+ * block is a graph `<data>` under its own key, and the per-element values its rules read are keys of their own.
+ * @category Built-in formats
+ */
+export declare const GRAPHML_STYLE_CAPABILITIES: StyleWriteCapabilities;
+/** A written value and whether it is the exact value. */
+interface Written {
+    readonly value: string;
+    readonly exact: boolean;
+}
+/** yEd's ShapeNode types, by the neutral shape each draws exactly. */
+export declare const YED_SHAPES: ReadonlyMap<string, string>;
+/** yEd's line types, by the neutral line style each draws exactly. */
+export declare const YED_LINES: ReadonlyMap<string, string>;
+/** yEd's arrows, by the neutral arrow each draws exactly. */
+export declare const YED_ARROWS: ReadonlyMap<string, string>;
+/**
+ * A value of a table, or the nearest value the table has.
+ * @param table - neutral value to yEd value
+ * @param value - the neutral value
+ * @param nearest - the yEd value written when the table has none
+ * @returns the written value
+ */
+export declare function yedValue(table: ReadonlyMap<string, string>, value: string, nearest: string): Written;
+/**
+ * A color with an alpha from an opacity, as yEd writes it: `#RRGGBB`, or `#RRGGBBAA` with the alpha last.
+ * @param color - the canonical color
+ * @param opacity - the opacity, or null
+ * @returns the text
+ */
+export declare function yedColor(color: string, opacity: StyleValue | null): string;
+/** Records a value written as the nearest one yEd has. */
+type Approximate = (property: string, value: StyleValue) => void;
+/**
+ * A value in yEd's spelling, recorded as approximated when yEd has no exact one.
+ * @param table - yEd's spellings
+ * @param value - the neutral value
+ * @param nearest - the spelling written when there is no exact one
+ * @param property - the property, for the approximation note
+ * @param approximate - records approximations
+ * @returns the spelling
+ */
+export declare function yedSpelled(table: ReadonlyMap<string, string>, value: string, nearest: string, property: string, approximate: Approximate): string;
+/**
+ * For a file graphty wrote: where a value read from the yEd graphics is what the writer writes for the block's own
+ * value (a pentagon written as a hexagon, an opacity rounded to yEd's 255 steps), the block's exact value is the
+ * truth, so a re-import gives back the same rules; a value another program changed since stays the truth.
+ * @param read - the values the reader read, changed in place
+ * @param picture - each element's value of a property under the block's rules
+ * @param counts - the node and edge counts
+ * @param counts.node - the node count
+ * @param counts.edge - the edge count
+ * @param notes - a scratch note list for reading back what the writer writes
+ */
+export declare function exactFromBlock(read: YedRead, picture: (target: StyleTarget, property: string) => readonly (StyleValue | null)[], counts: {
+    readonly node: number;
+    readonly edge: number;
+}, notes: StyleNotes): void;
+/** A GraphML export with styles worked out. */
+interface GraphmlStyledExport {
+    /** The graph to write: the yFiles drawing columns replaced by yEd graphics written from the styles. */
+    readonly snapshot: GraphSnapshot;
+    /** W_STYLE_APPROXIMATED for every value written as the nearest one yEd has. */
+    readonly notes: readonly LossNote[];
+}
+/**
+ * Works out a GraphML export with styles: every node and edge column made from yFiles keys (the graphics trees,
+ * the typed `yfiles.*` columns and yFiles 3's drawing state) is replaced by yEd graphics written from what graphty
+ * draws, keeping each node's position and each edge's bends from the graphics it had; graph data from yFiles 3
+ * keys goes too, since its `y:` elements are not yEd's.
+ * @param snapshot - the graph handed to the exporter
+ * @param input - the styles, or undefined when none are written
+ * @returns the styled export, or null without styles
+ */
+export declare function graphmlStyledExport(snapshot: GraphSnapshot, input: ExporterStyleInput | undefined): GraphmlStyledExport | null;
+export {};
+//# sourceMappingURL=styles-yed.d.ts.map

package/dist/src/formats/graphml/styles-yed.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"styles-yed.d.ts","sourceRoot":"","sources":["../../../../src/formats/graphml/styles-yed.ts"],"names":[],"mappings":"AAAA;;;;;;;GAOG;AAEH,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,uBAAuB,CAAC;AAQ3D,OAAO,EAAE,KAAK,SAAS,EAAkC,MAAM,4BAA4B,CAAC;AAI5F,OAAO,KAAK,EAAE,kBAAkB,EAAE,MAAM,2BAA2B,CAAC;AACpE,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,uBAAuB,CAAC;AAExD,OAAO,KAAK,EAAE,WAAW,EAAE,UAAU,EAAE,eAAe,EAAE,sBAAsB,EAAE,MAAM,uBAAuB,CAAC;AAC9G,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,gBAAgB,CAAC;AAI/C,sGAAsG;AACtG,KAAK,IAAI,GAAG,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;AAEpC;;;;GAIG;AACH,wBAAgB,MAAM,CAAC,KAAK,EAAE,OAAO,GAAG,KAAK,IAAI,IAAI,CAEpD;AAED;;;;GAIG;AACH,wBAAgB,OAAO,CAAC,IAAI,EAAE,MAAM,GAAG,MAAM,CAG5C;AAED;;;;;GAKG;AACH,wBAAgB,YAAY,CAAC,IAAI,EAAE,OAAO,EAAE,KAAK,EAAE,MAAM,GAAG,OAAO,EAAE,CAmBpE;AAED;;;;;GAKG;AACH,wBAAgB,SAAS,CAAC,IAAI,EAAE,OAAO,EAAE,KAAK,EAAE,MAAM,GAAG,OAAO,CAW/D;AAED;;;;;GAKG;AACH,wBAAgB,QAAQ,CAAC,IAAI,EAAE,OAAO,EAAE,IAAI,EAAE,MAAM,GAAG,MAAM,GAAG,SAAS,CAMxE;AAED;;;;GAIG;AACH,wBAAgB,QAAQ,CAAC,IAAI,EAAE,OAAO,GAAG,MAAM,GAAG,IAAI,CASrD;AAiBD;;;;;GAKG;AACH,wBAAgB,aAAa,CAAC,KAAK,EAAE,aAAa,CAAC,OAAO,CAAC,GAAG,MAAM,EAAE,CAQrE;AAID,yEAAyE;AACzE,MAAM,MAAM,QAAQ,GAAG,CAAC,QAAQ,EAAE,MAAM,EAAE,KAAK,EAAE,UAAU,GAAG,IAAI,KAAK,IAAI,CAAC;AAE5E,yDAAyD;AACzD,MAAM,MAAM,MAAM,GAAG,CAAC,QAAQ,EAAE,MAAM,KAAK,SAAS,CAAC;AAyFrD;;;;;GAKG;AACH,wBAAgB,cAAc,CAAC,aAAa,EAAE,MAAM,GAAG,MAAM,GAAG,IAAI,CAInE;AAsCD,qDAAqD;AACrD,eAAO,MAAM,WAAW,EAAE,WAAW,CAAC,MAAM,EAAE,SAAS,CAAC,MAAM,EAAE,OAAO,CAAC,CAKtE,CAAC;AA6NH,uDAAuD;AACvD,MAAM,MAAM,YAAY,GAAG,MAAM,CAAC,MAAM,EAAE,CAAC,UAAU,GAAG,IAAI,CAAC,EAAE,CAAC,CAAC;AAEjE;;;;GAIG;AACH,wBAAgB,YAAY,CAAC,CAAC,EAAE,MAAM,GAAG;IACrC,QAAQ,CAAC,MAAM,EAAE,YAAY,CAAC;IAC9B,GAAG,CAAC,CAAC,EAAE,MAAM,EAAE,QAAQ,EAAE,MAAM,EAAE,KAAK,EAAE,UAAU,GAAG,IAAI,GAAG,IAAI,CAAC;CACpE,CAWA;AAED,gCAAgC;AAChC,MAAM,WAAW,OAAO;IACpB,mBAAmB;IACnB,QAAQ,CAAC,IAAI,EAAE,YAAY,CAAC;IAC5B,mBAAmB;IACnB,QAAQ,CAAC,IAAI,EAAE,YAAY,CAAC;CAC/B;AAED;;;;;;GAMG;AACH,wBAAgB,aAAa,CAAC,QAAQ,EAAE,aAAa,EAAE,KAAK,EAAE,UAAU,EAAE,MAAM,EAAE,eAAe,GAAG,OAAO,GAAG,IAAI,CA0CjH;AAID;;;;GAIG;AACH,eAAO,MAAM,0BAA0B,EAAE,sBAmCvC,CAAC;AAEH,yDAAyD;AACzD,UAAU,OAAO;IACb,QAAQ,CAAC,KAAK,EAAE,MAAM,CAAC;IACvB,QAAQ,CAAC,KAAK,EAAE,OAAO,CAAC;CAC3B;AAED,sEAAsE;AACtE,eAAO,MAAM,UAAU,EAAE,WAAW,CAAC,MAAM,EAAE,MAAM,CAWjD,CAAC;AAEH,sEAAsE;AACtE,eAAO,MAAM,SAAS,EAAE,WAAW,CAAC,MAAM,EAAE,MAAM,CAKhD,CAAC;AAEH,6DAA6D;AAC7D,eAAO,MAAM,UAAU,EAAE,WAAW,CAAC,MAAM,EAAE,MAAM,CAYjD,CAAC;AAeH;;;;;;GAMG;AACH,wBAAgB,QAAQ,CAAC,KAAK,EAAE,WAAW,CAAC,MAAM,EAAE,MAAM,CAAC,EAAE,KAAK,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM,GAAG,OAAO,CAOpG;AAED;;;;;GAKG;AACH,wBAAgB,QAAQ,CAAC,KAAK,EAAE,MAAM,EAAE,OAAO,EAAE,UAAU,GAAG,IAAI,GAAG,MAAM,CAY1E;AAED,0DAA0D;AAC1D,KAAK,WAAW,GAAG,CAAC,QAAQ,EAAE,MAAM,EAAE,KAAK,EAAE,UAAU,KAAK,IAAI,CAAC;AAEjE;;;;;;;;GAQG;AACH,wBAAgB,UAAU,CACtB,KAAK,EAAE,WAAW,CAAC,MAAM,EAAE,MAAM,CAAC,EAClC,KAAK,EAAE,MAAM,EACb,OAAO,EAAE,MAAM,EACf,QAAQ,EAAE,MAAM,EAChB,WAAW,EAAE,WAAW,GACzB,MAAM,CAMR;AAiMD;;;;;;;;;;GAUG;AACH,wBAAgB,cAAc,CAC1B,IAAI,EAAE,OAAO,EACb,OAAO,EAAE,CAAC,MAAM,EAAE,WAAW,EAAE,QAAQ,EAAE,MAAM,KAAK,SAAS,CAAC,UAAU,GAAG,IAAI,CAAC,EAAE,EAClF,MAAM,EAAE;IAAE,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC;IAAC,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAA;CAAE,EACxD,KAAK,EAAE,UAAU,GAClB,IAAI,CAoBN;AA+BD,+CAA+C;AAC/C,UAAU,mBAAmB;IACzB,uGAAuG;IACvG,QAAQ,CAAC,QAAQ,EAAE,aAAa,CAAC;IACjC,+EAA+E;IAC/E,QAAQ,CAAC,KAAK,EAAE,SAAS,QAAQ,EAAE,CAAC;CACvC;AAgHD;;;;;;;;GAQG;AACH,wBAAgB,mBAAmB,CAC/B,QAAQ,EAAE,aAAa,EACvB,KAAK,EAAE,kBAAkB,GAAG,SAAS,GACtC,mBAAmB,GAAG,IAAI,CA2D5B"}