fix(schema): fix OASv3 schema generation fails when model used in @OneOf

has kind property Closes: #2413
tsedio · Sep 3, 2023 · d8a9584 · d8a9584
1 parent 238bac8
commit d8a9584
Show file tree

Hide file tree

Showing 14 changed files with 166 additions and 18 deletions.
diff --git a/packages/specs/schema/src/components/anyMapper.ts b/packages/specs/schema/src/components/anyMapper.ts
@@ -20,8 +20,8 @@ export function anyMapper(input: any, options: JsonSchemaOptions = {}): any {
     return toRef(enumSchema, enumSchema.toJSON(options), options);
   }
 
-  if (input.kind) {
-    const kind = oneOfMapper(input.kind, "map");
+  if (input.$kind && input.$isJsonDocument) {
+    const kind = oneOfMapper(input.$kind, "map");
     const schema = execMapper(kind, input, mapGenericsOptions(options));
 
     return input.canRef ? toRef(input, schema, options) : schema;

diff --git a/packages/specs/schema/src/domain/JsonMap.ts b/packages/specs/schema/src/domain/JsonMap.ts
@@ -5,7 +5,8 @@ import {execMapper} from "../registries/JsonSchemaMapperContainer";
 export class JsonMap<T> extends Map<string, any> {
   [key: string]: any;
 
-  kind: string = "map";
+  $kind: string = "map";
+  readonly $isJsonDocument = true;
 
   constructor(obj: Partial<T> = {}) {
     super();

diff --git a/packages/specs/schema/src/domain/JsonMedia.ts b/packages/specs/schema/src/domain/JsonMedia.ts
@@ -3,7 +3,7 @@ import {JsonMap} from "./JsonMap";
 import {JsonSchema} from "./JsonSchema";
 
 export class JsonMedia extends JsonMap<OS3MediaType<JsonSchema>> {
-  kind: string = "operationMedia";
+  $kind: string = "operationMedia";
 
   groups: string[] = [];
   groupsName: string;

diff --git a/packages/specs/schema/src/domain/JsonOperation.ts b/packages/specs/schema/src/domain/JsonOperation.ts
@@ -20,7 +20,7 @@ export interface JsonOperationOptions extends OS3Operation<JsonSchema, JsonParam
 }
 
 export class JsonOperation extends JsonMap<JsonOperationOptions> {
-  kind: string = "operation";
+  $kind: string = "operation";
 
   readonly operationPaths: Map<string, JsonMethodPath> = new Map();
   #status: number;

diff --git a/packages/specs/schema/src/domain/JsonOperationPathsMap.ts b/packages/specs/schema/src/domain/JsonOperationPathsMap.ts
@@ -2,7 +2,8 @@ import {OperationMethods} from "../constants/httpMethods";
 import {JsonMethodPath} from "./JsonOperation";
 
 export class JsonOperationPathsMap extends Map<string, JsonMethodPath> {
-  kind: string = "operationPaths";
+  $kind: string = "operationPaths";
+  readonly $isJsonDocument = true;
 
   setOperationPath(operationPath: JsonMethodPath) {
     if (operationPath.method !== OperationMethods.CUSTOM) {

diff --git a/packages/specs/schema/src/domain/JsonParameter.ts b/packages/specs/schema/src/domain/JsonParameter.ts
@@ -8,7 +8,7 @@ import {formatParameterType} from "./JsonParameterTypes";
 import {JsonSchema} from "./JsonSchema";
 
 export class JsonParameter extends JsonMap<OS3Parameter<JsonSchema>> implements NestedGenerics {
-  kind = "operationInParameter";
+  $kind = "operationInParameter";
 
   nestedGenerics: Type<any>[][] = [];
   groups: string[];

diff --git a/packages/specs/schema/src/domain/JsonRequestBody.ts b/packages/specs/schema/src/domain/JsonRequestBody.ts
@@ -6,7 +6,7 @@ import {JsonSchema} from "./JsonSchema";
 export type JsonRequestBodyOptions = OS3RequestBody<JsonSchema>;
 
 export class JsonRequestBody extends JsonMap<JsonRequestBodyOptions> {
-  kind = "operationRequestBody";
+  $kind = "operationRequestBody";
 
   constructor(obj: Partial<JsonRequestBodyOptions> = {}) {
     super(obj);

diff --git a/packages/specs/schema/src/domain/JsonResponse.ts b/packages/specs/schema/src/domain/JsonResponse.ts
@@ -9,7 +9,7 @@ import {JsonSchema} from "./JsonSchema";
 export type JsonResponseOptions = OS3Response<JsonSchema, string | JsonHeader>;
 
 export class JsonResponse extends JsonMap<JsonResponseOptions> {
-  kind: string = "operationResponse";
+  $kind: string = "operationResponse";
 
   status: number;
 

diff --git a/packages/specs/schema/src/domain/JsonSchema.ts b/packages/specs/schema/src/domain/JsonSchema.ts
@@ -55,7 +55,7 @@ function mapToJsonSchema(item: any): any {
     return (item as any[]).map(mapToJsonSchema);
   }
 
-  if (item.isStore || item.isJsonSchema || item.isLazyRef) {
+  if (item.isStore || item.$isJsonDocument || item.isLazyRef) {
     return item;
   }
 
@@ -75,9 +75,8 @@ function mapToJsonSchema(item: any): any {
 }
 
 export class JsonSchema extends Map<string, any> implements NestedGenerics {
-  kind: string = "schema";
-
-  readonly isJsonSchema = true;
+  readonly $kind: string = "schema";
+  readonly $isJsonDocument = true;
   readonly $hooks = new Hooks();
   readonly $required: Set<string> = new Set();
   readonly $allow: any[] = [];

diff --git a/packages/specs/schema/src/utils/inlineEnums.spec.ts b/packages/specs/schema/src/utils/inlineEnums.spec.ts
@@ -5,7 +5,7 @@ describe("inlineEnums()", () => {
     const result = inlineEnums(
       {
         enum: {
-          isJsonSchema: true,
+          $isJsonDocument: true,
           toJSON() {
             return {enum: ["type"]};
           }
@@ -26,7 +26,7 @@ describe("inlineEnums()", () => {
       {
         type: "object",
         enum: {
-          isJsonSchema: true,
+          $isJsonDocument: true,
           toJSON() {
             return {enum: ["type"]};
           }
@@ -46,7 +46,7 @@ describe("inlineEnums()", () => {
       {
         type: "string",
         enum: {
-          isJsonSchema: true,
+          $isJsonDocument: true,
           toJSON() {
             return {enum: ["type"]};
           }

diff --git a/packages/specs/schema/src/utils/inlineEnums.ts b/packages/specs/schema/src/utils/inlineEnums.ts
@@ -2,7 +2,7 @@ import {JsonSchema} from "../domain/JsonSchema";
 import {JsonSchemaOptions} from "../interfaces/JsonSchemaOptions";
 
 export function inlineEnums(obj: any, schema: JsonSchema, options: JsonSchemaOptions) {
-  if (options.inlineEnums && obj.enum?.isJsonSchema) {
+  if (options.inlineEnums && obj.enum?.$isJsonDocument) {
     obj.enum = obj.enum.toJSON().enum;
   }
 

diff --git a/packages/specs/schema/test/integrations/__snapshots__/discriminator.integration.spec.ts.snap b/packages/specs/schema/test/integrations/__snapshots__/discriminator.integration.spec.ts.snap
@@ -0,0 +1,97 @@
+// Jest Snapshot v1, https://goo.gl/fbAQLP
+
+exports[`Discriminator with kind property should generate the spec 1`] = `
+Object {
+  "components": Object {
+    "schemas": Object {
+      "FirstImpl": Object {
+        "properties": Object {
+          "kind": Object {
+            "enum": Array [
+              "json",
+            ],
+            "type": "string",
+          },
+          "type": Object {
+            "enum": Array [
+              "one",
+              "two",
+            ],
+            "example": "one",
+            "type": "string",
+          },
+        },
+        "type": "object",
+      },
+      "ParentModel": Object {
+        "properties": Object {
+          "test": Object {
+            "discriminator": Object {
+              "propertyName": "type",
+            },
+            "oneOf": Array [
+              Object {
+                "$ref": "#/components/schemas/FirstImpl",
+              },
+              Object {
+                "$ref": "#/components/schemas/SecondImpl",
+              },
+            ],
+            "required": Array [
+              "type",
+            ],
+          },
+        },
+        "type": "object",
+      },
+      "SecondImpl": Object {
+        "properties": Object {
+          "prop": Object {
+            "type": "string",
+          },
+          "type": Object {
+            "enum": Array [
+              "one",
+              "two",
+            ],
+            "example": "two",
+            "type": "string",
+          },
+        },
+        "type": "object",
+      },
+    },
+  },
+  "paths": Object {
+    "/test": Object {
+      "get": Object {
+        "operationId": "testGet",
+        "parameters": Array [],
+        "responses": Object {
+          "200": Object {
+            "content": Object {
+              "application/json": Object {
+                "schema": Object {
+                  "items": Object {
+                    "$ref": "#/components/schemas/ParentModel",
+                  },
+                  "type": "array",
+                },
+              },
+            },
+            "description": "Success",
+          },
+        },
+        "tags": Array [
+          "Test",
+        ],
+      },
+    },
+  },
+  "tags": Array [
+    Object {
+      "name": "Test",
+    },
+  ],
+}
+`;
diff --git a/packages/specs/schema/test/integrations/discriminator.integration.spec.ts b/packages/specs/schema/test/integrations/discriminator.integration.spec.ts
@@ -1,12 +1,15 @@
 import {Controller} from "@tsed/di";
 import {BodyParams, PathParams} from "@tsed/platform-params";
+import * as Path from "path";
 import {
   DiscriminatorKey,
   DiscriminatorValue,
+  Enum,
   Get,
   getJsonSchema,
   getSpec,
   JsonEntityStore,
+  Name,
   OneOf,
   Partial,
   Patch,
@@ -1287,4 +1290,51 @@ describe("Discriminator", () => {
       expect(JsonEntityStore.from(Event).isDiscriminatorChild).toEqual(false);
     });
   });
+  describe("with kind property", () => {
+    it("should generate the spec", () => {
+      enum Discriminator {
+        ONE = "one",
+        TWO = "two"
+      }
+
+      abstract class BaseModel {
+        @Enum(Discriminator.ONE, Discriminator.TWO)
+        @DiscriminatorKey()
+        public type!: Discriminator.ONE | Discriminator.TWO;
+      }
+
+      @DiscriminatorValue(Discriminator.ONE)
+      class FirstImpl extends BaseModel {
+        public declare type: Discriminator.ONE;
+
+        @Enum("json")
+        public kind!: "json";
+      }
+
+      @DiscriminatorValue(Discriminator.TWO)
+      class SecondImpl extends BaseModel {
+        public declare type: Discriminator.TWO;
+
+        @Property()
+        public prop!: string;
+      }
+
+      class ParentModel {
+        @OneOf(FirstImpl, SecondImpl)
+        public test?: FirstImpl | SecondImpl;
+      }
+
+      @Controller("/test")
+      @Name("Test")
+      class TestController {
+        @Get()
+        @Returns(200, Array).Of(ParentModel)
+        public get(): Promise<ParentModel> {
+          return null as any;
+        }
+      }
+
+      expect(getSpec(TestController)).toMatchSnapshot();
+    });
+  });
 });
diff --git a/tsconfig.json b/tsconfig.json
@@ -1,5 +1,5 @@
 {
-  "files": [],
+  "files": ["**/*"],
   "compilerOptions": {
     "module": "ES2020",
     "target": "ES2020",