TypeBox 中实现带剩余元素的元组类型

在 TypeScript 开发中，我们经常会遇到需要定义一种特殊的元组类型：它包含固定数量的特定类型元素，后面可以跟随任意数量的另一种类型元素。例如 ['me', 'you', ...string[]] 这样的类型。本文将介绍如何在 TypeBox 中实现这种带剩余元素的元组类型。

技术背景

TypeBox 是一个用于在 TypeScript 中创建 JSON Schema 的库，它能够将 TypeScript 类型转换为 JSON Schema 定义。在 JSON Schema 规范中，这种带前缀元素和剩余元素的数组类型可以通过 prefixItems 和 unevaluatedItems 属性来实现。

然而，TypeBox 当前默认使用的是 Draft-7 规范，该规范不支持这种语法。不过，我们可以通过两种方式来实现这一功能。

方法一：使用 Type.Unsafe 结合 Ajv

第一种方法是利用 TypeBox 的 Type.Unsafe 功能，结合配置为 Draft 2020-12 规范的 Ajv 验证器：

import { Type, Static, TSchema } from '@sinclair/typebox'

// 定义类型辅助工具
export type TupleRestStatic<T extends TSchema[], Rest extends TSchema, Acc extends unknown[] = []> = 
    T extends [infer L extends TSchema, ...infer R extends TSchema[]]
      ? TupleRestStatic<R, Rest, [...Acc, Static<L>]>
      : [...Acc, ...Static<Rest>[]]

// 创建带剩余元素的元组类型
export const TupleRest = <T extends TSchema[], Rest extends TSchema>(items: [...T], rest: Rest) => 
  Type.Unsafe<TupleRestStatic<T, Rest>>({
    type: 'array',
    prefixItems: items,
    unevaluatedItems: rest
  })

// 使用示例
const T = TupleRest([Type.String(), Type.Number()], Type.Boolean())
type T = Static<typeof T> // 类型为 [string, number, ...boolean[]]

这种方法需要将 Ajv 配置为支持 Draft 2020-12 规范，适合快速实现需求。

方法二：使用 TypeRegistry 自定义类型

第二种方法是利用 TypeBox 的 TypeRegistry 功能来自定义类型，这种方式更加灵活且不依赖特定的 JSON Schema 版本：

import { Type, Static, TSchema, TypeRegistry, Kind } from '@sinclair/typebox'
import { Value } from '@sinclair/typebox/value'

// 注册自定义类型检查器
TypeRegistry.Set<TTupleRest>('TupleRest', (schema, value) => {
  return (
    Array.isArray(value) && 
    value.length >= schema.prefixItems.length &&
    schema.prefixItems.every((schema, index) => Value.Check(schema, value[index])) &&
    value.every((value, index) => 
      index < schema.prefixItems.length || 
      Value.Check(schema.unevaluatedItems, value)
  )
})

// 定义类型辅助工具
export type TupleRestStatic<T extends TSchema[], Rest extends TSchema, Acc extends unknown[] = []> = 
    T extends [infer L extends TSchema, ...infer R extends TSchema[]]
      ? TupleRestStatic<R, Rest, [...Acc, Static<L>]>
      : [...Acc, ...Static<Rest>[]]

// 定义自定义类型接口
export interface TTupleRest<T extends TSchema[] = [], Rest extends TSchema = TSchema> extends TSchema {
  [Kind]: 'TupleRest'
  static: TupleRestStatic<T, Rest>
  type: 'array'
  prefixItems: T
  unevaluatedItems: Rest
}

// 创建带剩余元素的元组类型
export function TupleRest<T extends TSchema[], Rest extends TSchema>(
  prefixItems: [...T], 
  unevaluatedItems: Rest
): TTupleRest<T, Rest> {
  return { 
    [Kind]: 'TupleRest', 
    type: 'array', 
    prefixItems, 
    unevaluatedItems 
  } as never
}

// 使用示例
const T = TupleRest([Type.String(), Type.Number()], Type.Boolean())
type T = Static<typeof T> // 类型为 [string, number, ...boolean[]]

const R = Value.Check(T, ['', 1, true, true, true]) // 返回 true

这种方法通过自定义类型检查器实现了完整的验证逻辑，不依赖外部验证器的特定版本。

总结

在 TypeBox 中实现带剩余元素的元组类型有两种主要方法：

1. 使用 Type.Unsafe 结合 Draft 2020-12 规范的 Ajv 验证器，适合快速实现需求
2. 使用 TypeRegistry 自定义类型，提供更灵活的解决方案

随着 TypeBox 未来向 Draft 2020-12 规范的迁移，预计会原生支持这种语法。在此之前，上述两种方法都能很好地解决这个问题。开发者可以根据项目需求选择最适合的实现方式。