@graphty/graph-io 0.3.24 → 0.3.26

package/dist/src/common/codes.d.ts

@@ -1,6 +1,5 @@
 /**
- * The issue and loss codes shared by more than one format (design section 8.6: "a stable code
- * such as E_UNKNOWN_NODE or W_WIDENED"): one constant per condition, aliased by every format's
+ * The issue and loss codes shared by more than one format: one constant per condition, aliased by every format's
  * `<FMT>_ISSUE` / `<FMT>_LOSS` table, so a consumer can switch on a condition without knowing the
  * format and two importers never spell the same condition differently. A condition specific to one
  * format keeps that format's own `E_<FMT>_` / `W_<FMT>_` code next to its importer or exporter.
@@ -9,146 +8,537 @@
  * throws), `W_` for a warning; a table key is the code without the severity prefix and without the
  * format prefix.
  */
-/** The element (node, attribute, key, ...) has no id where the format requires one. */
+/**
+ * The URL could not be fetched (network failure, CORS refusal or a non-2xx status).
+ * @category Issue and loss codes
+ */
+export declare const FETCH_CODE = "E_FETCH";
+/**
+ * The element (node, attribute, key, ...) has no id where the format requires one.
+ * @category Issue and loss codes
+ */
 export declare const MISSING_ID_CODE = "E_MISSING_ID";
-/** An edge has no source or no target. */
+/**
+ * An edge has no source or no target.
+ * @category Issue and loss codes
+ */
 export declare const MISSING_ENDPOINT_CODE = "E_MISSING_ENDPOINT";
-/** A node id declared twice; the second declaration merges into the first. */
+/**
+ * A node id declared twice; the second declaration merges into the first.
+ * @category Issue and loss codes
+ */
 export declare const DUPLICATE_NODE_CODE = "W_DUPLICATE_NODE";
-/** The document declares no graph at all (fatal). */
+/**
+ * The file declares no graph at all. The import stops.
+ * @category Issue and loss codes
+ */
 export declare const NO_GRAPH_CODE = "E_NO_GRAPH";
-/** A second graph in one document is merged into the first. */
+/**
+ * The file holds several graphs and only the first was read (GraphML and GEXF merge them into one graph instead). It is not added when `graphIndex` or `graphName` chose the graph.
+ * `importAllGraphs()` reads every one.
+ * @category Issue and loss codes
+ */
 export declare const MULTIPLE_GRAPHS_CODE = "W_MULTIPLE_GRAPHS";
-/** The input is empty (fatal). */
+/**
+ * The input is empty. The import stops.
+ * @category Issue and loss codes
+ */
 export declare const EMPTY_INPUT_CODE = "E_EMPTY_INPUT";
-/** The text grammar of the format is violated (fatal; the message carries the detail). */
+/**
+ * The text breaks the format's syntax; the message says where and how. The import stops.
+ * @category Issue and loss codes
+ */
 export declare const SYNTAX_CODE = "E_SYNTAX";
-/** The XML is not well-formed (fatal; the message carries the detail and the line). */
+/**
+ * The XML is not well-formed; the message says where. The import stops.
+ * @category Issue and loss codes
+ */
 export declare const XML_SYNTAX_CODE = "E_XML_SYNTAX";
-/** An element the format does not define at that place was skipped. */
+/**
+ * An element the format does not define at that place was skipped.
+ * @category Issue and loss codes
+ */
 export declare const UNKNOWN_ELEMENT_CODE = "W_UNKNOWN_ELEMENT";
-/** Text where the format allows only elements was ignored. */
+/**
+ * Text where the format allows only elements was ignored.
+ * @category Issue and loss codes
+ */
 export declare const STRAY_TEXT_CODE = "W_STRAY_TEXT";
-/** A `pid` / parent reference names a node the document never declares. */
+/**
+ * A `pid` / parent reference names a node the document never declares.
+ * @category Issue and loss codes
+ */
 export declare const UNKNOWN_PARENT_CODE = "E_UNKNOWN_PARENT";
-/** A hyperedge under the `hyperedges: "error"` policy (fatal). */
+/**
+ * A hyperedge (an edge with more than two ends) while `hyperedges` is "error". The import stops.
+ * @category Issue and loss codes
+ */
 export declare const HYPEREDGE_CODE = "E_HYPEREDGE";
-/** A declaration's key / attribute id is declared twice. */
+/**
+ * A declaration's key / attribute id is declared twice.
+ * @category Issue and loss codes
+ */
 export declare const DUPLICATE_KEY_CODE = "E_DUPLICATE_KEY";
 /**
- * A column was renamed `<name>#<origin.id>` because the name was taken in the sink's table
- * (design section 5.6).
+ * An attribute was renamed `<name>#<suffix>` because another attribute already has its name, for example a repeated
+ * column header.
+ * @category Issue and loss codes
  */
 export declare const COLUMN_RENAMED_CODE = "W_COLUMN_RENAMED";
-/** A column's role was dropped because another column of the table already holds it (design section 5.5). */
+/**
+ * A node or edge attribute is not written, because the format has nowhere to put it.
+ * @category Issue and loss codes
+ */
+export declare const COLUMN_DROPPED_CODE = "W_COLUMN_DROPPED";
+/**
+ * You read into a graph builder that already has an id, label or position attribute, so this file's one is kept as a
+ * plain attribute.
+ * @category Issue and loss codes
+ */
 export declare const ROLE_TAKEN_CODE = "W_ROLE_TAKEN";
-/** A long value beyond 2^53 was stored as the nearest f64 (design section 5.1). */
+/**
+ * An integer beyond 2^53 was stored as the nearest 64-bit float; pass `long: "string"` to keep every digit.
+ * @category Issue and loss codes
+ */
 export declare const PRECISION_CODE = "W_PRECISION";
-/** Two distinct id texts became one number under ids "number" (design section 4.1). */
+/**
+ * Two different id texts became the same number because `ids` is "number" (for example, "042" and "42"), so their nodes were
+ * merged.
+ * @category Issue and loss codes
+ */
 export declare const ID_MERGED_CODE = "W_ID_MERGED";
