@graphty/graph-io 0.3.24 → 0.3.26

package/dist/src/common/ontology-export.d.ts

@@ -0,0 +1,167 @@
+/**
+ * What the two ontology exporters share (the OBO flat file and the JSON exporter's `obographs`
+ * dialect): the snapshot columns that fill the OBO slots (the label as `name`, the edge kind as
+ * `relation`), the placeholder nodes a re-import makes again by itself, the order a re-import gives
+ * the nodes, and the text of a cell. Both read the snapshot through the column vocabulary of
+ * ontology.ts, so a column means the same thing in both files.
+ */
+import { type Column, GraphFormatError, type GraphSnapshot } from "@graphty/graph-format";
+import { type ExportCapabilities } from "../types.js";
+import { type ResolvedExportOptions } from "./options.js";
+/**
+ * A note recorder.
+ * @category Plugin helpers
+ */
+export type NoteFn = (code: string, message: string, column?: string | null, count?: number | null) => void;
+/**
+ * The roles whose columns are never written as values (their loss notes come from checkCapabilities()).
+ * @category Plugin helpers
+ */
+export declare const UNWRITTEN_ROLES: ReadonlySet<string>;
+/**
+ * The OBO frame types.
+ * @category Plugin helpers
+ */
+export type FrameKind = "Term" | "Instance" | "Typedef";
+/**
+ * The frame types as a set, for checking a `type` cell.
+ * @category Plugin helpers
+ */
+export declare const FRAME_KINDS: ReadonlySet<string>;
+/**
+ * The value of a set cell (a multi-component value as a plain array), or undefined when unset; a
+ * declared default is not a value here (the formats have no defaults and say so).
+ * @param column - the column
+ * @param row - the row
+ * @returns the value or undefined
+ * @category Plugin helpers
+ */
+export declare function cellOf(column: Column, row: number): unknown;
+/**
+ * The text of a scalar value: a number by its dtype's shortest round-tripping form (`-0` kept), a
+ * boolean as `true` / `false`, a string as it is, anything else as its JSON text.
+ * @param value - the value
+ * @param dtype - the dtype it came from (the item dtype for a list item)
+ * @returns the text
+ * @category Plugin helpers
+ */
+export declare function textOf(value: unknown, dtype: string): string;
+/**
+ * Whether a column has the dtype of a vocabulary column (string and dict both fit a text column;
+ * the other text dtype is reported, not refused).
+ * @param want - the vocabulary dtype
+ * @param column - the column
+ * @returns true when the column can be written into the vocabulary slot
+ * @category Plugin helpers
+ */
+export declare function fitsVocabulary(want: string, column: Column): boolean;
+/**
+ * The values of a cell that may hold one value or a list of them.
+ * @param value - the cell value, or undefined
+ * @returns the values
+ * @category Plugin helpers
+ */
+export declare function valuesOf(value: unknown): readonly unknown[];
+/** A column chosen for an OBO slot. */
+interface Slot {
+    /** The column, or null when the snapshot has none for the slot. */
+    readonly column: Column | null;
+    /** Whether a role-less column was chosen by its name; it reads back with the role (W_ROLE_ASSUMED). */
+    readonly assumed: boolean;
+}
+/**
+ * The column of a slot: the column with the role when it holds text, else a role-less text column
+ * of the slot's name (which the importer reads back with the role).
+ * @param table - the node or edge table
+ * @param role - the role (`label` for `name`, `kind` for `relation`)
+ * @param name - the name the importer gives the slot
+ * @returns the column and whether its role is assumed
+ * @category Plugin helpers
+ */
+export declare function slotColumn(table: GraphSnapshot["nodes"], role: "label" | "kind", name: string): Slot;
+/**
+ * The nodes written without a frame (OBO) or a node record (OBO Graphs) because the re-import makes
+ * them again as placeholders: a `graphty.placeholder` true cell, no other set cell, an id written
+ * as it is, an edge that references it, and (in the flat file, where an edge is written on its
+ * source's frame) no edge of its own.
+ * @param snapshot - the snapshot
+ * @param written - the logical edges written
+ * @param options - `outgoingAllowed`: whether a placeholder may be an edge's source; `changed`: whether a node's id is rewritten
+ * @param options.outgoingAllowed - whether a placeholder may be an edge's source
+ * @param options.changed - whether a node's id is rewritten
+ * @returns one flag per node, 1 for a node written without a frame
+ * @category Plugin helpers
+ */
+export declare function framelessNodes(snapshot: GraphSnapshot, written: readonly number[], options: {
+    readonly outgoingAllowed: boolean;
+    readonly changed: (i: number) => boolean;
+}): Uint8Array;
+/**
+ * How many nodes a re-import puts at another index: the written nodes keep their order and the
+ * placeholders follow in the order the edges first reference them.
+ * @param frameless - the framelessNodes() flags
+ * @param references - the node indices in the order the written edges reference them
+ * @returns the number of nodes whose index changes
+ * @category Plugin helpers
+ */
+export declare function movedNodes(frameless: Uint8Array, references: Iterable<number>): number;
+/**
+ * Whether a value is a qualifier record as the importers make it: a non-empty object of names to a
+ * text or a list of two or more texts (a name given once reads back as a text, never as a
+ * one-item list), every name passing `nameOk`.
+ * @param value - the value
+ * @param nameOk - the name rule
+ * @returns true when the record is written and read back unchanged
+ * @category Plugin helpers
+ */
+export declare function isQualifierRecord(value: unknown, nameOk: (name: string) => boolean): boolean;
+/** What capabilityNotes() needs to know about the export. */
+interface CapabilityNoteSpec {
+    /** The format's capabilities. */
+    readonly caps: ExportCapabilities;
+    /** The label column written as the name, or null. */
+    readonly label: Column | null;
+    /** Whether the label is a role-less `name` column. */
+    readonly labelAssumed: boolean;
+    /** Where an edge column without a slot goes, for messages ("a qualifier"). */
+    readonly edgeSlot: string;
+    /** Records a note. */
+    readonly note: NoteFn;
+}
+/**
+ * The generic notes of checkCapabilities() as the ontology formats see them. No column of the
+ * snapshot's own survives as a column (the formats keep only the OBO vocabulary), so the generic
+ * dtype, list, json, strides and graph-attribute notes give way to the formats' own, which say
+ * where each column goes (a vocabulary column written into its slot needs no note; any other
+ * becomes property values, edge qualifiers or metadata). The name-change notes stand only for the
+ * label and kind columns actually written into their slot. Added: the roles without a slot (a
+ * node kind, an edge label) and a role-less `name` column taking the label role.
+ * @param snapshot - the snapshot
+ * @param common - the common options
+ * @param spec - the export's facts
+ * @returns the fatal error of a mixed graph under onMixedDirection "error", or null
+ * @category Plugin helpers
+ */
+export declare function capabilityNotes(snapshot: GraphSnapshot, common: ResolvedExportOptions, spec: CapabilityNoteSpec): GraphFormatError | null;
+/**
+ * Record the columns that read back absent: a node or edge column without a set cell on a written
+ * element (the importers declare a column when a value needs it).
+ * @param snapshot - the snapshot
+ * @param rows - the written nodes
+ * @param frameless - the frameless flags (a placeholder column set only there reads back)
+ * @param written - the written edges
+ * @param note - records a note
+ * @category Plugin helpers
+ */
+export declare function emptyColumnNotes(snapshot: GraphSnapshot, rows: readonly number[], frameless: Uint8Array, written: readonly number[], note: NoteFn): void;
+/**
+ * Record the note of a node column written as property values.
+ * @param note - the recorder
+ * @param column - the column
+ * @param rows - the written nodes
+ * @param how - how the values are written, for the message
+ * @category Plugin helpers
+ */
+export declare function notePropertyColumn(note: NoteFn, column: Column, rows: readonly number[], how: string): void;
+export {};
+//# sourceMappingURL=ontology-export.d.ts.map

