@krizaka/charts 0.1.0 → 0.2.0

package/registry/latency-chart.json

@@ -0,0 +1,671 @@
+{
+  "name": "latency-chart",
+  "package": "@krizaka/charts",
+  "type": "chart",
+  "title": "Latency chart",
+  "summary": "Median and 95th-percentile latency per item, in the unit that fits (ms, s, min), against a service objective.",
+  "description": "Median and 95th-percentile latency per item, in the unit that fits (ms, s, min), against a service objective.",
+  "status": "beta",
+  "category": "charts",
+  "platforms": "both",
+  "engine": "svg",
+  "tier": "ready-made",
+  "whenToUse": [
+    "The console's supervision: latency per capability against the objective.",
+    "Orazaka's “time to result” per kind of job, where seconds turn into minutes.",
+    "Any duration compared across items: a model, a region, an endpoint."
+  ],
+  "whenNotToUse": [
+    {
+      "when": "A duration over time (the latency of the last hours).",
+      "use": "line-chart"
+    },
+    {
+      "when": "How many jobs ran.",
+      "use": "job-throughput"
+    }
+  ],
+  "bestPractices": [
+    "Pass milliseconds: the chart picks the unit for each value.",
+    "Show the p95 beside the median: the median alone hides the slow tail people feel.",
+    "Name the objective in its label (“Objective”: the line writes its value)."
+  ],
+  "accessibility": {
+    "keyboard": [
+      {
+        "keys": "Tab",
+        "action": "Moves the focus to the plot, then to the data and export buttons."
+      },
+      {
+        "keys": "Arrow keys",
+        "action": "Walk the items: the median and the p95 of each are announced."
+      }
+    ],
+    "notes": [
+      "The slowest p95 and the number of items past the objective are written above the chart.",
+      "Durations are written with their unit everywhere: axis, tooltip, table and summary."
+    ]
+  },
+  "related": [
+    "bar-chart",
+    "job-throughput",
+    "line-chart"
+  ],
+  "source": "packages/charts/src/meta/latency-chart.ts",
+  "install": {
+    "web": "npm install @krizaka/charts",
+    "native": "npx expo install react-native-svg\nnpm install @krizaka/charts"
+  },
+  "web": {
+    "entry": "@krizaka/charts/latency",
+    "import": "import { LatencyChart, formatDuration } from \"@krizaka/charts/latency\";",
+    "props": [
+      {
+        "component": "LatencyChart",
+        "description": "Median and p95 latency per item, durations in the unit that fits, against a service objective.",
+        "props": [
+          {
+            "name": "data",
+            "type": "readonly T[]",
+            "default": null,
+            "description": "The rows, in the order of the x axis.",
+            "required": true
+          },
+          {
+            "name": "title",
+            "type": "string",
+            "default": null,
+            "description": "What the chart shows, in a few words: its accessible name, and its heading unless `hideTitle`.",
+            "required": true
+          },
+          {
+            "name": "brand",
+            "type": "BrandId",
+            "default": null,
+            "description": "The brand whose palette the charts use. Without it, a chart follows a `.brand-<id>` ancestor, else Krizaka. Set it\nwhen the app loads a brand stylesheet on `:root` (`@krizaka/tokens/brands/orazaka.css`).",
+            "required": false
+          },
+          {
+            "name": "className",
+            "type": "string",
+            "default": null,
+            "description": "A class on the figure (layout: margins, grid placement).",
+            "required": false
+          },
+          {
+            "name": "dataTable",
+            "type": "boolean",
+            "default": null,
+            "description": "The \"Show data\" button (the table is in the page for screen readers either way). Default true.",
+            "required": false
+          },
+          {
+            "name": "description",
+            "type": "ReactNode",
+            "default": null,
+            "description": "A sentence under the title: the period, the unit, the source.",
+            "required": false
+          },
+          {
+            "name": "empty",
+            "type": "ReactNode",
+            "default": null,
+            "description": "What to show when there is nothing to draw (default: the `empty` label). An `EmptyState` of\n@krizaka /ui fits.",
+            "required": false
+          },
+          {
+            "name": "error",
+            "type": "ReactNode",
+            "default": null,
+            "description": "The data could not be loaded: `true` says the default words, a node says yours (a retry button…).",
+            "required": false
+          },
+          {
+            "name": "exportable",
+            "type": "boolean | readonly ExportFormat[]",
+            "default": null,
+            "description": "Export buttons: `true` for PNG, SVG and CSV, or the formats you want.",
+            "required": false
+          },
+          {
+            "name": "height",
+            "type": "number",
+            "default": null,
+            "description": "The height of the plot in pixels. Default 280 (a sparkline: 32).",
+            "required": false
+          },
+          {
+            "name": "hideSummary",
+            "type": "boolean",
+            "default": null,
+            "description": "Hide the slowest p95 and the count over the objective.",
+            "required": false
+          },
+          {
+            "name": "hideTitle",
+            "type": "boolean",
+            "default": null,
+            "description": "Visually hide the title (it stays the chart's accessible name): a card that already has its heading.",
+            "required": false
+          },
+          {
+            "name": "id",
+            "type": "string",
+            "default": null,
+            "description": "The id of the figure.",
+            "required": false
+          },
+          {
+            "name": "labels",
+            "type": "Partial<LatencyLabels>",
+            "default": null,
+            "description": "The words, passed translated; English by default.",
+            "required": false
+          },
+          {
+            "name": "legend",
+            "type": "boolean",
+            "default": null,
+            "description": "Show the legend (from two series). Default true.",
+            "required": false
+          },
+          {
+            "name": "live",
+            "type": "boolean",
+            "default": null,
+            "description": "Streaming data (a job queue, an auction): no entrance on updates, no announcement of every new point.",
+            "required": false
+          },
+          {
+            "name": "loading",
+            "type": "boolean",
+            "default": null,
+            "description": "The data is on its way: a skeleton of the chart, announced once.",
+            "required": false
+          },
+          {
+            "name": "locale",
+            "type": "Locale",
+            "default": null,
+            "description": "The locale of every figure and date (`\"fr-FR\"`). Default `\"en-US\"`.",
+            "required": false
+          },
+          {
+            "name": "markers",
+            "type": "readonly Marker[]",
+            "default": null,
+            "description": "Vertical markers at a category: a launch, an incident.",
+            "required": false
+          },
+          {
+            "name": "objective",
+            "type": "{ readonly value: number; readonly label: string; }",
+            "default": null,
+            "description": "The service objective, in milliseconds: a line, and the count of what goes past it (by p95).",
+            "required": false
+          },
+          {
+            "name": "onSelect",
+            "type": "((datum: T, index: number) => void)",
+            "default": null,
+            "description": "Called with the row when a point or a bar is clicked (or Enter is pressed on it).",
+            "required": false
+          },
+          {
+            "name": "p50",
+            "type": "string | ((datum: T, index: number) => number | null)",
+            "default": "\"p50\" as Accessor<T, number | null | undefined>",
+            "description": "The median, in milliseconds. Default `\"p50\"`.",
+            "required": false
+          },
+          {
+            "name": "p95",
+            "type": "string | ((datum: T, index: number) => number | null) | null",
+            "default": "\"p95\" as Accessor<T, number | null | undefined>",
+            "description": "The 95th percentile, in milliseconds. Default `\"p95\"`; `null` to draw the median alone.",
+            "required": false
+          },
+          {
+            "name": "style",
+            "type": "CSSProperties",
+            "default": null,
+            "description": "Inline style on the figure (layout only: colours come from the tokens).",
+            "required": false
+          },
+          {
+            "name": "summary",
+            "type": "\"hidden\" | \"visible\"",
+            "default": null,
+            "description": "The written summary: read by screen readers only (`\"hidden\"`, default), or shown under the chart (`\"visible\"`).",
+            "required": false
+          },
+          {
+            "name": "summaryText",
+            "type": "string",
+            "default": null,
+            "description": "Your own summary instead of the generated one (still read first by screen readers).",
+            "required": false
+          },
+          {
+            "name": "vertical",
+            "type": "boolean",
+            "default": null,
+            "description": "Vertical bars instead of horizontal ones (few, short names).",
+            "required": false
+          },
+          {
+            "name": "x",
+            "type": "string | ((datum: T, index: number) => unknown)",
+            "default": "\"name\" as Accessor<T, unknown>",
+            "description": "The field (or function) naming what is measured (a capability, a model). Default `\"name\"`.",
+            "required": false
+          },
+          {
+            "name": "xLabel",
+            "type": "string",
+            "default": null,
+            "description": "The header of the categories in the data table (`Month`).",
+            "required": false
+          },
+          {
+            "name": "zero",
+            "type": "boolean",
+            "default": null,
+            "description": "Start the value axis at zero. Default: true for bars and areas; for lines, unless the values sit far from zero.",
+            "required": false
+          }
+        ]
+      }
+    ],
+    "examples": [
+      {
+        "name": "by-capability",
+        "title": "By capability",
+        "description": "The console: p50 and p95 per capability against a 2 s objective.",
+        "path": "examples/latency-chart/by-capability.tsx",
+        "module": "@krizaka/charts/registry/examples/latency-chart/by-capability",
+        "code": "import { LatencyChart } from \"@krizaka/charts/latency\";\n\n// Milliseconds, per capability, over the last 24 hours (the console's supervision).\nconst capabilities = [\n  { name: \"Chat\", p50: 420, p95: 1_180 },\n  { name: \"Embeddings\", p50: 85, p95: 210 },\n  { name: \"Speech to text\", p50: 1_350, p95: 2_900 },\n  { name: \"Image\", p50: 4_200, p95: 9_800 },\n  { name: \"Translation\", p50: 610, p95: 1_640 },\n];\n\nexport default function ByCapability() {\n  return (\n    <LatencyChart\n      title=\"Latency by capability\"\n      description=\"Last 24 hours\"\n      data={capabilities}\n      objective={{ value: 2_000, label: \"Objective\" }}\n    />\n  );\n}\n"
+      },
+      {
+        "name": "time-to-result",
+        "title": "Time to result",
+        "description": "Orazaka: the median time to a result per kind of job, in minutes when it takes minutes.",
+        "path": "examples/latency-chart/time-to-result.tsx",
+        "module": "@krizaka/charts/registry/examples/latency-chart/time-to-result",
+        "code": "import { LatencyChart } from \"@krizaka/charts/latency\";\n\n// Orazaka: how long a job takes to give its result, per kind — seconds turn into minutes.\nconst kinds = [\n  { kind: \"Summary\", median: 8_400 },\n  { kind: \"Transcript\", median: 46_000 },\n  { kind: \"Dubbing\", median: 312_000 },\n  { kind: \"Video clip\", median: 540_000 },\n];\n\nexport default function TimeToResult() {\n  return (\n    <LatencyChart\n      title=\"Time to result\"\n      data={kinds}\n      x=\"kind\"\n      p50=\"median\"\n      p95={null}\n      labels={{ p50: \"Median\", slowest: \"median of {name}, the slowest\" }}\n    />\n  );\n}\n"
+      }
+    ]
+  },
+  "native": {
+    "entry": "@krizaka/charts/native",
+    "import": "import { LatencyChart } from \"@krizaka/charts/native\";",
+    "differences": [
+      "Vertical bars only (no `vertical` prop): keep the names short.",
+      "The slowest p95 is a headline above the chart."
+    ],
+    "props": [
+      {
+        "component": "LatencyChart",
+        "description": "Median and p95 latency per item (React Native, vertical bars): the slowest p95 first.",
+        "props": [
+          {
+            "name": "data",
+            "type": "readonly T[]",
+            "default": null,
+            "description": "The rows, in the order of the x axis.",
+            "required": true
+          },
+          {
+            "name": "title",
+            "type": "string",
+            "default": null,
+            "description": "What the chart shows: its heading and accessible name.",
+            "required": true
+          },
+          {
+            "name": "brand",
+            "type": "BrandId",
+            "default": null,
+            "description": "The brand whose palette leads. Default Krizaka.",
+            "required": false
+          },
+          {
+            "name": "empty",
+            "type": "ReactNode",
+            "default": null,
+            "description": "Shown instead of the plot when there is nothing to draw. Default: the `empty` label.",
+            "required": false
+          },
+          {
+            "name": "height",
+            "type": "number",
+            "default": null,
+            "description": "The plot's height.",
+            "required": false
+          },
+          {
+            "name": "hideTitle",
+            "type": "boolean",
+            "default": null,
+            "description": "Hide the heading (it stays the accessible name).",
+            "required": false
+          },
+          {
+            "name": "labels",
+            "type": "Partial<LatencyLabels>",
+            "default": null,
+            "description": "The words, passed translated.",
+            "required": false
+          },
+          {
+            "name": "loading",
+            "type": "boolean",
+            "default": null,
+            "description": "The data is on its way.",
+            "required": false
+          },
+          {
+            "name": "locale",
+            "type": "Locale",
+            "default": null,
+            "description": "The locale of every figure and date. Default `\"en-US\"`.",
+            "required": false
+          },
+          {
+            "name": "objective",
+            "type": "{ readonly value: number; readonly label: string; }",
+            "default": null,
+            "description": "The service objective, in milliseconds.",
+            "required": false
+          },
+          {
+            "name": "p50",
+            "type": "string | ((datum: T, index: number) => number | null)",
+            "default": "\"p50\" as Accessor<T, number | null | undefined>",
+            "description": "The median, in milliseconds. Default `\"p50\"`.",
+            "required": false
+          },
+          {
+            "name": "p95",
+            "type": "string | ((datum: T, index: number) => number | null) | null",
+            "default": "\"p95\" as Accessor<T, number | null | undefined>",
+            "description": "The 95th percentile, in milliseconds. Default `\"p95\"`; `null` for the median alone.",
+            "required": false
+          },
+          {
+            "name": "scheme",
+            "type": "Mode",
+            "default": null,
+            "description": "Dark or light. Default: the device's (pass `useTheme().scheme` of\n@krizaka /ui/native to follow the app).",
+            "required": false
+          },
+          {
+            "name": "style",
+            "type": "ViewStyle",
+            "default": null,
+            "description": "The style of the chart's container (layout only: colours come from the theme).",
+            "required": false
+          },
+          {
+            "name": "theme",
+            "type": "Partial<ChartTheme>",
+            "default": null,
+            "description": "The app's colour roles (`useTheme().theme` of\n@krizaka /ui/native): a product's brand overrides apply.",
+            "required": false
+          },
+          {
+            "name": "x",
+            "type": "string | ((datum: T, index: number) => unknown)",
+            "default": "\"name\" as Accessor<T, unknown>",
+            "description": "The field naming what is measured. Default `\"name\"`.",
+            "required": false
+          }
+        ]
+      }
+    ],
+    "examples": [
+      {
+        "name": "by-capability",
+        "title": "By capability",
+        "description": "The latency per capability, on a phone.",
+        "path": "examples/latency-chart/native/by-capability.tsx",
+        "module": "@krizaka/charts/registry/examples/latency-chart/native/by-capability",
+        "code": "import { LatencyChart } from \"@krizaka/charts/native\";\n\nconst capabilities = [\n  { name: \"Chat\", p50: 420, p95: 1_180 },\n  { name: \"Embed\", p50: 85, p95: 210 },\n  { name: \"Speech\", p50: 1_350, p95: 2_900 },\n  { name: \"Image\", p50: 4_200, p95: 9_800 },\n];\n\n// Short names: the bars stand upright on a phone.\nexport default function NativeByCapability() {\n  return <LatencyChart title=\"Latency by capability\" data={capabilities} height={170} objective={{ value: 2_000, label: \"Objective\" }} />;\n}\n",
+        "screenshots": {
+          "dark": "examples/latency-chart/native/by-capability.dark.png",
+          "light": "examples/latency-chart/native/by-capability.light.png"
+        }
+      }
+    ]
+  },
+  "files": [],
+  "dependencies": [
+    "@krizaka/intl@workspace:^",
+    "d3-geo@^3.1.1",
+    "echarts@^6.1.0",
+    "topojson-client@^3.1.0"
+  ],
+  "registryDependencies": [],
+  "demo": {
+    "path": "examples/latency-chart/by-capability.tsx",
+    "content": "import { LatencyChart } from \"@krizaka/charts/latency\";\n\n// Milliseconds, per capability, over the last 24 hours (the console's supervision).\nconst capabilities = [\n  { name: \"Chat\", p50: 420, p95: 1_180 },\n  { name: \"Embeddings\", p50: 85, p95: 210 },\n  { name: \"Speech to text\", p50: 1_350, p95: 2_900 },\n  { name: \"Image\", p50: 4_200, p95: 9_800 },\n  { name: \"Translation\", p50: 610, p95: 1_640 },\n];\n\nexport default function ByCapability() {\n  return (\n    <LatencyChart\n      title=\"Latency by capability\"\n      description=\"Last 24 hours\"\n      data={capabilities}\n      objective={{ value: 2_000, label: \"Objective\" }}\n    />\n  );\n}\n"
+  },
+  "props": [
+    {
+      "component": "LatencyChart",
+      "description": "Median and p95 latency per item, durations in the unit that fits, against a service objective.",
+      "props": [
+        {
+          "name": "data",
+          "type": "readonly T[]",
+          "default": null,
+          "description": "The rows, in the order of the x axis.",
+          "required": true
+        },
+        {
+          "name": "title",
+          "type": "string",
+          "default": null,
+          "description": "What the chart shows, in a few words: its accessible name, and its heading unless `hideTitle`.",
+          "required": true
+        },
+        {
+          "name": "brand",
+          "type": "BrandId",
+          "default": null,
+          "description": "The brand whose palette the charts use. Without it, a chart follows a `.brand-<id>` ancestor, else Krizaka. Set it\nwhen the app loads a brand stylesheet on `:root` (`@krizaka/tokens/brands/orazaka.css`).",
+          "required": false
+        },
+        {
+          "name": "className",
+          "type": "string",
+          "default": null,
+          "description": "A class on the figure (layout: margins, grid placement).",
+          "required": false
+        },
+        {
+          "name": "dataTable",
+          "type": "boolean",
+          "default": null,
+          "description": "The \"Show data\" button (the table is in the page for screen readers either way). Default true.",
+          "required": false
+        },
+        {
+          "name": "description",
+          "type": "ReactNode",
+          "default": null,
+          "description": "A sentence under the title: the period, the unit, the source.",
+          "required": false
+        },
+        {
+          "name": "empty",
+          "type": "ReactNode",
+          "default": null,
+          "description": "What to show when there is nothing to draw (default: the `empty` label). An `EmptyState` of\n@krizaka /ui fits.",
+          "required": false
+        },
+        {
+          "name": "error",
+          "type": "ReactNode",
+          "default": null,
+          "description": "The data could not be loaded: `true` says the default words, a node says yours (a retry button…).",
+          "required": false
+        },
+        {
+          "name": "exportable",
+          "type": "boolean | readonly ExportFormat[]",
+          "default": null,
+          "description": "Export buttons: `true` for PNG, SVG and CSV, or the formats you want.",
+          "required": false
+        },
+        {
+          "name": "height",
+          "type": "number",
+          "default": null,
+          "description": "The height of the plot in pixels. Default 280 (a sparkline: 32).",
+          "required": false
+        },
+        {
+          "name": "hideSummary",
+          "type": "boolean",
+          "default": null,
+          "description": "Hide the slowest p95 and the count over the objective.",
+          "required": false
+        },
+        {
+          "name": "hideTitle",
+          "type": "boolean",
+          "default": null,
+          "description": "Visually hide the title (it stays the chart's accessible name): a card that already has its heading.",
+          "required": false
+        },
+        {
+          "name": "id",
+          "type": "string",
+          "default": null,
+          "description": "The id of the figure.",
+          "required": false
+        },
+        {
+          "name": "labels",
+          "type": "Partial<LatencyLabels>",
+          "default": null,
+          "description": "The words, passed translated; English by default.",
+          "required": false
+        },
+        {
+          "name": "legend",
+          "type": "boolean",
+          "default": null,
+          "description": "Show the legend (from two series). Default true.",
+          "required": false
+        },
+        {
+          "name": "live",
+          "type": "boolean",
+          "default": null,
+          "description": "Streaming data (a job queue, an auction): no entrance on updates, no announcement of every new point.",
+          "required": false
+        },
+        {
+          "name": "loading",
+          "type": "boolean",
+          "default": null,
+          "description": "The data is on its way: a skeleton of the chart, announced once.",
+          "required": false
+        },
+        {
+          "name": "locale",
+          "type": "Locale",
+          "default": null,
+          "description": "The locale of every figure and date (`\"fr-FR\"`). Default `\"en-US\"`.",
+          "required": false
+        },
+        {
+          "name": "markers",
+          "type": "readonly Marker[]",
+          "default": null,
+          "description": "Vertical markers at a category: a launch, an incident.",
+          "required": false
+        },
+        {
+          "name": "objective",
+          "type": "{ readonly value: number; readonly label: string; }",
+          "default": null,
+          "description": "The service objective, in milliseconds: a line, and the count of what goes past it (by p95).",
+          "required": false
+        },
+        {
+          "name": "onSelect",
+          "type": "((datum: T, index: number) => void)",
+          "default": null,
+          "description": "Called with the row when a point or a bar is clicked (or Enter is pressed on it).",
+          "required": false
+        },
+        {
+          "name": "p50",
+          "type": "string | ((datum: T, index: number) => number | null)",
+          "default": "\"p50\" as Accessor<T, number | null | undefined>",
+          "description": "The median, in milliseconds. Default `\"p50\"`.",
+          "required": false
+        },
+        {
+          "name": "p95",
+          "type": "string | ((datum: T, index: number) => number | null) | null",
+          "default": "\"p95\" as Accessor<T, number | null | undefined>",
+          "description": "The 95th percentile, in milliseconds. Default `\"p95\"`; `null` to draw the median alone.",
+          "required": false
+        },
+        {
+          "name": "style",
+          "type": "CSSProperties",
+          "default": null,
+          "description": "Inline style on the figure (layout only: colours come from the tokens).",
+          "required": false
+        },
+        {
+          "name": "summary",
+          "type": "\"hidden\" | \"visible\"",
+          "default": null,
+          "description": "The written summary: read by screen readers only (`\"hidden\"`, default), or shown under the chart (`\"visible\"`).",
+          "required": false
+        },
+        {
+          "name": "summaryText",
+          "type": "string",
+          "default": null,
+          "description": "Your own summary instead of the generated one (still read first by screen readers).",
+          "required": false
+        },
+        {
+          "name": "vertical",
+          "type": "boolean",
+          "default": null,
+          "description": "Vertical bars instead of horizontal ones (few, short names).",
+          "required": false
+        },
+        {
+          "name": "x",
+          "type": "string | ((datum: T, index: number) => unknown)",
+          "default": "\"name\" as Accessor<T, unknown>",
+          "description": "The field (or function) naming what is measured (a capability, a model). Default `\"name\"`.",
+          "required": false
+        },
+        {
+          "name": "xLabel",
+          "type": "string",
+          "default": null,
+          "description": "The header of the categories in the data table (`Month`).",
+          "required": false
+        },
+        {
+          "name": "zero",
+          "type": "boolean",
+          "default": null,
+          "description": "Start the value axis at zero. Default: true for bars and areas; for lines, unless the values sit far from zero.",
+          "required": false
+        }
+      ]
+    }
+  ]
+}

package/registry/line-chart.json

@@ -9,6 +9,7 @@
   "category": "charts",
   "platforms": "both",
   "engine": "svg",
+  "tier": "core",
   "whenToUse": [
     "A trend over time: a creator's earnings per month, credits used per day, latency per hour.",
     "Two or three series compared over the same period (this year and last, two plans).",