gofish-ir 0.1.0

package/dist/frontend/v0.json

@@ -0,0 +1,506 @@
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "$id": "https://gofish.graphics/schema/frontend/v0.json",
+  "title": "GoFish Frontend IR",
+  "description": "Source-level chart specification produced by the v3 fluent API.",
+  "type": "object",
+  "required": [
+    "irVersion",
+    "ir",
+    "root"
+  ],
+  "additionalProperties": false,
+  "properties": {
+    "irVersion": {
+      "const": 0
+    },
+    "ir": {
+      "const": "gofish-frontend"
+    },
+    "$schema": {
+      "type": "string"
+    },
+    "root": {
+      "$ref": "#/$defs/Root"
+    }
+  },
+  "$defs": {
+    "Root": {
+      "oneOf": [
+        {
+          "$ref": "#/$defs/ChartIR"
+        },
+        {
+          "$ref": "#/$defs/LayerIR"
+        },
+        {
+          "$ref": "#/$defs/RawMarkIR"
+        }
+      ]
+    },
+    "Origin": {
+      "type": "object",
+      "properties": {
+        "name": {
+          "type": "string"
+        },
+        "stack": {
+          "type": "string"
+        }
+      }
+    },
+    "Meta": {
+      "type": "object",
+      "description": "Optional inline annotations populated by later passes. v0 emitters leave it absent."
+    },
+    "DataIR": {
+      "oneOf": [
+        {
+          "type": "object",
+          "required": [
+            "type",
+            "rows"
+          ],
+          "properties": {
+            "type": {
+              "const": "inline"
+            },
+            "rows": {
+              "type": "array",
+              "items": {
+                "type": "object"
+              }
+            }
+          }
+        },
+        {
+          "type": "object",
+          "required": [
+            "type",
+            "layer"
+          ],
+          "properties": {
+            "type": {
+              "const": "select"
+            },
+            "layer": {
+              "type": "string"
+            }
+          }
+        },
+        {
+          "type": "object",
+          "required": [
+            "type"
+          ],
+          "properties": {
+            "type": {
+              "const": "external"
+            },
+            "id": {
+              "type": "string"
+            }
+          }
+        }
+      ]
+    },
+    "ChartIR": {
+      "type": "object",
+      "required": [
+        "type",
+        "mark"
+      ],
+      "properties": {
+        "type": {
+          "const": "chart"
+        },
+        "data": {
+          "oneOf": [
+            {
+              "$ref": "#/$defs/DataIR"
+            },
+            {
+              "type": "null"
+            }
+          ]
+        },
+        "operators": {
+          "type": "array",
+          "items": {
+            "$ref": "#/$defs/OperatorIR"
+          }
+        },
+        "mark": {
+          "$ref": "#/$defs/MarkIR"
+        },
+        "options": {
+          "type": "object"
+        },
+        "zOrder": {
+          "type": "number"
+        },
+        "origin": {
+          "$ref": "#/$defs/Origin"
+        },
+        "meta": {
+          "$ref": "#/$defs/Meta"
+        }
+      }
+    },
+    "LayerIR": {
+      "type": "object",
+      "required": [
+        "type",
+        "charts"
+      ],
+      "properties": {
+        "type": {
+          "const": "layer"
+        },
+        "charts": {
+          "type": "array",
+          "items": {
+            "$ref": "#/$defs/ChartIR"
+          }
+        },
+        "options": {
+          "type": "object"
+        },
+        "origin": {
+          "$ref": "#/$defs/Origin"
+        },
+        "meta": {
+          "$ref": "#/$defs/Meta"
+        }
+      }
+    },
+    "RawMarkIR": {
+      "type": "object",
+      "required": [
+        "type",
+        "mark"
+      ],
+      "properties": {
+        "type": {
+          "const": "raw-mark"
+        },
+        "mark": {
+          "$ref": "#/$defs/MarkIR"
+        },
+        "options": {
+          "type": "object"
+        },
+        "origin": {
+          "$ref": "#/$defs/Origin"
+        },
+        "meta": {
+          "$ref": "#/$defs/Meta"
+        }
+      }
+    },
+    "OperatorIR": {
+      "type": "object",
+      "required": [
+        "type"
+      ],
+      "properties": {
+        "type": {
+          "enum": [
+            "derive",
+            "spread",
+            "stack",
+            "group",
+            "scatter",
+            "table",
+            "log"
+          ]
+        }
+      }
+    },
+    "MarkIR": {
+      "oneOf": [
+        {
+          "$ref": "#/$defs/LeafMarkIR"
+        },
+        {
+          "$ref": "#/$defs/CombinatorMarkIR"
+        },
+        {
+          "$ref": "#/$defs/RefMarkIR"
+        }
+      ]
+    },
+    "LeafMarkIR": {
+      "type": "object",
+      "required": [
+        "type"
+      ],
+      "properties": {
+        "type": {
+          "enum": [
+            "rect",
+            "circle",
+            "line",
+            "area",
+            "blank",
+            "ellipse",
+            "petal",
+            "text",
+            "image",
+            "polygon",
+            "mark-fn"
+          ]
+        },
+        "name": {
+          "type": "string"
+        },
+        "label": {
+          "$ref": "#/$defs/LabelIR"
+        },
+        "constraints": {
+          "type": "array",
+          "items": {
+            "$ref": "#/$defs/ConstraintIR"
+          }
+        },
+        "zOrder": {
+          "type": "number"
+        }
+      }
+    },
+    "CombinatorMarkIR": {
+      "type": "object",
+      "required": [
+        "type",
+        "__combinator",
+        "children"
+      ],
+      "properties": {
+        "type": {
+          "enum": [
+            "spread",
+            "stack",
+            "scatter",
+            "group",
+            "table",
+            "layer",
+            "arrow",
+            "connect",
+            "treemap",
+            "over",
+            "inside",
+            "xor",
+            "out",
+            "atop",
+            "mask"
+          ]
+        },
+        "__combinator": {
+          "const": true
+        },
+        "options": {
+          "type": "object"
+        },
+        "children": {
+          "type": "array",
+          "items": {
+            "$ref": "#/$defs/MarkIR"
+          }
+        },
+        "name": {
+          "type": "string"
+        },
+        "label": {
+          "$ref": "#/$defs/LabelIR"
+        },
+        "constraints": {
+          "type": "array",
+          "items": {
+            "$ref": "#/$defs/ConstraintIR"
+          }
+        },
+        "zOrder": {
+          "type": "number"
+        }
+      }
+    },
+    "RefMarkIR": {
+      "type": "object",
+      "required": [
+        "type",
+        "selection"
+      ],
+      "properties": {
+        "type": {
+          "const": "ref"
+        },
+        "selection": {
+          "oneOf": [
+            {
+              "type": "string"
+            },
+            {
+              "type": "array",
+              "items": {
+                "oneOf": [
+                  {
+                    "type": "string"
+                  },
+                  {
+                    "type": "number"
+                  }
+                ]
+              }
+            }
+          ]
+        },
+        "name": {
+          "type": "string"
+        },
+        "label": {
+          "$ref": "#/$defs/LabelIR"
+        },
+        "zOrder": {
+          "type": "number"
+        }
+      }
+    },
+    "LabelIR": {
+      "oneOf": [
+        {
+          "type": "boolean"
+        },
+        {
+          "type": "string"
+        },
+        {
+          "type": "object",
+          "required": [
+            "accessor"
+          ],
+          "properties": {
+            "accessor": {
+              "type": "string"
+            },
+            "position": {
+              "type": "string"
+            },
+            "fontSize": {
+              "type": "number"
+            },
+            "color": {
+              "type": "string"
+            },
+            "offset": {
+              "type": "number"
+            },
+            "minSpace": {
+              "type": "number"
+            },
+            "rotate": {
+              "type": "number"
+            }
+          }
+        }
+      ]
+    },
+    "ConstraintIR": {
+      "type": "object",
+      "required": [
+        "type",
+        "refs"
+      ],
+      "properties": {
+        "type": {
+          "enum": [
+            "align",
+            "distribute",
+            "zAbove",
+            "zBelow"
+          ]
+        },
+        "options": {
+          "type": "object"
+        },
+        "refs": {
+          "type": "array",
+          "items": {
+            "type": "string"
+          }
+        }
+      }
+    },
+    "ChannelValue": {
+      "description": "Right-hand side of a channel slot. Bare primitives for the shorthand path; tagged objects for the explicit field/datum/literal constructors and Python-bridge sentinels.",
+      "oneOf": [
+        {
+          "type": "string"
+        },
+        {
+          "type": "number"
+        },
+        {
+          "type": "boolean"
+        },
+        {
+          "type": "null"
+        },
+        {
+          "type": "object",
+          "required": [
+            "type",
+            "name"
+          ],
+          "properties": {
+            "type": {
+              "const": "field"
+            },
+            "name": {
+              "type": "string"
+            }
+          }
+        },
+        {
+          "type": "object",
+          "required": [
+            "type",
+            "value"
+          ],
+          "properties": {
+            "type": {
+              "const": "literal"
+            },
+            "value": {}
+          }
+        },
+        {
+          "type": "object",
+          "required": [
+            "type",
+            "datum"
+          ],
+          "properties": {
+            "type": {
+              "const": "datum"
+            },
+            "datum": {},
+            "measure": {
+              "type": "string"
+            }
+          }
+        },
+        {
+          "type": "object",
+          "required": [
+            "__gofish_lambda"
+          ],
+          "properties": {
+            "__gofish_lambda": {
+              "type": "string"
+            }
+          }
+        }
+      ]
+    }
+  }
+}

