fix: do not transform property names for standalone clients

hey-api · May 24, 2024 · 735561c · 735561c
1 parent 17b982c
commit 735561c
Show file tree

Hide file tree

Showing 40 changed files with 4,162 additions and 307 deletions.
diff --git a/.changeset/fair-mugs-sneeze.md b/.changeset/fair-mugs-sneeze.md
@@ -0,0 +1,5 @@
+---
+'@hey-api/client-fetch': patch
+---
+
+fix: JSON stringify object headers
diff --git a/.changeset/twenty-ways-complain.md b/.changeset/twenty-ways-complain.md
@@ -0,0 +1,5 @@
+---
+'@hey-api/openapi-ts': patch
+---
+
+fix: do not transform property names for standalone clients
diff --git a/examples/openapi-ts-fetch/src/client/types.gen.ts b/examples/openapi-ts-fetch/src/client/types.gen.ts
@@ -177,7 +177,7 @@ export type UpdatePetWithFormData = {
 
 export type DeletePetData = {
   headers?: {
-    apiKey?: string;
+    api_key?: string;
   };
   path: {
     /**
@@ -330,11 +330,11 @@ export type $OpenApiTs = {
         /**
          * Successful operation
          */
-        200: Pet;
+        '200': Pet;
         /**
          * Invalid input
          */
-        405: unknown;
+        '405': unknown;
       };
     };
     put: {
@@ -343,19 +343,19 @@ export type $OpenApiTs = {
         /**
          * Successful operation
          */
-        200: Pet;
+        '200': Pet;
         /**
          * Invalid ID supplied
          */
-        400: unknown;
+        '400': unknown;
         /**
          * Pet not found
          */
-        404: unknown;
+        '404': unknown;
         /**
          * Validation exception
          */
-        405: unknown;
+        '405': unknown;
       };
     };
   };
@@ -366,11 +366,11 @@ export type $OpenApiTs = {
         /**
          * successful operation
          */
-        200: Array<Pet>;
+        '200': Array<Pet>;
         /**
          * Invalid status value
          */
-        400: unknown;
+        '400': unknown;
       };
     };
   };
@@ -381,11 +381,11 @@ export type $OpenApiTs = {
         /**
          * successful operation
          */
-        200: Array<Pet>;
+        '200': Array<Pet>;
         /**
          * Invalid tag value
          */
-        400: unknown;
+        '400': unknown;
       };
     };
   };
@@ -396,15 +396,15 @@ export type $OpenApiTs = {
         /**
          * successful operation
          */
-        200: Pet;
+        '200': Pet;
         /**
          * Invalid ID supplied
          */
-        400: unknown;
+        '400': unknown;
         /**
          * Pet not found
          */
-        404: unknown;
+        '404': unknown;
       };
     };
     post: {
@@ -413,7 +413,7 @@ export type $OpenApiTs = {
         /**
          * Invalid input
          */
-        405: unknown;
+        '405': unknown;
       };
     };
     delete: {
@@ -422,7 +422,7 @@ export type $OpenApiTs = {
         /**
          * Invalid pet value
          */
-        400: unknown;
+        '400': unknown;
       };
     };
   };
@@ -433,7 +433,7 @@ export type $OpenApiTs = {
         /**
          * successful operation
          */
-        200: ApiResponse;
+        '200': ApiResponse;
       };
     };
   };
@@ -443,7 +443,7 @@ export type $OpenApiTs = {
         /**
          * successful operation
          */
-        200: {
+        '200': {
           [key: string]: number;
         };
       };
@@ -456,11 +456,11 @@ export type $OpenApiTs = {
         /**
          * successful operation
          */
-        200: Order;
+        '200': Order;
         /**
          * Invalid input
          */
-        405: unknown;
+        '405': unknown;
       };
     };
   };
@@ -471,15 +471,15 @@ export type $OpenApiTs = {
         /**
          * successful operation
          */
-        200: Order;
+        '200': Order;
         /**
          * Invalid ID supplied
          */
-        400: unknown;
+        '400': unknown;
         /**
          * Order not found
          */
-        404: unknown;
+        '404': unknown;
       };
     };
     delete: {
@@ -488,11 +488,11 @@ export type $OpenApiTs = {
         /**
          * Invalid ID supplied
          */
-        400: unknown;
+        '400': unknown;
         /**
          * Order not found
          */
-        404: unknown;
+        '404': unknown;
       };
     };
   };
@@ -514,7 +514,7 @@ export type $OpenApiTs = {
         /**
          * Successful operation
          */
-        200: User;
+        '200': User;
         /**
          * successful operation
          */
@@ -529,11 +529,11 @@ export type $OpenApiTs = {
         /**
          * successful operation
          */
-        200: string;
+        '200': string;
         /**
          * Invalid username/password supplied
          */
-        400: unknown;
+        '400': unknown;
       };
     };
   };
