@graphty/graph-io 0.3.47 → 0.3.49

package/src/styles/vocabulary.ts

@@ -7,22 +7,28 @@
 import type { StyleTarget } from "./types.js";
 
 /**
- * The kinds of style value: a canonical `#rrggbb` color, a number (lengths and factors at least 0), an opacity
+ * The kinds of style value: a canonical `#rrggbb` color, a number (lengths and factors at least 0), a signed number
+ * (an offset, negative too), an opacity
  * (0..1), a text, a boolean, or a value of one of the enumerations in `STYLE_ENUMS`.
  * @category Styles
  */
 export type StyleValueKind =
     | "color"
     | "number"
+    | "signed"
     | "opacity"
     | "text"
     | "boolean"
     | "shape"
     | "borderStyle"
+    | "borderPosition"
     | "lineStyle"
     | "arrow"
+    | "arrowSide"
     | "weight"
-    | "position";
+    | "textAlign"
+    | "position"
+    | "labelFit";
 
 /**
  * The value kind of every neutral property, per target.
@@ -38,24 +44,132 @@ export const STYLE_PROPERTIES: {
 } = Object.freeze({
     node: new Map<string, StyleValueKind>([
         ["fill", "color"],
+        ["fillGradient", "color"],
         ["borderColor", "color"],
         ["labelColor", "color"],
         ["fillOpacity", "opacity"],
         ["opacity", "opacity"],
+        ["borderOpacity", "opacity"],
         ["width", "number"],
         ["height", "number"],
         ["borderWidth", "number"],
         ["cornerRadius", "number"],
+        ["fillGradientAngle", "number"],
+        ["fillGradientColors", "text"],
+        ["fillGradientStops", "text"],
+        ["fillGradientKind", "text"],
         ["labelSize", "number"],
+        ["labelWrapWidth", "number"],
+        ["labelWrapTrailingSpace", "boolean"],
+        ["labelWrapEllipsis", "boolean"],
+        ["labelWrapAnywhere", "boolean"],
+        ["labelWrapSpaceCount", "number"],
+        ["labelRunAlign", "text"],
+        ["labelOffsetX", "signed"],
+        ["labelOffsetY", "signed"],
+        ["labelShiftX", "signed"],
+        ["labelShiftY", "signed"],
+        ["labelOpacity", "opacity"],
+        ["labelBackgroundOpacity", "opacity"],
+        ["labelFit", "labelFit"],
+        ["labelPaddingX", "number"],
+        ["labelPaddingY", "number"],
+        ["labelFitSquare", "boolean"],
         ["shape", "shape"],
+        ["shapePoints", "text"],
+        ["shapePointsStretch", "boolean"],
+        ["shapeParts", "text"],
+        ["shapeLines", "text"],
+        ["shapeLineWidth", "number"],
+        ["shapeTexts", "text"],
         ["borderStyle", "borderStyle"],
+        ["borderPosition", "borderPosition"],
+        ["borderWaveAmplitude", "number"],
+        ["borderWavePeriod", "number"],
+        ["outerBorderColor", "color"],
+        ["outerBorderWidth", "number"],
+        ["outerBorderOpacity", "opacity"],
+        ["outerBorderStyle", "borderStyle"],
+        ["outerBorderOffset", "number"],
+        ["underlayColor", "color"],
+        ["underlayOpacity", "opacity"],
+        ["underlayPadding", "number"],
+        ["underlayShape", "shape"],
+        ["underlayCornerRadius", "number"],
+        ["overlayColor", "color"],
+        ["overlayOpacity", "opacity"],
+        ["overlayPadding", "number"],
+        ["overlayShape", "shape"],
+        ["overlayCornerRadius", "number"],
         ["label", "text"],
         ["tooltip", "text"],
         ["labelFont", "text"],
         ["labelWeight", "weight"],
         ["labelItalic", "boolean"],
         ["labelPosition", "position"],
+        ["labelTextAlign", "textAlign"],
+        ["labelRuns", "text"],
+        ["labelMinScreenSize", "number"],
+        ["labelAvoidOverlap", "boolean"],
+        ["labelMinNodeScreenSize", "number"],
+        ["labelGridCellSize", "number"],
+        ["labelOnTop", "boolean"],
+        ["labelRotation", "number"],
+        ["labelBackground", "color"],
+        ["labelOutlineColor", "color"],
+        ["labelOutlineWidth", "number"],
+        ["labelBorderColor", "color"],
+        ["labelBorderWidth", "number"],
+        ["labelOutlineOpacity", "opacity"],
+        ["labelBorderOpacity", "opacity"],
+        ["labelPadding", "number"],
+        ["labelCornerRadius", "number"],
+        ["labelLineHeight", "number"],
         ["image", "text"],
+        ["imageFit", "text"],
+        ["imageFallback", "text"],
+        ["imageWidth", "number"],
+        ["imageHeight", "number"],
+        ["imagePositionX", "number"],
+        ["imagePositionY", "number"],
+        ["imageOffsetX", "signed"],
+        ["imageOffsetY", "signed"],
+        ["imageRepeat", "text"],
+        ["imageClip", "text"],
+        ["imageSmoothing", "boolean"],
+        ["imageAutoSize", "text"],
+        ["imageOpacity", "opacity"],
+        ["glyph", "text"],
+        ["glyphFont", "text"],
+        ["glyphSize", "number"],
+        ["glyphWeight", "weight"],
+        ["glyphColor", "color"],
+        ["pieColors", "text"],
+        ["pieSizes", "text"],
+        ["pieOpacities", "text"],
+        ["pieRadius", "number"],
+        ["pieHole", "number"],
+        ["pieRotation", "number"],
+        ["pieFitBox", "boolean"],
+        ["pieOffsetX", "signed"],
+        ["pieOffsetY", "signed"],
+        ["stripeColors", "text"],
+        ["stripeSizes", "text"],
+        ["stripeOpacities", "text"],
+        ["stripeDirection", "text"],
+        ["stripeSize", "number"],
+        ["chartKind", "text"],
+        ["chartValues", "text"],
+        ["chartColors", "text"],
+        ["chartMin", "signed"],
+        ["chartMax", "signed"],
+        ["chartHorizontal", "boolean"],
+        ["chartSize", "number"],
+        ["chartMargin", "signed"],
+        ["chartGap", "number"],
+        ["chartLineWidth", "number"],
+        ["chartBorderColor", "color"],
+        ["chartBorderWidth", "number"],
         ["visible", "boolean"],
     ]),
     edge: new Map<string, StyleValueKind>([
@@ -65,20 +179,101 @@ export const STYLE_PROPERTIES: {
         ["labelColor", "color"],
         ["opacity", "opacity"],
         ["width", "number"],
+        ["minScreenWidth", "number"],
+        ["outlineWidth", "number"],
+        ["outlineColor", "color"],
+        ["outlineOpacity", "opacity"],
+        ["outlineStyle", "lineStyle"],
+        ["underlayColor", "color"],
+        ["underlayOpacity", "opacity"],
+        ["underlayPadding", "number"],
+        ["overlayColor", "color"],
+        ["overlayOpacity", "opacity"],
+        ["overlayPadding", "number"],
+        ["gradientColors", "text"],
+        ["gradientStops", "text"],
+        ["gradientKind", "text"],
         ["labelSize", "number"],
         ["arrowSize", "number"],
+        ["sourceArrowSize", "number"],
+        ["sourceArrowLength", "number"],
+        ["targetArrowLength", "number"],
+        ["sourceArrowWidth", "number"],
+        ["targetArrowWidth", "number"],
+        ["sourceArrowGap", "number"],
+        ["targetArrowGap", "number"],
+        ["sourceArrowSide", "arrowSide"],
+        ["targetArrowSide", "arrowSide"],
+        ["arrowPosition", "number"],
         ["lineStyle", "lineStyle"],
+        ["waveAmplitude", "number"],
+        ["wavePeriod", "number"],
         ["sourceArrow", "arrow"],
         ["targetArrow", "arrow"],
+        ["midTargetArrow", "arrow"],
+        ["midSourceArrow", "arrow"],
+        ["midTargetArrowColor", "color"],
+        ["midSourceArrowColor", "color"],
+        ["targetArrowImage", "text"],
+        ["sourceArrowImage", "text"],
+        ["midTargetArrowImage", "text"],
+        ["targetArrowImageWidth", "number"],
+        ["targetArrowImageHeight", "number"],
+        ["sourceArrowImageWidth", "number"],
+        ["sourceArrowImageHeight", "number"],
+        ["midTargetArrowImageWidth", "number"],
+        ["midTargetArrowImageHeight", "number"],
         ["curved", "boolean"],
         ["bends", "text"],
+        ["fanSpacing", "number"],
+        ["fanned", "boolean"],
+        ["bendCurve", "text"],
+        ["arcRadius", "number"],
+        ["nodeGap", "number"],
+        ["sourcePort", "text"],
+        ["targetPort", "text"],
         ["label", "text"],
         ["tooltip", "text"],
         ["labelFont", "text"],
         ["labelWeight", "weight"],
+        ["labelTextAlign", "textAlign"],
+        ["labelRuns", "text"],
         ["labelItalic", "boolean"],
+        ["labelWrapWidth", "number"],
+        ["labelWrapEllipsis", "boolean"],
+        ["labelWrapAnywhere", "boolean"],
+        ["labelWrapSpaceCount", "number"],
+        ["labelRunAlign", "text"],
+        ["labelPosition", "position"],
+        ["labelRotation", "number"],
+        ["labelOffsetX", "signed"],
+        ["labelOffsetY", "signed"],
+        ["labelShiftX", "signed"],
+        ["labelShiftY", "signed"],
+        ["labelOpacity", "opacity"],
+        ["labelBackgroundOpacity", "opacity"],
+        ["labelBackground", "color"],
+        ["labelOutlineColor", "color"],
+        ["labelOutlineWidth", "number"],
+        ["labelBorderColor", "color"],
+        ["labelBorderWidth", "number"],
+        ["labelOutlineOpacity", "opacity"],
+        ["labelBorderOpacity", "opacity"],
+        ["labelPadding", "number"],
+        ["labelCornerRadius", "number"],
+        ["labelLineHeight", "number"],
         ["sourceLabel", "text"],
         ["targetLabel", "text"],
+        ["sourceLabelOffset", "number"],
+        ["targetLabelOffset", "number"],
+        ["sourceLabelOffsetX", "signed"],
+        ["sourceLabelOffsetY", "signed"],
+        ["targetLabelOffsetX", "signed"],
+        ["targetLabelOffsetY", "signed"],
+        ["sourceLabelRotation", "number"],
+        ["targetLabelRotation", "number"],
+        ["labelMinScreenSize", "number"],
+        ["labelOnTop", "boolean"],
         ["visible", "boolean"],
     ]),
     graph: new Map<string, StyleValueKind>([["background", "color"]]),
@@ -105,10 +300,12 @@ export const STYLE_ENUMS: ReadonlyMap<StyleValueKind, readonly string[]> = new M
             "trapezoid",
             "star",
             "vee",
+            "polygon",
             "none",
         ],
     ],
     ["borderStyle", ["solid", "dashed", "dotted", "dash-dot", "double"]],
+    ["borderPosition", ["inside", "center", "outside"]],
     ["lineStyle", ["solid", "dashed", "dotted", "dash-dot", "long-dash", "double", "zigzag", "sinewave"]],
     [
         "arrow",
@@ -128,8 +325,32 @@ export const STYLE_ENUMS: ReadonlyMap<StyleValueKind, readonly string[]> = new M
             "inverted",
         ],
     ],
+    ["arrowSide", ["left", "right"]],
     ["weight", ["normal", "bold"]],
-    ["position", ["center", "top", "bottom", "left", "right", "top-left", "top-right", "bottom-left", "bottom-right"]],
+    ["textAlign", ["left", "center", "right"]],
+    ["labelFit", ["inside", "bounds"]],
+    [
+        "position",
+        [
+            "center",
+            "top",
+            "bottom",
+            "left",
+            "right",
+            "top-left",
+            "top-right",
+            "bottom-left",
+            "bottom-right",
+            "inside-top",
+            "inside-bottom",
+            "inside-left",
+            "inside-right",
+            "inside-top-left",
+            "inside-top-right",
+            "inside-bottom-left",
+            "inside-bottom-right",
+        ],
+    ],
 ]);
 
 /** The enumerations that keep unknown spellings as `other:<raw>`. */
