Set discriminators types before other types than enums

.changeset/slow-vans-win.md

@@ -0,0 +1,5 @@
+---
+"swagger-typescript-api": patch
+---
+
+Ensure discriminators are just after enums in components list to avoid cyclic errors

src/code-gen-process.ts

@@ -127,6 +127,9 @@ export class CodeGenProcess {
       }),
     );
 
+    // Set all discriminators at the top
+    this.schemaComponentsMap.discriminatorsFirst();
+    // Put all enums at the top (before discriminators)
     this.schemaComponentsMap.enumsFirst();
 
     const componentsToParse: SchemaComponent[] =

src/schema-components-map.ts

@@ -77,4 +77,13 @@ export class SchemaComponentsMap {
       return 0;
     });
   }
+
+  // Ensure discriminators are at the top of components list
+  discriminatorsFirst() {
+    this._data.sort((a, b) => {
+      if (Object.keys(a.rawTypeData || {}).includes("discriminator")) return -1;
+      if (Object.keys(b.rawTypeData || {}).includes("discriminator")) return 1;
+      return 0;
+    });
+  }
 }

tests/spec/discriminator/__snapshots__/basic.test.ts.snap

@@ -25,6 +25,74 @@ export enum BlockDTOEnum {
   Kek = "kek",
 }
 