package/dist/src/common/ontology-export.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"ontology-export.d.ts","sourceRoot":"","sources":["../../../src/common/ontology-export.ts"],"names":[],"mappings":"AAAA;;;;;;GAMG;AAEH,OAAO,EAAE,KAAK,MAAM,EAAE,gBAAgB,EAAE,KAAK,aAAa,EAAE,MAAM,uBAAuB,CAAC;AAE1F,OAAO,EAAE,KAAK,kBAAkB,EAAiB,MAAM,aAAa,CAAC;AAKrE,OAAO,EAAE,KAAK,qBAAqB,EAAE,MAAM,cAAc,CAAC;AAE1D;;;GAGG;AACH,MAAM,MAAM,MAAM,GAAG,CAAC,IAAI,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM,EAAE,MAAM,CAAC,EAAE,MAAM,GAAG,IAAI,EAAE,KAAK,CAAC,EAAE,MAAM,GAAG,IAAI,KAAK,IAAI,CAAC;AAe5G;;;GAGG;AACH,eAAO,MAAM,eAAe,EAAE,WAAW,CAAC,MAAM,CAqB9C,CAAC;AAEH;;;GAGG;AACH,MAAM,MAAM,SAAS,GAAG,MAAM,GAAG,UAAU,GAAG,SAAS,CAAC;AAExD;;;GAGG;AACH,eAAO,MAAM,WAAW,EAAE,WAAW,CAAC,MAAM,CAA4C,CAAC;AAEzF;;;;;;;GAOG;AACH,wBAAgB,MAAM,CAAC,MAAM,EAAE,MAAM,EAAE,GAAG,EAAE,MAAM,GAAG,OAAO,CAM3D;AAED;;;;;;;GAOG;AACH,wBAAgB,MAAM,CAAC,KAAK,EAAE,OAAO,EAAE,KAAK,EAAE,MAAM,GAAG,MAAM,CAc5D;AAED;;;;;;;GAOG;AACH,wBAAgB,cAAc,CAAC,IAAI,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,GAAG,OAAO,CASpE;AAED;;;;;GAKG;AACH,wBAAgB,QAAQ,CAAC,KAAK,EAAE,OAAO,GAAG,SAAS,OAAO,EAAE,CAK3D;AAED,uCAAuC;AACvC,UAAU,IAAI;IACV,mEAAmE;IACnE,QAAQ,CAAC,MAAM,EAAE,MAAM,GAAG,IAAI,CAAC;IAC/B,uGAAuG;IACvG,QAAQ,CAAC,OAAO,EAAE,OAAO,CAAC;CAC7B;AAED;;;;;;;;GAQG;AACH,wBAAgB,UAAU,CAAC,KAAK,EAAE,aAAa,CAAC,OAAO,CAAC,EAAE,IAAI,EAAE,OAAO,GAAG,MAAM,EAAE,IAAI,EAAE,MAAM,GAAG,IAAI,CAUpG;AAqBD;;;;;;;;;;;;GAYG;AACH,wBAAgB,cAAc,CAC1B,QAAQ,EAAE,aAAa,EACvB,OAAO,EAAE,SAAS,MAAM,EAAE,EAC1B,OAAO,EAAE;IAAE,QAAQ,CAAC,eAAe,EAAE,OAAO,CAAC;IAAC,QAAQ,CAAC,OAAO,EAAE,CAAC,CAAC,EAAE,MAAM,KAAK,OAAO,CAAA;CAAE,GACzF,UAAU,CA+BZ;AAED;;;;;;;GAOG;AACH,wBAAgB,UAAU,CAAC,SAAS,EAAE,UAAU,EAAE,UAAU,EAAE,QAAQ,CAAC,MAAM,CAAC,GAAG,MAAM,CAqBtF;AAED;;;;;;;;GAQG;AACH,wBAAgB,iBAAiB,CAAC,KAAK,EAAE,OAAO,EAAE,MAAM,EAAE,CAAC,IAAI,EAAE,MAAM,KAAK,OAAO,GAAG,OAAO,CAc5F;AAED,6DAA6D;AAC7D,UAAU,kBAAkB;IACxB,iCAAiC;IACjC,QAAQ,CAAC,IAAI,EAAE,kBAAkB,CAAC;IAClC,qDAAqD;IACrD,QAAQ,CAAC,KAAK,EAAE,MAAM,GAAG,IAAI,CAAC;IAC9B,sDAAsD;IACtD,QAAQ,CAAC,YAAY,EAAE,OAAO,CAAC;IAC/B,8EAA8E;IAC9E,QAAQ,CAAC,QAAQ,EAAE,MAAM,CAAC;IAC1B,sBAAsB;IACtB,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC;CACzB;AAED;;;;;;;;;;;;;GAaG;AACH,wBAAgB,eAAe,CAC3B,QAAQ,EAAE,aAAa,EACvB,MAAM,EAAE,qBAAqB,EAC7B,IAAI,EAAE,kBAAkB,GACzB,gBAAgB,GAAG,IAAI,CAezB;AAmDD;;;;;;;;;GASG;AACH,wBAAgB,gBAAgB,CAC5B,QAAQ,EAAE,aAAa,EACvB,IAAI,EAAE,SAAS,MAAM,EAAE,EACvB,SAAS,EAAE,UAAU,EACrB,OAAO,EAAE,SAAS,MAAM,EAAE,EAC1B,IAAI,EAAE,MAAM,GACb,IAAI,CAuBN;AAED;;;;;;;GAOG;AACH,wBAAgB,kBAAkB,CAAC,IAAI,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,IAAI,EAAE,SAAS,MAAM,EAAE,EAAE,GAAG,EAAE,MAAM,GAAG,IAAI,CAY3G"}

package/dist/src/common/ontology-export.js

