hextimator 0.1.0

package/dist/index.d.mts

@@ -0,0 +1,168 @@
+import { C as Color, a as CVDType, O as OKLCH, b as ColorSpace, c as ColorInSpace, d as ColorInput, H as HextimatePreset, e as HextimateGenerationOptions, f as HextimatePaletteBuilder } from './HextimatePaletteBuilder-BzrgFryu.mjs';
+export { D as DerivedToken, F as FlatTokenMap, g as FormatResult, h as HextimateFormatOptions, i as HextimateOptions, j as HextimateResult, N as NestedTokenMap, T as ThemeAdjustments, k as TokenValue, V as VariantPlacement } from './HextimatePaletteBuilder-BzrgFryu.mjs';
+
+/**
+ * Daltonize a color for a specific type of color vision deficiency (CVD).
+ *
+ * Daltonization attempts to preserve the appearance of the color by redistributing the error from the CVD simulation into the channels that the person can still perceive.
+ *
+ * Note that daltonization is not a perfect solution and may not work well for all colors or all types of CVD.
+ * It is intended as a tool for improving accessibility,
+ * but should be used with caution and tested with real users whenever possible.
+ *
+ *
+ * @param color The color to daltonize.
+ * @param type The type of color vision deficiency to daltonize for (e.g. "protanopia", "deuteranopia", "tritanopia", "achromatopsia").
+ * @param severity The severity of the color vision deficiency to daltonize for, on a scale from 0 (no deficiency) to 1 (complete deficiency). Default is 1.
+ * @returns The daltonized color in OKLCH color space.
+ */
+declare function daltonizeColor(color: Color, type: CVDType, severity?: number): OKLCH;
+
+/**
+ * Simulate how a color would appear to someone with a specific type of color vision deficiency (CVD).
+ */
+declare function simulateColor(color: Color, type: CVDType, severity?: number): OKLCH;
+
+/**
+ *
+ * Convert a Color to a target color space.
+ *
+ * This function supports conversion between any two color spaces
+ * for which a conversion path is defined in the `conversions` table.
+ * If a direct conversion is not available, it will attempt to find
+ * a path through intermediate color spaces.
+ *
+ * If no path exists, an error is thrown.
+ *
+ * @param color The input color, in any supported color space.
+ * @param to The target color space to convert to.
+ * @returns The converted color, in the target color space.
+ *
+ * @throws If the conversion is not supported (e.g. if there is no defined conversion path between the input and target color spaces).
+ */
+declare function convert<S extends ColorSpace>(color: Color, to: S): ColorInSpace<S>;
+
+/**
+ * Parse a ColorInput into a Color.
+ *
+ * If the input is already a Color, it will be returned as is.
+ * If the input is a number, it will be parsed as a numeric hex value.
+ * If the input is a string, it will be parsed as a hex value, CSS function, or comma separated values.
+ * If the input is a tuple, it will be parsed as a color tuple.
+ * If the input is a CSS function string, it will be parsed as a CSS function.
+ * If the input is a comma separated values string, it will be parsed as a comma separated values.
+ *
+ * **Alpha is always set to 1.** Transparent inputs like `rgba(255,0,0,0.5)` are treated as
+ * fully opaque. This is intentional: alpha tokens break WCAG contrast guarantees because
+ * contrast ratios depend on whatever is rendered behind the element, which hextimator cannot
+ * know at generation time.
+ *
+ * @param input ColorInput
+ * @param assumeSpace color space to assume. If not provided, the color space will be inferred from the input, and default to 'srgb' if ambiguous
+ * @returns Color or throws a ColorParseError if parsing fails
+ */
+declare function parse(input: ColorInput, assumeSpace?: ColorSpace): Color;
+
+/**
+ * Demo preset that exercises every `HextimatePreset` capability:
+ * generation options, extra roles, extra variants, standalone tokens,
+ * and format defaults.
+ *
+ * Use this as a reference when building your own presets.
+ *
+ * @example
+ * import { hextimate, presets } from 'hextimator';
+ *
+ * const theme = hextimate('#e63946').preset(presets.demo).format();
+ *
+ * // Override any preset default:
+ * const theme = hextimate('#e63946', { minContrastRatio: 'AAA' })
+ *   .preset(presets.demo)
+ *   .format({ colors: 'rgb' });
+ */
+declare const demo: HextimatePreset;
+
+/**
+ * Preset for Material UI (MUI) projects.
+ *
+ * Generates palette tokens matching MUI's theme structure:
+ * `primary`, `secondary`, `error`, `warning`, `info`, `success` —
+ * each with `main`, `light`, `dark`, and `contrastText` variants.
+ *
+ * Also generates `background` (`default`, `paper`), `text` (`primary`,
+ * `secondary`, `disabled`), `divider`, and `action` tokens.
+ *
+ * Defaults to `object` format for use with `createTheme()`. Override with
+ * `.format({ as: 'css' })` for MUI's CSS variables mode.
+ *
+ * @example
+ * import { hextimate, presets } from 'hextimator';
+ * import { createTheme } from '@mui/material/styles';
+ *
+ * const palette = hextimate('#6366F1')
+ *   .preset(presets.mui)
+ *   .format();
+ *
+ * const theme = createTheme({ palette: palette.light });
+ */
+declare const mui: HextimatePreset;
+
+/**
+ * Preset for shadcn/ui projects.
+ *
+ * Generates all CSS variables that shadcn/ui components expect:
+ * `--background`, `--foreground`, `--primary`, `--secondary`, `--muted`,
+ * `--accent`, `--destructive`, `--card`, `--popover`, `--border`, `--input`, `--ring`,
+ * plus their `-foreground` counterparts.
+ *
+ * Also includes hextimator's bonus scale variants (`--primary-strong`, `--primary-weak`, etc.)
+ * which you can optionally use beyond what shadcn requires.
+ *
+ * Defaults to `oklch` color format (modern shadcn). Override with
+ * `.format({ colors: 'hsl-raw' })` for older shadcn setups.
+ *
+ * @example
+ * import { hextimate, presets } from 'hextimator';
+ *
+ * const theme = hextimate('#6366F1')
+ *   .preset(presets.shadcn)
+ *   .format();
+ *
+ * // Use with React hook:
+ * const palette = useHextimator('#6366F1', {
+ *   configure: (b) => b.preset(presets.shadcn),
+ * });
+ */
+declare const shadcn: HextimatePreset;
+
+declare const index_HextimatePreset: typeof HextimatePreset;
+declare const index_demo: typeof demo;
+declare const index_mui: typeof mui;
+declare const index_shadcn: typeof shadcn;
+declare namespace index {
+  export { index_HextimatePreset as HextimatePreset, index_demo as demo, index_mui as mui, index_shadcn as shadcn };
+}
+
+/** Thrown when `hextimate()` fails to parse or generate a palette from the given input. */
+declare class HextimateError extends Error {
+    readonly input: ColorInput;
+    constructor(input: ColorInput, message?: string);
+}
+/**
+ * Creates a palette builder from an accent/brand color.
+ *
+ * @example
+ * // Two-step API: generate, then format
+ * const theme = hextimate('#ff6600')
+ *   .format({ as: 'css', colors: 'oklch' });
+ *
+ * @example
+ * // Extended: add roles and variants before formatting
+ * const theme = hextimate('#ff6600', { light: { lightness: 0.5 }, dark: { lightness: 0.65, maxChroma: 0.1 } })
+ *   .addRole('cta', '#ee2244')
+ *   .addVariant('hover', { from: 'strong' })
+ *   .format({ as: 'tailwind' });
+ */
+declare function hextimate(color: ColorInput, options?: HextimateGenerationOptions): HextimatePaletteBuilder;
+
+export { CVDType, HextimateError, HextimateGenerationOptions, HextimatePaletteBuilder, HextimatePreset, convert as convertColor, daltonizeColor, hextimate, parse as parseColor, index as presets, simulateColor };

