@graphty/graph-io 0.0.0 → 0.2.1

package/dist/src/formats/json/dialect.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"dialect.d.ts","sourceRoot":"","sources":["../../../../src/formats/json/dialect.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;GAYG;AAEH,OAAO,EAAE,KAAK,SAAS,EAAE,MAAM,uBAAuB,CAAC;AAGvD,OAAO,EAAE,KAAK,kBAAkB,EAAE,MAAM,gBAAgB,CAAC;AAEzD,qDAAqD;AACrD,MAAM,MAAM,WAAW,GAAG,WAAW,GAAG,IAAI,GAAG,KAAK,GAAG,WAAW,GAAG,YAAY,GAAG,KAAK,CAAC;AAE1F,4DAA4D;AAC5D,eAAO,MAAM,aAAa,EAAE,SAAS,WAAW,EAO9C,CAAC;AAEH,mFAAmF;AACnF,eAAO,MAAM,QAAQ,SAAS,CAAC;AAE/B;;;;GAIG;AACH,MAAM,WAAW,aAAa;IAC1B,wCAAwC;IACxC,QAAQ,CAAC,OAAO,CAAC,EAAE,WAAW,GAAG,SAAS,CAAC;IAC3C,6EAA6E;IAC7E,QAAQ,CAAC,QAAQ,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IACvC,wGAAwG;IACxG,QAAQ,CAAC,SAAS,CAAC,EAAE,MAAM,GAAG,IAAI,GAAG,SAAS,CAAC;IAC/C,mFAAmF;IACnF,QAAQ,CAAC,UAAU,CAAC,EAAE,OAAO,GAAG,SAAS,CAAC;IAC1C,6DAA6D;IAC7D,QAAQ,CAAC,SAAS,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IACxC,6DAA6D;IAC7D,QAAQ,CAAC,SAAS,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IACxC,2BAA2B;IAC3B,QAAQ,CAAC,EAAE,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IACjC,6BAA6B;IAC7B,QAAQ,CAAC,IAAI,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IACnC,wDAAwD;IACxD,QAAQ,CAAC,cAAc,CAAC,EAAE,OAAO,GAAG,SAAS,CAAC;IAC9C,sGAAsG;IACtG,QAAQ,CAAC,SAAS,CAAC,EAAE,QAAQ,CAAC,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC,GAAG,SAAS,CAAC;CACtE;AAED;;;;GAIG;AACH,wBAAgB,YAAY,CAAC,KAAK,EAAE,OAAO,GAAG,KAAK,IAAI,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAE7E;AAED;;;;;;GAMG;AACH,wBAAgB,MAAM,CAAC,MAAM,EAAE,QAAQ,CAAC,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC,EAAE,GAAG,EAAE,MAAM,GAAG,OAAO,CAEtF;AAED;;;;GAIG;AACH,wBAAgB,aAAa,CAAC,KAAK,EAAE,OAAO,GAAG,KAAK,IAAI,WAAW,CAElE;AAED;;;;;;;;;GASG;AACH,wBAAgB,gBAAgB,CAAC,IAAI,EAAE,OAAO,GAAG,WAAW,GAAG,IAAI,CAsClE;AAeD;;;;;GAKG;AACH,wBAAgB,WAAW,CAAC,IAAI,EAAE,SAAS,GAAG,aAAa,CAoB1D;AAED,2GAA2G;AAC3G,eAAO,MAAM,wBAAwB,EAAE,QAAQ,CAAC,MAAM,CAAC,WAAW,EAAE,OAAO,CAAC,CAO1E,CAAC;AAuEH;;;;;;;;;GASG;AACH,wBAAgB,mBAAmB,CAAC,OAAO,EAAE,WAAW,GAAG,kBAAkB,CAE5E;AAED,2FAA2F;AAC3F,eAAO,MAAM,sBAAsB,EAAE,WAAW,CAAC,MAAM,CASrD,CAAC;AAEH,wFAAwF;AACxF,eAAO,MAAM,yBAAyB,EAAE,WAAW,CAAC,MAAM,CAAqD,CAAC;AAEhH;;;;GAIG;AACH,eAAO,MAAM,MAAM;IACf,qGAAqG;;IAErG,qFAAqF;;EAEvF,CAAC;AAEH,gGAAgG;AAChG,eAAO,MAAM,qBAAqB,EAAE,SAAS,MAAM,EAA6C,CAAC;AAEjG,0EAA0E;AAC1E,eAAO,MAAM,qBAAqB,EAAE,SAAS,MAAM,EAA2C,CAAC;AAE/F,8FAA8F;AAC9F,eAAO,MAAM,eAAe,aAAa,CAAC;AAE1C,wFAAwF;AACxF,eAAO,MAAM,cAAc,YAAY,CAAC;AAExC,kFAAkF;AAClF,eAAO,MAAM,aAAa,WAAW,CAAC"}