@@ -0,0 +1,359 @@
+/**
+ * What the two ontology exporters share (the OBO flat file and the JSON exporter's `obographs`
+ * dialect): the snapshot columns that fill the OBO slots (the label as `name`, the edge kind as
+ * `relation`), the placeholder nodes a re-import makes again by itself, the order a re-import gives
+ * the nodes, and the text of a cell. Both read the snapshot through the column vocabulary of
+ * ontology.ts, so a column means the same thing in both files.
+ */
+import { GraphFormatError } from "@graphty/graph-format";
+import { COLUMN_AS_PROPERTY_VALUE_CODE, ROLE_ASSUMED_CODE } from "./codes.js";
+import { checkCapabilities, LOSS } from "./export.js";
+import { formatNumber } from "./format.js";
+import { PLACEHOLDER_COLUMN } from "./ontology.js";
+/** The generic notes the ontology formats replace with their own (see capabilityNotes()). */
+const SUPERSEDED = new Set([
+    LOSS.DTYPE,
+    LOSS.LIST,
+    LOSS.JSON,
+    LOSS.COMPONENTS,
+    LOSS.GRAPH_ATTRIBUTES,
+]);
+/** The roles the ontology formats have a slot for, and the column names their importers give them. */
+const SLOT_ROLES = new Set(["label", "kind"]);
+const ROLE_NAMES = Object.freeze({ label: "name", kind: "relation" });
+/**
+ * The roles whose columns are never written as values (their loss notes come from checkCapabilities()).
+ * @category Plugin helpers
+ */
+export const UNWRITTEN_ROLES = new Set([
+    "directed",
+    "pair",
+    "mutual",
+    "weight",
+    "timeText",
+    "originalId",
+    "parent",
+    "parents",
+    "start",
+    "end",
+    "timestamp",
+    "timestamps",
+    "spells",
+    "open",
+    "spellsOpen",
+    "position",
+    "color",
+    "size",
+    "shape",
+    "thickness",
+]);
+/**
+ * The frame types as a set, for checking a `type` cell.
+ * @category Plugin helpers
+ */
+export const FRAME_KINDS = new Set(["Term", "Instance", "Typedef"]);
+/**
+ * The value of a set cell (a multi-component value as a plain array), or undefined when unset; a
+ * declared default is not a value here (the formats have no defaults and say so).
+ * @param column - the column
+ * @param row - the row
+ * @returns the value or undefined
+ * @category Plugin helpers
+ */
+export function cellOf(column, row) {
+    if (!column.isSet(row)) {
+        return undefined;
+    }
+    const value = column.value(row);
+    return ArrayBuffer.isView(value) ? Array.from(value) : value;
+}
+/**
+ * The text of a scalar value: a number by its dtype's shortest round-tripping form (`-0` kept), a
+ * boolean as `true` / `false`, a string as it is, anything else as its JSON text.
+ * @param value - the value
+ * @param dtype - the dtype it came from (the item dtype for a list item)
+ * @returns the text
+ * @category Plugin helpers
+ */
+export function textOf(value, dtype) {
+    switch (typeof value) {
+        case "string":
+            return value;
+        case "boolean":
+            return value ? "true" : "false";
+        case "number":
+            return formatNumber(value, dtype === "f32" || dtype === "i32" || dtype === "u32" || dtype === "u8" ? dtype : "f64");
+        default:
+            return JSON.stringify(value) ?? "null";
+    }
+}
+/**
+ * Whether a column has the dtype of a vocabulary column (string and dict both fit a text column;
+ * the other text dtype is reported, not refused).
+ * @param want - the vocabulary dtype
+ * @param column - the column
+ * @returns true when the column can be written into the vocabulary slot
+ * @category Plugin helpers
+ */
+export function fitsVocabulary(want, column) {
+    switch (want) {
+        case "list":
+        case "bool":
+        case "json":
+            return column.dtype === want;
+        default:
+            return isText(column);
+    }
+}
+/**
+ * The values of a cell that may hold one value or a list of them.
+ * @param value - the cell value, or undefined
+ * @returns the values
+ * @category Plugin helpers
+ */
+export function valuesOf(value) {
+    if (value === undefined) {
+        return [];
+    }
+    return Array.isArray(value) ? value : [value];
+}
+/**
+ * The column of a slot: the column with the role when it holds text, else a role-less text column
+ * of the slot's name (which the importer reads back with the role).
+ * @param table - the node or edge table
+ * @param role - the role (`label` for `name`, `kind` for `relation`)
+ * @param name - the name the importer gives the slot
+ * @returns the column and whether its role is assumed
+ * @category Plugin helpers
+ */
+export function slotColumn(table, role, name) {
+    const byRole = table.byRole(role);
+    if (byRole !== null) {
+        return { column: isText(byRole) ? byRole : null, assumed: false };
+    }
+    const byName = table.get(name);
+    if (byName !== null && byName.meta.role === null && isText(byName)) {
+        return { column: byName, assumed: true };
+    }
+    return { column: null, assumed: false };
+}
+/**
+ * Whether a column holds text (string or dict).
+ * @param column - the column
+ * @returns true for string and dict
+ */
+function isText(column) {
+    return column.dtype === "string" || column.dtype === "dict";
+}
+/**
+ * The placeholder column (`graphty.placeholder`, a bool), or null.
+ * @param snapshot - the snapshot
+ * @returns the column
+ */
+function placeholderColumn(snapshot) {
+    const column = snapshot.nodes.get(PLACEHOLDER_COLUMN);
+    return column !== null && column.dtype === "bool" ? column : null;
+}
+/**
+ * The nodes written without a frame (OBO) or a node record (OBO Graphs) because the re-import makes
+ * them again as placeholders: a `graphty.placeholder` true cell, no other set cell, an id written
+ * as it is, an edge that references it, and (in the flat file, where an edge is written on its
+ * source's frame) no edge of its own.
+ * @param snapshot - the snapshot
+ * @param written - the logical edges written
+ * @param options - `outgoingAllowed`: whether a placeholder may be an edge's source; `changed`: whether a node's id is rewritten
+ * @param options.outgoingAllowed - whether a placeholder may be an edge's source
+ * @param options.changed - whether a node's id is rewritten
+ * @returns one flag per node, 1 for a node written without a frame
+ * @category Plugin helpers
+ */
+export function framelessNodes(snapshot, written, options) {
+    const flags = new Uint8Array(snapshot.nodeCount);
+    const placeholder = placeholderColumn(snapshot);
+    if (placeholder === null) {
+        return flags;
+    }
+    const { src, dst } = snapshot.edgeList();
+    const referenced = new Uint8Array(snapshot.nodeCount);
+    const sources = new Uint8Array(snapshot.nodeCount);
+    for (const e of written) {
+        referenced[dst[e]] = 1;
+        if (options.outgoingAllowed) {
+            referenced[src[e]] = 1;
+        }
+        else {
+            sources[src[e]] = 1;
+        }
+    }
+    const others = [...snapshot.nodes].filter((c) => c !== placeholder);
+    for (let i = 0; i < snapshot.nodeCount; i++) {
+        if (placeholder.isSet(i) &&
+            placeholder.value(i) === true &&
+            referenced[i] === 1 &&
+            sources[i] === 0 &&
+            !options.changed(i) &&
+            others.every((c) => !c.isSet(i))) {
+            flags[i] = 1;
+        }
+    }
+    return flags;
+}
+/**
+ * How many nodes a re-import puts at another index: the written nodes keep their order and the
+ * placeholders follow in the order the edges first reference them.
+ * @param frameless - the framelessNodes() flags
+ * @param references - the node indices in the order the written edges reference them
+ * @returns the number of nodes whose index changes
+ * @category Plugin helpers
+ */
+export function movedNodes(frameless, references) {
+    const order = [];
+    for (let i = 0; i < frameless.length; i++) {
+        if (frameless[i] === 0) {
+            order.push(i);
+        }
+    }
+    const seen = new Uint8Array(frameless.length);
+    for (const i of references) {
+        if (frameless[i] === 1 && seen[i] === 0) {
+            seen[i] = 1;
+            order.push(i);
+        }
+    }
+    let moved = 0;
+    for (let k = 0; k < order.length; k++) {
+        if (order[k] !== k) {
+            moved++;
+        }
+    }
+    return moved;
+}
+/**
+ * Whether a value is a qualifier record as the importers make it: a non-empty object of names to a
+ * text or a list of two or more texts (a name given once reads back as a text, never as a
+ * one-item list), every name passing `nameOk`.
+ * @param value - the value
+ * @param nameOk - the name rule
+ * @returns true when the record is written and read back unchanged
+ * @category Plugin helpers
+ */
+export function isQualifierRecord(value, nameOk) {
+    if (typeof value !== "object" || value === null || Array.isArray(value)) {
+        return false;
+    }
+    const entries = Object.entries(value);
+    return (entries.length > 0 &&
+        entries.every(([name, v]) => nameOk(name) &&
+            (typeof v === "string" ||
+                (Array.isArray(v) && v.length >= 2 && v.every((item) => typeof item === "string")))));
+}
+/**
+ * The generic notes of checkCapabilities() as the ontology formats see them. No column of the
+ * snapshot's own survives as a column (the formats keep only the OBO vocabulary), so the generic
+ * dtype, list, json, strides and graph-attribute notes give way to the formats' own, which say
+ * where each column goes (a vocabulary column written into its slot needs no note; any other
+ * becomes property values, edge qualifiers or metadata). The name-change notes stand only for the
+ * label and kind columns actually written into their slot. Added: the roles without a slot (a
+ * node kind, an edge label) and a role-less `name` column taking the label role.
+ * @param snapshot - the snapshot
+ * @param common - the common options
+ * @param spec - the export's facts
+ * @returns the fatal error of a mixed graph under onMixedDirection "error", or null
+ * @category Plugin helpers
+ */
+export function capabilityNotes(snapshot, common, spec) {
+    const { label, note } = spec;
+    let fatal = null;
+    const kind = snapshot.edges.byRole("kind");
+    for (const gen of checkCapabilities(snapshot, spec.caps, common, { roles: SLOT_ROLES, roleNames: ROLE_NAMES })) {
+        if (SUPERSEDED.has(gen.code) || (gen.code === LOSS.COLUMN_NAME_CHANGED && !isSlotRename(gen, label, kind))) {
+            continue;
+        }
+        if (gen.code === LOSS.MIXED_DIRECTION_ERROR && fatal === null) {
+            fatal = new GraphFormatError("E_DIRECTED", gen.message, { reason: "mixed direction" });
+        }
+        note(gen.code, gen.message, gen.column, gen.count);
+    }
+    slotlessRoleNotes(snapshot, spec);
+    return fatal;
+}
+/**
+ * Note the roles the ontology formats have no slot for (a node kind, an edge label), and a
+ * role-less `name` column taking the label role.
+ * @param snapshot - the snapshot
+ * @param spec - the export's facts
+ */
+function slotlessRoleNotes(snapshot, spec) {
+    const { label, note } = spec;
+    const nodeKind = snapshot.nodes.byRole("kind");
+    if (nodeKind !== null) {
+        note(LOSS.ROLE, `node column "${nodeKind.meta.name}" (kind) is written as property values; the format has no node kind slot`, nodeKind.meta.name, nodeKind.length - nodeKind.nullCount);
+    }
+    const edgeLabel = snapshot.edges.byRole("label");
+    if (edgeLabel !== null) {
+        note(LOSS.ROLE, `edge column "${edgeLabel.meta.name}" (label) is written as ${spec.edgeSlot}; the format has no edge label slot`, edgeLabel.meta.name, edgeLabel.length - edgeLabel.nullCount);
+    }
+    if (label !== null && spec.labelAssumed) {
+        note(ROLE_ASSUMED_CODE, `node column "name" is written as each node's name and reads back as the label`, "name", label.length - label.nullCount);
+    }
+}
+/**
+ * Whether a name-change note is about a column written into its slot: the node label, or a text
+ * edge kind column.
+ * @param gen - the note
+ * @param label - the node label column, or null
+ * @param kind - the edge kind column, or null
+ * @returns true when it is
+ */
+function isSlotRename(gen, label, kind) {
+    const isLabel = label !== null && gen.column === label.meta.name;
+    return isLabel || (kind !== null && gen.column === kind.meta.name && isText(kind));
+}
+/**
+ * Record the columns that read back absent: a node or edge column without a set cell on a written
+ * element (the importers declare a column when a value needs it).
+ * @param snapshot - the snapshot
+ * @param rows - the written nodes
+ * @param frameless - the frameless flags (a placeholder column set only there reads back)
+ * @param written - the written edges
+ * @param note - records a note
+ * @category Plugin helpers
+ */
+export function emptyColumnNotes(snapshot, rows, frameless, written, note) {
+    const tables = [
+        [
+            "node",
+            snapshot.nodes,
+            (c) => rows.some((i) => c.isSet(i)) ||
+                (c.meta.name === PLACEHOLDER_COLUMN && frameless.some((f, i) => f === 1 && c.isSet(i))),
+        ],
+        ["edge", snapshot.edges, (c) => written.some((e) => c.isSet(e))],
+    ];
+    for (const [domain, table, used] of tables) {
+        for (const column of table) {
+            const { role, name } = column.meta;
+            if ((role !== null && (UNWRITTEN_ROLES.has(role) || (domain === "edge" && role === "id"))) ||
+                used(column)) {
+                continue;
+            }
+            note(LOSS.EMPTY_COLUMN, `${domain} column "${name}" has no value to write; it reads back absent`, name, 0);
+        }
+    }
+}
+/**
+ * Record the note of a node column written as property values.
+ * @param note - the recorder
+ * @param column - the column
+ * @param rows - the written nodes
+ * @param how - how the values are written, for the message
+ * @category Plugin helpers
+ */
+export function notePropertyColumn(note, column, rows, how) {
+    const count = rows.filter((i) => column.isSet(i)).length;
+    if (count === 0) {
+        return;
+    }
+    const role = column.meta.role === null ? "" : ` (its ${column.meta.role} role is lost)`;
+    note(COLUMN_AS_PROPERTY_VALUE_CODE, `node column "${column.meta.name}" is written as ${how} and reads back inside the property_value column, not as its own column${role}`, column.meta.name, count);
+}
+//# sourceMappingURL=ontology-export.js.map