package/dist/index.d.ts

@@ -0,0 +1,168 @@
+import { C as Color, a as CVDType, O as OKLCH, b as ColorSpace, c as ColorInSpace, d as ColorInput, H as HextimatePreset, e as HextimateGenerationOptions, f as HextimatePaletteBuilder } from './HextimatePaletteBuilder-BzrgFryu.js';
+export { D as DerivedToken, F as FlatTokenMap, g as FormatResult, h as HextimateFormatOptions, i as HextimateOptions, j as HextimateResult, N as NestedTokenMap, T as ThemeAdjustments, k as TokenValue, V as VariantPlacement } from './HextimatePaletteBuilder-BzrgFryu.js';
+
+/**
+ * Daltonize a color for a specific type of color vision deficiency (CVD).
+ *
+ * Daltonization attempts to preserve the appearance of the color by redistributing the error from the CVD simulation into the channels that the person can still perceive.
+ *
+ * Note that daltonization is not a perfect solution and may not work well for all colors or all types of CVD.
+ * It is intended as a tool for improving accessibility,
+ * but should be used with caution and tested with real users whenever possible.
+ *
+ *
+ * @param color The color to daltonize.
+ * @param type The type of color vision deficiency to daltonize for (e.g. "protanopia", "deuteranopia", "tritanopia", "achromatopsia").
+ * @param severity The severity of the color vision deficiency to daltonize for, on a scale from 0 (no deficiency) to 1 (complete deficiency). Default is 1.
+ * @returns The daltonized color in OKLCH color space.
+ */
+declare function daltonizeColor(color: Color, type: CVDType, severity?: number): OKLCH;
+
+/**
+ * Simulate how a color would appear to someone with a specific type of color vision deficiency (CVD).
+ */
+declare function simulateColor(color: Color, type: CVDType, severity?: number): OKLCH;
+
+/**
+ *
+ * Convert a Color to a target color space.
+ *
+ * This function supports conversion between any two color spaces
+ * for which a conversion path is defined in the `conversions` table.
+ * If a direct conversion is not available, it will attempt to find
+ * a path through intermediate color spaces.
+ *
+ * If no path exists, an error is thrown.
+ *
+ * @param color The input color, in any supported color space.
+ * @param to The target color space to convert to.
+ * @returns The converted color, in the target color space.
+ *
+ * @throws If the conversion is not supported (e.g. if there is no defined conversion path between the input and target color spaces).
+ */
+declare function convert<S extends ColorSpace>(color: Color, to: S): ColorInSpace<S>;
+
+/**
+ * Parse a ColorInput into a Color.
+ *
+ * If the input is already a Color, it will be returned as is.
+ * If the input is a number, it will be parsed as a numeric hex value.
+ * If the input is a string, it will be parsed as a hex value, CSS function, or comma separated values.
+ * If the input is a tuple, it will be parsed as a color tuple.
+ * If the input is a CSS function string, it will be parsed as a CSS function.
+ * If the input is a comma separated values string, it will be parsed as a comma separated values.
+ *
+ * **Alpha is always set to 1.** Transparent inputs like `rgba(255,0,0,0.5)` are treated as
+ * fully opaque. This is intentional: alpha tokens break WCAG contrast guarantees because
+ * contrast ratios depend on whatever is rendered behind the element, which hextimator cannot
+ * know at generation time.
+ *
+ * @param input ColorInput
+ * @param assumeSpace color space to assume. If not provided, the color space will be inferred from the input, and default to 'srgb' if ambiguous
+ * @returns Color or throws a ColorParseError if parsing fails
+ */
+declare function parse(input: ColorInput, assumeSpace?: ColorSpace): Color;
+
+/**
+ * Demo preset that exercises every `HextimatePreset` capability:
+ * generation options, extra roles, extra variants, standalone tokens,
+ * and format defaults.
+ *
+ * Use this as a reference when building your own presets.
+ *
+ * @example
+ * import { hextimate, presets } from 'hextimator';
+ *
+ * const theme = hextimate('#e63946').preset(presets.demo).format();
+ *
+ * // Override any preset default:
+ * const theme = hextimate('#e63946', { minContrastRatio: 'AAA' })
+ *   .preset(presets.demo)
+ *   .format({ colors: 'rgb' });
+ */
+declare const demo: HextimatePreset;
+
+/**
+ * Preset for Material UI (MUI) projects.
+ *
+ * Generates palette tokens matching MUI's theme structure:
+ * `primary`, `secondary`, `error`, `warning`, `info`, `success` —
+ * each with `main`, `light`, `dark`, and `contrastText` variants.
+ *
+ * Also generates `background` (`default`, `paper`), `text` (`primary`,
+ * `secondary`, `disabled`), `divider`, and `action` tokens.
+ *
+ * Defaults to `object` format for use with `createTheme()`. Override with
+ * `.format({ as: 'css' })` for MUI's CSS variables mode.
+ *
+ * @example
+ * import { hextimate, presets } from 'hextimator';
+ * import { createTheme } from '@mui/material/styles';
+ *
+ * const palette = hextimate('#6366F1')
+ *   .preset(presets.mui)
+ *   .format();
+ *
+ * const theme = createTheme({ palette: palette.light });
+ */
+declare const mui: HextimatePreset;
+
+/**
+ * Preset for shadcn/ui projects.
+ *
+ * Generates all CSS variables that shadcn/ui components expect:
+ * `--background`, `--foreground`, `--primary`, `--secondary`, `--muted`,
+ * `--accent`, `--destructive`, `--card`, `--popover`, `--border`, `--input`, `--ring`,
+ * plus their `-foreground` counterparts.
+ *
+ * Also includes hextimator's bonus scale variants (`--primary-strong`, `--primary-weak`, etc.)
+ * which you can optionally use beyond what shadcn requires.
+ *
+ * Defaults to `oklch` color format (modern shadcn). Override with
+ * `.format({ colors: 'hsl-raw' })` for older shadcn setups.
+ *
+ * @example
+ * import { hextimate, presets } from 'hextimator';
+ *
+ * const theme = hextimate('#6366F1')
+ *   .preset(presets.shadcn)
+ *   .format();
+ *
+ * // Use with React hook:
+ * const palette = useHextimator('#6366F1', {
+ *   configure: (b) => b.preset(presets.shadcn),
+ * });
+ */
+declare const shadcn: HextimatePreset;
+
+declare const index_HextimatePreset: typeof HextimatePreset;
+declare const index_demo: typeof demo;
+declare const index_mui: typeof mui;
+declare const index_shadcn: typeof shadcn;
+declare namespace index {
+  export { index_HextimatePreset as HextimatePreset, index_demo as demo, index_mui as mui, index_shadcn as shadcn };
+}
+
+/** Thrown when `hextimate()` fails to parse or generate a palette from the given input. */
+declare class HextimateError extends Error {
+    readonly input: ColorInput;
+    constructor(input: ColorInput, message?: string);
+}
+/**
+ * Creates a palette builder from an accent/brand color.
+ *
+ * @example
+ * // Two-step API: generate, then format
+ * const theme = hextimate('#ff6600')
+ *   .format({ as: 'css', colors: 'oklch' });
+ *
+ * @example
+ * // Extended: add roles and variants before formatting
+ * const theme = hextimate('#ff6600', { light: { lightness: 0.5 }, dark: { lightness: 0.65, maxChroma: 0.1 } })
+ *   .addRole('cta', '#ee2244')
+ *   .addVariant('hover', { from: 'strong' })
+ *   .format({ as: 'tailwind' });
+ */
+declare function hextimate(color: ColorInput, options?: HextimateGenerationOptions): HextimatePaletteBuilder;
+
+export { CVDType, HextimateError, HextimateGenerationOptions, HextimatePaletteBuilder, HextimatePreset, convert as convertColor, daltonizeColor, hextimate, parse as parseColor, index as presets, simulateColor };

