Skip to content

feat(typescript-angular): update enum definitions to use 'as const' for improved type safety #20958

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
macjohnny merged 1 commit into from
Mar 24, 2025
Merged

feat(typescript-angular): update enum definitions to use 'as const' for improved type safety #20958

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 5 additions & 5 deletions modules/openapi-generator/src/main/resources/typescript-angular/modelEnum.mustache
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,18 +13,18 @@ export enum {{classname}} {
}
{{/stringEnums}}
{{^stringEnums}}
export type {{classname}} = {{#allowableValues}}{{#enumVars}}{{{value}}}{{^-last}} | {{/-last}}{{/enumVars}}{{/allowableValues}};

export const {{classname}} = {
{{#allowableValues}}
{{#enumVars}}
{{#enumDescription}}

/**
* {{.}}
*/{{/enumDescription}}
{{name}}: {{{value}}} as {{classname}}{{^-last}},{{/-last}}
*/
{{/enumDescription}}
{{name}}: {{{value}}}{{^-last}},{{/-last}}
{{/enumVars}}
{{/allowableValues}}
};
} as const;
export type {{classname}} = typeof {{classname}}[keyof typeof {{classname}}];
{{/stringEnums}}
6 changes: 3 additions & 3 deletions modules/openapi-generator/src/main/resources/typescript-angular/modelGenericEnums.mustache
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,14 +15,14 @@ export enum {{classname}}{{enumName}} {
};
{{/stringEnums}}
{{^stringEnums}}
export type {{enumName}} = {{#allowableValues}}{{#enumVars}}{{{value}}}{{^-last}} | {{/-last}}{{/enumVars}}{{/allowableValues}};
export const {{enumName}} = {
{{#allowableValues}}
{{#enumVars}}
{{name}}: {{{value}}} as {{enumName}}{{^-last}},{{/-last}}
{{name}}: {{{value}}}{{^-last}},{{/-last}}
{{/enumVars}}
{{/allowableValues}}
};
} as const;
export type {{enumName}} = typeof {{enumName}}[keyof typeof {{enumName}}];
{{/stringEnums}}
{{/isEnum}}
{{/vars}}
Expand Down
25 changes: 25 additions & 0 deletions ...openapitools/codegen/typescript/typescriptangular/TypeScriptAngularClientCodegenTest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -439,4 +439,29 @@ public void testBasePath() throws IOException {
final String fileContents = Files.readString(Paths.get(output + "/api.base.service.ts"));
assertThat(fileContents).containsOnlyOnce("basePath = '/relative/url'");
}

@Test
public void testEnumAsConst() throws IOException {
// GIVEN
final String specPath = "src/test/resources/3_0/enum.yaml";

File output = Files.createTempDirectory("test").toFile();
output.deleteOnExit();

// WHEN
final CodegenConfigurator configurator = new CodegenConfigurator()
.setGeneratorName("typescript-angular")
.setInputSpec(specPath)
.setOutputDir(output.getAbsolutePath().replace("\\", "/"));

final ClientOptInput clientOptInput = configurator.toClientOptInput();

Generator generator = new DefaultGenerator();
generator.opts(clientOptInput).generate();

// THEN
final String fileContents = Files.readString(Paths.get(output + "/model/type.ts"));
assertThat(fileContents).containsOnlyOnce("} as const;");
assertThat(fileContents).doesNotContain(" as Type");
}
}
10 changes: 5 additions & 5 deletions samples/client/petstore/typescript-angular-v12-provided-in-any/builds/default/model/order.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,12 +24,12 @@ export interface Order {
complete?: boolean;
}
export namespace Order {
export type StatusEnum = 'placed' | 'approved' | 'delivered';
export const StatusEnum = {
Placed: 'placed' as StatusEnum,
Approved: 'approved' as StatusEnum,
Delivered: 'delivered' as StatusEnum
};
Placed: 'placed',
Approved: 'approved',
Delivered: 'delivered'
} as const;
export type StatusEnum = typeof StatusEnum[keyof typeof StatusEnum];
}


10 changes: 5 additions & 5 deletions samples/client/petstore/typescript-angular-v12-provided-in-any/builds/default/model/pet.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,12 +26,12 @@ export interface Pet {
status?: Pet.StatusEnum;
}
export namespace Pet {
export type StatusEnum = 'available' | 'pending' | 'sold';
export const StatusEnum = {
Available: 'available' as StatusEnum,
Pending: 'pending' as StatusEnum,
Sold: 'sold' as StatusEnum
};
Available: 'available',
Pending: 'pending',
Sold: 'sold'
} as const;
export type StatusEnum = typeof StatusEnum[keyof typeof StatusEnum];
}


10 changes: 5 additions & 5 deletions ...les/client/petstore/typescript-angular-v12-provided-in-root/builds/default/model/order.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,12 +24,12 @@ export interface Order {
complete?: boolean;
}
export namespace Order {
export type StatusEnum = 'placed' | 'approved' | 'delivered';
export const StatusEnum = {
Placed: 'placed' as StatusEnum,
Approved: 'approved' as StatusEnum,
Delivered: 'delivered' as StatusEnum
};
Placed: 'placed',
Approved: 'approved',
Delivered: 'delivered'
} as const;
export type StatusEnum = typeof StatusEnum[keyof typeof StatusEnum];
}


10 changes: 5 additions & 5 deletions samples/client/petstore/typescript-angular-v12-provided-in-root/builds/default/model/pet.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,12 +26,12 @@ export interface Pet {
status?: Pet.StatusEnum;
}
export namespace Pet {
export type StatusEnum = 'available' | 'pending' | 'sold';
export const StatusEnum = {
Available: 'available' as StatusEnum,
Pending: 'pending' as StatusEnum,
Sold: 'sold' as StatusEnum
};
Available: 'available',
Pending: 'pending',
Sold: 'sold'
} as const;
export type StatusEnum = typeof StatusEnum[keyof typeof StatusEnum];
}


10 changes: 5 additions & 5 deletions ...es/client/petstore/typescript-angular-v12-provided-in-root/builds/with-npm/model/order.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,12 +24,12 @@ export interface Order {
complete?: boolean;
}
export namespace Order {
export type StatusEnum = 'placed' | 'approved' | 'delivered';
export const StatusEnum = {
Placed: 'placed' as StatusEnum,
Approved: 'approved' as StatusEnum,
Delivered: 'delivered' as StatusEnum
};
Placed: 'placed',
Approved: 'approved',
Delivered: 'delivered'
} as const;
export type StatusEnum = typeof StatusEnum[keyof typeof StatusEnum];
}


10 changes: 5 additions & 5 deletions samples/client/petstore/typescript-angular-v12-provided-in-root/builds/with-npm/model/pet.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,12 +26,12 @@ export interface Pet {
status?: Pet.StatusEnum;
}
export namespace Pet {
export type StatusEnum = 'available' | 'pending' | 'sold';
export const StatusEnum = {
Available: 'available' as StatusEnum,
Pending: 'pending' as StatusEnum,
Sold: 'sold' as StatusEnum
};
Available: 'available',
Pending: 'pending',
Sold: 'sold'
} as const;
export type StatusEnum = typeof StatusEnum[keyof typeof StatusEnum];
}


10 changes: 5 additions & 5 deletions samples/client/petstore/typescript-angular-v13-provided-in-any/builds/default/model/order.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,12 +24,12 @@ export interface Order {
complete?: boolean;
}
export namespace Order {
export type StatusEnum = 'placed' | 'approved' | 'delivered';
export const StatusEnum = {
Placed: 'placed' as StatusEnum,
Approved: 'approved' as StatusEnum,
Delivered: 'delivered' as StatusEnum
};
Placed: 'placed',
Approved: 'approved',
Delivered: 'delivered'
} as const;
export type StatusEnum = typeof StatusEnum[keyof typeof StatusEnum];
}


10 changes: 5 additions & 5 deletions samples/client/petstore/typescript-angular-v13-provided-in-any/builds/default/model/pet.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,12 +26,12 @@ export interface Pet {
status?: Pet.StatusEnum;
}
export namespace Pet {
export type StatusEnum = 'available' | 'pending' | 'sold';
export const StatusEnum = {
Available: 'available' as StatusEnum,
Pending: 'pending' as StatusEnum,
Sold: 'sold' as StatusEnum
};
Available: 'available',
Pending: 'pending',
Sold: 'sold'
} as const;
export type StatusEnum = typeof StatusEnum[keyof typeof StatusEnum];
}


10 changes: 5 additions & 5 deletions ...les/client/petstore/typescript-angular-v13-provided-in-root/builds/default/model/order.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,12 +24,12 @@ export interface Order {
complete?: boolean;
}
export namespace Order {
export type StatusEnum = 'placed' | 'approved' | 'delivered';
export const StatusEnum = {
Placed: 'placed' as StatusEnum,
Approved: 'approved' as StatusEnum,
Delivered: 'delivered' as StatusEnum
};
Placed: 'placed',
Approved: 'approved',
Delivered: 'delivered'
} as const;
export type StatusEnum = typeof StatusEnum[keyof typeof StatusEnum];
}


10 changes: 5 additions & 5 deletions samples/client/petstore/typescript-angular-v13-provided-in-root/builds/default/model/pet.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -27,12 +27,12 @@ export interface Pet {
status?: Pet.StatusEnum;
}
export namespace Pet {
export type StatusEnum = 'available' | 'pending' | 'sold';
export const StatusEnum = {
Available: 'available' as StatusEnum,
Pending: 'pending' as StatusEnum,
Sold: 'sold' as StatusEnum
};
Available: 'available',
Pending: 'pending',
Sold: 'sold'
} as const;
export type StatusEnum = typeof StatusEnum[keyof typeof StatusEnum];
}


10 changes: 5 additions & 5 deletions ...es/client/petstore/typescript-angular-v13-provided-in-root/builds/with-npm/model/order.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,12 +24,12 @@ export interface Order {
complete?: boolean;
}
export namespace Order {
export type StatusEnum = 'placed' | 'approved' | 'delivered';
export const StatusEnum = {
Placed: 'placed' as StatusEnum,
Approved: 'approved' as StatusEnum,
Delivered: 'delivered' as StatusEnum
};
Placed: 'placed',
Approved: 'approved',
Delivered: 'delivered'
} as const;
export type StatusEnum = typeof StatusEnum[keyof typeof StatusEnum];
}


