@graphty/graph-io 0.0.0 → 0.2.1

package/dist/src/common/attributes.js

@@ -0,0 +1,368 @@
+/**
+ * Attribute declaration shared by the typed importers (design sections 5.1, 5.5 and 5.6): turn a
+ * GEXF `<attribute>`, a GraphML `<key>` or a Neo4j header column into a ColumnDecl with the right
+ * dtype, default, options and origin metadata; parse values (scalars and lists) by the declaration;
+ * derive the deterministic `<name>#<origin.id>` name when a declared name collides; and the dict
+ * heuristic of design section 5.4.
+ *
+ * Naming rule (design section 5.6): a column's name is the GEXF `title` / GraphML `attr.name`,
+ * falling back to the attribute `id` when the title is absent; `origin.id` always keeps the source
+ * id and `origin.title` the title when it differs from the resolved name.
+ */
+import { GraphFormatError, INVALID_INDEX, } from "@graphty/graph-format";
+import { BAD_DEFAULT_CODE, BAD_OPTIONS_CODE, COLUMN_RENAMED_CODE, PRECISION_CODE, ROLE_TAKEN_CODE, UNKNOWN_ATTR_TYPE_CODE, } from "./codes.js";
+import { mapDeclaredType, parseScalarText, stringSpec, } from "./declared-types.js";
+import { splitListText } from "./lists.js";
+import { parseTemporal, timeTextCompanion } from "./temporal.js";
+/** Issue code: the declared type is not one the format defines; the column is kept as string. */
+export const UNKNOWN_TYPE_CODE = UNKNOWN_ATTR_TYPE_CODE;
+/** Issue code: the column was renamed `<name>#<id>` because the name was taken (design section 5.6). */
+export const RENAMED_CODE = COLUMN_RENAMED_CODE;
+export { BAD_DEFAULT_CODE, BAD_OPTIONS_CODE, PRECISION_CODE, ROLE_TAKEN_CODE };
+/** Rows sampled before the dict heuristic decides (design section 5.4). */
+export const DICT_SAMPLE_ROWS = 1024;
+/**
+ * Build the column declaration of a declared attribute.
+ * @param input - what the file declares
+ * @returns the declaration, the value spec and any warnings to record
+ */
+export function declareAttribute(input) {
+    const issues = [];
+    const listSyntax = input.listSyntax ?? "gexf";
+    let spec;
+    if (input.type === null) {
+        spec = stringSpec(null);
+    }
+    else {
+        const mapped = mapDeclaredType(input.format, input.type, input.long);
+        if (mapped === null) {
+            spec = stringSpec(input.type);
+            issues.push({
+                category: "unsupported",
+                code: UNKNOWN_TYPE_CODE,
+                message: `${input.format} type "${input.type}" is not supported; values kept as text`,
+            });
+        }
+        else {
+            spec = mapped;
+        }
+    }
+    const { name, renamed } = resolveName(input);
+    if (renamed) {
+        issues.push({
+            category: "coercion",
+            code: RENAMED_CODE,
+            message: `attribute "${input.title ?? input.id ?? ""}" renamed to "${name}": the name was taken`,
+        });
+    }
+    const decl = {
+        name,
+        dtype: spec.dtype,
+        nullable: true,
+        origin: {
+            format: input.format,
+            id: input.id,
+            title: input.title !== null && input.title !== name ? input.title : null,
+            type: input.type,
+            namespace: input.namespace ?? null,
+        },
+    };
+    if (spec.list) {
+        decl.itemDtype = spec.itemDtype ?? "string";
+    }
+    if (input.role !== undefined && input.role !== null) {
+        decl.role = input.role;
+    }
+    if (input.dynamic === true) {
+        decl.dynamic = true;
+    }
+    const optionsText = input.optionsText ?? null;
+    if (optionsText !== null) {
+        try {
+            const options = splitListText(optionsText, listSyntax).map((item) => parseItem(item, spec));
+            decl.options = options;
+            if (spec.dtype === "string" && !spec.list && options.every((o) => typeof o === "string")) {
+                decl.dtype = "dict";
+                spec = { ...spec, dtype: "dict" };
+            }
+        }
+        catch (err) {
+            issues.push({
+                category: "validation-error",
+                code: BAD_OPTIONS_CODE,
+                message: `options "${optionsText}" of attribute "${name}" do not parse as ${spec.declared}: ${messageOf(err)}`,
+            });
+        }
+    }
+    const defaultText = input.defaultText ?? null;
+    if (defaultText !== null) {
+        try {
+            decl.default = parseDeclaredValue(defaultText, spec, listSyntax);
+        }
+        catch (err) {
+            issues.push({
+                category: "validation-error",
+                code: BAD_DEFAULT_CODE,
+                message: `default "${defaultText}" of attribute "${name}" does not parse as ${spec.declared}: ${messageOf(err)}`,
+            });
+        }
+    }
+    const companion = spec.temporal !== null && !spec.list ? timeTextCompanion(name) : null;
+    return { decl, spec, listSyntax, companion, renamed, issues };
+}
+/**
+ * Parse a value text by a declaration: a scalar, or a list split by the syntax with each item
+ * parsed by the item kind.
+ * @param text - the value text
+ * @param spec - the declared type
+ * @param listSyntax - the list syntax
+ * @returns the value to push (a boolean, a number, a string, a JSON value or an array)
+ */
+export function parseDeclaredValue(text, spec, listSyntax) {
+    if (spec.list) {
+        return splitListText(text, listSyntax).map((item) => parseItem(item, spec));
+    }
+    return parseItem(text, spec);
+}
+/**
+ * Parse a temporal value text by a declaration, keeping the source text when its canonical form
+ * differs (for the companion column).
+ * @param text - the value text
+ * @param spec - a scalar temporal spec
+ * @returns the value and the text to keep, or null text
+ */
+export function parseDeclaredTemporal(text, spec) {
+    if (spec.temporal === null || spec.list) {
+        throw new GraphFormatError("E_COLUMN_TYPE", `"${spec.declared}" is not a scalar temporal type`, {
+            declared: spec.declared,
+        });
+    }
+    return parseTemporal(text.trim(), spec.temporal);
+}
+const INTEGER_TEXT = /^[+-]?[0-9]+$/;
+/**
+ * Whether a long value's text lost precision when parsed to f64 (design section 5.1: a value with
+ * |v| > 2^53 is stored as the nearest f64 and recorded as a `precision` issue). Decided from the
+ * text, since the parsed number alone cannot tell 2^53 from 2^53 + 1.
+ * @param spec - the declared type
+ * @param text - the value text (trimmed or not)
+ * @returns true when the importer should record a `precision` issue
+ */
+export function losesPrecision(spec, text) {
+    if (!spec.precision) {
+        return false;
+    }
+    const trimmed = text.trim();
+    if (!INTEGER_TEXT.test(trimmed)) {
+        return false;
+    }
+    const n = Number(trimmed);
+    return !Number.isFinite(n) || BigInt(trimmed) !== BigInt(n);
+}
+/**
+ * Declare a column on the sink for one domain.
+ * @param sink - the sink
+ * @param domain - node or edge
+ * @param decl - the declaration
+ * @returns the column handle
+ */
+export function declareOn(sink, domain, decl) {
+    return domain === "node" ? sink.declareNodeColumn(decl) : sink.declareEdgeColumn(decl);
+}
+/**
+ * The io rule of design section 5.6 in one place, so every importer agrees: declare a column on
+ * the sink and, when the sink already holds the name with another shape (an earlier import, a
+ * caller's column), rename it `<name>#<origin.id>` (a counter when the source has no id) and
+ * record W_COLUMN_RENAMED (coercion); when the table already holds the role (design section 5.5:
+ * at most one column per role), declare without the role and record W_ROLE_TAKEN (coercion). The
+ * same shape under the same name returns the existing handle, as the sink does.
+ * @param sink - the sink
+ * @param domain - node or edge
+ * @param decl - the wanted declaration
+ * @param report - the report the coercion issues are recorded in
+ * @param where - the line and element, when known
+ * @returns the handle and the declaration as applied
+ */
+export function declareResolved(sink, domain, decl, report, where) {
+    let current = decl;
+    let renamed = false;
+    let roleDropped = false;
+    for (;;) {
+        try {
+            return { handle: declareOn(sink, domain, current), decl: current, renamed, roleDropped };
+        }
+        catch (err) {
+            if (!(err instanceof GraphFormatError)) {
+                throw err;
+            }
+            if (err.code === "E_COLUMN_EXISTS" && !renamed) {
+                const taken = takenIn(sink, domain);
+                const id = current.origin?.id ?? null;
+                const name = uniqueColumnName(current.name, id, taken);
+                report.warning("coercion", COLUMN_RENAMED_CODE, `${domain} column "${current.name}" renamed to "${name}": the sink already holds that name with another shape`, { ...where, element: where?.element ?? current.name });
+                current = { ...current, name };
+                renamed = true;
+                continue;
+            }
+            if (err.code === "E_DUPLICATE_ROLE" && current.role !== undefined && !roleDropped) {
+                const holder = typeof err.details.holder === "string" ? err.details.holder : "another column";
+                report.warning("coercion", ROLE_TAKEN_CODE, `${domain} column "${current.name}" loses the ${current.role} role: "${holder}" already holds it`, { ...where, element: where?.element ?? current.name });
+                const { role: _role, ...withoutRole } = current;
+                current = withoutRole;
+                roleDropped = true;
+                continue;
+            }
+            throw err;
+        }
+    }
+}
+/**
+ * Declare the companion text column of a temporal column (design section 5.1). A table holds at
+ * most one column per role, so when another companion already carries `timeText` this one is
+ * declared without the role (reported once per table); exporters find every companion through
+ * `extra.for`.
+ * @param sink - the sink
+ * @param domain - node or edge
+ * @param companion - the declaration from declareAttribute()
+ * @param report - the report the role loss is recorded in; when omitted the loss is silent
+ * @returns the column handle
+ */
+export function declareCompanion(sink, domain, companion, report) {
+    try {
+        return declareOn(sink, domain, companion);
+    }
+    catch (err) {
+        if (err instanceof GraphFormatError && err.code === "E_DUPLICATE_ROLE") {
+            report?.warnOnce("coercion", ROLE_TAKEN_CODE, `${domain} column "${companion.name}" is declared without the timeText role: another companion holds it (exporters use extra.for)`, { element: companion.name });
+            const { role: _role, ...withoutRole } = companion;
+            return declareOn(sink, domain, withoutRole);
+        }
+        throw err;
+    }
+}
+/**
+ * Whether a column name is taken in a sink's table, the usual `taken` callback.
+ * @param sink - the sink
+ * @param domain - node or edge
+ * @returns a predicate over column names
+ */
+export function takenIn(sink, domain) {
+    return (name) => (domain === "node" ? sink.nodeColumn(name) : sink.edgeColumn(name)) !== INVALID_INDEX;
+}
+/**
+ * The deterministic name of a declared attribute whose preferred name is taken (design section
+ * 5.6): `<name>#<origin.id>`, and `<name>#<origin.id>#2`, `#3`... should that be taken as well.
+ * @param name - the preferred name
+ * @param id - the source id (the attribute id or key id); null falls back to a counter
+ * @param taken - whether a name is already used in the table
+ * @returns a free name
+ */
+export function uniqueColumnName(name, id, taken) {
+    if (!taken(name)) {
+        return name;
+    }
+    const base = id === null ? name : `${name}#${id}`;
+    if (id !== null && !taken(base)) {
+        return base;
+    }
+    for (let n = 2;; n++) {
+        const candidate = `${base}#${n}`;
+        if (!taken(candidate)) {
+            return candidate;
+        }
+    }
+}
+/**
+ * The dict heuristic of design section 5.4 for an untyped string column: observe values until the
+ * sample is full; the column is a dict when the distinct count stays below half the rows, a string
+ * otherwise. The importer buffers the sampled values and declares the column on the decision.
+ */
+export class DictHeuristic {
+    /**
+     * Create a heuristic.
+     * @param sampleRows - rows observed before deciding; DICT_SAMPLE_ROWS by default
+     */
+    constructor(sampleRows = DICT_SAMPLE_ROWS) {
+        this.distinct = new Set();
+        this.rowsSeen = 0;
+        this.sampleRows = sampleRows;
+    }
+    /**
+     * Rows observed so far.
+     * @returns the count
+     */
+    get rows() {
+        return this.rowsSeen;
+    }
+    /**
+     * Distinct values observed so far.
+     * @returns the count
+     */
+    get distinctCount() {
+        return this.distinct.size;
+    }
+    /**
+     * Whether the sample is full.
+     * @returns true once sampleRows values were observed
+     */
+    get decided() {
+        return this.rowsSeen >= this.sampleRows;
+    }
+    /**
+     * Observe one value.
+     * @param value - the value text
+     * @returns true when this observation completed the sample
+     */
+    observe(value) {
+        this.rowsSeen++;
+        if (this.distinct.size < this.rowsSeen) {
+            this.distinct.add(value);
+        }
+        return this.rowsSeen === this.sampleRows;
+    }
+    /**
+     * The dtype the sample suggests: dict when the distinct count is below rows / 2 (and at least
+     * one row was seen), string otherwise. Valid before the sample is full (end of input).
+     * @returns "dict" or "string"
+     */
+    decide() {
+        return this.rowsSeen > 0 && this.distinct.size * 2 < this.rowsSeen ? "dict" : "string";
+    }
+}
+/**
+ * The resolved name of a declaration and whether it was renamed.
+ * @param input - the declaration input
+ * @returns the name and the rename flag; E_COLUMN_TYPE when neither a title nor an id exists
+ */
+function resolveName(input) {
+    const preferred = input.title !== null && input.title.length > 0 ? input.title : input.id;
+    if (preferred === null || preferred.length === 0) {
+        throw new GraphFormatError("E_COLUMN_TYPE", "an attribute declaration needs a title or an id", {
+            field: "name",
+            format: input.format,
+        });
+    }
+    if (input.taken === undefined) {
+        return { name: preferred, renamed: false };
+    }
+    const name = uniqueColumnName(preferred, input.id, input.taken);
+    return { name, renamed: name !== preferred };
+}
+/**
+ * Parse one scalar value or list item by a spec.
+ * @param text - the item text
+ * @param spec - the declared type
+ * @returns the parsed value
+ */
+function parseItem(text, spec) {
+    return parseScalarText(text, spec.kind, spec.temporal);
+}
+/**
+ * The message of a caught value.
+ * @param err - the thrown value
+ * @returns the message
+ */
+function messageOf(err) {
+    return err instanceof Error ? err.message : String(err);
+}
+//# sourceMappingURL=attributes.js.map

