@howells/hairline 0.0.0-stage → 0.1.0

package/lib/json-schema/hairline-line.json

@@ -0,0 +1,256 @@
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "type": "object",
+  "properties": {
+    "note": {
+      "deprecated": true,
+      "description": "Deprecated: use `unitNote`.",
+      "type": "string"
+    },
+    "unitNote": {
+      "description": "The in-plot key under the axis.",
+      "type": "string"
+    },
+    "animate": {
+      "description": "When the entry draws in: \"scroll\" as the chart scrolls into view, \"mount\" at once, \"off\" never (drawn, and ready, in the first HTML). The default is \"off\" for a fixed-size chart and \"scroll\" for a responsive one. Under reduced motion the chart is drawn in the first paint.",
+      "type": "string",
+      "enum": [
+        "scroll",
+        "mount",
+        "off"
+      ]
+    },
+    "replayKey": {
+      "description": "Change it to replay the entry without remounting the chart.",
+      "type": [
+        "string",
+        "number"
+      ]
+    },
+    "fit": {
+      "description": "Fill the container's width at the chart's aspect ratio. Wins over `scale`.",
+      "type": "boolean"
+    },
+    "scale": {
+      "description": "Slides: draw at the logical width, then show the composition this many times larger, type and textures with it.",
+      "type": "number",
+      "exclusiveMinimum": 0
+    },
+    "strokes": {
+      "description": "\"proportional\" (default) scales strokes with the composition; \"device\" keeps every stroke at one device pixel. It acts on stroked geometry only (rules, lines, rings, outlines): filled marks, such as the bars of RungBars, scale either way.",
+      "type": "string",
+      "enum": [
+        "proportional",
+        "device"
+      ]
+    },
+    "idPrefix": {
+      "description": "Leads every SVG id, to separate charts rendered in separate React roots on one page.",
+      "type": "string",
+      "pattern": "^[A-Za-z][\\w-]*$"
+    },
+    "metrics": {
+      "description": "Glyph widths of a face other than Inter, so notes wrap and reserve room for it.",
+      "type": "object",
+      "properties": {
+        "advances": {
+          "type": "object",
+          "propertyNames": {
+            "type": "string",
+            "minLength": 1,
+            "maxLength": 1
+          },
+          "additionalProperties": {
+            "type": "number",
+            "exclusiveMinimum": 0
+          }
+        },
+        "fallback": {
+          "type": "number",
+          "exclusiveMinimum": 0
+        },
+        "tabular": {
+          "type": "number",
+          "exclusiveMinimum": 0
+        }
+      },
+      "required": [
+        "advances",
+        "fallback"
+      ],
+      "additionalProperties": false
+    },
+    "table": {
+      "description": "Show the data table to sighted readers too. It is always there for screen readers.",
+      "type": "boolean"
+    },
+    "title": {
+      "description": "The chart's accessible name. Each chart has a default that reads the data.",
+      "type": "string",
+      "minLength": 1
+    },
+    "data": {
+      "minItems": 1,
+      "maxItems": 731,
+      "type": "array",
+      "items": {
+        "type": "object",
+        "properties": {
+          "date": {
+            "anyOf": [
+              {
+                "type": "string",
+                "format": "date",
+                "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$"
+              },
+              {
+                "type": "string",
+                "format": "date-time",
+                "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$"
+              }
+            ],
+            "description": "The day of the reading, as an ISO date or date-time."
+          },
+          "id": {
+            "description": "Names the reading, and is its key; without it the date is.",
+            "type": "string",
+            "minLength": 1
+          },
+          "value": {
+            "description": "The reading. Null is a day with no reading, drawn as a gap.",
+            "type": [
+              "number",
+              "null"
+            ]
+          }
+        },
+        "required": [
+          "date",
+          "value"
+        ],
+        "additionalProperties": false
+      },
+      "description": "Readings by date, in any order. A null value is a gap."
+    },
+    "dateFormat": {
+      "description": "How dates print on the axis and in the tooltip. Defaults to day-month.",
+      "type": "string",
+      "enum": [
+        "day-month",
+        "day-month-year",
+        "month-year"
+      ]
+    },
+    "emphasis": {
+      "description": "The reading to draw in the hero colour, by key. Defaults to `extreme`.",
+      "type": "string"
+    },
+    "extreme": {
+      "description": "Which extreme the hero marks when `emphasis` is not given.",
+      "type": "string",
+      "enum": [
+        "peak",
+        "trough"
+      ]
+    },
+    "format": {
+      "description": "How values print: a preset name or Intl number-format options.",
+      "anyOf": [
+        {
+          "type": "string",
+          "enum": [
+            "integer",
+            "decimal",
+            "compact",
+            "percent"
+          ]
+        },
+        {
+          "type": "object",
+          "properties": {
+            "compactDisplay": {
+              "type": "string",
+              "enum": [
+                "short",
+                "long"
+              ]
+            },
+            "currency": {
+              "type": "string",
+              "minLength": 3,
+              "maxLength": 3
+            },
+            "locale": {
+              "type": "string",
+              "minLength": 2
+            },
+            "maximumFractionDigits": {
+              "type": "integer",
+              "minimum": 0,
+              "maximum": 20
+            },
+            "minimumFractionDigits": {
+              "type": "integer",
+              "minimum": 0,
+              "maximum": 20
+            },
+            "notation": {
+              "type": "string",
+              "enum": [
+                "standard",
+                "compact"
+              ]
+            },
+            "signDisplay": {
+              "type": "string",
+              "enum": [
+                "auto",
+                "always",
+                "exceptZero",
+                "never"
+              ]
+            },
+            "style": {
+              "type": "string",
+              "enum": [
+                "decimal",
+                "percent",
+                "currency",
+                "unit"
+              ]
+            },
+            "unit": {
+              "type": "string"
+            },
+            "useGrouping": {
+              "type": "boolean"
+            }
+          },
+          "additionalProperties": false
+        }
+      ]
+    },
+    "height": {
+      "description": "Fixed height in px. Without it a line chart is 440 tall.",
+      "type": "integer",
+      "exclusiveMinimum": 0,
+      "maximum": 9007199254740991
+    },
+    "initialWidth": {
+      "description": "Responsive mode only: the width of the first render, before measuring.",
+      "type": "integer",
+      "exclusiveMinimum": 0,
+      "maximum": 9007199254740991
+    },
+    "width": {
+      "description": "Fixed width in px. Giving it turns measuring off.",
+      "type": "integer",
+      "exclusiveMinimum": 0,
+      "maximum": 9007199254740991
+    }
+  },
+  "required": [
+    "data"
+  ],
+  "additionalProperties": false
+}