-/** A builder-policy option the caller asked for that the sink does not honour (design section 8.4). */
+/**
+ * You read into your own graph builder, which was created with a different `addMissingNodes`, `duplicateEdges`,
+ * `selfLoops` or `weightDtype` than the option you passed; the builder's setting applies.
+ * @category Issue and loss codes
+ */
 export declare const SINK_OPTION_CODE = "W_SINK_OPTION";
-/** A common option the format has no use for (or cannot honour) was given a non-default value (design section 8.4). */
+/**
+ * You set an option this format does not use; it had no effect. The message names the option.
+ * @category Issue and loss codes
+ */
 export declare const OPTION_IGNORED_CODE = "W_OPTION_IGNORED";
-/** An invalid UTF-8 sequence in the input (fatal). */
+/**
+ * The input is not valid UTF-8. The import stops.
+ * @category Issue and loss codes
+ */
 export declare const INVALID_UTF8_CODE = "E_INVALID_UTF8";
-/** Bytes that are not valid in the encoding a BOM, a declaration or the `encoding` option chose (fatal). */
+/**
+ * Some bytes are not valid in the encoding that was chosen (by a byte order mark, the file's own declaration or the
+ * `encoding` option). The import stops.
+ * @category Issue and loss codes
+ */
 export declare const INVALID_ENCODING_CODE = "E_INVALID_ENCODING";
-/** Bytes that are not valid UTF-8 (and declare no other encoding) were read as windows-1252. */
+/**
+ * Bytes that are not valid UTF-8 (and declare no other encoding) were read as windows-1252.
+ * @category Issue and loss codes
+ */
 export declare const ENCODING_FALLBACK_CODE = "W_ENCODING_FALLBACK";
-/** The file declares an encoding the platform's TextDecoder does not know; the declaration is ignored. */
+/**
+ * The file declares an encoding the platform's TextDecoder does not know; the declaration is ignored.
+ * @category Issue and loss codes
+ */
 export declare const UNKNOWN_ENCODING_CODE = "W_UNKNOWN_ENCODING";
-/** The sink refused the file's direction (locked or non-empty); the file is read as the sink's. */
+/**
+ * A byte order mark, the `encoding` option and the encoding the file declares disagree, or the file
+ * declares UTF-16 over bytes that are not UTF-16; the message names which one applied (a BOM wins
+ * over the option and the declaration, the option over the declaration).
+ * @category Issue and loss codes
+ */
+export declare const ENCODING_CONFLICT_CODE = "W_ENCODING_CONFLICT";
+/**
+ * The text holds a control character, such as a NUL byte or an escape character, which is kept in the id or value it
+ * is part of; or it ends with a Ctrl-Z end-of-file marker, which was ignored. Reported once per import.
+ * @category Issue and loss codes
+ */
+export declare const CONTROL_CHARACTER_CODE = "W_CONTROL_CHARACTER";
+/**
+ * The input is a known kind of file that is not a graph: an HTML page, a PDF, compressed or zip data, or an image. The
+ * import stops.
+ * @category Issue and loss codes
+ */
+export declare const FOREIGN_FORMAT_CODE = "E_FOREIGN_FORMAT";
+/**
+ * More warnings of one code than a report keeps: the first ones are kept and this one warning (the
+ * suppressed code as its element) counts the rest.
+ * @category Issue and loss codes
+ */
+export declare const ISSUES_SUPPRESSED_CODE = "W_ISSUES_SUPPRESSED";
+/**
+ * An XML attribute the format does not define (or does not keep) on that element; it is not kept.
+ * @category Issue and loss codes
+ */
+export declare const UNKNOWN_XML_ATTRIBUTE_CODE = "W_UNKNOWN_XML_ATTRIBUTE";
+/**
+ * You read into a graph builder that already holds edges (or whose direction is locked), and its direction differs
+ * from the file's, so the file is read with the builder's direction. A builder without edges takes the file's
+ * direction.
+ * @category Issue and loss codes
+ */
 export declare const DIRECTION_REFUSED_CODE = "W_DIRECTION_REFUSED";
-/** Edges of the other direction were forced to the policy's direction. */
+/**
+ * `onMixedDirection` ("directed" or "undirected") made edges take a direction the file did not give them. It can
+ * appear twice in one report: once for the direction the file declares and once for the edges that declared
+ * their own.
+ * @category Issue and loss codes
+ */
 export declare const DIRECTION_FORCED_CODE = "W_DIRECTION_FORCED";
-/** A mixed-direction file under onMixedDirection "error" (import), or a mixed snapshot under the same export policy. */
+/**
+ * The graph has both directed and undirected edges and `onMixedDirection` is "error". An import stops; a save to a
+ * format that holds one direction per file fails with E_DIRECTED. Pass "directed" or "undirected" to read or write it
+ * anyway.
+ * @category Issue and loss codes
+ */
 export declare const MIXED_DIRECTION_CODE = "E_MIXED_DIRECTION";
-/** A `count` / `parse.nodes` hint the sink cannot reserve (ignored). */
+/**
+ * A node or edge count the file announces is too large to reserve room for; it is ignored and the elements are read as
+ * they come.
+ * @category Issue and loss codes
+ */
 export declare const COUNT_HINT_CODE = "W_COUNT_HINT";
-/** The declared type is not one the format defines; the column is kept as string. */
+/**
+ * The declared type is not one the format defines; the column is kept as string.
+ * @category Issue and loss codes
+ */
 export declare const UNKNOWN_ATTR_TYPE_CODE = "W_UNKNOWN_ATTR_TYPE";
-/** The declared default does not parse as the declared type; the column has no default. */
+/**
+ * The declared default does not parse as the declared type; the column has no default.
+ * @category Issue and loss codes
+ */
 export declare const BAD_DEFAULT_CODE = "W_BAD_DEFAULT";
-/** A declared option does not parse as the declared type; the options are dropped. */
+/**
+ * A declared option does not parse as the declared type; the options are dropped.
+ * @category Issue and loss codes
+ */
 export declare const BAD_OPTIONS_CODE = "W_BAD_OPTIONS";
-/** A repeated edge id in a format whose edge ids are unique; the second edge is skipped. */
+/**
+ * A repeated edge id in a format whose edge ids are unique; the second edge is skipped.
+ * @category Issue and loss codes
+ */
 export declare const DUPLICATE_EDGE_ID_CODE = "E_DUPLICATE_EDGE_ID";