package/dist/src/common/attributes.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"attributes.js","sourceRoot":"","sources":["../../../src/common/attributes.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;GAUG;AAEH,OAAO,EAIH,gBAAgB,EAEhB,aAAa,GAChB,MAAM,uBAAuB,CAAC;AAG/B,OAAO,EACH,gBAAgB,EAChB,gBAAgB,EAChB,mBAAmB,EACnB,cAAc,EACd,eAAe,EACf,sBAAsB,GACzB,MAAM,YAAY,CAAC;AACpB,OAAO,EAGH,eAAe,EACf,eAAe,EACf,UAAU,GACb,MAAM,qBAAqB,CAAC;AAC7B,OAAO,EAAmB,aAAa,EAAE,MAAM,YAAY,CAAC;AAE5D,OAAO,EAAE,aAAa,EAAsB,iBAAiB,EAAE,MAAM,eAAe,CAAC;AAoErF,iGAAiG;AACjG,MAAM,CAAC,MAAM,iBAAiB,GAAG,sBAAsB,CAAC;AACxD,wGAAwG;AACxG,MAAM,CAAC,MAAM,YAAY,GAAG,mBAAmB,CAAC;AAEhD,OAAO,EAAE,gBAAgB,EAAE,gBAAgB,EAAE,cAAc,EAAE,eAAe,EAAE,CAAC;AAE/E,2EAA2E;AAC3E,MAAM,CAAC,MAAM,gBAAgB,GAAG,IAAI,CAAC;AAErC;;;;GAIG;AACH,MAAM,UAAU,gBAAgB,CAAC,KAAgC;IAC7D,MAAM,MAAM,GAAuB,EAAE,CAAC;IACtC,MAAM,UAAU,GAAG,KAAK,CAAC,UAAU,IAAI,MAAM,CAAC;IAC9C,IAAI,IAAsB,CAAC;IAC3B,IAAI,KAAK,CAAC,IAAI,KAAK,IAAI,EAAE,CAAC;QACtB,IAAI,GAAG,UAAU,CAAC,IAAI,CAAC,CAAC;IAC5B,CAAC;SAAM,CAAC;QACJ,MAAM,MAAM,GAAG,eAAe,CAAC,KAAK,CAAC,MAAM,EAAE,KAAK,CAAC,IAAI,EAAE,KAAK,CAAC,IAAI,CAAC,CAAC;QACrE,IAAI,MAAM,KAAK,IAAI,EAAE,CAAC;YAClB,IAAI,GAAG,UAAU,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC;YAC9B,MAAM,CAAC,IAAI,CAAC;gBACR,QAAQ,EAAE,aAAa;gBACvB,IAAI,EAAE,iBAAiB;gBACvB,OAAO,EAAE,GAAG,KAAK,CAAC,MAAM,UAAU,KAAK,CAAC,IAAI,yCAAyC;aACxF,CAAC,CAAC;QACP,CAAC;aAAM,CAAC;YACJ,IAAI,GAAG,MAAM,CAAC;QAClB,CAAC;IACL,CAAC;IACD,MAAM,EAAE,IAAI,EAAE,OAAO,EAAE,GAAG,WAAW,CAAC,KAAK,CAAC,CAAC;IAC7C,IAAI,OAAO,EAAE,CAAC;QACV,MAAM,CAAC,IAAI,CAAC;YACR,QAAQ,EAAE,UAAU;YACpB,IAAI,EAAE,YAAY;YAClB,OAAO,EAAE,cAAc,KAAK,CAAC,KAAK,IAAI,KAAK,CAAC,EAAE,IAAI,EAAE,iBAAiB,IAAI,uBAAuB;SACnG,CAAC,CAAC;IACP,CAAC;IACD,MAAM,IAAI,GAAe;QACrB,IAAI;QACJ,KAAK,EAAE,IAAI,CAAC,KAAK;QACjB,QAAQ,EAAE,IAAI;QACd,MAAM,EAAE;YACJ,MAAM,EAAE,KAAK,CAAC,MAAM;YACpB,EAAE,EAAE,KAAK,CAAC,EAAE;YACZ,KAAK,EAAE,KAAK,CAAC,KAAK,KAAK,IAAI,IAAI,KAAK,CAAC,KAAK,KAAK,IAAI,CAAC,CAAC,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC,CAAC,IAAI;YACxE,IAAI,EAAE,KAAK,CAAC,IAAI;YAChB,SAAS,EAAE,KAAK,CAAC,SAAS,IAAI,IAAI;SACrC;KACJ,CAAC;IACF,IAAI,IAAI,CAAC,IAAI,EAAE,CAAC;QACZ,IAAI,CAAC,SAAS,GAAG,IAAI,CAAC,SAAS,IAAI,QAAQ,CAAC;IAChD,CAAC;IACD,IAAI,KAAK,CAAC,IAAI,KAAK,SAAS,IAAI,KAAK,CAAC,IAAI,KAAK,IAAI,EAAE,CAAC;QAClD,IAAI,CAAC,IAAI,GAAG,KAAK,CAAC,IAAI,CAAC;IAC3B,CAAC;IACD,IAAI,KAAK,CAAC,OAAO,KAAK,IAAI,EAAE,CAAC;QACzB,IAAI,CAAC,OAAO,GAAG,IAAI,CAAC;IACxB,CAAC;IACD,MAAM,WAAW,GAAG,KAAK,CAAC,WAAW,IAAI,IAAI,CAAC;IAC9C,IAAI,WAAW,KAAK,IAAI,EAAE,CAAC;QACvB,IAAI,CAAC;YACD,MAAM,OAAO,GAAG,aAAa,CAAC,WAAW,EAAE,UAAU,CAAC,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,SAAS,CAAC,IAAI,EAAE,IAAI,CAAC,CAAC,CAAC;YAC5F,IAAI,CAAC,OAAO,GAAG,OAAO,CAAC;YACvB,IAAI,IAAI,CAAC,KAAK,KAAK,QAAQ,IAAI,CAAC,IAAI,CAAC,IAAI,IAAI,OAAO,CAAC,KAAK,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,OAAO,CAAC,KAAK,QAAQ,CAAC,EAAE,CAAC;gBACvF,IAAI,CAAC,KAAK,GAAG,MAAM,CAAC;gBACpB,IAAI,GAAG,EAAE,GAAG,IAAI,EAAE,KAAK,EAAE,MAAM,EAAE,CAAC;YACtC,CAAC;QACL,CAAC;QAAC,OAAO,GAAG,EAAE,CAAC;YACX,MAAM,CAAC,IAAI,CAAC;gBACR,QAAQ,EAAE,kBAAkB;gBAC5B,IAAI,EAAE,gBAAgB;gBACtB,OAAO,EAAE,YAAY,WAAW,mBAAmB,IAAI,qBAAqB,IAAI,CAAC,QAAQ,KAAK,SAAS,CAAC,GAAG,CAAC,EAAE;aACjH,CAAC,CAAC;QACP,CAAC;IACL,CAAC;IACD,MAAM,WAAW,GAAG,KAAK,CAAC,WAAW,IAAI,IAAI,CAAC;IAC9C,IAAI,WAAW,KAAK,IAAI,EAAE,CAAC;QACvB,IAAI,CAAC;YACD,IAAI,CAAC,OAAO,GAAG,kBAAkB,CAAC,WAAW,EAAE,IAAI,EAAE,UAAU,CAAC,CAAC;QACrE,CAAC;QAAC,OAAO,GAAG,EAAE,CAAC;YACX,MAAM,CAAC,IAAI,CAAC;gBACR,QAAQ,EAAE,kBAAkB;gBAC5B,IAAI,EAAE,gBAAgB;gBACtB,OAAO,EAAE,YAAY,WAAW,mBAAmB,IAAI,uBAAuB,IAAI,CAAC,QAAQ,KAAK,SAAS,CAAC,GAAG,CAAC,EAAE;aACnH,CAAC,CAAC;QACP,CAAC;IACL,CAAC;IACD,MAAM,SAAS,GAAG,IAAI,CAAC,QAAQ,KAAK,IAAI,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC,iBAAiB,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC;IACxF,OAAO,EAAE,IAAI,EAAE,IAAI,EAAE,UAAU,EAAE,SAAS,EAAE,OAAO,EAAE,MAAM,EAAE,CAAC;AAClE,CAAC;AAED;;;;;;;GAOG;AACH,MAAM,UAAU,kBAAkB,CAAC,IAAY,EAAE,IAAsB,EAAE,UAAsB;IAC3F,IAAI,IAAI,CAAC,IAAI,EAAE,CAAC;QACZ,OAAO,aAAa,CAAC,IAAI,EAAE,UAAU,CAAC,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,SAAS,CAAC,IAAI,EAAE,IAAI,CAAC,CAAC,CAAC;IAChF,CAAC;IACD,OAAO,SAAS,CAAC,IAAI,EAAE,IAAI,CAAC,CAAC;AACjC,CAAC;AAED;;;;;;GAMG;AACH,MAAM,UAAU,qBAAqB,CAAC,IAAY,EAAE,IAAsB;IACtE,IAAI,IAAI,CAAC,QAAQ,KAAK,IAAI,IAAI,IAAI,CAAC,IAAI,EAAE,CAAC;QACtC,MAAM,IAAI,gBAAgB,CAAC,eAAe,EAAE,IAAI,IAAI,CAAC,QAAQ,iCAAiC,EAAE;YAC5F,QAAQ,EAAE,IAAI,CAAC,QAAQ;SAC1B,CAAC,CAAC;IACP,CAAC;IACD,OAAO,aAAa,CAAC,IAAI,CAAC,IAAI,EAAE,EAAE,IAAI,CAAC,QAAQ,CAAC,CAAC;AACrD,CAAC;AAED,MAAM,YAAY,GAAG,eAAe,CAAC;AAErC;;;;;;;GAOG;AACH,MAAM,UAAU,cAAc,CAAC,IAAsB,EAAE,IAAY;IAC/D,IAAI,CAAC,IAAI,CAAC,SAAS,EAAE,CAAC;QAClB,OAAO,KAAK,CAAC;IACjB,CAAC;IACD,MAAM,OAAO,GAAG,IAAI,CAAC,IAAI,EAAE,CAAC;IAC5B,IAAI,CAAC,YAAY,CAAC,IAAI,CAAC,OAAO,CAAC,EAAE,CAAC;QAC9B,OAAO,KAAK,CAAC;IACjB,CAAC;IACD,MAAM,CAAC,GAAG,MAAM,CAAC,OAAO,CAAC,CAAC;IAC1B,OAAO,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAC,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,KAAK,MAAM,CAAC,CAAC,CAAC,CAAC;AAChE,CAAC;AAED;;;;;;GAMG;AACH,MAAM,UAAU,SAAS,CAAC,IAAe,EAAE,MAAuB,EAAE,IAAgB;IAChF,OAAO,MAAM,KAAK,MAAM,CAAC,CAAC,CAAC,IAAI,CAAC,iBAAiB,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,iBAAiB,CAAC,IAAI,CAAC,CAAC;AAC3F,CAAC;AAkBD;;;;;;;;;;;;;GAaG;AACH,MAAM,UAAU,eAAe,CAC3B,IAAe,EACf,MAAuB,EACvB,IAAgB,EAChB,MAA2B,EAC3B,KAAqB;IAErB,IAAI,OAAO,GAAG,IAAI,CAAC;IACnB,IAAI,OAAO,GAAG,KAAK,CAAC;IACpB,IAAI,WAAW,GAAG,KAAK,CAAC;IACxB,SAAS,CAAC;QACN,IAAI,CAAC;YACD,OAAO,EAAE,MAAM,EAAE,SAAS,CAAC,IAAI,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,IAAI,EAAE,OAAO,EAAE,OAAO,EAAE,WAAW,EAAE,CAAC;QAC7F,CAAC;QAAC,OAAO,GAAG,EAAE,CAAC;YACX,IAAI,CAAC,CAAC,GAAG,YAAY,gBAAgB,CAAC,EAAE,CAAC;gBACrC,MAAM,GAAG,CAAC;YACd,CAAC;YACD,IAAI,GAAG,CAAC,IAAI,KAAK,iBAAiB,IAAI,CAAC,OAAO,EAAE,CAAC;gBAC7C,MAAM,KAAK,GAAG,OAAO,CAAC,IAAI,EAAE,MAAM,CAAC,CAAC;gBACpC,MAAM,EAAE,GAAG,OAAO,CAAC,MAAM,EAAE,EAAE,IAAI,IAAI,CAAC;gBACtC,MAAM,IAAI,GAAG,gBAAgB,CAAC,OAAO,CAAC,IAAI,EAAE,EAAE,EAAE,KAAK,CAAC,CAAC;gBACvD,MAAM,CAAC,OAAO,CACV,UAAU,EACV,mBAAmB,EACnB,GAAG,MAAM,YAAY,OAAO,CAAC,IAAI,iBAAiB,IAAI,wDAAwD,EAC9G,EAAE,GAAG,KAAK,EAAE,OAAO,EAAE,KAAK,EAAE,OAAO,IAAI,OAAO,CAAC,IAAI,EAAE,CACxD,CAAC;gBACF,OAAO,GAAG,EAAE,GAAG,OAAO,EAAE,IAAI,EAAE,CAAC;gBAC/B,OAAO,GAAG,IAAI,CAAC;gBACf,SAAS;YACb,CAAC;YACD,IAAI,GAAG,CAAC,IAAI,KAAK,kBAAkB,IAAI,OAAO,CAAC,IAAI,KAAK,SAAS,IAAI,CAAC,WAAW,EAAE,CAAC;gBAChF,MAAM,MAAM,GAAG,OAAO,GAAG,CAAC,OAAO,CAAC,MAAM,KAAK,QAAQ,CAAC,CAAC,CAAC,GAAG,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC,CAAC,gBAAgB,CAAC;gBAC9F,MAAM,CAAC,OAAO,CACV,UAAU,EACV,eAAe,EACf,GAAG,MAAM,YAAY,OAAO,CAAC,IAAI,eAAe,OAAO,CAAC,IAAI,WAAW,MAAM,oBAAoB,EACjG,EAAE,GAAG,KAAK,EAAE,OAAO,EAAE,KAAK,EAAE,OAAO,IAAI,OAAO,CAAC,IAAI,EAAE,CACxD,CAAC;gBACF,MAAM,EAAE,IAAI,EAAE,KAAK,EAAE,GAAG,WAAW,EAAE,GAAG,OAAO,CAAC;gBAChD,OAAO,GAAG,WAAW,CAAC;gBACtB,WAAW,GAAG,IAAI,CAAC;gBACnB,SAAS;YACb,CAAC;YACD,MAAM,GAAG,CAAC;QACd,CAAC;IACL,CAAC;AACL,CAAC;AAED;;;;;;;;;;GAUG;AACH,MAAM,UAAU,gBAAgB,CAC5B,IAAe,EACf,MAAuB,EACvB,SAAqB,EACrB,MAA4B;IAE5B,IAAI,CAAC;QACD,OAAO,SAAS,CAAC,IAAI,EAAE,MAAM,EAAE,SAAS,CAAC,CAAC;IAC9C,CAAC;IAAC,OAAO,GAAG,EAAE,CAAC;QACX,IAAI,GAAG,YAAY,gBAAgB,IAAI,GAAG,CAAC,IAAI,KAAK,kBAAkB,EAAE,CAAC;YACrE,MAAM,EAAE,QAAQ,CACZ,UAAU,EACV,eAAe,EACf,GAAG,MAAM,YAAY,SAAS,CAAC,IAAI,+FAA+F,EAClI,EAAE,OAAO,EAAE,SAAS,CAAC,IAAI,EAAE,CAC9B,CAAC;YACF,MAAM,EAAE,IAAI,EAAE,KAAK,EAAE,GAAG,WAAW,EAAE,GAAG,SAAS,CAAC;YAClD,OAAO,SAAS,CAAC,IAAI,EAAE,MAAM,EAAE,WAAW,CAAC,CAAC;QAChD,CAAC;QACD,MAAM,GAAG,CAAC;IACd,CAAC;AACL,CAAC;AAED;;;;;GAKG;AACH,MAAM,UAAU,OAAO,CAAC,IAAe,EAAE,MAAuB;IAC5D,OAAO,CAAC,IAAY,EAAW,EAAE,CAC7B,CAAC,MAAM,KAAK,MAAM,CAAC,CAAC,CAAC,IAAI,CAAC,UAAU,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,UAAU,CAAC,IAAI,CAAC,CAAC,KAAK,aAAa,CAAC;AAC9F,CAAC;AAED;;;;;;;GAOG;AACH,MAAM,UAAU,gBAAgB,CAAC,IAAY,EAAE,EAAiB,EAAE,KAAgC;IAC9F,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,EAAE,CAAC;QACf,OAAO,IAAI,CAAC;IAChB,CAAC;IACD,MAAM,IAAI,GAAG,EAAE,KAAK,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,GAAG,IAAI,IAAI,EAAE,EAAE,CAAC;IAClD,IAAI,EAAE,KAAK,IAAI,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,EAAE,CAAC;QAC9B,OAAO,IAAI,CAAC;IAChB,CAAC;IACD,KAAK,IAAI,CAAC,GAAG,CAAC,GAAI,CAAC,EAAE,EAAE,CAAC;QACpB,MAAM,SAAS,GAAG,GAAG,IAAI,IAAI,CAAC,EAAE,CAAC;QACjC,IAAI,CAAC,KAAK,CAAC,SAAS,CAAC,EAAE,CAAC;YACpB,OAAO,SAAS,CAAC;QACrB,CAAC;IACL,CAAC;AACL,CAAC;AAED;;;;GAIG;AACH,MAAM,OAAO,aAAa;IAOtB;;;OAGG;IACH,YAAY,aAAqB,gBAAgB;QAVhC,aAAQ,GAAG,IAAI,GAAG,EAAU,CAAC;QAEtC,aAAQ,GAAG,CAAC,CAAC;QASjB,IAAI,CAAC,UAAU,GAAG,UAAU,CAAC;IACjC,CAAC;IAED;;;OAGG;IACH,IAAI,IAAI;QACJ,OAAO,IAAI,CAAC,QAAQ,CAAC;IACzB,CAAC;IAED;;;OAGG;IACH,IAAI,aAAa;QACb,OAAO,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC;IAC9B,CAAC;IAED;;;OAGG;IACH,IAAI,OAAO;QACP,OAAO,IAAI,CAAC,QAAQ,IAAI,IAAI,CAAC,UAAU,CAAC;IAC5C,CAAC;IAED;;;;OAIG;IACH,OAAO,CAAC,KAAa;QACjB,IAAI,CAAC,QAAQ,EAAE,CAAC;QAChB,IAAI,IAAI,CAAC,QAAQ,CAAC,IAAI,GAAG,IAAI,CAAC,QAAQ,EAAE,CAAC;YACrC,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,KAAK,CAAC,CAAC;QAC7B,CAAC;QACD,OAAO,IAAI,CAAC,QAAQ,KAAK,IAAI,CAAC,UAAU,CAAC;IAC7C,CAAC;IAED;;;;OAIG;IACH,MAAM;QACF,OAAO,IAAI,CAAC,QAAQ,GAAG,CAAC,IAAI,IAAI,CAAC,QAAQ,CAAC,IAAI,GAAG,CAAC,GAAG,IAAI,CAAC,QAAQ,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,QAAQ,CAAC;IAC3F,CAAC;CACJ;AAED;;;;GAIG;AACH,SAAS,WAAW,CAAC,KAAgC;IACjD,MAAM,SAAS,GAAG,KAAK,CAAC,KAAK,KAAK,IAAI,IAAI,KAAK,CAAC,KAAK,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,EAAE,CAAC;IAC1F,IAAI,SAAS,KAAK,IAAI,IAAI,SAAS,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;QAC/C,MAAM,IAAI,gBAAgB,CAAC,eAAe,EAAE,iDAAiD,EAAE;YAC3F,KAAK,EAAE,MAAM;YACb,MAAM,EAAE,KAAK,CAAC,MAAM;SACvB,CAAC,CAAC;IACP,CAAC;IACD,IAAI,KAAK,CAAC,KAAK,KAAK,SAAS,EAAE,CAAC;QAC5B,OAAO,EAAE,IAAI,EAAE,SAAS,EAAE,OAAO,EAAE,KAAK,EAAE,CAAC;IAC/C,CAAC;IACD,MAAM,IAAI,GAAG,gBAAgB,CAAC,SAAS,EAAE,KAAK,CAAC,EAAE,EAAE,KAAK,CAAC,KAAK,CAAC,CAAC;IAChE,OAAO,EAAE,IAAI,EAAE,OAAO,EAAE,IAAI,KAAK,SAAS,EAAE,CAAC;AACjD,CAAC;AAED;;;;;GAKG;AACH,SAAS,SAAS,CAAC,IAAY,EAAE,IAAsB;IACnD,OAAO,eAAe,CAAC,IAAI,EAAE,IAAI,CAAC,IAAI,EAAE,IAAI,CAAC,QAAQ,CAAC,CAAC;AAC3D,CAAC;AAED;;;;GAIG;AACH,SAAS,SAAS,CAAC,GAAY;IAC3B,OAAO,GAAG,YAAY,KAAK,CAAC,CAAC,CAAC,GAAG,CAAC,OAAO,CAAC,CAAC,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC;AAC5D,CAAC"}

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

