@graphty/graph-io 0.0.0 → 0.2.1

package/dist/src/formats/gexf/schema.js

@@ -0,0 +1,323 @@
+/**
+ * What the GEXF importer and exporter share (research note 07 section 2.1, design sections 5.1,
+ * 5.5, 5.6 and 5.10): the namespaces of the two supported versions, the fixed names and
+ * declarations of the columns derived from XML attributes and viz elements (design section 5.6:
+ * XML-attribute-derived columns have fixed names and roles, and a declared attribute that would
+ * take one of them is renamed `<name>#<id>`), the shape of a temporal extension table, and the
+ * declared-type table of each version for the exporter.
+ */
+import { TIME_TEXT_ROLE, TIME_TEXT_SUFFIX } from "../../common/temporal.js";
+/** The format name. */
+export const GEXF_FORMAT = "gexf";
+/** The namespace URIs of each version. */
+export const GEXF_NAMESPACES = {
+    "1.2": { gexf: "http://www.gexf.net/1.2draft", viz: "http://www.gexf.net/1.2draft/viz" },
+    "1.3": { gexf: "http://gexf.net/1.3", viz: "http://gexf.net/1.3/viz" },
+};
+/** The GEXF `timeformat` values. */
+export const TIME_FORMATS = new Set(["integer", "double", "date", "dateTime"]);
+/** The GEXF graph `mode` values. */
+export const GRAPH_MODES = new Set(["static", "dynamic", "slice"]);
+/** The GEXF 1.3 `timerepresentation` values. */
+export const TIME_REPRESENTATIONS = new Set(["interval", "timestamp"]);
+/** The `origin.namespace` of viz-derived columns. */
+export const VIZ_NAMESPACE = "viz";
+/** The origin every XML-derived column declares. */
+const XML_ORIGIN = { format: GEXF_FORMAT };
+/** The origin of every viz-derived column. */
+const VIZ_ORIGIN = { format: GEXF_FORMAT, namespace: VIZ_NAMESPACE };
+/**
+ * The fixed node column names the importer owns (design section 5.6): a declared attribute with
+ * one of these titles is renamed `<title>#<id>` so the XML-derived column keeps its name and role.
+ */
+export const NODE_COLUMNS = Object.freeze({
+    label: "label",
+    parent: "parent",
+    parents: "parents",
+    start: "start",
+    end: "end",
+    timestamp: "timestamp",
+    spells: "spells",
+    timestamps: "timestamps",
+    open: "open",
+    position: "position",
+    color: "color",
+    size: "size",
+    shape: "shape",
+    shapeUri: "shape.uri",
+});
+/** The fixed edge column names the importer owns. */
+const EDGE_COLUMNS = Object.freeze({
+    id: "id",
+    label: "label",
+    kind: "kind",
+    start: "start",
+    end: "end",
+    timestamp: "timestamp",
+    spells: "spells",
+    timestamps: "timestamps",
+    open: "open",
+    color: "color",
+    thickness: "thickness",
+    shape: "shape",
+});
+/** Every reserved node column name, including the temporal companions. */
+export const RESERVED_NODE_NAMES = new Set([
+    ...Object.values(NODE_COLUMNS),
+    NODE_COLUMNS.start + TIME_TEXT_SUFFIX,
+    NODE_COLUMNS.end + TIME_TEXT_SUFFIX,
+    NODE_COLUMNS.timestamp + TIME_TEXT_SUFFIX,
+]);
+/** Every reserved edge column name, including the temporal companions. */
+export const RESERVED_EDGE_NAMES = new Set([
+    ...Object.values(EDGE_COLUMNS),
+    EDGE_COLUMNS.start + TIME_TEXT_SUFFIX,
+    EDGE_COLUMNS.end + TIME_TEXT_SUFFIX,
+    EDGE_COLUMNS.timestamp + TIME_TEXT_SUFFIX,
+]);
+/** The declarations of the XML-derived node columns, keyed as NODE_COLUMNS. */
+export const NODE_DECLS = {
+    label: { name: NODE_COLUMNS.label, dtype: "string", role: "label", nullable: true, origin: XML_ORIGIN },
+    parent: {
+        name: NODE_COLUMNS.parent,
+        dtype: "u32",
+        role: "parent",
+        refersTo: "node",
+        nullable: true,
+        origin: XML_ORIGIN,
+    },
+    parents: {
+        name: NODE_COLUMNS.parents,
+        dtype: "list",
+        itemDtype: "u32",
+        role: "parents",
+        refersTo: "node",
+        nullable: true,
+        origin: XML_ORIGIN,
+    },
+    start: { name: NODE_COLUMNS.start, dtype: "f64", role: "start", nullable: true, origin: XML_ORIGIN },
+    end: { name: NODE_COLUMNS.end, dtype: "f64", role: "end", nullable: true, origin: XML_ORIGIN },
+    timestamp: { name: NODE_COLUMNS.timestamp, dtype: "f64", role: "timestamp", nullable: true, origin: XML_ORIGIN },
+    spells: {
+        name: NODE_COLUMNS.spells,
+        dtype: "list",
+        itemDtype: "f64",
+        itemComponents: 2,
+        role: "spells",
+        nullable: true,
+        origin: XML_ORIGIN,
+    },
+    timestamps: {
+        name: NODE_COLUMNS.timestamps,
+        dtype: "list",
+        itemDtype: "f64",
+        role: "timestamps",
+        nullable: true,
+        origin: XML_ORIGIN,
+    },
+    open: { name: NODE_COLUMNS.open, dtype: "u8", role: "open", nullable: true, origin: XML_ORIGIN },
+    position: {
+        name: NODE_COLUMNS.position,
+        dtype: "f32",
+        components: 3,
+        role: "position",
+        mutable: true,
+        nullable: true,
+        origin: VIZ_ORIGIN,
+        extra: { units: "file" },
+    },
+    color: {
+        name: NODE_COLUMNS.color,
+        dtype: "f32",
+        components: 4,
+        role: "color",
+        nullable: true,
+        origin: VIZ_ORIGIN,
+    },
+    size: { name: NODE_COLUMNS.size, dtype: "f32", role: "size", nullable: true, origin: VIZ_ORIGIN },
+    shape: { name: NODE_COLUMNS.shape, dtype: "dict", role: "shape", nullable: true, origin: VIZ_ORIGIN },
+    shapeUri: { name: NODE_COLUMNS.shapeUri, dtype: "string", nullable: true, origin: VIZ_ORIGIN },
+};
+/** The declarations of the XML-derived edge columns, keyed as EDGE_COLUMNS. */
+export const EDGE_DECLS = {
+    id: { name: EDGE_COLUMNS.id, dtype: "string", role: "id", unique: true, nullable: true, origin: XML_ORIGIN },
+    label: { name: EDGE_COLUMNS.label, dtype: "string", role: "label", nullable: true, origin: XML_ORIGIN },
+    kind: { name: EDGE_COLUMNS.kind, dtype: "dict", role: "kind", nullable: true, origin: XML_ORIGIN },
+    start: { name: EDGE_COLUMNS.start, dtype: "f64", role: "start", nullable: true, origin: XML_ORIGIN },
+    end: { name: EDGE_COLUMNS.end, dtype: "f64", role: "end", nullable: true, origin: XML_ORIGIN },
+    timestamp: { name: EDGE_COLUMNS.timestamp, dtype: "f64", role: "timestamp", nullable: true, origin: XML_ORIGIN },
+    spells: {
+        name: EDGE_COLUMNS.spells,
+        dtype: "list",
+        itemDtype: "f64",
+        itemComponents: 2,
+        role: "spells",
+        nullable: true,
+        origin: XML_ORIGIN,
+    },
+    timestamps: {
+        name: EDGE_COLUMNS.timestamps,
+        dtype: "list",
+        itemDtype: "f64",
+        role: "timestamps",
+        nullable: true,
+        origin: XML_ORIGIN,
+    },
+    open: { name: EDGE_COLUMNS.open, dtype: "u8", role: "open", nullable: true, origin: XML_ORIGIN },
+    color: {
+        name: EDGE_COLUMNS.color,
+        dtype: "f32",
+        components: 4,
+        role: "color",
+        nullable: true,
+        origin: VIZ_ORIGIN,
+    },
+    thickness: { name: EDGE_COLUMNS.thickness, dtype: "f32", role: "thickness", nullable: true, origin: VIZ_ORIGIN },
+    shape: { name: EDGE_COLUMNS.shape, dtype: "dict", role: "shape", nullable: true, origin: VIZ_ORIGIN },
+};
+/** The bit of the `open` column marking an open start (design section 5.1). */
+export const OPEN_START = 1;
+/** The bit of the `open` column marking an open end. */
+export const OPEN_END = 2;
+/** The prefix of a temporal extension table's name (design section 5.10). */
+const TEMPORAL_TABLE_PREFIX = "temporal:";
+/** The column names of a temporal extension table (design section 5.10). */
+export const TEMPORAL_COLUMNS = Object.freeze({
+    element: "element",
+    start: "start",
+    end: "end",
+    value: "value",
+    open: "open",
+    startText: `start${TIME_TEXT_SUFFIX}`,
+    endText: `end${TIME_TEXT_SUFFIX}`,
+    valueText: `value${TIME_TEXT_SUFFIX}`,
+});
+/**
+ * The name of the temporal extension table of a dynamic attribute.
+ * @param domain - node or edge
+ * @param column - the static column's name
+ * @returns `temporal:<domain>:<column>`
+ */
+export function temporalTableName(domain, column) {
+    return `${TEMPORAL_TABLE_PREFIX}${domain}:${column}`;
+}
+/**
+ * Split a temporal table name into its domain and column.
+ * @param name - the table name
+ * @returns the parts, or null when the name is not a temporal table's
+ */
+export function parseTemporalTableName(name) {
+    if (!name.startsWith(TEMPORAL_TABLE_PREFIX)) {
+        return null;
+    }
+    const rest = name.slice(TEMPORAL_TABLE_PREFIX.length);
+    const colon = rest.indexOf(":");
+    if (colon < 0) {
+        return null;
+    }
+    const domain = rest.slice(0, colon);
+    if (domain !== "node" && domain !== "edge") {
+        return null;
+    }
+    return { domain, column: rest.slice(colon + 1) };
+}
+/**
+ * The column declarations of a temporal extension table (design section 5.10): the element index,
+ * the interval, the value in the attribute's dtype, the interval's text companions, an open-bounds
+ * byte and, for a temporal-typed attribute, the value's text companion.
+ * @param domain - the domain the element column refers to
+ * @param value - the value column's declaration fields (dtype, itemDtype, options...)
+ * @param temporalValue - whether the value is itself a temporal type needing a text companion
+ * @returns the declarations in table order
+ */
+export function temporalTableDecls(domain, value, temporalValue) {
+    const decls = [
+        { name: TEMPORAL_COLUMNS.element, dtype: "u32", refersTo: domain, nullable: false },
+        { name: TEMPORAL_COLUMNS.start, dtype: "f64", role: "start", nullable: true },
+        { name: TEMPORAL_COLUMNS.end, dtype: "f64", role: "end", nullable: true },
+        { name: TEMPORAL_COLUMNS.value, ...value, nullable: true },
+        {
+            name: TEMPORAL_COLUMNS.startText,
+            dtype: "string",
+            role: TIME_TEXT_ROLE,
+            nullable: true,
+            extra: { for: TEMPORAL_COLUMNS.start },
+        },
+        { name: TEMPORAL_COLUMNS.endText, dtype: "string", nullable: true, extra: { for: TEMPORAL_COLUMNS.end } },
+        { name: TEMPORAL_COLUMNS.open, dtype: "u8", role: "open", nullable: true },
+    ];
+    if (temporalValue) {
+        decls.push({
+            name: TEMPORAL_COLUMNS.valueText,
+            dtype: "string",
+            nullable: true,
+            extra: { for: TEMPORAL_COLUMNS.value },
+        });
+    }
+    return decls;
+}
+/** The scalar type names GEXF 1.2 declares. */
+const TYPES_1_2 = new Set(["integer", "long", "double", "float", "boolean", "string", "anyURI"]);
+/** The scalar type names GEXF 1.3 declares (the list variants are derived). */
+const TYPES_1_3 = new Set([
+    ...TYPES_1_2,
+    "bigdecimal",
+    "biginteger",
+    "byte",
+    "char",
+    "short",
+    "date",
+    "dateTime",
+]);
+/**
+ * Whether a declared type text is a scalar type of a version (case-sensitive, as the schema spells
+ * them).
+ * @param type - the type text
+ * @param version - the target version
+ * @returns true when the version declares it
+ */
+export function isScalarType(type, version) {
+    return (version === "1.2" ? TYPES_1_2 : TYPES_1_3).has(type);
+}
+/**
+ * Whether a declared type text is a list type of a version: `liststring` in 1.2, `list<scalar>` in 1.3.
+ * @param type - the type text
+ * @param version - the target version
+ * @returns true when the version declares it
+ */
+export function isListType(type, version) {
+    if (version === "1.2") {
+        return type === "liststring";
+    }
+    return type.startsWith("list") && type.length > 4 && isScalarType(type.slice(4), "1.3");
+}
+/**
+ * The canonical GEXF scalar type of a column dtype (design section 5.1 reversed).
+ * @param dtype - a scalar dtype
+ * @returns the type text; u32 becomes `long` (its range exceeds `integer`), u8 `integer`, json `string`
+ */
+export function canonicalScalarType(dtype) {
+    switch (dtype) {
+        case "bool":
+            return "boolean";
+        case "i32":
+        case "u8":
+            return "integer";
+        case "u32":
+            return "long";
+        case "f32":
+            return "float";
+        case "f64":
+            return "double";
+        case "dict":
+        case "string":
+        case "json":
+        case "list":
+            return "string";
+        default: {
+            const name = dtype;
+            return name;
+        }
+    }
+}
+//# sourceMappingURL=schema.js.map