-/** A value does not parse as its declared type; the cell is left unset. */
+/**
+ * A value does not parse as its declared type; the cell is left unset.
+ * @category Issue and loss codes
+ */
 export declare const BAD_VALUE_CODE = "E_BAD_VALUE";
 /**
- * A column's dtype was widened (design section 5.1) because a later value did not fit: an i32
- * column meeting a value above 2^31, two declared types for one attribute.
+ * An attribute's type was widened because a later value did not fit: an integer above 2^31 in an integer column, or
+ * two declared types for one attribute.
+ * @category Issue and loss codes
  */
 export declare const WIDENED_CODE = "W_WIDENED";
 /**
  * A reference that is not a containment link (an attribute's element id, a layout or bypass
  * entry, a subnetwork member, a view's network, an undeclared target) names nothing; reported
  * once per kind with the count.
+ * @category Issue and loss codes
  */
 export declare const DANGLING_REFERENCE_CODE = "W_DANGLING_REFERENCE";
-/** The same attribute twice on one element; one value is kept (the later, unless the format's specification says the first). */
+/**
+ * The same attribute twice on one element; one value is kept (the later, unless the format's specification says the first).
+ * @category Issue and loss codes
+ */
 export declare const DUPLICATE_ATTRIBUTE_CODE = "W_DUPLICATE_ATTRIBUTE";
-/** A containment link would close a parent cycle; that one link is dropped. */
+/**
+ * A containment link would close a parent cycle; that one link is dropped.
+ * @category Issue and loss codes
+ */
 export declare const PARENT_CYCLE_CODE = "E_PARENT_CYCLE";
-/** A formula (Cytoscape's `=ABS($x)`) is kept as its text; it is never evaluated. */
+/**
+ * A formula (Cytoscape's `=ABS($x)`) is kept as its text; it is never evaluated.
+ * @category Issue and loss codes
+ */
 export declare const EQUATION_AS_TEXT_CODE = "W_EQUATION_AS_TEXT";
 /**
- * The file's style rules (defaults, mappings, dependencies, visual property aspects) are not
- * applied to the snapshot; recorded once per import, the message names what was not applied.
+ * The file's style rules (default styles, mappings, visual properties) are not applied to the graph. Reported once per
+ * import; the message names what was not applied.
+ * @category Issue and loss codes
  */
 export declare const STYLES_NOT_IMPORTED_CODE = "W_STYLES_NOT_IMPORTED";
-/** A CX array member that is not a one-key object holding an array or an object; the block is skipped. */
+/**
+ * A CX file is an array of blocks, each an object with one key (`{"nodes": [...]}`). A member of that array
+ * that is not such a block cannot be read and is skipped; the rest of the file is read.
+ * @category Issue and loss codes
+ */
 export declare const BAD_ASPECT_BLOCK_CODE = "E_BAD_ASPECT_BLOCK";
-/** A CX aspect out of its place (after the post-metadata, a status that is not last, a block buffered for what it depends on). */
+/**
+ * A CX array member holding several aspects (`{"nodes": [...], "edges": [...]}`); each array-valued key is read as its own fragment.
+ * @category Issue and loss codes
+ */
+export declare const MULTI_ASPECT_FRAGMENT_CODE = "W_MULTI_ASPECT_FRAGMENT";
+/**
+ * A CX aspect, an array of elements, written as one object (`{"nodes": {"@id": 1}}`); read as one element.
+ * @category Issue and loss codes
+ */
+export declare const SINGLE_OBJECT_ASPECT_CODE = "W_SINGLE_OBJECT_ASPECT";
+/**
+ * The document uses the bare tokens NaN, Infinity or -Infinity (Python's json writes them), which
+ * strict JSON does not allow; read as the numbers.
+ * @category Issue and loss codes
+ */
+export declare const JSON_NONSTANDARD_NUMBER_CODE = "W_JSON_NONSTANDARD_NUMBER";
+/**
+ * A CX aspect out of its place (after the post-metadata, a status that is not last, a block buffered for what it depends on).
+ * @category Issue and loss codes
+ */
 export declare const ASPECT_ORDER_CODE = "W_ASPECT_ORDER";
-/** A declared element count disagrees with what was read. */
+/**
+ * A declared element count disagrees with what was read.
+ * @category Issue and loss codes
+ */
 export declare const COUNT_MISMATCH_CODE = "W_COUNT_MISMATCH";
-/** The producer marked the document as failed (CX `status.success: false`): it is incomplete (fatal). */
+/**
+ * The program that wrote the file marked it as failed (CX `status.success: false`), so it is incomplete. The import
+ * stops.
+ * @category Issue and loss codes
+ */
 export declare const STATUS_FAILED_CODE = "E_STATUS_FAILED";
-/** The producer marked the document as successful but attached an error text. */
+/**
+ * The producer marked the document as successful but attached an error text.
+ * @category Issue and loss codes
+ */
 export declare const STATUS_WARNING_CODE = "W_STATUS_WARNING";
 /**
  * The input is beyond a size limit (a zip's uncompressed total or ratio, a document longer than
  * one string); the same string as graph-format's E_TOO_LARGE, recorded with category "unsupported".
+ * @category Issue and loss codes
  */
 export declare const TOO_LARGE_CODE = "E_TOO_LARGE";
-/** `graphIndex` is beyond the graphs of the input, or `graphName` names none of them (fatal). */
+/**
+ * A value that does not fit its attribute's type. An import records it for a value that does not parse as the
+ * type the file declares for it ("x" in an integer attribute): GraphML and GEXF leave that value unset, Neo4j CSV
+ * skips the row. A save throws it when an attribute value cannot be written in the format; `checkExport()` returns
+ * the `E_` note that names the attribute.
+ * @category Issue and loss codes
+ */
+export declare const COLUMN_TYPE_CODE = "E_COLUMN_TYPE";
+/**
+ * `graphIndex` is past the last graph in the file, or `graphName` matches none of them. The import stops, and
+ * the message lists the index and name of each graph the file holds.
+ * @category Issue and loss codes
+ */
 export declare const GRAPH_NOT_FOUND_CODE = "E_GRAPH_NOT_FOUND";
