style-dictionary/types/DesignToken.d.ts

Style once, use everywhere. A build system for creating cross-platform styles.

/**
 * This type is also used in the `typescript/module-declarations` format
 * Make sure to also change it there when this type changes!
 */
export interface DesignToken {
    value?: any;
    $value?: any;
    type?: string;
    $type?: string;
    $description?: string;
    name?: string;
    comment?: string;
    themeable?: boolean;
    attributes?: Record<string, unknown>;
    /**
     * When flattening tokens, DesignToken is given a key that matches the original ancestor tree e.g. `{colors.red.500}`
     */
    key?: string;
    [key: string]: any;
}
export interface DesignTokens {
    $type?: string;
    [key: string]: DesignTokens | DesignToken | string | undefined;
}
export interface PreprocessedTokens {
    [key: string]: PreprocessedTokens | DesignToken;
}
export interface TransformedToken extends DesignToken {
    name: string;
    /** The object path of the property.
     *
     * `color: { background: { primary: { value: "#fff" } } }` will have a path of `['color', 'background', 'primary']`.
     */
    path: string[];
    /**
     * A pristine copy of the original property object.
     *
     * This is to make sure transforms and formats always have the unmodified version of  the original property.
     */
    original: DesignToken;
    /**
     * The file path of the file the token is defined in.
     *
     * This file path is derived from the source or include file path arrays defined in the configuration.
     */
    filePath: string;
    /**
     * If the token is from a file defined in the source array as opposed to include in the [configuration](https://styledictionary.com/reference/config).
     */
    isSource: boolean;
}
export interface TransformedTokens {
    [key: string]: TransformedTokens | TransformedToken;
}
export interface Dictionary {
    tokens: TransformedTokens;
    allTokens: TransformedToken[];
    tokenMap: Map<string, TransformedToken>;
    unfilteredTokens?: TransformedTokens;
    unfilteredAllTokens?: TransformedToken[];
    unfilteredTokenMap?: Map<string, TransformedToken>;
}
/**
 * DTCG v2025.10 color spaces
 * @see https://tr.designtokens.org/format/#color
 */
export type DTCGColorSpace = 'srgb' | 'srgb-linear' | 'display-p3' | 'a98-rgb' | 'prophoto-rgb' | 'rec2020' | 'xyz-d50' | 'xyz-d65' | 'lab' | 'lch' | 'oklab' | 'oklch' | 'hsl' | 'hwb';
/**
 * DTCG v2025.10 color value format
 * @see https://tr.designtokens.org/format/#color
 */
export interface DTCGColorValue {
    colorSpace: DTCGColorSpace;
    components: (number | 'none')[];
    alpha?: number | 'none';
    hex?: string;
}