package/dist/index.js

@@ -0,0 +1,20 @@
+import {
+  HextimateError,
+  HextimatePaletteBuilder,
+  convert,
+  daltonizeColor,
+  hextimate,
+  parse,
+  presets_exports,
+  simulateColor
+} from "./chunk-MBVLFPTG.js";
+export {
+  HextimateError,
+  HextimatePaletteBuilder,
+  convert as convertColor,
+  daltonizeColor,
+  hextimate,
+  parse as parseColor,
+  presets_exports as presets,
+  simulateColor
+};

package/dist/react.d.mts

@@ -0,0 +1,132 @@
+import * as react_jsx_runtime from 'react/jsx-runtime';
+import { e as HextimateGenerationOptions, f as HextimatePaletteBuilder, j as HextimateResult, h as HextimateFormatOptions, F as FlatTokenMap } from './HextimatePaletteBuilder-BzrgFryu.mjs';
+import { PropsWithChildren } from 'react';
+
+type DarkModeStrategy = {
+    type: 'class';
+    className?: string;
+} | {
+    type: 'data';
+    attribute?: string;
+} | {
+    type: 'media';
+} | {
+    type: 'media-or-class';
+    className?: string;
+} | false;
+/**
+ * Options for the `useHextimator` hook, which generates a color palette and injects CSS variables based on a given color and configuration.
+ * - `generation`: Options for how the palette is generated (e.g., light/dark settings, contrast requirements).
+ * - `format`: Options for how the generated palette is formatted (e.g., output format).
+ * - `configure`: A callback to further customize the palette builder before formatting.
+ * - `darkMode`: Strategy for handling dark mode variants in CSS variable injection.
+ * - `cssPrefix`: A prefix to apply to all generated CSS variable names.
+ * - `target`: An optional ref to a specific DOM element where CSS variables should be injected instead of the document root.
+ *
+ */
+interface UseHextimatorOptions {
+    generation?: HextimateGenerationOptions;
+    format?: Omit<HextimateFormatOptions, 'as'>;
+    configure?: (builder: HextimatePaletteBuilder) => void;
+    darkMode?: DarkModeStrategy;
+    cssPrefix?: string;
+    target?: React.RefObject<HTMLElement | null>;
+}
+/**
+ * Generates a color palette based on the provided color and options,
+ * and injects CSS variables into the document for use in styling.
+ * The palette is regenerated whenever the input color or relevant options change.
+ *
+ * Example usage:
+ * ```tsx
+ * const palette = useHextimator('#ff6600', {
+ *   generation: { minContrastRatio: 'AA' },
+ *   darkMode: { type: 'class', className: 'dark' },
+ *   cssPrefix: '--myapp-',
+ * });
+ * ```
+ *
+ * @param color - The base color to generate the palette from.
+ * @param options - Configuration options for palette generation, formatting, and CSS variable injection.
+ */
+declare function useHextimator(color: string, options?: UseHextimatorOptions): HextimateResult<FlatTokenMap>;
+type ModePreference = 'light' | 'dark' | 'system';
+type ResolvedMode = 'light' | 'dark';
+/**
+ * Props for the `HextimatorProvider` component, which manages the state of a Hextimator-generated color palette and injects corresponding CSS variables into the document.
+ * - `defaultColor`: The initial base color to generate the palette from.
+ * - `generation`: Initial options for how the palette is generated (e.g., light/dark settings, contrast requirements).
+ * - `format`: Initial options for how the generated palette is formatted (e.g., output format).
+ * - `configure`: An initial callback to further customize the palette builder before formatting.
+ * - `darkMode`: Strategy for handling dark mode variants in CSS variable injection.
+ * - `cssPrefix`: A prefix to apply to all generated CSS variable names.
+ * - `target`: An optional ref to a specific DOM element where CSS variables should be injected instead of the document root.
+ */
+interface HextimatorProviderProps {
+    defaultColor: string;
+    defaultMode?: ModePreference;
+    generation?: HextimateGenerationOptions;
+    format?: Omit<HextimateFormatOptions, 'as'>;
+    configure?: (builder: HextimatePaletteBuilder) => void;
+    darkMode?: DarkModeStrategy;
+    cssPrefix?: string;
+    target?: React.RefObject<HTMLElement | null>;
+}
+interface HextimatorContextValue {
+    color: string;
+    setColor: (color: string) => void;
+    mode: ResolvedMode;
+    modePreference: ModePreference;
+    setMode: (mode: ModePreference) => void;
+    generation: HextimateGenerationOptions | undefined;
+    setGeneration: (opts: HextimateGenerationOptions | undefined) => void;
+    configure: ((builder: HextimatePaletteBuilder) => void) | undefined;
+    setConfigure: (fn: ((builder: HextimatePaletteBuilder) => void) | undefined) => void;
+    palette: HextimateResult;
+}
+/**
+ *
+ * A React context provider that manages the state of
+ * a Hextimator-generated color palette and injects corresponding CSS variables into the document.
+ * It allows child components to access and update the
+ * base color, generation options, and configuration callback, automatically
+ * regenerating the palette and updating CSS variables as needed.
+
+ * The Provider accepts props for the default color, generation options, formatting options,
+ * dark mode strategy, CSS variable prefix, and an optional target element for CSS variable injection.
+ * It uses the `useHextimator` hook to generate the palette and handles the injection of CSS variables based on the current state.
+ *
+ * Example usage:
+ * ```tsx
+ * <HextimatorProvider defaultColor="#ff6600" generation={{ minContrastRatio: 'AA' }} darkMode={{ type: 'class', className: 'dark' }} cssPrefix="--myapp-">
+ *  <App />
+ * </HextimatorProvider>
+ * ```
+ */
+declare function HextimatorProvider({ children, defaultColor, defaultMode: initialMode, generation: initialGeneration, format: formatOpts, configure: initialConfigure, darkMode, cssPrefix, target, }: PropsWithChildren<HextimatorProviderProps>): react_jsx_runtime.JSX.Element;
+/**
+ * Provides access to the current Hextimator palette and theme state from the nearest `HextimatorProvider`.
+ *
+ * Returned properties:
+ * - `color` / `setColor` — the current base color.
+ * - `mode` — the resolved color mode (`'light'` or `'dark'`), accounting for OS preference when set to `'system'`.
+ * - `modePreference` — the raw preference (`'light'`, `'dark'`, or `'system'`).
+ * - `setMode` — update the mode preference. Pass `'system'` to follow the OS.
+ * - `generation` / `setGeneration` — palette generation options.
+ * - `configure` / `setConfigure` — builder configuration callback.
+ * - `palette` — the generated `HextimateResult`.
+ *
+ * @example
+ * ```tsx
+ * const { mode, setMode } = useHextimatorTheme();
+ *
+ * <button onClick={() => setMode(mode === 'dark' ? 'light' : 'dark')}>
+ *   Toggle dark mode
+ * </button>
+ * ```
+ *
+ * @throws If used outside of a `HextimatorProvider`.
+ */
+declare function useHextimatorTheme(): HextimatorContextValue;
+
+export { type HextimatorContextValue, HextimatorProvider, type HextimatorProviderProps, type ModePreference, type ResolvedMode, type UseHextimatorOptions, useHextimator, useHextimatorTheme };