-/** `graphName` names more than one graph of the input; the message lists their indexes (fatal). */
+/**
+ * `graphName` matches more than one graph; the message lists their positions. The import stops.
+ * @category Issue and loss codes
+ */
 export declare const AMBIGUOUS_GRAPH_NAME_CODE = "E_AMBIGUOUS_GRAPH_NAME";
-/** A role column the format has no slot for is written as a plain attribute (the role is lost). */
+/**
+ * A second edge between the same two nodes under `duplicateEdges: "error"`; the import stops.
+ * @category Issue and loss codes
+ */
+export declare const DUPLICATE_EDGE_CODE = "E_DUPLICATE_EDGE";
+/**
+ * An edge from a node to itself under `selfLoops: "error"`; the import stops.
+ * @category Issue and loss codes
+ */
+export declare const SELF_LOOP_CODE = "E_SELF_LOOP";
+/**
+ * The `duplicateEdges` option merged parallel edges into one edge per pair, so whatever told them apart (an OBO
+ * relation, a label) is lost. Recorded once, with the number merged.
+ * @category Issue and loss codes
+ */
+export declare const EDGES_MERGED_CODE = "W_EDGES_MERGED";
+/**
+ * Self-loops were removed by the `selfLoops: "drop"` option. Recorded once by importGraph() with the
+ * number removed.
+ * @category Issue and loss codes
+ */
+export declare const SELF_LOOPS_DROPPED_CODE = "W_SELF_LOOPS_DROPPED";
+/**
+ * An option name that no format and no load or save function takes, most often a misspelling (`delimeter`). The
+ * option has no effect. A load records it as a warning, and `checkExport()` returns it as a note. Reported only while
+ * every registered format lists its options, as the built-in formats do.
+ * @category Issue and loss codes
+ */
+export declare const UNKNOWN_OPTION_CODE = "W_UNKNOWN_OPTION";
+/**
+ * A line the `parseLine` function of a format made with defineLineFormat() could not read (it threw). The line is
+ * skipped; the message is the one the function threw with.
+ * @category Issue and loss codes
+ */
+export declare const BAD_LINE_CODE = "E_BAD_LINE";
+/**
+ * The `weightFrom` option names an attribute no edge has a value for, so the graph has no weights. The usual cause
+ * is one options object shared between formats: GML and Pajek keep their weights in `value`, not `weight`. Recorded
+ * once by importGraph().
+ * @category Issue and loss codes
+ */
+export declare const WEIGHT_NOT_FOUND_CODE = "W_WEIGHT_NOT_FOUND";
+/**
+ * An attribute with a role the format has no place for is written as a plain attribute; the role is lost.
+ * @category Issue and loss codes
+ */
 export declare const ROLE_DROPPED_CODE = "W_ROLE_DROPPED";
-/** A parents (multi-parent) column in a format with single containment only. */
+/**
+ * A parents (multi-parent) column in a format with single containment only.
+ * @category Issue and loss codes
+ */
 export declare const PARENTS_DROPPED_CODE = "W_PARENTS_DROPPED";
-/** A start / end / timestamp column in a format without temporal support. */
+/**
+ * A start / end / timestamp column in a format without temporal support.
+ * @category Issue and loss codes
+ */
 export declare const TEMPORAL_DROPPED_CODE = "W_TEMPORAL_DROPPED";
-/** A mutual pair is written as two directed edges without the mutual mark. */
+/**
+ * A mutual pair is written as two directed edges without the mutual mark.
+ * @category Issue and loss codes
+ */
 export declare const MUTUAL_EXPANDED_CODE = "W_MUTUAL_EXPANDED";
-/** A mutual pair is written as one undirected edge; the pair reads back undirected, the mark is lost. */
+/**
+ * A mutual pair is written as one undirected edge; the pair reads back undirected, the mark is lost.
+ * @category Issue and loss codes
+ */
 export declare const MUTUAL_AS_UNDIRECTED_CODE = "W_MUTUAL_AS_UNDIRECTED";
-/** Node ids whose written text reads back as the other type under the importer's id rule. */
+/**
+ * Node ids whose written text reads back as the other type under the importer's id rule.
+ * @category Issue and loss codes
+ */
 export declare const ID_TEXT_TYPE_CODE = "W_ID_TEXT_TYPE";
-/** Two node ids share one written text; export() throws E_INVALID_ID. */
+/**
+ * Two node ids would be written as the same text (the number 5 and the text "5"); the save fails with E_INVALID_ID.
+ * @category Issue and loss codes
+ */
 export declare const ID_TEXT_COLLISION_CODE = "E_ID_TEXT_COLLISION";
-/** A `<column>.text` companion (design section 5.1) the format cannot carry. */
+/**
+ * A `<column>.text` companion the format cannot carry.
+ * @category Issue and loss codes
+ */
 export declare const TEMPORAL_TEXT_DROPPED_CODE = "W_TEMPORAL_TEXT_DROPPED";
-/** A plain column named like the importer's weight key reads back as THE weight. */
+/**
+ * The graph has edge weights and the file does not keep them: every edge reads back with the default weight 1.
+ * @category Issue and loss codes
+ */
+export declare const WEIGHTS_DROPPED_CODE = "W_WEIGHTS_DROPPED";
+/**
+ * An attribute without the weight role is named like the attribute graph-io reads weights from (for example, `weight`), so it
+ * reads back as the edge weight.
+ * @category Issue and loss codes
+ */
 export declare const WEIGHT_KEY_CLASH_CODE = "W_WEIGHT_KEY_CLASH";
-/** A role-less column whose written name the importer maps to a role. */
+/**
+ * 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.
+ * @category Issue and loss codes
+ */
 export declare const ROLE_ASSUMED_CODE = "W_ROLE_ASSUMED";
-/** A role column written into the format's slot reads back under the importer's fixed name. */
+/**
+ * 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.
+ * @category Issue and loss codes
+ */
 export declare const COLUMN_RENAMED_LOSS_CODE = "W_COLUMN_NAME_CHANGED";
