如何在json-schema-to-typescript中生成更严格的TypeScript类型

在使用json-schema-to-typescript工具将JSON Schema转换为TypeScript类型定义时，开发者可能会遇到生成的类型包含[k: string]: unknown | undefined这样的索引签名的问题。这种宽松的类型定义在某些场景下可能不够严格，不符合开发者的预期。

问题背景

默认情况下，当JSON Schema中没有明确指定additionalProperties时，json-schema-to-typescript会生成包含索引签名的类型定义。这种设计是为了保持与JSON Schema的宽松特性一致，允许对象包含未在Schema中明确定义的额外属性。

例如，对于以下Schema：

{
  "type": "object",
  "properties": {
    "name": {
      "type": "string"
    }
  }
}

生成的TypeScript类型可能包含：

interface MyObject {
  name?: string;
  [k: string]: unknown | undefined;
}

解决方案

要让生成的类型更加严格，可以通过以下两种方式实现：

1. 在Schema中显式设置additionalProperties

在JSON Schema中为每个对象类型显式设置additionalProperties: false，这将告诉json-schema-to-typescript不要生成索引签名。

修改后的Schema示例：

{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "name": {
      "type": "string"
    }
  }
}

2. 递归处理现有Schema

对于已有的复杂Schema，可以编写一个工具函数递归地设置所有对象的additionalProperties为false：

function setNoAdditionalProps(schema: SchemaObject) {
  if (schema.type === "object") {
    schema.additionalProperties = false;
    for (const [, value] of Object.entries(schema.properties ?? {})) {
      setNoAdditionalProps(value as SchemaObject);
    }
  }
  if (schema.type === "array") {
    setNoAdditionalProps(schema.items as SchemaObject);
  }
}

这个函数会：

1. 对于对象类型，设置additionalProperties: false
2. 递归处理对象的所有属性
3. 对于数组类型，递归处理数组元素类型

实际应用

在实际项目中，特别是使用第三方Schema（如resume-schema）时，可能会遇到Schema本身定义了additionalProperties: true的情况。这时可以使用上述递归函数批量修改Schema，确保生成的TypeScript类型更加严格。

注意事项

1. 设置additionalProperties: false后，TypeScript会严格检查对象属性，任何未在Schema中定义的属性都会导致类型错误
2. 这种严格模式更适合需要强类型保证的场景，如API契约、配置验证等
3. 如果确实需要保留灵活性，可以在特定对象上保持additionalProperties: true

通过这种方式，开发者可以更好地控制json-schema-to-typescript生成的类型严格程度，使其更符合项目需求。