Skip to content

Feat/enum names #2005

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
merged 2 commits into from
Apr 2, 2025
Merged

Feat/enum names #2005

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
9506ce1
feat(core): add support for more enumname extensions
AllieJonsson Apr 2, 2025
736a39a
Merge branch 'master' into feat/enum-names
AllieJonsson Apr 2, 2025
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
227 changes: 131 additions & 96 deletions docs/public/sitemap.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,99 +4,134 @@
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xmlns="http://www.sitemaps.org/schemas/sitemap/0.9"
xmlns:xhtml="http://www.w3.org/1999/xhtml">
<url><loc>https://orval.dev/guides/angular</loc>



<lastmod>2023-11-14</lastmod>
</url><url><loc>https://orval.dev/guides/basics</loc>



<lastmod>2023-11-14</lastmod>
</url><url><loc>https://orval.dev/guides/custom-axios</loc>



<lastmod>2023-11-14</lastmod>
</url><url><loc>https://orval.dev/guides/custom-client</loc>



<lastmod>2023-11-14</lastmod>
</url><url><loc>https://orval.dev/guides/react-query</loc>



<lastmod>2023-11-14</lastmod>
</url><url><loc>https://orval.dev/guides/set-base-url</loc>



<lastmod>2023-11-14</lastmod>
</url><url><loc>https://orval.dev/guides/svelte-query</loc>



<lastmod>2023-11-14</lastmod>
</url><url><loc>https://orval.dev/guides/swr</loc>



<lastmod>2023-11-14</lastmod>
</url><url><loc>https://orval.dev/guides/vue-query</loc>



<lastmod>2023-11-14</lastmod>
</url><url><loc>https://orval.dev/installation</loc>



<lastmod>2023-11-14</lastmod>
</url><url><loc>https://orval.dev/overview</loc>



<lastmod>2023-11-14</lastmod>
</url><url><loc>https://orval.dev/quick-start</loc>



<lastmod>2023-11-14</lastmod>
</url><url><loc>https://orval.dev/reference/cli</loc>



<lastmod>2023-11-14</lastmod>
</url><url><loc>https://orval.dev/reference/configuration/full-example</loc>



<lastmod>2023-11-14</lastmod>
</url><url><loc>https://orval.dev/reference/configuration/hooks</loc>



<lastmod>2023-11-14</lastmod>
</url><url><loc>https://orval.dev/reference/configuration/input</loc>



<lastmod>2023-11-14</lastmod>
</url><url><loc>https://orval.dev/reference/configuration/output</loc>



<lastmod>2023-11-14</lastmod>
</url><url><loc>https://orval.dev/reference/configuration/overview</loc>



<lastmod>2023-11-14</lastmod>
</url><url><loc>https://orval.dev/reference/integration</loc>



<lastmod>2023-11-14</lastmod>
</url></urlset>

<url>
<loc>https://orval.dev/guides/angular</loc>
<lastmod>2025-04-02</lastmod>
</url>

<url>
<loc>https://orval.dev/guides/basics</loc>
<lastmod>2025-04-02</lastmod>
</url>

<url>
<loc>https://orval.dev/guides/client-with-zod</loc>
<lastmod>2025-04-02</lastmod>
</url>

<url>
<loc>https://orval.dev/guides/custom-axios</loc>
<lastmod>2025-04-02</lastmod>
</url>

<url>
<loc>https://orval.dev/guides/custom-client</loc>
<lastmod>2025-04-02</lastmod>
</url>

<url>
<loc>https://orval.dev/guides/enums</loc>
<lastmod>2025-04-02</lastmod>
</url>

<url>
<loc>https://orval.dev/guides/fetch-client</loc>
<lastmod>2025-04-02</lastmod>
</url>

<url>
<loc>https://orval.dev/guides/fetch</loc>
<lastmod>2025-04-02</lastmod>
</url>

<url>
<loc>https://orval.dev/guides/hono</loc>
<lastmod>2025-04-02</lastmod>
</url>

<url>
<loc>https://orval.dev/guides/msw</loc>
<lastmod>2025-04-02</lastmod>
</url>

<url>
<loc>https://orval.dev/guides/react-query</loc>
<lastmod>2025-04-02</lastmod>
</url>

<url>
<loc>https://orval.dev/guides/set-base-url</loc>
<lastmod>2025-04-02</lastmod>
</url>

<url>
<loc>https://orval.dev/guides/svelte-query</loc>
<lastmod>2025-04-02</lastmod>
</url>

<url>
<loc>https://orval.dev/guides/swr</loc>
<lastmod>2025-04-02</lastmod>
</url>

<url>
<loc>https://orval.dev/guides/vue-query</loc>
<lastmod>2025-04-02</lastmod>
</url>

<url>
<loc>https://orval.dev/guides/zod</loc>
<lastmod>2025-04-02</lastmod>
</url>

<url>
<loc>https://orval.dev/installation</loc>
<lastmod>2025-04-02</lastmod>
</url>

<url>
<loc>https://orval.dev/overview</loc>
<lastmod>2025-04-02</lastmod>
</url>

<url>
<loc>https://orval.dev/quick-start</loc>
<lastmod>2025-04-02</lastmod>
</url>

<url>
<loc>https://orval.dev/reference/cli</loc>
<lastmod>2025-04-02</lastmod>
</url>

<url>
<loc>https://orval.dev/reference/configuration/full-example</loc>
<lastmod>2025-04-02</lastmod>
</url>

