Skip to content

Commit 61acecc

Browse files
mrlubosmrlubos
authored
Merge pull request #3376 from spikesagal/main
fix: number enum properties to avoid collision
2 parents a2ad2aa + 54138b6 commit 61acecc

25 files changed

Lines changed: 427 additions & 18 deletions

File tree

‎.changeset/lovely-moons-taste.md‎

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
---
2+
"@hey-api/openapi-ts": patch
3+
---
4+
5+
**plugin(@hey-api/typescript)**: fix: deduplicate enum keys to avoid name collision

‎packages/openapi-ts-tests/main/test/3.0.x.test.ts‎

Lines changed: 55 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -21,6 +21,13 @@ describe(`OpenAPI ${version}`, () => {
2121
version,
2222
typeof input === 'string' ? input : ((input?.path as string) ?? ''),
2323
);
24+
const output = userConfig.output instanceof Array ? userConfig.output[0] : userConfig.output;
25+
const outputPath = path.join(
26+
outputDir,
27+
typeof output === 'string' ? output : ((output?.path as string) ?? ''),
28+
);
29+
const nameConflictResolver =
30+
typeof output === 'string' ? undefined : output?.nameConflictResolver;
2431
return {
2532
plugins: ['@hey-api/typescript'],
2633
...userConfig,
@@ -34,7 +41,10 @@ describe(`OpenAPI ${version}`, () => {
3441
logs: {
3542
level: 'silent',
3643
},
37-
output: path.join(outputDir, typeof userConfig.output === 'string' ? userConfig.output : ''),
44+
output: {
45+
nameConflictResolver,
46+
path: outputPath,
47+
},
3848
} as const satisfies UserConfig;
3949
};
4050

@@ -263,6 +273,49 @@ describe(`OpenAPI ${version}`, () => {
263273
}),
264274
description: 'exports inline enums (TypeScript)',
265275
},
276+
{
277+
config: createConfig({
278+
input: 'enum-inline.json',
279+
output: {
280+
nameConflictResolver: ({ attempt, baseName }) =>
281+
attempt === 0 ? baseName : `${baseName}_N${attempt + 1}`,
282+
path: 'enum-inline-name-resolver',
283+
},
284+
parser: {
285+
transforms: {
286+
enums: 'root',
287+
},
288+
},
289+
plugins: [
290+
{
291+
enums: 'javascript',
292+
name: '@hey-api/typescript',
293+
},
294+
],
295+
}),
296+
description: 'exports inline enums with name conflict resolver',
297+
},
298+
{
299+
config: createConfig({
300+
input: 'enum-inline.json',
301+
output: {
302+
nameConflictResolver: () => null,
303+
path: 'enum-inline-name-resolver-null',
304+
},
305+
parser: {
306+
transforms: {
307+
enums: 'root',
308+
},
309+
},
310+
plugins: [
311+
{
312+
enums: 'javascript',
313+
name: '@hey-api/typescript',
314+
},
315+
],
316+
}),
317+
description: 'exports inline enums with name conflict resolver returning null',
318+
},
266319
{
267320
config: createConfig({
268321
input: 'enum-names-values.json',
@@ -673,7 +726,7 @@ describe(`OpenAPI ${version}`, () => {
673726
it.each(scenarios)('$description', async ({ config }) => {
674727
await createClient(config);
675728

676-
const filePaths = getFilePaths(config.output);
729+
const filePaths = getFilePaths(config.output.path);
677730

678731
await Promise.all(
679732
filePaths.map(async (filePath) => {

‎packages/openapi-ts-tests/main/test/3.1.x.test.ts‎

Lines changed: 54 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -22,6 +22,12 @@ describe(`OpenAPI ${version}`, () => {
2222
typeof input === 'string' ? input : ((input?.path as string) ?? ''),
2323
);
2424
const output = userConfig.output instanceof Array ? userConfig.output[0] : userConfig.output;
25+
const outputPath = path.join(
26+
outputDir,
27+
typeof output === 'string' ? output : ((output?.path as string) ?? ''),
28+
);
29+
const nameConflictResolver =
30+
typeof output === 'string' ? undefined : output?.nameConflictResolver;
2531
return {
2632
plugins: ['@hey-api/typescript'],
2733
...userConfig,
@@ -35,7 +41,10 @@ describe(`OpenAPI ${version}`, () => {
3541
logs: {
3642
level: 'silent',
3743
},
38-
output: path.join(outputDir, typeof output === 'string' ? output : (output?.path ?? '')),
44+
output: {
45+
nameConflictResolver,
46+
path: outputPath,
47+
},
3948
} as const satisfies UserConfig;
4049
};
4150

@@ -297,6 +306,49 @@ describe(`OpenAPI ${version}`, () => {
297306
}),
298307
description: 'exports inline enums (TypeScript)',
299308
},
309+
{
310+
config: createConfig({
311+
input: 'enum-inline.yaml',
312+
output: {
313+
nameConflictResolver: ({ attempt, baseName }) =>
314+
attempt === 0 ? baseName : `${baseName}_N${attempt + 1}`,
315+
path: 'enum-inline-name-resolver',
316+
},
317+
parser: {
318+
transforms: {
319+
enums: 'root',
320+
},
321+
},
322+
plugins: [
323+
{
324+
enums: 'javascript',
325+
name: '@hey-api/typescript',
326+
},
327+
],
328+
}),
329+
description: 'exports inline enums with name conflict resolver',
330+
},
331+
{
332+
config: createConfig({
333+
input: 'enum-inline.yaml',
334+
output: {
335+
nameConflictResolver: () => null,
336+
path: 'enum-inline-name-resolver-null',
337+
},
338+
parser: {
339+
transforms: {
340+
enums: 'root',
341+
},
342+
},
343+
plugins: [
344+
{
345+
enums: 'javascript',
346+
name: '@hey-api/typescript',
347+
},
348+
],
349+
}),
350+
description: 'exports inline enums with name conflict resolver returning null',
351+
},
300352
{
301353
config: createConfig({
302354
input: 'enum-names-values.yaml',
@@ -991,7 +1043,7 @@ describe(`OpenAPI ${version}`, () => {
9911043
it.each(scenarios)('$description', async ({ config }) => {
9921044
await createClient(config);
9931045

994-
const filePaths = getFilePaths(config.output);
1046+
const filePaths = getFilePaths(config.output.path);
9951047

9961048
await Promise.all(
9971049
filePaths.map(async (filePath) => {

‎packages/openapi-ts-tests/main/test/__snapshots__/3.0.x/enum-inline-javascript/types.gen.ts‎

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,12 @@ export type Foo = {
88
type?: TypeEnum;
99
};
1010

11-
export const TypeEnum = { FOO: 'foo', BAR: 'bar' } as const;
11+
export const TypeEnum = {
12+
FOO: 'foo',
13+
BAR: 'bar',
14+
FOO_BAR: 'FooBar',
15+
FOO_BAR2: 'fooBar',
16+
FOO_BAR3: 'foo bar'
17+
} as const;
1218

1319
export type TypeEnum = typeof TypeEnum[keyof typeof TypeEnum];

‎packages/openapi-ts-tests/main/test/__snapshots__/3.0.x/enum-inline-name-resolver-null/index.ts‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
// This file is auto-generated by @hey-api/openapi-ts
2+
3+
export { type ClientOptions, type Foo, TypeEnum } from './types.gen';

‎packages/openapi-ts-tests/main/test/__snapshots__/3.0.x/enum-inline-name-resolver-null/types.gen.ts‎

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
// This file is auto-generated by @hey-api/openapi-ts
2+
3+
export type ClientOptions = {
4+
baseUrl: `${string}://${string}` | (string & {});
5+
};
6+
7+
export type Foo = {
8+
type?: TypeEnum;
9+
};
10+
11+
export const TypeEnum = {
12+
FOO: 'foo',
13+
BAR: 'bar',
14+
FOO_BAR: 'FooBar',
15+
FOO_BAR2: 'fooBar',
16+
FOO_BAR3: 'foo bar'
17+
} as const;
18+
19+
export type TypeEnum = typeof TypeEnum[keyof typeof TypeEnum];

‎packages/openapi-ts-tests/main/test/__snapshots__/3.0.x/enum-inline-name-resolver/index.ts‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
// This file is auto-generated by @hey-api/openapi-ts
2+
3+
export { type ClientOptions, type Foo, TypeEnum } from './types.gen';

‎packages/openapi-ts-tests/main/test/__snapshots__/3.0.x/enum-inline-name-resolver/types.gen.ts‎

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
// This file is auto-generated by @hey-api/openapi-ts
2+
3+
export type ClientOptions = {
4+
baseUrl: `${string}://${string}` | (string & {});
5+
};
6+
7+
export type Foo = {
8+
type?: TypeEnum;
9+
};
10+
11+
export const TypeEnum = {
12+
FOO: 'foo',
13+
BAR: 'bar',
14+
FOO_BAR: 'FooBar',
15+
FOO_BAR_N2: 'fooBar',
16+
FOO_BAR_N3: 'foo bar'
17+
} as const;
18+
19+
export type TypeEnum = typeof TypeEnum[keyof typeof TypeEnum];

‎packages/openapi-ts-tests/main/test/__snapshots__/3.0.x/enum-inline-typescript/types.gen.ts‎

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,5 +10,8 @@ export type Foo = {
1010

1111
export enum TypeEnum {
1212
FOO = 'foo',
13-
BAR = 'bar'
13+
BAR = 'bar',
14+
FOO_BAR = 'FooBar',
15+
FOO_BAR2 = 'fooBar',
16+
FOO_BAR3 = 'foo bar'
1417
}

‎packages/openapi-ts-tests/main/test/__snapshots__/3.0.x/enum-inline/types.gen.ts‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,4 +8,4 @@ export type Foo = {
88
type?: TypeEnum;
99
};
1010

11-
export type TypeEnum = 'foo' | 'bar';
11+
export type TypeEnum = 'foo' | 'bar' | 'FooBar' | 'fooBar' | 'foo bar';

0 commit comments

Comments
 (0)