-/** A declared column whose every row is unset is not written by a format without declarations. */
+/**
+ * A declared column whose every row is unset is not written by a format without declarations.
+ * @category Issue and loss codes
+ */
 export declare const EMPTY_COLUMN_DROPPED_CODE = "W_EMPTY_COLUMN_DROPPED";
-/** A string / dict column whose cardinality makes the importer read it back as the other storage class. */
+/**
+ * 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.
+ * @category Issue and loss codes
+ */
 export declare const STORAGE_CLASS_CODE = "W_STORAGE_CLASS_CHANGED";
-/** An f64 column whose set values are all integral reads back as i32 through an untyped format. */
+/**
+ * A number attribute whose values are all whole numbers reads back as integers, because the format does not record the
+ * type.
+ * @category Issue and loss codes
+ */
 export declare const INTEGRAL_F64_CODE = "W_INTEGRAL_F64_AS_I32";
-/** A text cell that reads back as a number or boolean under the 5.1 grammar (its lexical form may change). */
+/**
+ * A text value that reads back as a number or a boolean, because the format does not record that it was text (the text
+ * "42" reads back as the number 42).
+ * @category Issue and loss codes
+ */
 export declare const TEXT_INFERRED_CODE = "W_TEXT_INFERRED";
-/** A string cell holding a character XML 1.0 forbids; export() throws E_COLUMN_TYPE. */
+/**
+ * A text value holds a character XML 1.0 forbids (most control characters); the save fails with E_COLUMN_TYPE.
+ * @category Issue and loss codes
+ */
 export declare const XML_ILLEGAL_CHAR_CODE = "E_XML_ILLEGAL_CHAR";
-/** A dict column without declared options gains one from its dictionary on re-import. */
+/**
+ * An ontology exporter (OBO, OBO Graphs) writes a node column outside its vocabulary as property values; it reads back inside the `property_value` column.
+ * @category Issue and loss codes
+ */
+export declare const COLUMN_AS_PROPERTY_VALUE_CODE = "W_COLUMN_AS_PROPERTY_VALUE";
+/**
+ * An ontology exporter writes an edge without a relation as `is_a` (or the relation the caller chose).
+ * @category Issue and loss codes
+ */
+export declare const RELATION_ASSUMED_CODE = "W_RELATION_ASSUMED";
+/**
+ * An ontology exporter writes Typedef (property) nodes; they read back as nodes only under the importer's `typedefs: "nodes"`.
+ * @category Issue and loss codes
+ */
+export declare const TYPEDEF_NODES_CODE = "W_TYPEDEF_NODES";
+/**
+ * A graph attribute is written into the file's metadata and reads back in `snapshot.meta.extra`, not as a graph
+ * attribute.
+ * @category Issue and loss codes
+ */
+export declare const GRAPH_COLUMN_AS_METADATA_CODE = "W_GRAPH_COLUMN_AS_METADATA";
+/**
+ * The file cannot record direction: an undirected graph's edges read back as directed, or the whole graph reads back
+ * with the importer's default direction.
+ * @category Issue and loss codes
+ */
+export declare const DIRECTION_DROPPED_CODE = "W_DIRECTION_DROPPED";
+/**
+ * NaN and the infinities cannot be written; they are written as null and read back unset.
+ * @category Issue and loss codes
+ */
+export declare const NONFINITE_AS_NULL_CODE = "W_NONFINITE_AS_NULL";
+/**
+ * The nodes read back in a different order.
+ * @category Issue and loss codes
+ */
+export declare const NODE_ORDER_CODE = "W_NODE_ORDER";
+/**
+ * A text attribute stored as a dictionary, without a declared list of allowed values, reads back with its distinct
+ * values as that list.
+ * @category Issue and loss codes
+ */
 export declare const OPTIONS_GAINED_CODE = "W_OPTIONS_GAINED";
+/**
+ * The issue codes every importer can record when the graph refuses an element, by name; every
+ * format's `<FMT>_ISSUE` table includes them. Each one skips that element and counts toward
+ * `errorLimit`.
+ * @category Issue and loss codes
+ */
+export declare const ELEMENT_ISSUE: Readonly<{
+    /** A node id of a type the graph cannot hold (an empty id, a non-finite number, an object). The node is skipped. */
+    INVALID_ID: "E_INVALID_ID";
+    /** An edge names a node the file never declares, while `addMissingNodes` is false. The edge is skipped. */
+    UNKNOWN_NODE: "E_UNKNOWN_NODE";
+    /**
+     * An edge weight that is not a number (text such as "2,5" with a decimal comma, NaN, a boolean). The whole edge is
+     * skipped, not only its weight.
+     */
+    INVALID_WEIGHT: "E_INVALID_WEIGHT";
+    /** A second edge between the same two nodes, while `duplicateEdges` is "error". The edge is skipped. */
+    DUPLICATE_EDGE: "E_DUPLICATE_EDGE";
+    /** An edge from a node to itself, while `selfLoops` is "error". The edge is skipped. */
+    SELF_LOOP: "E_SELF_LOOP";
+    /** An edge id declared twice. The second edge is skipped. */
+    DUPLICATE_EDGE_ID: "E_DUPLICATE_EDGE_ID";
+}>;
+/**
+ * The issue codes every importer can record for input it cannot read (empty, too large, invalid
+ * bytes, not a graph file), by name; every format's `<FMT>_ISSUE` table includes them.
+ * @category Issue and loss codes
+ */
+export declare const INPUT_ISSUE: Readonly<{
+    /** The input is empty or holds only whitespace. The import stops. */
+    EMPTY_INPUT: "E_EMPTY_INPUT";
+    /** The input, or one of its lines, is longer than a JavaScript string can hold. The import stops. */
+    TOO_LARGE: "E_TOO_LARGE";
+    /** A byte order mark, the encoding option and the declared encoding disagree. */
+    ENCODING_CONFLICT: "W_ENCODING_CONFLICT";
+    /** A control character or a stray U+FEFF in the text, or an ignored trailing Ctrl-Z. */
+    CONTROL_CHARACTER: "W_CONTROL_CHARACTER";
+    /** The input is an HTML page, a PDF, compressed or zip data, or an image. The import stops. */
+    FOREIGN_FORMAT: "E_FOREIGN_FORMAT";
+    /** Warnings of one code beyond the number a report keeps, counted in one warning. */
+    ISSUES_SUPPRESSED: "W_ISSUES_SUPPRESSED";
+}>;
 //# sourceMappingURL=codes.d.ts.map