package/dist/src/formats/gexf/schema.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"schema.js","sourceRoot":"","sources":["../../../../src/formats/gexf/schema.ts"],"names":[],"mappings":"AAAA;;;;;;;GAOG;AAIH,OAAO,EAAE,cAAc,EAAE,gBAAgB,EAAE,MAAM,0BAA0B,CAAC;AAK5E,uBAAuB;AACvB,MAAM,CAAC,MAAM,WAAW,GAAG,MAAM,CAAC;AAElC,0CAA0C;AAC1C,MAAM,CAAC,MAAM,eAAe,GAAmF;IAC3G,KAAK,EAAE,EAAE,IAAI,EAAE,8BAA8B,EAAE,GAAG,EAAE,kCAAkC,EAAE;IACxF,KAAK,EAAE,EAAE,IAAI,EAAE,qBAAqB,EAAE,GAAG,EAAE,yBAAyB,EAAE;CACzE,CAAC;AAKF,oCAAoC;AACpC,MAAM,CAAC,MAAM,YAAY,GAAwB,IAAI,GAAG,CAAC,CAAC,SAAS,EAAE,QAAQ,EAAE,MAAM,EAAE,UAAU,CAAC,CAAC,CAAC;AAEpG,oCAAoC;AACpC,MAAM,CAAC,MAAM,WAAW,GAAwB,IAAI,GAAG,CAAC,CAAC,QAAQ,EAAE,SAAS,EAAE,OAAO,CAAC,CAAC,CAAC;AAExF,gDAAgD;AAChD,MAAM,CAAC,MAAM,oBAAoB,GAAwB,IAAI,GAAG,CAAC,CAAC,UAAU,EAAE,WAAW,CAAC,CAAC,CAAC;AAE5F,qDAAqD;AACrD,MAAM,CAAC,MAAM,aAAa,GAAG,KAAK,CAAC;AAEnC,oDAAoD;AACpD,MAAM,UAAU,GAAG,EAAE,MAAM,EAAE,WAAW,EAAE,CAAC;AAE3C,8CAA8C;AAC9C,MAAM,UAAU,GAAG,EAAE,MAAM,EAAE,WAAW,EAAE,SAAS,EAAE,aAAa,EAAE,CAAC;AAErE;;;GAGG;AACH,MAAM,CAAC,MAAM,YAAY,GAAG,MAAM,CAAC,MAAM,CAAC;IACtC,KAAK,EAAE,OAAO;IACd,MAAM,EAAE,QAAQ;IAChB,OAAO,EAAE,SAAS;IAClB,KAAK,EAAE,OAAO;IACd,GAAG,EAAE,KAAK;IACV,SAAS,EAAE,WAAW;IACtB,MAAM,EAAE,QAAQ;IAChB,UAAU,EAAE,YAAY;IACxB,IAAI,EAAE,MAAM;IACZ,QAAQ,EAAE,UAAU;IACpB,KAAK,EAAE,OAAO;IACd,IAAI,EAAE,MAAM;IACZ,KAAK,EAAE,OAAO;IACd,QAAQ,EAAE,WAAW;CACxB,CAAC,CAAC;AAEH,qDAAqD;AACrD,MAAM,YAAY,GAAG,MAAM,CAAC,MAAM,CAAC;IAC/B,EAAE,EAAE,IAAI;IACR,KAAK,EAAE,OAAO;IACd,IAAI,EAAE,MAAM;IACZ,KAAK,EAAE,OAAO;IACd,GAAG,EAAE,KAAK;IACV,SAAS,EAAE,WAAW;IACtB,MAAM,EAAE,QAAQ;IAChB,UAAU,EAAE,YAAY;IACxB,IAAI,EAAE,MAAM;IACZ,KAAK,EAAE,OAAO;IACd,SAAS,EAAE,WAAW;IACtB,KAAK,EAAE,OAAO;CACjB,CAAC,CAAC;AAEH,0EAA0E;AAC1E,MAAM,CAAC,MAAM,mBAAmB,GAAwB,IAAI,GAAG,CAAC;IAC5D,GAAG,MAAM,CAAC,MAAM,CAAC,YAAY,CAAC;IAC9B,YAAY,CAAC,KAAK,GAAG,gBAAgB;IACrC,YAAY,CAAC,GAAG,GAAG,gBAAgB;IACnC,YAAY,CAAC,SAAS,GAAG,gBAAgB;CAC5C,CAAC,CAAC;AAEH,0EAA0E;AAC1E,MAAM,CAAC,MAAM,mBAAmB,GAAwB,IAAI,GAAG,CAAC;IAC5D,GAAG,MAAM,CAAC,MAAM,CAAC,YAAY,CAAC;IAC9B,YAAY,CAAC,KAAK,GAAG,gBAAgB;IACrC,YAAY,CAAC,GAAG,GAAG,gBAAgB;IACnC,YAAY,CAAC,SAAS,GAAG,gBAAgB;CAC5C,CAAC,CAAC;AAEH,+EAA+E;AAC/E,MAAM,CAAC,MAAM,UAAU,GAA4D;IAC/E,KAAK,EAAE,EAAE,IAAI,EAAE,YAAY,CAAC,KAAK,EAAE,KAAK,EAAE,QAAQ,EAAE,IAAI,EAAE,OAAO,EAAE,QAAQ,EAAE,IAAI,EAAE,MAAM,EAAE,UAAU,EAAE;IACvG,MAAM,EAAE;QACJ,IAAI,EAAE,YAAY,CAAC,MAAM;QACzB,KAAK,EAAE,KAAK;QACZ,IAAI,EAAE,QAAQ;QACd,QAAQ,EAAE,MAAM;QAChB,QAAQ,EAAE,IAAI;QACd,MAAM,EAAE,UAAU;KACrB;IACD,OAAO,EAAE;QACL,IAAI,EAAE,YAAY,CAAC,OAAO;QAC1B,KAAK,EAAE,MAAM;QACb,SAAS,EAAE,KAAK;QAChB,IAAI,EAAE,SAAS;QACf,QAAQ,EAAE,MAAM;QAChB,QAAQ,EAAE,IAAI;QACd,MAAM,EAAE,UAAU;KACrB;IACD,KAAK,EAAE,EAAE,IAAI,EAAE,YAAY,CAAC,KAAK,EAAE,KAAK,EAAE,KAAK,EAAE,IAAI,EAAE,OAAO,EAAE,QAAQ,EAAE,IAAI,EAAE,MAAM,EAAE,UAAU,EAAE;IACpG,GAAG,EAAE,EAAE,IAAI,EAAE,YAAY,CAAC,GAAG,EAAE,KAAK,EAAE,KAAK,EAAE,IAAI,EAAE,KAAK,EAAE,QAAQ,EAAE,IAAI,EAAE,MAAM,EAAE,UAAU,EAAE;IAC9F,SAAS,EAAE,EAAE,IAAI,EAAE,YAAY,CAAC,SAAS,EAAE,KAAK,EAAE,KAAK,EAAE,IAAI,EAAE,WAAW,EAAE,QAAQ,EAAE,IAAI,EAAE,MAAM,EAAE,UAAU,EAAE;IAChH,MAAM,EAAE;QACJ,IAAI,EAAE,YAAY,CAAC,MAAM;QACzB,KAAK,EAAE,MAAM;QACb,SAAS,EAAE,KAAK;QAChB,cAAc,EAAE,CAAC;QACjB,IAAI,EAAE,QAAQ;QACd,QAAQ,EAAE,IAAI;QACd,MAAM,EAAE,UAAU;KACrB;IACD,UAAU,EAAE;QACR,IAAI,EAAE,YAAY,CAAC,UAAU;QAC7B,KAAK,EAAE,MAAM;QACb,SAAS,EAAE,KAAK;QAChB,IAAI,EAAE,YAAY;QAClB,QAAQ,EAAE,IAAI;QACd,MAAM,EAAE,UAAU;KACrB;IACD,IAAI,EAAE,EAAE,IAAI,EAAE,YAAY,CAAC,IAAI,EAAE,KAAK,EAAE,IAAI,EAAE,IAAI,EAAE,MAAM,EAAE,QAAQ,EAAE,IAAI,EAAE,MAAM,EAAE,UAAU,EAAE;IAChG,QAAQ,EAAE;QACN,IAAI,EAAE,YAAY,CAAC,QAAQ;QAC3B,KAAK,EAAE,KAAK;QACZ,UAAU,EAAE,CAAC;QACb,IAAI,EAAE,UAAU;QAChB,OAAO,EAAE,IAAI;QACb,QAAQ,EAAE,IAAI;QACd,MAAM,EAAE,UAAU;QAClB,KAAK,EAAE,EAAE,KAAK,EAAE,MAAM,EAAE;KAC3B;IACD,KAAK,EAAE;QACH,IAAI,EAAE,YAAY,CAAC,KAAK;QACxB,KAAK,EAAE,KAAK;QACZ,UAAU,EAAE,CAAC;QACb,IAAI,EAAE,OAAO;QACb,QAAQ,EAAE,IAAI;QACd,MAAM,EAAE,UAAU;KACrB;IACD,IAAI,EAAE,EAAE,IAAI,EAAE,YAAY,CAAC,IAAI,EAAE,KAAK,EAAE,KAAK,EAAE,IAAI,EAAE,MAAM,EAAE,QAAQ,EAAE,IAAI,EAAE,MAAM,EAAE,UAAU,EAAE;IACjG,KAAK,EAAE,EAAE,IAAI,EAAE,YAAY,CAAC,KAAK,EAAE,KAAK,EAAE,MAAM,EAAE,IAAI,EAAE,OAAO,EAAE,QAAQ,EAAE,IAAI,EAAE,MAAM,EAAE,UAAU,EAAE;IACrG,QAAQ,EAAE,EAAE,IAAI,EAAE,YAAY,CAAC,QAAQ,EAAE,KAAK,EAAE,QAAQ,EAAE,QAAQ,EAAE,IAAI,EAAE,MAAM,EAAE,UAAU,EAAE;CACjG,CAAC;AAEF,+EAA+E;AAC/E,MAAM,CAAC,MAAM,UAAU,GAA4D;IAC/E,EAAE,EAAE,EAAE,IAAI,EAAE,YAAY,CAAC,EAAE,EAAE,KAAK,EAAE,QAAQ,EAAE,IAAI,EAAE,IAAI,EAAE,MAAM,EAAE,IAAI,EAAE,QAAQ,EAAE,IAAI,EAAE,MAAM,EAAE,UAAU,EAAE;IAC5G,KAAK,EAAE,EAAE,IAAI,EAAE,YAAY,CAAC,KAAK,EAAE,KAAK,EAAE,QAAQ,EAAE,IAAI,EAAE,OAAO,EAAE,QAAQ,EAAE,IAAI,EAAE,MAAM,EAAE,UAAU,EAAE;IACvG,IAAI,EAAE,EAAE,IAAI,EAAE,YAAY,CAAC,IAAI,EAAE,KAAK,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,EAAE,QAAQ,EAAE,IAAI,EAAE,MAAM,EAAE,UAAU,EAAE;IAClG,KAAK,EAAE,EAAE,IAAI,EAAE,YAAY,CAAC,KAAK,EAAE,KAAK,EAAE,KAAK,EAAE,IAAI,EAAE,OAAO,EAAE,QAAQ,EAAE,IAAI,EAAE,MAAM,EAAE,UAAU,EAAE;IACpG,GAAG,EAAE,EAAE,IAAI,EAAE,YAAY,CAAC,GAAG,EAAE,KAAK,EAAE,KAAK,EAAE,IAAI,EAAE,KAAK,EAAE,QAAQ,EAAE,IAAI,EAAE,MAAM,EAAE,UAAU,EAAE;IAC9F,SAAS,EAAE,EAAE,IAAI,EAAE,YAAY,CAAC,SAAS,EAAE,KAAK,EAAE,KAAK,EAAE,IAAI,EAAE,WAAW,EAAE,QAAQ,EAAE,IAAI,EAAE,MAAM,EAAE,UAAU,EAAE;IAChH,MAAM,EAAE;QACJ,IAAI,EAAE,YAAY,CAAC,MAAM;QACzB,KAAK,EAAE,MAAM;QACb,SAAS,EAAE,KAAK;QAChB,cAAc,EAAE,CAAC;QACjB,IAAI,EAAE,QAAQ;QACd,QAAQ,EAAE,IAAI;QACd,MAAM,EAAE,UAAU;KACrB;IACD,UAAU,EAAE;QACR,IAAI,EAAE,YAAY,CAAC,UAAU;QAC7B,KAAK,EAAE,MAAM;QACb,SAAS,EAAE,KAAK;QAChB,IAAI,EAAE,YAAY;QAClB,QAAQ,EAAE,IAAI;QACd,MAAM,EAAE,UAAU;KACrB;IACD,IAAI,EAAE,EAAE,IAAI,EAAE,YAAY,CAAC,IAAI,EAAE,KAAK,EAAE,IAAI,EAAE,IAAI,EAAE,MAAM,EAAE,QAAQ,EAAE,IAAI,EAAE,MAAM,EAAE,UAAU,EAAE;IAChG,KAAK,EAAE;QACH,IAAI,EAAE,YAAY,CAAC,KAAK;QACxB,KAAK,EAAE,KAAK;QACZ,UAAU,EAAE,CAAC;QACb,IAAI,EAAE,OAAO;QACb,QAAQ,EAAE,IAAI;QACd,MAAM,EAAE,UAAU;KACrB;IACD,SAAS,EAAE,EAAE,IAAI,EAAE,YAAY,CAAC,SAAS,EAAE,KAAK,EAAE,KAAK,EAAE,IAAI,EAAE,WAAW,EAAE,QAAQ,EAAE,IAAI,EAAE,MAAM,EAAE,UAAU,EAAE;IAChH,KAAK,EAAE,EAAE,IAAI,EAAE,YAAY,CAAC,KAAK,EAAE,KAAK,EAAE,MAAM,EAAE,IAAI,EAAE,OAAO,EAAE,QAAQ,EAAE,IAAI,EAAE,MAAM,EAAE,UAAU,EAAE;CACxG,CAAC;AAEF,+EAA+E;AAC/E,MAAM,CAAC,MAAM,UAAU,GAAG,CAAC,CAAC;AAE5B,wDAAwD;AACxD,MAAM,CAAC,MAAM,QAAQ,GAAG,CAAC,CAAC;AAE1B,6EAA6E;AAC7E,MAAM,qBAAqB,GAAG,WAAW,CAAC;AAE1C,4EAA4E;AAC5E,MAAM,CAAC,MAAM,gBAAgB,GAAG,MAAM,CAAC,MAAM,CAAC;IAC1C,OAAO,EAAE,SAAS;IAClB,KAAK,EAAE,OAAO;IACd,GAAG,EAAE,KAAK;IACV,KAAK,EAAE,OAAO;IACd,IAAI,EAAE,MAAM;IACZ,SAAS,EAAE,QAAQ,gBAAgB,EAAE;IACrC,OAAO,EAAE,MAAM,gBAAgB,EAAE;IACjC,SAAS,EAAE,QAAQ,gBAAgB,EAAE;CACxC,CAAC,CAAC;AAEH;;;;;GAKG;AACH,MAAM,UAAU,iBAAiB,CAAC,MAAuB,EAAE,MAAc;IACrE,OAAO,GAAG,qBAAqB,GAAG,MAAM,IAAI,MAAM,EAAE,CAAC;AACzD,CAAC;AAED;;;;GAIG;AACH,MAAM,UAAU,sBAAsB,CAAC,IAAY;IAC/C,IAAI,CAAC,IAAI,CAAC,UAAU,CAAC,qBAAqB,CAAC,EAAE,CAAC;QAC1C,OAAO,IAAI,CAAC;IAChB,CAAC;IACD,MAAM,IAAI,GAAG,IAAI,CAAC,KAAK,CAAC,qBAAqB,CAAC,MAAM,CAAC,CAAC;IACtD,MAAM,KAAK,GAAG,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC;IAChC,IAAI,KAAK,GAAG,CAAC,EAAE,CAAC;QACZ,OAAO,IAAI,CAAC;IAChB,CAAC;IACD,MAAM,MAAM,GAAG,IAAI,CAAC,KAAK,CAAC,CAAC,EAAE,KAAK,CAAC,CAAC;IACpC,IAAI,MAAM,KAAK,MAAM,IAAI,MAAM,KAAK,MAAM,EAAE,CAAC;QACzC,OAAO,IAAI,CAAC;IAChB,CAAC;IACD,OAAO,EAAE,MAAM,EAAE,MAAM,EAAE,IAAI,CAAC,KAAK,CAAC,KAAK,GAAG,CAAC,CAAC,EAAE,CAAC;AACrD,CAAC;AAED;;;;;;;;GAQG;AACH,MAAM,UAAU,kBAAkB,CAC9B,MAAuB,EACvB,KAAqE,EACrE,aAAsB;IAEtB,MAAM,KAAK,GAAiB;QACxB,EAAE,IAAI,EAAE,gBAAgB,CAAC,OAAO,EAAE,KAAK,EAAE,KAAK,EAAE,QAAQ,EAAE,MAAM,EAAE,QAAQ,EAAE,KAAK,EAAE;QACnF,EAAE,IAAI,EAAE,gBAAgB,CAAC,KAAK,EAAE,KAAK,EAAE,KAAK,EAAE,IAAI,EAAE,OAAO,EAAE,QAAQ,EAAE,IAAI,EAAE;QAC7E,EAAE,IAAI,EAAE,gBAAgB,CAAC,GAAG,EAAE,KAAK,EAAE,KAAK,EAAE,IAAI,EAAE,KAAK,EAAE,QAAQ,EAAE,IAAI,EAAE;QACzE,EAAE,IAAI,EAAE,gBAAgB,CAAC,KAAK,EAAE,GAAG,KAAK,EAAE,QAAQ,EAAE,IAAI,EAAE;QAC1D;YACI,IAAI,EAAE,gBAAgB,CAAC,SAAS;YAChC,KAAK,EAAE,QAAQ;YACf,IAAI,EAAE,cAAc;YACpB,QAAQ,EAAE,IAAI;YACd,KAAK,EAAE,EAAE,GAAG,EAAE,gBAAgB,CAAC,KAAK,EAAE;SACzC;QACD,EAAE,IAAI,EAAE,gBAAgB,CAAC,OAAO,EAAE,KAAK,EAAE,QAAQ,EAAE,QAAQ,EAAE,IAAI,EAAE,KAAK,EAAE,EAAE,GAAG,EAAE,gBAAgB,CAAC,GAAG,EAAE,EAAE;QACzG,EAAE,IAAI,EAAE,gBAAgB,CAAC,IAAI,EAAE,KAAK,EAAE,IAAI,EAAE,IAAI,EAAE,MAAM,EAAE,QAAQ,EAAE,IAAI,EAAE;KAC7E,CAAC;IACF,IAAI,aAAa,EAAE,CAAC;QAChB,KAAK,CAAC,IAAI,CAAC;YACP,IAAI,EAAE,gBAAgB,CAAC,SAAS;YAChC,KAAK,EAAE,QAAQ;YACf,QAAQ,EAAE,IAAI;YACd,KAAK,EAAE,EAAE,GAAG,EAAE,gBAAgB,CAAC,KAAK,EAAE;SACzC,CAAC,CAAC;IACP,CAAC;IACD,OAAO,KAAK,CAAC;AACjB,CAAC;AAED,+CAA+C;AAC/C,MAAM,SAAS,GAAwB,IAAI,GAAG,CAAC,CAAC,SAAS,EAAE,MAAM,EAAE,QAAQ,EAAE,OAAO,EAAE,SAAS,EAAE,QAAQ,EAAE,QAAQ,CAAC,CAAC,CAAC;AAEtH,+EAA+E;AAC/E,MAAM,SAAS,GAAwB,IAAI,GAAG,CAAC;IAC3C,GAAG,SAAS;IACZ,YAAY;IACZ,YAAY;IACZ,MAAM;IACN,MAAM;IACN,OAAO;IACP,MAAM;IACN,UAAU;CACb,CAAC,CAAC;AAEH;;;;;;GAMG;AACH,MAAM,UAAU,YAAY,CAAC,IAAY,EAAE,OAAoB;IAC3D,OAAO,CAAC,OAAO,KAAK,KAAK,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC;AACjE,CAAC;AAED;;;;;GAKG;AACH,MAAM,UAAU,UAAU,CAAC,IAAY,EAAE,OAAoB;IACzD,IAAI,OAAO,KAAK,KAAK,EAAE,CAAC;QACpB,OAAO,IAAI,KAAK,YAAY,CAAC;IACjC,CAAC;IACD,OAAO,IAAI,CAAC,UAAU,CAAC,MAAM,CAAC,IAAI,IAAI,CAAC,MAAM,GAAG,CAAC,IAAI,YAAY,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,EAAE,KAAK,CAAC,CAAC;AAC5F,CAAC;AAED;;;;GAIG;AACH,MAAM,UAAU,mBAAmB,CAAC,KAAY;IAC5C,QAAQ,KAAK,EAAE,CAAC;QACZ,KAAK,MAAM;YACP,OAAO,SAAS,CAAC;QACrB,KAAK,KAAK,CAAC;QACX,KAAK,IAAI;YACL,OAAO,SAAS,CAAC;QACrB,KAAK,KAAK;YACN,OAAO,MAAM,CAAC;QAClB,KAAK,KAAK;YACN,OAAO,OAAO,CAAC;QACnB,KAAK,KAAK;YACN,OAAO,QAAQ,CAAC;QACpB,KAAK,MAAM,CAAC;QACZ,KAAK,QAAQ,CAAC;QACd,KAAK,MAAM,CAAC;QACZ,KAAK,MAAM;YACP,OAAO,QAAQ,CAAC;QACpB,OAAO,CAAC,CAAC,CAAC;YACN,MAAM,IAAI,GAAW,KAAK,CAAC;YAC3B,OAAO,IAAI,CAAC;QAChB,CAAC;IACL,CAAC;AACL,CAAC"}

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