@@ -554,15 +554,15 @@ export type $OpenApiTs = {
         /**
          * successful operation
          */
-        200: User;
+        '200': User;
         /**
          * Invalid username supplied
          */
-        400: unknown;
+        '400': unknown;
         /**
          * User not found
          */
-        404: unknown;
+        '404': unknown;
       };
     };
     put: {
@@ -580,11 +580,11 @@ export type $OpenApiTs = {
         /**
          * Invalid username supplied
          */
-        400: unknown;
+        '400': unknown;
         /**
          * User not found
          */
-        404: unknown;
+        '404': unknown;
       };
     };
   };

diff --git a/packages/client-fetch/src/types.ts b/packages/client-fetch/src/types.ts
@@ -56,6 +56,7 @@ export interface Config
         | (string | number | boolean)[]
         | null
         | undefined
+        | unknown
       >;
   /**
    * The request method.

diff --git a/packages/client-fetch/src/utils.ts b/packages/client-fetch/src/utils.ts
@@ -402,7 +402,12 @@ export const mergeHeaders = (
           mergedHeaders.append(key, v as string);
         }
       } else if (value !== undefined) {
-        mergedHeaders.set(key, value as string);
+        // assume object headers are meant to be JSON stringified, i.e. their
+        // content value in OpenAPI specification is 'application/json'
+        mergedHeaders.set(
+          key,
+          typeof value === 'object' ? JSON.stringify(value) : (value as string),
+        );
       }
     }
   }

diff --git a/packages/openapi-ts/src/openApi/common/interfaces/client.ts b/packages/openapi-ts/src/openApi/common/interfaces/client.ts
@@ -1,3 +1,5 @@
+import type { OpenApiParameter } from '../../v3/interfaces/OpenApiParameter';
+
 export interface ModelComposition
   extends Pick<Model, '$refs' | 'enums' | 'imports' | 'properties'> {
   export: Extract<Model['export'], 'all-of' | 'any-of' | 'one-of'>;
@@ -11,7 +13,7 @@ export interface Enum {
 }
 
 export interface OperationParameter extends Model {
-  in: 'path' | 'query' | 'header' | 'formData' | 'body' | 'cookie';
+  in: 'body' | 'cookie' | 'formData' | 'header' | 'path' | 'query';
   prop: string;
   mediaType: string | null;
 }
@@ -27,7 +29,7 @@ export interface OperationParameters extends Pick<Model, '$refs' | 'imports'> {
 }
 
 export interface OperationResponse extends Model {
-  in: 'response' | 'header';
+  in: 'header' | 'response';
   code: number | 'default';
 }
 
@@ -130,6 +132,11 @@ export interface Model extends Schema {
     | 'one-of'
     | 'reference';
   imports: string[];
+  in:
+    | OperationParameter['in']
+    | OpenApiParameter['in']
+    | OperationResponse['in']
+    | '';
   link: Model | null;
   meta?: ModelMeta;
   /**

diff --git a/packages/openapi-ts/src/openApi/common/parser/__tests__/operation.spec.ts b/packages/openapi-ts/src/openApi/common/parser/__tests__/operation.spec.ts
@@ -1,11 +1,7 @@
 import { describe, expect, it } from 'vitest';
 
 import { setConfig } from '../../../../utils/config';
-import {
-  getOperationName,
-  getOperationParameterName,
-  getOperationResponseCode,
-} from '../operation';
+import { getOperationName, getOperationResponseCode } from '../operation';
 
 describe('getOperationName', () => {
   const options1: Parameters<typeof setConfig>[0] = {
@@ -225,29 +221,6 @@ describe('getOperationName', () => {
   );
 });
 
-describe('getOperationParameterName', () => {
-  it.each([
-    { expected: '', input: '' },
-    { expected: 'foobar', input: 'foobar' },
-    { expected: 'fooBar', input: 'fooBar' },
-    { expected: 'fooBar', input: 'foo_bar' },
-    { expected: 'fooBar', input: 'foo-bar' },
-    { expected: 'fooBar', input: 'foo.bar' },
-    { expected: 'fooBar', input: '@foo.bar' },
-    { expected: 'fooBar', input: '$foo.bar' },
-    { expected: 'fooBar', input: '123.foo.bar' },
-    { expected: 'fooBar', input: 'Foo-Bar' },
-    { expected: 'fooBar', input: 'FOO-BAR' },
-    { expected: 'fooBar', input: 'foo[bar]' },
-    { expected: 'fooBarArray', input: 'foo.bar[]' },
-  ])(
-    'getOperationParameterName($input) -> $expected',
-    ({ input, expected }) => {
-      expect(getOperationParameterName(input)).toBe(expected);
-    },
-  );
-});
-
 describe('getOperationResponseCode', () => {
   it.each([
     { expected: null, input: '' },