tailwindcss 4.0.0-alpha.2 → 4.0.0-alpha.21

package/dist/lib.d.ts

@@ -1,3 +1,104 @@
+type Rule = {
+    kind: 'rule';
+    selector: string;
+    nodes: AstNode[];
+};
+type Declaration = {
+    kind: 'declaration';
+    property: string;
+    value: string | undefined;
+    important: boolean;
+};
+type Comment = {
+    kind: 'comment';
+    value: string;
+};
+type AstNode = Rule | Declaration | Comment;
+
+declare class Theme {
+    #private;
+    private values;
+    constructor(values?: Map<string, {
+        value: string;
+        isReference: boolean;
+        isInline: boolean;
+    }>);
+    add(key: string, value: string, { isReference, isInline }?: {
+        isReference?: boolean | undefined;
+        isInline?: boolean | undefined;
+    }): void;
+    keysInNamespaces(themeKeys: ThemeKey[]): string[];
+    get(themeKeys: (ThemeKey | `${ThemeKey}-${string}`)[]): string | null;
+    entries(): IterableIterator<[string, {
+        value: string;
+        isReference: boolean;
+        isInline: boolean;
+    }]>;
+    resolve(candidateValue: string | null, themeKeys: ThemeKey[]): string | null;
+    resolveValue(candidateValue: string | null, themeKeys: ThemeKey[]): string | null;
+    resolveWith(candidateValue: string, themeKeys: ThemeKey[], nestedKeys?: `--${string}`[]): [string, Record<string, string>] | null;
+    namespace(namespace: string): Map<string | null, string>;
+}
+type ThemeKey = '--accent-color' | '--animate' | '--aspect-ratio' | '--backdrop-blur' | '--backdrop-brightness' | '--backdrop-contrast' | '--backdrop-grayscale' | '--backdrop-hue-rotate' | '--backdrop-invert' | '--backdrop-opacity' | '--backdrop-saturate' | '--backdrop-sepia' | '--background-color' | '--background-image' | '--blur' | '--border-color' | '--border-spacing' | '--border-width' | '--box-shadow-color' | '--breakpoint' | '--brightness' | '--caret-color' | '--color' | '--columns' | '--contrast' | '--cursor' | '--default-border-width' | '--default-ring-color' | '--default-ring-width' | '--default-transition-timing-function' | '--default-transition-duration' | '--divide-width' | '--divide-color' | '--drop-shadow' | '--fill' | '--flex-basis' | '--font-family' | '--font-size' | '--font-weight' | '--gap' | '--gradient-color-stop-positions' | '--grayscale' | '--grid-auto-columns' | '--grid-auto-rows' | '--grid-column' | '--grid-column-end' | '--grid-column-start' | '--grid-row' | '--grid-row-end' | '--grid-row-start' | '--grid-template-columns' | '--grid-template-rows' | '--height' | '--hue-rotate' | '--inset' | '--inset-shadow' | '--invert' | '--letter-spacing' | '--line-height' | '--line-clamp' | '--list-style-image' | '--list-style-type' | '--margin' | '--max-height' | '--max-width' | '--min-height' | '--min-width' | '--object-position' | '--opacity' | '--order' | '--outline-color' | '--outline-width' | '--outline-offset' | '--padding' | '--placeholder-color' | '--perspective' | '--perspective-origin' | '--radius' | '--ring-color' | '--ring-offset-color' | '--ring-offset-width' | '--ring-width' | '--rotate' | '--saturate' | '--scale' | '--scroll-margin' | '--scroll-padding' | '--sepia' | '--shadow' | '--size' | '--skew' | '--space' | '--spacing' | '--stroke' | '--stroke-width' | '--text-color' | '--text-decoration-color' | '--text-decoration-thickness' | '--text-indent' | '--text-underline-offset' | '--transform-origin' | '--transition-delay' | '--transition-duration' | '--transition-property' | '--transition-timing-function' | '--translate' | '--width' | '--z-index' | `--default-${string}`;
+
+type VariantFn<T extends Variant['kind']> = (rule: Rule, variant: Extract<Variant, {
+    kind: T;
+}>) => null | void;
+type CompareFn = (a: Variant, z: Variant) => number;
+declare class Variants {
+    private compareFns;
+    private variants;
+    private completions;
+    /**
+     * Registering a group of variants should result in the same sort number for
+     * all the variants. This is to ensure that the variants are applied in the
+     * correct order.
+     */
+    private groupOrder;
+    /**
+     * Keep track of the last sort order instead of using the size of the map to
+     * avoid unnecessarily skipping order numbers.
+     */
+    private lastOrder;
+    static(name: string, applyFn: VariantFn<'static'>, { compounds }?: {
+        compounds?: boolean;
+    }): void;
+    fromAst(name: string, ast: AstNode[]): void;
+    functional(name: string, applyFn: VariantFn<'functional'>, { compounds }?: {
+        compounds?: boolean;
+    }): void;
+    compound(name: string, applyFn: VariantFn<'compound'>, { compounds }?: {
+        compounds?: boolean;
+    }): void;
+    group(fn: () => void, compareFn?: CompareFn): void;
+    has(name: string): boolean;
+    get(name: string): {
+        kind: Variant["kind"];
+        order: number;
+        applyFn: VariantFn<any>;
+        compounds: boolean;
+    } | undefined;
+    kind(name: string): "static" | "arbitrary" | "functional" | "compound";
+    compounds(name: string): boolean;
+    suggest(name: string, suggestions: () => string[]): void;
+    getCompletions(name: string): string[];
+    compare(a: Variant | null, z: Variant | null): number;
+    keys(): IterableIterator<string>;
+    entries(): IterableIterator<[string, {
+        kind: Variant["kind"];
+        order: number;
+        applyFn: VariantFn<any>;
+        compounds: boolean;
+    }]>;
+    private set;
+    private nextOrder;
+}
+
+declare function compileAstNodes(candidate: Candidate, designSystem: DesignSystem): {
+    node: AstNode;
+    propertySort: number[];
+}[];
+
 interface ClassMetadata {
     modifiers: string[];
 }