@@ -0,0 +1,69 @@
+/**
+ * The GML exporter (design section 8.5, research note 07 sections 2.2 and 9): writes a snapshot in
+ * the NetworkX dialect of GML. Node ids must be integers (`idCharset: "integer"`; `sanitizeIds:
+ * "mangle"` renumbers the others and keeps the original in a `graphty_originalId` key the importer
+ * restores); columns are written per dtype (`int` for the integer dtypes, `real` with a decimal
+ * point guaranteed for f32 / f64 so the dtype survives a re-import, quoted strings with `&#NN;`
+ * references, repeated keys for lists with the `_networkx_list_start` marker for one-element
+ * lists and `"[]"` for empty ones, nested records for json objects); the position role becomes
+ * `graphics [ x y z ]` merged with the node's `graphics` json record; graph columns are written
+ * inside `graph [ ]` (or at the top level when the importer found them there); `Creator` and
+ * `Version` come from the metadata.
+ *
+ * check() reports, before anything is written, the capability gaps of the common check plus the
+ * GML-specific ones: json columns holding numbers (JSON cannot keep the int / real distinction:
+ * `W_GML_RECORD_NUMBER_TYPE`), booleans (written 1 / 0) or nulls (omitted), arrays nested in
+ * arrays (no GML spelling; export() throws), column names and record keys that are not GML keys
+ * or collide with the structural keys (`E_GML_INVALID_KEY` / `E_GML_RESERVED_KEY`, or
+ * `W_GML_KEY_MANGLED` under `sanitizeKeys: "mangle"`), and graphics / position overlaps.
+ */
+import { type GraphExporter } from "../../types.js";
+/** The format-specific options of the GML exporter. */
+export interface GmlExportOptions {
+    /**
+     * The edge key explicit weights are written under; by default the key the GML importer read
+     * them from (`meta.weightOrigin.id` when the snapshot came from GML), else `value`.
+     */
+    weightKey?: string | undefined;
+    /**
+     * "error" (default): a column name or record key that is not a GML key (`[A-Za-z][0-9A-Za-z_]*`)
+     * or collides with a structural key makes export() throw; "mangle": such keys are rewritten
+     * (`.` and other characters become `_`, collisions get a `_2` suffix) and check() reports them.
+     */
+    sanitizeKeys?: "error" | "mangle" | undefined;
+}
+/** Loss code: a json column holds numbers; JSON cannot keep GML's int / real distinction (design section 8.5). */
+export declare const RECORD_NUMBER_TYPE_CODE = "W_GML_RECORD_NUMBER_TYPE";
+/** Loss code: a json column holds booleans, written as 1 / 0. */
+export declare const RECORD_BOOLEAN_CODE = "W_GML_RECORD_BOOLEAN";
+/** Loss code: a json column holds nulls, which GML cannot write; the key (or the row) is omitted. */
+export declare const RECORD_NULL_CODE = "W_GML_RECORD_NULL";
+/** Loss code: a json column holds an array inside an array, which GML cannot write; export() throws. */
+export declare const NESTED_ARRAY_CODE = "E_GML_NESTED_ARRAY";
+/** Loss code: a json column holds arrays as row values; written as repeated keys, they re-import as a list column. */
+export declare const JSON_ARRAY_CODE = "W_GML_JSON_ARRAY";
+/** Loss code: a column name or record key is not a GML key; export() throws unless sanitizeKeys is "mangle". */
+export declare const INVALID_KEY_CODE = "E_GML_INVALID_KEY";
+/** Loss code: a column name collides with a structural GML key; export() throws unless sanitizeKeys is "mangle". */
+export declare const RESERVED_KEY_CODE = "E_GML_RESERVED_KEY";
+/** Loss code: keys rewritten under sanitizeKeys "mangle". */
+export declare const KEY_MANGLED_CODE = "W_GML_KEY_MANGLED";
+/** Loss code: a position column with more than three components; x, y and z are written. */
+export declare const POSITION_COMPONENTS_CODE = "W_GML_POSITION_COMPONENTS";
+/** Loss code: a node's graphics record has x / y / z keys the position column replaces. */
+export declare const GRAPHICS_OVERRIDDEN_CODE = "W_GML_GRAPHICS_OVERRIDDEN";
+/** Loss code: a node's graphics value is not a record and cannot hold the position; export() throws. */
+export declare const GRAPHICS_CONFLICT_CODE = "E_GML_GRAPHICS_CONFLICT";
+/** The default weight key (design section 8.4: GML weights are read from `value` by default). */
+export declare const DEFAULT_WEIGHT_KEY = "value";
+/**
+ * The GML text of a real: the shortest text of the dtype with a decimal point guaranteed
+ * (`2.0`, `1.0e-7`), the NetworkX spellings `+INF` / `-INF` / `NAN` for the non-finite values.
+ * @param value - the value
+ * @param dtype - the dtype the value came from (f32 uses the fround-shortest text)
+ * @returns the text
+ */
+export declare function gmlRealText(value: number, dtype?: "f32" | "f64" | "i32" | "u32" | "u8"): string;
+/** The GML exporter plugin. */
+export declare const gmlExporter: GraphExporter<GmlExportOptions>;
+//# sourceMappingURL=exporter.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"exporter.d.ts","sourceRoot":"","sources":["../../../../src/formats/gml/exporter.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;GAkBG;AA0BH,OAAO,EAAqD,KAAK,aAAa,EAAiB,MAAM,gBAAgB,CAAC;AAGtH,uDAAuD;AACvD,MAAM,WAAW,gBAAgB;IAC7B;;;OAGG;IACH,SAAS,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IAC/B;;;;OAIG;IACH,YAAY,CAAC,EAAE,OAAO,GAAG,QAAQ,GAAG,SAAS,CAAC;CACjD;AAED,kHAAkH;AAClH,eAAO,MAAM,uBAAuB,6BAA6B,CAAC;AAClE,iEAAiE;AACjE,eAAO,MAAM,mBAAmB,yBAAyB,CAAC;AAC1D,qGAAqG;AACrG,eAAO,MAAM,gBAAgB,sBAAsB,CAAC;AACpD,wGAAwG;AACxG,eAAO,MAAM,iBAAiB,uBAAuB,CAAC;AACtD,sHAAsH;AACtH,eAAO,MAAM,eAAe,qBAAqB,CAAC;AAClD,gHAAgH;AAChH,eAAO,MAAM,gBAAgB,sBAAsB,CAAC;AACpD,oHAAoH;AACpH,eAAO,MAAM,iBAAiB,uBAAuB,CAAC;AACtD,6DAA6D;AAC7D,eAAO,MAAM,gBAAgB,sBAAsB,CAAC;AACpD,4FAA4F;AAC5F,eAAO,MAAM,wBAAwB,8BAA8B,CAAC;AACpE,2FAA2F;AAC3F,eAAO,MAAM,wBAAwB,8BAA8B,CAAC;AACpE,wGAAwG;AACxG,eAAO,MAAM,sBAAsB,4BAA4B,CAAC;AAEhE,iGAAiG;AACjG,eAAO,MAAM,kBAAkB,UAAU,CAAC;AAyuB1C;;;;;;GAMG;AACH,wBAAgB,WAAW,CAAC,KAAK,EAAE,MAAM,EAAE,KAAK,GAAE,KAAK,GAAG,KAAK,GAAG,KAAK,GAAG,KAAK,GAAG,IAAY,GAAG,MAAM,CAEtG;AA6gBD,+BAA+B;AAC/B,eAAO,MAAM,WAAW,EAAE,aAAa,CAAC,gBAAgB,CAuBtD,CAAC"}