@graphty/graph-io 0.3.43 → 0.3.45

package/dist/src/styles/codes.js

@@ -0,0 +1,97 @@
+/**
+ * The codes of every style condition graph-io reports: the notes attached to a file's styles (`W_STYLE_*`), the
+ * import and export report codes about styles as a whole (`W_STYLES_*`), and the one error (`E_STYLES_MISMATCH`).
+ */
+import { STYLES_NOT_IMPORTED_CODE } from "../common/codes.js";
+/**
+ * Every style code by name. A key is the code without its `E_` / `W_` and `STYLE_` / `STYLES_` prefixes. Every style
+ * condition is a warning except `MISMATCH`; none counts toward an import's `errorLimit`.
+ * @category Styles
+ */
+export const STYLE_ISSUE = Object.freeze({
+    // ------------------------------------------------ reading values
+    /** A value longer than 256 characters was not parsed. */
+    VALUE_TOO_LONG: "W_STYLE_VALUE_TOO_LONG",
+    /** A value does not parse in the file's dialect (an unknown color name, a non-number, a negative length). */
+    BAD_VALUE: "W_STYLE_BAD_VALUE",
+    /** An enumeration value the vocabulary has no name for; kept as `other:<value>`. */
+    UNKNOWN_VALUE: "W_STYLE_UNKNOWN_VALUE",
+    /** A color's alpha was dropped because the property has no opacity to carry it. */
+    ALPHA_DROPPED: "W_STYLE_ALPHA_DROPPED",
+    /** A list of colors where one color is expected; the tool draws it its own way and the first is not taken. */
+    COLOR_LIST: "W_STYLE_COLOR_LIST",
+    /** A gradient fill; its first color is kept. */
+    GRADIENT: "W_STYLE_GRADIENT",
+    /** A node the tool draws unfilled although the file gives it a fill color. */
+    UNFILLED: "W_STYLE_UNFILLED",
+    /** A node fill the file marks as transparent or absent. */
+    NO_FILL: "W_STYLE_NO_FILL",
+    /** An edge stroke the file marks as absent. */
+    NO_STROKE: "W_STYLE_NO_STROKE",
+    /** The tool grows a node to fit its label, so the stated size is a minimum. */
+    SIZE_MINIMUM: "W_STYLE_SIZE_MINIMUM",
+    /** An HTML-like label: its text is kept and its markup dropped. */
+    HTML_LABEL: "W_STYLE_HTML_LABEL",
+    /** A record label: its fields are joined with " | ". */
+    RECORD_LABEL: "W_STYLE_RECORD_LABEL",
+    /** An element carries more than one label; the first is kept. */
+    EXTRA_LABELS: "W_STYLE_EXTRA_LABELS",
+    /** A color that inherits from the edge's ends in a way the vocabulary cannot express. */
+    INHERIT_COLOR: "W_STYLE_INHERIT_COLOR",
+    /** A style property the vocabulary has no counterpart for was not carried. */
+    NOT_CARRIED: "W_STYLE_NOT_CARRIED",
+    // ------------------------------------------------ reading declared styles
+    /** A declared mapping that cannot be read. */
+    BAD_MAPPING: "W_STYLE_BAD_MAPPING",
+    /** A declared mapping reads a column the file does not have. */
+    MAPPING_COLUMN_MISSING: "W_STYLE_MAPPING_COLUMN_MISSING",
+    /** References between style records that are circular or too deep; the rest are read. */
+    REFERENCE_CYCLE: "W_STYLE_REFERENCE_CYCLE",
+    /** A style reference that names nothing in the file. */
+    UNRESOLVED: "W_STYLE_UNRESOLVED",
+    /** Style structures nested deeper than graph-io reads. */
+    NESTING: "W_STYLE_NESTING",
+    /** A style section that cannot be read at all. */
+    UNREADABLE: "W_STYLE_UNREADABLE",
+    /** A Cytoscape session without its visual styles; the tool's fallbacks apply. */
+    NO_VIZMAP: "W_STYLE_NO_VIZMAP",
+    /** The view names a visual style the file does not hold. */
+    VIEW_STYLE_MISSING: "W_STYLE_VIEW_STYLE_MISSING",
+    /** The file holds more visual styles than the one its view uses; the others are not read. */
+    OTHER_STYLES: "W_STYLE_OTHER_STYLES",
+    /** The file holds more views than one; only the first view's styles are read. */
+    OTHER_VIEWS: "W_STYLE_OTHER_VIEWS",
+    /** A selector the tool treats as invalid, which matches every element there. */
+    SELECTOR: "W_STYLE_SELECTOR",
+    /** A selector a short predicate cannot express; its members are marked on the elements instead. */
+    SELECTOR_AS_COLUMN: "W_STYLE_SELECTOR_AS_COLUMN",
+    /** A selector state that changes while the tool runs (selected, hovered), evaluated as at load. */
+    STATE_ASSUMED: "W_STYLE_STATE_ASSUMED",
+    // ------------------------------------------------ planning
+    /** A continuous mapping matches the file's values only within the tool's rounding. */
+    RAMP_ROUNDED: "W_STYLE_RAMP_ROUNDED",
+    /** Rules were folded into a copy to keep the number of rules per kind bounded. */
+    LAYER_CAP: "W_STYLE_LAYER_CAP",
+    /** The counted work budget ran out; the values not yet explained are copied per element. */
+    BUDGET: "W_STYLE_BUDGET",
+    // ------------------------------------------------ graphty's own block
+    /** A `graphty.styles` block was ignored, with a reason code; the file is read like any other. */
+    BLOCK_IGNORED: "W_STYLE_BLOCK_IGNORED",
+    // ------------------------------------------------ export
+    /** The format has no place for this property; it is not written. */
+    NOT_WRITTEN: "W_STYLE_NOT_WRITTEN",
+    /** Written as the nearest value the format allows. */
+    APPROXIMATED: "W_STYLE_APPROXIMATED",
+    /** Per-element values were written but not the rules; importing the file infers them again. */
+    RULES_NOT_KEPT: "W_STYLE_RULES_NOT_KEPT",
+    /** A style was written as its per-element values and lost its editable form, with a reason code. */
+    LAYER_FLATTENED: "W_STYLE_LAYER_FLATTENED",
+    // ------------------------------------------------ styles as a whole
+    /** The file holds styles that were not imported; import them with the `styles` option. */
+    NOT_IMPORTED: STYLES_NOT_IMPORTED_CODE,
+    /** The graph has styles that were not exported; export them with the `styles` option. */
+    NOT_EXPORTED: "W_STYLES_NOT_EXPORTED",
+    /** The styles were read from or built for a different graph; nothing is written. */
+    MISMATCH: "E_STYLES_MISMATCH",
+});
+//# sourceMappingURL=codes.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"codes.js","sourceRoot":"","sources":["../../../src/styles/codes.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,EAAE,wBAAwB,EAAE,MAAM,oBAAoB,CAAC;AAE9D;;;;GAIG;AACH,MAAM,CAAC,MAAM,WAAW,GAAG,MAAM,CAAC,MAAM,CAAC;IACrC,kEAAkE;IAClE,yDAAyD;IACzD,cAAc,EAAE,wBAAwB;IACxC,6GAA6G;IAC7G,SAAS,EAAE,mBAAmB;IAC9B,oFAAoF;IACpF,aAAa,EAAE,uBAAuB;IACtC,mFAAmF;IACnF,aAAa,EAAE,uBAAuB;IACtC,8GAA8G;IAC9G,UAAU,EAAE,oBAAoB;IAChC,gDAAgD;IAChD,QAAQ,EAAE,kBAAkB;IAC5B,8EAA8E;IAC9E,QAAQ,EAAE,kBAAkB;IAC5B,2DAA2D;IAC3D,OAAO,EAAE,iBAAiB;IAC1B,+CAA+C;IAC/C,SAAS,EAAE,mBAAmB;IAC9B,+EAA+E;IAC/E,YAAY,EAAE,sBAAsB;IACpC,mEAAmE;IACnE,UAAU,EAAE,oBAAoB;IAChC,wDAAwD;IACxD,YAAY,EAAE,sBAAsB;IACpC,iEAAiE;IACjE,YAAY,EAAE,sBAAsB;IACpC,yFAAyF;IACzF,aAAa,EAAE,uBAAuB;IACtC,8EAA8E;IAC9E,WAAW,EAAE,qBAAqB;IAClC,2EAA2E;IAC3E,8CAA8C;IAC9C,WAAW,EAAE,qBAAqB;IAClC,gEAAgE;IAChE,sBAAsB,EAAE,gCAAgC;IACxD,yFAAyF;IACzF,eAAe,EAAE,yBAAyB;IAC1C,wDAAwD;IACxD,UAAU,EAAE,oBAAoB;IAChC,0DAA0D;IAC1D,OAAO,EAAE,iBAAiB;IAC1B,kDAAkD;IAClD,UAAU,EAAE,oBAAoB;IAChC,iFAAiF;IACjF,SAAS,EAAE,mBAAmB;IAC9B,4DAA4D;IAC5D,kBAAkB,EAAE,4BAA4B;IAChD,6FAA6F;IAC7F,YAAY,EAAE,sBAAsB;IACpC,iFAAiF;IACjF,WAAW,EAAE,qBAAqB;IAClC,gFAAgF;IAChF,QAAQ,EAAE,kBAAkB;IAC5B,mGAAmG;IACnG,kBAAkB,EAAE,4BAA4B;IAChD,mGAAmG;IACnG,aAAa,EAAE,uBAAuB;IACtC,4DAA4D;IAC5D,sFAAsF;IACtF,YAAY,EAAE,sBAAsB;IACpC,kFAAkF;IAClF,SAAS,EAAE,mBAAmB;IAC9B,4FAA4F;IAC5F,MAAM,EAAE,gBAAgB;IACxB,uEAAuE;IACvE,iGAAiG;IACjG,aAAa,EAAE,uBAAuB;IACtC,0DAA0D;IAC1D,oEAAoE;IACpE,WAAW,EAAE,qBAAqB;IAClC,sDAAsD;IACtD,YAAY,EAAE,sBAAsB;IACpC,+FAA+F;IAC/F,cAAc,EAAE,wBAAwB;IACxC,oGAAoG;IACpG,eAAe,EAAE,yBAAyB;IAC1C,qEAAqE;IACrE,0FAA0F;IAC1F,YAAY,EAAE,wBAAwB;IACtC,yFAAyF;IACzF,YAAY,EAAE,uBAAuB;IACrC,oFAAoF;IACpF,QAAQ,EAAE,mBAAmB;CAChC,CAAC,CAAC"}

