@graphty/graph-io 0.3.18 → 0.3.20

package/dist/src/formats/xgmml/columns.d.ts

@@ -0,0 +1,152 @@
+/**
+ * The attribute columns of one XGMML (or `.cys`) import: every att and every untyped XML
+ * attribute is parsed by its own declared kind when it is read, then each column's dtype is
+ * decided once over all its values (design section 5.1 widening: int and long to f64, numbers
+ * and booleans to string, lists and scalars to json), and only then declared on the sink, so a
+ * column is never re-typed after rows were written and a caller's sink needs no widening call.
+ */
+import { type GraphSink } from "@graphty/graph-format";
+import { type ImportReportBuilder, type IssueLocation } from "../../common/report.js";
+import { type AttRec } from "./document.js";
+/** A table of the snapshot. */
+type Domain = "node" | "edge" | "graph";
+/** Options of a column set. */
+interface ColumnSetOptions {
+    /** Decode Cytoscape's `\n` / `\t` escapes in string values. */
+    readonly unescape: boolean;
+    /** The importer's `long` option. */
+    readonly long: "f64" | "string";
+    /** The column names the importer's own columns hold; an att of one of these names is renamed. */
+    readonly reserved: ReadonlySet<string>;
+}
+/**
+ * Collects the attribute values of one table, then declares and writes the columns.
+ */
+export declare class ColumnSet {
+    private readonly domain;
+    private readonly report;
+    private readonly options;
+    private readonly plans;
+    /**
+     * Create a column set.
+     * @param domain - the table
+     * @param report - the report
+     * @param options - the options
+     */
+    constructor(domain: Domain, report: ImportReportBuilder, options: ColumnSetOptions);
+    /**
+     * Whether a column of that name (any namespace) was collected.
+     * @param name - the name
+     * @returns true when some row has a value or the column was declared
+     */
+    has(name: string): boolean;
+    /**
+     * Add one att of a row: parse it by its declared kind (E_BAD_VALUE for a value that does not
+     * parse; the cell stays unset). A second value of the same column on one row wins with
+     * W_DUPLICATE_ATTRIBUTE.
+     * @param row - the row
+     * @param att - the att
+     * @param where - the element, for issues
+     */
+    addAtt(row: number, att: AttRec, where: IssueLocation): void;
+    /**
+     * Add one value read by the 5.1 text grammar (an XML attribute of an element).
+     * @param row - the row
+     * @param name - the column name
+     * @param text - the text
+     * @param where - the element, for issues
+     */
+    addText(row: number, name: string, text: string, where: IssueLocation): void;
+    /**
+     * Add one value of a known kind (a typed table cell of a session).
+     * @param row - the row
+     * @param name - the column name
+     * @param value - the value
+     * @param where - the element, for issues
+     */
+    addJson(row: number, name: string, value: unknown, where: IssueLocation): void;
+    /**
+     * Declare every collected column on the sink and write its values.
+     * @param sink - the sink
+     * @param rowIndex - the sink index of a row (node or edge index), or -1 when the row was not added
+     */
+    write(sink: GraphSink, rowIndex: (row: number) => number): void;
+    /**
+     * The plan of a column, created on first use.
+     * @param name - the attribute name
+     * @param namespace - the table namespace, or null
+     * @returns the plan
+     */
+    private plan;
+    /**
+     * Store a cell, reporting a second value on the same row.
+     * @param plan - the column
+     * @param row - the row
+     * @param cell - the cell
+     * @param where - the location
+     */
+    private set;
+    /**
+     * Parse a scalar att.
+     * @param att - the att
+     * @param kind - the declared kind
+     * @param plan - the column
+     * @param at - the location
+     * @returns the cell, or null when unset or invalid
+     */
+    private scalarAtt;
+    /**
+     * Parse a list att: items by `cy:elementType`, else by the widened kinds of the children.
+     * A list of lists, a list with records, or a list of named fields is a json value.
+     * @param att - the att
+     * @param name - the column name
+     * @param plan - the column (an item beyond i32 widens it, as a scalar does)
+     * @param at - the location
+     * @returns the cell
+     */
+    private listCell;
+    /**
+     * Decide one column's dtype, declare it and write its values.
+     * @param sink - the sink
+     * @param plan - the column
+     * @param name - the name to declare it under
+     * @param rowIndex - the row to sink index map
+     */
+    private writePlan;
+    /**
+     * The dtype of a column from its cells, with the widening and precision warnings.
+     * @param plan - the column
+     * @param cells - its cells
+     * @returns the decision
+     */
+    private decide;
+    /**
+     * The scalar decision of a column.
+     * @param plan - the column
+     * @param cells - its cells
+     * @returns the decision
+     */
+    private decideScalar;
+    /**
+     * Report a malformed att, once per kind of defect.
+     * @param message - the message
+     * @param att - the att
+     * @param kind - the defect, for the once key
+     */
+    private badAtt;
+    /**
+     * Report a value that does not parse as its declared kind (an error; the cell stays unset).
+     * @param text - the value
+     * @param kind - the kind
+     * @param at - the location
+     */
+    private badValue;
+    /**
+     * Report a record list, list of lists, map or foreign XML kept as json, once.
+     * @param message - the message
+     * @param at - the location
+     */
+    private recordList;
+}
+export {};
+//# sourceMappingURL=columns.d.ts.map