package/dist/frontend/validate.d.ts

@@ -0,0 +1,27 @@
+/**
+ * Runtime validator for the GoFish frontend IR.
+ *
+ * Hand-rolled, dependency-free. Strict mode rejects unknown fields (used in
+ * CI and tests); the default permissive mode ignores them, suitable for
+ * forward-compatible reading.
+ */
+import { type ChannelValue, type CombinatorMarkIR, type ConstraintIR, type DataIR, type FrontendIRDocument, type LabelIR, type LeafMarkIR, type MarkIR, type Meta, type Origin, type RefMarkIR } from "./schema.js";
+export interface ValidationError {
+    /** Dotted path into the document. */
+    path: string;
+    message: string;
+}
+export type ValidationResult = {
+    valid: true;
+} | {
+    valid: false;
+    errors: ValidationError[];
+};
+export interface ValidateOptions {
+    /** Reject unknown fields. Default: false (permissive). */
+    strict?: boolean;
+}
+/** Validate a document against the frontend-IR schema. */
+export declare function validate(doc: unknown, options?: ValidateOptions): ValidationResult;
+export type { ChannelValue, CombinatorMarkIR, ConstraintIR, DataIR, FrontendIRDocument, LabelIR, LeafMarkIR, MarkIR, Meta, Origin, RefMarkIR, };
+//# sourceMappingURL=validate.d.ts.map