package/dist/src/common/ontology-export.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"ontology-export.js","sourceRoot":"","sources":["../../../src/common/ontology-export.ts"],"names":[],"mappings":"AAAA;;;;;;GAMG;AAEH,OAAO,EAAe,gBAAgB,EAAsB,MAAM,uBAAuB,CAAC;AAG1F,OAAO,EAAE,6BAA6B,EAAE,iBAAiB,EAAE,MAAM,YAAY,CAAC;AAC9E,OAAO,EAAE,iBAAiB,EAAE,IAAI,EAAE,MAAM,aAAa,CAAC;AACtD,OAAO,EAAE,YAAY,EAAE,MAAM,aAAa,CAAC;AAC3C,OAAO,EAAE,kBAAkB,EAAE,MAAM,eAAe,CAAC;AASnD,6FAA6F;AAC7F,MAAM,UAAU,GAAwB,IAAI,GAAG,CAAC;IAC5C,IAAI,CAAC,KAAK;IACV,IAAI,CAAC,IAAI;IACT,IAAI,CAAC,IAAI;IACT,IAAI,CAAC,UAAU;IACf,IAAI,CAAC,gBAAgB;CACxB,CAAC,CAAC;AAEH,sGAAsG;AACtG,MAAM,UAAU,GAAwB,IAAI,GAAG,CAAC,CAAC,OAAO,EAAE,MAAM,CAAC,CAAC,CAAC;AACnE,MAAM,UAAU,GAAqC,MAAM,CAAC,MAAM,CAAC,EAAE,KAAK,EAAE,MAAM,EAAE,IAAI,EAAE,UAAU,EAAE,CAAC,CAAC;AAExG;;;GAGG;AACH,MAAM,CAAC,MAAM,eAAe,GAAwB,IAAI,GAAG,CAAC;IACxD,UAAU;IACV,MAAM;IACN,QAAQ;IACR,QAAQ;IACR,UAAU;IACV,YAAY;IACZ,QAAQ;IACR,SAAS;IACT,OAAO;IACP,KAAK;IACL,WAAW;IACX,YAAY;IACZ,QAAQ;IACR,MAAM;IACN,YAAY;IACZ,UAAU;IACV,OAAO;IACP,MAAM;IACN,OAAO;IACP,WAAW;CACd,CAAC,CAAC;AAQH;;;GAGG;AACH,MAAM,CAAC,MAAM,WAAW,GAAwB,IAAI,GAAG,CAAC,CAAC,MAAM,EAAE,UAAU,EAAE,SAAS,CAAC,CAAC,CAAC;AAEzF;;;;;;;GAOG;AACH,MAAM,UAAU,MAAM,CAAC,MAAc,EAAE,GAAW;IAC9C,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,GAAG,CAAC,EAAE,CAAC;QACrB,OAAO,SAAS,CAAC;IACrB,CAAC;IACD,MAAM,KAAK,GAAY,MAAM,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;IACzC,OAAO,WAAW,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,IAAI,CAAC,KAAqC,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC;AACjG,CAAC;AAED;;;;;;;GAOG;AACH,MAAM,UAAU,MAAM,CAAC,KAAc,EAAE,KAAa;IAChD,QAAQ,OAAO,KAAK,EAAE,CAAC;QACnB,KAAK,QAAQ;YACT,OAAO,KAAK,CAAC;QACjB,KAAK,SAAS;YACV,OAAO,KAAK,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,OAAO,CAAC;QACpC,KAAK,QAAQ;YACT,OAAO,YAAY,CACf,KAAK,EACL,KAAK,KAAK,KAAK,IAAI,KAAK,KAAK,KAAK,IAAI,KAAK,KAAK,KAAK,IAAI,KAAK,KAAK,IAAI,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,KAAK,CAC1F,CAAC;QACN;YACI,OAAO,IAAI,CAAC,SAAS,CAAC,KAAK,CAAC,IAAI,MAAM,CAAC;IAC/C,CAAC;AACL,CAAC;AAED;;;;;;;GAOG;AACH,MAAM,UAAU,cAAc,CAAC,IAAY,EAAE,MAAc;IACvD,QAAQ,IAAI,EAAE,CAAC;QACX,KAAK,MAAM,CAAC;QACZ,KAAK,MAAM,CAAC;QACZ,KAAK,MAAM;YACP,OAAO,MAAM,CAAC,KAAK,KAAK,IAAI,CAAC;QACjC;YACI,OAAO,MAAM,CAAC,MAAM,CAAC,CAAC;IAC9B,CAAC;AACL,CAAC;AAED;;;;;GAKG;AACH,MAAM,UAAU,QAAQ,CAAC,KAAc;IACnC,IAAI,KAAK,KAAK,SAAS,EAAE,CAAC;QACtB,OAAO,EAAE,CAAC;IACd,CAAC;IACD,OAAO,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC;AAClD,CAAC;AAUD;;;;;;;;GAQG;AACH,MAAM,UAAU,UAAU,CAAC,KAA6B,EAAE,IAAsB,EAAE,IAAY;IAC1F,MAAM,MAAM,GAAG,KAAK,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC;IAClC,IAAI,MAAM,KAAK,IAAI,EAAE,CAAC;QAClB,OAAO,EAAE,MAAM,EAAE,MAAM,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,IAAI,EAAE,OAAO,EAAE,KAAK,EAAE,CAAC;IACtE,CAAC;IACD,MAAM,MAAM,GAAG,KAAK,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC;IAC/B,IAAI,MAAM,KAAK,IAAI,IAAI,MAAM,CAAC,IAAI,CAAC,IAAI,KAAK,IAAI,IAAI,MAAM,CAAC,MAAM,CAAC,EAAE,CAAC;QACjE,OAAO,EAAE,MAAM,EAAE,MAAM,EAAE,OAAO,EAAE,IAAI,EAAE,CAAC;IAC7C,CAAC;IACD,OAAO,EAAE,MAAM,EAAE,IAAI,EAAE,OAAO,EAAE,KAAK,EAAE,CAAC;AAC5C,CAAC;AAED;;;;GAIG;AACH,SAAS,MAAM,CAAC,MAAc;IAC1B,OAAO,MAAM,CAAC,KAAK,KAAK,QAAQ,IAAI,MAAM,CAAC,KAAK,KAAK,MAAM,CAAC;AAChE,CAAC;AAED;;;;GAIG;AACH,SAAS,iBAAiB,CAAC,QAAuB;IAC9C,MAAM,MAAM,GAAG,QAAQ,CAAC,KAAK,CAAC,GAAG,CAAC,kBAAkB,CAAC,CAAC;IACtD,OAAO,MAAM,KAAK,IAAI,IAAI,MAAM,CAAC,KAAK,KAAK,MAAM,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,IAAI,CAAC;AACtE,CAAC;AAED;;;;;;;;;;;;GAYG;AACH,MAAM,UAAU,cAAc,CAC1B,QAAuB,EACvB,OAA0B,EAC1B,OAAwF;IAExF,MAAM,KAAK,GAAG,IAAI,UAAU,CAAC,QAAQ,CAAC,SAAS,CAAC,CAAC;IACjD,MAAM,WAAW,GAAG,iBAAiB,CAAC,QAAQ,CAAC,CAAC;IAChD,IAAI,WAAW,KAAK,IAAI,EAAE,CAAC;QACvB,OAAO,KAAK,CAAC;IACjB,CAAC;IACD,MAAM,EAAE,GAAG,EAAE,GAAG,EAAE,GAAG,QAAQ,CAAC,QAAQ,EAAE,CAAC;IACzC,MAAM,UAAU,GAAG,IAAI,UAAU,CAAC,QAAQ,CAAC,SAAS,CAAC,CAAC;IACtD,MAAM,OAAO,GAAG,IAAI,UAAU,CAAC,QAAQ,CAAC,SAAS,CAAC,CAAC;IACnD,KAAK,MAAM,CAAC,IAAI,OAAO,EAAE,CAAC;QACtB,UAAU,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC;QACvB,IAAI,OAAO,CAAC,eAAe,EAAE,CAAC;YAC1B,UAAU,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC;QAC3B,CAAC;aAAM,CAAC;YACJ,OAAO,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC;QACxB,CAAC;IACL,CAAC;IACD,MAAM,MAAM,GAAG,CAAC,GAAG,QAAQ,CAAC,KAAK,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,KAAK,WAAW,CAAC,CAAC;IACpE,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,QAAQ,CAAC,SAAS,EAAE,CAAC,EAAE,EAAE,CAAC;QAC1C,IACI,WAAW,CAAC,KAAK,CAAC,CAAC,CAAC;YACpB,WAAW,CAAC,KAAK,CAAC,CAAC,CAAC,KAAK,IAAI;YAC7B,UAAU,CAAC,CAAC,CAAC,KAAK,CAAC;YACnB,OAAO,CAAC,CAAC,CAAC,KAAK,CAAC;YAChB,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC,CAAC;YACnB,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,EAClC,CAAC;YACC,KAAK,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC;QACjB,CAAC;IACL,CAAC;IACD,OAAO,KAAK,CAAC;AACjB,CAAC;AAED;;;;;;;GAOG;AACH,MAAM,UAAU,UAAU,CAAC,SAAqB,EAAE,UAA4B;IAC1E,MAAM,KAAK,GAAa,EAAE,CAAC;IAC3B,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,SAAS,CAAC,MAAM,EAAE,CAAC,EAAE,EAAE,CAAC;QACxC,IAAI,SAAS,CAAC,CAAC,CAAC,KAAK,CAAC,EAAE,CAAC;YACrB,KAAK,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;QAClB,CAAC;IACL,CAAC;IACD,MAAM,IAAI,GAAG,IAAI,UAAU,CAAC,SAAS,CAAC,MAAM,CAAC,CAAC;IAC9C,KAAK,MAAM,CAAC,IAAI,UAAU,EAAE,CAAC;QACzB,IAAI,SAAS,CAAC,CAAC,CAAC,KAAK,CAAC,IAAI,IAAI,CAAC,CAAC,CAAC,KAAK,CAAC,EAAE,CAAC;YACtC,IAAI,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC;YACZ,KAAK,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;QAClB,CAAC;IACL,CAAC;IACD,IAAI,KAAK,GAAG,CAAC,CAAC;IACd,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,KAAK,CAAC,MAAM,EAAE,CAAC,EAAE,EAAE,CAAC;QACpC,IAAI,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,EAAE,CAAC;YACjB,KAAK,EAAE,CAAC;QACZ,CAAC;IACL,CAAC;IACD,OAAO,KAAK,CAAC;AACjB,CAAC;AAED;;;;;;;;GAQG;AACH,MAAM,UAAU,iBAAiB,CAAC,KAAc,EAAE,MAAiC;IAC/E,IAAI,OAAO,KAAK,KAAK,QAAQ,IAAI,KAAK,KAAK,IAAI,IAAI,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,EAAE,CAAC;QACtE,OAAO,KAAK,CAAC;IACjB,CAAC;IACD,MAAM,OAAO,GAAG,MAAM,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC;IACtC,OAAO,CACH,OAAO,CAAC,MAAM,GAAG,CAAC;QAClB,OAAO,CAAC,KAAK,CACT,CAAC,CAAC,IAAI,EAAE,CAAC,CAAC,EAAE,EAAE,CACV,MAAM,CAAC,IAAI,CAAC;YACZ,CAAC,OAAO,CAAC,KAAK,QAAQ;gBAClB,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,MAAM,IAAI,CAAC,IAAI,CAAC,CAAC,KAAK,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,OAAO,IAAI,KAAK,QAAQ,CAAC,CAAC,CAAC,CAC9F,CACJ,CAAC;AACN,CAAC;AAgBD;;;;;;;;;;;;;GAaG;AACH,MAAM,UAAU,eAAe,CAC3B,QAAuB,EACvB,MAA6B,EAC7B,IAAwB;IAExB,MAAM,EAAE,KAAK,EAAE,IAAI,EAAE,GAAG,IAAI,CAAC;IAC7B,IAAI,KAAK,GAA4B,IAAI,CAAC;IAC1C,MAAM,IAAI,GAAG,QAAQ,CAAC,KAAK,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC;IAC3C,KAAK,MAAM,GAAG,IAAI,iBAAiB,CAAC,QAAQ,EAAE,IAAI,CAAC,IAAI,EAAE,MAAM,EAAE,EAAE,KAAK,EAAE,UAAU,EAAE,SAAS,EAAE,UAAU,EAAE,CAAC,EAAE,CAAC;QAC7G,IAAI,UAAU,CAAC,GAAG,CAAC,GAAG,CAAC,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,IAAI,KAAK,IAAI,CAAC,mBAAmB,IAAI,CAAC,YAAY,CAAC,GAAG,EAAE,KAAK,EAAE,IAAI,CAAC,CAAC,EAAE,CAAC;YACzG,SAAS;QACb,CAAC;QACD,IAAI,GAAG,CAAC,IAAI,KAAK,IAAI,CAAC,qBAAqB,IAAI,KAAK,KAAK,IAAI,EAAE,CAAC;YAC5D,KAAK,GAAG,IAAI,gBAAgB,CAAC,YAAY,EAAE,GAAG,CAAC,OAAO,EAAE,EAAE,MAAM,EAAE,iBAAiB,EAAE,CAAC,CAAC;QAC3F,CAAC;QACD,IAAI,CAAC,GAAG,CAAC,IAAI,EAAE,GAAG,CAAC,OAAO,EAAE,GAAG,CAAC,MAAM,EAAE,GAAG,CAAC,KAAK,CAAC,CAAC;IACvD,CAAC;IACD,iBAAiB,CAAC,QAAQ,EAAE,IAAI,CAAC,CAAC;IAClC,OAAO,KAAK,CAAC;AACjB,CAAC;AAED;;;;;GAKG;AACH,SAAS,iBAAiB,CAAC,QAAuB,EAAE,IAAwB;IACxE,MAAM,EAAE,KAAK,EAAE,IAAI,EAAE,GAAG,IAAI,CAAC;IAC7B,MAAM,QAAQ,GAAG,QAAQ,CAAC,KAAK,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC;IAC/C,IAAI,QAAQ,KAAK,IAAI,EAAE,CAAC;QACpB,IAAI,CACA,IAAI,CAAC,IAAI,EACT,gBAAgB,QAAQ,CAAC,IAAI,CAAC,IAAI,0EAA0E,EAC5G,QAAQ,CAAC,IAAI,CAAC,IAAI,EAClB,QAAQ,CAAC,MAAM,GAAG,QAAQ,CAAC,SAAS,CACvC,CAAC;IACN,CAAC;IACD,MAAM,SAAS,GAAG,QAAQ,CAAC,KAAK,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC;IACjD,IAAI,SAAS,KAAK,IAAI,EAAE,CAAC;QACrB,IAAI,CACA,IAAI,CAAC,IAAI,EACT,gBAAgB,SAAS,CAAC,IAAI,CAAC,IAAI,2BAA2B,IAAI,CAAC,QAAQ,qCAAqC,EAChH,SAAS,CAAC,IAAI,CAAC,IAAI,EACnB,SAAS,CAAC,MAAM,GAAG,SAAS,CAAC,SAAS,CACzC,CAAC;IACN,CAAC;IACD,IAAI,KAAK,KAAK,IAAI,IAAI,IAAI,CAAC,YAAY,EAAE,CAAC;QACtC,IAAI,CACA,iBAAiB,EACjB,+EAA+E,EAC/E,MAAM,EACN,KAAK,CAAC,MAAM,GAAG,KAAK,CAAC,SAAS,CACjC,CAAC;IACN,CAAC;AACL,CAAC;AAED;;;;;;;GAOG;AACH,SAAS,YAAY,CAAC,GAAa,EAAE,KAAoB,EAAE,IAAmB;IAC1E,MAAM,OAAO,GAAG,KAAK,KAAK,IAAI,IAAI,GAAG,CAAC,MAAM,KAAK,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC;IACjE,OAAO,OAAO,IAAI,CAAC,IAAI,KAAK,IAAI,IAAI,GAAG,CAAC,MAAM,KAAK,IAAI,CAAC,IAAI,CAAC,IAAI,IAAI,MAAM,CAAC,IAAI,CAAC,CAAC,CAAC;AACvF,CAAC;AAED;;;;;;;;;GASG;AACH,MAAM,UAAU,gBAAgB,CAC5B,QAAuB,EACvB,IAAuB,EACvB,SAAqB,EACrB,OAA0B,EAC1B,IAAY;IAEZ,MAAM,MAAM,GAAG;QACX;YACI,MAAM;YACN,QAAQ,CAAC,KAAK;YACd,CAAC,CAAS,EAAW,EAAE,CACnB,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC;gBAC5B,CAAC,CAAC,CAAC,IAAI,CAAC,IAAI,KAAK,kBAAkB,IAAI,SAAS,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,EAAE,CAAC,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC;SAC9F;QACD,CAAC,MAAM,EAAE,QAAQ,CAAC,KAAK,EAAE,CAAC,CAAS,EAAW,EAAE,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC;KAC3E,CAAC;IACX,KAAK,MAAM,CAAC,MAAM,EAAE,KAAK,EAAE,IAAI,CAAC,IAAI,MAAM,EAAE,CAAC;QACzC,KAAK,MAAM,MAAM,IAAI,KAAK,EAAE,CAAC;YACzB,MAAM,EAAE,IAAI,EAAE,IAAI,EAAE,GAAG,MAAM,CAAC,IAAI,CAAC;YACnC,IACI,CAAC,IAAI,KAAK,IAAI,IAAI,CAAC,eAAe,CAAC,GAAG,CAAC,IAAI,CAAC,IAAI,CAAC,MAAM,KAAK,MAAM,IAAI,IAAI,KAAK,IAAI,CAAC,CAAC,CAAC;gBACtF,IAAI,CAAC,MAAM,CAAC,EACd,CAAC;gBACC,SAAS;YACb,CAAC;YACD,IAAI,CAAC,IAAI,CAAC,YAAY,EAAE,GAAG,MAAM,YAAY,IAAI,+CAA+C,EAAE,IAAI,EAAE,CAAC,CAAC,CAAC;QAC/G,CAAC;IACL,CAAC;AACL,CAAC;AAED;;;;;;;GAOG;AACH,MAAM,UAAU,kBAAkB,CAAC,IAAY,EAAE,MAAc,EAAE,IAAuB,EAAE,GAAW;IACjG,MAAM,KAAK,GAAG,IAAI,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC;IACzD,IAAI,KAAK,KAAK,CAAC,EAAE,CAAC;QACd,OAAO;IACX,CAAC;IACD,MAAM,IAAI,GAAG,MAAM,CAAC,IAAI,CAAC,IAAI,KAAK,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,SAAS,MAAM,CAAC,IAAI,CAAC,IAAI,gBAAgB,CAAC;IACxF,IAAI,CACA,6BAA6B,EAC7B,gBAAgB,MAAM,CAAC,IAAI,CAAC,IAAI,mBAAmB,GAAG,0EAA0E,IAAI,EAAE,EACtI,MAAM,CAAC,IAAI,CAAC,IAAI,EAChB,KAAK,CACR,CAAC;AACN,CAAC"}

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

