@graphty/graph-io 0.3.24 → 0.3.26

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

@@ -8,7 +8,7 @@
  * every node block first, then every edge block, so node indices follow the file's node order
  * and forward edge references resolve.
  *
- * Conventions honoured: NetworkX's `_networkx_list_start` marker and `"[]"` empty lists, `&#NN;`
+ * Conventions honored: NetworkX's `_networkx_list_start` marker and `"[]"` empty lists, `&#NN;`
  * character references in strings, `Creator` / `Version` top-level metadata, `directed 0|1` and
  * `multigraph 0|1` graph flags, comments, keys and values on one line or split across lines, and
  * a `graphics [ x y z ]` node record mapped to the `position` role (note 07 section 9) with the
@@ -21,51 +21,142 @@
  * `graphty_originalId` key written by the exporter's `sanitizeIds: "mangle"` restores the
  * original id under `restoreMangledIds` (the default).
  */
-import { type GraphImporter } from "../../types.js";
-/** The format-specific options of the GML importer. */
-export interface GmlImportOptions {
+import { type CommonImportOptions, type GraphChoiceOptions, type GraphImporter } from "../../types.js";
+/**
+ * The format-specific options of the GML importer.
+ * @category Built-in formats
+ */
+export interface GmlImportOptions extends GraphChoiceOptions, CommonImportOptions {
     /**
-     * Map a node's `graphics [ x y z ]` record to a `position` column with the position role
-     * (default true); false keeps the whole record in the `graphics` json column.
+     * Read a node's `graphics [ x y z ]` record as its position; false keeps the whole record as a
+     * JSON attribute named `graphics`.
+     * @defaultValue true
      */
     positions?: boolean | undefined;
-    /** Apply the dictionary heuristic of design section 5.4 to string columns (default true). */
+    /**
+     * Store a text attribute whose values repeat a lot (fewer distinct values than half the rows)
+     * as a dictionary column, which uses less memory and reads the same. Such a column reports
+     * `meta.dtype` "dict" instead of "string". A column with a role, such as the `label` column,
+     * always stays "string".
+     * @defaultValue true
+     */
     dictionaries?: boolean | undefined;
 }
-/** Issue code: the text holds no `graph [ ... ]` block. */
+/**
+ * The text holds no `graph [ ... ]` block.
+ * @category Issue and loss codes
+ */
 export declare const NO_GRAPH_CODE = "E_NO_GRAPH";
-/** Issue code: the text holds more than one `graph [ ... ]` block; import() reads the first, importAll() every one. */
+/**
+ * The text holds more than one `graph [ ... ]` block; import() reads the first, importAll() every one.
+ * @category Issue and loss codes
+ */
 export declare const SECOND_GRAPH_CODE = "W_MULTIPLE_GRAPHS";
-/** Issue code: a node block has no `id` key. */
+/**
+ * A node block has no `id` key.
+ * @category Issue and loss codes
+ */
 export declare const MISSING_ID_CODE = "E_MISSING_ID";
-/** Issue code: a node block has no `label` key under `nodeIdFrom: "label"`. */
+/**
+ * A node block has no `label` key under `nodeIdFrom: "label"`.
+ * @category Issue and loss codes
+ */
 export declare const MISSING_LABEL_CODE = "E_GML_MISSING_LABEL";
-/** Issue code: an edge block has no `source` or no `target` key. */
+/**
+ * An edge block has no `source` or no `target` key.
+ * @category Issue and loss codes
+ */
 export declare const MISSING_ENDPOINT_CODE = "E_MISSING_ENDPOINT";
-/** Issue code: an `id`, `source` or `target` value is neither an integer nor a string. */
+/**
+ * An `id`, `source` or `target` value is neither an integer nor a string.
+ * @category Issue and loss codes
+ */
 export declare const ID_TYPE_CODE = "E_GML_ID_TYPE";
-/** Issue code: string `id`, `source` or `target` values, outside the GML spec's integer ids; warned once per file. */
+/**
+ * Node ids, sources or targets are text, where GML expects integers. They are read under the `ids` option. Reported
+ * once per file.
+ * @category Issue and loss codes
+ */
 export declare const STRING_ID_CODE = "W_GML_STRING_ID";
-/** Issue code: a node id (or label under `nodeIdFrom: "label"`) is declared twice; later keys overwrite. */
+/**
+ * A node id (or label under `nodeIdFrom: "label"`) is declared twice; later keys overwrite.
+ * @category Issue and loss codes
+ */
 export declare const DUPLICATE_NODE_CODE = "W_DUPLICATE_NODE";
-/** Issue code: a structural key (`id`, `source`, `target`) appears twice in one block. */
+/**
+ * A structural key (`id`, `source`, `target`) appears twice in one block.
+ * @category Issue and loss codes
+ */
 export declare const REPEATED_KEY_CODE = "E_GML_REPEATED_KEY";
-/** Issue code: a `node` or `edge` key whose value is not a `[ ... ]` block. */
+/**
+ * A `node` or `edge` key whose value is not a `[ ... ]` block.
+ * @category Issue and loss codes
+ */
 export declare const ELEMENT_TYPE_CODE = "E_GML_ELEMENT_TYPE";
-/** Issue code: a `directed` or `multigraph` flag that is not an integer. */
+/**
+ * A `directed` or `multigraph` flag that is not an integer.
+ * @category Issue and loss codes
+ */
 export declare const FLAG_TYPE_CODE = "E_GML_FLAG_TYPE";
-/** Issue code: a `directed` / `multigraph` flag that is not 0 or 1 (read as its truth value), one written as a quoted integer, or one repeated. */
+/**
+ * A `directed` / `multigraph` flag that is not 0 or 1 (read as its truth value), one written as a quoted integer, or
+ * one repeated.
+ * @category Issue and loss codes
+ */
 export declare const FLAG_VALUE_CODE = "W_GML_FLAG_VALUE";
-/** Issue code: a named entity in a string that is neither an XML nor an ISO-8859-1 HTML entity; it is kept as written. */
+/**
+ * A named entity in a string that is neither an XML nor an ISO-8859-1 HTML entity, or a numeric reference beyond
+ * U+10FFFF; it is kept as written.
+ * @category Issue and loss codes
+ */
 export declare const UNKNOWN_ENTITY_CODE = "W_GML_UNKNOWN_ENTITY";
-/** Issue code: an integer beyond 2^53 stored as the nearest f64 (design section 5.1). */
+/**
+ * A node's `graphics` value cannot give a position as written (not a record, repeated in the node, or with an x / y /
+ * z that is not one number); the value is kept in the graphics json column. Warned once per kind of problem, naming
+ * the first node.
+ * @category Issue and loss codes
+ */
+export declare const GRAPHICS_CODE = "W_GML_GRAPHICS";
+/**
+ * A `graph`, `node` or `edge` record inside a node or edge; kept as a json column, not read as structure.
+ * @category Issue and loss codes
+ */
+export declare const NESTED_ELEMENT_CODE = "W_GML_NESTED_ELEMENT";
+/**
+ * YEd's group keys (`isGroup`, `gid`); kept as plain node columns, the hierarchy is not read as containment.
+ * @category Issue and loss codes
+ */
+export declare const GROUPS_CODE = "W_GML_GROUPS";
+/**
+ * A key whose values mix numbers and strings; the column is string, the numbers kept as written.
+ * @category Issue and loss codes
+ */
+export declare const WIDENED_CODE = "W_WIDENED";
+/**
+ * An integer above 2^53 was stored as the nearest JavaScript number, so its last digits may differ. Pass `long:
+ * "string"` to keep every digit as text.
+ * @category Issue and loss codes
+ */
 export declare const PRECISION_CODE = "W_PRECISION";
-/** Issue code: the sink already holds a column of the name with another declaration; renamed `<name>#<key>`. */
+/**
+ * Two attributes would have had the same name, so this one was renamed `<name>#<key>`.
+ * @category Plugin helpers
+ */
 export declare const COLUMN_RENAMED_CODE_GML = "W_COLUMN_RENAMED";
-/** Issue code: the sink already holds a column with the role; the column is declared without it. */
+/**
+ * You read into a graph builder that already has an attribute with this role, so this file's attribute is kept without
+ * the role.
+ * @category Issue and loss codes
+ */
 export declare const ROLE_TAKEN_CODE = "W_ROLE_TAKEN";
-/** Loss code: under `nodeIdFrom` "label" / "index" the integer `id` keys are not kept. */
+/**
+ * Under `nodeIdFrom` "label" / "index" the integer `id` keys are not kept.
+ * @category Issue and loss codes
+ */
 export declare const ID_DROPPED_CODE = "W_GML_ID_DROPPED";
-/** The GML importer plugin. */
+/**
+ * The GML importer plugin.
+ * @category Built-in formats
+ */
 export declare const gmlImporter: GraphImporter<GmlImportOptions>;
 //# sourceMappingURL=importer.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"importer.d.ts","sourceRoot":"","sources":["../../../../src/formats/gml/importer.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;GAsBG;AAqCH,OAAO,EAA4B,KAAK,aAAa,EAAuC,MAAM,gBAAgB,CAAC;AAmBnH,uDAAuD;AACvD,MAAM,WAAW,gBAAgB;IAC7B;;;OAGG;IACH,SAAS,CAAC,EAAE,OAAO,GAAG,SAAS,CAAC;IAChC,6FAA6F;IAC7F,YAAY,CAAC,EAAE,OAAO,GAAG,SAAS,CAAC;CACtC;AAED,2DAA2D;AAC3D,eAAO,MAAM,aAAa,eAAuB,CAAC;AAClD,uHAAuH;AACvH,eAAO,MAAM,iBAAiB,sBAAuB,CAAC;AACtD,gDAAgD;AAChD,eAAO,MAAM,eAAe,iBAAyB,CAAC;AACtD,+EAA+E;AAC/E,eAAO,MAAM,kBAAkB,wBAAwB,CAAC;AACxD,oEAAoE;AACpE,eAAO,MAAM,qBAAqB,uBAA+B,CAAC;AAClE,0FAA0F;AAC1F,eAAO,MAAM,YAAY,kBAAkB,CAAC;AAC5C,sHAAsH;AACtH,eAAO,MAAM,cAAc,oBAAoB,CAAC;AAChD,4GAA4G;AAC5G,eAAO,MAAM,mBAAmB,qBAA6B,CAAC;AAC9D,0FAA0F;AAC1F,eAAO,MAAM,iBAAiB,uBAAuB,CAAC;AACtD,+EAA+E;AAC/E,eAAO,MAAM,iBAAiB,uBAAuB,CAAC;AACtD,4EAA4E;AAC5E,eAAO,MAAM,cAAc,oBAAoB,CAAC;AAChD,mJAAmJ;AACnJ,eAAO,MAAM,eAAe,qBAAqB,CAAC;AAIlD,0HAA0H;AAC1H,eAAO,MAAM,mBAAmB,yBAAyB,CAAC;AAC1D,yFAAyF;AACzF,eAAO,MAAM,cAAc,gBAAwB,CAAC;AACpD,gHAAgH;AAChH,eAAO,MAAM,uBAAuB,qBAAsB,CAAC;AAC3D,oGAAoG;AACpG,eAAO,MAAM,eAAe,iBAAyB,CAAC;AACtD,0FAA0F;AAC1F,eAAO,MAAM,eAAe,qBAAqB,CAAC;AA08ClD,+BAA+B;AAC/B,eAAO,MAAM,WAAW,EAAE,aAAa,CAAC,gBAAgB,CAqEtD,CAAC"}
+{"version":3,"file":"importer.d.ts","sourceRoot":"","sources":["../../../../src/formats/gml/importer.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;GAsBG;AAyCH,OAAO,EACH,KAAK,mBAAmB,EACxB,KAAK,kBAAkB,EACvB,KAAK,aAAa,EAGrB,MAAM,gBAAgB,CAAC;AAmBxB;;;GAGG;AACH,MAAM,WAAW,gBAAiB,SAAQ,kBAAkB,EAAE,mBAAmB;IAC7E;;;;OAIG;IACH,SAAS,CAAC,EAAE,OAAO,GAAG,SAAS,CAAC;IAChC;;;;;;OAMG;IACH,YAAY,CAAC,EAAE,OAAO,GAAG,SAAS,CAAC;CACtC;AAED;;;GAGG;AACH,eAAO,MAAM,aAAa,eAAuB,CAAC;AAClD;;;GAGG;AACH,eAAO,MAAM,iBAAiB,sBAAuB,CAAC;AACtD;;;GAGG;AACH,eAAO,MAAM,eAAe,iBAAyB,CAAC;AACtD;;;GAGG;AACH,eAAO,MAAM,kBAAkB,wBAAwB,CAAC;AACxD;;;GAGG;AACH,eAAO,MAAM,qBAAqB,uBAA+B,CAAC;AAClE;;;GAGG;AACH,eAAO,MAAM,YAAY,kBAAkB,CAAC;AAC5C;;;;GAIG;AACH,eAAO,MAAM,cAAc,oBAAoB,CAAC;AAChD;;;GAGG;AACH,eAAO,MAAM,mBAAmB,qBAA6B,CAAC;AAC9D;;;GAGG;AACH,eAAO,MAAM,iBAAiB,uBAAuB,CAAC;AACtD;;;GAGG;AACH,eAAO,MAAM,iBAAiB,uBAAuB,CAAC;AACtD;;;GAGG;AACH,eAAO,MAAM,cAAc,oBAAoB,CAAC;AAChD;;;;GAIG;AACH,eAAO,MAAM,eAAe,qBAAqB,CAAC;AAIlD;;;;GAIG;AACH,eAAO,MAAM,mBAAmB,yBAAyB,CAAC;AAC1D;;;;;GAKG;AACH,eAAO,MAAM,aAAa,mBAAmB,CAAC;AAC9C;;;GAGG;AACH,eAAO,MAAM,mBAAmB,yBAAyB,CAAC;AAC1D;;;GAGG;AACH,eAAO,MAAM,WAAW,iBAAiB,CAAC;AAC1C;;;GAGG;AACH,eAAO,MAAM,YAAY,cAAsB,CAAC;AAChD;;;;GAIG;AACH,eAAO,MAAM,cAAc,gBAAwB,CAAC;AACpD;;;GAGG;AACH,eAAO,MAAM,uBAAuB,qBAAsB,CAAC;AAC3D;;;;GAIG;AACH,eAAO,MAAM,eAAe,iBAAyB,CAAC;AACtD;;;GAGG;AACH,eAAO,MAAM,eAAe,qBAAqB,CAAC;AAiqDlD;;;GAGG;AACH,eAAO,MAAM,WAAW,EAAE,aAAa,CAAC,gBAAgB,CA0EtD,CAAC"}