package/dist/src/formats/json/dialect.js

@@ -0,0 +1,262 @@
+/**
+ * What the JSON importer and exporter share (design sections 8.2 and 8.5): the dialect names, the
+ * reserved `meta.extra.json` shape record the importer writes and the exporter reads back, the
+ * per-dialect capability tables, the fixed key sets of each dialect and the small JSON value
+ * helpers both sides use.
+ *
+ * Dialects: NetworkX node-link (`nodes` + `links` / `edges`, graph-level `directed` / `multigraph`
+ * / `graph`), the d3 lineage of the same shape (`links`, `name` ids, integer index endpoints),
+ * JSON Graph Format v2 (`graph.nodes` keyed by id, per-edge `directed`, hyperedges), Cytoscape.js
+ * elements (`data.id` / `data.source` / `data.target`, `position`, `classes`, `data.parent`),
+ * graphology serialisation (`key` / `attributes`, `undirected` edges, `options.type` / `multi`) and
+ * vis.js (`from` / `to`).
+ */
+import { capabilities } from "../../common/export.js";
+/** Every dialect name, for option checking and messages. */
+export const JSON_DIALECTS = Object.freeze([
+    "node-link",
+    "d3",
+    "jgf",
+    "cytoscape",
+    "graphology",
+    "vis",
+]);
+/** The key under `meta.extra` that holds the shape record (design section 8.5). */
+export const META_KEY = "json";
+/**
+ * Whether a value is a plain JSON object (not null, not an array).
+ * @param value - any value
+ * @returns true for an object that is not an array
+ */
+export function isJsonObject(value) {
+    return typeof value === "object" && value !== null && !Array.isArray(value);
+}
+/**
+ * Whether a record has an own property; JSON.parse output is checked with hasOwnProperty so a key
+ * named "constructor" or "__proto__" is never read from the prototype.
+ * @param record - the record
+ * @param key - the key
+ * @returns true when the key is an own property
+ */
+export function hasKey(record, key) {
+    return Object.prototype.hasOwnProperty.call(record, key);
+}
+/**
+ * Whether a text names a dialect.
+ * @param value - any value
+ * @returns true for one of JSON_DIALECTS
+ */
+export function isJsonDialect(value) {
+    return typeof value === "string" && JSON_DIALECTS.includes(value);
+}
+/**
+ * The dialect of a parsed JSON document, by the shape rules of design section 8.2 (Cytoscape:
+ * `elements` or a top-level array of `{ data }` elements; JGF: `graph.nodes` / `graph.edges` or
+ * `graphs[]`; graphology: `options.type` / `options.multi`, `key` nodes without `id`, edges with
+ * `undirected` or an `attributes` record; vis: edges with `from` / `to`; d3: `links` without
+ * `directed` / `multigraph` / `graph`; else node-link). Pure: the importer wraps it with its issue
+ * codes, the registry's sniff() uses it on a head that parses as a whole document.
+ * @param root - the parsed document
+ * @returns the dialect, or null when the document is not a graph document in any dialect
+ */
+export function sniffJsonDialect(root) {
+    if (Array.isArray(root)) {
+        const first = firstJsonObject(root);
+        return root.length === 0 || (first !== null && isJsonObject(first.data)) ? "cytoscape" : null;
+    }
+    if (!isJsonObject(root)) {
+        return null;
+    }
+    if (hasKey(root, "elements")) {
+        return "cytoscape";
+    }
+    if (isJsonObject(root.graph) && (hasKey(root.graph, "nodes") || hasKey(root.graph, "edges"))) {
+        return "jgf";
+    }
+    if (Array.isArray(root.graphs)) {
+        return "jgf";
+    }
+    if (!hasKey(root, "nodes") && !hasKey(root, "edges") && !hasKey(root, "links")) {
+        return null;
+    }
+    const firstNode = firstJsonObject(root.nodes);
+    const firstEdge = firstJsonObject(hasKey(root, "edges") ? root.edges : root.links);
+    if (isJsonObject(root.options) && (hasKey(root.options, "type") || hasKey(root.options, "multi"))) {
+        return "graphology";
+    }
+    if (firstNode !== null && hasKey(firstNode, "key") && !hasKey(firstNode, "id")) {
+        return "graphology";
+    }
+    if (firstEdge !== null && !hasKey(firstEdge, "from")) {
+        if (hasKey(firstEdge, "undirected") || isJsonObject(firstEdge.attributes)) {
+            return "graphology";
+        }
+    }
+    if (firstEdge !== null && hasKey(firstEdge, "from") && hasKey(firstEdge, "to") && !hasKey(firstEdge, "source")) {
+        return "vis";
+    }
+    const bare = !hasKey(root, "directed") && !hasKey(root, "multigraph") && !hasKey(root, "graph");
+    return bare && hasKey(root, "links") ? "d3" : "node-link";
+}
+/**
+ * The first object of an array, or null.
+ * @param value - maybe an array
+ * @returns the first element that is an object
+ */
+function firstJsonObject(value) {
+    if (!Array.isArray(value)) {
+        return null;
+    }
+    const found = value.find((item) => isJsonObject(item));
+    return isJsonObject(found) ? found : null;
+}
+/**
+ * The shape record of a snapshot's metadata, or an empty record when the snapshot did not come
+ * from the JSON importer.
+ * @param meta - the snapshot's metadata
+ * @returns the fields found under `meta.extra.json`, each only when it has the expected type
+ */
+export function shapeMetaOf(meta) {
+    const raw = meta.extra[META_KEY];
+    if (!isJsonObject(raw)) {
+        return {};
+    }
+    const text = (key) => (typeof raw[key] === "string" ? raw[key] : undefined);
+    const flag = (key) => (typeof raw[key] === "boolean" ? raw[key] : undefined);
+    const { nodeIdKey } = raw;
+    return {
+        dialect: isJsonDialect(raw.dialect) ? raw.dialect : undefined,
+        edgesKey: text("edgesKey"),
+        nodeIdKey: nodeIdKey === null || typeof nodeIdKey === "string" ? nodeIdKey : undefined,
+        indexLinks: flag("indexLinks"),
+        sourceKey: text("sourceKey"),
+        targetKey: text("targetKey"),
+        id: text("id"),
+        type: text("type"),
+        allowSelfLoops: flag("allowSelfLoops"),
+        cytoscape: isJsonObject(raw.cytoscape) ? raw.cytoscape : undefined,
+    };
+}
+/** The direction a dialect assumes when the file declares none (design section 8.4, `defaultDirected`). */
+export const DIALECT_DEFAULT_DIRECTED = Object.freeze({
+    "node-link": false,
+    d3: false,
+    jgf: true,
+    cytoscape: true,
+    graphology: true,
+    vis: false,
+});
+/**
+ * The dtypes a JSON dialect keeps as declared: JSON declares no types, so a value reads back as
+ * what the importer's inference gives it (design section 5.1: integral numbers i32, other numbers
+ * f64, booleans, strings). f32 values re-read as f64 differ from the f32 ones, u32 / u8 come back
+ * i32, dict comes back string, a multi-component or list value comes back json.
+ */
+const JSON_DTYPES = Object.freeze(["f64", "i32", "bool", "string"]);
+const COMMON = {
+    multiEdges: true,
+    selfLoops: true,
+    idCharset: "any",
+    dtypes: JSON_DTYPES,
+    components: false,
+    lists: false,
+    json: true,
+    defaults: false,
+    options: false,
+    temporal: "none",
+    positions: false,
+    viz: false,
+};
+const TABLES = Object.freeze({
+    "node-link": capabilities({
+        ...COMMON,
+        mixedDirection: false,
+        edgeIds: "none",
+        hierarchy: false,
+        graphAttributes: true,
+    }),
+    d3: capabilities({
+        ...COMMON,
+        mixedDirection: false,
+        edgeIds: "none",
+        hierarchy: false,
+        graphAttributes: false,
+    }),
+    jgf: capabilities({
+        ...COMMON,
+        mixedDirection: true,
+        edgeIds: "optional",
+        hierarchy: false,
+        graphAttributes: true,
+    }),
+    cytoscape: capabilities({
+        ...COMMON,
+        positions: true,
+        mixedDirection: false,
+        edgeIds: "required",
+        hierarchy: true,
+        graphAttributes: true,
+    }),
+    graphology: capabilities({
+        ...COMMON,
+        mixedDirection: true,
+        edgeIds: "optional",
+        hierarchy: false,
+        graphAttributes: true,
+    }),
+    vis: capabilities({
+        ...COMMON,
+        mixedDirection: false,
+        edgeIds: "optional",
+        hierarchy: false,
+        graphAttributes: false,
+    }),
+});
+/**
+ * What one dialect can express (design section 8.5): positions and visual columns are written as
+ * plain attributes (an array for a multi-component column) and read back without their role,
+ * except Cytoscape's `position` object; containment only as the Cytoscape `data.parent`; mixed
+ * direction only where the dialect carries a per-edge flag (JGF `directed`, graphology
+ * `undirected`); edge ids where the dialect has a slot (not node-link / d3); nothing temporal;
+ * graph attributes everywhere but d3 (the bare shape) and vis.
+ * @param dialect - the dialect
+ * @returns its frozen capability table
+ */
+export function dialectCapabilities(dialect) {
+    return TABLES[dialect];
+}
+/** The Cytoscape element-level keys (everything else on an element lives under `data`). */
+export const CYTOSCAPE_ELEMENT_KEYS = new Set([
+    "selected",
+    "selectable",
+    "locked",
+    "grabbable",
+    "pannable",
+    "removed",
+    "scratch",
+    "renderedPosition",
+]);
+/** The Cytoscape element keys the importer maps structurally rather than to columns. */
+export const CYTOSCAPE_STRUCTURAL_KEYS = new Set(["data", "group", "position", "classes"]);
+/**
+ * The suffix the importer appends to a column name that collides with a structural column or a
+ * reserved key of its dialect (design section 5.6 names collisions deterministically); the exporter
+ * strips it when the value goes back to the level the suffix names.
+ */
+export const SUFFIX = Object.freeze({
+    /** A Cytoscape `data` key or a JGF / graphology attribute that collides with a structural column. */
+    data: "#data",
+    /** An element-level key the dialect does not define (Cytoscape, JGF, graphology). */
+    element: "#element",
+});
+/** The default source keys of a node-link edge record, tried in order (as fromRecords does). */
+export const NODE_LINK_SOURCE_KEYS = Object.freeze(["source", "src", "from"]);
+/** The default target keys of a node-link edge record, tried in order. */
+export const NODE_LINK_TARGET_KEYS = Object.freeze(["target", "dst", "to"]);
+/** The name of the position column every JSON dialect writes / reads (design section 5.2). */
+export const POSITION_COLUMN = "position";
+/** The name of the Cytoscape classes column (a list of strings with role "classes"). */
+export const CLASSES_COLUMN = "classes";
+/** The name of the Cytoscape parent column (u32 refersTo node, role "parent"). */
+export const PARENT_COLUMN = "parent";
+//# sourceMappingURL=dialect.js.map

