@graphty/graph-io 0.3.25 → 0.3.26

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

@@ -0,0 +1,118 @@
+/**
+ * The Cytoscape session exporter: writes a snapshot as a `.cys` file that Cytoscape Desktop 3.x
+ * opens as a session holding one network (one collection with one registered subnetwork).
+ *
+ * The archive holds what Cytoscape's session reader needs and nothing more:
+ * - `CytoscapeSession/3.0.0.version`, the empty marker that makes Cytoscape read a 3.x session;
+ * - `networks/<root>-<name>.xgmml`, the topology: one root network holding one registered
+ *   subnetwork, its nodes and edges by SUID, each edge with `cy:directed`;
+ * - `tables/<subnetwork>-<name>/LOCAL_ATTRS-org.cytoscape.model.Cy{Node,Edge,Network}-*.cytable`,
+ *   every column as a CyCSV table keyed by SUID (a session network file carries no attributes:
+ *   Cytoscape ignores atts on the nodes and edges of a 3.x session), with the label in `name`,
+ *   which Cytoscape's default style shows; plus the root network's own table with its name;
+ * - `views/<subnetwork>-<view>-<name>.xgmml`, the node coordinates (y negated back to screen
+ *   coordinates), only when the snapshot has positions: graph-io computes no layout.
+ *
+ * Styles, the network list, properties and thumbnails are not written; Cytoscape gives the view
+ * its default style. Entries are stored, not compressed. Every SUID comes from one counter, above
+ * the node ids that are kept as SUIDs; Cytoscape renumbers them all on load.
+ */
+import { type CommonExportOptions, type ExportCapabilities, type GraphExporter } from "../../types.js";
+/**
+ * The options of the Cytoscape session exporter: the common export options; it has none of its own. The
+ * collection and network names come from the snapshot's `meta.name` (default "Network").
+ * @category Built-in formats
+ */
+export type CysExportOptions = CommonExportOptions;
+/**
+ * The loss notes the session exporter's check() returns, by name. A key is the code without its
+ * severity and format prefixes.
+ * @category Built-in formats
+ */
+export declare const CYS_LOSS: Readonly<{
+    /** CyCSV has no unset text cell: an unset cell of a text column reads back as "". */
+    UNSET_AS_EMPTY_STRING: "W_CYS_UNSET_AS_EMPTY_STRING";
+    /**
+     * List cells CyCSV cannot hold exactly: an unset or empty list of text reads back as [""], an
+     * empty list of numbers or booleans reads back unset, trailing empty text items vanish, and an
+     * item holding a newline splits in two.
+     */
+    LIST_ITEMS: "W_CYS_LIST_ITEMS";
+    /** A text cell starting with "=" is a formula to Cytoscape (an error cell there); graph-io reads it back as text. */
+    TEXT_AS_EQUATION: "W_CYS_TEXT_AS_EQUATION";
+    /** A nested (json) column is written as a text column holding its JSON text. */
+    JSON_AS_STRING: "W_CYS_JSON_AS_STRING";
+    /** A position that cannot be written as it is: another shape, a non-finite coordinate, a z read back in the z column. */
+    POSITION: "W_CYS_POSITION";
+    /**
+     * An attribute with a role (for example, the label) is written where the format keeps that role, and reads back under the
+     * name the format's importer gives it.
+     */
+    COLUMN_NAME_CHANGED: "W_COLUMN_NAME_CHANGED";
+    /**
+     * An attribute without a role is written where the format keeps a role (for example, a `name` column as the label), and
+     * reads back with that role.
+     */
+    ROLE_ASSUMED: "W_ROLE_ASSUMED";
+    /** A mutual pair is written as two directed edges without its mark. */
+    MUTUAL_EXPANDED: "W_MUTUAL_EXPANDED";
+    /** Node ids that are numbers read back as their text. */
+    ID_TEXT_TYPE: "W_ID_TEXT_TYPE";
+    /**
+     * Two node ids would be written as the same text (the number 5 and the text "5"); the save fails with
+     * E_INVALID_ID.
+     */
+    ID_TEXT_COLLISION: "E_ID_TEXT_COLLISION";
+    /**
+     * Node ids the format cannot write, under `sanitizeIds: "error"`; the save fails with E_INVALID_ID. Pass
+     * `sanitizeIds: "mangle"` to rewrite them.
+     */
+    ID_CHARSET: "E_ID_CHARSET";
+    /** Node ids that are not positive integers under sanitizeIds "mangle": renumbered, originals kept. */
+    ID_MANGLED: "W_ID_MANGLED";
+    /** Edges without a usable id get generated SUIDs. */
+    EDGE_IDS_GENERATED: "W_EDGE_IDS_GENERATED";
+    /**
+     * An attribute type Cytoscape stores as a wider one (a 32-bit float as Double, a byte as Integer), or a label that
+     * is not text and is written as text; it reads back with the Cytoscape type.
+     */
+    DTYPE_UNSUPPORTED: "W_DTYPE_UNSUPPORTED";
+    /** A column whose every cell is unset (and which is not text) vanishes. */
+    EMPTY_COLUMN_DROPPED: "W_EMPTY_COLUMN_DROPPED";
+    /**
+     * A text attribute reads back as a dictionary attribute, or the reverse, because the importer chooses by how often
+     * its values repeat. The values are the same.
+     */
+    STORAGE_CLASS_CHANGED: "W_STORAGE_CLASS_CHANGED";
+    /** A plain `weight` edge column reads back as the edge weight. */
+    WEIGHT_KEY_CLASH: "W_WEIGHT_KEY_CLASH";
+    /** A parent / parents column: groups are not written. */
+    HIERARCHY_DROPPED: "W_HIERARCHY_DROPPED";
+    /** A start / end / timestamp column: sessions have no time. */
+    TEMPORAL_DROPPED: "W_TEMPORAL_DROPPED";
+    /** An attribute with a role the format has no place for is written as a plain attribute; the role is lost. */
+    ROLE_DROPPED: "W_ROLE_DROPPED";
+    /** An extension table the session cannot carry. */
+    EXTENSION_TABLE_DROPPED: "W_EXTENSION_TABLE_DROPPED";
+}>;
+/**
+ * What a Cytoscape session keeps: mixed direction, parallel edges and self-loops, integer SUIDs
+ * for nodes and edges, String / Double / Integer / Long / Boolean columns and lists of them,
+ * graph columns and positions. Groups, defaults, styles and time are not written.
+ * @category Built-in formats
+ */
+export declare const CYS_CAPABILITIES: ExportCapabilities;
+/**
+ * Cytoscape's `SessionUtil.escape`: Java's `URLEncoder.encode(text, "UTF-8")` (letters, digits
+ * and `.-*_` kept, space as `+`, everything else `%XX`), then `-` as `%2D`.
+ * @param text - the text
+ * @returns the escaped text
+ * @category Plugin helpers
+ */
+export declare function sessionEscape(text: string): string;
+/**
+ * The Cytoscape session exporter.
+ * @category Built-in formats
+ */
+export declare const cysExporter: GraphExporter<CysExportOptions>;
+//# sourceMappingURL=exporter.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"exporter.d.ts","sourceRoot":"","sources":["../../../../src/formats/cys/exporter.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;GAkBG;AAcH,OAAO,EAAE,KAAK,mBAAmB,EAAE,KAAK,kBAAkB,EAAE,KAAK,aAAa,EAAiB,MAAM,gBAAgB,CAAC;AAmBtH;;;;GAIG;AACH,MAAM,MAAM,gBAAgB,GAAG,mBAAmB,CAAC;AAEnD;;;;GAIG;AACH,eAAO,MAAM,QAAQ;IACjB,qFAAqF;;IAErF;;;;OAIG;;IAEH,qHAAqH;;IAErH,gFAAgF;;IAEhF,yHAAyH;;IAEzH;;;OAGG;;IAEH;;;OAGG;;IAEH,uEAAuE;;IAEvE,yDAAyD;;IAEzD;;;OAGG;;IAEH;;;OAGG;;IAEH,sGAAsG;;IAEtG,qDAAqD;;IAErD;;;OAGG;;IAEH,2EAA2E;;IAE3E;;;OAGG;;IAEH,kEAAkE;;IAElE,yDAAyD;;IAEzD,+DAA+D;;IAE/D,8GAA8G;;IAE9G,mDAAmD;;EAErD,CAAC;AAEH;;;;;GAKG;AACH,eAAO,MAAM,gBAAgB,EAAE,kBAiB7B,CAAC;AA28BH;;;;;;GAMG;AACH,wBAAgB,aAAa,CAAC,IAAI,EAAE,MAAM,GAAG,MAAM,CAMlD;AA4LD;;;GAGG;AACH,eAAO,MAAM,WAAW,EAAE,aAAa,CAAC,gBAAgB,CAsCtD,CAAC"}