@kubb/swagger-ts 2.11.0 → 2.12.0

package/src/oas/requestParams.ts

@@ -2,10 +2,7 @@
 import type { OasTypes } from '@kubb/swagger/oas'
 import type { SplitByDelimiter, TupleToUnion } from '@kubb/types'
 import type { Pipe, Strings, Tuples } from 'hotscript'
-import type {
-  FromSchema,
-  JSONSchema,
-} from 'json-schema-to-ts'
+import type { FromSchema, JSONSchema } from 'json-schema-to-ts'
 import type { MethodMap, ParamMap, PathMap } from './mappers.ts'
 import type { SecurityParamsBySecurityRef } from './security.ts'
 
@@ -35,12 +32,7 @@ type Checks = {
 
 type ExtractPathParamsWithPattern<TPath extends string> = Pipe<
   TPath,
-  [
-    Strings.Split<'/'>,
-    Tuples.Filter<Strings.StartsWith<':'>>,
-    Tuples.Map<Strings.Trim<':'>>,
-    Tuples.ToUnion,
-  ]
+  [Strings.Split<'/'>, Tuples.Filter<Strings.StartsWith<':'>>, Tuples.Map<Strings.Trim<':'>>, Tuples.ToUnion]
 >
 
 type IsPathParameter<T extends string> = T extends `{${infer U}}` ? U : never
@@ -55,114 +47,90 @@ type ExtractSubSegments<T extends any[]> = {
   [K in keyof T]: SplitByDelimiter<T[K], ';'>
 }
 
-type ExtractPathParamsWithBrackets<TPath extends string> = TupleToUnion<
-  ExtractPathParameters<ExtractSubSegments<ExtractSegments<TPath>>[number]>
->
+type ExtractPathParamsWithBrackets<TPath extends string> = TupleToUnion<ExtractPathParameters<ExtractSubSegments<ExtractSegments<TPath>>[number]>>
 
-export type RequestParams<
-  TOAS extends OasTypes.OASDocument,
-  TPath extends keyof PathMap<TOAS>,
-  TMethod extends keyof MethodMap<TOAS, TPath>,
-> =
-  & (MethodMap<TOAS, TPath>[TMethod] extends Checks['RequestBodyJson'] ? MethodMap<TOAS, TPath>[TMethod]['requestBody'] extends Checks['Required'] ? {
+export type RequestParams<TOAS extends OasTypes.OASDocument, TPath extends keyof PathMap<TOAS>, TMethod extends keyof MethodMap<TOAS, TPath>> = (MethodMap<
+  TOAS,
+  TPath
+>[TMethod] extends Checks['RequestBodyJson']
+  ? MethodMap<TOAS, TPath>[TMethod]['requestBody'] extends Checks['Required']
+    ? {
         /**
          * The request body in JSON is required for this request.
          *
          * The value of `json` will be stringified and sent as the request body with `Content-Type: application/json`.
          */
-        json: FromSchema<
-          MethodMap<TOAS, TPath>[TMethod]['requestBody']['content']['application/json']['schema']
-        >
+        json: FromSchema<MethodMap<TOAS, TPath>[TMethod]['requestBody']['content']['application/json']['schema']>
       }
     : {
-      /**
-       * The request body in JSON is optional for this request.
-       *
-       * The value of `json` will be stringified and sent as the request body with `Content-Type: application/json`.
-       */
-      json?: FromSchema<
-        MethodMap<TOAS, TPath>[TMethod]['requestBody']['content']['application/json']['schema']
-      >
-    }
-    : MethodMap<TOAS, TPath>[TMethod] extends Checks['RequestBodyFormData'] ? MethodMap<TOAS, TPath>[TMethod]['requestBody'] extends Checks['Required'] ? {
+        /**
+         * The request body in JSON is optional for this request.
+         *
+         * The value of `json` will be stringified and sent as the request body with `Content-Type: application/json`.
+         */
+        json?: FromSchema<MethodMap<TOAS, TPath>[TMethod]['requestBody']['content']['application/json']['schema']>
+      }
+  : MethodMap<TOAS, TPath>[TMethod] extends Checks['RequestBodyFormData']
+    ? MethodMap<TOAS, TPath>[TMethod]['requestBody'] extends Checks['Required']
+      ? {
           /**
            * The request body in multipart/form-data is required for this request.
            *
            * The value of `formData` will be sent as the request body with `Content-Type: multipart/form-data`.
            */
-          formData: FromSchema<
-            MethodMap<
-              TOAS,
-              TPath
-            >[TMethod]['requestBody']['content']['multipart/form-data']['schema']
-          >
+          formData: FromSchema<MethodMap<TOAS, TPath>[TMethod]['requestBody']['content']['multipart/form-data']['schema']>
         }
       : {
-        /**
-         * The request body in multipart/form-data is optional for this request.
-         *
-         * The value of `formData` will be sent as the request body with `Content-Type: multipart/form-data`.
-         */
-        formData?: FromSchema<
-          MethodMap<
-            TOAS,
-            TPath
-          >[TMethod]['requestBody']['content']['multipart/form-data']['schema']
-        >
-      }
-    : MethodMap<TOAS, TPath>[TMethod] extends Checks['RequestBodyFormEncoded'] ? MethodMap<TOAS, TPath>[TMethod]['requestBody'] extends Checks['Required'] ? {
           /**
-           * The request body in application/x-www-form-urlencoded is required for this request.
+           * The request body in multipart/form-data is optional for this request.
            *
-           * The value of `formUrlEncoded` will be sent as the request body with `Content-Type: application/x-www-form-urlencoded`.
+           * The value of `formData` will be sent as the request body with `Content-Type: multipart/form-data`.
            */
-          formUrlEncoded: FromSchema<
-            MethodMap<
-              TOAS,
-              TPath
-            >[TMethod]['requestBody']['content']['application/x-www-form-urlencoded']['schema']
-          >
+          formData?: FromSchema<MethodMap<TOAS, TPath>[TMethod]['requestBody']['content']['multipart/form-data']['schema']>
         }
-      : {
+    : MethodMap<TOAS, TPath>[TMethod] extends Checks['RequestBodyFormEncoded']
+      ? MethodMap<TOAS, TPath>[TMethod]['requestBody'] extends Checks['Required']
+        ? {
+            /**
+             * The request body in application/x-www-form-urlencoded is required for this request.
+             *
+             * The value of `formUrlEncoded` will be sent as the request body with `Content-Type: application/x-www-form-urlencoded`.
+             */
+            formUrlEncoded: FromSchema<MethodMap<TOAS, TPath>[TMethod]['requestBody']['content']['application/x-www-form-urlencoded']['schema']>
+          }
+        : {
+            /**
+             * The request body in application/x-www-form-urlencoded is optional for this request.
+             *
+             * The value of `formUrlEncoded` will be sent as the request body with `Content-Type: application/x-www-form-urlencoded`.
+             */
+            formUrlEncoded?: FromSchema<MethodMap<TOAS, TPath>[TMethod]['requestBody']['content']['application/x-www-form-urlencoded']['schema']>
+          }
+      : {}) &
+  (MethodMap<TOAS, TPath>[TMethod] extends Checks['Parameters'] ? ParamMap<MethodMap<TOAS, TPath>[TMethod]['parameters']> : {}) & // If there is any parameters defined in path but not in the parameters array, we should add them to the params
+  (TPath extends Checks['PathBrackets']
+    ? {
         /**
-         * The request body in application/x-www-form-urlencoded is optional for this request.
+         * Parameters defined in the path are required for this request.
+         *
+         * The value of `params` will be used to replace the path parameters.
          *
-         * The value of `formUrlEncoded` will be sent as the request body with `Content-Type: application/x-www-form-urlencoded`.
+         * For example if path is `/todos/{id}` and `params` is `{ id: '1' }`, the path will be `/todos/1`
          */
-        formUrlEncoded?: FromSchema<
-          MethodMap<
-            TOAS,
-            TPath
-          >[TMethod]['requestBody']['content']['application/x-www-form-urlencoded']['schema']
-        >
+        params: Record<ExtractPathParamsWithBrackets<TPath>, string | number | bigint | boolean>
       }
-    : {})
-  & (MethodMap<TOAS, TPath>[TMethod] extends Checks['Parameters'] ? ParamMap<MethodMap<TOAS, TPath>[TMethod]['parameters']>
-    : {})
-  & // If there is any parameters defined in path but not in the parameters array, we should add them to the params
-  (TPath extends Checks['PathBrackets'] ? {
-      /**
-       * Parameters defined in the path are required for this request.
-       *
-       * The value of `params` will be used to replace the path parameters.
-       *
-       * For example if path is `/todos/{id}` and `params` is `{ id: '1' }`, the path will be `/todos/1`
-       */
-      params: Record<ExtractPathParamsWithBrackets<TPath>, string | number | bigint | boolean>
-    }
-    : {})
-  & (TPath extends Checks['PathPattern'] ? {
-      /**
-       * Parameters defined in the path are required for this request.
-       *
-       * The value of `params` will be used to replace the path parameters.
-       *
-       * For example if path is `/todos/:id` and `params` is `{ id: '1' }`, the path will be `/todos/1`.
-       */
-      params: Record<ExtractPathParamsWithPattern<TPath>, string | number | bigint | boolean>
-    }
-    : {})
-  & // Respect security definitions in path object
-  SecurityParamsBySecurityRef<TOAS, MethodMap<TOAS, TPath>[TMethod]>
-  & // Respect global security definitions
+    : {}) &
+  (TPath extends Checks['PathPattern']
+    ? {
+        /**
+         * Parameters defined in the path are required for this request.
+         *
+         * The value of `params` will be used to replace the path parameters.
+         *
+         * For example if path is `/todos/:id` and `params` is `{ id: '1' }`, the path will be `/todos/1`.
+         */
+        params: Record<ExtractPathParamsWithPattern<TPath>, string | number | bigint | boolean>
+      }
+    : {}) & // Respect security definitions in path object
+  SecurityParamsBySecurityRef<TOAS, MethodMap<TOAS, TPath>[TMethod]> & // Respect global security definitions
   SecurityParamsBySecurityRef<TOAS, TOAS>

package/src/oas/response.ts

@@ -1,7 +1,5 @@
 import type { OasTypes } from '@kubb/swagger/oas'
-import type {
-  FromSchema,
-} from 'json-schema-to-ts'
+import type { FromSchema } from 'json-schema-to-ts'
 import type { MethodMap, PathMap, StatusMap } from './mappers.ts'
 
 type Checks = {
@@ -20,14 +18,8 @@ type JSONResponseSchema<
   TPath extends keyof PathMap<TOAS>,
   TMethod extends keyof MethodMap<TOAS, TPath>,
   TStatus extends keyof StatusMap<TOAS, TPath, TMethod>,
-> = StatusMap<TOAS, TPath, TMethod>[TStatus] extends Checks['Content'] ? ResponseSchemas<TOAS, TPath, TMethod, TStatus>[
-    keyof ResponseSchemas<
-      TOAS,
-      TPath,
-      TMethod,
-      TStatus
-    >
-  ]['schema']
+> = StatusMap<TOAS, TPath, TMethod>[TStatus] extends Checks['Content']
+  ? ResponseSchemas<TOAS, TPath, TMethod, TStatus>[keyof ResponseSchemas<TOAS, TPath, TMethod, TStatus>]['schema']
   : StatusMap<TOAS, TPath, TMethod>[TStatus]['schema']
 
 export type Response<

package/src/oas/security.ts

@@ -9,15 +9,15 @@ type Checks = {
   AuthParams: {
     Basic:
       | {
-        type: 'http'
-        scheme: 'basic'
-      }
+          type: 'http'
+          scheme: 'basic'
+        }
       | { type: 'basic' }
     Bearer:
       | {
-        type: 'http'
-        scheme: 'bearer'
-      }
+          type: 'http'
+          scheme: 'bearer'
+        }
       | { type: 'bearer' }
 
     OAuth2: {
@@ -36,123 +36,125 @@ type Checks = {
   }
 }
 
-type SecuritySchemeName<T extends Checks['Security']> = Call<
-  Tuples.Map<Objects.Keys>,
-  T['security']
->[number]
+type SecuritySchemeName<T extends Checks['Security']> = Call<Tuples.Map<Objects.Keys>, T['security']>[number]
 
 namespace AuthParams {
-  export type Basic<TSecurityScheme> = TSecurityScheme extends Checks['AuthParams']['Basic'] ? {
-      headers: {
-        /**
-         * `Authorization` header is required for basic authentication
-         * @see https://en.wikipedia.org/wiki/Basic_access_authentication
-         *
-         * It contains the word `Basic` followed by a space and a base64-encoded string `username:password`
-         *
-         * @example
-         * ```
-         * Authorization: Basic QWxhZGRpbjpvcGVuIHNlc2FtZQ==
-         * ```
-         */
-        Authorization: `Basic ${string}`
+  export type Basic<TSecurityScheme> = TSecurityScheme extends Checks['AuthParams']['Basic']
+    ? {
+        headers: {
+          /**
+           * `Authorization` header is required for basic authentication
+           * @see https://en.wikipedia.org/wiki/Basic_access_authentication
+           *
+           * It contains the word `Basic` followed by a space and a base64-encoded string `username:password`
+           *
+           * @example
+           * ```
+           * Authorization: Basic QWxhZGRpbjpvcGVuIHNlc2FtZQ==
+           * ```
+           */
+          Authorization: `Basic ${string}`
+        }
       }
-    }
     : {}
 
-  export type Bearer<TSecurityScheme> = TSecurityScheme extends Checks['AuthParams']['Bearer'] ? {
-      /**
-       * `Authorization` header is required for bearer authentication
-       * @see https://swagger.io/docs/specification/authentication/bearer-authentication/
-       */
-      headers: {
+  export type Bearer<TSecurityScheme> = TSecurityScheme extends Checks['AuthParams']['Bearer']
+    ? {
         /**
-         * It contains the word `Bearer` followed by a space and the token
-         *
-         * @example
-         * ```
-         * Authorization: Bearer {token}
-         * ```
+         * `Authorization` header is required for bearer authentication
+         * @see https://swagger.io/docs/specification/authentication/bearer-authentication/
          */
-        Authorization: `Bearer ${string}`
+        headers: {
+          /**
+           * It contains the word `Bearer` followed by a space and the token
+           *
+           * @example
+           * ```
+           * Authorization: Bearer {token}
+           * ```
+           */
+          Authorization: `Bearer ${string}`
+        }
       }
-    }
     : {}
 
-  export type ApiKey<TSecurityScheme> = TSecurityScheme extends Checks['AuthParams']['ApiKey'] & { name: infer TApiKeyHeaderName } ? {
-      headers: {
-        /**
-         * Header required for API key authentication
-         */
-        [THeaderName in TApiKeyHeaderName extends string ? TApiKeyHeaderName : never]: string
-      }
-    }
-    : TSecurityScheme extends {
-      type: 'apiKey'
-      in: 'query'
-      name: infer TApiKeyQueryName
-    } ? {
-        query: {
+  export type ApiKey<TSecurityScheme> = TSecurityScheme extends Checks['AuthParams']['ApiKey'] & {
+    name: infer TApiKeyHeaderName
+  }
+    ? {
+        headers: {
           /**
-           * Query parameter required for API key authentication
+           * Header required for API key authentication
            */
-          [TQueryName in TApiKeyQueryName extends string ? TApiKeyQueryName : never]: string
+          [THeaderName in TApiKeyHeaderName extends string ? TApiKeyHeaderName : never]: string
         }
       }
-    : {}
+    : TSecurityScheme extends {
+          type: 'apiKey'
+          in: 'query'
+          name: infer TApiKeyQueryName
+        }
+      ? {
+          query: {
+            /**
+             * Query parameter required for API key authentication
+             */
+            [TQueryName in TApiKeyQueryName extends string ? TApiKeyQueryName : never]: string
+          }
+        }
+      : {}
 
-  export type OAuth2<TSecurityScheme> = TSecurityScheme extends Checks['AuthParams']['OAuth2'] ? {
-      /**
-       * `Authorization` header is required for OAuth2.
-       */
-      headers: {
+  export type OAuth2<TSecurityScheme> = TSecurityScheme extends Checks['AuthParams']['OAuth2']
+    ? {
         /**
-         * The access token string as issued by the authorization server.
-         * @example `Authorization: Bearer <access_token>`
+         * `Authorization` header is required for OAuth2.
          */
-        Authorization: `Bearer ${string}`
+        headers: {
+          /**
+           * The access token string as issued by the authorization server.
+           * @example `Authorization: Bearer <access_token>`
+           */
+          Authorization: `Bearer ${string}`
+        }
       }
-    }
     : {}
 }
 
-type OASSecurityParams<TSecurityScheme> =
-  & AuthParams.Basic<TSecurityScheme>
-  & AuthParams.Bearer<TSecurityScheme>
-  & AuthParams.ApiKey<TSecurityScheme>
-  & AuthParams.OAuth2<TSecurityScheme>
+type OASSecurityParams<TSecurityScheme> = AuthParams.Basic<TSecurityScheme> &
+  AuthParams.Bearer<TSecurityScheme> &
+  AuthParams.ApiKey<TSecurityScheme> &
+  AuthParams.OAuth2<TSecurityScheme>
 
-export type SecurityParamsBySecurityRef<TOAS, TSecurityObj> = TSecurityObj extends Checks['Security'] ? TOAS extends
-    | {
-      components: {
-        securitySchemes: {
-          [
-            TSecuritySchemeNameKey in SecuritySchemeName<TSecurityObj> extends string ? SecuritySchemeName<TSecurityObj>
-              : never
-          ]: infer TSecurityScheme
+export type SecurityParamsBySecurityRef<TOAS, TSecurityObj> = TSecurityObj extends Checks['Security']
+  ? TOAS extends
+      | {
+          components: {
+            securitySchemes: {
+              [TSecuritySchemeNameKey in SecuritySchemeName<TSecurityObj> extends string ? SecuritySchemeName<TSecurityObj> : never]: infer TSecurityScheme
+            }
+          }
         }
-      }
-    }
-    | {
-      securityDefinitions: {
-        [
-          TSecuritySchemeNameKey in SecuritySchemeName<TSecurityObj> extends string ? SecuritySchemeName<TSecurityObj>
-            : never
-        ]: infer TSecurityScheme
-      }
-    } ? OASSecurityParams<TSecurityScheme>
-    // OAS may have a bad reference to a security scheme
-    // So we can assume it
-  : SecuritySchemeName<TSecurityObj> extends Checks['AuthName']['Basic'] ? AuthParams.Basic<{
-      type: 'http'
-      scheme: 'basic'
-    }>
-  : SecuritySchemeName<TSecurityObj> extends Checks['AuthName']['Bearer'] ? AuthParams.Bearer<{
-      type: 'http'
-      scheme: 'bearer'
-    }>
-  : SecuritySchemeName<TSecurityObj> extends Checks['AuthName']['OAuth2'] ? AuthParams.OAuth2<{
-      type: 'oauth2'
-    }>
-  : {}
+      | {
+          securityDefinitions: {
+            [TSecuritySchemeNameKey in SecuritySchemeName<TSecurityObj> extends string ? SecuritySchemeName<TSecurityObj> : never]: infer TSecurityScheme
+          }
+        }
+    ? OASSecurityParams<TSecurityScheme>
+    : // OAS may have a bad reference to a security scheme
+      // So we can assume it
+      SecuritySchemeName<TSecurityObj> extends Checks['AuthName']['Basic']
+      ? AuthParams.Basic<{
+          type: 'http'
+          scheme: 'basic'
+        }>
+      : SecuritySchemeName<TSecurityObj> extends Checks['AuthName']['Bearer']
+        ? AuthParams.Bearer<{
+            type: 'http'
+            scheme: 'bearer'
+          }>
+        : SecuritySchemeName<TSecurityObj> extends Checks['AuthName']['OAuth2']
+          ? AuthParams.OAuth2<{
+              type: 'oauth2'
+            }>
+          : {}
   : {}

package/src/plugin.ts

@@ -88,35 +88,29 @@ export const definePlugin = createPlugin<PluginOptions>((options) => {
       const root = path.resolve(this.config.root, this.config.output.path)
       const mode = FileManager.getMode(path.resolve(root, output.path))
 
-      const schemaGenerator = new SchemaGenerator(
-        this.plugin.options,
-        {
-          oas,
-          pluginManager: this.pluginManager,
-          plugin: this.plugin,
-          contentType: swaggerPlugin.api.contentType,
-          include: undefined,
-          mode,
-          output: output.path,
-        },
-      )
+      const schemaGenerator = new SchemaGenerator(this.plugin.options, {
+        oas,
+        pluginManager: this.pluginManager,
+        plugin: this.plugin,
+        contentType: swaggerPlugin.api.contentType,
+        include: undefined,
+        mode,
+        output: output.path,
+      })
 
       const schemaFiles = await schemaGenerator.build()
       await this.addFile(...schemaFiles)
 
-      const operationGenerator = new OperationGenerator(
-        this.plugin.options,
-        {
-          oas,
-          pluginManager: this.pluginManager,
-          plugin: this.plugin,
-          contentType: swaggerPlugin.api.contentType,
-          exclude,
-          include,
-          override,
-          mode,
-        },
-      )
+      const operationGenerator = new OperationGenerator(this.plugin.options, {
+        oas,
+        pluginManager: this.pluginManager,
+        plugin: this.plugin,
+        contentType: swaggerPlugin.api.contentType,
+        exclude,
+        include,
+        override,
+        mode,
+      })
 
       const operationFiles = await operationGenerator.build()
       await this.addFile(...operationFiles)