package/dist/frontend/validate.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"validate.d.ts","sourceRoot":"","sources":["../../src/frontend/validate.ts"],"names":[],"mappings":"AAIA;;;;;;GAMG;AAEH,OAAO,EAIL,KAAK,YAAY,EACjB,KAAK,gBAAgB,EACrB,KAAK,YAAY,EACjB,KAAK,MAAM,EACX,KAAK,kBAAkB,EACvB,KAAK,OAAO,EACZ,KAAK,UAAU,EACf,KAAK,MAAM,EACX,KAAK,IAAI,EACT,KAAK,MAAM,EACX,KAAK,SAAS,EACf,MAAM,aAAa,CAAC;AAErB,MAAM,WAAW,eAAe;IAC9B,qCAAqC;IACrC,IAAI,EAAE,MAAM,CAAC;IACb,OAAO,EAAE,MAAM,CAAC;CACjB;AAED,MAAM,MAAM,gBAAgB,GACxB;IAAE,KAAK,EAAE,IAAI,CAAA;CAAE,GACf;IAAE,KAAK,EAAE,KAAK,CAAC;IAAC,MAAM,EAAE,eAAe,EAAE,CAAA;CAAE,CAAC;AAEhD,MAAM,WAAW,eAAe;IAC9B,0DAA0D;IAC1D,MAAM,CAAC,EAAE,OAAO,CAAC;CAClB;AAED,0DAA0D;AAC1D,wBAAgB,QAAQ,CACtB,GAAG,EAAE,OAAO,EACZ,OAAO,GAAE,eAAoB,GAC5B,gBAAgB,CASlB;AAyrBD,YAAY,EACV,YAAY,EACZ,gBAAgB,EAChB,YAAY,EACZ,MAAM,EACN,kBAAkB,EAClB,OAAO,EACP,UAAU,EACV,MAAM,EACN,IAAI,EACJ,MAAM,EACN,SAAS,GACV,CAAC"}