Merge pull request #2009 from hey-api/fix/types-identifier-case-preserve

mrlubos · web-flow · commit 204d4bdcaa32 · 2025-05-04T08:11:07.000+01:00
fix: avoid including underscore for appended types (e.g. data, error, response) when preserving identifier case
diff --git a/.changeset/eighty-rivers-enjoy.md b/.changeset/eighty-rivers-enjoy.md
@@ -2,4 +2,4 @@
 "@hey-api/openapi-ts": patch
 ---
 
-fix: make descriminator field required when used with `oneOf` keyword
+fix: make discriminator field required when used with `oneOf` keyword
diff --git a/.changeset/nervous-months-brake.md b/.changeset/nervous-months-brake.md
@@ -0,0 +1,5 @@
+---
+'@hey-api/openapi-ts': patch
+---
+
+fix: avoid including underscore for appended types (e.g. data, error, response) when preserving identifier case
diff --git a/packages/openapi-ts-tests/test/3.0.x.test.ts b/packages/openapi-ts-tests/test/3.0.x.test.ts
@@ -89,10 +89,10 @@ describe(`OpenAPI ${version}`, () => {
     {
       config: createConfig({
         input: 'case.json',
-        output: 'case',
+        output: 'case-preserve',
         plugins: [
           {
-            identifierCase: undefined,
+            identifierCase: 'preserve',
             name: '@hey-api/typescript',
           },
         ],
diff --git a/packages/openapi-ts-tests/test/3.1.x.test.ts b/packages/openapi-ts-tests/test/3.1.x.test.ts
@@ -89,10 +89,10 @@ describe(`OpenAPI ${version}`, () => {
     {
       config: createConfig({
         input: 'case.json',
-        output: 'case',
+        output: 'case-preserve',
         plugins: [
           {
-            identifierCase: undefined,
+            identifierCase: 'preserve',
             name: '@hey-api/typescript',
           },
         ],
diff --git a/packages/openapi-ts-tests/test/__snapshots__/3.0.x/case-preserve/index.ts b/packages/openapi-ts-tests/test/__snapshots__/3.0.x/case-preserve/index.ts
diff --git a/packages/openapi-ts-tests/test/__snapshots__/3.0.x/case-preserve/types.gen.ts b/packages/openapi-ts-tests/test/__snapshots__/3.0.x/case-preserve/types.gen.ts
@@ -51,7 +51,7 @@ export type fooBar = number;
  */
 export type FooBar = string;
 
-export type GetFoo_Data = {
+export type GetFooData = {
     body: Foo;
     path?: never;
     query: {
@@ -71,7 +71,7 @@ export type GetFoo_Data = {
     url: '/foo';
 };
 
-export type GetFoo_Responses = {
+export type GetFooResponses = {
     /**
      * OK
      */
@@ -82,7 +82,7 @@ export type GetFoo_Responses = {
     201: _201;
 };
 
-export type GetFoo_Response = GetFoo_Responses[keyof GetFoo_Responses];
+export type GetFooResponse = GetFooResponses[keyof GetFooResponses];
 
 export type ClientOptions = {
     baseUrl: `${string}://${string}` | (string & {});
diff --git a/packages/openapi-ts-tests/test/__snapshots__/3.1.x/case-preserve/index.ts b/packages/openapi-ts-tests/test/__snapshots__/3.1.x/case-preserve/index.ts
diff --git a/packages/openapi-ts-tests/test/__snapshots__/3.1.x/case-preserve/types.gen.ts b/packages/openapi-ts-tests/test/__snapshots__/3.1.x/case-preserve/types.gen.ts
@@ -51,7 +51,7 @@ export type fooBar = number;
  */
 export type FooBar = string;
 
-export type GetFoo_Data = {
+export type GetFooData = {
     body: Foo;
     path?: never;
     query: {
@@ -71,7 +71,7 @@ export type GetFoo_Data = {
     url: '/foo';
 };
 
-export type GetFoo_Responses = {
+export type GetFooResponses = {
     /**
      * OK
      */
@@ -82,7 +82,7 @@ export type GetFoo_Responses = {
     201: _201;
 };
 
-export type GetFoo_Response = GetFoo_Responses[keyof GetFoo_Responses];
+export type GetFooResponse = GetFooResponses[keyof GetFooResponses];
 
 export type ClientOptions = {
     baseUrl: `${string}://${string}` | (string & {});
diff --git a/packages/openapi-ts-tests/test/openapi-ts.config.ts b/packages/openapi-ts-tests/test/openapi-ts.config.ts
@@ -103,7 +103,7 @@ export default defineConfig(() => {
         // enums: 'javascript',
         // enumsCase: 'camelCase',
         // exportInlineEnums: true,
-        // identifierCase: 'preserve',
+        identifierCase: 'preserve',
         name: '@hey-api/typescript',
         // readOnlyWriteOnlyBehavior: 'off',
         // readableNameBuilder: 'Readable{{name}}',
diff --git a/packages/openapi-ts/src/plugins/@hey-api/sdk/plugin.ts b/packages/openapi-ts/src/plugins/@hey-api/sdk/plugin.ts
@@ -398,6 +398,7 @@ const operationStatements = ({
     const identifierSchema = context.file({ id: zodId })!.identifier({
       $ref: operationIrRef({
         case: 'camelCase',
+        config: context.config,
         id: operation.id,
         type: 'response',
       }),
diff --git a/packages/openapi-ts/src/plugins/@hey-api/transformers/plugin.ts b/packages/openapi-ts/src/plugins/@hey-api/transformers/plugin.ts
@@ -469,7 +469,11 @@ export const handler: Plugin.Handler<Config> = ({ context, plugin }) => {
     }
 
     const identifierResponse = context.file({ id: typesId })!.identifier({
-      $ref: operationIrRef({ id: operation.id, type: 'response' }),
+      $ref: operationIrRef({
+        config: context.config,
+        id: operation.id,
+        type: 'response',
+      }),
       namespace: 'type',
     });
     if (!identifierResponse.name) {
diff --git a/packages/openapi-ts/src/plugins/@hey-api/typescript/plugin.ts b/packages/openapi-ts/src/plugins/@hey-api/typescript/plugin.ts
@@ -904,7 +904,11 @@ const operationToDataType = ({
   data.required = dataRequired;
 
   const identifier = file.identifier({
-    $ref: operationIrRef({ id: operation.id, type: 'data' }),
+    $ref: operationIrRef({
+      config: context.config,
+      id: operation.id,
+      type: 'data',
+    }),
     create: true,
     namespace: 'type',
   });
@@ -952,7 +956,11 @@ const operationToType = ({
 
   if (errors) {
     const identifierErrors = file.identifier({
-      $ref: operationIrRef({ id: operation.id, type: 'errors' }),
+      $ref: operationIrRef({
+        config: context.config,
+        id: operation.id,
+        type: 'errors',
+      }),
       create: true,
       namespace: 'type',
     });
@@ -980,7 +988,11 @@ const operationToType = ({
 
       if (error) {
         const identifierError = file.identifier({
-          $ref: operationIrRef({ id: operation.id, type: 'error' }),
+          $ref: operationIrRef({
+            config: context.config,
+            id: operation.id,
+            type: 'error',
+          }),
           create: true,
           namespace: 'type',
         });
@@ -1008,7 +1020,11 @@ const operationToType = ({
 
   if (responses) {
     const identifierResponses = file.identifier({
-      $ref: operationIrRef({ id: operation.id, type: 'responses' }),
+      $ref: operationIrRef({
+        config: context.config,
+        id: operation.id,
+        type: 'responses',
+      }),
       create: true,
       namespace: 'type',
     });
@@ -1036,7 +1052,11 @@ const operationToType = ({
 
       if (response) {
         const identifierResponse = file.identifier({
-          $ref: operationIrRef({ id: operation.id, type: 'response' }),
+          $ref: operationIrRef({
+            config: context.config,
+            id: operation.id,
+            type: 'response',
+          }),
           create: true,
           namespace: 'type',
         });
diff --git a/packages/openapi-ts/src/plugins/@hey-api/typescript/ref.ts b/packages/openapi-ts/src/plugins/@hey-api/typescript/ref.ts
@@ -27,7 +27,11 @@ export const importIdentifierData = ({
   operation: IR.OperationObject;
 }): Identifier => {
   const identifierData = context.file({ id: typesId })!.identifier({
-    $ref: operationIrRef({ id: operation.id, type: 'data' }),
+    $ref: operationIrRef({
+      config: context.config,
+      id: operation.id,
+      type: 'data',
+    }),
     namespace: 'type',
   });
   return refIdentifier(identifierData, (identifier) => {
@@ -51,7 +55,11 @@ export const importIdentifierError = ({
   operation: IR.OperationObject;
 }): Identifier => {
   const identifierError = context.file({ id: typesId })!.identifier({
-    $ref: operationIrRef({ id: operation.id, type: 'error' }),
+    $ref: operationIrRef({
+      config: context.config,
+      id: operation.id,
+      type: 'error',
+    }),
     namespace: 'type',
   });
   return refIdentifier(identifierError, (identifier) => {
@@ -75,7 +83,11 @@ export const importIdentifierResponse = ({
   operation: IR.OperationObject;
 }): Identifier => {
   const identifierResponse = context.file({ id: typesId })!.identifier({
-    $ref: operationIrRef({ id: operation.id, type: 'response' }),
+    $ref: operationIrRef({
+      config: context.config,
+      id: operation.id,
+      type: 'response',
+    }),
     namespace: 'type',
   });
   return refIdentifier(identifierResponse, (identifier) => {
diff --git a/packages/openapi-ts/src/plugins/fastify/plugin.ts b/packages/openapi-ts/src/plugins/fastify/plugin.ts
@@ -24,7 +24,11 @@ const operationToRouteHandler = ({
   const properties: Array<Property> = [];
 
   const identifierData = fileTypes.identifier({
-    $ref: operationIrRef({ id: operation.id, type: 'data' }),
+    $ref: operationIrRef({
+      config: context.config,
+      id: operation.id,
+      type: 'data',
+    }),
     namespace: 'type',
   });
   if (identifierData.name) {
@@ -93,7 +97,11 @@ const operationToRouteHandler = ({
 
   let errorsTypeReference: ts.TypeReferenceNode | undefined = undefined;
   const identifierErrors = fileTypes.identifier({
-    $ref: operationIrRef({ id: operation.id, type: 'errors' }),
+    $ref: operationIrRef({
+      config: context.config,
+      id: operation.id,
+      type: 'errors',
+    }),
     namespace: 'type',
   });
   if (identifierErrors.name && errors && errors.properties) {
@@ -131,7 +139,11 @@ const operationToRouteHandler = ({
 
   let responsesTypeReference: ts.TypeReferenceNode | undefined = undefined;
   const identifierResponses = fileTypes.identifier({
-    $ref: operationIrRef({ id: operation.id, type: 'responses' }),
+    $ref: operationIrRef({
+      config: context.config,
+      id: operation.id,
+      type: 'responses',
+    }),
     namespace: 'type',
   });
   if (identifierResponses.name && responses && responses.properties) {
diff --git a/packages/openapi-ts/src/plugins/shared/utils/ref.ts b/packages/openapi-ts/src/plugins/shared/utils/ref.ts
@@ -1,4 +1,4 @@
-import type { StringCase } from '../../../types/config';
+import type { Config, StringCase } from '../../../types/config';
 import { irRef } from '../../../utils/ref';
 import { stringCase } from '../../../utils/stringCase';
 
@@ -11,36 +11,30 @@ interface OperationIRRef {
 
 export const operationIrRef = ({
   case: _case = 'PascalCase',
+  config,
   id,
   type,
 }: OperationIRRef & {
   readonly case?: StringCase;
+  config: Pick<Config, 'plugins'>;
   type: 'data' | 'error' | 'errors' | 'response' | 'responses';
 }): string => {
   let affix = '';
   switch (type) {
     case 'data':
-      affix = 'Data';
-      break;
-    case 'error':
-      // error union
-      affix = 'Error';
-      break;
-    case 'errors':
-      // errors map
-      affix = 'Errors';
-      break;
-    case 'response':
-      // response union
-      affix = 'Response';
-      break;
-    case 'responses':
-      // responses map
-      affix = 'Responses';
+    case 'error': // error union
+    case 'errors': // errors map
+    case 'response': // response union
+    case 'responses': // responses map
+      affix = `${(type[0] ?? '').toLocaleUpperCase()}${type.slice(1)}`;
       break;
   }
+  let separator = true;
+  if (config.plugins['@hey-api/typescript']?.identifierCase === 'preserve') {
+    separator = false;
+  }
   return `${irRef}${stringCase({
     case: _case,
     value: id,
-  })}-${affix}`;
+  })}${separator ? '-' : ''}${affix}`;
 };
diff --git a/packages/openapi-ts/src/plugins/zod/plugin.ts b/packages/openapi-ts/src/plugins/zod/plugin.ts
@@ -809,6 +809,7 @@ const operationToZodSchema = ({
       schemaToZodSchema({
         $ref: operationIrRef({
           case: 'camelCase',
+          config: context.config,
           id: operation.id,
           type: 'response',
         }),

-Original file line number
+Diff line change
@@ @@ -0,0 +1,5 @@ @@
 +---
 +'@hey-api/openapi-ts': patch
 +---
++
 +fix: avoid including underscore for appended types (e.g. data, error, response) when preserving identifier case
Original file line number	Diff line number	Diff line change
@@ -89,10 +89,10 @@ describe(`OpenAPI ${version}`, () => {
`89`	`89`	`{`
`90`	`90`	`config: createConfig({`
`91`	`91`	`input: 'case.json',`
`92`		`- output: 'case',`
	`92`	`+ output: 'case-preserve',`
`93`	`93`	`plugins: [`
`94`	`94`	`{`
`95`		`- identifierCase: undefined,`
	`95`	`+ identifierCase: 'preserve',`
`96`	`96`	`name: '@hey-api/typescript',`
`97`	`97`	`},`
`98`	`98`	`],`