@arbor-css/core 0.0.144 → 0.0.146

package/dist/presets/arborPreset/modeSchema/modeSchema.d.ts

@@ -1,916 +0,0 @@
-export interface ArborModeSchemaOptions<TColorName extends PropertyKey> {
-    colorNames: TColorName[];
-}
-export declare function createArborModeSchema<TColorName extends string>(options: ArborModeSchemaOptions<TColorName>): {
-    global: {
-        color: {
-            saturation: {
-                purpose: "scalar";
-                description: "Applies global saturation adjustments to all colors";
-            };
-        };
-        space: {
-            density: {
-                purpose: "scalar";
-                description: "A scaling factor for density. Higher density means smaller, tighter spacing and size";
-            };
-            baseSize: {
-                purpose: "spacing";
-                description: "Defines the base spacing unit used to derive spacing and layout tokens.";
-            };
-            scaleBase: {
-                purpose: "scalar";
-                description: "The \"base\" number of the scale equation - a linear scalar multiplier. Set this to scale by some linear factor if scaleExponent is \"1\"";
-            };
-            scaleExponentStep: {
-                purpose: "scalar";
-                description: "The exponent of the scale equation - the rate of exponential growth. `scaleBase` is raised to this exponent before being multiplied by the base spacing size. Set this to \"1\" to scale linearly by the `scaleBase` factor, or set it to a value greater than \"1\" to have exponential growth.";
-            };
-        };
-        shape: {
-            roundness: {
-                purpose: "scalar";
-                description: "Controls the roundness of corners. Larger roundness values also may affect padding.";
-            };
-            lineWidth: {
-                purpose: "scalar";
-                description: "Controls the width of lines used for borders, etc.";
-            };
-        };
-        shadow: {
-            spread: {
-                purpose: "scalar";
-                description: "Controls the spread size of all shadows.";
-            };
-            blur: {
-                purpose: "scalar";
-                description: "Controls the blur scaling of all shadows.";
-            };
-            color: {
-                purpose: "color";
-                description: "Provides the default shadow color used when a shadow token does not supply its own color.";
-            };
-        };
-        typography: {
-            baseFontSize: {
-                purpose: "font-size";
-                description: "Defines the root font size used to derive typography tokens.";
-            };
-            size: {
-                purpose: "scalar";
-                description: "A global parameter to influence the overall font size of all typography tokens.";
-            };
-            weightStep: {
-                purpose: "scalar";
-                description: "The amount of font weight change between each typography level. This is multiplied by the level index to determine how much to adjust font weight at each level.";
-            };
-            minWeight: {
-                purpose: "scalar";
-                description: "The minimum font weight to use in the typography scale.";
-            };
-            maxWeight: {
-                purpose: "scalar";
-                description: "The maximum font weight to use in the typography scale.";
-            };
-            baseWeight: {
-                purpose: "scalar";
-                description: "The base font weight from which to calculate typography levels. This is typically the \"normal\" font weight (e.g. 400), and level adjustments are applied as positive or negative offsets from this base.";
-            };
-            lineHeightStep: {
-                purpose: "scalar";
-                description: "The amount of line height change between each typography level. This is multiplied by the level index to determine how much to adjust line height at each level.";
-            };
-            minLineHeight: {
-                purpose: "scalar";
-                description: "The minimum line height to use in the typography scale.";
-            };
-            maxLineHeight: {
-                purpose: "scalar";
-                description: "The maximum line height to use in the typography scale.";
-            };
-            baseLineHeight: {
-                purpose: "scalar";
-                description: "The base line height from which to calculate typography levels. This is typically the line height used at the default typography level, and level adjustments are applied as positive or negative offsets from this base.";
-            };
-            minFontSize: {
-                purpose: "font-size";
-                description: "The minimum font size to use in the typography scale.";
-            };
-            maxFontSize: {
-                purpose: "font-size";
-                description: "The maximum font size to use in the typography scale.";
-            };
-            fontSizeScaleBase: {
-                purpose: "scalar";
-                description: "The \"base\" number of the font size scale equation - a linear scalar multiplier. Set this to scale by some linear factor if sizeExponent is \"1\"";
-            };
-            fontSizeScaleExponentStep: {
-                purpose: "scalar";
-                description: "The exponent of the font size scale equation - the rate of exponential growth. `fontSizeScaleBase` is raised to this exponent before being multiplied by the base font size. Set this to \"1\" to scale linearly by the `fontSizeScaleBase` factor, or set it to a value greater than \"1\" to have exponential growth.";
-            };
-            letterSpacingStep: {
-                purpose: "scalar";
-                description: "The amount of letter spacing change between each typography level. This is multiplied by the level index to determine how much to adjust letter spacing at each level.";
-            };
-            minLetterSpacing: {
-                purpose: "spacing";
-                description: "The minimum letter spacing to use in the typography scale.";
-            };
-            maxLetterSpacing: {
-                purpose: "spacing";
-                description: "The maximum letter spacing to use in the typography scale.";
-            };
-            baseLetterSpacing: {
-                purpose: "spacing";
-                description: "The base letter spacing from which to calculate typography levels. This is typically the letter spacing used at the default typography level, and level adjustments are applied as positive or negative offsets from this base.";
-            };
-            darkModeWeightAdjustment: {
-                purpose: "scalar";
-                description: "An adjustment applied to font weight when in dark mode to compensate for the irradiation illusion. This is typically a negative value to reduce font weight in dark mode, but it can be positive if your theme has very light text and you want to increase weight in dark mode.";
-            };
-            boldness: {
-                purpose: "scalar";
-                description: "An overall scaling factor for how heavy font weight tokens are.";
-            };
-        };
-        easing: {
-            bounciness: {
-                purpose: "scalar";
-                description: "Controls the bounciness of easing functions. Higher values result in more overshoot and bounce.";
-            };
-        };
-        duration: {
-            slowness: {
-                purpose: "scalar";
-                description: "Controls the overall slowness of durations. Higher values result in longer durations.";
-            };
-            base: {
-                purpose: "duration";
-                description: "The base duration used to derive all other durations. This can be thought of as the \"medium\" duration, and other durations are calculated as multiples or fractions of this base.";
-            };
-            min: {
-                purpose: "duration";
-                description: "The minimum duration to use in the duration scale.";
-            };
-            max: {
-                purpose: "duration";
-                description: "The maximum duration to use in the duration scale.";
-            };
-        };
-    };
-    action: {
-        padding: {
-            $root: {
-                purpose: "other";
-                description: string;
-            };
-            inline: {
-                purpose: "spacing";
-                description: "Inline (horizontal, usually) padding";
-            };
-            block: {
-                purpose: "spacing";
-                description: "Block (vertical, usually) padding";
-            };
-        };
-        roundness: {
-            purpose: "scalar";
-            description: "This token controls the overall roundness of actions and stacks with the root roundness token";
-        };
-        radius: {
-            purpose: "border-radius";
-            description: "This token captures the border-radius of actions, taking into account the overall roundness";
-        };
-        text: {
-            size: "font-size";
-            weight: "font-weight";
-            lineHeight: "line-height";
-            font: "font-family";
-            letterSpacing: "letter-spacing";
-        };
-        primary: {
-            fg: {
-                purpose: "color";
-                description: "Foreground color";
-            };
-            bg: {
-                purpose: "background";
-                description: "Background - can be a color or a more complex value like a gradient or image";
-            };
-            borderColor: {
-                purpose: "color";
-            };
-            borderWidth: {
-                purpose: "border-width";
-            };
-            borderStyle: {
-                purpose: "border-style";
-            };
-            border: {
-                purpose: "border";
-                description: "Compiles the border color, width, and style into a single token for direct assignment to border.";
-            };
-        };
-        secondary: {
-            fg: {
-                purpose: "color";
-                description: "Foreground color";
-            };
-            bg: {
-                purpose: "background";
-                description: "Background - can be a color or a more complex value like a gradient or image";
-            };
-            borderColor: {
-                purpose: "color";
-            };
-            borderWidth: {
-                purpose: "border-width";
-            };
-            borderStyle: {
-                purpose: "border-style";
-            };
-            border: {
-                purpose: "border";
-                description: "Compiles the border color, width, and style into a single token for direct assignment to border.";
-            };
-        };
-        ambient: {
-            fg: {
-                purpose: "color";
-                description: "Foreground color";
-            };
-            bg: {
-                purpose: "background";
-                description: "Background - can be a color or a more complex value like a gradient or image";
-            };
-            borderColor: {
-                purpose: "color";
-            };
-            borderWidth: {
-                purpose: "border-width";
-            };
-            borderStyle: {
-                purpose: "border-style";
-            };
-            border: {
-                purpose: "border";
-                description: "Compiles the border color, width, and style into a single token for direct assignment to border.";
-            };
-        };
-    };
-    control: {
-        text: {
-            size: "font-size";
-            weight: "font-weight";
-            lineHeight: "line-height";
-            font: "font-family";
-            letterSpacing: "letter-spacing";
-        };
-        fg: {
-            purpose: "color";
-            description: "Foreground color";
-        };
-        bg: {
-            purpose: "background";
-            description: "Background - can be a color or a more complex value like a gradient or image";
-        };
-        borderColor: {
-            purpose: "color";
-        };
-        borderWidth: {
-            purpose: "border-width";
-        };
-        borderStyle: {
-            purpose: "border-style";
-        };
-        border: {
-            purpose: "border";
-            description: "Compiles the border color, width, and style into a single token for direct assignment to border.";
-        };
-        padding: {
-            $root: {
-                purpose: "other";
-                description: string;
-            };
-            inline: {
-                purpose: "spacing";
-                description: "Inline (horizontal, usually) padding";
-            };
-            block: {
-                purpose: "spacing";
-                description: "Block (vertical, usually) padding";
-            };
-        };
-        roundness: {
-            purpose: "scalar";
-            description: "This token controls the overall roundness of controls and stacks with the root roundness token";
-        };
-        radius: {
-            purpose: "border-radius";
-            description: "This token captures the border-radius of controls, taking into account the overall roundness";
-        };
-    };
-    surface: {
-        padding: {
-            $root: {
-                purpose: "other";
-                description: string;
-            };
-            inline: {
-                purpose: "spacing";
-                description: "Inline (horizontal, usually) padding";
-            };
-            block: {
-                purpose: "spacing";
-                description: "Block (vertical, usually) padding";
-            };
-        };
-        roundness: {
-            purpose: "scalar";
-            description: "This token controls the overall roundness of surfaces and stacks with the root roundness token";
-        };
-        radius: {
-            purpose: "border-radius";
-            description: "This token captures the border-radius of surfaces, taking into account the overall roundness";
-        };
-        text: {
-            size: "font-size";
-            weight: "font-weight";
-            lineHeight: "line-height";
-            font: "font-family";
-            letterSpacing: "letter-spacing";
-        };
-        primary: {
-            fg: {
-                purpose: "color";
-                description: "Foreground color";
-            };
-            bg: {
-                purpose: "background";
-                description: "Background - can be a color or a more complex value like a gradient or image";
-            };
-            borderColor: {
-                purpose: "color";
-            };
-            borderWidth: {
-                purpose: "border-width";
-            };
-            borderStyle: {
-                purpose: "border-style";
-            };
-            border: {
-                purpose: "border";
-                description: "Compiles the border color, width, and style into a single token for direct assignment to border.";
-            };
-        };
-        secondary: {
-            fg: {
-                purpose: "color";
-                description: "Foreground color";
-            };
-            bg: {
-                purpose: "background";
-                description: "Background - can be a color or a more complex value like a gradient or image";
-            };
-            borderColor: {
-                purpose: "color";
-            };
-            borderWidth: {
-                purpose: "border-width";
-            };
-            borderStyle: {
-                purpose: "border-style";
-            };
-            border: {
-                purpose: "border";
-                description: "Compiles the border color, width, and style into a single token for direct assignment to border.";
-            };
-        };
-        ambient: {
-            fg: {
-                purpose: "color";
-                description: "Foreground color";
-            };
-            bg: {
-                purpose: "background";
-                description: "Background - can be a color or a more complex value like a gradient or image";
-            };
-            borderColor: {
-                purpose: "color";
-            };
-            borderWidth: {
-                purpose: "border-width";
-            };
-            borderStyle: {
-                purpose: "border-style";
-            };
-            border: {
-                purpose: "border";
-                description: "Compiles the border color, width, and style into a single token for direct assignment to border.";
-            };
-        };
-    };
-    prose: {
-        primary: {
-            size: "font-size";
-            weight: "font-weight";
-            lineHeight: "line-height";
-            font: "font-family";
-            letterSpacing: "letter-spacing";
-        };
-        secondary: {
-            size: "font-size";
-            weight: "font-weight";
-            lineHeight: "line-height";
-            font: "font-family";
-            letterSpacing: "letter-spacing";
-        };
-        ambient: {
-            size: "font-size";
-            weight: "font-weight";
-            lineHeight: "line-height";
-            font: "font-family";
-            letterSpacing: "letter-spacing";
-        };
-    };
-    color: {
-        main: {
-            $neutral: {
-                $root: {
-                    purpose: "color";
-                    description: string;
-                };
-                paper: {
-                    purpose: "color";
-                    description: "An extremely light shade, good for backgrounds and surfaces";
-                };
-                wash: {
-                    purpose: "color";
-                    description: "A very faint but slightly vibrant shade, good for backgrounds and surfaces";
-                };
-                light: {
-                    purpose: "color";
-                    description: "A light shade, good for emphasized surfaces.";
-                };
-                mid: {
-                    purpose: "color";
-                    description: "The main shade, good for primary actions and decoration.";
-                };
-                heavy: {
-                    purpose: "color";
-                    description: "A heavy shade, good for text emphasis and accents.";
-                };
-                ink: {
-                    purpose: "color";
-                    description: "A very dark but still slightly vibrant shade, good for text and high contrast elements.";
-                };
-            };
-            $root: {
-                purpose: "color";
-                description: string;
-            };
-            paper: {
-                purpose: "color";
-                description: "An extremely light shade, good for backgrounds and surfaces";
-            };
-            wash: {
-                purpose: "color";
-                description: "A very faint but slightly vibrant shade, good for backgrounds and surfaces";
-            };
-            light: {
-                purpose: "color";
-                description: "A light shade, good for emphasized surfaces.";
-            };
-            mid: {
-                purpose: "color";
-                description: "The main shade, good for primary actions and decoration.";
-            };
-            heavy: {
-                purpose: "color";
-                description: "A heavy shade, good for text emphasis and accents.";
-            };
-            ink: {
-                purpose: "color";
-                description: "A very dark but still slightly vibrant shade, good for text and high contrast elements.";
-            };
-        };
-        neutral: {
-            $root: {
-                purpose: "color";
-                description: string;
-            };
-            paper: {
-                purpose: "color";
-                description: "An extremely light shade, good for backgrounds and surfaces";
-            };
-            wash: {
-                purpose: "color";
-                description: "A very faint but slightly vibrant shade, good for backgrounds and surfaces";
-            };
-            light: {
-                purpose: "color";
-                description: "A light shade, good for emphasized surfaces.";
-            };
-            mid: {
-                purpose: "color";
-                description: "The main shade, good for primary actions and decoration.";
-            };
-            heavy: {
-                purpose: "color";
-                description: "A heavy shade, good for text emphasis and accents.";
-            };
-            ink: {
-                purpose: "color";
-                description: "A very dark but still slightly vibrant shade, good for text and high contrast elements.";
-            };
-        };
-        palette: Record<TColorName, {
-            $neutral: {
-                $root: {
-                    purpose: "color";
-                    description: string;
-                };
-                paper: {
-                    purpose: "color";
-                    description: "An extremely light shade, good for backgrounds and surfaces";
-                };
-                wash: {
-                    purpose: "color";
-                    description: "A very faint but slightly vibrant shade, good for backgrounds and surfaces";
-                };
-                light: {
-                    purpose: "color";
-                    description: "A light shade, good for emphasized surfaces.";
-                };
-                mid: {
-                    purpose: "color";
-                    description: "The main shade, good for primary actions and decoration.";
-                };
-                heavy: {
-                    purpose: "color";
-                    description: "A heavy shade, good for text emphasis and accents.";
-                };
-                ink: {
-                    purpose: "color";
-                    description: "A very dark but still slightly vibrant shade, good for text and high contrast elements.";
-                };
-            };
-            $root: {
-                purpose: "color";
-                description: string;
-            };
-            paper: {
-                purpose: "color";
-                description: "An extremely light shade, good for backgrounds and surfaces";
-            };
-            wash: {
-                purpose: "color";
-                description: "A very faint but slightly vibrant shade, good for backgrounds and surfaces";
-            };
-            light: {
-                purpose: "color";
-                description: "A light shade, good for emphasized surfaces.";
-            };
-            mid: {
-                purpose: "color";
-                description: "The main shade, good for primary actions and decoration.";
-            };
-            heavy: {
-                purpose: "color";
-                description: "A heavy shade, good for text emphasis and accents.";
-            };
-            ink: {
-                purpose: "color";
-                description: "A very dark but still slightly vibrant shade, good for text and high contrast elements.";
-            };
-        }>;
-    };
-    space: {
-        $root: {
-            purpose: "spacing";
-            description: string;
-        };
-        xs: "spacing";
-        sm: "spacing";
-        md: "spacing";
-        lg: "spacing";
-        xl: "spacing";
-    };
-    lineWidth: {
-        $root: {
-            purpose: "border-width";
-            description: string;
-        };
-        sm: {
-            purpose: "border-width";
-            description: "A hairline border width. Always >= 1px. If the global border width is small, this may be the same as \"md\"";
-        };
-        md: {
-            purpose: "border-width";
-            description: "A general-purpose border width";
-        };
-        lg: {
-            purpose: "border-width";
-            description: "A thicker border, good for emphasis";
-        };
-    };
-    radius: {
-        $root: {
-            purpose: "border-radius";
-            description: string;
-        };
-        xs: "border-radius";
-        sm: "border-radius";
-        md: "border-radius";
-        lg: "border-radius";
-        full: "border-radius";
-    };
-    shadow: {
-        $root: {
-            purpose: "shadow";
-            description: string;
-        };
-        color: {
-            purpose: "color";
-            description: "If specified, this token overrides shadow colors from primitives";
-        };
-        none: {
-            x: {
-                purpose: "size";
-                description: "Horizontal offset of the shadow";
-            };
-            y: {
-                purpose: "size";
-                description: "Vertical offset of the shadow";
-            };
-            blur: {
-                purpose: "size";
-                description: "Blur radius of the shadow";
-            };
-            spread: {
-                purpose: "size";
-                description: "Spread radius of the shadow";
-            };
-            color: {
-                purpose: "color";
-                description: "Color of the shadow";
-            };
-            $root: {
-                purpose: "shadow";
-                description: string;
-            };
-        };
-        sm: {
-            x: {
-                purpose: "size";
-                description: "Horizontal offset of the shadow";
-            };
-            y: {
-                purpose: "size";
-                description: "Vertical offset of the shadow";
-            };
-            blur: {
-                purpose: "size";
-                description: "Blur radius of the shadow";
-            };
-            spread: {
-                purpose: "size";
-                description: "Spread radius of the shadow";
-            };
-            color: {
-                purpose: "color";
-                description: "Color of the shadow";
-            };
-            $root: {
-                purpose: "shadow";
-                description: string;
-            };
-        };
-        md: {
-            x: {
-                purpose: "size";
-                description: "Horizontal offset of the shadow";
-            };
-            y: {
-                purpose: "size";
-                description: "Vertical offset of the shadow";
-            };
-            blur: {
-                purpose: "size";
-                description: "Blur radius of the shadow";
-            };
-            spread: {
-                purpose: "size";
-                description: "Spread radius of the shadow";
-            };
-            color: {
-                purpose: "color";
-                description: "Color of the shadow";
-            };
-            $root: {
-                purpose: "shadow";
-                description: string;
-            };
-        };
-        lg: {
-            x: {
-                purpose: "size";
-                description: "Horizontal offset of the shadow";
-            };
-            y: {
-                purpose: "size";
-                description: "Vertical offset of the shadow";
-            };
-            blur: {
-                purpose: "size";
-                description: "Blur radius of the shadow";
-            };
-            spread: {
-                purpose: "size";
-                description: "Spread radius of the shadow";
-            };
-            color: {
-                purpose: "color";
-                description: "Color of the shadow";
-            };
-            $root: {
-                purpose: "shadow";
-                description: string;
-            };
-        };
-        xl: {
-            x: {
-                purpose: "size";
-                description: "Horizontal offset of the shadow";
-            };
-            y: {
-                purpose: "size";
-                description: "Vertical offset of the shadow";
-            };
-            blur: {
-                purpose: "size";
-                description: "Blur radius of the shadow";
-            };
-            spread: {
-                purpose: "size";
-                description: "Spread radius of the shadow";
-            };
-            color: {
-                purpose: "color";
-                description: "Color of the shadow";
-            };
-            $root: {
-                purpose: "shadow";
-                description: string;
-            };
-        };
-    };
-    easing: {
-        in: {
-            $root: {
-                purpose: "easing-function";
-                description: string;
-            };
-            tight: {
-                purpose: "easing-function";
-                description: "A short, snappy easing, good for tight interactions";
-            };
-            medium: {
-                purpose: "easing-function";
-                description: "A medium easing, good for general use";
-            };
-            loose: {
-                purpose: "easing-function";
-                description: "A long, relaxed easing, good for slow interactions and animations";
-            };
-        };
-        out: {
-            $root: {
-                purpose: "easing-function";
-                description: string;
-            };
-            tight: {
-                purpose: "easing-function";
-                description: "A short, snappy easing, good for tight interactions";
-            };
-            medium: {
-                purpose: "easing-function";
-                description: "A medium easing, good for general use";
-            };
-            loose: {
-                purpose: "easing-function";
-                description: "A long, relaxed easing, good for slow interactions and animations";
-            };
-        };
-        $root: {
-            purpose: "easing-function";
-            description: string;
-        };
-        tight: {
-            purpose: "easing-function";
-            description: "A short, snappy easing, good for tight interactions";
-        };
-        medium: {
-            purpose: "easing-function";
-            description: "A medium easing, good for general use";
-        };
-        loose: {
-            purpose: "easing-function";
-            description: "A long, relaxed easing, good for slow interactions and animations";
-        };
-    };
-    duration: {
-        $root: {
-            purpose: "duration";
-            description: string;
-        };
-        short: {
-            purpose: "duration";
-            description: "A short, snappy duration, good for fast interactions and large animations";
-        };
-        medium: {
-            purpose: "duration";
-            description: "A medium duration, good for general use, fast enough for interactions";
-        };
-        long: {
-            purpose: "duration";
-            description: "A long, relaxed duration, good for slow interactions and animations";
-        };
-    };
-    text: {
-        weight: {
-            $root: {
-                purpose: "font-weight";
-                description: string;
-            };
-            thin: {
-                purpose: "font-weight";
-                description: "A thin font weight, good for large or de-emphasized text";
-            };
-            normal: {
-                purpose: "font-weight";
-                description: "A normal font weight, good for general use";
-            };
-            bold: {
-                purpose: "font-weight";
-                description: "A bold font weight, good for small or emphasized text";
-            };
-        };
-        size: {
-            $root: {
-                purpose: "font-size";
-                description: string;
-            };
-            sm: {
-                purpose: "font-size";
-                description: "A small font size, good for captions and fine print";
-            };
-            md: {
-                purpose: "font-size";
-                description: "A medium font size, good for general use";
-            };
-            lg: {
-                purpose: "font-size";
-                description: "A large font size, good for headings and emphasis";
-            };
-        };
-        lineHeight: {
-            $root: {
-                purpose: "line-height";
-                description: string;
-            };
-            tight: {
-                purpose: "line-height";
-                description: "A tight line height, good for large text or when space is limited";
-            };
-            normal: {
-                purpose: "line-height";
-                description: "A normal line height, good for general use";
-            };
-            loose: {
-                purpose: "line-height";
-                description: "A loose line height, good for small text or when readability is a concern";
-            };
-        };
-        letterSpacing: {
-            $root: {
-                purpose: "letter-spacing";
-                description: string;
-            };
-            tight: {
-                purpose: "letter-spacing";
-                description: "A tight letter spacing, good for large text or when space is limited";
-            };
-            normal: {
-                purpose: "letter-spacing";
-                description: "A normal letter spacing, good for general use";
-            };
-            loose: {
-                purpose: "letter-spacing";
-                description: "A loose letter spacing, good for small text or when readability is a concern";
-            };
-        };
-    };
-};
-export type ArborModeSchema<TColorName extends string = string> = ReturnType<typeof createArborModeSchema<TColorName>>;
-//# sourceMappingURL=modeSchema.d.ts.map