@@ -156,6 +377,8 @@ export function isStyleValue(target: StyleTarget | "graph", property: string, va
             return typeof value === "string" && /^#[0-9a-f]{6}$/.test(value);
         case "number":
             return typeof value === "number" && Number.isFinite(value) && value >= 0;
+        case "signed":
+            return typeof value === "number" && Number.isFinite(value);
         case "opacity":
             return typeof value === "number" && value >= 0 && value <= 1;
         case "text":

package/src/types.ts

@@ -18,6 +18,8 @@ import {
 } from "@graphty/graph-format";
 
 import type { ImporterPositions, PositionReadContext } from "./positions/types.js";
+import { type SourceIssueCode } from "./sources/codes.js";
+import { type SourceReportInfo } from "./sources/types.js";
 import type {
     EdgeStyleProperty,
     GraphStyleProperty,
@@ -170,9 +172,10 @@ export interface CommonImportOptions {
      * Called as the input is read, with the bytes read so far and the total. For a string or a
      * Uint8Array the total is known from the first call. For a stream (which includes loadFromUrl()
      * and loadFromFile()) it is undefined until the last call, which always has
-     * `bytesDone === bytesTotal`. Text counts its UTF-8 length.
+     * `bytesDone === bytesTotal`. Text counts its UTF-8 length. A load from a network source passes a
+     * third argument, "bytes" or "items", saying what is counted.
      */
-    onProgress?: ((bytesDone: number, bytesTotal?: number) => void) | undefined;
+    onProgress?: ((bytesDone: number, bytesTotal?: number, unit?: "items" | "bytes") => void) | undefined;
     /**
      * The character encoding of byte input, as a label such as "utf-8", "windows-1252" or
      * "utf-16le". Without it graph-io uses a byte order mark, then the encoding the file declares
@@ -553,9 +556,18 @@ export interface ImportIssue {
      * kept, possibly changed.
      */
     readonly severity: "error" | "warning";
-    /** A stable code; E_ for errors, W_ for warnings ("E_UNKNOWN_NODE", "W_WIDENED"). */
-    readonly code: string;
-    /** A plain-English message. */
+    /**
+     * A stable code; E_ for errors, W_ for warnings ("E_UNKNOWN_NODE", "W_WIDENED"). The network
+     * source codes (`SOURCE_ISSUE`) autocomplete; every other code is a string.
+     */
+    readonly code: SourceIssueCode | (string & {}); // NOSONAR(S4335): open string union, keeps the known names autocompleting
+    /**
+     * The issue's machine-readable values (`{ status: 401 }`), when it has any. Every network source
+     * issue has them (`SourceIssueParams` maps each code to its shape); an application writes its
+     * own words from the code and these values.
+     */
+    readonly params?: Readonly<Record<string, unknown>> | undefined;
+    /** A plain-English message, for logs. */
     readonly message: string;
     /** The 1-based line in the input, or null when the format has no lines or it is unknown. */
     readonly line: number | null;
@@ -598,6 +610,8 @@ export interface ImportReport {
     readonly lossy: readonly LossNote[];
     /** How long reading the file took, in milliseconds. */
     readonly durationMs: number;
+    /** What a load from a network source did: requests, bytes, where to resume. Experimental. */
+    readonly source?: SourceReportInfo | undefined;
 }
 
 /**