+/** kek pek */
+export type Variant =
+  | ({
+      type: "update";
+    } & VariantUpdate)
+  | ({
+      type: "undo";
+    } & VariantUndo)
+  | ({
+      type: "rollback";
+    } & VariantRollback)
+  | ({
+      type: "scale";
+    } & VariantScale)
+  | ({
+      type: "resources";
+    } & VariantResources)
+  | ({
+      type: "firewall";
+    } & VariantFirewall)
+  | ({
+      type: "gateway";
+    } & VariantGateway);
+
+export type InvalidDiscriminatorPropertyName =
+  BaseInvalidDiscriminatorPropertyName &
+    (
+      | BaseInvalidDiscriminatorPropertyNameTypeMapping<"num", number>
+      | BaseInvalidDiscriminatorPropertyNameTypeMapping<"str", string>
+    );
+
+export type PetWithEnum = BasePetWithEnum &
+  (
+    | BasePetWithEnumPetTypeMapping<PetEnum.Dog, DogWithEnum>
+    | BasePetWithEnumPetTypeMapping<PetEnum.Cat, CatWithEnum>
+    | BasePetWithEnumPetTypeMapping<PetEnum.Lizard, LizardWithEnum>
+  );
+
+export type PetOnlyDiscriminator =
+  | ({
+      pet_type: "dog";
+    } & Dog)
+  | ({
+      pet_type: "cat";
+    } & Cat)
+  | ({
+      pet_type: "lizard";
+    } & Lizard);
+
+export type Pet = BasePet &
+  (
+    | BasePetPetTypeMapping<"dog", Dog>
+    | BasePetPetTypeMapping<"cat", Cat>
+    | BasePetPetTypeMapping<"lizard", Lizard>
+  );
+
+export type BlockDTO = BaseBlockDto &
+  (
+    | BaseBlockDtoTypeMapping<"csv", CsvBlockDTO>
+    | BaseBlockDtoTypeMapping<"file", FileBlockDTO>
+  );
+
+export type BlockDTOWithEnum = BaseBlockDtoWithEnum &
+  (
+    | BaseBlockDtoWithEnumTypeMapping<BlockDTOEnum.Csv, CsvBlockWithEnumDTO>
+    | BaseBlockDtoWithEnumTypeMapping<BlockDTOEnum.File, FileBlockWithEnumDTO>
+  );
+
 export type SimpleDiscriminator = SimpleObject | ComplexObject;
 
 export interface SimpleObject {
@@ -35,12 +103,6 @@ export interface ComplexObject {
   objectType: string;
 }
 
-export type BlockDTOWithEnum = BaseBlockDtoWithEnum &
-  (
-    | BaseBlockDtoWithEnumTypeMapping<BlockDTOEnum.Csv, CsvBlockWithEnumDTO>
-    | BaseBlockDtoWithEnumTypeMapping<BlockDTOEnum.File, FileBlockWithEnumDTO>
-  );
-
 export type CsvBlockWithEnumDTO = BaseBlockDtoWithEnum & {
   type: BlockDTOEnum.Csv;
   text: string;
@@ -51,12 +113,6 @@ export type FileBlockWithEnumDTO = BaseBlockDtoWithEnum & {
   fileId: string;
 };
 
-export type BlockDTO = BaseBlockDto &
-  (
-    | BaseBlockDtoTypeMapping<"csv", CsvBlockDTO>
-    | BaseBlockDtoTypeMapping<"file", FileBlockDTO>
-  );
-
 export type CsvBlockDTO = BaseBlockDto & {
   /** @default "csv" */
   type: "csv";
@@ -69,24 +125,6 @@ export type FileBlockDTO = BaseBlockDto & {
   fileId: string;
 };
 
-export type Pet = BasePet &
-  (
-    | BasePetPetTypeMapping<"dog", Dog>
-    | BasePetPetTypeMapping<"cat", Cat>
-    | BasePetPetTypeMapping<"lizard", Lizard>
-  );
-
-export type PetOnlyDiscriminator =
-  | ({
-      pet_type: "dog";
-    } & Dog)
-  | ({
-      pet_type: "cat";
-    } & Cat)
-  | ({
-      pet_type: "lizard";
-    } & Lizard);
-
 export type Cat = BasePet & {
   name?: string;
 };
@@ -99,13 +137,6 @@ export type Lizard = BasePet & {
   lovesRocks?: boolean;
 };
 
-export type PetWithEnum = BasePetWithEnum &
-  (
-    | BasePetWithEnumPetTypeMapping<PetEnum.Dog, DogWithEnum>
-    | BasePetWithEnumPetTypeMapping<PetEnum.Cat, CatWithEnum>
-    | BasePetWithEnumPetTypeMapping<PetEnum.Lizard, LizardWithEnum>
-  );
-
 export type CatWithEnum = BasePetWithEnum & {
   name?: string;
 };
@@ -118,37 +149,6 @@ export type LizardWithEnum = BasePetWithEnum & {
   lovesRocks?: boolean;
 };
 
-export type InvalidDiscriminatorPropertyName =
-  BaseInvalidDiscriminatorPropertyName &
-    (
-      | BaseInvalidDiscriminatorPropertyNameTypeMapping<"num", number>
-      | BaseInvalidDiscriminatorPropertyNameTypeMapping<"str", string>
-    );
-
-/** kek pek */
-export type Variant =
-  | ({
-      type: "update";
-    } & VariantUpdate)
-  | ({
-      type: "undo";
-    } & VariantUndo)
-  | ({
-      type: "rollback";
-    } & VariantRollback)
-  | ({
-      type: "scale";
-    } & VariantScale)
-  | ({
-      type: "resources";
-    } & VariantResources)
-  | ({
-      type: "firewall";
-    } & VariantFirewall)
-  | ({
-      type: "gateway";
-    } & VariantGateway);
-
 /** Proposal to change firewall rules for deployment. */
 export interface VariantFirewall {
   /** asdasdasdasdasdsad added to deployment. If not set, no rules are added. */
@@ -196,21 +196,18 @@ export interface VariantRollback {
 /** asdasdasdasdasdn */
 export type VariantUndo = object;
 
-interface BaseBlockDtoWithEnum {
-  title: string;
-  type: BlockDTOEnum;
-}
+type BaseInvalidDiscriminatorPropertyName = object;
 
-type BaseBlockDtoWithEnumTypeMapping<Key, Type> = {
-  type: Key;
+type BaseInvalidDiscriminatorPropertyNameTypeMapping<Key, Type> = {
+  "@type": Key;
 } & Type;
 
-interface BaseBlockDto {
-  title: string;
+interface BasePetWithEnum {
+  pet_type: PetEnum;
 }
 
-type BaseBlockDtoTypeMapping<Key, Type> = {
-  type: Key;
+type BasePetWithEnumPetTypeMapping<Key, Type> = {
+  pet_type: Key;
 } & Type;
 
 interface BasePet {
@@ -221,18 +218,21 @@ type BasePetPetTypeMapping<Key, Type> = {
   pet_type: Key;
 } & Type;
 
-interface BasePetWithEnum {
-  pet_type: PetEnum;
+interface BaseBlockDto {
+  title: string;
 }
 
-type BasePetWithEnumPetTypeMapping<Key, Type> = {
-  pet_type: Key;
+type BaseBlockDtoTypeMapping<Key, Type> = {
+  type: Key;
 } & Type;
 
-type BaseInvalidDiscriminatorPropertyName = object;
+interface BaseBlockDtoWithEnum {
+  title: string;
+  type: BlockDTOEnum;
+}
 
-type BaseInvalidDiscriminatorPropertyNameTypeMapping<Key, Type> = {
-  "@type": Key;
+type BaseBlockDtoWithEnumTypeMapping<Key, Type> = {
+  type: Key;
 } & Type;
 "
 `;

tests/spec/enumNotFirstInComponents/__snapshots__/basic.test.ts.snap

@@ -18,6 +18,12 @@ export enum ExampleEnum {
   Example2 = "Example2",
 }
 
+export type ExampleObject = BaseExampleObject &
+  (
+    | BaseExampleObjectTypeMapping<ExampleEnum.Example1, DtoExample1>
+    | BaseExampleObjectTypeMapping<ExampleEnum.Example2, DtoExample2>
+  );
+
 export interface DtoExample1 {
   name: string;
   age: number;
@@ -29,12 +35,6 @@ export interface DtoExample2 {
   description: string;
 }
 
-export type ExampleObject = BaseExampleObject &
-  (
-    | BaseExampleObjectTypeMapping<ExampleEnum.Example1, DtoExample1>
-    | BaseExampleObjectTypeMapping<ExampleEnum.Example2, DtoExample2>
-  );
-
 interface BaseExampleObject {
   type?: ExampleEnum;
 }