Merge pull request #1850 from kelnos/apikey-cookie-support

feat: add support for cookies auth

Author: mrlubos

.changeset/silent-camels-explain.md

@@ -0,0 +1,10 @@
+---
+"@hey-api/client-axios": patch
+"@hey-api/client-core": patch
+"@hey-api/client-fetch": patch
+"@hey-api/client-next": patch
+"@hey-api/client-nuxt": patch
+"@hey-api/openapi-ts": patch
+---
+
+feat: add support for cookies auth

packages/client-axios/src/__tests__/utils.test.ts

@@ -90,6 +90,27 @@ describe('setAuthParams', () => {
     expect(query).toEqual({});
   });
 
+  it('sets an API key in a cookie', async () => {
+    const auth = vi.fn().mockReturnValue('foo');
+    const headers: Record<any, unknown> = {};
+    const query: Record<any, unknown> = {};
+    await setAuthParams({
+      auth,
+      headers,
+      query,
+      security: [
+        {
+          in: 'cookie',
+          name: 'baz',
+          type: 'apiKey',
+        },
+      ],
+    });
+    expect(auth).toHaveBeenCalled();
+    expect(headers.Cookie).toBe('baz=foo');
+    expect(query).toEqual({});
+  });
+
   it('sets first scheme only', async () => {
     const auth = vi.fn().mockReturnValue('foo');
     const headers: Record<any, unknown> = {};

packages/client-axios/src/utils.ts

@@ -171,6 +171,15 @@ export const setAuthParams = async ({
         }
         options.query[name] = token;
         break;
+      case 'cookie': {
+        const value = `${name}=${token}`;
+        if ('Cookie' in options.headers && options.headers['Cookie']) {
+          options.headers['Cookie'] = `${options.headers['Cookie']}; ${value}`;
+        } else {
+          options.headers['Cookie'] = value;
+        }
+        break;
+      }
       case 'header':
       default:
         options.headers[name] = token;

packages/client-core/src/auth.ts

@@ -6,7 +6,7 @@ export interface Auth {
    *
    * @default 'header'
    */
-  in?: 'header' | 'query';
+  in?: 'header' | 'query' | 'cookie';
   /**
    * Header or query parameter name.
    *

packages/client-fetch/src/__tests__/utils.test.ts

@@ -186,4 +186,25 @@ describe('setAuthParams', () => {
     expect(headers.get('baz')).toBeNull();
     expect(query.baz).toBe('Bearer foo');
   });
+
+  it('sets an API key in a cookie', async () => {
+    const auth = vi.fn().mockReturnValue('foo');
+    const headers = new Headers();
+    const query: Record<any, unknown> = {};
+    await setAuthParams({
+      auth,
+      headers,
+      query,
+      security: [
+        {
+          in: 'cookie',
+          name: 'baz',
+          type: 'apiKey',
+        },
+      ],
+    });
+    expect(auth).toHaveBeenCalled();
+    expect(headers.get('Cookie')).toBe('baz=foo');
+    expect(query).toEqual({});
+  });
 });

packages/client-fetch/src/utils.ts

@@ -217,6 +217,9 @@ export const setAuthParams = async ({
         }
         options.query[name] = token;
         break;
+      case 'cookie':
+        options.headers.append('Cookie', `${name}=${token}`);
+        break;
       case 'header':
       default:
         options.headers.set(name, token);

packages/client-next/src/__tests__/utils.test.ts

@@ -186,4 +186,25 @@ describe('setAuthParams', () => {
     expect(headers.get('baz')).toBeNull();
     expect(query.baz).toBe('Bearer foo');
   });
+
+  it('sets an API key in a cookie', async () => {
+    const auth = vi.fn().mockReturnValue('foo');
+    const headers = new Headers();
+    const query: Record<any, unknown> = {};
+    await setAuthParams({
+      auth,
+      headers,
+      query,
+      security: [
+        {
+          in: 'cookie',
+          name: 'baz',
+          type: 'apiKey',
+        },
+      ],
+    });
+    expect(auth).toHaveBeenCalled();
+    expect(headers.get('Cookie')).toBe('baz=foo');
+    expect(query).toEqual({});
+  });
 });

packages/client-next/src/utils.ts

@@ -217,6 +217,9 @@ export const setAuthParams = async ({
         }
         options.query[name] = token;
         break;
+      case 'cookie':
+        options.headers.append('Cookie', `${name}=${token}`);
+        break;
       case 'header':
       default:
         options.headers.set(name, token);

packages/client-nuxt/src/utils.ts

@@ -178,6 +178,9 @@ export const setAuthParams = async ({
         }
         toValue(options.query)[name] = token;
         break;
+      case 'cookie':
+        options.headers.append('Cookie', `${name}=${token}`);
+        break;
       case 'header':
       default:
         options.headers.set(name, token);

packages/openapi-ts/src/plugins/@hey-api/sdk/plugin.ts

@@ -37,7 +37,7 @@ export interface Auth {
    *
    * @default 'header'
    */
-  in?: 'header' | 'query';
+  in?: 'header' | 'query' | 'cookie';
   /**
    * Header or query parameter name.
    *
@@ -175,8 +175,10 @@ const securitySchemeObjectToAuthObject = ({
       };
     }
 
-    // TODO: parser - support cookies auth
-    if (securitySchemeObject.in === 'query') {
+    if (
+      securitySchemeObject.in === 'query' ||
+      securitySchemeObject.in == 'cookie'
+    ) {
       return {
         in: securitySchemeObject.in,
         name: securitySchemeObject.name,