@k2b/ui 0.49.0 → 0.51.0

package/dist/types/charts/core/inspection.d.ts

@@ -0,0 +1,16 @@
+import { type ChartDatum, type ChartKind } from "./types";
+export type ChartDatumRef = Pick<ChartDatum, "role" | "index" | "seriesIndex">;
+export declare const sameChartDatum: (a: ChartDatumRef, b: ChartDatumRef) => boolean;
+export type ChartSelection = {
+    kind: ChartKind;
+    datum: ChartDatum;
+};
+export type ChartTooltip = {
+    title?: string;
+    rows: readonly {
+        label: string;
+        value: string;
+    }[];
+};
+export type ChartTooltipFormatter = (selection: ChartSelection) => ChartTooltip;
+export declare function isChartDatum(value: unknown): value is ChartDatum;

package/dist/types/charts/core/map.d.ts

@@ -0,0 +1,3 @@
+import { type MapOptions } from "./svg-renderers";
+/** Render geographic point series over a dependency-free world land map. */
+export declare function map(opts: MapOptions): string;

package/dist/types/charts/core/registry.d.ts

@@ -0,0 +1,33 @@
+import { renderBarChartSvg } from "../../content/chart-bar";
+import { renderStateTimelineSvg } from "../../content/chart-state-timeline";
+import { renderAreaSvg } from "./area";
+import { renderHeatmapSvg } from "./calendar";
+import { renderHbarSvg } from "./hbar";
+import { map } from "./map";
+import { barGauge, boxplot, donut, gauge, histogram, line, pie, scatter, sparkline, stat } from "./svg-renderers";
+import { renderWaterfallSvg } from "./waterfall";
+export declare const chartRenderers: {
+    waterfall: typeof renderWaterfallSvg;
+    area: typeof renderAreaSvg;
+    line: typeof line;
+    bar: typeof renderBarChartSvg;
+    hbar: typeof renderHbarSvg;
+    pie: typeof pie;
+    donut: typeof donut;
+    scatter: typeof scatter;
+    sparkline: typeof sparkline;
+    histogram: typeof histogram;
+    boxplot: typeof boxplot;
+    gauge: typeof gauge;
+    barGauge: typeof barGauge;
+    stat: typeof stat;
+    heatmap: typeof renderHeatmapSvg;
+    map: typeof map;
+    stateTimeline: typeof renderStateTimelineSvg;
+};
+type Kind = keyof typeof chartRenderers;
+type ChartKinds = {
+    [K in Kind as Capitalize<K>]: K;
+};
+export declare const chartKinds: ChartKinds;
+export {};

package/dist/types/charts/core/render-size.d.ts

@@ -0,0 +1,7 @@
+import type { ChartRenderOptions } from "./render";
+import type { ChartKind } from "./types";
+/** Standard logical height, or compact bar-gauge rows for a host without an explicit height. */
+export declare const chartRenderHeight: (props: ChartRenderOptions, sizing?: {
+    contentHeight?: boolean;
+}) => number;
+export declare const preservesAspectRatio: (kind: ChartKind) => kind is "donut" | "gauge" | "map" | "pie";

package/dist/types/charts/core/render.d.ts

@@ -0,0 +1,37 @@
+import { type StateTimelineDomain } from "../../content/chart-state-timeline";
+import { type ChartTimeAxis } from "../../content/chart-time-axis";
+import { chartRenderers } from "./registry";
+import type { MapViewport } from "./svg";
+import type { ChartKind } from "./types";
+type DrawingOptions<T> = T extends unknown ? Omit<T, "width" | "height" | "inspect" | "interactive"> : never;
+type RenderOptions<T> = T extends unknown ? Omit<T, "legendPlacement"> : never;
+export type ChartDrawingOptions = {
+    [K in ChartKind]: {
+        kind: K;
+    } & (K extends "map" ? {
+        /** Target when zooming in from the world view. Defaults to Europe (50, 10). */
+        zoomFocus?: Pick<MapViewport, "latitude" | "longitude">;
+    } : {}) & (K extends "line" ? {
+        /** Largest connected X distance; positive, finite, without area/errorBand fills. */
+        maxGap?: number;
+        /** Wrap the legend above the plot inside the caller's total chart height. Requires legend=true. */
+        legendPlacement?: "top-start";
+        /** Round ticks for instant X values (Unix ms), in the supplied zone. xAxis.format labels them. */
+        timeAxis?: ChartTimeAxis;
+    } : {}) & DrawingOptions<Parameters<(typeof chartRenderers)[K]>[0]>;
+}[ChartKind];
+export type ChartRenderOptions = RenderOptions<ChartDrawingOptions>;
+export { chartRenderHeight, preservesAspectRatio } from "./render-size";
+/** Shared logical SVG renderer; callbacks and browser interaction stay with the Solid host. */
+export declare const renderChartSvg: (props: ChartDrawingOptions, width: number, height: number, mapViewport?: MapViewport, timelineViewport?: StateTimelineDomain, renderLocale?: string) => string;
+export type ChartSize = {
+    width: number;
+    height: number;
+};
+export type ChartScene = ChartSize & {
+    kind: ChartKind;
+    svg: string;
+};
+/** Lay out a chart in a fixed logical coordinate space, without browser measurement. */
+export declare const layout: (spec: ChartDrawingOptions, size: ChartSize) => ChartScene;
+export declare const toSvg: (scene: ChartScene) => string;

package/dist/types/charts/core/snapshot.d.ts

@@ -0,0 +1,27 @@
+import { type ChartSelection, type ChartTooltip, type ChartTooltipFormatter } from "./inspection";
+import { type ChartRenderOptions, chartRenderHeight } from "./render";
+import type { ChartDatum, ChartKind } from "./types";
+/** Trusted output of prepareChartSnapshot; never accept arbitrary user SVG. */
+export type ChartSnapshot = {
+    kind: ChartKind;
+    svg: string;
+    width: number;
+    height: number;
+    stretch: boolean;
+    minWidth?: number;
+    marks: readonly {
+        key: string;
+        rowKey: string;
+        datum: ChartDatum;
+        tooltip: ChartTooltip;
+        reference?: boolean;
+    }[];
+};
+/** Pure SVG preparation for server or browser. Transfer only this output across SSR boundaries. */
+export declare function prepareChartSnapshot(options: ChartRenderOptions, inspection: {
+    key: (selection: ChartSelection) => string;
+    /** Defaults to the mark key for one-to-one charts. */
+    rowKey?: (selection: ChartSelection) => string;
+    tooltip: ChartTooltipFormatter;
+    reference?: (selection: ChartSelection) => boolean;
+}, sizing?: Parameters<typeof chartRenderHeight>[1]): ChartSnapshot;