fix: discriminator and mapping with invalid discriminator property name (#551)

Author: js2me

CHANGELOG.md

@@ -2,7 +2,8 @@
 
 feat: `const` keyword OpenAPI 3.0 draft  
 fix: problem with using `anyOf`  
-feat: `--extract-responses` (nodejs: `extractResponses`) option to extract all schemas from `/components/responses`    
+feat: `--extract-responses` (nodejs: `extractResponses`) option to extract all schemas from `/components/responses`
+fix: discriminator and mapping with invalid discriminator property name (#551)  
 
 ## 13.0.0  
 

src/schema-parser/base-schema-parsers/discriminator.js

@@ -90,7 +90,7 @@ class DiscriminatorSchemaParser extends MonoSchemaParser {
         content: this.config.Ts.IntersectionType([
           this.config.Ts.ObjectWrapper(
             this.config.Ts.TypeField({
-              key: discriminator.propertyName,
+              key: this.config.Ts.StringValue(discriminator.propertyName),
               value: 'Key',
             }),
           ),

tests/generated/v3.0/additional-properties2.ts

@@ -9,7 +9,7 @@
  * ---------------------------------------------------------------
  */
 
-export type Primitive = string | number | boolean | null | (string & number & boolean & null);
+export type Primitive = string | number | boolean | null;
 
 export type PrimitiveMap = Record<string, Primitive>;
 

tests/generated/v3.0/anyof-example.ts

@@ -241,7 +241,7 @@ export class Api<SecurityDataType extends unknown> extends HttpClient<SecurityDa
      * @name PetsPartialUpdate
      * @request PATCH:/pets
      */
-    petsPartialUpdate: (data: PetByAge | PetByType | (PetByAge & PetByType), params: RequestParams = {}) =>
+    petsPartialUpdate: (data: PetByAge | PetByType, params: RequestParams = {}) =>
       this.request<void, any>({
         path: `/pets`,
         method: "PATCH",

tests/generated/v3.0/full-swagger-scheme.ts

@@ -3021,7 +3021,7 @@ export interface Installation {
    * @example "https://api.github.com/installations/1/access_tokens"
    */
   access_tokens_url: string;
-  account: SimpleUser | Enterprise | (SimpleUser & Enterprise) | null;
+  account: SimpleUser | Enterprise | null;
   /** @example 1 */
   app_id: number;
   /** @example "github-actions" */
@@ -17831,13 +17831,6 @@ export class Api<SecurityDataType extends unknown> extends HttpClient<SecurityDa
             status?: "queued" | "in_progress";
             [key: string]: any;
           }
-        | ({
-            status?: "completed";
-            [key: string]: any;
-          } & {
-            status?: "queued" | "in_progress";
-            [key: string]: any;
-          })
       ) & {
         /**
          * Displays a button on GitHub that can be clicked to alert your app to do additional tasks. For example, a code linting app can display a button that automatically fixes detected errors. The button created in this object is displayed after the check run completes. When a user clicks the button, GitHub sends the [`check_run.requested_action` webhook](https://docs.github.com/webhooks/event-payloads/#check_run) to your app. Each action includes a `label`, `identifier` and `description`. A maximum of three actions are accepted. See the [`actions` object](https://docs.github.com/rest/reference/checks#actions-object) description. To learn more about check runs and requested actions, see "[Check runs and requested actions](https://docs.github.com/rest/reference/checks#check-runs-and-requested-actions)." To learn more about check runs and requested actions, see "[Check runs and requested actions](https://docs.github.com/rest/reference/checks#check-runs-and-requested-actions)."
@@ -17979,13 +17972,6 @@ export class Api<SecurityDataType extends unknown> extends HttpClient<SecurityDa
             status?: "queued" | "in_progress";
             [key: string]: any;
           }
-        | ({
-            status?: "completed";
-            [key: string]: any;
-          } & {
-            status?: "queued" | "in_progress";
-            [key: string]: any;
-          })
       ) & {
         /**
          * Possible further actions the integrator can perform, which a user may trigger. Each action includes a `label`, `identifier` and `description`. A maximum of three actions are accepted. See the [`actions` object](https://docs.github.com/rest/reference/checks#actions-object) description. To learn more about check runs and requested actions, see "[Check runs and requested actions](https://docs.github.com/rest/reference/checks#check-runs-and-requested-actions)."
@@ -22161,17 +22147,7 @@ export class Api<SecurityDataType extends unknown> extends HttpClient<SecurityDa
               branch: string;
               /** The repository directory that includes the source files for the Pages site. Allowed paths are `/` or `/docs`. */
               path: "/" | "/docs";
-            }
-          | (
-              | "gh-pages"
-              | "master"
-              | ("master /docs" & {
-                  /** The repository branch used to publish your site's source files. */
-                  branch: string;
-                  /** The repository directory that includes the source files for the Pages site. Allowed paths are `/` or `/docs`. */
-                  path: "/" | "/docs";
-                })
-            );
+            };
       },
       params: RequestParams = {},
     ) =>

tests/generated/v3.0/personal-api-example.ts

@@ -186,7 +186,7 @@ export type TestAllOfDc2 = FooBarBaz & {
   prop?: string;
 };
 
-export type TestAnyOfDc = (FooBarBaz | FooBar | (FooBarBaz & FooBar)) & {
+export type TestAnyOfDc = (FooBarBaz | FooBar) & {
   prop?: string;
 };
 

tests/spec/discriminator/expected.ts

@@ -107,6 +107,12 @@ export type LizardWithEnum = BasePetWithEnum & {
   lovesRocks?: boolean;
 };
 
+export type InvalidDiscriminatorPropertyName = BaseInvalidDiscriminatorPropertyName &
+  (
+    | BaseInvalidDiscriminatorPropertyNameTypeMapping<"num", number>
+    | BaseInvalidDiscriminatorPropertyNameTypeMapping<"str", string>
+  );
+
 interface BaseBlockDtoWithEnum {
   title: string;
   type: BlockDTOEnum;
@@ -139,3 +145,9 @@ interface BasePetWithEnum {
 type BasePetWithEnumPetTypeMapping<Key, Type> = {
   pet_type: Key;
 } & Type;
+
+type BaseInvalidDiscriminatorPropertyName = object;
+
+type BaseInvalidDiscriminatorPropertyNameTypeMapping<Key, Type> = {
+  "@type": Key;
+} & Type;

tests/spec/discriminator/schema.json

@@ -363,6 +363,20 @@
           }
         }
       ]
+    },
+    "InvalidDiscriminatorPropertyName": {
+      "type": "object",
+      "discriminator": {
+        "propertyName": "@type",
+        "mapping": {
+          "num": {
+            "type": "number"
+          },
+          "str": {
+            "type": "string"
+          }
+        }
+      }
     }
   }
 }