package/dist/src/formats/json/dialect.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"dialect.js","sourceRoot":"","sources":["../../../../src/formats/json/dialect.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;GAYG;AAIH,OAAO,EAAE,YAAY,EAAE,MAAM,wBAAwB,CAAC;AAMtD,4DAA4D;AAC5D,MAAM,CAAC,MAAM,aAAa,GAA2B,MAAM,CAAC,MAAM,CAAC;IAC/D,WAAW;IACX,IAAI;IACJ,KAAK;IACL,WAAW;IACX,YAAY;IACZ,KAAK;CACR,CAAC,CAAC;AAEH,mFAAmF;AACnF,MAAM,CAAC,MAAM,QAAQ,GAAG,MAAM,CAAC;AA8B/B;;;;GAIG;AACH,MAAM,UAAU,YAAY,CAAC,KAAc;IACvC,OAAO,OAAO,KAAK,KAAK,QAAQ,IAAI,KAAK,KAAK,IAAI,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC;AAChF,CAAC;AAED;;;;;;GAMG;AACH,MAAM,UAAU,MAAM,CAAC,MAAyC,EAAE,GAAW;IACzE,OAAO,MAAM,CAAC,SAAS,CAAC,cAAc,CAAC,IAAI,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;AAC7D,CAAC;AAED;;;;GAIG;AACH,MAAM,UAAU,aAAa,CAAC,KAAc;IACxC,OAAO,OAAO,KAAK,KAAK,QAAQ,IAAK,aAAmC,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC;AAC7F,CAAC;AAED;;;;;;;;;GASG;AACH,MAAM,UAAU,gBAAgB,CAAC,IAAa;IAC1C,IAAI,KAAK,CAAC,OAAO,CAAC,IAAI,CAAC,EAAE,CAAC;QACtB,MAAM,KAAK,GAAG,eAAe,CAAC,IAAI,CAAC,CAAC;QACpC,OAAO,IAAI,CAAC,MAAM,KAAK,CAAC,IAAI,CAAC,KAAK,KAAK,IAAI,IAAI,YAAY,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,CAAC,WAAW,CAAC,CAAC,CAAC,IAAI,CAAC;IAClG,CAAC;IACD,IAAI,CAAC,YAAY,CAAC,IAAI,CAAC,EAAE,CAAC;QACtB,OAAO,IAAI,CAAC;IAChB,CAAC;IACD,IAAI,MAAM,CAAC,IAAI,EAAE,UAAU,CAAC,EAAE,CAAC;QAC3B,OAAO,WAAW,CAAC;IACvB,CAAC;IACD,IAAI,YAAY,CAAC,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,KAAK,EAAE,OAAO,CAAC,IAAI,MAAM,CAAC,IAAI,CAAC,KAAK,EAAE,OAAO,CAAC,CAAC,EAAE,CAAC;QAC3F,OAAO,KAAK,CAAC;IACjB,CAAC;IACD,IAAI,KAAK,CAAC,OAAO,CAAC,IAAI,CAAC,MAAM,CAAC,EAAE,CAAC;QAC7B,OAAO,KAAK,CAAC;IACjB,CAAC;IACD,IAAI,CAAC,MAAM,CAAC,IAAI,EAAE,OAAO,CAAC,IAAI,CAAC,MAAM,CAAC,IAAI,EAAE,OAAO,CAAC,IAAI,CAAC,MAAM,CAAC,IAAI,EAAE,OAAO,CAAC,EAAE,CAAC;QAC7E,OAAO,IAAI,CAAC;IAChB,CAAC;IACD,MAAM,SAAS,GAAG,eAAe,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;IAC9C,MAAM,SAAS,GAAG,eAAe,CAAC,MAAM,CAAC,IAAI,EAAE,OAAO,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;IACnF,IAAI,YAAY,CAAC,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,OAAO,EAAE,MAAM,CAAC,IAAI,MAAM,CAAC,IAAI,CAAC,OAAO,EAAE,OAAO,CAAC,CAAC,EAAE,CAAC;QAChG,OAAO,YAAY,CAAC;IACxB,CAAC;IACD,IAAI,SAAS,KAAK,IAAI,IAAI,MAAM,CAAC,SAAS,EAAE,KAAK,CAAC,IAAI,CAAC,MAAM,CAAC,SAAS,EAAE,IAAI,CAAC,EAAE,CAAC;QAC7E,OAAO,YAAY,CAAC;IACxB,CAAC;IACD,IAAI,SAAS,KAAK,IAAI,IAAI,CAAC,MAAM,CAAC,SAAS,EAAE,MAAM,CAAC,EAAE,CAAC;QACnD,IAAI,MAAM,CAAC,SAAS,EAAE,YAAY,CAAC,IAAI,YAAY,CAAC,SAAS,CAAC,UAAU,CAAC,EAAE,CAAC;YACxE,OAAO,YAAY,CAAC;QACxB,CAAC;IACL,CAAC;IACD,IAAI,SAAS,KAAK,IAAI,IAAI,MAAM,CAAC,SAAS,EAAE,MAAM,CAAC,IAAI,MAAM,CAAC,SAAS,EAAE,IAAI,CAAC,IAAI,CAAC,MAAM,CAAC,SAAS,EAAE,QAAQ,CAAC,EAAE,CAAC;QAC7G,OAAO,KAAK,CAAC;IACjB,CAAC;IACD,MAAM,IAAI,GAAG,CAAC,MAAM,CAAC,IAAI,EAAE,UAAU,CAAC,IAAI,CAAC,MAAM,CAAC,IAAI,EAAE,YAAY,CAAC,IAAI,CAAC,MAAM,CAAC,IAAI,EAAE,OAAO,CAAC,CAAC;IAChG,OAAO,IAAI,IAAI,MAAM,CAAC,IAAI,EAAE,OAAO,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,WAAW,CAAC;AAC9D,CAAC;AAED;;;;GAIG;AACH,SAAS,eAAe,CAAC,KAAc;IACnC,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,EAAE,CAAC;QACxB,OAAO,IAAI,CAAC;IAChB,CAAC;IACD,MAAM,KAAK,GAAY,KAAK,CAAC,IAAI,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,YAAY,CAAC,IAAI,CAAC,CAAC,CAAC;IAChE,OAAO,YAAY,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,IAAI,CAAC;AAC9C,CAAC;AAED;;;;;GAKG;AACH,MAAM,UAAU,WAAW,CAAC,IAAe;IACvC,MAAM,GAAG,GAAY,IAAI,CAAC,KAAK,CAAC,QAAQ,CAAC,CAAC;IAC1C,IAAI,CAAC,YAAY,CAAC,GAAG,CAAC,EAAE,CAAC;QACrB,OAAO,EAAE,CAAC;IACd,CAAC;IACD,MAAM,IAAI,GAAG,CAAC,GAAW,EAAsB,EAAE,CAAC,CAAC,OAAO,GAAG,CAAC,GAAG,CAAC,KAAK,QAAQ,CAAC,CAAC,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC;IACxG,MAAM,IAAI,GAAG,CAAC,GAAW,EAAuB,EAAE,CAAC,CAAC,OAAO,GAAG,CAAC,GAAG,CAAC,KAAK,SAAS,CAAC,CAAC,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC;IAC1G,MAAM,EAAE,SAAS,EAAE,GAAG,GAAG,CAAC;IAC1B,OAAO;QACH,OAAO,EAAE,aAAa,CAAC,GAAG,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,OAAO,CAAC,CAAC,CAAC,SAAS;QAC7D,QAAQ,EAAE,IAAI,CAAC,UAAU,CAAC;QAC1B,SAAS,EAAE,SAAS,KAAK,IAAI,IAAI,OAAO,SAAS,KAAK,QAAQ,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,SAAS;QACtF,UAAU,EAAE,IAAI,CAAC,YAAY,CAAC;QAC9B,SAAS,EAAE,IAAI,CAAC,WAAW,CAAC;QAC5B,SAAS,EAAE,IAAI,CAAC,WAAW,CAAC;QAC5B,EAAE,EAAE,IAAI,CAAC,IAAI,CAAC;QACd,IAAI,EAAE,IAAI,CAAC,MAAM,CAAC;QAClB,cAAc,EAAE,IAAI,CAAC,gBAAgB,CAAC;QACtC,SAAS,EAAE,YAAY,CAAC,GAAG,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,SAAS,CAAC,CAAC,CAAC,SAAS;KACrE,CAAC;AACN,CAAC;AAED,2GAA2G;AAC3G,MAAM,CAAC,MAAM,wBAAwB,GAA2C,MAAM,CAAC,MAAM,CAAC;IAC1F,WAAW,EAAE,KAAK;IAClB,EAAE,EAAE,KAAK;IACT,GAAG,EAAE,IAAI;IACT,SAAS,EAAE,IAAI;IACf,UAAU,EAAE,IAAI;IAChB,GAAG,EAAE,KAAK;CACb,CAAC,CAAC;AAEH;;;;;GAKG;AACH,MAAM,WAAW,GAAG,MAAM,CAAC,MAAM,CAAC,CAAC,KAAK,EAAE,KAAK,EAAE,MAAM,EAAE,QAAQ,CAAU,CAAC,CAAC;AAE7E,MAAM,MAAM,GAAG;IACX,UAAU,EAAE,IAAI;IAChB,SAAS,EAAE,IAAI;IACf,SAAS,EAAE,KAAK;IAChB,MAAM,EAAE,WAAW;IACnB,UAAU,EAAE,KAAK;IACjB,KAAK,EAAE,KAAK;IACZ,IAAI,EAAE,IAAI;IACV,QAAQ,EAAE,KAAK;IACf,OAAO,EAAE,KAAK;IACd,QAAQ,EAAE,MAAM;IAChB,SAAS,EAAE,KAAK;IAChB,GAAG,EAAE,KAAK;CACJ,CAAC;AAEX,MAAM,MAAM,GAAsD,MAAM,CAAC,MAAM,CAAC;IAC5E,WAAW,EAAE,YAAY,CAAC;QACtB,GAAG,MAAM;QACT,cAAc,EAAE,KAAK;QACrB,OAAO,EAAE,MAAM;QACf,SAAS,EAAE,KAAK;QAChB,eAAe,EAAE,IAAI;KACxB,CAAC;IACF,EAAE,EAAE,YAAY,CAAC;QACb,GAAG,MAAM;QACT,cAAc,EAAE,KAAK;QACrB,OAAO,EAAE,MAAM;QACf,SAAS,EAAE,KAAK;QAChB,eAAe,EAAE,KAAK;KACzB,CAAC;IACF,GAAG,EAAE,YAAY,CAAC;QACd,GAAG,MAAM;QACT,cAAc,EAAE,IAAI;QACpB,OAAO,EAAE,UAAU;QACnB,SAAS,EAAE,KAAK;QAChB,eAAe,EAAE,IAAI;KACxB,CAAC;IACF,SAAS,EAAE,YAAY,CAAC;QACpB,GAAG,MAAM;QACT,SAAS,EAAE,IAAI;QACf,cAAc,EAAE,KAAK;QACrB,OAAO,EAAE,UAAU;QACnB,SAAS,EAAE,IAAI;QACf,eAAe,EAAE,IAAI;KACxB,CAAC;IACF,UAAU,EAAE,YAAY,CAAC;QACrB,GAAG,MAAM;QACT,cAAc,EAAE,IAAI;QACpB,OAAO,EAAE,UAAU;QACnB,SAAS,EAAE,KAAK;QAChB,eAAe,EAAE,IAAI;KACxB,CAAC;IACF,GAAG,EAAE,YAAY,CAAC;QACd,GAAG,MAAM;QACT,cAAc,EAAE,KAAK;QACrB,OAAO,EAAE,UAAU;QACnB,SAAS,EAAE,KAAK;QAChB,eAAe,EAAE,KAAK;KACzB,CAAC;CACL,CAAC,CAAC;AAEH;;;;;;;;;GASG;AACH,MAAM,UAAU,mBAAmB,CAAC,OAAoB;IACpD,OAAO,MAAM,CAAC,OAAO,CAAC,CAAC;AAC3B,CAAC;AAED,2FAA2F;AAC3F,MAAM,CAAC,MAAM,sBAAsB,GAAwB,IAAI,GAAG,CAAC;IAC/D,UAAU;IACV,YAAY;IACZ,QAAQ;IACR,WAAW;IACX,UAAU;IACV,SAAS;IACT,SAAS;IACT,kBAAkB;CACrB,CAAC,CAAC;AAEH,wFAAwF;AACxF,MAAM,CAAC,MAAM,yBAAyB,GAAwB,IAAI,GAAG,CAAC,CAAC,MAAM,EAAE,OAAO,EAAE,UAAU,EAAE,SAAS,CAAC,CAAC,CAAC;AAEhH;;;;GAIG;AACH,MAAM,CAAC,MAAM,MAAM,GAAG,MAAM,CAAC,MAAM,CAAC;IAChC,qGAAqG;IACrG,IAAI,EAAE,OAAO;IACb,qFAAqF;IACrF,OAAO,EAAE,UAAU;CACtB,CAAC,CAAC;AAEH,gGAAgG;AAChG,MAAM,CAAC,MAAM,qBAAqB,GAAsB,MAAM,CAAC,MAAM,CAAC,CAAC,QAAQ,EAAE,KAAK,EAAE,MAAM,CAAC,CAAC,CAAC;AAEjG,0EAA0E;AAC1E,MAAM,CAAC,MAAM,qBAAqB,GAAsB,MAAM,CAAC,MAAM,CAAC,CAAC,QAAQ,EAAE,KAAK,EAAE,IAAI,CAAC,CAAC,CAAC;AAE/F,8FAA8F;AAC9F,MAAM,CAAC,MAAM,eAAe,GAAG,UAAU,CAAC;AAE1C,wFAAwF;AACxF,MAAM,CAAC,MAAM,cAAc,GAAG,SAAS,CAAC;AAExC,kFAAkF;AAClF,MAAM,CAAC,MAAM,aAAa,GAAG,QAAQ,CAAC"}

