# Validators ## Type Aliases ### RuleValidators ```ts type RuleValidators = (flatten) => object[]; ``` #### Parameters | Parameter | Type | | ------ | ------ | | `flatten` | `FlattenTokens` | #### Returns `object` | Name | Type | | ------ | ------ | | `errors` | [`ValidatorError`](#validatorerror)[] | *** ### TypeValidators ```ts type TypeValidators = object; ``` #### Index Signature ```ts [key: string]: object ``` *** ### ValidatorConfig ```ts type ValidatorConfig = object; ``` #### Properties ##### rules? ```ts optional rules?: RuleValidators; ``` ##### types? ```ts optional types?: TypeValidators; ``` *** ### ValidatorError ```ts type ValidatorError = object; ``` #### Properties ##### message ```ts message: string; ``` ##### name ```ts name: string; ``` ##### path ```ts path: string; ``` ##### value? ```ts optional value?: unknown; ``` *** ### ValidatorReturn ```ts type ValidatorReturn = object; ``` #### Properties ##### errors ```ts errors: ValidatorError[]; ``` ##### warnings ```ts warnings: string[]; ``` ## Variables ### borderTokenPropertyTypes ```ts const borderTokenPropertyTypes: Record; ``` *** ### BorderTokenSchema ```ts const BorderTokenSchema: ZodMiniObject<{ $deprecated: ZodMiniOptional, ZodMiniString]>>; $description: ZodMiniOptional>; $extensions: ZodMiniOptional, ZodMiniUnknown>>; $type: ZodMiniOptional>; $value: ZodMiniUnion, ZodMiniObject<{ color: ZodMiniUnion; colorSpace: ZodMiniString<...>; components: ZodMiniArray<...>; hex: ZodMiniOptional<...>; }, $strict>, ZodMiniString]>; style: ZodMiniUnion, ZodMiniObject<..., ...>]>, ZodMiniString]>; width: ZodMiniUnion; value: ZodMiniNumber<...>; }, $strict>, ZodMiniString]>; }, $strict>]>; }, $strict>; ``` *** ### BorderValueSchema ```ts const BorderValueSchema: ZodMiniObject<{ color: ZodMiniUnion>; colorSpace: ZodMiniString; components: ZodMiniArray, ZodMiniLiteral<"none">]>>; hex: ZodMiniOptional>; }, $strict>, ZodMiniString]>; style: ZodMiniUnion, ZodMiniObject<{ dashArray: ZodMiniArray>; lineCap: ZodMiniString; }, $strict>]>, ZodMiniString]>; width: ZodMiniUnion, ZodMiniLiteral<"rem">]>; value: ZodMiniNumber; }, $strict>, ZodMiniString]>; }, $strict>; ``` *** ### colorSpaces ```ts const colorSpaces: readonly ["srgb", "srgb-linear", "hsl", "hwb", "lab", "lch", "oklab", "oklch", "display-p3", "a98-rgb", "prophoto-rgb", "rec2020", "xyz-d65", "xyz-d50"]; ``` *** ### ColorTokenSchema ```ts const ColorTokenSchema: ZodMiniObject<{ $deprecated: ZodMiniOptional, ZodMiniString]>>; $description: ZodMiniOptional>; $extensions: ZodMiniOptional, ZodMiniUnknown>>; $type: ZodMiniOptional>; $value: ZodMiniUnion, ZodMiniObject<{ alpha: ZodMiniOptional>; colorSpace: ZodMiniString; components: ZodMiniArray, ZodMiniLiteral<"none">]>>; hex: ZodMiniOptional>; }, $strict>]>; }, $strict>; ``` *** ### ColorValueSchema ```ts const ColorValueSchema: ZodMiniObject<{ alpha: ZodMiniOptional>; colorSpace: ZodMiniString; components: ZodMiniArray, ZodMiniLiteral<"none">]>>; hex: ZodMiniOptional>; }, $strict>; ``` *** ### CubicBezierTokenSchema ```ts const CubicBezierTokenSchema: ZodMiniObject<{ $deprecated: ZodMiniOptional, ZodMiniString]>>; $description: ZodMiniOptional>; $extensions: ZodMiniOptional, ZodMiniUnknown>>; $type: ZodMiniOptional>; $value: ZodMiniUnion, ZodMiniArray>]>; }, $strict>; ``` A schema for a cubic bezier token. The cubic bezier token is an array of 4 numbers. The first and third numbers must be between 0 and 1. Reference: https://tr.designtokens.org/format/#cubic-bezier #### Returns The cubic bezier token schema. *** ### CubicBezierValueSchema ```ts const CubicBezierValueSchema: ZodMiniArray>; ``` *** ### DimensionTokenSchema ```ts const DimensionTokenSchema: ZodMiniObject<{ $deprecated: ZodMiniOptional, ZodMiniString]>>; $description: ZodMiniOptional>; $extensions: ZodMiniOptional, ZodMiniUnknown>>; $type: ZodMiniOptional>; $value: ZodMiniUnion, ZodMiniObject<{ unit: ZodMiniUnion, ZodMiniLiteral<"rem">]>; value: ZodMiniNumber; }, $strict>]>; }, $strict>; ``` *** ### DimensionValueSchema ```ts const DimensionValueSchema: ZodMiniObject<{ unit: ZodMiniUnion, ZodMiniLiteral<"rem">]>; value: ZodMiniNumber; }, $strict>; ``` *** ### dtcgJsonSchemas ```ts const dtcgJsonSchemas: TypeValidators; ``` *** ### DurationTokenSchema ```ts const DurationTokenSchema: ZodMiniObject<{ $deprecated: ZodMiniOptional, ZodMiniString]>>; $description: ZodMiniOptional>; $extensions: ZodMiniOptional, ZodMiniUnknown>>; $type: ZodMiniOptional>; $value: ZodMiniUnion, ZodMiniObject<{ unit: ZodMiniUnion, ZodMiniLiteral<"s">]>; value: ZodMiniNumber; }, $strict>]>; }, $strict>; ``` A schema for a duration token. The duration token is an object with a value and a unit. The unit can be "ms" or "s". Reference: https://tr.designtokens.org/format/#duration #### Returns The duration token schema. *** ### DurationValueSchema ```ts const DurationValueSchema: ZodMiniObject<{ unit: ZodMiniUnion, ZodMiniLiteral<"s">]>; value: ZodMiniNumber; }, $strict>; ``` *** ### FontFamilyTokenSchema ```ts const FontFamilyTokenSchema: ZodMiniObject<{ $deprecated: ZodMiniOptional, ZodMiniString]>>; $description: ZodMiniOptional>; $extensions: ZodMiniOptional, ZodMiniUnknown>>; $type: ZodMiniOptional>; $value: ZodMiniUnion, ZodMiniUnion, ZodMiniArray>]>]>; }, $strict>; ``` *** ### FontFamilyValueSchema ```ts const FontFamilyValueSchema: ZodMiniUnion, ZodMiniArray>]>; ``` *** ### FontWeightTokenSchema ```ts const FontWeightTokenSchema: ZodMiniObject<{ $deprecated: ZodMiniOptional, ZodMiniString]>>; $description: ZodMiniOptional>; $extensions: ZodMiniOptional, ZodMiniUnknown>>; $type: ZodMiniOptional>; $value: ZodMiniUnion, ZodMiniUnion, ZodMiniString]>]>; }, $strict>; ``` *** ### fontWeightValues ```ts const fontWeightValues: object; ``` #### Type Declaration | Name | Type | | ------ | ------ | | `100` | readonly \[`"thin"`, `"hairline"`\] | | `200` | readonly \[`"extra-light"`, `"ultra-light"`\] | | `300` | readonly \[`"light"`\] | | `400` | readonly \[`"normal"`, `"regular"`, `"book"`\] | | `500` | readonly \[`"medium"`\] | | `600` | readonly \[`"semi-bold"`, `"demi-bold"`\] | | `700` | readonly \[`"bold"`\] | | `800` | readonly \[`"extra-bold"`, `"ultra-bold"`\] | | `900` | readonly \[`"black"`, `"heavy"`\] | | `950` | readonly \[`"extra-black"`, `"ultra-black"`\] | *** ### FontWeightValueSchema ```ts const FontWeightValueSchema: ZodMiniUnion, ZodMiniString]>; ``` *** ### gradientTokenPropertyTypes ```ts const gradientTokenPropertyTypes: Record; ``` *** ### GradientTokenSchema ```ts const GradientTokenSchema: ZodMiniObject<{ $deprecated: ZodMiniOptional, ZodMiniString]>>; $description: ZodMiniOptional>; $extensions: ZodMiniOptional, ZodMiniUnknown>>; $type: ZodMiniOptional>; $value: ZodMiniUnion, ZodMiniArray; position: ZodMiniUnion; }, $strict>, ZodMiniString]>>]>; }, $strict>; ``` *** ### JsonPointerReferenceSchema ```ts const JsonPointerReferenceSchema: ZodMiniString; ``` *** ### lineCapPredefinedValues ```ts const lineCapPredefinedValues: readonly ["butt", "round", "square"]; ``` *** ### NumberTokenSchema ```ts const NumberTokenSchema: ZodMiniObject<{ $deprecated: ZodMiniOptional, ZodMiniString]>>; $description: ZodMiniOptional>; $extensions: ZodMiniOptional, ZodMiniUnknown>>; $type: ZodMiniOptional>; $value: ZodMiniUnion, ZodMiniNumber]>; }, $strict>; ``` A schema for a number token. Reference: https://tr.designtokens.org/format/#number #### Returns The number token schema. *** ### NumberValueSchema ```ts const NumberValueSchema: ZodMiniNumber; ``` *** ### ReferenceValueSchema ```ts const ReferenceValueSchema: ZodMiniString; ``` *** ### shadowTokenPropertyTypes ```ts const shadowTokenPropertyTypes: Record; ``` *** ### ShadowTokenSchema ```ts const ShadowTokenSchema: ZodMiniObject<{ $deprecated: ZodMiniOptional, ZodMiniString]>>; $description: ZodMiniOptional>; $extensions: ZodMiniOptional, ZodMiniUnknown>>; $type: ZodMiniOptional>; $value: ZodMiniUnion, ZodMiniUnion, ZodMiniString<...>]>; color: ZodMiniUnion, ZodMiniString<...>]>; inset: ZodMiniOptional>; offsetX: ZodMiniUnion, ZodMiniString<...>]>; offsetY: ZodMiniUnion, ZodMiniString<...>]>; spread: ZodMiniUnion, ZodMiniString<...>]>; }, $strict>, ZodMiniArray, ZodMiniString]>>]>]>; }, $strict>; ``` A schema for a shadow token. Reference: https://tr.designtokens.org/format/#shadow #### Returns The shadow token schema. *** ### StrictStringSchema ```ts const StrictStringSchema: ZodMiniString; ``` *** ### strokePredefinedValues ```ts const strokePredefinedValues: readonly ["solid", "dashed", "dotted", "double", "groove", "ridge", "outset", "inset"]; ``` *** ### strokeStyleTokenPropertyTypes ```ts const strokeStyleTokenPropertyTypes: Record; ``` *** ### StrokeStyleTokenSchema ```ts const StrokeStyleTokenSchema: ZodMiniObject<{ $deprecated: ZodMiniOptional, ZodMiniString]>>; $description: ZodMiniOptional>; $extensions: ZodMiniOptional, ZodMiniUnknown>>; $type: ZodMiniOptional>; $value: ZodMiniUnion, ZodMiniUnion, ZodMiniObject<{ dashArray: ZodMiniArray>; lineCap: ZodMiniString; }, $strict>]>]>; }, $strict>; ``` *** ### StrokeStyleValueSchema ```ts const StrokeStyleValueSchema: ZodMiniUnion, ZodMiniObject<{ dashArray: ZodMiniArray; value: ZodMiniNumber; }, $strict>, ZodMiniString]>>; lineCap: ZodMiniString; }, $strict>]>; ``` *** ### TokenValueReferenceSchema ```ts const TokenValueReferenceSchema: ZodMiniString = ReferenceValueSchema; ``` *** ### transitionTokenPropertyTypes ```ts const transitionTokenPropertyTypes: Record; ``` *** ### TransitionTokenSchema ```ts const TransitionTokenSchema: ZodMiniObject<{ $deprecated: ZodMiniOptional, ZodMiniString]>>; $description: ZodMiniOptional>; $extensions: ZodMiniOptional, ZodMiniUnknown>>; $type: ZodMiniOptional>; $value: ZodMiniUnion, ZodMiniObject<{ delay: ZodMiniUnion; value: ZodMiniNumber<...>; }, $strict>, ZodMiniString]>; duration: ZodMiniUnion; value: ZodMiniNumber<...>; }, $strict>, ZodMiniString]>; timingFunction: ZodMiniUnion>, ZodMiniString]>; }, $strict>]>; }, $strict>; ``` *** ### TransitionValueSchema ```ts const TransitionValueSchema: ZodMiniObject<{ delay: ZodMiniUnion, ZodMiniLiteral<"s">]>; value: ZodMiniNumber; }, $strict>, ZodMiniString]>; duration: ZodMiniUnion, ZodMiniLiteral<"s">]>; value: ZodMiniNumber; }, $strict>, ZodMiniString]>; timingFunction: ZodMiniUnion>, ZodMiniString]>; }, $strict>; ``` *** ### typographyTokenPropertyTypes ```ts const typographyTokenPropertyTypes: Record; ``` *** ### TypographyTokenSchema ```ts const TypographyTokenSchema: ZodMiniObject<{ $deprecated: ZodMiniOptional, ZodMiniString]>>; $description: ZodMiniOptional>; $extensions: ZodMiniOptional, ZodMiniUnknown>>; $type: ZodMiniOptional>; $value: ZodMiniUnion, ZodMiniObject<{ fontFamily: ZodMiniUnion, ZodMiniArray<...>]>, ZodMiniString]>; fontSize: ZodMiniUnion; value: ZodMiniNumber<...>; }, $strict>, ZodMiniString]>; fontWeight: ZodMiniUnion, ZodMiniString<...>]>, ZodMiniString]>; letterSpacing: ZodMiniUnion; value: ZodMiniNumber<...>; }, $strict>, ZodMiniString]>; lineHeight: ZodMiniUnion, ZodMiniString]>; }, $strict>]>; }, $strict>; ``` A schema for a typography token. Reference: https://tr.designtokens.org/format/#typography #### Returns The typography token schema. ## Functions ### createSchema() ```ts function createSchema(type, value): ZodMiniObject<{ $deprecated: ZodMiniOptional, ZodMiniString]>>; $description: ZodMiniOptional>; $extensions: ZodMiniOptional, ZodMiniUnknown>>; $type: ZodMiniOptional>; $value: ZodMiniUnion, V]>; }, $strict>; ``` Creates a schema for a token. #### Type Parameters | Type Parameter | | ------ | | `T` *extends* `string` | | `V` *extends* `ZodMiniType`\<`any`, `any`, `$ZodTypeInternals`\<`any`, `any`\>\> | #### Parameters | Parameter | Type | Description | | ------ | ------ | ------ | | `type` | `T` | The type of the token. | | `value` | `V` | The value of the token. | #### Returns `ZodMiniObject`\<\{ `$deprecated`: `ZodMiniOptional`\<`ZodMiniUnion`\, `ZodMiniString`\<`string`\>\]\>\>; `$description`: `ZodMiniOptional`\<`ZodMiniString`\<`string`\>\>; `$extensions`: `ZodMiniOptional`\<`ZodMiniRecord`\<`ZodMiniString`\<`string`\>, `ZodMiniUnknown`\>\>; `$type`: `ZodMiniOptional`\<`ZodMiniLiteral`\<`T`\>\>; `$value`: `ZodMiniUnion`\, `V`\]\>; \}, `$strict`\> The token schema. *** ### dtcgValidator() ```ts function dtcgValidator(value, config?): ValidatorReturn; ``` Validate the token group. The function checks if the token group is valid and if the references are correct. #### Parameters | Parameter | Type | Description | | ------ | ------ | ------ | | `value` | `unknown` | Unknown value to validate | | `config` | [`ValidatorConfig`](#validatorconfig) | Validator to use | #### Returns [`ValidatorReturn`](#validatorreturn) True if the value is a valid token group *** ### GroupSchema() ```ts function GroupSchema(customTypes?): ZodMiniObject<{ $deprecated: ZodMiniOptional, ZodMiniString]>>; $description: ZodMiniOptional>; $extends: ZodMiniOptional, ZodMiniString]>>; $extensions: ZodMiniOptional, ZodMiniUnknown>>; $root: ZodMiniOptional; $schema: ZodMiniOptional>; $type: ZodMiniOptional>; }, $loose>; ``` #### Parameters | Parameter | Type | | ------ | ------ | | `customTypes?` | `string`[] | #### Returns `ZodMiniObject`\<\{ `$deprecated`: `ZodMiniOptional`\<`ZodMiniUnion`\, `ZodMiniString`\<`string`\>\]\>\>; `$description`: `ZodMiniOptional`\<`ZodMiniString`\<`string`\>\>; `$extends`: `ZodMiniOptional`\<`ZodMiniUnion`\, `ZodMiniString`\<`string`\>\]\>\>; `$extensions`: `ZodMiniOptional`\<`ZodMiniRecord`\<`ZodMiniString`\<`string`\>, `ZodMiniUnknown`\>\>; `$root`: `ZodMiniOptional`\<`ZodMiniUnknown`\>; `$schema`: `ZodMiniOptional`\<`ZodMiniString`\<`string`\>\>; `$type`: `ZodMiniOptional`\<`ZodMiniString`\<`string`\>\>; \}, `$loose`\>

Installation

On this page