@@ -0,0 +1,105 @@
+/**
+ * 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
+ * `<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.
+ *
+ * Naming scheme: `E_` for an issue recorded with severity "error" (or a loss note whose export()
+ * 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. */
+export declare const MISSING_ID_CODE = "E_MISSING_ID";
+/** An edge has no source or no target. */
+export declare const MISSING_ENDPOINT_CODE = "E_MISSING_ENDPOINT";
+/** A node id declared twice; the second declaration merges into the first. */
+export declare const DUPLICATE_NODE_CODE = "W_DUPLICATE_NODE";
+/** The document declares no graph at all (fatal). */
+export declare const NO_GRAPH_CODE = "E_NO_GRAPH";
+/** A second graph in one document is merged into the first. */
+export declare const MULTIPLE_GRAPHS_CODE = "W_MULTIPLE_GRAPHS";
+/** The input is empty (fatal). */
+export declare const EMPTY_INPUT_CODE = "E_EMPTY_INPUT";
+/** The text grammar of the format is violated (fatal; the message carries the detail). */
+export declare const SYNTAX_CODE = "E_SYNTAX";
+/** The XML is not well-formed (fatal; the message carries the detail and the line). */
+export declare const XML_SYNTAX_CODE = "E_XML_SYNTAX";
+/** An element the format does not define at that place was skipped. */
+export declare const UNKNOWN_ELEMENT_CODE = "W_UNKNOWN_ELEMENT";
+/** Text where the format allows only elements was ignored. */
+export declare const STRAY_TEXT_CODE = "W_STRAY_TEXT";
+/** A `pid` / parent reference names a node the document never declares. */
+export declare const UNKNOWN_PARENT_CODE = "E_UNKNOWN_PARENT";
+/** A hyperedge under the `hyperedges: "error"` policy (fatal). */
+export declare const HYPEREDGE_CODE = "E_HYPEREDGE";
+/** A declaration's key / attribute id is declared twice. */
+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).
+ */
+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). */
+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). */
+export declare const PRECISION_CODE = "W_PRECISION";
+/** Two distinct id texts became one number under ids "number" (design section 4.1). */
+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). */
+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). */
+export declare const OPTION_IGNORED_CODE = "W_OPTION_IGNORED";
+/** An invalid UTF-8 sequence in the input (fatal). */
+export declare const INVALID_UTF8_CODE = "E_INVALID_UTF8";
+/** The sink refused the file's direction (locked or non-empty); the file is read as the sink's. */
+export declare const DIRECTION_REFUSED_CODE = "W_DIRECTION_REFUSED";
+/** Edges of the other direction were forced to the policy's direction. */
+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. */
+export declare const MIXED_DIRECTION_CODE = "E_MIXED_DIRECTION";
+/** A `count` / `parse.nodes` hint the sink cannot reserve (ignored). */
+export declare const COUNT_HINT_CODE = "W_COUNT_HINT";
+/** The declared type is not one the format defines; the column is kept as string. */
+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. */
+export declare const BAD_DEFAULT_CODE = "W_BAD_DEFAULT";
+/** A declared option does not parse as the declared type; the options are dropped. */
+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. */
+export declare const DUPLICATE_EDGE_ID_CODE = "E_DUPLICATE_EDGE_ID";
+/** A role column the format has no slot for is written as a plain attribute (the role is lost). */
+export declare const ROLE_DROPPED_CODE = "W_ROLE_DROPPED";
+/** A parents (multi-parent) column in a format with single containment only. */
+export declare const PARENTS_DROPPED_CODE = "W_PARENTS_DROPPED";
+/** A start / end / timestamp column in a format without temporal support. */
+export declare const TEMPORAL_DROPPED_CODE = "W_TEMPORAL_DROPPED";
+/** A mutual pair is written as two directed edges without the mutual mark. */
+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. */
+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. */
+export declare const ID_TEXT_TYPE_CODE = "W_ID_TEXT_TYPE";
+/** Two node ids share one written text; export() throws E_INVALID_ID. */
+export declare const ID_TEXT_COLLISION_CODE = "E_ID_TEXT_COLLISION";
+/** A `<column>.text` companion (design section 5.1) the format cannot carry. */
+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. */
+export declare const WEIGHT_KEY_CLASH_CODE = "W_WEIGHT_KEY_CLASH";
+/** A role-less column whose written name the importer maps to a role. */
+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. */
+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. */
+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. */
+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. */
+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). */
+export declare const TEXT_INFERRED_CODE = "W_TEXT_INFERRED";
+/** A string cell holding a character XML 1.0 forbids; export() throws E_COLUMN_TYPE. */
+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. */
+export declare const OPTIONS_GAINED_CODE = "W_OPTIONS_GAINED";
+//# sourceMappingURL=codes.d.ts.map

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

