@danxbot/ui 18.2.0 → 18.2.1

package/dist/types/components/chart/TimeSeriesChart.d.ts

@@ -0,0 +1,62 @@
+import { type Ref } from "react";
+export type TimeSeriesRole = "member" | "other";
+export interface TimeSeriesSeries {
+    /** Unique within the chart. */
+    key: string;
+    label: string;
+    /** `other` is the neutral remainder: drawn last, in a neutral tone, never selectable. @default "member" */
+    role?: TimeSeriesRole;
+    /** One value per bucket, same order. Finite and >= 0 — anything else throws. */
+    points: readonly number[];
+}
+/** A named kind of unmeasured span: its label is its legend entry. At most two (45 and 135 degree hatching). */
+export interface TimeSeriesBlockKind {
+    key: string;
+    label: string;
+}
+/** A span the chart cannot place in time, drawn hatched in the bucket that holds `at`. */
+export interface TimeSeriesBlock {
+    /** Unique within the chart. */
+    id: string;
+    /** Epoch ms; must fall inside one of the buckets. */
+    at: number;
+    /** Finite and >= 0. Counts toward the bucket total. */
+    value: number;
+    /** What this span is, for its tooltip line and the table. */
+    label: string;
+    /** A `TimeSeriesBlockKind.key`. */
+    kind: string;
+}
+export interface TimeSeriesChartProps {
+    /** Each bucket's start, epoch ms, strictly ascending. */
+    buckets: readonly number[];
+    /** The width of one bucket in ms; null only when there are no buckets. */
+    bucketMs: number | null;
+    /** In stacking order, bottom first; also the palette order. */
+    series: readonly TimeSeriesSeries[];
+    blocks?: readonly TimeSeriesBlock[];
+    blockKinds?: readonly TimeSeriesBlockKind[];
+    /** What the chart measures, e.g. "Tokens over time". Names the group and captions the table. */
+    label: string;
+    /** @default "bar" */
+    variant?: "bar" | "area";
+    /** How a raw value reads in the tooltip and the table. @default locale-formatted number */
+    formatValue?: (value: number) => string;
+    /** How a value reads on the y axis; use a compact form here. @default `formatValue` */
+    formatAxis?: (value: number) => string;
+    /** Locale of the time labels. @default the viewer's */
+    locale?: string;
+    /** IANA zone the buckets are labelled in, e.g. "UTC". @default the viewer's */
+    timeZone?: string;
+    /** Called with a member series' key when its band or its legend name is clicked. */
+    onSelectSeries?: (key: string) => void;
+    /** Plot height in px. @default 240 */
+    height?: number;
+    /** Said when there is nothing to draw. @default "No data" */
+    emptyLabel?: string;
+    /** Said over the axis when every value is zero. @default "All values are zero" */
+    zeroLabel?: string;
+    className?: string;
+    ref?: Ref<HTMLDivElement>;
+}
+export declare function TimeSeriesChart(props: TimeSeriesChartProps): import("react").JSX.Element;

package/dist/types/components/chart/time-series-scale.d.ts

@@ -0,0 +1,29 @@
+export declare const MINUTE_MS = 60000;
+export declare const DAY_MS = 86400000;
+/**
+ * A value axis that starts at zero and ends on a round number at or above
+ * `max`, with about `count` intervals: steps of 1, 2 or 5 times a power of ten.
+ * No data (`max <= 0`) is a 0-to-1 axis, never a zero-height one.
+ */
+export declare function niceTicks(max: number, count?: number): {
+    ticks: number[];
+    max: number;
+};
+export interface TimeFormatters {
+    /** The label under a tick: a primary line, and a secondary line when the day (or year) changed since the last tick. */
+    tick: (ms: number, previousMs: number | null) => {
+        primary: string;
+        secondary: string | null;
+    };
+    /** The whole instant, for the tooltip and the table. */
+    full: (ms: number) => string;
+}
+/**
+ * How a bucket start reads for a bucket this wide. Under a day the time is the
+ * label and the date appears where it changes; a day or wider is labelled by
+ * its date; a month or wider by month and year. `timeZone` is passed straight
+ * to `Intl` (an unknown zone throws, loudly); undefined is the viewer's own.
+ */
+export declare function timeFormatters(bucketMs: number, locale: string | undefined, timeZone: string | undefined): TimeFormatters;
+/** The index of the bucket whose span `[start, start + bucketMs)` holds `at`, or -1. */
+export declare function bucketIndexAt(buckets: readonly number[], bucketMs: number, at: number): number;

package/dist/types/index.d.ts

@@ -75,6 +75,7 @@ export { ConcentricRing, type ConcentricRingProps, type ConcentricRingLevel, } f
 export { Stat, StatRow, Sparkline, type StatProps, type StatRowProps, type SparklineProps, type StatSize, type StatTrend, type StatSentiment, } from "./components/Stat";
 export { ShareBar, type ShareBarProps, type ShareBarSegment, } from "./components/chart/ShareBar";
 export { BarList, type BarListProps, type BarListItem, } from "./components/chart/BarList";
+export { TimeSeriesChart, type TimeSeriesChartProps, type TimeSeriesSeries, type TimeSeriesRole, type TimeSeriesBlock, type TimeSeriesBlockKind, } from "./components/chart/TimeSeriesChart";
 export { CHART_SERIES_COUNT, CHART_SERIES_TOKENS, CHART_SEQUENTIAL_TOKEN, CHART_SEQUENTIAL_COLOR, chartSeriesColor, } from "./lib/chart-palette";
 export { DataTable, TableEmptyState, CellStack, type DataTableProps, type TableDensity, } from "./components/Table";
 export { CodeEditor, CodeEditorToolbar, CodeEditorCaption, CodeEditorCopyButton, CodeEditorWrapToggle, CodeEditorViewSwitch, type CodeEditorProps, type CodeEditorToolbarProps, type CodeEditorView, } from "./components/CodeEditor";

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@danxbot/ui",
-  "version": "18.2.0",
+  "version": "18.2.1",
   "type": "module",
   "description": "Danxbot — a domain-agnostic React design system with motion as a first-class primitive.",
   "license": "MIT",