@@ -14,37 +115,47 @@ interface VariantEntry {
     selectors: (options: SelectorOptions) => string[];
 }
 
-declare class Theme {
-    private values;
-    constructor(values?: Map<string, string>);
-    add(key: string, value: string): void;
-    keysInNamespaces(themeKeys: ThemeKey[]): string[];
-    get(themeKeys: ThemeKey[]): string | null;
-    entries(): IterableIterator<[string, string]>;
-    clearNamespace(namespace: string): void;
-    resolveKey(candidateValue: string, themeKeys: ThemeKey[]): string | null;
-    resolve(candidateValue: string, themeKeys: ThemeKey[]): string | null;
-    resolveWith(candidateValue: string, themeKeys: ThemeKey[], nestedKeys?: `--${string}`[]): [string, Record<string, string>] | null;
-    namespace(namespace: string): Map<string | null, string>;
+type CompileFn<T extends Candidate['kind']> = (value: Extract<Candidate, {
+    kind: T;
+}>) => AstNode[] | undefined | null;
+interface SuggestionGroup {
+    supportsNegative?: boolean;
+    values: (string | null)[];
+    modifiers: string[];
 }
-type ThemeKey = '--accent-color' | '--animate' | '--aspect-ratio' | '--backdrop-blur' | '--backdrop-brightness' | '--backdrop-contrast' | '--backdrop-grayscale' | '--backdrop-hue-rotate' | '--backdrop-invert' | '--backdrop-opacity' | '--backdrop-saturate' | '--backdrop-sepia' | '--background-color' | '--background-image' | '--blur' | '--border-color' | '--border-spacing' | '--border-width' | '--box-shadow-color' | '--breakpoint' | '--brightness' | '--caret-color' | '--color' | '--columns' | '--contrast' | '--cursor' | '--default-border-width' | '--default-ring-color' | '--default-ring-width' | '--divide-width' | '--divide-color' | '--drop-shadow' | '--fill' | '--flex-basis' | '--font-family' | '--font-size' | '--font-weight' | '--gap' | '--gradient-color-stop-positions' | '--grayscale' | '--grid-auto-columns' | '--grid-auto-rows' | '--grid-column' | '--grid-column-end' | '--grid-column-start' | '--grid-row' | '--grid-row-end' | '--grid-row-start' | '--grid-template-columns' | '--grid-template-rows' | '--height' | '--hue-rotate' | '--inset' | '--inset-shadow' | '--invert' | '--letter-spacing' | '--line-height' | '--line-clamp' | '--list-style-image' | '--list-style-type' | '--margin' | '--max-height' | '--max-width' | '--min-height' | '--min-width' | '--object-position' | '--opacity' | '--order' | '--outline-color' | '--outline-width' | '--outline-offset' | '--padding' | '--placeholder-color' | '--radius' | '--ring-color' | '--ring-offset-color' | '--ring-offset-width' | '--ring-width' | '--rotate' | '--saturate' | '--scale' | '--scroll-margin' | '--scroll-padding' | '--sepia' | '--shadow' | '--size' | '--skew' | '--space' | '--spacing' | '--stroke' | '--stroke-width' | '--text-color' | '--text-decoration-color' | '--text-decoration-thickness' | '--text-indent' | '--text-underline-offset' | '--transform-origin' | '--transition-delay' | '--transition-duration' | '--transition-property' | '--transition-timing-function' | '--translate' | '--width' | '--z-index';
-
-type Rule = {
-    kind: 'rule';
-    selector: string;
-    nodes: AstNode[];
+type UtilityOptions = {
+    types: string[];
 };
-type Declaration = {
-    kind: 'declaration';
-    property: string;
-    value: string;
-    important: boolean;
+type Utility = {
+    kind: 'static' | 'functional';
+    compileFn: CompileFn<any>;
+    options?: UtilityOptions;
 };
-type Comment = {
-    kind: 'comment';
-    value: string;
+declare class Utilities {
+    private utilities;
+    private completions;
+    static(name: string, compileFn: CompileFn<'static'>): void;
+    functional(name: string, compileFn: CompileFn<'functional'>, options?: UtilityOptions): void;
+    has(name: string, kind: 'static' | 'functional'): boolean;
+    get(name: string): Utility[];
+    getCompletions(name: string): SuggestionGroup[];
+    suggest(name: string, groups: () => SuggestionGroup[]): void;
+    keys(kind: 'static' | 'functional'): string[];
+}
+
+type DesignSystem = {
+    theme: Theme;
+    utilities: Utilities;
+    variants: Variants;
+    candidatesToCss(classes: string[]): (string | null)[];
+    getClassOrder(classes: string[]): [string, bigint | null][];
+    getClassList(): ClassEntry[];
+    getVariants(): VariantEntry[];
+    parseCandidate(candidate: string): Candidate[];
+    parseVariant(variant: string): ReturnType<typeof parseVariant>;
+    compileAstNodes(candidate: Candidate): ReturnType<typeof compileAstNodes>;
+    getUsedVariants(): ReturnType<typeof parseVariant>[];
 };
-type AstNode = Rule | Declaration | Comment;
 
 type ArbitraryUtilityValue = {
     kind: 'arbitrary';
@@ -122,6 +233,7 @@ type Variant =
     kind: 'arbitrary';
     selector: string;
     compounds: boolean;
+    relative: boolean;
 }
 /**
  * Static variants are variants that don't take any arguments.
@@ -186,6 +298,7 @@ type Candidate =
     modifier: ArbitraryModifier | NamedModifier | null;
     variants: Variant[];
     important: boolean;
+    raw: string;
 }
 /**
  * Static candidates are candidates that don't take any arguments.
@@ -201,6 +314,7 @@ type Candidate =
     variants: Variant[];
     negative: boolean;
     important: boolean;
+    raw: string;
 }
 /**
  * Functional candidates are candidates that can take an argument.
@@ -219,106 +333,89 @@ type Candidate =
     variants: Variant[];
     negative: boolean;
     important: boolean;
+    raw: string;
 };
+declare function parseVariant(variant: string, designSystem: DesignSystem): Variant | null;
 
-type CompileFn<T extends Candidate['kind']> = (value: Extract<Candidate, {
-    kind: T;
-}>) => AstNode[] | undefined;
-interface SuggestionGroup {
-    supportsNegative?: boolean;
-    values: (string | null)[];
-    modifiers: string[];
-}
-declare class Utilities {
-    private utilities;
-    private completions;
-    static(name: string, compileFn: CompileFn<'static'>): void;
-    functional(name: string, compileFn: CompileFn<'functional'>): void;
-    arbitrary(compileFn: CompileFn<'arbitrary'>): void;
-    has(name: string): boolean;
-    get(name: string | symbol): {
-        kind: "arbitrary" | "static" | "functional";
-        compileFn: CompileFn<any>;
-    } | undefined;
-    kind(name: string): "arbitrary" | "static" | "functional";
-    getCompletions(name: string): SuggestionGroup[];
-    suggest(name: string, groups: () => SuggestionGroup[]): void;
-    keys(): IterableIterator<string | symbol>;
-    entries(): IterableIterator<[string | symbol, {
-        kind: "arbitrary" | "static" | "functional";
-        compileFn: CompileFn<any>;
-    }]>;
-    getArbitrary(): CompileFn<any>;
-    private set;
+interface PluginUtils {
+    theme(keypath: string, defaultValue?: any): any;
 }
 
-type VariantFn<T extends Variant['kind']> = (rule: Rule, variant: Extract<Variant, {
-    kind: T;
-}>) => null | void;
-type CompareFn = (a: Variant, z: Variant) => number;
-declare class Variants {
-    private compareFns;
-    private variants;
-    private completions;
-    /**
-     * Registering a group of variants should result in the same sort number for
-     * all the variants. This is to ensure that the variants are applied in the
-     * correct order.
-     */
-    private groupOrder;
-    /**
-     * Keep track of the last sort order instead of using the size of the map to
-     * avoid unnecessarily skipping order numbers.
-     */
-    private lastOrder;
-    static(name: string, applyFn: VariantFn<'static'>, { compounds }?: {
-        compounds?: boolean;
-    }): void;
-    functional(name: string, applyFn: VariantFn<'functional'>, { compounds }?: {
-        compounds?: boolean;
-    }): void;
-    compound(name: string, applyFn: VariantFn<'compound'>, { compounds }?: {
-        compounds?: boolean;
-    }): void;
-    group(fn: () => void, compareFn?: CompareFn): void;
-    has(name: string): boolean;
-    get(name: string): {
-        kind: "arbitrary" | "static" | "functional" | "compound";
-        order: number;
-        applyFn: VariantFn<any>;
-        compounds: boolean;
-    } | undefined;
-    kind(name: string): "arbitrary" | "static" | "functional" | "compound";
-    compounds(name: string): boolean;
-    suggest(name: string, suggestions: () => string[]): void;
-    getCompletions(name: string): string[];
-    compare(a: Variant | null, z: Variant | null): number;
-    keys(): IterableIterator<string>;
-    entries(): IterableIterator<[string, {
-        kind: "arbitrary" | "static" | "functional" | "compound";
-        order: number;
-        applyFn: VariantFn<any>;
-        compounds: boolean;
-    }]>;
-    private set;
-    private nextOrder;
-}
+type PluginFn = (api: PluginAPI) => void;
+type PluginWithConfig = {
+    handler: PluginFn;
+    config?: UserConfig;
+};
+type PluginWithOptions<T> = {
+    (options?: T): PluginWithConfig;
+    __isOptionsFunction: true;
+};
+type Plugin = PluginFn | PluginWithConfig | PluginWithOptions<any>;
+type PluginAPI = {
+    addBase(base: CssInJs): void;
+    addVariant(name: string, variant: string | string[] | CssInJs): void;
+    addUtilities(utilities: Record<string, CssInJs | CssInJs[]> | Record<string, CssInJs | CssInJs[]>[], options?: {}): void;
+    matchUtilities(utilities: Record<string, (value: string, extra: {
+        modifier: string | null;
+    }) => CssInJs | CssInJs[]>, options?: Partial<{
+        type: string | string[];
+        supportsNegativeValues: boolean;
+        values: Record<string, string> & {
+            __BARE_VALUE__?: (value: NamedUtilityValue) => string | undefined;
+        };
+        modifiers: 'any' | Record<string, string>;
+    }>): void;
+    addComponents(utilities: Record<string, CssInJs> | Record<string, CssInJs>[], options?: {}): void;
+    matchComponents(utilities: Record<string, (value: string, extra: {
+        modifier: string | null;
+    }) => CssInJs>, options?: Partial<{
+        type: string | string[];
+        supportsNegativeValues: boolean;
+        values: Record<string, string> & {
+            __BARE_VALUE__?: (value: NamedUtilityValue) => string | undefined;
+        };
+        modifiers: 'any' | Record<string, string>;
+    }>): void;
+    theme(path: string, defaultValue?: any): any;
+    config(path: string, defaultValue?: any): any;
+    prefix(className: string): string;
+};
+type CssInJs = {
+    [key: string]: string | string[] | CssInJs | CssInJs[];
+};
 
-type DesignSystem = {
-    theme: Theme;
-    utilities: Utilities;
-    variants: Variants;
-    candidatesToCss(classes: string[]): (string | null)[];
-    getClassOrder(classes: string[]): [string, bigint | null][];
-    getClassList(): ClassEntry[];
-    getVariants(): VariantEntry[];
+type ResolvableTo<T> = T | ((utils: PluginUtils) => T);
+type ThemeValue = ResolvableTo<Record<string, unknown>> | null | undefined;
+type ThemeConfig = Record<string, ThemeValue> & {
+    extend?: Record<string, ThemeValue>;
+};
+type ContentFile = string | {
+    raw: string;
+    extension?: string;
 };
+type DarkModeStrategy = false | 'media' | 'class' | ['class', string] | 'selector' | ['selector', string] | ['variant', string | string[]];
+interface UserConfig {
+    presets?: UserConfig[];
+    theme?: ThemeConfig;
+    plugins?: Plugin[];
+}
+interface UserConfig {
+    content?: ContentFile[] | {
+        files: ContentFile[];
+    };
+}
+interface UserConfig {
+    darkMode?: DarkModeStrategy;
+}
 
-declare function compile(css: string, rawCandidates: string[]): string;
-declare function optimizeCss(input: string, { file, minify }?: {
-    file?: string;
-    minify?: boolean;
-}): string;
-declare function __unstable__loadDesignSystem(css: string): DesignSystem;
+type CompileOptions = {
+    loadPlugin?: (path: string) => Promise<Plugin>;
+    loadConfig?: (path: string) => Promise<UserConfig>;
+};
+declare function compile(css: string, opts?: CompileOptions): Promise<{
+    globs: string[];
+    build(candidates: string[]): string;
+}>;
+declare function __unstable__loadDesignSystem(css: string, opts?: CompileOptions): Promise<DesignSystem>;
 
-export { __unstable__loadDesignSystem, compile, optimizeCss };
+export { __unstable__loadDesignSystem, compile };