package/dist/src/styles/cyjs/cascade.d.ts

@@ -0,0 +1,134 @@
+/**
+ * The Cytoscape.js style engine: a stylesheet applied to the raw element JSON the way Cytoscape.js 3.34 applies it,
+ * giving what Cytoscape.js draws for every node and edge, and the stylesheet's rules as neutral rules.
+ *
+ * - Elements are taken as `cy.add()` takes them: nodes first, ids made text, duplicates and edges to missing nodes
+ *   dropped, compound parents linked without cycles.
+ * - Comparisons read the RAW element data (a field of mixed types is compared with `===`, not as graph-io's column
+ *   holds it), and a dotted field reads a nested path.
+ * - Beneath the file's rules lie Cytoscape.js's own default rules (edges 3px wide, compound parents gray rectangles,
+ *   selected elements blue); per property the last matching rule wins; a mapper that fails resets the property to
+ *   its Cytoscape.js default; an element's own `style` is a bypass over every rule.
+ * - Every selector is evaluated through indexes (class, id, value) where one test decides, so a sheet of 20,000
+ *   per-value rules or a selector of 100,000 class tests costs one pass over the elements it names. Every step spends
+ *   from the extraction's one counted budget.
+ *
+ * The rules: a selector a short predicate expresses exactly over graph-io's columns becomes that predicate; any other
+ * becomes a membership style column (`member.<n>`) with a short `has` test. A run of three or more rules that each
+ * test one class, one id or one value of the same field and only set values becomes ONE mapping rule over a winner
+ * column. A `data()` or `mapData()` mapper becomes a passthrough or continuous mapping when graph-io's column gives
+ * exactly Cytoscape.js's values, else the mapper's per-element values as a style column.
+ */
+import type { GraphSnapshot } from "@graphty/graph-format";
+import { StyleNotes } from "../notes.js";
+import type { ImporterStyles, StyleColumn, StyleRule, StyleWorkBudget } from "../types.js";
+/** One element as a Cytoscape.js core holds it. */
+export interface CyjsElement {
+    /** The element's JSON as given. */
+    readonly json: Readonly<Record<string, unknown>>;
+    /** Its `data` object as given. */
+    readonly data: Readonly<Record<string, unknown>>;
+    /** Fields Cytoscape.js rewrites on add: an id made text or generated, endpoints and parent made text. */
+    readonly overrides: ReadonlyMap<string, unknown>;
+    /** The id. */
+    readonly id: string;
+    /** The classes. */
+    readonly classes: ReadonlySet<unknown>;
+    /** `:selected`. */
+    readonly selected: boolean;
+    /** `:selectable`. */
+    readonly selectable: boolean;
+    /** `:locked`. */
+    readonly locked: boolean;
+    /** `:grabbable`. */
+    readonly grabbable: boolean;
+}
+/** The elements of a Cytoscape.js core, with their links. */
+export interface CyjsGraph {
+    /** Nodes in the order the core holds them. */
+    readonly nodes: readonly CyjsElement[];
+    /** Edges in the order the core holds them. */
+    readonly edges: readonly CyjsElement[];
+    /** Each edge's source node. */
+    readonly source: Int32Array;
+    /** Each edge's target node. */
+    readonly target: Int32Array;
+    /** Each node's compound parent, or -1. */
+    readonly parent: Int32Array;
+    /** Each node's children. */
+    readonly children: readonly (readonly number[])[];
+    /** Each node's incident edges (a loop once). */
+    readonly incident: readonly (readonly number[])[];
+}
+/**
+ * The elements a Cytoscape.js core holds after `cy.add(elements)`.
+ * @param elements - an array of element JSON, or `{ nodes, edges }`
+ * @returns the elements and their links
+ */
+export declare function cyjsGraph(elements: unknown): CyjsGraph;
+/** One target's result. */
+export interface CyjsTargetStyles {
+    /** The element count (in snapshot order when a snapshot was given). */
+    readonly n: number;
+    /** What Cytoscape.js draws, per neutral property, by element index. */
+    readonly values: Partial<Record<string, StyleColumn>>;
+    /** The stylesheet's rules, bottom to top. */
+    readonly rules: StyleRule[];
+    /** The style columns the rules read. */
+    readonly columns: Map<string, StyleColumn>;
+    /** The data columns the rules or the values were read from. */
+    readonly rawColumns: string[];
+    /** Each element's Cytoscape.js element, by index (null where the core holds none). */
+    readonly elements: readonly (CyjsElement | null)[];
+}
+/** The input of the engine. */
+export interface CyjsStyleInput {
+    /** The elements: an array of element JSON, or `{ nodes, edges }`. */
+    readonly elements: unknown;
+    /** The stylesheet: an array of `{ selector, style }` (or `css`), or a stylesheet written as text. */
+    readonly style: unknown;
+    /**
+     * The graph the styles are for. Elements are matched to its nodes by id and to its edges in order, and the
+     * values come out indexed like it; its columns let a selector or a mapper become a predicate or a mapping over
+     * graph-io's columns. Without it, values are indexed like the core holds the elements.
+     */
+    readonly snapshot?: GraphSnapshot;
+    /** Whether Cytoscape.js's own default rules (edges 3px wide, gray compound parents) are applied; default true. */
+    readonly toolDefaults?: boolean;
+    /**
+     * What a live core draws, per element JSON object (`ele.style()` beside `ele.json()`): taken as the truth over what
+     * the stylesheet gives, and the only source for a property whose stylesheet value is a function.
+     */
+    readonly rendered?: ReadonlyMap<object, Readonly<Record<string, unknown>>>;
+    /** Where problems are noted. */
+    readonly notes?: StyleNotes;
+    /** The counted work budget. */
+    readonly budget?: StyleWorkBudget;
+    /** Cancels the work. */
+    readonly signal?: AbortSignal;
+}
+/** The engine's result. */
+export interface CyjsStyles {
+    /** Nodes. */
+    readonly node: CyjsTargetStyles;
+    /** Edges. */
+    readonly edge: CyjsTargetStyles;
+    /** The elements as the core holds them. */
+    readonly graph: CyjsGraph;
+}
+/**
+ * Applies a Cytoscape.js stylesheet to its elements as Cytoscape.js 3.34 does.
+ * @param input - the elements, the stylesheet, the graph and the options
+ * @returns what is drawn per element and the stylesheet's rules, per target
+ */
+export declare function evaluateCytoscapeJs(input: CyjsStyleInput): CyjsStyles;
+/**
+ * A Cytoscape.js file's styles as an importer's `styles()` returns them: what Cytoscape.js draws per element and the
+ * stylesheet's rules, with Cytoscape.js as the writing tool whose defaults fill what the stylesheet leaves unset.
+ * @param input - the elements, the stylesheet, the graph and the options
+ * @returns the styles for graph-io's planner
+ */
+export declare function cytoscapeJsStyles(input: CyjsStyleInput & {
+    readonly snapshot: GraphSnapshot;
+}): ImporterStyles;
+//# sourceMappingURL=cascade.d.ts.map

