Valibot 中如何预定义 ObjectSchema 的键类型

在 Valibot 这个强大的 TypeScript 表单验证库中，开发者有时会遇到需要预定义 ObjectSchema 键类型的场景。本文将深入探讨这一技术问题的解决方案。

问题背景

当开发者尝试构建自定义的 useForm 钩子时，常常需要确保验证模式中的键与表单字段完全匹配。例如，当表单字段定义为 { name: "", email: "" } 时，验证模式应该强制包含且仅包含 name 和 email 这两个键。

技术挑战

Valibot 的 ObjectSchema 类型通常用于定义对象验证模式，但在 TypeScript 中直接使用它作为泛型时可能会遇到类型推断问题。开发者需要找到一种既能保持类型安全又能提供良好开发体验的解决方案。

解决方案

经过探索，我们发现了两种有效的实现方式：

方案一：分离验证条目与对象创建

type SchemaEntries<TValues> = {
  [TKey in keyof TValues]: GenericSchema<TValues[TKey], unknown>;
};

interface FormConfig<TValues, TEntries extends SchemaEntries<TValues>> {
  fields: TValues;
  validation?: TEntries;
}

function useForm<TValues, TEntries extends SchemaEntries<TValues>>(
  config: FormConfig<TValues, TEntries>
) {
  const schema = config.validation && object(config.validation);
}

这种方案将验证条目与对象创建分离，允许 TypeScript 在配置阶段就进行类型检查，然后在函数内部创建实际的验证对象。

方案二：直接使用 ObjectSchema 类型

type SchemaEntries<TValues> = {
  [TKey in keyof TValues]: GenericSchema<TValues[TKey], unknown>;
};

interface FormConfig<TValues, TEntries extends SchemaEntries<TValues>> {
  fields: TValues;
  validation?: ObjectSchema<
    TEntries,
    ErrorMessage<ObjectIssue> | undefined
  >;
}

function useForm<TValues, TEntries extends SchemaEntries<TValues>>(
  config: FormConfig<TValues, TEntries>
) {
  // 实现代码
}

这种方案直接使用 ObjectSchema 类型，保持了 Valibot 原生 API 的使用方式，同时通过泛型约束确保了类型安全。

实际应用示例

const form = useForm({
  fields: {
    username: "",
    age: 0,
  },
  validation: {
    username: string(),
    age: pipe(number(), minValue(18)),
  },
});

在这个例子中，TypeScript 会确保：

1. 验证对象必须包含 username 和 age 两个键
2. 每个键对应的验证器类型必须与字段类型匹配
3. 如果缺少必要键或添加了额外键，都会引发类型错误

技术原理

这两种方案都利用了 TypeScript 的映射类型和泛型约束：

1. SchemaEntries<TValues> 创建了一个类型，其键与 TValues 相同，但值类型为对应的验证器
2. 泛型约束 TEntries extends SchemaEntries<TValues> 确保传入的验证配置与字段定义匹配
3. 方案一在运行时创建验证对象，方案二直接使用预构建的验证对象

最佳实践建议

1. 对于简单表单，方案二更为直接
2. 对于需要动态构建验证规则的复杂场景，方案一更具灵活性
3. 始终为表单字段提供初始值，这有助于 TypeScript 正确推断类型
4. 考虑添加自定义错误消息等增强功能时，可以扩展 SchemaEntries 类型

通过这种方式，开发者可以在 Valibot 中实现类型安全的表单验证，获得完整的类型检查和编辑器自动补全功能，大大提升开发效率和代码可靠性。