package/dist/react.d.ts

@@ -0,0 +1,132 @@
+import * as react_jsx_runtime from 'react/jsx-runtime';
+import { e as HextimateGenerationOptions, f as HextimatePaletteBuilder, j as HextimateResult, h as HextimateFormatOptions, F as FlatTokenMap } from './HextimatePaletteBuilder-BzrgFryu.js';
+import { PropsWithChildren } from 'react';
+
+type DarkModeStrategy = {
+    type: 'class';
+    className?: string;
+} | {
+    type: 'data';
+    attribute?: string;
+} | {
+    type: 'media';
+} | {
+    type: 'media-or-class';
+    className?: string;
+} | false;
+/**
+ * Options for the `useHextimator` hook, which generates a color palette and injects CSS variables based on a given color and configuration.
+ * - `generation`: Options for how the palette is generated (e.g., light/dark settings, contrast requirements).
+ * - `format`: Options for how the generated palette is formatted (e.g., output format).
+ * - `configure`: A callback to further customize the palette builder before formatting.
+ * - `darkMode`: Strategy for handling dark mode variants in CSS variable injection.
+ * - `cssPrefix`: A prefix to apply to all generated CSS variable names.
+ * - `target`: An optional ref to a specific DOM element where CSS variables should be injected instead of the document root.
+ *
+ */
+interface UseHextimatorOptions {
+    generation?: HextimateGenerationOptions;
+    format?: Omit<HextimateFormatOptions, 'as'>;
+    configure?: (builder: HextimatePaletteBuilder) => void;
+    darkMode?: DarkModeStrategy;
+    cssPrefix?: string;
+    target?: React.RefObject<HTMLElement | null>;
+}
+/**
+ * Generates a color palette based on the provided color and options,
+ * and injects CSS variables into the document for use in styling.
+ * The palette is regenerated whenever the input color or relevant options change.
+ *
+ * Example usage:
+ * ```tsx
+ * const palette = useHextimator('#ff6600', {
+ *   generation: { minContrastRatio: 'AA' },
+ *   darkMode: { type: 'class', className: 'dark' },
+ *   cssPrefix: '--myapp-',
+ * });
+ * ```
+ *
+ * @param color - The base color to generate the palette from.
+ * @param options - Configuration options for palette generation, formatting, and CSS variable injection.
+ */
+declare function useHextimator(color: string, options?: UseHextimatorOptions): HextimateResult<FlatTokenMap>;
+type ModePreference = 'light' | 'dark' | 'system';
+type ResolvedMode = 'light' | 'dark';
+/**
+ * Props for the `HextimatorProvider` component, which manages the state of a Hextimator-generated color palette and injects corresponding CSS variables into the document.
+ * - `defaultColor`: The initial base color to generate the palette from.
+ * - `generation`: Initial options for how the palette is generated (e.g., light/dark settings, contrast requirements).
+ * - `format`: Initial options for how the generated palette is formatted (e.g., output format).
+ * - `configure`: An initial callback to further customize the palette builder before formatting.
+ * - `darkMode`: Strategy for handling dark mode variants in CSS variable injection.
+ * - `cssPrefix`: A prefix to apply to all generated CSS variable names.
+ * - `target`: An optional ref to a specific DOM element where CSS variables should be injected instead of the document root.
+ */
+interface HextimatorProviderProps {
+    defaultColor: string;
+    defaultMode?: ModePreference;
+    generation?: HextimateGenerationOptions;
+    format?: Omit<HextimateFormatOptions, 'as'>;
+    configure?: (builder: HextimatePaletteBuilder) => void;
+    darkMode?: DarkModeStrategy;
+    cssPrefix?: string;
+    target?: React.RefObject<HTMLElement | null>;
+}
+interface HextimatorContextValue {
+    color: string;
+    setColor: (color: string) => void;
+    mode: ResolvedMode;
+    modePreference: ModePreference;
+    setMode: (mode: ModePreference) => void;
+    generation: HextimateGenerationOptions | undefined;
+    setGeneration: (opts: HextimateGenerationOptions | undefined) => void;
+    configure: ((builder: HextimatePaletteBuilder) => void) | undefined;
+    setConfigure: (fn: ((builder: HextimatePaletteBuilder) => void) | undefined) => void;
+    palette: HextimateResult;
+}
+/**
+ *
+ * A React context provider that manages the state of
+ * a Hextimator-generated color palette and injects corresponding CSS variables into the document.
+ * It allows child components to access and update the
+ * base color, generation options, and configuration callback, automatically
+ * regenerating the palette and updating CSS variables as needed.
+
+ * The Provider accepts props for the default color, generation options, formatting options,
+ * dark mode strategy, CSS variable prefix, and an optional target element for CSS variable injection.
+ * It uses the `useHextimator` hook to generate the palette and handles the injection of CSS variables based on the current state.
+ *
+ * Example usage:
+ * ```tsx
+ * <HextimatorProvider defaultColor="#ff6600" generation={{ minContrastRatio: 'AA' }} darkMode={{ type: 'class', className: 'dark' }} cssPrefix="--myapp-">
+ *  <App />
+ * </HextimatorProvider>
+ * ```
+ */
+declare function HextimatorProvider({ children, defaultColor, defaultMode: initialMode, generation: initialGeneration, format: formatOpts, configure: initialConfigure, darkMode, cssPrefix, target, }: PropsWithChildren<HextimatorProviderProps>): react_jsx_runtime.JSX.Element;
+/**
+ * Provides access to the current Hextimator palette and theme state from the nearest `HextimatorProvider`.
+ *
+ * Returned properties:
+ * - `color` / `setColor` — the current base color.
+ * - `mode` — the resolved color mode (`'light'` or `'dark'`), accounting for OS preference when set to `'system'`.
+ * - `modePreference` — the raw preference (`'light'`, `'dark'`, or `'system'`).
+ * - `setMode` — update the mode preference. Pass `'system'` to follow the OS.
+ * - `generation` / `setGeneration` — palette generation options.
+ * - `configure` / `setConfigure` — builder configuration callback.
+ * - `palette` — the generated `HextimateResult`.
+ *
+ * @example
+ * ```tsx
+ * const { mode, setMode } = useHextimatorTheme();
+ *
+ * <button onClick={() => setMode(mode === 'dark' ? 'light' : 'dark')}>
+ *   Toggle dark mode
+ * </button>
+ * ```
+ *
+ * @throws If used outside of a `HextimatorProvider`.
+ */
+declare function useHextimatorTheme(): HextimatorContextValue;
+
+export { type HextimatorContextValue, HextimatorProvider, type HextimatorProviderProps, type ModePreference, type ResolvedMode, type UseHextimatorOptions, useHextimator, useHextimatorTheme };