/*-------------------------------------------------------------------------- @sinclair/typebox The MIT License (MIT) Copyright (c) 2017-2025 Haydn Paterson (sinclair) Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. ---------------------------------------------------------------------------*/ import * as Types from '@sinclair/typebox' // ------------------------------------------------------------------- // Annotation // // Generates TypeScript Type Annotations from TypeBox types // ------------------------------------------------------------------- /** Generates TypeScript Type Annotations from TypeBox types */ export namespace Annotation { // ----------------------------------------------------------------- // Escape // ----------------------------------------------------------------- function Escape(content: string) { return content.replace(/'/g, "\\'") } // ----------------------------------------------------------------- // Types // ----------------------------------------------------------------- function Intersect(schema: Types.TSchema[], references: Types.TSchema[]): string { const [L, ...R] = schema // prettier-ignore return R.length === 0 ? `${Visit(L, references)}` : `${Visit(L, references)} & ${Intersect(R, references)}` } function Union(schema: Types.TSchema[], references: Types.TSchema[]): string { const [L, ...R] = schema // prettier-ignore return R.length === 0 ? `${Visit(L, references)}` : `${Visit(L, references)} | ${Union(R, references)}` } function Tuple(schema: Types.TSchema[], references: Types.TSchema[]): string { const [L, ...R] = schema // prettier-ignore return R.length > 0 ? `${Visit(L, references)}, ${Tuple(R, references)}` : `` } function Property(schema: Types.TProperties, K: string, references: Types.TSchema[]): string { const TK = schema[K] // prettier-ignore return ( Types.TypeGuard.IsOptional(TK) && Types.TypeGuard.IsReadonly(TK) ? `readonly ${K}?: ${Visit(TK, references)}` : Types.TypeGuard.IsReadonly(TK) ? `readonly ${K}: ${Visit(TK, references)}` : Types.TypeGuard.IsOptional(TK) ? `${K}?: ${Visit(TK, references)}` : `${K}: ${Visit(TK, references)}` ) } function Properties(schema: Types.TProperties, K: string[], references: Types.TSchema[]): string { const [L, ...R] = K // prettier-ignore return R.length === 0 ? `${Property(schema, L, references)}` : `${Property(schema, L, references)}; ${Properties(schema, R, references)}` } function Parameters(schema: Types.TSchema[], I: number, references: Types.TSchema[]): string { const [L, ...R] = schema // prettier-ignore return R.length === 0 ? `param_${I}: ${Visit(L, references)}` : `param_${I}: ${Visit(L, references)}, ${Parameters(R, I + 1, references)}` } function Literal(schema: Types.TLiteral, references: Types.TSchema[]): string { return typeof schema.const === 'string' ? `'${Escape(schema.const)}'` : schema.const.toString() } function Record(schema: Types.TRecord, references: Types.TSchema[]): string { // prettier-ignore return ( Types.PatternBooleanExact in schema.patternProperties ? `Record` : Types.PatternNumberExact in schema.patternProperties ? `Record` : Types.PatternStringExact in schema.patternProperties ? `Record` : `{}` ) } function TemplateLiteral(schema: Types.TTemplateLiteral, references: Types.TSchema[]) { const E = Types.TemplateLiteralParseExact(schema.pattern) if (!Types.IsTemplateLiteralExpressionFinite(E)) return 'string' return [...Types.TemplateLiteralExpressionGenerate(E)].map((literal) => `'${Escape(literal)}'`).join(' | ') } function Visit(schema: Types.TSchema, references: Types.TSchema[]): string { // prettier-ignore return ( Types.TypeGuard.IsAny(schema) ? 'any' : Types.TypeGuard.IsArray(schema) ? `${Visit(schema.items, references)}[]` : Types.TypeGuard.IsAsyncIterator(schema) ? `AsyncIterableIterator<${Visit(schema.items, references)}>` : Types.TypeGuard.IsBigInt(schema) ? `bigint` : Types.TypeGuard.IsBoolean(schema) ? `boolean` : Types.TypeGuard.IsConstructor(schema) ? `new (${Parameters(schema.parameter, 0, references)}) => ${Visit(schema.returns, references)}` : Types.TypeGuard.IsDate(schema) ? 'Date' : Types.TypeGuard.IsFunction(schema) ? `(${Parameters(schema.parameters, 0, references)}) => ${Visit(schema.returns, references)}` : Types.TypeGuard.IsInteger(schema) ? 'number' : Types.TypeGuard.IsIntersect(schema) ? `(${Intersect(schema.allOf, references)})` : Types.TypeGuard.IsIterator(schema) ? `IterableIterator<${Visit(schema.items, references)}>` : Types.TypeGuard.IsLiteral(schema) ? `${Literal(schema, references)}` : Types.TypeGuard.IsNever(schema) ? `never` : Types.TypeGuard.IsNull(schema) ? `null` : Types.TypeGuard.IsNot(schema) ? 'unknown' : Types.TypeGuard.IsNumber(schema) ? 'number' : Types.TypeGuard.IsObject(schema) ? `{ ${Properties(schema.properties, Object.getOwnPropertyNames(schema.properties), references)} }` : Types.TypeGuard.IsPromise(schema) ? `Promise<${Visit(schema.item, references)}>` : Types.TypeGuard.IsRecord(schema) ? `${Record(schema, references)}` : Types.TypeGuard.IsRef(schema) ? `${Visit(Types.Type.Deref(schema, references), references)}` : Types.TypeGuard.IsString(schema) ? 'string' : Types.TypeGuard.IsSymbol(schema) ? 'symbol' : Types.TypeGuard.IsTemplateLiteral(schema) ? `${TemplateLiteral(schema, references)}` : Types.TypeGuard.IsThis(schema) ? 'unknown' : // requires named interface Types.TypeGuard.IsTuple(schema) ? `[${Tuple(schema.items || [], references)}]` : Types.TypeGuard.IsUint8Array(schema) ? `Uint8Array` : Types.TypeGuard.IsUndefined(schema) ? 'undefined' : Types.TypeGuard.IsUnion(schema) ? `${Union(schema.anyOf, references)}` : Types.TypeGuard.IsVoid(schema) ? `void` : 'unknown' ) } /** Generates a TypeScript annotation for the given schema */ export function Code(schema: Types.TSchema, references: Types.TSchema[] = []): string { return Visit(schema, references) } }