feat(typescript): adjust and make base type name configurable (#37)

MaSch0212 · Dec 20, 2024 · b3bd784 · b3bd784
1 parent cca91d0
commit b3bd784
Show file tree

Hide file tree

Showing 5 changed files with 29 additions and 22 deletions.
diff --git a/packages/typescript/deno.json b/packages/typescript/deno.json
@@ -1,6 +1,6 @@
 {
   "name": "@goast/typescript",
-  "version": "0.4.1",
+  "version": "0.4.2",
   "description": "Provides gOAst generators for generating TypeScript code from OpenAPI specifications.",
   "exports": "./mod.ts",
   "publish": {

diff --git a/packages/typescript/src/generators/models/model-generator.ts b/packages/typescript/src/generators/models/model-generator.ts
@@ -450,7 +450,7 @@ export class DefaultTypeScriptModelGenerator extends TypeScriptFileGenerator<Con
   }
 
   protected getBaseTypeName(ctx: Context, schema: ApiSchema): string {
-    return toCasing(schema.name + '_Base', ctx.config.typeNameCasing);
+    return toCasing(schema.name, ctx.config.discriminatorBaseTypeCasing);
   }
 
   protected getInheritedSchemas(ctx: Context, schema: ApiSchema): ApiSchema['inheritedSchemas'] {

diff --git a/packages/typescript/src/generators/models/models.ts b/packages/typescript/src/generators/models/models.ts
@@ -49,6 +49,12 @@ export type TypeScriptModelGeneratorConfig = TypeScriptGeneratorConfig & {
    * @default 'type'
    */
   typeDeclaration: 'type' | 'prefer-interface';
+
+  /**
+   * The casing to use for the base type of discriminator schemas.
+   * @default `_<SchemaName>Base`
+   */
+  discriminatorBaseTypeCasing: ExtendedStringCasing;
 };
 
 export type TypeScriptModelsGeneratorConfig = TypeScriptModelGeneratorConfig & {
@@ -68,6 +74,7 @@ export const defaultTypeScriptModelGeneratorConfig: DefaultGenerationProviderCon
   modelsDir: 'models',
   modelFileNameCasing: undefined,
   typeDeclaration: 'type',
+  discriminatorBaseTypeCasing: { casing: 'pascal', prefix: '_', suffix: 'Base' },
 };
 
 export const defaultTypeScriptModelsGeneratorConfig: DefaultGenerationProviderConfig<TypeScriptModelsGeneratorConfig> =

diff --git a/...s/typescript/tests/.verify/openapi-models/open-api-v-3-0-discriminated-schemas.expect.txt b/...s/typescript/tests/.verify/openapi-models/open-api-v-3-0-discriminated-schemas.expect.txt
@@ -7,7 +7,7 @@
     models: {
       'schema-1': {
         __source__: '<root>/test/openapi-files/v3/discriminated-schemas.yml#/components/schemas/Pet',
-        additionalExports: [ { name: 'PetBase', type: 'type-export' } ],
+        additionalExports: [ { name: '_PetBase', type: 'type-export' } ],
         component: 'Pet',
         filePath: '<root>/out/models/pet.ts',
         imports: [
@@ -62,7 +62,7 @@
       },
       'schema-5': {
         __source__: '<root>/test/openapi-files/v3/discriminated-schemas.yml#/components/schemas/Pet',
-        additionalExports: [ { name: 'PetBase', type: 'type-export' } ],
+        additionalExports: [ { name: '_PetBase', type: 'type-export' } ],
         component: 'Pet',
         filePath: '<root>/out/models/pet.ts',
         imports: [
@@ -92,7 +92,7 @@
       },
       'schema-7': {
         __source__: '<root>/test/openapi-files/v3/discriminated-schemas.yml#/components/schemas/Pet',
-        additionalExports: [ { name: 'PetBase', type: 'type-export' } ],
+        additionalExports: [ { name: '_PetBase', type: 'type-export' } ],
         component: 'Pet',
         filePath: '<root>/out/models/pet.ts',
         imports: [
@@ -150,12 +150,12 @@ import type { Dog } from './dog';
 
 type PetDiscriminator = ('dog') | ('cat');
 
-export type PetBase = {
+export type _PetBase = {
     name: string;
     petType: string;
   };
 
-export type Pet<TPetType extends PetDiscriminator = PetDiscriminator> = (PetBase) & (({
+export type Pet<TPetType extends PetDiscriminator = PetDiscriminator> = (_PetBase) & (({
         dog: ({
             petType: 'dog';
           }) & (Dog);
@@ -193,10 +193,10 @@ export const SCHEMA_9_VALUES = [
 ┌──────────────────────────────────────┐
 │ <root>/out/models/cat.ts             │
 ├──────────────────────────────────────┤
-import type { PetBase } from './pet';
+import type { _PetBase } from './pet';
 import type { Schema9 } from './schema-9';
 
-export type Cat = (Omit<(PetBase) & ({
+export type Cat = (Omit<(_PetBase) & ({
           /**
            * The measured skill for hunting
            */
@@ -210,9 +210,9 @@ export type Cat = (Omit<(PetBase) & ({
 ┌──────────────────────────────────────┐
 │ <root>/out/models/dog.ts             │
 ├──────────────────────────────────────┤
-import type { PetBase } from './pet';
+import type { _PetBase } from './pet';
 
-export type Dog = (Omit<(PetBase) & ({
+export type Dog = (Omit<(_PetBase) & ({
           /**
            * the size of the pack the dog is from
            */
@@ -230,7 +230,7 @@ export { SCHEMA_9_VALUES } from './models/schema-9';
 
 export type { Cat } from './models/cat';
 export type { Dog } from './models/dog';
-export type { Pet, PetBase } from './models/pet';
+export type { Pet, _PetBase } from './models/pet';
 export type { Schema9 } from './models/schema-9';
 
 └──────────────────────────────────────┘
diff --git a/...s/typescript/tests/.verify/openapi-models/open-api-v-3-1-discriminated-schemas.expect.txt b/...s/typescript/tests/.verify/openapi-models/open-api-v-3-1-discriminated-schemas.expect.txt
@@ -7,7 +7,7 @@
     models: {
       'schema-1': {
         __source__: '<root>/test/openapi-files/v3.1/discriminated-schemas.yml#/components/schemas/Pet',
-        additionalExports: [ { name: 'PetBase', type: 'type-export' } ],
+        additionalExports: [ { name: '_PetBase', type: 'type-export' } ],
         component: 'Pet',
         filePath: '<root>/out/models/pet.ts',
         imports: [
@@ -62,7 +62,7 @@
       },
       'schema-5': {
         __source__: '<root>/test/openapi-files/v3.1/discriminated-schemas.yml#/components/schemas/Pet',
-        additionalExports: [ { name: 'PetBase', type: 'type-export' } ],
+        additionalExports: [ { name: '_PetBase', type: 'type-export' } ],
         component: 'Pet',
         filePath: '<root>/out/models/pet.ts',
         imports: [
@@ -92,7 +92,7 @@
       },
       'schema-7': {
         __source__: '<root>/test/openapi-files/v3.1/discriminated-schemas.yml#/components/schemas/Pet',
-        additionalExports: [ { name: 'PetBase', type: 'type-export' } ],
+        additionalExports: [ { name: '_PetBase', type: 'type-export' } ],
         component: 'Pet',
         filePath: '<root>/out/models/pet.ts',
         imports: [
@@ -150,12 +150,12 @@ import type { Dog } from './dog';
 
 type PetDiscriminator = ('dog') | ('cat');
 
-export type PetBase = {
+export type _PetBase = {
     name: string;
     petType: string;
   };
 
-export type Pet<TPetType extends PetDiscriminator = PetDiscriminator> = (PetBase) & (({
+export type Pet<TPetType extends PetDiscriminator = PetDiscriminator> = (_PetBase) & (({
         dog: ({
             petType: 'dog';
           }) & (Dog);
@@ -193,10 +193,10 @@ export const SCHEMA_9_VALUES = [
 ┌──────────────────────────────────────┐
 │ <root>/out/models/cat.ts             │
 ├──────────────────────────────────────┤
-import type { PetBase } from './pet';
+import type { _PetBase } from './pet';
 import type { Schema9 } from './schema-9';
 
-export type Cat = (Omit<(PetBase) & ({
+export type Cat = (Omit<(_PetBase) & ({
           /**
            * The measured skill for hunting
            */
@@ -210,9 +210,9 @@ export type Cat = (Omit<(PetBase) & ({
 ┌──────────────────────────────────────┐
 │ <root>/out/models/dog.ts             │
 ├──────────────────────────────────────┤
-import type { PetBase } from './pet';
+import type { _PetBase } from './pet';
 
-export type Dog = (Omit<(PetBase) & ({
+export type Dog = (Omit<(_PetBase) & ({
           /**
            * the size of the pack the dog is from
            */
@@ -230,7 +230,7 @@ export { SCHEMA_9_VALUES } from './models/schema-9';
 
 export type { Cat } from './models/cat';
 export type { Dog } from './models/dog';
-export type { Pet, PetBase } from './models/pet';
+export type { Pet, _PetBase } from './models/pet';
 export type { Schema9 } from './models/schema-9';
 
 └──────────────────────────────────────┘