@@ -18,34 +18,55 @@ interface OboColumnSpec {
  * The node columns of the OBO vocabulary, keyed by column name (design section 4.2). The names are
  * the OBO tag names, so a Gene Ontology user finds `namespace`, `def` and `is_obsolete` under the
  * names the GO documentation uses.
+ * @category Plugin helpers
  */
 export declare const OBO_NODE_COLUMNS: Readonly<Record<string, OboColumnSpec>>;
-/** The node column that marks a node made for an undeclared reference (design section 4.2). */
+/**
+ * The node column that marks a node made for an undeclared reference (design section 4.2).
+ * @category Plugin helpers
+ */
 export declare const PLACEHOLDER_COLUMN = "graphty.placeholder";
 /**
  * The declaration of an OBO vocabulary column.
  * @param domain - node or edge
  * @param name - the column name (a key of OBO_NODE_COLUMNS / OBO_EDGE_COLUMNS, or the placeholder column)
  * @returns the declaration, nullable, with origin `{ format: "obo", id: name }`
+ * @category Plugin helpers
  */
 export declare function oboColumnDecl(domain: "node" | "edge", name: string): ColumnDecl;
+/**
+ * The OBO PURL base every OBO Foundry IRI starts with.
+ * @category Plugin helpers
+ */
+export declare const OBO_PURL = "http://purl.obolibrary.org/obo/";
+/**
+ * The oboInOwl namespace of the OBO-to-OWL mapping's annotation properties.
+ * @category Plugin helpers
+ */
+export declare const OBO_IN_OWL = "http://www.geneontology.org/formats/oboInOwl#";
 /**
  * An IRI as the identifier the `.obo` file writes (the OBO 1.4 mapping, section 5.9, read
  * backwards): `http://purl.obolibrary.org/obo/GO_0008150` is `GO:0008150` (the prefix is the text
  * before the first underscore), and `http://purl.obolibrary.org/obo/go#regulates` (how the OWL
- * translation writes an unprefixed OBO id: subsets, relations, synonym types) is `regulates`.
+ * translation writes an unprefixed OBO id: subsets, relations, synonym types) is `regulates`; the
+ * same under `https://purl.obolibrary.org/obo/`.
  * Every other IRI, and an OBO PURL that fits neither form (`.../obo/T/Female`), is kept.
  * @param iri - the IRI
  * @returns the CURIE or local id, or the IRI unchanged
+ * @category Plugin helpers
  */
 export declare function compactOboIri(iri: string): string;
-/** The OBO synonym scopes. */
+/**
+ * The OBO synonym scopes.
+ * @category Plugin helpers
+ */
 export declare const SYNONYM_SCOPES: ReadonlySet<string>;
 /**
  * The OBO synonym scope of an OBO Graphs synonym predicate (`hasExactSynonym`, with or without the
  * oboInOwl namespace).
  * @param pred - the predicate
  * @returns the scope, or null for a predicate that is not one of the four
+ * @category Plugin helpers
  */
 export declare function synonymScopeOf(pred: string): string | null;
 /**
@@ -53,6 +74,7 @@ export declare function synonymScopeOf(pred: string): string | null;
  * the tags that are annotations), so the `.json` of an ontology fills the same columns as its
  * `.obo`. `shorthand` is the relation's short name; every predicate not listed is a
  * `property_value`.
+ * @category Plugin helpers
  */
 export declare const OBOGRAPHS_PREDICATE_TAGS: ReadonlyMap<string, string>;
 export {};

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

@@ -1 +1 @@
-{"version":3,"file":"ontology.d.ts","sourceRoot":"","sources":["../../../src/common/ontology.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAEH,OAAO,EAAE,KAAK,UAAU,EAAE,MAAM,uBAAuB,CAAC;AAExD,0CAA0C;AAC1C,KAAK,QAAQ,GAAG,QAAQ,GAAG,MAAM,GAAG,MAAM,GAAG,MAAM,GAAG,MAAM,CAAC;AAE7D,wCAAwC;AACxC,UAAU,aAAa;IACnB,iBAAiB;IACjB,QAAQ,CAAC,KAAK,EAAE,QAAQ,CAAC;IACzB,6CAA6C;IAC7C,QAAQ,CAAC,IAAI,CAAC,EAAE,OAAO,GAAG,MAAM,GAAG,SAAS,CAAC;CAChD;AAED;;;;GAIG;AACH,eAAO,MAAM,gBAAgB,EAAE,QAAQ,CAAC,MAAM,CAAC,MAAM,EAAE,aAAa,CAAC,CAiDnE,CAAC;AASH,+FAA+F;AAC/F,eAAO,MAAM,kBAAkB,wBAAwB,CAAC;AAExD;;;;;GAKG;AACH,wBAAgB,aAAa,CAAC,MAAM,EAAE,MAAM,GAAG,MAAM,EAAE,IAAI,EAAE,MAAM,GAAG,UAAU,CAa/E;AAQD;;;;;;;;GAQG;AACH,wBAAgB,aAAa,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAejD;AAED,8BAA8B;AAC9B,eAAO,MAAM,cAAc,EAAE,WAAW,CAAC,MAAM,CAAoD,CAAC;AAEpG;;;;;GAKG;AACH,wBAAgB,cAAc,CAAC,IAAI,EAAE,MAAM,GAAG,MAAM,GAAG,IAAI,CAI1D;AAED;;;;;GAKG;AACH,eAAO,MAAM,wBAAwB,EAAE,WAAW,CAAC,MAAM,EAAE,MAAM,CAQ/D,CAAC"}
+{"version":3,"file":"ontology.d.ts","sourceRoot":"","sources":["../../../src/common/ontology.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAEH,OAAO,EAAE,KAAK,UAAU,EAAE,MAAM,uBAAuB,CAAC;AAExD,0CAA0C;AAC1C,KAAK,QAAQ,GAAG,QAAQ,GAAG,MAAM,GAAG,MAAM,GAAG,MAAM,GAAG,MAAM,CAAC;AAE7D,wCAAwC;AACxC,UAAU,aAAa;IACnB,iBAAiB;IACjB,QAAQ,CAAC,KAAK,EAAE,QAAQ,CAAC;IACzB,6CAA6C;IAC7C,QAAQ,CAAC,IAAI,CAAC,EAAE,OAAO,GAAG,MAAM,GAAG,SAAS,CAAC;CAChD;AAED;;;;;GAKG;AACH,eAAO,MAAM,gBAAgB,EAAE,QAAQ,CAAC,MAAM,CAAC,MAAM,EAAE,aAAa,CAAC,CAiDnE,CAAC;AASH;;;GAGG;AACH,eAAO,MAAM,kBAAkB,wBAAwB,CAAC;AAExD;;;;;;GAMG;AACH,wBAAgB,aAAa,CAAC,MAAM,EAAE,MAAM,GAAG,MAAM,EAAE,IAAI,EAAE,MAAM,GAAG,UAAU,CAa/E;AAED;;;GAGG;AACH,eAAO,MAAM,QAAQ,oCAAoC,CAAC;AAK1D;;;GAGG;AACH,eAAO,MAAM,UAAU,kDAAkD,CAAC;AAE1E;;;;;;;;;;GAUG;AACH,wBAAgB,aAAa,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAgBjD;AAED;;;GAGG;AACH,eAAO,MAAM,cAAc,EAAE,WAAW,CAAC,MAAM,CAAoD,CAAC;AAEpG;;;;;;GAMG;AACH,wBAAgB,cAAc,CAAC,IAAI,EAAE,MAAM,GAAG,MAAM,GAAG,IAAI,CAI1D;AAED;;;;;;GAMG;AACH,eAAO,MAAM,wBAAwB,EAAE,WAAW,CAAC,MAAM,EAAE,MAAM,CAQ/D,CAAC"}