@howells/hairline 0.0.0-stage → 0.2.0

package/lib/types/schema/slope.d.ts

@@ -0,0 +1,120 @@
+import { z } from "zod";
+import type { FormatInput } from "./format.js";
+import type { SharedCallbacks } from "./options.js";
+/** One line: a name and its values at the two points. */
+export declare const slopeRowSchema: z.ZodObject<{
+    from: z.ZodNumber;
+    id: z.ZodOptional<z.ZodString>;
+    name: z.ZodString;
+    to: z.ZodNumber;
+}, z.core.$strict>;
+export declare const slopeSchema: z.ZodObject<{
+    animate: z.ZodOptional<z.ZodEnum<{
+        mount: "mount";
+        off: "off";
+        scroll: "scroll";
+    }>>;
+    replayKey: z.ZodOptional<z.ZodUnion<readonly [z.ZodString, z.ZodNumber]>>;
+    fit: z.ZodOptional<z.ZodBoolean>;
+    scale: z.ZodOptional<z.ZodNumber>;
+    strokes: z.ZodOptional<z.ZodEnum<{
+        device: "device";
+        proportional: "proportional";
+    }>>;
+    idPrefix: z.ZodOptional<z.ZodString>;
+    metrics: z.ZodOptional<z.ZodObject<{
+        advances: z.ZodRecord<z.ZodString, z.ZodNumber>;
+        fallback: z.ZodNumber;
+        tabular: z.ZodOptional<z.ZodNumber>;
+    }, z.core.$strict>>;
+    table: z.ZodOptional<z.ZodBoolean>;
+    title: z.ZodOptional<z.ZodString>;
+    domain: z.ZodOptional<z.ZodTuple<[z.ZodNumber, z.ZodNumber], null>>;
+    emphasis: z.ZodOptional<z.ZodString>;
+    format: z.ZodOptional<z.ZodUnion<readonly [z.ZodEnum<{
+        compact: "compact";
+        decimal: "decimal";
+        integer: "integer";
+        percent: "percent";
+    }>, z.ZodObject<{
+        compactDisplay: z.ZodOptional<z.ZodEnum<{
+            long: "long";
+            short: "short";
+        }>>;
+        currency: z.ZodOptional<z.ZodString>;
+        locale: z.ZodOptional<z.ZodString>;
+        maximumFractionDigits: z.ZodOptional<z.ZodNumber>;
+        minimumFractionDigits: z.ZodOptional<z.ZodNumber>;
+        notation: z.ZodOptional<z.ZodEnum<{
+            compact: "compact";
+            standard: "standard";
+        }>>;
+        signDisplay: z.ZodOptional<z.ZodEnum<{
+            always: "always";
+            auto: "auto";
+            exceptZero: "exceptZero";
+            never: "never";
+        }>>;
+        style: z.ZodOptional<z.ZodEnum<{
+            currency: "currency";
+            decimal: "decimal";
+            percent: "percent";
+            unit: "unit";
+        }>>;
+        unit: z.ZodOptional<z.ZodString>;
+        useGrouping: z.ZodOptional<z.ZodBoolean>;
+    }, z.core.$strict>]>>;
+    height: z.ZodOptional<z.ZodNumber>;
+    initialWidth: z.ZodOptional<z.ZodNumber>;
+    label: z.ZodOptional<z.ZodString>;
+    labels: z.ZodTuple<[z.ZodString, z.ZodString], null>;
+    narrowFormat: z.ZodOptional<z.ZodUnion<readonly [z.ZodEnum<{
+        compact: "compact";
+        decimal: "decimal";
+        integer: "integer";
+        percent: "percent";
+    }>, z.ZodObject<{
+        compactDisplay: z.ZodOptional<z.ZodEnum<{
+            long: "long";
+            short: "short";
+        }>>;
+        currency: z.ZodOptional<z.ZodString>;
+        locale: z.ZodOptional<z.ZodString>;
+        maximumFractionDigits: z.ZodOptional<z.ZodNumber>;
+        minimumFractionDigits: z.ZodOptional<z.ZodNumber>;
+        notation: z.ZodOptional<z.ZodEnum<{
+            compact: "compact";
+            standard: "standard";
+        }>>;
+        signDisplay: z.ZodOptional<z.ZodEnum<{
+            always: "always";
+            auto: "auto";
+            exceptZero: "exceptZero";
+            never: "never";
+        }>>;
+        style: z.ZodOptional<z.ZodEnum<{
+            currency: "currency";
+            decimal: "decimal";
+            percent: "percent";
+            unit: "unit";
+        }>>;
+        unit: z.ZodOptional<z.ZodString>;
+        useGrouping: z.ZodOptional<z.ZodBoolean>;
+    }, z.core.$strict>]>>;
+    rows: z.ZodArray<z.ZodObject<{
+        from: z.ZodNumber;
+        id: z.ZodOptional<z.ZodString>;
+        name: z.ZodString;
+        to: z.ZodNumber;
+    }, z.core.$strict>>;
+    width: z.ZodOptional<z.ZodNumber>;
+}, z.core.$strict>;
+/** One line. */
+export type SlopeRow = z.infer<typeof slopeRowSchema>;
+/** The validated payload. */
+export type SlopeData = z.infer<typeof slopeSchema>;
+/** What `<Slope>` takes: the payload, with formats also allowed as functions. */
+export type SlopeProps = SharedCallbacks & Omit<z.input<typeof slopeSchema>, "format" | "narrowFormat"> & {
+    format?: FormatInput;
+    narrowFormat?: FormatInput;
+};

