@kubb/swagger-ts 2.13.0 → 2.13.2

package/src/oas/requestParams.ts

@@ -1,135 +0,0 @@
-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 { MethodMap, ParamMap, PathMap } from './mappers.ts'
-import type { SecurityParamsBySecurityRef } from './security.ts'
-
-type Checks = {
-  RequestBodyJson: {
-    requestBody: { content: { 'application/json': { schema: JSONSchema } } }
-  }
-  RequestBodyFormData: {
-    requestBody: {
-      content: { 'multipart/form-data': { schema: JSONSchema } }
-    }
-  }
-  RequestBodyFormEncoded: {
-    requestBody: {
-      content: {
-        'application/x-www-form-urlencoded': { schema: JSONSchema }
-      }
-    }
-  }
-  Parameters: {
-    parameters: { name: string; in: string }[]
-  }
-  PathBrackets: `${string}{${string}}${string}`
-  PathPattern: `${string}:${string}${string}`
-  Required: { required: true }
-}
-
-type ExtractPathParamsWithPattern<TPath extends string> = Pipe<
-  TPath,
-  [Strings.Split<'/'>, Tuples.Filter<Strings.StartsWith<':'>>, Tuples.Map<Strings.Trim<':'>>, Tuples.ToUnion]
->
-
-type IsPathParameter<T extends string> = T extends `{${infer U}}` ? U : never
-
-type ExtractPathParameters<T extends any[]> = {
-  [K in keyof T]: IsPathParameter<T[K]>
-}
-
-type ExtractSegments<TPath extends string> = SplitByDelimiter<TPath, '/'>
-
-type ExtractSubSegments<T extends any[]> = {
-  [K in keyof T]: SplitByDelimiter<T[K], ';'>
-}
-
-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']
-    ? {
-        /**
-         * 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']>
-      }
-    : {
-        /**
-         * 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']>
-        }
-      : {
-          /**
-           * 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 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']
-    ? {
-        /**
-         * 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
-  SecurityParamsBySecurityRef<TOAS, TOAS>

package/src/oas/response.ts

@@ -1,30 +0,0 @@
-import type { OasTypes } from '@kubb/swagger/oas'
-import type { FromSchema } from 'json-schema-to-ts'
-import type { MethodMap, PathMap, StatusMap } from './mappers.ts'
-
-type Checks = {
-  Content: { content: any }
-}
-
-type ResponseSchemas<
-  TOAS extends OasTypes.OASDocument,
-  TPath extends keyof PathMap<TOAS>,
-  TMethod extends keyof MethodMap<TOAS, TPath>,
-  TStatus extends keyof StatusMap<TOAS, TPath, TMethod>,
-> = StatusMap<TOAS, TPath, TMethod>[TStatus]['content']
-
-type JSONResponseSchema<
-  TOAS extends OasTypes.OASDocument,
-  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]['schema']
-
-export type Response<
-  TOAS extends OasTypes.OASDocument,
-  TPath extends keyof PathMap<TOAS>,
-  TMethod extends keyof MethodMap<TOAS, TPath>,
-  TStatusCode extends keyof StatusMap<TOAS, TPath, TMethod> = 200,
-> = FromSchema<JSONResponseSchema<TOAS, TPath, TMethod, TStatusCode>>

package/src/oas/security.ts

@@ -1,157 +0,0 @@
-import type { Call, Objects, Tuples } from 'hotscript'
-
-type Checks = {
-  Security: { security: { [key: string]: any }[] }
-
-  AuthParams: {
-    Basic:
-      | {
-          type: 'http'
-          scheme: 'basic'
-        }
-      | { type: 'basic' }
-    Bearer:
-      | {
-          type: 'http'
-          scheme: 'bearer'
-        }
-      | { type: 'bearer' }
-
-    OAuth2: {
-      type: 'oauth2'
-    }
-    ApiKey: {
-      type: 'apiKey'
-      in: 'header'
-    }
-  }
-
-  AuthName: {
-    Basic: `basic${string}`
-    Bearer: `bearer${string}`
-    OAuth2: `oauth${string}`
-  }
-}
-
-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 Bearer<TSecurityScheme> = TSecurityScheme extends Checks['AuthParams']['Bearer']
-    ? {
-        /**
-         * `Authorization` header is required for bearer authentication
-         * @see https://swagger.io/docs/specification/authentication/bearer-authentication/
-         */
-        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: {
-            /**
-             * 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: {
-          /**
-           * 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>
-
-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'
-            }>
-          : {}
-  : {}