Merge pull request #1648 from hey-api/feat/auth-open-id-connect

fix: add support for openIdConnect auth flow

.changeset/orange-bags-hope.md

@@ -1,7 +1,6 @@
 ---
 '@hey-api/client-axios': patch
 '@hey-api/client-fetch': patch
-'@hey-api/client-next': patch
 '@hey-api/client-nuxt': patch
 ---
 

.changeset/tiny-kings-reflect.md

@@ -1,7 +1,6 @@
 ---
 '@hey-api/client-axios': patch
 '@hey-api/client-fetch': patch
-'@hey-api/client-next': patch
 '@hey-api/client-nuxt': patch
 ---
 

.changeset/unlucky-ligers-help.md

@@ -0,0 +1,5 @@
+---
+'@hey-api/openapi-ts': patch
+---
+
+fix: add support for openIdConnect auth flow

packages/client-core/src/auth.ts

@@ -1,7 +1,17 @@
 export type AuthToken = string | undefined;
 
 export interface Auth {
+  /**
+   * Which part of the request do we use to send the auth?
+   *
+   * @default 'header'
+   */
   in?: 'header' | 'query';
+  /**
+   * Header or query parameter name.
+   *
+   * @default 'Authorization'
+   */
   name?: string;
   scheme?: 'basic' | 'bearer';
   type: 'apiKey' | 'http';

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

@@ -28,9 +28,19 @@ import {
 import { serviceFunctionIdentifier } from './plugin-legacy';
 import type { Config } from './types';
 
-// type copied from client packages
-interface Auth {
+// copy-pasted from @hey-api/client-core
+export interface Auth {
+  /**
+   * Which part of the request do we use to send the auth?
+   *
+   * @default 'header'
+   */
   in?: 'header' | 'query';
+  /**
+   * Header or query parameter name.
+   *
+   * @default 'Authorization'
+   */
   name?: string;
   scheme?: 'basic' | 'bearer';
   type: 'apiKey' | 'http';
@@ -129,6 +139,13 @@ const securitySchemeObjectToAuthObject = ({
 }: {
   securitySchemeObject: IR.SecurityObject;
 }): Auth | undefined => {
+  if (securitySchemeObject.type === 'openIdConnect') {
+    return {
+      scheme: 'bearer',
+      type: 'http',
+    };
+  }
+
   if (securitySchemeObject.type === 'oauth2') {
     if (
       securitySchemeObject.flows.password ||

packages/openapi-ts/test/2.0.x.test.ts

@@ -247,7 +247,7 @@ describe(`OpenAPI ${version}`, () => {
     },
     {
       config: createConfig({
-        input: 'security-oauth2.json',
+        input: 'security-oauth2.yaml',
         output: 'security-oauth2',
         plugins: [
           '@hey-api/client-fetch',
@@ -261,7 +261,7 @@ describe(`OpenAPI ${version}`, () => {
     },
     {
       config: createConfig({
-        input: 'security-oauth2.json',
+        input: 'security-oauth2.yaml',
         output: 'security-false',
         plugins: [
           '@hey-api/client-fetch',

packages/openapi-ts/test/3.0.x.test.ts

@@ -448,7 +448,7 @@ describe(`OpenAPI ${version}`, () => {
     },
     {
       config: createConfig({
-        input: 'security-oauth2.json',
+        input: 'security-oauth2.yaml',
         output: 'security-oauth2',
         plugins: [
           '@hey-api/client-fetch',
@@ -462,7 +462,21 @@ describe(`OpenAPI ${version}`, () => {
     },
     {
       config: createConfig({
-        input: 'security-oauth2.json',
+        input: 'security-open-id-connect.yaml',
+        output: 'security-open-id-connect',
+        plugins: [
+          '@hey-api/client-fetch',
+          {
+            auth: true,
+            name: '@hey-api/sdk',
+          },
+        ],
+      }),
+      description: 'generates SDK functions with auth (OpenID Connect)',
+    },
+    {
+      config: createConfig({
+        input: 'security-oauth2.yaml',
         output: 'security-false',
         plugins: [
           '@hey-api/client-fetch',

packages/openapi-ts/test/3.1.x.test.ts

@@ -537,6 +537,20 @@ describe(`OpenAPI ${version}`, () => {
       }),
       description: 'generates SDK functions with auth (oauth2)',
     },
+    {
+      config: createConfig({
+        input: 'security-open-id-connect.yaml',
+        output: 'security-open-id-connect',
+        plugins: [
+          '@hey-api/client-fetch',
+          {
+            auth: true,
+            name: '@hey-api/sdk',
+          },
+        ],
+      }),
+      description: 'generates SDK functions with auth (OpenID Connect)',
+    },
     {
       config: createConfig({
         input: 'security-oauth2.yaml',

packages/openapi-ts/test/__snapshots__/3.0.x/security-open-id-connect/client.gen.ts

@@ -0,0 +1,5 @@
+// This file is auto-generated by @hey-api/openapi-ts
+
+import { createClient, createConfig } from '@hey-api/client-fetch';
+
+export const client = createClient(createConfig());

packages/openapi-ts/test/__snapshots__/3.0.x/security-open-id-connect/index.ts

@@ -0,0 +1,3 @@
+// This file is auto-generated by @hey-api/openapi-ts
+export * from './types.gen';
+export * from './sdk.gen';

packages/openapi-ts/test/__snapshots__/3.0.x/security-open-id-connect/sdk.gen.ts

@@ -0,0 +1,27 @@
+// This file is auto-generated by @hey-api/openapi-ts
+
+import type { Options as ClientOptions, TDataShape, Client } from '@hey-api/client-fetch';
+import type { GetFooData } from './types.gen';
+import { client as _heyApiClient } from './client.gen';
+
+export type Options<TData extends TDataShape = TDataShape, ThrowOnError extends boolean = boolean> = ClientOptions<TData, ThrowOnError> & {
+    /**
+     * You can provide a client instance returned by `createClient()` instead of
+     * individual options. This might be also useful if you want to implement a
+     * custom client.
+     */
+    client?: Client;
+};
+
+export const getFoo = <ThrowOnError extends boolean = false>(options?: Options<GetFooData, ThrowOnError>) => {
+    return (options?.client ?? _heyApiClient).get<unknown, unknown, ThrowOnError>({
+        security: [
+            {
+                scheme: 'bearer',
+                type: 'http'
+            }
+        ],
+        url: '/foo',
+        ...options
+    });
+};

packages/openapi-ts/test/__snapshots__/3.0.x/security-open-id-connect/types.gen.ts

@@ -0,0 +1,15 @@
+// This file is auto-generated by @hey-api/openapi-ts
+
+export type GetFooData = {
+    body?: never;
+    path?: never;
+    query?: never;
+    url: '/foo';
+};
+
+export type GetFooResponses = {
+    /**
+     * OK
+     */
+    200: unknown;
+};

packages/openapi-ts/test/__snapshots__/3.1.x/clients/@hey-api/client-axios/bundle/client/index.d.cts

@@ -2,7 +2,17 @@ import { CreateAxiosDefaults, AxiosStatic, AxiosResponse, AxiosError, AxiosInsta
 
 type AuthToken = string | undefined;
 interface Auth {
+    /**
+     * Which part of the request do we use to send the auth?
+     *
+     * @default 'header'
+     */
     in?: 'header' | 'query';
+    /**
+     * Header or query parameter name.
+     *
+     * @default 'Authorization'
+     */
     name?: string;
     scheme?: 'basic' | 'bearer';
     type: 'apiKey' | 'http';

packages/openapi-ts/test/__snapshots__/3.1.x/clients/@hey-api/client-axios/bundle/client/index.d.ts

@@ -2,7 +2,17 @@ import { CreateAxiosDefaults, AxiosStatic, AxiosResponse, AxiosError, AxiosInsta
 
 type AuthToken = string | undefined;
 interface Auth {
+    /**
+     * Which part of the request do we use to send the auth?
+     *
+     * @default 'header'
+     */
     in?: 'header' | 'query';
+    /**
+     * Header or query parameter name.
+     *
+     * @default 'Authorization'
+     */
     name?: string;
     scheme?: 'basic' | 'bearer';
     type: 'apiKey' | 'http';

packages/openapi-ts/test/__snapshots__/3.1.x/clients/@hey-api/client-fetch/bundle/client/index.d.cts

@@ -1,6 +1,16 @@
 type AuthToken = string | undefined;
 interface Auth {
+    /**
+     * Which part of the request do we use to send the auth?
+     *
+     * @default 'header'
+     */
     in?: 'header' | 'query';
+    /**
+     * Header or query parameter name.
+     *
+     * @default 'Authorization'
+     */
     name?: string;
     scheme?: 'basic' | 'bearer';
     type: 'apiKey' | 'http';

packages/openapi-ts/test/__snapshots__/3.1.x/clients/@hey-api/client-fetch/bundle/client/index.d.ts

@@ -1,6 +1,16 @@
 type AuthToken = string | undefined;
 interface Auth {
+    /**
+     * Which part of the request do we use to send the auth?
+     *
+     * @default 'header'
+     */
     in?: 'header' | 'query';
+    /**
+     * Header or query parameter name.
+     *
+     * @default 'Authorization'
+     */
     name?: string;
     scheme?: 'basic' | 'bearer';
     type: 'apiKey' | 'http';

packages/openapi-ts/test/__snapshots__/3.1.x/clients/@hey-api/client-next/bundle/client/index.d.cts

@@ -1,6 +1,16 @@
 type AuthToken = string | undefined;
 interface Auth {
+    /**
+     * Which part of the request do we use to send the auth?
+     *
+     * @default 'header'
+     */
     in?: 'header' | 'query';
+    /**
+     * Header or query parameter name.
+     *
+     * @default 'Authorization'
+     */
     name?: string;
     scheme?: 'basic' | 'bearer';
     type: 'apiKey' | 'http';

packages/openapi-ts/test/__snapshots__/3.1.x/clients/@hey-api/client-next/bundle/client/index.d.ts

@@ -1,6 +1,16 @@
 type AuthToken = string | undefined;
 interface Auth {
+    /**
+     * Which part of the request do we use to send the auth?
+     *
+     * @default 'header'
+     */
     in?: 'header' | 'query';
+    /**
+     * Header or query parameter name.
+     *
+     * @default 'Authorization'
+     */
     name?: string;
     scheme?: 'basic' | 'bearer';
     type: 'apiKey' | 'http';

packages/openapi-ts/test/__snapshots__/3.1.x/clients/@hey-api/client-nuxt/bundle/client/index.d.cts

@@ -3,7 +3,17 @@ import { Ref } from 'vue';
 
 type AuthToken = string | undefined;
 interface Auth {
+    /**
+     * Which part of the request do we use to send the auth?
+     *
+     * @default 'header'
+     */
     in?: 'header' | 'query';
+    /**
+     * Header or query parameter name.
+     *
+     * @default 'Authorization'
+     */
     name?: string;
     scheme?: 'basic' | 'bearer';
     type: 'apiKey' | 'http';

packages/openapi-ts/test/__snapshots__/3.1.x/clients/@hey-api/client-nuxt/bundle/client/index.d.ts

@@ -3,7 +3,17 @@ import { Ref } from 'vue';
 
 type AuthToken = string | undefined;
 interface Auth {
+    /**
+     * Which part of the request do we use to send the auth?
+     *
+     * @default 'header'
+     */
     in?: 'header' | 'query';
+    /**
+     * Header or query parameter name.
+     *
+     * @default 'Authorization'
+     */
     name?: string;
     scheme?: 'basic' | 'bearer';
     type: 'apiKey' | 'http';

packages/openapi-ts/test/__snapshots__/3.1.x/security-open-id-connect/client.gen.ts

@@ -0,0 +1,5 @@
+// This file is auto-generated by @hey-api/openapi-ts
+
+import { createClient, createConfig } from '@hey-api/client-fetch';
+
+export const client = createClient(createConfig());

packages/openapi-ts/test/__snapshots__/3.1.x/security-open-id-connect/index.ts

@@ -0,0 +1,3 @@
+// This file is auto-generated by @hey-api/openapi-ts
+export * from './types.gen';
+export * from './sdk.gen';

packages/openapi-ts/test/__snapshots__/3.1.x/security-open-id-connect/sdk.gen.ts

@@ -0,0 +1,27 @@
+// This file is auto-generated by @hey-api/openapi-ts
+
+import type { Options as ClientOptions, TDataShape, Client } from '@hey-api/client-fetch';
+import type { GetFooData } from './types.gen';
+import { client as _heyApiClient } from './client.gen';
+
+export type Options<TData extends TDataShape = TDataShape, ThrowOnError extends boolean = boolean> = ClientOptions<TData, ThrowOnError> & {
+    /**
+     * You can provide a client instance returned by `createClient()` instead of
+     * individual options. This might be also useful if you want to implement a
+     * custom client.
+     */
+    client?: Client;
+};
+
+export const getFoo = <ThrowOnError extends boolean = false>(options?: Options<GetFooData, ThrowOnError>) => {
+    return (options?.client ?? _heyApiClient).get<unknown, unknown, ThrowOnError>({
+        security: [
+            {
+                scheme: 'bearer',
+                type: 'http'
+            }
+        ],
+        url: '/foo',
+        ...options
+    });
+};