tests/spec/discriminator/schema.ts

@@ -107,6 +107,12 @@ export type LizardWithEnum = BasePetWithEnum & {
   lovesRocks?: boolean;
 };
 
+export type InvalidDiscriminatorPropertyName = BaseInvalidDiscriminatorPropertyName &
+  (
+    | BaseInvalidDiscriminatorPropertyNameTypeMapping<"num", number>
+    | BaseInvalidDiscriminatorPropertyNameTypeMapping<"str", string>
+  );
+
 interface BaseBlockDtoWithEnum {
   title: string;
   type: BlockDTOEnum;
@@ -139,3 +145,9 @@ interface BasePetWithEnum {
 type BasePetWithEnumPetTypeMapping<Key, Type> = {
   pet_type: Key;
 } & Type;
+
+type BaseInvalidDiscriminatorPropertyName = object;
+
+type BaseInvalidDiscriminatorPropertyNameTypeMapping<Key, Type> = {
+  "@type": Key;
+} & Type;

tests/spec/enumNamesAsValues/expected.ts

@@ -17,7 +17,7 @@ export type TestAllOfDc2 = FooBarBaz & {
   prop?: string;
 };
 
-export type TestAnyOfDc = (FooBarBaz | FooBar | (FooBarBaz & FooBar)) & {
+export type TestAnyOfDc = (FooBarBaz | FooBar) & {
   prop?: string;
 };
 

tests/spec/enumNamesAsValues/schema.ts

@@ -17,7 +17,7 @@ export type TestAllOfDc2 = FooBarBaz & {
   prop?: string;
 };
 
-export type TestAnyOfDc = (FooBarBaz | FooBar | (FooBarBaz & FooBar)) & {
+export type TestAnyOfDc = (FooBarBaz | FooBar) & {
   prop?: string;
 };
 

tests/spec/nullable-3.0/expected.ts

@@ -23,7 +23,7 @@ export interface TestObject {
   otherObjectMaybeNullA: OtherObject | null;
   otherObjectMaybeNullB: OtherObject | null;
   otherObjectMaybeNullC: OtherObject | null;
-  otherObjectMaybeNullD: OtherObject | null | (OtherObject & null);
+  otherObjectMaybeNullD: OtherObject | null;
 }
 
 export type OtherObject = object;

tests/spec/nullable-3.0/schema.ts

@@ -23,7 +23,7 @@ export interface TestObject {
   otherObjectMaybeNullA: OtherObject | null;
   otherObjectMaybeNullB: OtherObject | null;
   otherObjectMaybeNullC: OtherObject | null;
-  otherObjectMaybeNullD: OtherObject | null | (OtherObject & null);
+  otherObjectMaybeNullD: OtherObject | null;
 }
 
 export type OtherObject = object;

tests/spec/object-types/expected.ts

@@ -11,6 +11,13 @@
 
 type UtilRequiredKeys<T, K extends keyof T> = Omit<T, K> & Required<Pick<T, K>>;
 
+/**
+ * title
+ * description
+ * @example "https://ya.ru/a.png"
+ */
+export type AnyOfWithNullable = string | null;
+
 /** https://github.com/acacode/swagger-typescript-api/issues/445 */
 export interface SpecificEnum1 {
   myEnum?: ["foo", "bar", "baz"];

tests/spec/object-types/schema.json

@@ -19,6 +19,20 @@
   "produces": ["application/json"],
   "paths": {},
   "definitions": {
+    "AnyOfWithNullable":  {
+      "anyOf": [
+        {
+          "type": "string"
+        },
+        {
+          "type": "null"
+        }
+      ],
+      "description": "description",
+      "example": "https://ya.ru/a.png",
+      "nullable": true,
+      "title": "title"
+    },
     "SpecificEnum1": {
       "type": "object",
       "description": "https://github.com/acacode/swagger-typescript-api/issues/445",

tests/spec/object-types/schema.ts

@@ -11,6 +11,13 @@
 
 type UtilRequiredKeys<T, K extends keyof T> = Omit<T, K> & Required<Pick<T, K>>;
 
+/**
+ * title
+ * description
+ * @example "https://ya.ru/a.png"
+ */
+export type AnyOfWithNullable = string | null;
+
 /** https://github.com/acacode/swagger-typescript-api/issues/445 */
 export interface SpecificEnum1 {
   myEnum?: ["foo", "bar", "baz"];