package/lib/json-schema/index.json

@@ -0,0 +1,50 @@
+[
+  {
+    "jobs": [
+      "deviation",
+      "change-over-time"
+    ],
+    "kind": "dumbbell-queue",
+    "schema": "dumbbell-queue.json"
+  },
+  {
+    "jobs": [
+      "change-over-time",
+      "magnitude"
+    ],
+    "kind": "hairline-area",
+    "schema": "hairline-area.json"
+  },
+  {
+    "jobs": [
+      "change-over-time",
+      "ranking"
+    ],
+    "kind": "hairline-line",
+    "schema": "hairline-line.json"
+  },
+  {
+    "jobs": [
+      "correlation",
+      "ranking"
+    ],
+    "kind": "plumb-scatter",
+    "schema": "plumb-scatter.json"
+  },
+  {
+    "jobs": [
+      "magnitude",
+      "ranking"
+    ],
+    "kind": "rung-bars",
+    "schema": "rung-bars.json"
+  },
+  {
+    "jobs": [
+      "change-over-time",
+      "ranking"
+    ],
+    "kind": "slope",
+    "schema": "slope.json"
+  }
+]

package/lib/json-schema/plumb-scatter.json

@@ -0,0 +1,363 @@
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "type": "object",
+  "properties": {
+    "note": {
+      "deprecated": true,
+      "description": "Deprecated: use `unitNote`.",
+      "type": "string"
+    },
+    "unitNote": {
+      "description": "The in-plot key under the axis.",
+      "type": "string"
+    },
+    "animate": {
+      "description": "When the entry draws in: \"scroll\" as the chart scrolls into view, \"mount\" at once, \"off\" never (drawn, and ready, in the first HTML). The default is \"off\" for a fixed-size chart and \"scroll\" for a responsive one. Under reduced motion the chart is drawn in the first paint.",
+      "type": "string",
+      "enum": [
+        "scroll",
+        "mount",
+        "off"
+      ]
+    },
+    "replayKey": {
+      "description": "Change it to replay the entry without remounting the chart.",
+      "type": [
+        "string",
+        "number"
+      ]
+    },
+    "fit": {
+      "description": "Fill the container's width at the chart's aspect ratio. Wins over `scale`.",
+      "type": "boolean"
+    },
+    "scale": {
+      "description": "Slides: draw at the logical width, then show the composition this many times larger, type and textures with it.",
+      "type": "number",
+      "exclusiveMinimum": 0
+    },
+    "strokes": {
+      "description": "\"proportional\" (default) scales strokes with the composition; \"device\" keeps every stroke at one device pixel. It acts on stroked geometry only (rules, lines, rings, outlines): filled marks, such as the bars of RungBars, scale either way.",
+      "type": "string",
+      "enum": [
+        "proportional",
+        "device"
+      ]
+    },
+    "idPrefix": {
+      "description": "Leads every SVG id, to separate charts rendered in separate React roots on one page.",
+      "type": "string",
+      "pattern": "^[A-Za-z][\\w-]*$"
+    },
+    "metrics": {
+      "description": "Glyph widths of a face other than Inter, so notes wrap and reserve room for it.",
+      "type": "object",
+      "properties": {
+        "advances": {
+          "type": "object",
+          "propertyNames": {
+            "type": "string",
+            "minLength": 1,
+            "maxLength": 1
+          },
+          "additionalProperties": {
+            "type": "number",
+            "exclusiveMinimum": 0
+          }
+        },
+        "fallback": {
+          "type": "number",
+          "exclusiveMinimum": 0
+        },
+        "tabular": {
+          "type": "number",
+          "exclusiveMinimum": 0
+        }
+      },
+      "required": [
+        "advances",
+        "fallback"
+      ],
+      "additionalProperties": false
+    },
+    "table": {
+      "description": "Show the data table to sighted readers too. It is always there for screen readers.",
+      "type": "boolean"
+    },
+    "title": {
+      "description": "The chart's accessible name. Each chart has a default that reads the data.",
+      "type": "string",
+      "minLength": 1
+    },
+    "data": {
+      "minItems": 1,
+      "maxItems": 20,
+      "type": "array",
+      "items": {
+        "type": "object",
+        "properties": {
+          "id": {
+            "description": "A unique key, for when two points share a label.",
+            "type": "string",
+            "minLength": 1
+          },
+          "label": {
+            "type": "string",
+            "description": "Names the point, and is its key unless `id` is given."
+          },
+          "x": {
+            "type": "number",
+            "description": "Position along the x axis."
+          },
+          "y": {
+            "type": "number",
+            "description": "Position up the y axis."
+          }
+        },
+        "required": [
+          "label",
+          "x",
+          "y"
+        ],
+        "additionalProperties": false
+      },
+      "description": "The points, 1 to 20."
+    },
+    "emphasis": {
+      "description": "The point to draw in the hero colour, by key. Defaults to the highest.",
+      "type": "string"
+    },
+    "format": {
+      "description": "How y prints: a preset name or Intl number-format options.",
+      "anyOf": [
+        {
+          "type": "string",
+          "enum": [
+            "integer",
+            "decimal",
+            "compact",
+            "percent"
+          ]
+        },
+        {
+          "type": "object",
+          "properties": {
+            "compactDisplay": {
+              "type": "string",
+              "enum": [
+                "short",
+                "long"
+              ]
+            },
+            "currency": {
+              "type": "string",
+              "minLength": 3,
+              "maxLength": 3
+            },
+            "locale": {
+              "type": "string",
+              "minLength": 2
+            },
+            "maximumFractionDigits": {
+              "type": "integer",
+              "minimum": 0,
+              "maximum": 20
+            },
+            "minimumFractionDigits": {
+              "type": "integer",
+              "minimum": 0,
+              "maximum": 20
+            },
+            "notation": {
+              "type": "string",
+              "enum": [
+                "standard",
+                "compact"
+              ]
+            },
+            "signDisplay": {
+              "type": "string",
+              "enum": [
+                "auto",
+                "always",
+                "exceptZero",
+                "never"
+              ]
+            },
+            "style": {
+              "type": "string",
+              "enum": [
+                "decimal",
+                "percent",
+                "currency",
+                "unit"
+              ]
+            },
+            "unit": {
+              "type": "string"
+            },
+            "useGrouping": {
+              "type": "boolean"
+            }
+          },
+          "additionalProperties": false
+        }
+      ]
+    },
+    "formatX": {
+      "description": "How x prints. Defaults to a rounded integer.",
+      "anyOf": [
+        {
+          "type": "string",
+          "enum": [
+            "integer",
+            "decimal",
+            "compact",
+            "percent"
+          ]
+        },
+        {
+          "type": "object",
+          "properties": {
+            "compactDisplay": {
+              "type": "string",
+              "enum": [
+                "short",
+                "long"
+              ]
+            },
+            "currency": {
+              "type": "string",
+              "minLength": 3,
+              "maxLength": 3
+            },
+            "locale": {
+              "type": "string",
+              "minLength": 2
+            },
+            "maximumFractionDigits": {
+              "type": "integer",
+              "minimum": 0,
+              "maximum": 20
+            },
+            "minimumFractionDigits": {
+              "type": "integer",
+              "minimum": 0,
+              "maximum": 20
+            },
+            "notation": {
+              "type": "string",
+              "enum": [
+                "standard",
+                "compact"
+              ]
+            },
+            "signDisplay": {
+              "type": "string",
+              "enum": [
+                "auto",
+                "always",
+                "exceptZero",
+                "never"
+              ]
+            },
+            "style": {
+              "type": "string",
+              "enum": [
+                "decimal",
+                "percent",
+                "currency",
+                "unit"
+              ]
+            },
+            "unit": {
+              "type": "string"
+            },
+            "useGrouping": {
+              "type": "boolean"
+            }
+          },
+          "additionalProperties": false
+        }
+      ]
+    },
+    "height": {
+      "description": "Fixed height in px. Without it a scatter is 440 tall.",
+      "type": "integer",
+      "exclusiveMinimum": 0,
+      "maximum": 9007199254740991
+    },
+    "initialWidth": {
+      "description": "Responsive mode only: the width of the first render, before measuring.",
+      "type": "integer",
+      "exclusiveMinimum": 0,
+      "maximum": 9007199254740991
+    },
+    "labelled": {
+      "description": "Points to name beside their dot, by key. Defaults to the highest and lowest.",
+      "type": "array",
+      "items": {
+        "type": "string"
+      }
+    },
+    "width": {
+      "description": "Fixed width in px. Giving it turns measuring off.",
+      "type": "integer",
+      "exclusiveMinimum": 0,
+      "maximum": 9007199254740991
+    },
+    "xDomain": {
+      "description": "The x axis range, [low, high].",
+      "type": "array",
+      "prefixItems": [
+        {
+          "type": "number"
+        },
+        {
+          "type": "number"
+        }
+      ],
+      "items": false,
+      "minItems": 2,
+      "maxItems": 2
+    },
+    "xLabels": {
+      "description": "Names for the low and high ends of the x axis.",
+      "type": "array",
+      "prefixItems": [
+        {
+          "type": "string"
+        },
+        {
+          "type": "string"
+        }
+      ],
+      "items": false,
+      "minItems": 2,
+      "maxItems": 2
+    },
+    "yDomain": {
+      "description": "The y axis range, [low, high].",
+      "type": "array",
+      "prefixItems": [
+        {
+          "type": "number"
+        },
+        {
+          "type": "number"
+        }
+      ],
+      "items": false,
+      "minItems": 2,
+      "maxItems": 2
+    },
+    "yLabel": {
+      "description": "Name for the y direction, drawn up the left side.",
+      "type": "string"
+    }
+  },
+  "required": [
+    "data"
+  ],
+  "additionalProperties": false
+}