@arbor-css/core 0.0.141 → 0.0.143

package/dist/presets/v2/schema/schema.d.ts

@@ -0,0 +1,745 @@
+export type V2SchemaConfig<TColorName extends string> = {
+    colorNames: TColorName[];
+};
+export declare const modeSchema: <TColorName extends string>(config: V2SchemaConfig<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.";
+            };
+        };
+        ease: {
+            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.";
+            };
+        };
+    };
+    tint: {
+        $root: {
+            purpose: "color";
+            description: string;
+        };
+        paper: {
+            purpose: "color";
+            description: "The lightest color in the range";
+        };
+        wash: {
+            purpose: "color";
+            description: "A light color in the range, lighter than the base color";
+        };
+        light: {
+            purpose: "color";
+            description: "A light color in the range, lighter than the base color";
+        };
+        mid: {
+            purpose: "color";
+            description: "A mid-tone color in the range, similar to the base color";
+        };
+        heavy: {
+            purpose: "color";
+            description: "A dark color in the range, darker than the base color";
+        };
+        ink: {
+            purpose: "color";
+            description: "The darkest color in the range, usually used for text and other high-contrast elements";
+        };
+    };
+    gray: {
+        $root: {
+            purpose: "color";
+            description: string;
+        };
+        paper: {
+            purpose: "color";
+            description: "The lightest color in the range";
+        };
+        wash: {
+            purpose: "color";
+            description: "A light color in the range, lighter than the base color";
+        };
+        light: {
+            purpose: "color";
+            description: "A light color in the range, lighter than the base color";
+        };
+        mid: {
+            purpose: "color";
+            description: "A mid-tone color in the range, similar to the base color";
+        };
+        heavy: {
+            purpose: "color";
+            description: "A dark color in the range, darker than the base color";
+        };
+        ink: {
+            purpose: "color";
+            description: "The darkest color in the range, usually used for text and other high-contrast elements";
+        };
+    };
+    color: Record<TColorName, {
+        gray: {
+            $root: {
+                purpose: "color";
+                description: string;
+            };
+            paper: {
+                purpose: "color";
+                description: "The lightest color in the range";
+            };
+            wash: {
+                purpose: "color";
+                description: "A light color in the range, lighter than the base color";
+            };
+            light: {
+                purpose: "color";
+                description: "A light color in the range, lighter than the base color";
+            };
+            mid: {
+                purpose: "color";
+                description: "A mid-tone color in the range, similar to the base color";
+            };
+            heavy: {
+                purpose: "color";
+                description: "A dark color in the range, darker than the base color";
+            };
+            ink: {
+                purpose: "color";
+                description: "The darkest color in the range, usually used for text and other high-contrast elements";
+            };
+        };
+        $root: {
+            purpose: "color";
+            description: string;
+        };
+        paper: {
+            purpose: "color";
+            description: "The lightest color in the range";
+        };
+        wash: {
+            purpose: "color";
+            description: "A light color in the range, lighter than the base color";
+        };
+        light: {
+            purpose: "color";
+            description: "A light color in the range, lighter than the base color";
+        };
+        mid: {
+            purpose: "color";
+            description: "A mid-tone color in the range, similar to the base color";
+        };
+        heavy: {
+            purpose: "color";
+            description: "A dark color in the range, darker than the base color";
+        };
+        ink: {
+            purpose: "color";
+            description: "The darkest color in the range, usually used for text and other high-contrast elements";
+        };
+    }>;
+    sp: {
+        $root: "spacing";
+        xs: "spacing";
+        sm: "spacing";
+        md: "spacing";
+        lg: "spacing";
+        xl: "spacing";
+    };
+    rd: {
+        $root: "border-radius";
+        xs: "border-radius";
+        sm: "border-radius";
+        md: "border-radius";
+        lg: "border-radius";
+        xl: "border-radius";
+        full: "border-radius";
+    };
+    lw: {
+        $root: "border-width";
+        sm: "border-width";
+        md: "border-width";
+        lg: "border-width";
+    };
+    shadow: {
+        $root: "shadow";
+        none: {
+            $root: {
+                purpose: "shadow";
+                description: string;
+            };
+            x: {
+                purpose: "shadow-x";
+                description: "Horizontal offset of the shadow";
+            };
+            y: {
+                purpose: "shadow-y";
+                description: "Vertical offset of the shadow";
+            };
+            blur: {
+                purpose: "shadow-blur";
+                description: "Blur radius of the shadow";
+            };
+            spread: {
+                purpose: "shadow-spread";
+                description: "Spread radius of the shadow";
+            };
+            color: {
+                purpose: "shadow-color";
+                description: "Color of the shadow";
+            };
+        };
+        sm: {
+            $root: {
+                purpose: "shadow";
+                description: string;
+            };
+            x: {
+                purpose: "shadow-x";
+                description: "Horizontal offset of the shadow";
+            };
+            y: {
+                purpose: "shadow-y";
+                description: "Vertical offset of the shadow";
+            };
+            blur: {
+                purpose: "shadow-blur";
+                description: "Blur radius of the shadow";
+            };
+            spread: {
+                purpose: "shadow-spread";
+                description: "Spread radius of the shadow";
+            };
+            color: {
+                purpose: "shadow-color";
+                description: "Color of the shadow";
+            };
+        };
+        md: {
+            $root: {
+                purpose: "shadow";
+                description: string;
+            };
+            x: {
+                purpose: "shadow-x";
+                description: "Horizontal offset of the shadow";
+            };
+            y: {
+                purpose: "shadow-y";
+                description: "Vertical offset of the shadow";
+            };
+            blur: {
+                purpose: "shadow-blur";
+                description: "Blur radius of the shadow";
+            };
+            spread: {
+                purpose: "shadow-spread";
+                description: "Spread radius of the shadow";
+            };
+            color: {
+                purpose: "shadow-color";
+                description: "Color of the shadow";
+            };
+        };
+        lg: {
+            $root: {
+                purpose: "shadow";
+                description: string;
+            };
+            x: {
+                purpose: "shadow-x";
+                description: "Horizontal offset of the shadow";
+            };
+            y: {
+                purpose: "shadow-y";
+                description: "Vertical offset of the shadow";
+            };
+            blur: {
+                purpose: "shadow-blur";
+                description: "Blur radius of the shadow";
+            };
+            spread: {
+                purpose: "shadow-spread";
+                description: "Spread radius of the shadow";
+            };
+            color: {
+                purpose: "shadow-color";
+                description: "Color of the shadow";
+            };
+        };
+        xl: {
+            $root: {
+                purpose: "shadow";
+                description: string;
+            };
+            x: {
+                purpose: "shadow-x";
+                description: "Horizontal offset of the shadow";
+            };
+            y: {
+                purpose: "shadow-y";
+                description: "Vertical offset of the shadow";
+            };
+            blur: {
+                purpose: "shadow-blur";
+                description: "Blur radius of the shadow";
+            };
+            spread: {
+                purpose: "shadow-spread";
+                description: "Spread radius of the shadow";
+            };
+            color: {
+                purpose: "shadow-color";
+                description: "Color of the shadow";
+            };
+        };
+    };
+    fs: {
+        $root: "font-size";
+        sm: "font-size";
+        md: "font-size";
+        lg: "font-size";
+    };
+    fw: {
+        $root: "font-weight";
+        normal: "font-weight";
+        bold: "font-weight";
+    };
+    lh: {
+        $root: "line-height";
+        tight: "line-height";
+        normal: "line-height";
+        loose: "line-height";
+    };
+    ls: {
+        $root: "letter-spacing";
+        tight: "letter-spacing";
+        normal: "letter-spacing";
+        loose: "letter-spacing";
+    };
+    dur: {
+        $root: "duration";
+        short: "duration";
+        medium: "duration";
+        long: "duration";
+    };
+    ease: {
+        $root: "easing-function";
+        tight: "easing-function";
+        medium: "easing-function";
+        loose: "easing-function";
+        in: {
+            $root: "easing-function";
+            tight: "easing-function";
+            medium: "easing-function";
+            loose: "easing-function";
+        };
+        out: {
+            $root: "easing-function";
+            tight: "easing-function";
+            medium: "easing-function";
+            loose: "easing-function";
+        };
+    };
+    fg: {
+        $root: "color";
+        light: "color";
+        ink: "color";
+        gray: {
+            $root: "color";
+            light: "color";
+            ink: "color";
+        };
+    };
+    bg: {
+        $root: "color";
+        paper: "color";
+        wash: "color";
+        light: "color";
+        bold: "color";
+        gray: {
+            $root: "color";
+            paper: "color";
+            wash: "color";
+            light: "color";
+            bold: "color";
+        };
+    };
+    action: {
+        p: {
+            $root: {
+                purpose: "other";
+                description: string;
+            };
+            inline: {
+                purpose: "spacing";
+                description: "Inline (horizontal, usually) padding";
+            };
+            block: {
+                purpose: "spacing";
+                description: "Block (vertical, usually) padding";
+            };
+        };
+        rd: "border-radius";
+        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";
+            };
+            b: {
+                $root: {
+                    purpose: "border";
+                    description: string;
+                };
+                c: "color";
+                w: "border-width";
+                style: "border-style";
+            };
+        };
+        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";
+            };
+            b: {
+                $root: {
+                    purpose: "border";
+                    description: string;
+                };
+                c: "color";
+                w: "border-width";
+                style: "border-style";
+            };
+        };
+        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";
+            };
+            b: {
+                $root: {
+                    purpose: "border";
+                    description: string;
+                };
+                c: "color";
+                w: "border-width";
+                style: "border-style";
+            };
+        };
+        config: {
+            roundness: "scalar";
+        };
+    };
+    surface: {
+        p: {
+            $root: {
+                purpose: "other";
+                description: string;
+            };
+            inline: {
+                purpose: "spacing";
+                description: "Inline (horizontal, usually) padding";
+            };
+            block: {
+                purpose: "spacing";
+                description: "Block (vertical, usually) padding";
+            };
+        };
+        rd: "border-radius";
+        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";
+            };
+            b: {
+                $root: {
+                    purpose: "border";
+                    description: string;
+                };
+                c: "color";
+                w: "border-width";
+                style: "border-style";
+            };
+        };
+        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";
+            };
+            b: {
+                $root: {
+                    purpose: "border";
+                    description: string;
+                };
+                c: "color";
+                w: "border-width";
+                style: "border-style";
+            };
+        };
+        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";
+            };
+            b: {
+                $root: {
+                    purpose: "border";
+                    description: string;
+                };
+                c: "color";
+                w: "border-width";
+                style: "border-style";
+            };
+        };
+        config: {
+            roundness: "scalar";
+        };
+    };
+    control: {
+        config: {
+            roundness: "scalar";
+        };
+        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";
+        };
+        b: {
+            $root: {
+                purpose: "border";
+                description: string;
+            };
+            c: "color";
+            w: "border-width";
+            style: "border-style";
+        };
+        p: {
+            $root: {
+                purpose: "other";
+                description: string;
+            };
+            inline: {
+                purpose: "spacing";
+                description: "Inline (horizontal, usually) padding";
+            };
+            block: {
+                purpose: "spacing";
+                description: "Block (vertical, usually) padding";
+            };
+        };
+        rd: "border-radius";
+        text: {
+            size: "font-size";
+            weight: "font-weight";
+            lineHeight: "line-height";
+            font: "font-family";
+            letterSpacing: "letter-spacing";
+        };
+    };
+    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";
+        };
+    };
+};
+export type ModeSchema<TColorName extends string = string> = ReturnType<typeof modeSchema<TColorName>>;
+//# sourceMappingURL=schema.d.ts.map