@@ -0,0 +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,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;AAI5D,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"}

package/dist/src/common/codes.js

@@ -0,0 +1,107 @@
+/**
+ * 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
+ * `<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.
+ *
+ * Naming scheme: `E_` for an issue recorded with severity "error" (or a loss note whose export()
+ * throws), `W_` for a warning; a table key is the code without the severity prefix and without the
+ * format prefix.
+ */
+// ============================================================ importer issues
+/** The element (node, attribute, key, ...) has no id where the format requires one. */
+export const MISSING_ID_CODE = "E_MISSING_ID";
+/** An edge has no source or no target. */
+export const MISSING_ENDPOINT_CODE = "E_MISSING_ENDPOINT";
+/** A node id declared twice; the second declaration merges into the first. */
+export const DUPLICATE_NODE_CODE = "W_DUPLICATE_NODE";
+/** The document declares no graph at all (fatal). */
+export const NO_GRAPH_CODE = "E_NO_GRAPH";
+/** A second graph in one document is merged into the first. */
+export const MULTIPLE_GRAPHS_CODE = "W_MULTIPLE_GRAPHS";
+/** The input is empty (fatal). */
+export const EMPTY_INPUT_CODE = "E_EMPTY_INPUT";
+/** The text grammar of the format is violated (fatal; the message carries the detail). */
+export const SYNTAX_CODE = "E_SYNTAX";
+/** The XML is not well-formed (fatal; the message carries the detail and the line). */
+export const XML_SYNTAX_CODE = "E_XML_SYNTAX";
+/** An element the format does not define at that place was skipped. */
+export const UNKNOWN_ELEMENT_CODE = "W_UNKNOWN_ELEMENT";
+/** Text where the format allows only elements was ignored. */
+export const STRAY_TEXT_CODE = "W_STRAY_TEXT";
+/** A `pid` / parent reference names a node the document never declares. */
+export const UNKNOWN_PARENT_CODE = "E_UNKNOWN_PARENT";
+/** A hyperedge under the `hyperedges: "error"` policy (fatal). */
+export const HYPEREDGE_CODE = "E_HYPEREDGE";
+/** A declaration's key / attribute id is declared twice. */
+export 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).
+ */
+export 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). */
+export const ROLE_TAKEN_CODE = "W_ROLE_TAKEN";
+/** A long value beyond 2^53 was stored as the nearest f64 (design section 5.1). */
+export const PRECISION_CODE = "W_PRECISION";
+/** Two distinct id texts became one number under ids "number" (design section 4.1). */
+export 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). */
+export 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). */
+export const OPTION_IGNORED_CODE = "W_OPTION_IGNORED";
+/** An invalid UTF-8 sequence in the input (fatal). */
+export const INVALID_UTF8_CODE = "E_INVALID_UTF8";
+/** The sink refused the file's direction (locked or non-empty); the file is read as the sink's. */
+export const DIRECTION_REFUSED_CODE = "W_DIRECTION_REFUSED";
+/** Edges of the other direction were forced to the policy's direction. */
+export const DIRECTION_FORCED_CODE = "W_DIRECTION_FORCED";
+/** A mixed-direction file under onMixedDirection "error" (import), or a mixed snapshot under the same export policy. */
+export const MIXED_DIRECTION_CODE = "E_MIXED_DIRECTION";
+/** A `count` / `parse.nodes` hint the sink cannot reserve (ignored). */
+export const COUNT_HINT_CODE = "W_COUNT_HINT";
+/** The declared type is not one the format defines; the column is kept as string. */
+export const UNKNOWN_ATTR_TYPE_CODE = "W_UNKNOWN_ATTR_TYPE";
+/** The declared default does not parse as the declared type; the column has no default. */
+export const BAD_DEFAULT_CODE = "W_BAD_DEFAULT";
+/** A declared option does not parse as the declared type; the options are dropped. */
+export const BAD_OPTIONS_CODE = "W_BAD_OPTIONS";
+/** A repeated edge id in a format whose edge ids are unique; the second edge is skipped. */
+export const DUPLICATE_EDGE_ID_CODE = "E_DUPLICATE_EDGE_ID";
+// ============================================================ exporter loss notes
+/** A role column the format has no slot for is written as a plain attribute (the role is lost). */
+export const ROLE_DROPPED_CODE = "W_ROLE_DROPPED";
+/** A parents (multi-parent) column in a format with single containment only. */
+export const PARENTS_DROPPED_CODE = "W_PARENTS_DROPPED";
+/** A start / end / timestamp column in a format without temporal support. */
+export const TEMPORAL_DROPPED_CODE = "W_TEMPORAL_DROPPED";
+/** A mutual pair is written as two directed edges without the mutual mark. */
+export 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. */
+export 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. */
+export const ID_TEXT_TYPE_CODE = "W_ID_TEXT_TYPE";
+/** Two node ids share one written text; export() throws E_INVALID_ID. */
+export const ID_TEXT_COLLISION_CODE = "E_ID_TEXT_COLLISION";
+/** A `<column>.text` companion (design section 5.1) the format cannot carry. */
+export const TEMPORAL_TEXT_DROPPED_CODE = "W_TEMPORAL_TEXT_DROPPED";
+/** A plain column named like the importer's weight key reads back as THE weight. */
+export const WEIGHT_KEY_CLASH_CODE = "W_WEIGHT_KEY_CLASH";
+/** A role-less column whose written name the importer maps to a role. */
+export const ROLE_ASSUMED_CODE = "W_ROLE_ASSUMED";
+/** A role column written into the format's slot reads back under the importer's fixed name. */
+export 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. */
+export 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. */
+export 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. */
+export 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). */
+export const TEXT_INFERRED_CODE = "W_TEXT_INFERRED";
+/** A string cell holding a character XML 1.0 forbids; export() throws E_COLUMN_TYPE. */
+export const XML_ILLEGAL_CHAR_CODE = "E_XML_ILLEGAL_CHAR";
+/** A dict column without declared options gains one from its dictionary on re-import. */
+export const OPTIONS_GAINED_CODE = "W_OPTIONS_GAINED";
+//# sourceMappingURL=codes.js.map