package/dist/src/formats/json/exporter.d.ts

@@ -0,0 +1,89 @@
+/**
+ * The JSON exporter (design section 8.5): one GraphExporter with a `dialect` option writing
+ * NetworkX node-link (the default), d3 (`links`, optional index endpoints), JSON Graph Format v2,
+ * Cytoscape.js elements, graphology serialisation or vis.js. The dialect defaults to the one the
+ * importer recorded under `meta.extra.json` so a JSON file re-exported as JSON keeps its shape,
+ * and to node-link for a snapshot from any other source.
+ *
+ * check() runs the generic capability pre-flight against the dialect's table and appends the
+ * dialect-specific notes (non-finite numbers written as null, JGF id stringification / collisions
+ * / node order, direction dropped by Cytoscape and vis, mutual pairs expanded, reserved key
+ * collisions, positions written as plain attributes, a Cytoscape `parents` column) before anything
+ * is written; the same column plan drives write(), so the notes and the output agree.
+ *
+ * Every column without a structural slot in the dialect is written as a plain attribute under its
+ * column name; an f32 value is written as the shortest decimal that round-trips through
+ * Math.fround (design section 3.7); a multi-component value is an array; a list is an array; a json
+ * value is its JSON text; an unset row writes no key (design section 5.3). Non-finite numbers,
+ * which JSON cannot carry, become null and are reported.
+ */
+import { type ExportCapabilities, type GraphExporter } from "../../types.js";
+import { type JsonDialect } from "./dialect.js";
+/** The format-specific options of the JSON exporter. */
+export interface JsonExportOptions {
+    /** The dialect to write; default: the dialect the importer recorded, else "node-link". */
+    dialect?: JsonDialect | undefined;
+    /** Spaces per indentation level; 0 (default) writes compact JSON. */
+    indent?: number | undefined;
+    /** node-link / d3: the key of the edge array; default: the recorded key, else "edges" (d3: "links"). */
+    edgesKey?: string | undefined;
+    /** node-link / d3 / vis: the node id key; default: the recorded key, else "id". */
+    nodeIdKey?: string | undefined;
+    /** node-link / d3: write endpoints as node array positions; default: the recorded flag, else false. */
+    indexLinks?: boolean | undefined;
+    /** node-link / d3 / vis: the source key; default: the recorded key, else "source" (vis: "from"). */
+    sourceKey?: string | undefined;
+    /** node-link / d3 / vis: the target key; default: the recorded key, else "target" (vis: "to"). */
+    targetKey?: string | undefined;
+    /** The key the weight is written under; default: the key the JSON importer read it from, else "weight". */
+    weightKey?: string | undefined;
+}
+/**
+ * The LossNote codes of the JSON exporter's check(): the dialect-specific ones and, aliased, the
+ * shared ones it records (`LOSS` holds the rest of the generic pre-flight's codes). A key is the
+ * code without its severity prefix.
+ */
+export declare const JSON_LOSS: Readonly<{
+    /** Non-finite numbers (columns, weights) are written as null. */
+    NONFINITE_AS_NULL: "W_NONFINITE_AS_NULL";
+    /** Cytoscape, vis and d3 carry no direction; the file re-imports with the dialect's default direction. */
+    DIRECTION_DROPPED: "W_DIRECTION_DROPPED";
+    /** GEXF mutual pairs are written as two directed edges. */
+    MUTUAL_EXPANDED: "W_MUTUAL_EXPANDED";
+    /** JGF keys its nodes by string; numeric ids re-import as text unless ids: "canonical". */
+    NUMERIC_IDS_STRINGIFIED: "W_NUMERIC_IDS_STRINGIFIED";
+    /** JGF: two ids have the same text; export() throws E_INVALID_ID. */
+    ID_TEXT_COLLISION: "E_ID_TEXT_COLLISION";
+    /** JGF: integer-like id keys are enumerated first and ascending by JSON parsers; node order changes on re-import. */
+    NODE_ORDER: "W_NODE_ORDER";
+    /** A column named like a reserved key of the dialect (id, source, target, ...) is skipped. */
+    RESERVED_KEY: "W_RESERVED_KEY";
+    /** A plain edge column named like the weight key reads back as THE weight (or is skipped when weights are written). */
+    WEIGHT_KEY_CLASH: "W_WEIGHT_KEY_CLASH";
+    /** A position column without a slot (every dialect but Cytoscape) is a plain array attribute; the role is lost. */
+    POSITIONS_DROPPED: "W_POSITIONS_DROPPED";
+    /** Cytoscape positions are 2D; non-zero z values are dropped. */
+    POSITION_Z_DROPPED: "W_POSITION_Z_DROPPED";
+    /** Cytoscape has a single parent; a `parents` list column cannot be written. */
+    PARENTS_DROPPED: "W_PARENTS_DROPPED";
+    /** node-link / d3 have no edge id slot; the id column is written as a plain attribute. */
+    EDGE_IDS_DROPPED: "W_EDGE_IDS_DROPPED";
+    /** An f64 column of integral values reads back as i32 (JSON declares no types). */
+    INTEGRAL_F64_AS_I32: "W_INTEGRAL_F64_AS_I32";
+    /** A role column the dialect has no slot for is a plain attribute; the role is lost. */
+    ROLE_DROPPED: "W_ROLE_DROPPED";
+    /** A column without a set cell is not written (JSON declares no columns). */
+    EMPTY_COLUMN_DROPPED: "W_EMPTY_COLUMN_DROPPED";
+}>;
+/**
+ * The JSON exporter plugin (design section 8.5). `capabilities` is the node-link table (the
+ * default dialect); check() applies the table of the dialect actually selected.
+ */
+export declare const jsonExporter: GraphExporter<JsonExportOptions>;
+/**
+ * The capability table of one dialect, for callers that pick a dialect before check().
+ * @param dialect - the dialect
+ * @returns the frozen table
+ */
+export declare function jsonCapabilities(dialect: JsonDialect): ExportCapabilities;
+//# sourceMappingURL=exporter.d.ts.map

