@terrazzo/token-tools/dist/index.d.ts

Various utilities for token types

import { AliasToken, AliasValue, BooleanToken, BooleanTokenNormalized, BooleanValue, BorderToken, BorderTokenNormalized, BorderValue, BorderValueNormalized, ColorSpace, ColorToken, ColorTokenNormalized, ColorValue, ColorValueNormalized, CubicBezierToken, CubicBezierTokenNormalized, CubicBezierValue, DimensionToken, DimensionTokenNormalized, DimensionValue, DurationToken, DurationTokenNormalized, DurationValue, FontFamilyToken, FontFamilyTokenNormalized, FontFamilyValue, FontFamilyValueNormalized, FontWeightToken, FontWeightTokenNormalized, FontWeightValue, FontWeightValueNormalized, GradientStop, GradientStopNormalized, GradientToken, GradientTokenNormalized, GradientValue, GradientValueNormalized, Group, GroupCore, GroupOrToken, LinkToken, LinkTokenNormalized, LinkValue, ModeMap, NumberToken, NumberTokenNormalized, NumberValue, ShadowToken, ShadowTokenNormalized, ShadowValue, ShadowValueNormalized, StringToken, StringTokenNormalized, StringValue, StrokeStyleToken, StrokeStyleTokenNormalized, StrokeStyleValue, StrokeStyleValueExpanded, Token, TokenCore, TokenMode, TokenNormalized, TokenNormalizedCore, TokenNormalizedSet, TokensSet, TransitionToken, TransitionTokenNormalized, TransitionValue, TransitionValueNormalized, TypographyToken, TypographyTokenNormalized, TypographyValue, TypographyValueNormalized } from "./types-BOWDcBsq.js";
import "culori/css";
import { Color } from "culori/fn";

//#region src/color.d.ts
declare const CULORI_TO_CSS: Record<Extract<Color['mode'], 'a98' | 'lab' | 'lab65' | 'lch' | 'oklab' | 'oklch' | 'okhsv' | 'hsl' | 'hwb' | 'lrgb' | 'p3' | 'prophoto' | 'rec2020' | 'rgb' | 'xyz50' | 'xyz65'>, ColorSpace>;
declare const CSS_TO_CULORI: {
  readonly 'a98-rgb': "a98";
  readonly 'display-p3': "p3";
  readonly hsl: "hsl";
  readonly hwb: "hwb";
  readonly lab: "lab";
  readonly 'lab-d65': "lab65";
  readonly lch: "lch";
  readonly oklab: "oklab";
  readonly oklch: "oklch";
  readonly okhsv: "okhsv";
  readonly 'prophoto-rgb': "prophoto";
  readonly rec2020: "rec2020";
  readonly srgb: "rgb";
  readonly 'srgb-linear': "lrgb";
  readonly xyz: "xyz65";
  readonly 'xyz-d50': "xyz50";
  readonly 'xyz-d65': "xyz65";
};
/** Parse any color */
declare function parseColor(color: string): ColorValueNormalized;
/** Convert a color token to a Culori color */
declare function tokenToCulori(value: ColorValueNormalized): Color | undefined;
interface ColorSpaceDefinition {
  ranges: [min: number, max: number][];
}
/** Complete list of CSS Module 4 Colorspaces */
declare const COLORSPACE: Record<ColorSpace, ColorSpaceDefinition>;
//# sourceMappingURL=color.d.ts.map
//#endregion
//#region src/id.d.ts
/** Is this token an alias of another? */
declare function isAlias(value: string): boolean;
/** Same as isTokenMatch but returns the matching pattern */
declare function getTokenMatch(tokenId: string, globPatterns: string[]): string | undefined;
/** Make an alias */
declare function makeAlias(input: string): string;
/** Parse an alias */
declare function parseAlias(input: string): string;
/** split a token ID into a local ID and group ID */
declare function splitID(id: string): {
  local: string;
  group?: string;
};
//# sourceMappingURL=id.d.ts.map
//#endregion
//#region src/string.d.ts
/** Pad string lengths */
declare function padStr(input: string, length: number, alignment?: 'left' | 'center' | 'right'): string;
/** Pluralize strings */
declare function pluralize<T = string>(count: number, singular: T, plural: T): T;
/** Turn a string into kebab-case */
declare function kebabCase(str: string): string;
//# sourceMappingURL=string.d.ts.map
//#endregion
//#region src/transform.d.ts
interface CustomTransformOptions {
  /** Token $type */
  $type: string;
}
/** Give a user pertinent feedback if they override a transform incorrectly */
declare function validateCustomTransform(value: unknown, {
  $type
}: CustomTransformOptions): void;
//# sourceMappingURL=transform.d.ts.map

//#endregion
export { AliasToken, AliasValue, BooleanToken, BooleanTokenNormalized, BooleanValue, BorderToken, BorderTokenNormalized, BorderValue, BorderValueNormalized, COLORSPACE, CSS_TO_CULORI, CULORI_TO_CSS, ColorSpace, ColorSpaceDefinition, ColorToken, ColorTokenNormalized, ColorValue, ColorValueNormalized, CubicBezierToken, CubicBezierTokenNormalized, CubicBezierValue, CustomTransformOptions, DimensionToken, DimensionTokenNormalized, DimensionValue, DurationToken, DurationTokenNormalized, DurationValue, FontFamilyToken, FontFamilyTokenNormalized, FontFamilyValue, FontFamilyValueNormalized, FontWeightToken, FontWeightTokenNormalized, FontWeightValue, FontWeightValueNormalized, GradientStop, GradientStopNormalized, GradientToken, GradientTokenNormalized, GradientValue, GradientValueNormalized, Group, GroupCore, GroupOrToken, LinkToken, LinkTokenNormalized, LinkValue, ModeMap, NumberToken, NumberTokenNormalized, NumberValue, ShadowToken, ShadowTokenNormalized, ShadowValue, ShadowValueNormalized, StringToken, StringTokenNormalized, StringValue, StrokeStyleToken, StrokeStyleTokenNormalized, StrokeStyleValue, StrokeStyleValueExpanded, Token, TokenCore, TokenMode, TokenNormalized, TokenNormalizedCore, TokenNormalizedSet, TokensSet, TransitionToken, TransitionTokenNormalized, TransitionValue, TransitionValueNormalized, TypographyToken, TypographyTokenNormalized, TypographyValue, TypographyValueNormalized, getTokenMatch, isAlias, kebabCase, makeAlias, padStr, parseAlias, parseColor, pluralize, splitID, tokenToCulori, validateCustomTransform };
//# sourceMappingURL=index.d.ts.map