type FlattenedToken = { name: string; value: string | number; isReference?: boolean; isDeprecated?: boolean; comment?: string; isBase?: boolean; }; type TokenTree = { value?: string | number; isReference?: boolean; isDeprecated?: boolean; comment?: string; isBase?: boolean; [key: string]: TokenTree | string | number | boolean | undefined; }; /** * Flatten a nested token tree into token records used by SCSS generation. */ declare function flattenTree(nestedTree: TokenTree, prefix?: string): FlattenedToken[]; declare const DEPRECATED_DVRS: string[]; declare const DEPRECATED_DVR = ".$"; declare const DVR = "-"; declare const MAIN_DVR = "-"; type Token = { name: string; value: string; reference?: string; isReference?: boolean; isDeprecated?: boolean; comment?: string; isBase?: boolean; }; type TokenArray = Token[]; /** * export all tokens as a single object with named exports * mainly for token function in ui package */ declare const tokens: { color: { value: string; isReference: boolean; isDeprecated: boolean; default: { value: string; isDeprecated: boolean; }; blue: { value: string; isDeprecated: boolean; light: { value: string; isDeprecated: boolean; }; lightest: { value: string; isDeprecated: boolean; }; }; primary: { value: string; isReference: boolean; isDeprecated: boolean; hue: { "04": { value: string; isDeprecated: boolean; }; "01": { value: string; isDeprecated: boolean; }; }; }; red: { value: string; isDeprecated: boolean; }; white: { value: string; isDeprecated: boolean; }; grey: { value: string; isDeprecated: boolean; light: { value: string; isDeprecated: boolean; }; cool: { value: string; isDeprecated: boolean; }; }; black: { value: string; isDeprecated: boolean; }; text: { value: string; isReference: boolean; secondary: { value: string; isReference: boolean; }; default: { value: string; isDeprecated: boolean; }; subtle: { value: string; isDeprecated: boolean; }; neutral: { value: string; isReference: boolean; }; active: { value: string; isReference: boolean; secondary: { value: string; isReference: boolean; }; }; alert: { value: string; isReference: boolean; }; warning: { value: string; isReference: boolean; }; success: { value: string; isReference: boolean; }; discovery: { value: string; isReference: boolean; }; danger: { value: string; isReference: boolean; isDeprecated: boolean; }; dark: { value: string; isReference: boolean; isDeprecated: boolean; }; light: { value: string; isReference: boolean; isDeprecated: boolean; }; disabled: { value: string; isReference: boolean; }; required: { value: string; isDeprecated: boolean; }; }; border: { value: string; isReference: boolean; active: { value: string; isReference: boolean; }; neutral: { value: string; isReference: boolean; }; bold: { value: string; isReference: boolean; }; alert: { value: string; isReference: boolean; }; warning: { value: string; isReference: boolean; }; success: { value: string; isReference: boolean; }; disabled: { value: string; isReference: boolean; }; discovery: { value: string; isReference: boolean; }; error: { value: string; isDeprecated: boolean; }; static: { value: string; isDeprecated: boolean; }; periwinkle: { value: string; isReference: boolean; }; }; background: { default: { value: string; isReference: boolean; isDeprecated: boolean; }; value: string; isReference: boolean; hover: { value: string; isReference: boolean; }; neutral: { value: string; isReference: boolean; }; bold: { default: { value: string; isReference: boolean; isDeprecated: boolean; }; value: string; isReference: boolean; hover: { value: string; isReference: boolean; }; }; active: { default: { value: string; isReference: boolean; isDeprecated: boolean; }; value: string; isReference: boolean; hover: { value: string; isReference: boolean; }; secondary: { value: string; isReference: boolean; }; tertiary: { value: string; isReference: boolean; }; }; secondary: { value: string; isReference: boolean; isDeprecated: boolean; }; alert: { value: string; isReference: boolean; }; warning: { value: string; isReference: boolean; }; success: { value: string; isReference: boolean; }; disabled: { value: string; isReference: boolean; }; discovery: { value: string; isReference: boolean; }; primary: { value: string; isDeprecated: boolean; }; danger: { value: string; isDeprecated: boolean; }; periwinkle: { value: string; isReference: boolean; }; }; shadow: { default: { value: string; isDeprecated: boolean; }; }; }; palette: { alert: { value: string; isBase: boolean; }; warning: { value: string; isBase: boolean; }; success: { value: string; isBase: boolean; }; disabled: { value: string; isBase: boolean; }; discovery: { value: string; isBase: boolean; }; neutral: { c270: { value: string; isBase: boolean; }; c260: { value: string; isBase: boolean; }; c250: { value: string; isBase: boolean; }; c240: { value: string; isBase: boolean; }; c230: { value: string; isBase: boolean; }; c220: { value: string; isBase: boolean; }; c210: { value: string; isBase: boolean; }; c200: { value: string; isBase: boolean; }; }; primary: { c170: { value: string; isBase: boolean; }; c160: { value: string; isBase: boolean; }; c150: { value: string; isBase: boolean; }; c140: { value: string; isBase: boolean; }; c130: { value: string; isBase: boolean; }; c120: { value: string; isBase: boolean; }; c110: { value: string; isBase: boolean; }; c100: { value: string; isBase: boolean; }; c300: { value: string; isBase: boolean; }; }; }; fontsize: { s64: { value: string; isBase: boolean; comment: string; }; s48: { value: string; isBase: boolean; comment: string; }; s32: { value: string; isBase: boolean; comment: string; }; s24: { value: string; isBase: boolean; comment: string; }; s20: { value: string; isBase: boolean; comment: string; }; s16: { value: string; isBase: boolean; comment: string; }; s14: { value: string; isBase: boolean; comment: string; }; s12: { value: string; isBase: boolean; comment: string; }; s10: { value: string; isBase: boolean; comment: string; }; s8: { value: string; isBase: boolean; comment: string; }; }; font: { family: { value: string; }; lineheight: { default: { value: string; isDeprecated: boolean; }; large: { value: string; isDeprecated: boolean; }; }; weight: { default: { value: number; isDeprecated: boolean; }; regular: { value: number; isDeprecated: boolean; }; medium: { value: number; isDeprecated: boolean; }; large: { value: number; isDeprecated: boolean; }; }; size: { smallest: { value: string; isDeprecated: boolean; }; xs: { value: string; isDeprecated: boolean; }; small: { value: string; isDeprecated: boolean; }; regular: { value: string; isDeprecated: boolean; }; base: { value: string; isDeprecated: boolean; }; large: { value: string; isDeprecated: boolean; }; largest: { value: string; isDeprecated: boolean; }; x: { large: { value: string; isDeprecated: boolean; }; }; }; }; animation: { speed: { value: string; default: { value: string; isDeprecated: boolean; }; fast: { value: string; }; slow: { value: string; }; }; }; layout: { borderRadius: { value: string; isDeprecated: boolean; }; borderRadiusSmall: { value: string; isDeprecated: boolean; }; borderRadiusLarge: { value: string; isDeprecated: boolean; }; borderRadiusMax: { value: string; isDeprecated: boolean; }; borderWidth: { value: string; isDeprecated: boolean; }; boxShadow: { value: string; isDeprecated: boolean; }; boxShadowGreyLight: { value: string; isDeprecated: boolean; }; boxShadowLarge: { value: string; isDeprecated: boolean; }; zMax: { value: number; isDeprecated: boolean; }; padding: { default: { value: string; isDeprecated: boolean; }; smallest: { value: string; isDeprecated: boolean; }; small: { value: string; isDeprecated: boolean; }; medium: { value: string; isDeprecated: boolean; }; large: { value: string; isDeprecated: boolean; }; }; margin: { default: { value: string; isDeprecated: boolean; }; smallest: { value: string; isDeprecated: boolean; }; small: { value: string; isDeprecated: boolean; }; medium: { value: string; isDeprecated: boolean; }; large: { value: string; isDeprecated: boolean; }; }; spacing: { default: { value: string; isDeprecated: boolean; }; none: { value: string; isDeprecated: boolean; }; smallest: { value: string; isDeprecated: boolean; }; small: { value: string; isDeprecated: boolean; }; medium: { value: string; isDeprecated: boolean; }; large: { value: string; isDeprecated: boolean; }; largest: { value: string; isDeprecated: boolean; }; }; }; elevation: { surface: { value: number; sunken: { value: number; }; raised: { value: number; }; overlay: { value: number; }; }; corner: { radius: { value: string; isDeprecated: boolean; default: { value: string; isDeprecated: boolean; }; small: { value: string; isDeprecated: boolean; }; large: { value: string; isDeprecated: boolean; }; max: { value: string; isDeprecated: boolean; }; }; }; shadow: { value: string; isReference: boolean; pressed: { value: string; isDeprecated: boolean; }; large: { value: string; isReference: boolean; }; medium: { value: string; isReference: boolean; }; small: { value: string; isReference: boolean; }; active: { value: string; isReference: boolean; }; alert: { value: string; isReference: boolean; }; warning: { value: string; isReference: boolean; }; success: { value: string; isReference: boolean; }; disabled: { value: string; isReference: boolean; }; discovery: { value: string; isReference: boolean; }; overlay: { value: string; isReference: boolean; }; }; border: { value: string; isReference: boolean; isDeprecated: boolean; width: { value: string; medium: { value: string; isDeprecated: boolean; }; thick: { value: string; isDeprecated: boolean; }; thin: { value: string; isDeprecated: boolean; }; small: { value: string; }; }; radius: { value: string; isReference: boolean; default: { value: string; isReference: boolean; isDeprecated: boolean; }; medium: { value: string; isReference: boolean; }; large: { value: string; isReference: boolean; }; xlarge: { value: string; isReference: boolean; }; xxlarge: { value: string; isReference: boolean; }; max: { value: string; isReference: boolean; }; }; }; z: { index: { value: number; isDeprecated: boolean; max: { value: number; isDeprecated: boolean; }; }; }; }; space: { s0: { value: string; }; s025: { value: string; }; s050: { value: string; }; s075: { value: string; }; s100: { value: string; }; s150: { value: string; }; s200: { value: string; }; s250: { value: string; }; s300: { value: string; }; s400: { value: string; }; s500: { value: string; }; s600: { value: string; }; s700: { value: string; }; s750: { value: string; }; s800: { value: string; }; s1000: { value: string; }; s1500: { value: string; }; s2000: { value: string; }; }; weight: { regular: { value: number; isBase: boolean; }; medium: { value: number; isBase: boolean; }; semibold: { value: number; isBase: boolean; }; bold: { value: number; isBase: boolean; }; }; lineheight: { value: string; isBase: boolean; large: { value: string; isBase: boolean; }; small: { value: string; comment: string; isBase: boolean; }; }; }; /** * Checks if a given string is a valid hexadecimal color code. * * A valid hexadecimal color code starts with a '#' followed by exactly six characters, * which can be digits from 0 to 9 or letters from a to f (case insensitive). * * @param {any} color - Anything to be tested as a hexadecimal color code string. * @returns {boolean} Returns `true` if the string is a valid hex color code, otherwise `false`. */ declare function isHexColor(color: any): color is string; /** * Checks if a token specified by a path is a base token. eg. fontsize, palette * * @param {string} path - The dot-separated path string used to navigate through the nested token structure. * @returns {boolean} Returns `true` if the token found at the specified path is a base token, otherwise returns `false`. * If the path is invalid or does not lead to a token, the function also returns `false`. */ declare function isBaseToken(path: string): boolean; /** * Checks if a token specified by a path is deprecated. * * This function navigates through a nested structure of tokens based on the given path. * The path is a string of property names separated by dots, used to traverse the nested * token structure. If the specified path leads to a token, the function checks if this token * is marked as deprecated. * * @param {string} path - The dot-separated path string used to navigate through the nested token structure. * @returns {boolean} Returns `true` if the token found at the specified path is deprecated, otherwise returns `false`. * If the path is invalid or does not lead to a token, the function also returns `false`. */ declare function isDeprecatedToken(path: string): boolean; /** * Get a token from the JSON files * @param path - The dot-separated path to the token (e.g., "color.text.default") * @param fallback - The fallback value to use if the token isn't found * @param globalTheme - The global theme to use (e.g., 'light' or 'dark') * @param isShallow - If true, only return the shallow reference, eg. 'palette.danger' * @returns The token value or the fallback value */ declare function token(path: string, fallback?: string, globalTheme?: string, isShallow?: boolean): string; export { DEPRECATED_DVR, DEPRECATED_DVRS, DVR, MAIN_DVR, flattenTree, isBaseToken, isDeprecatedToken, isHexColor, token, tokens }; export type { Token, TokenArray };