package/dist/src/styles/cyjs/cascade.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"cascade.d.ts","sourceRoot":"","sources":["../../../../src/styles/cyjs/cascade.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;GAoBG;AAEH,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,uBAAuB,CAAC;AAK3D,OAAO,EAAE,UAAU,EAAE,MAAM,aAAa,CAAC;AAEzC,OAAO,KAAK,EAGR,cAAc,EAKd,WAAW,EACX,SAAS,EAGT,eAAe,EAClB,MAAM,aAAa,CAAC;AAmBrB,mDAAmD;AACnD,MAAM,WAAW,WAAW;IACxB,mCAAmC;IACnC,QAAQ,CAAC,IAAI,EAAE,QAAQ,CAAC,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC,CAAC;IACjD,kCAAkC;IAClC,QAAQ,CAAC,IAAI,EAAE,QAAQ,CAAC,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC,CAAC;IACjD,yGAAyG;IACzG,QAAQ,CAAC,SAAS,EAAE,WAAW,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IACjD,cAAc;IACd,QAAQ,CAAC,EAAE,EAAE,MAAM,CAAC;IACpB,mBAAmB;IACnB,QAAQ,CAAC,OAAO,EAAE,WAAW,CAAC,OAAO,CAAC,CAAC;IACvC,mBAAmB;IACnB,QAAQ,CAAC,QAAQ,EAAE,OAAO,CAAC;IAC3B,qBAAqB;IACrB,QAAQ,CAAC,UAAU,EAAE,OAAO,CAAC;IAC7B,iBAAiB;IACjB,QAAQ,CAAC,MAAM,EAAE,OAAO,CAAC;IACzB,oBAAoB;IACpB,QAAQ,CAAC,SAAS,EAAE,OAAO,CAAC;CAC/B;AAED,6DAA6D;AAC7D,MAAM,WAAW,SAAS;IACtB,8CAA8C;IAC9C,QAAQ,CAAC,KAAK,EAAE,SAAS,WAAW,EAAE,CAAC;IACvC,8CAA8C;IAC9C,QAAQ,CAAC,KAAK,EAAE,SAAS,WAAW,EAAE,CAAC;IACvC,+BAA+B;IAC/B,QAAQ,CAAC,MAAM,EAAE,UAAU,CAAC;IAC5B,+BAA+B;IAC/B,QAAQ,CAAC,MAAM,EAAE,UAAU,CAAC;IAC5B,0CAA0C;IAC1C,QAAQ,CAAC,MAAM,EAAE,UAAU,CAAC;IAC5B,4BAA4B;IAC5B,QAAQ,CAAC,QAAQ,EAAE,SAAS,CAAC,SAAS,MAAM,EAAE,CAAC,EAAE,CAAC;IAClD,gDAAgD;IAChD,QAAQ,CAAC,QAAQ,EAAE,SAAS,CAAC,SAAS,MAAM,EAAE,CAAC,EAAE,CAAC;CACrD;AAqHD;;;;GAIG;AACH,wBAAgB,SAAS,CAAC,QAAQ,EAAE,OAAO,GAAG,SAAS,CA+CtD;AAqyBD,2BAA2B;AAC3B,MAAM,WAAW,gBAAgB;IAC7B,uEAAuE;IACvE,QAAQ,CAAC,CAAC,EAAE,MAAM,CAAC;IACnB,uEAAuE;IACvE,QAAQ,CAAC,MAAM,EAAE,OAAO,CAAC,MAAM,CAAC,MAAM,EAAE,WAAW,CAAC,CAAC,CAAC;IACtD,6CAA6C;IAC7C,QAAQ,CAAC,KAAK,EAAE,SAAS,EAAE,CAAC;IAC5B,wCAAwC;IACxC,QAAQ,CAAC,OAAO,EAAE,GAAG,CAAC,MAAM,EAAE,WAAW,CAAC,CAAC;IAC3C,+DAA+D;IAC/D,QAAQ,CAAC,UAAU,EAAE,MAAM,EAAE,CAAC;IAC9B,sFAAsF;IACtF,QAAQ,CAAC,QAAQ,EAAE,SAAS,CAAC,WAAW,GAAG,IAAI,CAAC,EAAE,CAAC;CACtD;AAED,+BAA+B;AAC/B,MAAM,WAAW,cAAc;IAC3B,qEAAqE;IACrE,QAAQ,CAAC,QAAQ,EAAE,OAAO,CAAC;IAC3B,qGAAqG;IACrG,QAAQ,CAAC,KAAK,EAAE,OAAO,CAAC;IACxB;;;;OAIG;IACH,QAAQ,CAAC,QAAQ,CAAC,EAAE,aAAa,CAAC;IAClC,kHAAkH;IAClH,QAAQ,CAAC,YAAY,CAAC,EAAE,OAAO,CAAC;IAChC;;;OAGG;IACH,QAAQ,CAAC,QAAQ,CAAC,EAAE,WAAW,CAAC,MAAM,EAAE,QAAQ,CAAC,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC,CAAC,CAAC;IAC3E,gCAAgC;IAChC,QAAQ,CAAC,KAAK,CAAC,EAAE,UAAU,CAAC;IAC5B,+BAA+B;IAC/B,QAAQ,CAAC,MAAM,CAAC,EAAE,eAAe,CAAC;IAClC,wBAAwB;IACxB,QAAQ,CAAC,MAAM,CAAC,EAAE,WAAW,CAAC;CACjC;AAED,2BAA2B;AAC3B,MAAM,WAAW,UAAU;IACvB,aAAa;IACb,QAAQ,CAAC,IAAI,EAAE,gBAAgB,CAAC;IAChC,aAAa;IACb,QAAQ,CAAC,IAAI,EAAE,gBAAgB,CAAC;IAChC,2CAA2C;IAC3C,QAAQ,CAAC,KAAK,EAAE,SAAS,CAAC;CAC7B;AAcD;;;;GAIG;AACH,wBAAgB,mBAAmB,CAAC,KAAK,EAAE,cAAc,GAAG,UAAU,CAgDrE;AAm7CD;;;;;GAKG;AACH,wBAAgB,iBAAiB,CAAC,KAAK,EAAE,cAAc,GAAG;IAAE,QAAQ,CAAC,QAAQ,EAAE,aAAa,CAAA;CAAE,GAAG,cAAc,CAa9G"}