@krizaka/charts 0.1.0 → 0.2.0

package/registry/job-throughput.json

@@ -0,0 +1,654 @@
+{
+  "name": "job-throughput",
+  "package": "@krizaka/charts",
+  "type": "chart",
+  "title": "Job throughput",
+  "summary": "Jobs per period stacked by status, with the total and the success rate of the finished jobs written above.",
+  "description": "Jobs per period stacked by status, with the total and the success rate of the finished jobs written above.",
+  "status": "beta",
+  "category": "charts",
+  "platforms": "both",
+  "engine": "svg",
+  "tier": "ready-made",
+  "whenToUse": [
+    "Orazaka's insights and the console's supervision: jobs per day by status.",
+    "The mobile Jobs screen: the total and the success rate first, the week's bars under them.",
+    "Any queue whose items end in success or failure: uploads, payouts, transcodes."
+  ],
+  "whenNotToUse": [
+    {
+      "when": "Money per period.",
+      "use": "earnings-chart"
+    },
+    {
+      "when": "How long the jobs take.",
+      "use": "latency-chart"
+    },
+    {
+      "when": "The share of each kind of job, without time.",
+      "use": "pie-chart"
+    }
+  ],
+  "bestPractices": [
+    "Pass the statuses translated, in the order they should stack: the finished ones at the bottom.",
+    "Mark the statuses that end a job with `outcome`: only they count in the success rate.",
+    "Set `live` when the counts stream in: no entrance on every update."
+  ],
+  "accessibility": {
+    "keyboard": [
+      {
+        "keys": "Tab",
+        "action": "Moves the focus to the plot, then to the data and export buttons."
+      },
+      {
+        "keys": "Arrow keys",
+        "action": "Walk the periods: each one's counts by status are announced."
+      }
+    ],
+    "notes": [
+      "The statuses wear the status tones and are named in the legend: the colour is never alone.",
+      "The total and the success rate are written above the chart, in words."
+    ]
+  },
+  "related": [
+    "bar-chart",
+    "latency-chart",
+    "pie-chart"
+  ],
+  "source": "packages/charts/src/meta/job-throughput.ts",
+  "install": {
+    "web": "npm install @krizaka/charts",
+    "native": "npx expo install react-native-svg\nnpm install @krizaka/charts"
+  },
+  "web": {
+    "entry": "@krizaka/charts/throughput",
+    "import": "import { JobThroughput } from \"@krizaka/charts/throughput\";",
+    "props": [
+      {
+        "component": "JobThroughput",
+        "description": "Jobs per period, stacked by status, with the total and the success rate.",
+        "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 total and the success rate above the bars.",
+            "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<ThroughputLabels>",
+            "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": "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": "period",
+            "type": "CategoryFormat",
+            "default": "day",
+            "description": "How the periods are written. Default `\"day\"` (`Oct 11`); `\"time\"` for hours.",
+            "required": false
+          },
+          {
+            "name": "statuses",
+            "type": "readonly JobStatus[]",
+            "default": "[\n  { key: \"completed\", label: \"Completed\", tone: \"success\", outcome: \"succeeded\" },\n  { key: \"failed\", label: \"Failed\", tone: \"danger\", outcome: \"failed\" },\n  { key: \"running\", label: \"Running\", tone: \"info\" },\n  { key: \"queued\", label: \"Queued\", tone: \"neutral\" },\n]",
+            "description": "The statuses, in stacking order, with their field, name and tone. Default: completed, failed, running, queued.",
+            "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": "thresholds",
+            "type": "readonly Threshold[]",
+            "default": null,
+            "description": "Horizontal lines at a value: a goal, a payout threshold.",
+            "required": false
+          },
+          {
+            "name": "x",
+            "type": "string | ((datum: T, index: number) => unknown)",
+            "default": "\"day\" as Accessor<T, unknown>",
+            "description": "The field (or function) of the period. Default `\"day\"`.",
+            "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": "week-of-jobs",
+        "title": "A week of jobs",
+        "description": "Seven days of Orazaka jobs by status, the success rate above.",
+        "path": "examples/job-throughput/week-of-jobs.tsx",
+        "module": "@krizaka/charts/registry/examples/job-throughput/week-of-jobs",
+        "code": "import { JobThroughput } from \"@krizaka/charts/throughput\";\n\n// Orazaka jobs per day, by status (the default statuses: completed, failed, running, queued).\nconst days = [\n  { day: \"2026-10-05\", completed: 1_240, failed: 38, running: 0, queued: 0 },\n  { day: \"2026-10-06\", completed: 1_612, failed: 41, running: 0, queued: 0 },\n  { day: \"2026-10-07\", completed: 1_505, failed: 95, running: 0, queued: 0 },\n  { day: \"2026-10-08\", completed: 1_788, failed: 27, running: 0, queued: 0 },\n  { day: \"2026-10-09\", completed: 1_934, failed: 33, running: 0, queued: 0 },\n  { day: \"2026-10-10\", completed: 1_102, failed: 19, running: 0, queued: 0 },\n  { day: \"2026-10-11\", completed: 986, failed: 12, running: 24, queued: 63 },\n];\n\nexport default function WeekOfJobs() {\n  return <JobThroughput title=\"Jobs this week\" data={days} labels={{ total: \"jobs over {count} days\" }} />;\n}\n"
+      },
+      {
+        "name": "live-hours",
+        "title": "Live, per hour",
+        "description": "The last hours, `live`, with the console's own statuses.",
+        "path": "examples/job-throughput/live-hours.tsx",
+        "module": "@krizaka/charts/registry/examples/job-throughput/live-hours",
+        "code": "import { JobThroughput } from \"@krizaka/charts/throughput\";\n\n// The console, per hour and live: its own statuses, translated by the app.\nconst hours = [\n  { hour: \"2026-10-11T09:00:00Z\", done: 212, rejected: 4, waiting: 9 },\n  { hour: \"2026-10-11T10:00:00Z\", done: 268, rejected: 7, waiting: 14 },\n  { hour: \"2026-10-11T11:00:00Z\", done: 301, rejected: 22, waiting: 31 },\n  { hour: \"2026-10-11T12:00:00Z\", done: 244, rejected: 5, waiting: 12 },\n  { hour: \"2026-10-11T13:00:00Z\", done: 190, rejected: 3, waiting: 40 },\n];\n\nexport default function LiveHours() {\n  return (\n    <JobThroughput\n      title=\"Requests per hour\"\n      data={hours}\n      x=\"hour\"\n      period=\"time\"\n      live\n      statuses={[\n        { key: \"done\", label: \"Done\", tone: \"success\", outcome: \"succeeded\" },\n        { key: \"rejected\", label: \"Rejected\", tone: \"danger\", outcome: \"failed\" },\n        { key: \"waiting\", label: \"Waiting\", tone: \"neutral\" },\n      ]}\n      labels={{ total: \"requests over {count} hours\" }}\n    />\n  );\n}\n"
+      }
+    ]
+  },
+  "native": {
+    "entry": "@krizaka/charts/native",
+    "import": "import { JobThroughput } from \"@krizaka/charts/native\";",
+    "differences": [
+      "The total and the success rate are a headline above the chart.",
+      "No data table or export: swipe on the chart to hear each period."
+    ],
+    "props": [
+      {
+        "component": "JobThroughput",
+        "description": "Jobs per period stacked by status (React Native): the total and the success rate 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<ThroughputLabels>",
+            "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": "period",
+            "type": "CategoryFormat",
+            "default": "day",
+            "description": "How the periods are written. Default `\"day\"`.",
+            "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": "statuses",
+            "type": "readonly JobStatus[]",
+            "default": "[\n  { key: \"completed\", label: \"Completed\", tone: \"success\", outcome: \"succeeded\" },\n  { key: \"failed\", label: \"Failed\", tone: \"danger\", outcome: \"failed\" },\n  { key: \"running\", label: \"Running\", tone: \"info\" },\n  { key: \"queued\", label: \"Queued\", tone: \"neutral\" },\n]",
+            "description": "The statuses, in stacking order. Default: completed, failed, running, queued.",
+            "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": "\"day\" as Accessor<T, unknown>",
+            "description": "The field of the period. Default `\"day\"`.",
+            "required": false
+          }
+        ]
+      }
+    ],
+    "examples": [
+      {
+        "name": "week-of-jobs",
+        "title": "A week of jobs",
+        "description": "The mobile Jobs screen: the week's jobs by status.",
+        "path": "examples/job-throughput/native/week-of-jobs.tsx",
+        "module": "@krizaka/charts/registry/examples/job-throughput/native/week-of-jobs",
+        "code": "import { JobThroughput } from \"@krizaka/charts/native\";\n\nconst days = [\n  { day: \"2026-10-05\", completed: 1_240, failed: 38, running: 0, queued: 0 },\n  { day: \"2026-10-06\", completed: 1_612, failed: 41, running: 0, queued: 0 },\n  { day: \"2026-10-07\", completed: 1_505, failed: 95, running: 0, queued: 0 },\n  { day: \"2026-10-08\", completed: 1_788, failed: 27, running: 0, queued: 0 },\n  { day: \"2026-10-09\", completed: 1_934, failed: 33, running: 0, queued: 0 },\n  { day: \"2026-10-10\", completed: 1_102, failed: 19, running: 0, queued: 0 },\n  { day: \"2026-10-11\", completed: 986, failed: 12, running: 24, queued: 63 },\n];\n\n// The mobile Jobs screen: the total and the success rate first.\nexport default function NativeWeekOfJobs() {\n  return <JobThroughput title=\"Jobs this week\" data={days} height={160} labels={{ total: \"jobs over {count} days\" }} />;\n}\n",
+        "screenshots": {
+          "dark": "examples/job-throughput/native/week-of-jobs.dark.png",
+          "light": "examples/job-throughput/native/week-of-jobs.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/job-throughput/week-of-jobs.tsx",
+    "content": "import { JobThroughput } from \"@krizaka/charts/throughput\";\n\n// Orazaka jobs per day, by status (the default statuses: completed, failed, running, queued).\nconst days = [\n  { day: \"2026-10-05\", completed: 1_240, failed: 38, running: 0, queued: 0 },\n  { day: \"2026-10-06\", completed: 1_612, failed: 41, running: 0, queued: 0 },\n  { day: \"2026-10-07\", completed: 1_505, failed: 95, running: 0, queued: 0 },\n  { day: \"2026-10-08\", completed: 1_788, failed: 27, running: 0, queued: 0 },\n  { day: \"2026-10-09\", completed: 1_934, failed: 33, running: 0, queued: 0 },\n  { day: \"2026-10-10\", completed: 1_102, failed: 19, running: 0, queued: 0 },\n  { day: \"2026-10-11\", completed: 986, failed: 12, running: 24, queued: 63 },\n];\n\nexport default function WeekOfJobs() {\n  return <JobThroughput title=\"Jobs this week\" data={days} labels={{ total: \"jobs over {count} days\" }} />;\n}\n"
+  },
+  "props": [
+    {
+      "component": "JobThroughput",
+      "description": "Jobs per period, stacked by status, with the total and the success rate.",
+      "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 total and the success rate above the bars.",
+          "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<ThroughputLabels>",
+          "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": "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": "period",
+          "type": "CategoryFormat",
+          "default": "day",
+          "description": "How the periods are written. Default `\"day\"` (`Oct 11`); `\"time\"` for hours.",
+          "required": false
+        },
+        {
+          "name": "statuses",
+          "type": "readonly JobStatus[]",
+          "default": "[\n  { key: \"completed\", label: \"Completed\", tone: \"success\", outcome: \"succeeded\" },\n  { key: \"failed\", label: \"Failed\", tone: \"danger\", outcome: \"failed\" },\n  { key: \"running\", label: \"Running\", tone: \"info\" },\n  { key: \"queued\", label: \"Queued\", tone: \"neutral\" },\n]",
+          "description": "The statuses, in stacking order, with their field, name and tone. Default: completed, failed, running, queued.",
+          "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": "thresholds",
+          "type": "readonly Threshold[]",
+          "default": null,
+          "description": "Horizontal lines at a value: a goal, a payout threshold.",
+          "required": false
+        },
+        {
+          "name": "x",
+          "type": "string | ((datum: T, index: number) => unknown)",
+          "default": "\"day\" as Accessor<T, unknown>",
+          "description": "The field (or function) of the period. Default `\"day\"`.",
+          "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
+        }
+      ]
+    }
+  ]
+}