package/lib/types/schema/validate.d.ts

@@ -0,0 +1,29 @@
+import type { ZodType } from "zod";
+/** One thing wrong with a payload, located by its path. */
+export interface Issue {
+    /** Machine-readable reason, e.g. "invalid_type", "too_small", "unrecognized_keys". */
+    code: string;
+    message: string;
+    /** Where, as segments: ["data", 2, "value"]. */
+    path: (string | number)[];
+    /** The same path as text: "data[2].value"; "" for the payload itself. */
+    pointer: string;
+}
+/**
+ * A payload as it arrives, before `validate` has seen it: JSON as an agent
+ * writes it, plus the `undefined` of an omitted field.
+ */
+export type Payload = boolean | number | string | null | undefined | readonly Payload[] | {
+    readonly [key: string]: Payload;
+};
+export type Validated<T> = {
+    ok: true;
+    value: T;
+} | {
+    issues: Issue[];
+    ok: false;
+};
+/** ["data", 2, "value"] as "data[2].value". */
+export declare const pointerOf: (path: readonly (string | number)[]) => string;
+/** Check `input` against a schema: the parsed value, or path-specific issues. */
+export declare const validate: <T>(schema: ZodType<T>, input: Payload) => Validated<T>;

package/lib/types/schema.d.ts

@@ -0,0 +1,30 @@
+export { isoDateSchema, dailyDatumSchema } from "./schema/daily.js";
+export type { DailyDatum } from "./schema/daily.js";
+export { dumbbellDatumSchema, dumbbellQueueSchema, } from "./schema/dumbbell-queue.js";
+export type { DumbbellDatum, DumbbellQueueData, DumbbellQueueProps, } from "./schema/dumbbell-queue.js";
+export { FORMAT_PRESETS, intlFormatSchema, formatSchema, resolveFormat, DATE_FORMAT_PRESETS, dateFormatSchema, resolveDateFormat, } from "./schema/format.js";
+export type { FormatDescriptor, FormatInput, DateFormatDescriptor, DateFormatInput, } from "./schema/format.js";
+export { hairlineAreaSchema } from "./schema/hairline-area.js";
+export type { HairlineAreaData, HairlineAreaProps, } from "./schema/hairline-area.js";
+export { hairlineLineSchema } from "./schema/hairline-line.js";
+export type { HairlineLineData, HairlineLineProps, } from "./schema/hairline-line.js";
+export { keyOf } from "./schema/key.js";
+export type { Keyed } from "./schema/key.js";
+export { fontMetricsSchema, INTER_METRICS, textWidth } from "./schema/metrics.js";
+export type { FontMetrics } from "./schema/metrics.js";
+export { motionShape } from "./schema/motion.js";
+export type { MotionCallbacks } from "./schema/motion.js";
+export { sharedShape, noteShape } from "./schema/options.js";
+export type { NoteNames, NoteProps, SharedCallbacks } from "./schema/options.js";
+export { plumbDatumSchema, plumbScatterSchema } from "./schema/plumb-scatter.js";
+export type { PlumbDatum, PlumbScatterData, PlumbScatterProps, } from "./schema/plumb-scatter.js";
+export { charts, registry, getChart } from "./schema/registry.js";
+export type { Job, ChartEntry, ChartKind } from "./schema/registry.js";
+export { rungDatumSchema, rungBarsSchema } from "./schema/rung-bars.js";
+export type { RungDatum, RungBarsData, RungBarsProps, } from "./schema/rung-bars.js";
+export { scaleShape } from "./schema/scale.js";
+export type { ScaleOptions } from "./schema/scale.js";
+export { slopeRowSchema, slopeSchema } from "./schema/slope.js";
+export type { SlopeRow, SlopeData, SlopeProps } from "./schema/slope.js";
+export { pointerOf, validate } from "./schema/validate.js";
+export type { Issue, Payload, Validated } from "./schema/validate.js";

package/lib/types/theme/derive.d.ts

@@ -0,0 +1,23 @@
+export type ThemeMode = "light" | "dark";
+export interface ThemeInput {
+    /** The ground of the chart: page, slide or card. `#rrggbb`. */
+    paper: string;
+    /** The strongest mark and text colour. `#rrggbb`. */
+    ink: string;
+    /** The one highlighted element. Defaults to the ink (a step below it in dark mode). */
+    hero?: string;
+    /** Thresholds and regressions. Defaults to a red chosen for the mode. */
+    alert?: string;
+    /** Override the faint grid line colour (defaults to a step off the paper). */
+    grid?: string;
+    /** Override the quiet rule colour (defaults to a step off the paper). */
+    rule?: string;
+    /** The chart font stack, set as `--hl-font`. Omitted: the host's inherited font. */
+    font?: string;
+    /** Whether the paper is light or dark. Defaults to light. */
+    mode?: ThemeMode;
+}
+/** Plain CSS custom properties; assignable to a React `style` prop. */
+export type ThemeProperties = Record<`--hl-${string}`, string>;
+/** Every colour a chart draws with, from a few. */
+export declare const deriveTheme: (input: ThemeInput) => ThemeProperties;

package/lib/types/theme.d.ts

@@ -0,0 +1,2 @@
+export { deriveTheme } from "./theme/derive.js";
+export type { ThemeInput, ThemeMode, ThemeProperties } from "./theme/derive.js";