package/dist/src/common/codes.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"codes.js","sourceRoot":"","sources":["../../../src/common/codes.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;GAUG;AAEH,+EAA+E;AAE/E,uFAAuF;AACvF,MAAM,CAAC,MAAM,eAAe,GAAG,cAAc,CAAC;AAE9C,0CAA0C;AAC1C,MAAM,CAAC,MAAM,qBAAqB,GAAG,oBAAoB,CAAC;AAE1D,8EAA8E;AAC9E,MAAM,CAAC,MAAM,mBAAmB,GAAG,kBAAkB,CAAC;AAEtD,qDAAqD;AACrD,MAAM,CAAC,MAAM,aAAa,GAAG,YAAY,CAAC;AAE1C,+DAA+D;AAC/D,MAAM,CAAC,MAAM,oBAAoB,GAAG,mBAAmB,CAAC;AAExD,kCAAkC;AAClC,MAAM,CAAC,MAAM,gBAAgB,GAAG,eAAe,CAAC;AAEhD,0FAA0F;AAC1F,MAAM,CAAC,MAAM,WAAW,GAAG,UAAU,CAAC;AAEtC,uFAAuF;AACvF,MAAM,CAAC,MAAM,eAAe,GAAG,cAAc,CAAC;AAE9C,uEAAuE;AACvE,MAAM,CAAC,MAAM,oBAAoB,GAAG,mBAAmB,CAAC;AAExD,8DAA8D;AAC9D,MAAM,CAAC,MAAM,eAAe,GAAG,cAAc,CAAC;AAE9C,2EAA2E;AAC3E,MAAM,CAAC,MAAM,mBAAmB,GAAG,kBAAkB,CAAC;AAEtD,kEAAkE;AAClE,MAAM,CAAC,MAAM,cAAc,GAAG,aAAa,CAAC;AAE5C,4DAA4D;AAC5D,MAAM,CAAC,MAAM,kBAAkB,GAAG,iBAAiB,CAAC;AAEpD;;;GAGG;AACH,MAAM,CAAC,MAAM,mBAAmB,GAAG,kBAAkB,CAAC;AAEtD,6GAA6G;AAC7G,MAAM,CAAC,MAAM,eAAe,GAAG,cAAc,CAAC;AAE9C,mFAAmF;AACnF,MAAM,CAAC,MAAM,cAAc,GAAG,aAAa,CAAC;AAE5C,uFAAuF;AACvF,MAAM,CAAC,MAAM,cAAc,GAAG,aAAa,CAAC;AAE5C,uGAAuG;AACvG,MAAM,CAAC,MAAM,gBAAgB,GAAG,eAAe,CAAC;AAEhD,uHAAuH;AACvH,MAAM,CAAC,MAAM,mBAAmB,GAAG,kBAAkB,CAAC;AAEtD,sDAAsD;AACtD,MAAM,CAAC,MAAM,iBAAiB,GAAG,gBAAgB,CAAC;AAElD,mGAAmG;AACnG,MAAM,CAAC,MAAM,sBAAsB,GAAG,qBAAqB,CAAC;AAE5D,0EAA0E;AAC1E,MAAM,CAAC,MAAM,qBAAqB,GAAG,oBAAoB,CAAC;AAE1D,wHAAwH;AACxH,MAAM,CAAC,MAAM,oBAAoB,GAAG,mBAAmB,CAAC;AAExD,wEAAwE;AACxE,MAAM,CAAC,MAAM,eAAe,GAAG,cAAc,CAAC;AAE9C,qFAAqF;AACrF,MAAM,CAAC,MAAM,sBAAsB,GAAG,qBAAqB,CAAC;AAE5D,2FAA2F;AAC3F,MAAM,CAAC,MAAM,gBAAgB,GAAG,eAAe,CAAC;AAEhD,sFAAsF;AACtF,MAAM,CAAC,MAAM,gBAAgB,GAAG,eAAe,CAAC;AAEhD,4FAA4F;AAC5F,MAAM,CAAC,MAAM,sBAAsB,GAAG,qBAAqB,CAAC;AAE5D,mFAAmF;AAEnF,mGAAmG;AACnG,MAAM,CAAC,MAAM,iBAAiB,GAAG,gBAAgB,CAAC;AAElD,gFAAgF;AAChF,MAAM,CAAC,MAAM,oBAAoB,GAAG,mBAAmB,CAAC;AAExD,6EAA6E;AAC7E,MAAM,CAAC,MAAM,qBAAqB,GAAG,oBAAoB,CAAC;AAE1D,8EAA8E;AAC9E,MAAM,CAAC,MAAM,oBAAoB,GAAG,mBAAmB,CAAC;AAExD,yGAAyG;AACzG,MAAM,CAAC,MAAM,yBAAyB,GAAG,wBAAwB,CAAC;AAElE,6FAA6F;AAC7F,MAAM,CAAC,MAAM,iBAAiB,GAAG,gBAAgB,CAAC;AAElD,yEAAyE;AACzE,MAAM,CAAC,MAAM,sBAAsB,GAAG,qBAAqB,CAAC;AAE5D,gFAAgF;AAChF,MAAM,CAAC,MAAM,0BAA0B,GAAG,yBAAyB,CAAC;AAEpE,oFAAoF;AACpF,MAAM,CAAC,MAAM,qBAAqB,GAAG,oBAAoB,CAAC;AAE1D,yEAAyE;AACzE,MAAM,CAAC,MAAM,iBAAiB,GAAG,gBAAgB,CAAC;AAElD,+FAA+F;AAC/F,MAAM,CAAC,MAAM,wBAAwB,GAAG,uBAAuB,CAAC;AAEhE,kGAAkG;AAClG,MAAM,CAAC,MAAM,yBAAyB,GAAG,wBAAwB,CAAC;AAElE,2GAA2G;AAC3G,MAAM,CAAC,MAAM,kBAAkB,GAAG,yBAAyB,CAAC;AAE5D,mGAAmG;AACnG,MAAM,CAAC,MAAM,iBAAiB,GAAG,uBAAuB,CAAC;AAEzD,8GAA8G;AAC9G,MAAM,CAAC,MAAM,kBAAkB,GAAG,iBAAiB,CAAC;AAEpD,wFAAwF;AACxF,MAAM,CAAC,MAAM,qBAAqB,GAAG,oBAAoB,CAAC;AAE1D,yFAAyF;AACzF,MAAM,CAAC,MAAM,mBAAmB,GAAG,kBAAkB,CAAC"}