package/dist/src/formats/xgmml/columns.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"columns.d.ts","sourceRoot":"","sources":["../../../../src/formats/xgmml/columns.ts"],"names":[],"mappings":"AAAA;;;;;;GAMG;AAEH,OAAO,EAA+B,KAAK,SAAS,EAAoB,MAAM,uBAAuB,CAAC;AAGtG,OAAO,EAAE,KAAK,mBAAmB,EAAE,KAAK,aAAa,EAAE,MAAM,wBAAwB,CAAC;AAGtF,OAAO,EAAE,KAAK,MAAM,EAAc,MAAM,eAAe,CAAC;AAGxD,+BAA+B;AAC/B,KAAK,MAAM,GAAG,MAAM,GAAG,MAAM,GAAG,OAAO,CAAC;AAuCxC,+BAA+B;AAC/B,UAAU,gBAAgB;IACtB,+DAA+D;IAC/D,QAAQ,CAAC,QAAQ,EAAE,OAAO,CAAC;IAC3B,oCAAoC;IACpC,QAAQ,CAAC,IAAI,EAAE,KAAK,GAAG,QAAQ,CAAC;IAChC,iGAAiG;IACjG,QAAQ,CAAC,QAAQ,EAAE,WAAW,CAAC,MAAM,CAAC,CAAC;CAC1C;AAWD;;GAEG;AACH,qBAAa,SAAS;IAClB,OAAO,CAAC,QAAQ,CAAC,MAAM,CAAS;IAEhC,OAAO,CAAC,QAAQ,CAAC,MAAM,CAAsB;IAE7C,OAAO,CAAC,QAAQ,CAAC,OAAO,CAAmB;IAE3C,OAAO,CAAC,QAAQ,CAAC,KAAK,CAA2B;IAEjD;;;;;OAKG;gBACS,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,mBAAmB,EAAE,OAAO,EAAE,gBAAgB;IAMlF;;;;OAIG;IACH,GAAG,CAAC,IAAI,EAAE,MAAM,GAAG,OAAO;IAI1B;;;;;;;OAOG;IACH,MAAM,CAAC,GAAG,EAAE,MAAM,EAAE,GAAG,EAAE,MAAM,EAAE,KAAK,EAAE,aAAa,GAAG,IAAI;IAoD5D;;;;;;OAMG;IACH,OAAO,CAAC,GAAG,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,EAAE,KAAK,EAAE,aAAa,GAAG,IAAI;IAO5E;;;;;;OAMG;IACH,OAAO,CAAC,GAAG,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,EAAE,KAAK,EAAE,OAAO,EAAE,KAAK,EAAE,aAAa,GAAG,IAAI;IAI9E;;;;OAIG;IACH,KAAK,CAAC,IAAI,EAAE,SAAS,EAAE,QAAQ,EAAE,CAAC,GAAG,EAAE,MAAM,KAAK,MAAM,GAAG,IAAI;IAuB/D;;;;;OAKG;IACH,OAAO,CAAC,IAAI;IAsBZ;;;;;;OAMG;IACH,OAAO,CAAC,GAAG;IAeX;;;;;;;OAOG;IACH,OAAO,CAAC,SAAS;IA4BjB;;;;;;;;OAQG;IACH,OAAO,CAAC,QAAQ;IAqDhB;;;;;;OAMG;IACH,OAAO,CAAC,SAAS;IAkEjB;;;;;OAKG;IACH,OAAO,CAAC,MAAM;IA0Dd;;;;;OAKG;IACH,OAAO,CAAC,YAAY;IA8BpB;;;;;OAKG;IACH,OAAO,CAAC,MAAM;IAUd;;;;;OAKG;IACH,OAAO,CAAC,QAAQ;IAShB;;;;OAIG;IACH,OAAO,CAAC,UAAU;CAGrB"}