package/dist/src/formats/json/exporter.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"exporter.d.ts","sourceRoot":"","sources":["../../../../src/formats/json/exporter.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;GAkBG;AAUH,OAAO,EAA4B,KAAK,kBAAkB,EAAE,KAAK,aAAa,EAAiB,MAAM,gBAAgB,CAAC;AACtH,OAAO,EAMH,KAAK,WAAW,EAInB,MAAM,cAAc,CAAC;AAEtB,wDAAwD;AACxD,MAAM,WAAW,iBAAiB;IAC9B,0FAA0F;IAC1F,OAAO,CAAC,EAAE,WAAW,GAAG,SAAS,CAAC;IAClC,qEAAqE;IACrE,MAAM,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IAC5B,wGAAwG;IACxG,QAAQ,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IAC9B,mFAAmF;IACnF,SAAS,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IAC/B,uGAAuG;IACvG,UAAU,CAAC,EAAE,OAAO,GAAG,SAAS,CAAC;IACjC,oGAAoG;IACpG,SAAS,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IAC/B,kGAAkG;IAClG,SAAS,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IAC/B,2GAA2G;IAC3G,SAAS,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;CAClC;AAED;;;;GAIG;AACH,eAAO,MAAM,SAAS;IAClB,iEAAiE;;IAEjE,0GAA0G;;IAE1G,2DAA2D;;IAE3D,2FAA2F;;IAE3F,qEAAqE;;IAErE,qHAAqH;;IAErH,8FAA8F;;IAE9F,uHAAuH;;IAEvH,mHAAmH;;IAEnH,iEAAiE;;IAEjE,gFAAgF;;IAEhF,0FAA0F;;IAE1F,mFAAmF;;IAEnF,wFAAwF;;IAExF,6EAA6E;;EAE/E,CAAC;AAg8CH;;;GAGG;AACH,eAAO,MAAM,YAAY,EAAE,aAAa,CAAC,iBAAiB,CAiCxD,CAAC;AAEH;;;;GAIG;AACH,wBAAgB,gBAAgB,CAAC,OAAO,EAAE,WAAW,GAAG,kBAAkB,CAEzE"}