javascript - 输入基于作为参数传递的 JSON 模式的函数

Question

我有一个工厂函数 createF ，它接受 JSON 模式作为输入，并输出一个返回适合该模式的对象的函数 f ，它看起来像:

const createF = (schema) => { /* ... */ }

type T1 = number;
const f1: T1 = createF({
  type: 'integer',
});

type T2 = {
  a: number;
  b?: string;
  [key: string]: any;
};
const f2: T2 = createF({
  type: 'object',
  required: ['a'],
  properties: {
    a: { type: 'number' },
    b: { type: 'string' },
  },
});

f1 和 f2 始终返回形状类似于 T1 和 T2 的对象> 分别，但它们没有键入:没有编写 createF ，以便 TS 推断出 f1 和 f2 的正确类型。是否可以重写 createF 来实现它？如果是，怎么办？

我知道可以 have a return type that depends on parameters通过使用函数重载，但在我的例子中，所有可能的输入都是 JSON 模式，我不知道如何将函数重载解决方案扩展到这种情况。

目前，我使用json-schema-to-typescript在编译时围绕 createF 创建的函数生成类型，但这并不理想。

---

一些避免 XY problem 的上下文:我实际上正在构建oa-client ，一个基于 OpenAPI 规范创建助手的库，其中包含架构。在运行时，创建的助手仅接受并返回模式中定义的对象；但在 TS 层上没有类型 - 我必须使用模式来使用节点脚本编写 TS，这并不理想，特别是因为 oa-client 的目标就是不进行代码生成。

Answer 1

我想说这看起来需要大量工作，具体取决于您希望编译器能够为您完成多少工作。我不确定 json 模式是否存在一组现有的 TS 类型，这些类型足够丰富以表示从模式到输出类型的关系，因此您可能需要自己构建一些。以下是专门针对您的 f1 和 f2 示例定制的草图；其他用例可能需要对此处提供的代码进行一些修改/扩展，并且毫无疑问存在一些边缘情况，其中事情不会按照您想要的方式进行。我将呈现的代码的目的是展示一种通用方法，而不是针对任意 json 模式的完全成熟的解决方案。

---

这是 Schema 的一种可能定义，它是与 json 架构对象相对应的类型:

type Schema =
  { type: 'number' | 'integer' | 'string' } |
  { 
     type: 'object', 
     required?: readonly PropertyKey[], 
     properties: { [k: string]: Schema } 
  };

Schema 具有 string literal types 的某个并集的 type 属性。 ，如果该 type 是 object，那么它还有一个 properties 属性，它是键到其他 Schema 的映射code> 对象，并且它可能有一个 required 属性，它是一个键名称数组。

可以使用conditional type将Schema转换为类型。 。有趣的部分是 object 类型，它占据了下面代码的大部分复杂性:

type SchemaToType<S extends Schema> =
  S extends { type: 'number' | 'integer' } ? number :
  S extends { type: 'string' } ? string :
  S extends { type: 'object', properties: infer O, required?: readonly (infer R)[] } ? (
    RequiredKeys<
      { -readonly [K in keyof O]?: O[K] extends Schema ? SchemaToType<O[K]> : never },
      R extends PropertyKey ? R : never
    > & { [key: string]: any }) extends infer U ? { [P in keyof U]: U[P] } : never :
  unknown;

type RequiredKeys<T, K extends PropertyKey> = 
  Required<Pick<T, Extract<keyof T, K>>> & Omit<T, K>

对于对象类型，SchemaToType 查找 properties 和 required 属性，并使用 properties 中的键生成对象类型 以及递归地将 SchemaToType 应用于其属性的值。一开始这是完全可选的，但我们使用 required 属性键，并将全可选对象转换为需要这些键的对象。有很多utility types在那里使用:Pick、Omit、Extract、Required等。详细写出它是如何工作的需要很长时间，但重点是您可以以编程方式将 Schema 的子类型转换为类型。

---

现在我们给 createF 输入以下内容:

declare function createF<S extends Schema>(s: S): () => SchemaToType<S>;

并对其进行测试......但首先请注意，编译器通常会将您的架构对象类型扩展得太多而无用。如果我这样写:

const tooWideSchema = { 
  type: 'object', required: ["a"], properties: { a: { type: 'number' } } 
};

编译器会推断它是这种类型:

// const tooWideSchema: { 
//   type: string; required: string[]; properties: { a: { type: string; }; }; 
// }

糟糕，编译器忘记了我们关心的东西:我们需要 "object" 和 "a" 和 "number"，而不是字符串!所以接下来我将使用 const assertions要求编译器保持传入模式对象的推断类型尽可能窄:

const narrowSchema = { 
  type: 'object', required: ["a"], properties: { a: { type: 'number' } } 
} as const;

as const 有很大的不同:

// const narrowSchema: {
//    readonly type: "object";
//    readonly required: readonly ["a"];
//    readonly properties: {
//        readonly a: {
//            readonly type: "number";
//        };
//    };
//}

该类型有足够的细节来进行我们的转换......所以让我们测试一下:

const f1 = createF({
  type: 'integer',
} as const);
const t1 = f1();
// const t1: number

const f2 = createF({
  type: 'object',
  required: ["a"],
  properties: {
    a: { type: 'number' },
    b: { type: 'string' },
  },
} as const);
const t2 = f2();
/* const t2: {
    [x: string]: any;
    a: number;
    b?: string | undefined;
} */

t1 的类型推断为 number，t2 的类型推断为 {[x:字符串]:任意； a: 数字' b?: 字符串 |未定义}。这些本质上与您的 T1 和 T2 类型相同...耶!

---

这样就完成了演示。正如我上面所说，请注意其他用例和边缘情况。也许您会通过这种方法取得进展，或者最终您可能会发现使用类型系统来实现此目的太脆弱和丑陋，而原始的代码生成解决方案更适合您的需要。不管怎样，祝你好运!

Playground link to code