<url>
<loc>https://orval.dev/reference/configuration/hooks</loc>
<lastmod>2025-04-02</lastmod>
</url>

<url>
<loc>https://orval.dev/reference/configuration/input</loc>
<lastmod>2025-04-02</lastmod>
</url>

<url>
<loc>https://orval.dev/reference/configuration/output</loc>
<lastmod>2025-04-02</lastmod>
</url>

<url>
<loc>https://orval.dev/reference/configuration/overview</loc>
<lastmod>2025-04-02</lastmod>
</url>

<url>
<loc>https://orval.dev/reference/integration</loc>
<lastmod>2025-04-02</lastmod>
</url>
</urlset>
5 changes: 5 additions & 0 deletions docs/src/manifests/manifest.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -99,6 +99,11 @@
"title": "Hono",
"path": "/guides/hono",
"editUrl": "/guides/hono.md"
},
{
"title": "Enum names",
"path": "/guides/enums",
"editUrl": "/guides/enums.md"
}
]
},
Expand Down
53 changes: 53 additions & 0 deletions docs/src/pages/guides/enums.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,53 @@
---
id: enums
title: Enum Names
---

You can extend your OpenAPI schema to include enum names for your enum values. This will let Orval generate your enums with the correct names.

#### Example of OpenAPI schema

```yaml
openapi: '3.1.0'
info:
version: 1.0.0
title: Swagger Petstore
license:
name: MIT
components:
schemas:
MyObject:
type: object
properties:
myEnum:
type: number
enum:
- 1
- 2
- 3
- 4
x-enumNames:
- One
- Two
- Three
- Four
```

The enum generated by Orval will be

```ts
export const MyEnum {
One: 1,
Two: 2,
Three: 3,
Four: 4
} as const;
```

#### Valid enum name extensions

Orval recognizes the following extensions:

- x-enumNames
- x-enumnames
- x-enum-varnames
4 changes: 2 additions & 2 deletions packages/core/src/generators/schema-definition.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
import isEmpty from 'lodash.isempty';
import type { SchemaObject, SchemasObject } from 'openapi3-ts/oas30';
import { getEnum, resolveDiscriminators } from '../getters';
import { getEnum, getEnumNames, resolveDiscriminators } from '../getters';
import { resolveRef, resolveValue } from '../resolvers';
import type {
ContextSpecs,
Expand Down Expand Up @@ -84,7 +84,7 @@ export const generateSchemasDefinition = (
output += getEnum(
resolvedValue.value,
schemaName,
resolvedValue.originalSchema?.['x-enumNames'],
getEnumNames(resolvedValue.originalSchema),
context.output.override.useNativeEnums,
);
} else if (schemaName === resolvedValue.value && resolvedValue.isRef) {
Expand Down
4 changes: 2 additions & 2 deletions packages/core/src/getters/combine.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ import {
SchemaType,
} from '../types';
import { getNumberWord, pascal, isSchema } from '../utils';
import { getEnumImplementation } from './enum';
import { getEnumImplementation, getEnumNames } from './enum';
import { getScalar } from './scalar';
import uniq from 'lodash.uniq';

Expand Down Expand Up @@ -282,7 +282,7 @@ const getCombineEnumValue = ({
return `...${e},`;
}

const names = originalSchema[i]?.['x-enumNames'] as string[];
const names = getEnumNames(originalSchema[i]);

return getEnumImplementation(e, names);
})
Expand Down
9 changes: 9 additions & 0 deletions packages/core/src/getters/enum.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,15 @@
import { keyword } from 'esutils';
import { SchemaObject } from 'openapi3-ts/dist/model/openapi30';
import { isNumeric, sanitize } from '../utils';

export const getEnumNames = (schemaObject: SchemaObject | undefined) => {
return (
schemaObject?.['x-enumNames'] ||
schemaObject?.['x-enumnames'] ||
schemaObject?.['x-enum-varnames']
);
};

export const getEnum = (
value: string,
enumName: string,
Expand Down
4 changes: 2 additions & 2 deletions packages/core/src/getters/query-params.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ import {
GetterQueryParam,
} from '../types';
import { jsDoc, pascal, sanitize } from '../utils';
import { getEnum } from './enum';
import { getEnum, getEnumNames } from './enum';
import { getKey } from './keys';

type QueryParamsType = {
Expand Down Expand Up @@ -71,7 +71,7 @@ const getQueryParamsTypes = (
const enumValue = getEnum(
resolvedValue.value,
enumName,
resolvedValue.originalSchema?.['x-enumNames'],
getEnumNames(resolvedValue.originalSchema),
context.output.override.useNativeEnums,
);

Expand Down
4 changes: 2 additions & 2 deletions packages/core/src/resolvers/object.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
import { ReferenceObject, SchemaObject } from 'openapi3-ts/oas30';
import { getEnum } from '../getters/enum';
import { getEnum, getEnumNames } from '../getters/enum';
import { ContextSpecs, ResolverValue } from '../types';
import { jsDoc } from '../utils';
import { resolveValue } from './value';
Expand Down Expand Up @@ -64,7 +64,7 @@ const resolveObjectOriginal = ({
const enumValue = getEnum(
resolvedValue.value,
propName,
resolvedValue.originalSchema?.['x-enumNames'],
getEnumNames(resolvedValue.originalSchema),
context.output.override.useNativeEnums,
);

Expand Down