package/dist/src/common/codes.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"codes.d.ts","sourceRoot":"","sources":["../../../src/common/codes.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;GAUG;AAIH,uFAAuF;AACvF,eAAO,MAAM,eAAe,iBAAiB,CAAC;AAE9C,0CAA0C;AAC1C,eAAO,MAAM,qBAAqB,uBAAuB,CAAC;AAE1D,8EAA8E;AAC9E,eAAO,MAAM,mBAAmB,qBAAqB,CAAC;AAEtD,qDAAqD;AACrD,eAAO,MAAM,aAAa,eAAe,CAAC;AAE1C,+DAA+D;AAC/D,eAAO,MAAM,oBAAoB,sBAAsB,CAAC;AAExD,kCAAkC;AAClC,eAAO,MAAM,gBAAgB,kBAAkB,CAAC;AAEhD,0FAA0F;AAC1F,eAAO,MAAM,WAAW,aAAa,CAAC;AAEtC,uFAAuF;AACvF,eAAO,MAAM,eAAe,iBAAiB,CAAC;AAE9C,uEAAuE;AACvE,eAAO,MAAM,oBAAoB,sBAAsB,CAAC;AAExD,8DAA8D;AAC9D,eAAO,MAAM,eAAe,iBAAiB,CAAC;AAE9C,2EAA2E;AAC3E,eAAO,MAAM,mBAAmB,qBAAqB,CAAC;AAEtD,kEAAkE;AAClE,eAAO,MAAM,cAAc,gBAAgB,CAAC;AAE5C,4DAA4D;AAC5D,eAAO,MAAM,kBAAkB,oBAAoB,CAAC;AAEpD;;;GAGG;AACH,eAAO,MAAM,mBAAmB,qBAAqB,CAAC;AAEtD,6GAA6G;AAC7G,eAAO,MAAM,eAAe,iBAAiB,CAAC;AAE9C,mFAAmF;AACnF,eAAO,MAAM,cAAc,gBAAgB,CAAC;AAE5C,uFAAuF;AACvF,eAAO,MAAM,cAAc,gBAAgB,CAAC;AAE5C,uGAAuG;AACvG,eAAO,MAAM,gBAAgB,kBAAkB,CAAC;AAEhD,uHAAuH;AACvH,eAAO,MAAM,mBAAmB,qBAAqB,CAAC;AAEtD,sDAAsD;AACtD,eAAO,MAAM,iBAAiB,mBAAmB,CAAC;AAElD,4GAA4G;AAC5G,eAAO,MAAM,qBAAqB,uBAAuB,CAAC;AAE1D,gGAAgG;AAChG,eAAO,MAAM,sBAAsB,wBAAwB,CAAC;AAE5D,0GAA0G;AAC1G,eAAO,MAAM,qBAAqB,uBAAuB,CAAC;AAE1D,mGAAmG;AACnG,eAAO,MAAM,sBAAsB,wBAAwB,CAAC;AAE5D,0EAA0E;AAC1E,eAAO,MAAM,qBAAqB,uBAAuB,CAAC;AAE1D,wHAAwH;AACxH,eAAO,MAAM,oBAAoB,sBAAsB,CAAC;AAExD,wEAAwE;AACxE,eAAO,MAAM,eAAe,iBAAiB,CAAC;AAE9C,qFAAqF;AACrF,eAAO,MAAM,sBAAsB,wBAAwB,CAAC;AAE5D,2FAA2F;AAC3F,eAAO,MAAM,gBAAgB,kBAAkB,CAAC;AAEhD,sFAAsF;AACtF,eAAO,MAAM,gBAAgB,kBAAkB,CAAC;AAEhD,4FAA4F;AAC5F,eAAO,MAAM,sBAAsB,wBAAwB,CAAC;AAE5D,2EAA2E;AAC3E,eAAO,MAAM,cAAc,gBAAgB,CAAC;AAE5C;;;GAGG;AACH,eAAO,MAAM,YAAY,cAAc,CAAC;AAExC;;;;GAIG;AACH,eAAO,MAAM,uBAAuB,yBAAyB,CAAC;AAE9D,gIAAgI;AAChI,eAAO,MAAM,wBAAwB,0BAA0B,CAAC;AAEhE,+EAA+E;AAC/E,eAAO,MAAM,iBAAiB,mBAAmB,CAAC;AAElD,qFAAqF;AACrF,eAAO,MAAM,qBAAqB,uBAAuB,CAAC;AAE1D;;;GAGG;AACH,eAAO,MAAM,wBAAwB,0BAA0B,CAAC;AAEhE,0GAA0G;AAC1G,eAAO,MAAM,qBAAqB,uBAAuB,CAAC;AAE1D,kIAAkI;AAClI,eAAO,MAAM,iBAAiB,mBAAmB,CAAC;AAElD,6DAA6D;AAC7D,eAAO,MAAM,mBAAmB,qBAAqB,CAAC;AAEtD,yGAAyG;AACzG,eAAO,MAAM,kBAAkB,oBAAoB,CAAC;AAEpD,iFAAiF;AACjF,eAAO,MAAM,mBAAmB,qBAAqB,CAAC;AAEtD;;;GAGG;AACH,eAAO,MAAM,cAAc,gBAAgB,CAAC;AAE5C,iGAAiG;AACjG,eAAO,MAAM,oBAAoB,sBAAsB,CAAC;AAExD,mGAAmG;AACnG,eAAO,MAAM,yBAAyB,2BAA2B,CAAC;AAIlE,mGAAmG;AACnG,eAAO,MAAM,iBAAiB,mBAAmB,CAAC;AAElD,gFAAgF;AAChF,eAAO,MAAM,oBAAoB,sBAAsB,CAAC;AAExD,6EAA6E;AAC7E,eAAO,MAAM,qBAAqB,uBAAuB,CAAC;AAE1D,8EAA8E;AAC9E,eAAO,MAAM,oBAAoB,sBAAsB,CAAC;AAExD,yGAAyG;AACzG,eAAO,MAAM,yBAAyB,2BAA2B,CAAC;AAElE,6FAA6F;AAC7F,eAAO,MAAM,iBAAiB,mBAAmB,CAAC;AAElD,yEAAyE;AACzE,eAAO,MAAM,sBAAsB,wBAAwB,CAAC;AAE5D,gFAAgF;AAChF,eAAO,MAAM,0BAA0B,4BAA4B,CAAC;AAEpE,oFAAoF;AACpF,eAAO,MAAM,qBAAqB,uBAAuB,CAAC;AAE1D,yEAAyE;AACzE,eAAO,MAAM,iBAAiB,mBAAmB,CAAC;AAElD,+FAA+F;AAC/F,eAAO,MAAM,wBAAwB,0BAA0B,CAAC;AAEhE,kGAAkG;AAClG,eAAO,MAAM,yBAAyB,2BAA2B,CAAC;AAElE,2GAA2G;AAC3G,eAAO,MAAM,kBAAkB,4BAA4B,CAAC;AAE5D,mGAAmG;AACnG,eAAO,MAAM,iBAAiB,0BAA0B,CAAC;AAEzD,8GAA8G;AAC9G,eAAO,MAAM,kBAAkB,oBAAoB,CAAC;AAEpD,wFAAwF;AACxF,eAAO,MAAM,qBAAqB,uBAAuB,CAAC;AAE1D,yFAAyF;AACzF,eAAO,MAAM,mBAAmB,qBAAqB,CAAC"}
+{"version":3,"file":"codes.d.ts","sourceRoot":"","sources":["../../../src/common/codes.ts"],"names":[],"mappings":"AAAA;;;;;;;;;GASG;AAMH;;;GAGG;AACH,eAAO,MAAM,UAAU,YAAY,CAAC;AAEpC;;;GAGG;AACH,eAAO,MAAM,eAAe,iBAAiB,CAAC;AAE9C;;;GAGG;AACH,eAAO,MAAM,qBAAqB,uBAAuB,CAAC;AAE1D;;;GAGG;AACH,eAAO,MAAM,mBAAmB,qBAAqB,CAAC;AAEtD;;;GAGG;AACH,eAAO,MAAM,aAAa,eAAe,CAAC;AAE1C;;;;GAIG;AACH,eAAO,MAAM,oBAAoB,sBAAsB,CAAC;AAExD;;;GAGG;AACH,eAAO,MAAM,gBAAgB,kBAAkB,CAAC;AAEhD;;;GAGG;AACH,eAAO,MAAM,WAAW,aAAa,CAAC;AAEtC;;;GAGG;AACH,eAAO,MAAM,eAAe,iBAAiB,CAAC;AAE9C;;;GAGG;AACH,eAAO,MAAM,oBAAoB,sBAAsB,CAAC;AAExD;;;GAGG;AACH,eAAO,MAAM,eAAe,iBAAiB,CAAC;AAE9C;;;GAGG;AACH,eAAO,MAAM,mBAAmB,qBAAqB,CAAC;AAEtD;;;GAGG;AACH,eAAO,MAAM,cAAc,gBAAgB,CAAC;AAE5C;;;GAGG;AACH,eAAO,MAAM,kBAAkB,oBAAoB,CAAC;AAEpD;;;;GAIG;AACH,eAAO,MAAM,mBAAmB,qBAAqB,CAAC;AAEtD;;;GAGG;AACH,eAAO,MAAM,mBAAmB,qBAAqB,CAAC;AAEtD;;;;GAIG;AACH,eAAO,MAAM,eAAe,iBAAiB,CAAC;AAE9C;;;GAGG;AACH,eAAO,MAAM,cAAc,gBAAgB,CAAC;AAE5C;;;;GAIG;AACH,eAAO,MAAM,cAAc,gBAAgB,CAAC;AAE5C;;;;GAIG;AACH,eAAO,MAAM,gBAAgB,kBAAkB,CAAC;AAEhD;;;GAGG;AACH,eAAO,MAAM,mBAAmB,qBAAqB,CAAC;AAEtD;;;GAGG;AACH,eAAO,MAAM,iBAAiB,mBAAmB,CAAC;AAElD;;;;GAIG;AACH,eAAO,MAAM,qBAAqB,uBAAuB,CAAC;AAE1D;;;GAGG;AACH,eAAO,MAAM,sBAAsB,wBAAwB,CAAC;AAE5D;;;GAGG;AACH,eAAO,MAAM,qBAAqB,uBAAuB,CAAC;AAE1D;;;;;GAKG;AACH,eAAO,MAAM,sBAAsB,wBAAwB,CAAC;AAE5D;;;;GAIG;AACH,eAAO,MAAM,sBAAsB,wBAAwB,CAAC;AAE5D;;;;GAIG;AACH,eAAO,MAAM,mBAAmB,qBAAqB,CAAC;AAEtD;;;;GAIG;AACH,eAAO,MAAM,sBAAsB,wBAAwB,CAAC;AAE5D;;;GAGG;AACH,eAAO,MAAM,0BAA0B,4BAA4B,CAAC;AAEpE;;;;;GAKG;AACH,eAAO,MAAM,sBAAsB,wBAAwB,CAAC;AAE5D;;;;;GAKG;AACH,eAAO,MAAM,qBAAqB,uBAAuB,CAAC;AAE1D;;;;;GAKG;AACH,eAAO,MAAM,oBAAoB,sBAAsB,CAAC;AAExD;;;;GAIG;AACH,eAAO,MAAM,eAAe,iBAAiB,CAAC;AAE9C;;;GAGG;AACH,eAAO,MAAM,sBAAsB,wBAAwB,CAAC;AAE5D;;;GAGG;AACH,eAAO,MAAM,gBAAgB,kBAAkB,CAAC;AAEhD;;;GAGG;AACH,eAAO,MAAM,gBAAgB,kBAAkB,CAAC;AAEhD;;;GAGG;AACH,eAAO,MAAM,sBAAsB,wBAAwB,CAAC;AAE5D;;;GAGG;AACH,eAAO,MAAM,cAAc,gBAAgB,CAAC;AAE5C;;;;GAIG;AACH,eAAO,MAAM,YAAY,cAAc,CAAC;AAExC;;;;;GAKG;AACH,eAAO,MAAM,uBAAuB,yBAAyB,CAAC;AAE9D;;;GAGG;AACH,eAAO,MAAM,wBAAwB,0BAA0B,CAAC;AAEhE;;;GAGG;AACH,eAAO,MAAM,iBAAiB,mBAAmB,CAAC;AAElD;;;GAGG;AACH,eAAO,MAAM,qBAAqB,uBAAuB,CAAC;AAE1D;;;;GAIG;AACH,eAAO,MAAM,wBAAwB,0BAA0B,CAAC;AAEhE;;;;GAIG;AACH,eAAO,MAAM,qBAAqB,uBAAuB,CAAC;AAE1D;;;GAGG;AACH,eAAO,MAAM,0BAA0B,4BAA4B,CAAC;AAEpE;;;GAGG;AACH,eAAO,MAAM,yBAAyB,2BAA2B,CAAC;AAElE;;;;GAIG;AACH,eAAO,MAAM,4BAA4B,8BAA8B,CAAC;AAExE;;;GAGG;AACH,eAAO,MAAM,iBAAiB,mBAAmB,CAAC;AAElD;;;GAGG;AACH,eAAO,MAAM,mBAAmB,qBAAqB,CAAC;AAEtD;;;;GAIG;AACH,eAAO,MAAM,kBAAkB,oBAAoB,CAAC;AAEpD;;;GAGG;AACH,eAAO,MAAM,mBAAmB,qBAAqB,CAAC;AAEtD;;;;GAIG;AACH,eAAO,MAAM,cAAc,gBAAgB,CAAC;AAE5C;;;;;;GAMG;AACH,eAAO,MAAM,gBAAgB,kBAAkB,CAAC;AAEhD;;;;GAIG;AACH,eAAO,MAAM,oBAAoB,sBAAsB,CAAC;AAExD;;;GAGG;AACH,eAAO,MAAM,yBAAyB,2BAA2B,CAAC;AAElE;;;GAGG;AACH,eAAO,MAAM,mBAAmB,qBAAoD,CAAC;AAErF;;;GAGG;AACH,eAAO,MAAM,cAAc,gBAA+C,CAAC;AAE3E;;;;GAIG;AACH,eAAO,MAAM,iBAAiB,mBAAmB,CAAC;AAElD;;;;GAIG;AACH,eAAO,MAAM,uBAAuB,yBAAyB,CAAC;AAE9D;;;;;GAKG;AACH,eAAO,MAAM,mBAAmB,qBAAqB,CAAC;AAEtD;;;;GAIG;AACH,eAAO,MAAM,aAAa,eAAe,CAAC;AAE1C;;;;;GAKG;AACH,eAAO,MAAM,qBAAqB,uBAAuB,CAAC;AAI1D;;;GAGG;AACH,eAAO,MAAM,iBAAiB,mBAAmB,CAAC;AAElD;;;GAGG;AACH,eAAO,MAAM,oBAAoB,sBAAsB,CAAC;AAExD;;;GAGG;AACH,eAAO,MAAM,qBAAqB,uBAAuB,CAAC;AAE1D;;;GAGG;AACH,eAAO,MAAM,oBAAoB,sBAAsB,CAAC;AAExD;;;GAGG;AACH,eAAO,MAAM,yBAAyB,2BAA2B,CAAC;AAElE;;;GAGG;AACH,eAAO,MAAM,iBAAiB,mBAAmB,CAAC;AAElD;;;GAGG;AACH,eAAO,MAAM,sBAAsB,wBAAwB,CAAC;AAE5D;;;GAGG;AACH,eAAO,MAAM,0BAA0B,4BAA4B,CAAC;AAEpE;;;GAGG;AACH,eAAO,MAAM,oBAAoB,sBAAsB,CAAC;AAExD;;;;GAIG;AACH,eAAO,MAAM,qBAAqB,uBAAuB,CAAC;AAE1D;;;;GAIG;AACH,eAAO,MAAM,iBAAiB,mBAAmB,CAAC;AAElD;;;;GAIG;AACH,eAAO,MAAM,wBAAwB,0BAA0B,CAAC;AAEhE;;;GAGG;AACH,eAAO,MAAM,yBAAyB,2BAA2B,CAAC;AAElE;;;;GAIG;AACH,eAAO,MAAM,kBAAkB,4BAA4B,CAAC;AAE5D;;;;GAIG;AACH,eAAO,MAAM,iBAAiB,0BAA0B,CAAC;AAEzD;;;;GAIG;AACH,eAAO,MAAM,kBAAkB,oBAAoB,CAAC;AAEpD;;;GAGG;AACH,eAAO,MAAM,qBAAqB,uBAAuB,CAAC;AAE1D;;;GAGG;AACH,eAAO,MAAM,6BAA6B,+BAA+B,CAAC;AAE1E;;;GAGG;AACH,eAAO,MAAM,qBAAqB,uBAAuB,CAAC;AAE1D;;;GAGG;AACH,eAAO,MAAM,kBAAkB,oBAAoB,CAAC;AAEpD;;;;GAIG;AACH,eAAO,MAAM,6BAA6B,+BAA+B,CAAC;AAE1E;;;;GAIG;AACH,eAAO,MAAM,sBAAsB,wBAAwB,CAAC;AAE5D;;;GAGG;AACH,eAAO,MAAM,sBAAsB,wBAAwB,CAAC;AAE5D;;;GAGG;AACH,eAAO,MAAM,eAAe,iBAAiB,CAAC;AAE9C;;;;GAIG;AACH,eAAO,MAAM,mBAAmB,qBAAqB,CAAC;AAItD;;;;;GAKG;AACH,eAAO,MAAM,aAAa;IACtB,oHAAoH;;IAEpH,2GAA2G;;IAE3G;;;OAGG;;IAEH,wGAAwG;;IAExG,wFAAwF;;IAExF,6DAA6D;;EAE/D,CAAC;AAIH;;;;GAIG;AACH,eAAO,MAAM,WAAW;IACpB,qEAAqE;;IAErE,qGAAqG;;IAErG,iFAAiF;;IAEjF,wFAAwF;;IAExF,+FAA+F;;IAE/F,qFAAqF;;EAEvF,CAAC"}