@weasel-js/theme 1.5.1 → 1.6.0

package/dist/theme-BtpBHcUg.d.ts

@@ -1,189 +0,0 @@
-/** One value of an axis. `scheme` becomes `color-scheme` in that value's CSS blocks. */
-interface AxisValue {
-    readonly scheme?: 'dark' | 'light';
-}
-interface AxisDef {
-    readonly default: string;
-    readonly values: Readonly<Record<string, AxisValue>>;
-}
-/** Key order is declaration order, which selectors and selection keys follow. */
-type AxisDefs = Readonly<Record<string, AxisDef>>;
-/** A partial choice of axis values, e.g. `{ mode: 'light' }`. */
-type Selection = Readonly<Record<string, string>>;
-/** `{ by: 'mode', dark: …, light: … }`: a value that differs per axis value. */
-interface ByAxis<T> {
-    readonly by: string;
-    readonly [axisValue: string]: Varying<T> | string;
-}
-type Varying<T> = T | ByAxis<T>;
-declare function isByAxis(v: unknown): v is ByAxis<unknown>;
-/** Every axis given a known value; anything missing or unknown takes its default. */
-declare function fullSelection(axes: AxisDefs, selection?: Selection): Selection;
-declare function enumerateSelections(axes: AxisDefs): Selection[];
-/** `mode=dark,density=compact`, axes in declaration order. */
-declare function selectionKey(axes: AxisDefs, selection: Selection): string;
-
-type TokenValue = string | number | readonly (string | number)[];
-/**
- * A single design token as authored, before aliases are resolved: a DTCG-shaped
- * `{ type, value }` pair where `value` may still be a `{ref}` to another token.
- */
-interface RawToken {
-    readonly type: string;
-    readonly value: TokenValue;
-    /** Render the referenced color at this alpha, 0–1. */
-    readonly alpha?: number | undefined;
-    readonly description?: string | undefined;
-}
-/** A token graph flattened to one level, keyed by token name (no `--wzl-`
- *  prefix). Still unresolved — see `ResolvedTokenMap` for the output side. */
-type FlatTokens = Record<string, RawToken>;
-
-/** A number, or `{seeds.name}`. */
-type NumberParam = Varying<number | string>;
-interface PinObject {
-    readonly value: TokenValue;
-    readonly type?: string;
-    readonly description?: string;
-    readonly alpha?: number;
-}
-/** A bare value or `{ value, type?, description?, alpha? }`. The value may be a `{token}` reference. */
-type PinValue = TokenValue | PinObject;
-interface LightnessRampDef {
-    readonly kind: 'lightness';
-    readonly steps: Varying<readonly string[]>;
-    /** First and last step's OKLCH lightness. */
-    readonly lightness: Varying<readonly [NumberParam, NumberParam]>;
-    /** 0 walks evenly; 1 follows a smoothstep S. */
-    readonly curve?: NumberParam;
-    /** Degrees. Ignored when an anchor is given. */
-    readonly hue?: NumberParam;
-    readonly chroma?: Varying<{
-        readonly peak: NumberParam;
-        readonly lightBias?: NumberParam;
-        readonly darkBias?: NumberParam;
-    }>;
-    /** Step name → exact hex (or `{seeds.name}`). The first anchor supplies hue and chroma. */
-    readonly anchor?: Varying<Readonly<Record<string, Varying<string>>>>;
-    readonly description?: string;
-    readonly describe?: Readonly<Record<string, string>>;
-}
-interface CategoricalRampDef {
-    readonly kind: 'categorical';
-    readonly steps: Varying<readonly string[]>;
-    /** Any of the palette generator's `Constraints` except `count` and `anchors`. */
-    readonly gates?: Varying<Readonly<Record<string, Varying<number | string>>>>;
-    readonly anchors?: readonly {
-        readonly name: string;
-        readonly hue: number;
-        readonly lightness: number;
-        readonly chroma?: number;
-    }[];
-    readonly description?: string;
-    readonly describe?: Readonly<Record<string, string>>;
-}
-type RampDef = LightnessRampDef | CategoricalRampDef;
-interface ScaleDef {
-    readonly steps: Varying<readonly string[]>;
-    readonly base: NumberParam;
-    /** Linear: `base + step × i`. */
-    readonly step?: NumberParam;
-    /** Geometric: `base × ratio^i`. */
-    readonly ratio?: NumberParam;
-    readonly description?: string;
-    readonly describe?: Readonly<Record<string, string>>;
-}
-interface SemanticCommon {
-    readonly type?: string;
-    readonly description?: string;
-    /** Audited, never applied. */
-    readonly check?: {
-        readonly contrast: number;
-        readonly against: readonly string[];
-    };
-}
-type StepRule = SemanticCommon & {
-    readonly ramp: string;
-    readonly step: Varying<string>;
-};
-type OffsetRule = SemanticCommon & {
-    readonly from: string;
-    readonly offset: number;
-    readonly dir: 'lighter' | 'darker' | 'away';
-};
-type ContrastRule = SemanticCommon & {
-    readonly ramp: string;
-    readonly contrast: {
-        readonly min: number;
-        readonly against: readonly string[];
-    };
-};
-type RefRule = SemanticCommon & {
-    readonly ref: string;
-    readonly alpha?: number;
-};
-type LiteralRule = SemanticCommon & {
-    readonly value: TokenValue;
-};
-type SemanticRule = StepRule | OffsetRule | ContrastRule | RefRule | LiteralRule;
-interface ThemeDefinition {
-    readonly name: string;
-    /** Another definition's name. Absent or null: extends nothing. */
-    readonly extends?: string | null;
-    readonly description?: string;
-    readonly axes?: AxisDefs;
-    readonly seeds?: Readonly<Record<string, Varying<number | string>>>;
-    readonly ramps?: Readonly<Record<string, RampDef>>;
-    readonly scales?: Readonly<Record<string, ScaleDef>>;
-    readonly semantics?: Readonly<Record<string, Varying<SemanticRule>>>;
-    readonly components?: Readonly<Record<string, Varying<PinValue>>>;
-    readonly pins?: Readonly<Record<string, Varying<PinValue>>>;
-}
-
-type Lookup = (name: string) => ThemeDefinition | undefined;
-/** The definition with its whole `extends` chain folded in, child entries winning. */
-declare function mergeChain(def: ThemeDefinition, lookup?: Lookup, seen?: ReadonlySet<string>): ThemeDefinition;
-
-/**
- * A definition with every rule run: plain or `by`-varying tokens, references intact.
- * A branch `derive` could not produce is left out, so at runtime it falls through to the parent; definitions with
- * issues still bake, because the editor bakes mid-edit and the build refuses them before baking. Cycles and dangling
- * references still throw, as they do in `derive`.
- */
-interface BakedTheme {
-    readonly name: string;
-    readonly extends: string | null;
-    readonly axes: AxisDefs;
-    /** In layer order, then definition order. */
-    readonly tokens: Readonly<Record<string, Varying<RawToken>>>;
-}
-/** Derive `definition` at every selection and fold the results into one record of tokens with no rules left. */
-declare function bake(definition: ThemeDefinition, lookup?: Lookup): BakedTheme;
-/** `definition` and every theme it extends, baked, root first. */
-declare function bakeChain(definition: ThemeDefinition, lookup?: Lookup): BakedTheme[];
-
-/**
- * A theme ready to resolve: its axes and its tokens, each plain or varying by
- * axis, references intact. A `by` that leaves a value out contributes nothing
- * for that selection, so the theme it extends supplies it.
- */
-interface Theme {
-    readonly name: string;
-    readonly extends: Theme | null;
-    readonly axes: AxisDefs;
-    readonly tokens: Readonly<Record<string, Varying<RawToken>>>;
-}
-/** What `defineTheme` accepts: a definition whose `extends` is a `Theme`, holding pins and components only. */
-type ThemeInput = Omit<ThemeDefinition, 'extends'> & {
-    readonly extends?: Theme | null;
-};
-/** The built-in theme, from the baked output of themes/weasel.json. */
-declare const weaselTheme: Theme;
-/**
- * Build a theme from pins. Unless `extends` says otherwise the result layers
- * onto `weaselTheme`, so a theme only names what it changes. A definition with
- * seeds, ramps, scales or semantics needs deriving first.
- */
-declare function defineTheme(input: ThemeInput): Theme;
-
-export { type AxisDef as A, type BakedTheme as B, type CategoricalRampDef as C, type FlatTokens as F, type Lookup as L, type NumberParam as N, type OffsetRule as O, type PinObject as P, type RawToken as R, type Selection as S, type Theme as T, type Varying as V, type TokenValue as a, type AxisDefs as b, type AxisValue as c, type ByAxis as d, type PinValue as e, type ThemeDefinition as f, type ThemeInput as g, defineTheme as h, enumerateSelections as i, fullSelection as j, isByAxis as k, type ContrastRule as l, type LightnessRampDef as m, type LiteralRule as n, type RampDef as o, type RefRule as p, type ScaleDef as q, type SemanticRule as r, selectionKey as s, type StepRule as t, bake as u, bakeChain as v, weaselTheme as w, mergeChain as x };