10 changes: 5 additions & 5 deletions samples/client/petstore/typescript-angular-v13-provided-in-root/builds/with-npm/model/pet.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -27,12 +27,12 @@ export interface Pet {
status?: Pet.StatusEnum;
}
export namespace Pet {
export type StatusEnum = 'available' | 'pending' | 'sold';
export const StatusEnum = {
Available: 'available' as StatusEnum,
Pending: 'pending' as StatusEnum,
Sold: 'sold' as StatusEnum
};
Available: 'available',
Pending: 'pending',
Sold: 'sold'
} as const;
export type StatusEnum = typeof StatusEnum[keyof typeof StatusEnum];
}


10 changes: 5 additions & 5 deletions ...les/client/petstore/typescript-angular-v14-provided-in-root/builds/default/model/order.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,12 +24,12 @@ export interface Order {
complete?: boolean;
}
export namespace Order {
export type StatusEnum = 'placed' | 'approved' | 'delivered';
export const StatusEnum = {
Placed: 'placed' as StatusEnum,
Approved: 'approved' as StatusEnum,
Delivered: 'delivered' as StatusEnum
};
Placed: 'placed',
Approved: 'approved',
Delivered: 'delivered'
} as const;
export type StatusEnum = typeof StatusEnum[keyof typeof StatusEnum];
}


10 changes: 5 additions & 5 deletions samples/client/petstore/typescript-angular-v14-provided-in-root/builds/default/model/pet.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -27,12 +27,12 @@ export interface Pet {
status?: Pet.StatusEnum;
}
export namespace Pet {
export type StatusEnum = 'available' | 'pending' | 'sold';
export const StatusEnum = {
Available: 'available' as StatusEnum,
Pending: 'pending' as StatusEnum,
Sold: 'sold' as StatusEnum
};
Available: 'available',
Pending: 'pending',
Sold: 'sold'
} as const;
export type StatusEnum = typeof StatusEnum[keyof typeof StatusEnum];
}


10 changes: 5 additions & 5 deletions samples/client/petstore/typescript-angular-v14-query-param-object-format/model/order.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,12 +24,12 @@ export interface Order {
complete?: boolean;
}
export namespace Order {
export type StatusEnum = 'placed' | 'approved' | 'delivered';
export const StatusEnum = {
Placed: 'placed' as StatusEnum,
Approved: 'approved' as StatusEnum,
Delivered: 'delivered' as StatusEnum
};
Placed: 'placed',
Approved: 'approved',
Delivered: 'delivered'
} as const;
export type StatusEnum = typeof StatusEnum[keyof typeof StatusEnum];
}


10 changes: 5 additions & 5 deletions samples/client/petstore/typescript-angular-v14-query-param-object-format/model/pet.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -27,12 +27,12 @@ export interface Pet {
status?: Pet.StatusEnum;
}
export namespace Pet {
export type StatusEnum = 'available' | 'pending' | 'sold';
export const StatusEnum = {
Available: 'available' as StatusEnum,
Pending: 'pending' as StatusEnum,
Sold: 'sold' as StatusEnum
};
Available: 'available',
Pending: 'pending',
Sold: 'sold'
} as const;
export type StatusEnum = typeof StatusEnum[keyof typeof StatusEnum];
}


10 changes: 5 additions & 5 deletions ...les/client/petstore/typescript-angular-v15-provided-in-root/builds/default/model/order.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,12 +24,12 @@ export interface Order {
complete?: boolean;
}
export namespace Order {
export type StatusEnum = 'placed' | 'approved' | 'delivered';
export const StatusEnum = {
Placed: 'placed' as StatusEnum,
Approved: 'approved' as StatusEnum,
Delivered: 'delivered' as StatusEnum
};
Placed: 'placed',
Approved: 'approved',
Delivered: 'delivered'
} as const;
export type StatusEnum = typeof StatusEnum[keyof typeof StatusEnum];
}


10 changes: 5 additions & 5 deletions samples/client/petstore/typescript-angular-v15-provided-in-root/builds/default/model/pet.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -27,12 +27,12 @@ export interface Pet {
status?: Pet.StatusEnum;
}
export namespace Pet {
export type StatusEnum = 'available' | 'pending' | 'sold';
export const StatusEnum = {
Available: 'available' as StatusEnum,
Pending: 'pending' as StatusEnum,
Sold: 'sold' as StatusEnum
};
Available: 'available',
Pending: 'pending',
Sold: 'sold'
} as const;
export type StatusEnum = typeof StatusEnum[keyof typeof StatusEnum];
}


Loading
Loading