@kubb/plugin-client 3.0.0-alpha.9 → 3.0.0-beta.10

package/dist/types-DMMK2qi5.d.ts

@@ -0,0 +1,88 @@
+import { PluginFactoryOptions, Output, Group, ResolveNameParams } from '@kubb/core';
+import { ResolvePathOptions, Exclude, Include, Override, Generator } from '@kubb/plugin-oas';
+
+type Options = {
+    /**
+     * Specify the export location for the files and define the behavior of the output
+     * @default { path: 'clients', barrelType: 'named' }
+     */
+    output?: Output;
+    /**
+     * Group the clients based on the provided name.
+     */
+    group?: Group;
+    /**
+     * Array containing exclude parameters to exclude/skip tags/operations/methods/paths.
+     */
+    exclude?: Array<Exclude>;
+    /**
+     * Array containing include parameters to include tags/operations/methods/paths.
+     */
+    include?: Array<Include>;
+    /**
+     * Array containing override parameters to override `options` based on tags/operations/methods/paths.
+     */
+    override?: Array<Override<ResolvedOptions>>;
+    /**
+     * Create `operations.ts` file with all operations grouped by methods.
+     * @default false
+     */
+    operations?: boolean;
+    /**
+     * Path to the client import path that will be used to do the API calls.
+     * It will be used as `import client from '${client.importPath}'`.
+     * It allows both relative and absolute path but be aware that we will not change the path.
+     * @default '@kubb/plugin-client/client'
+     */
+    importPath?: string;
+    /**
+     * ReturnType that will be used when calling the client.
+     * - 'data' will return ResponseConfig[data].
+     * - 'full' will return ResponseConfig.
+     * @default 'data'
+     */
+    dataReturnType?: 'data' | 'full';
+    /**
+     * How to pass your params
+     * - 'object' will return the params and pathParams as an object.
+     * - 'inline' will return the params as comma separated params.
+     * @default 'inline'
+     */
+    paramsType?: 'object' | 'inline';
+    /**
+     * How to pass your pathParams.
+     * - 'object' will return the pathParams as an object.
+     * - 'inline' will return the pathParams as comma separated params.
+     * @default 'inline'
+     */
+    pathParamsType?: 'object' | 'inline';
+    /**
+     * Which parser can be used before returning the data
+     * - 'zod'  will use `@kubb/plugin-zod` to parse the data.
+     * @default 'client'
+     */
+    parser?: 'client' | 'zod';
+    transformers?: {
+        /**
+         * Customize the names based on the type that is provided by the plugin.
+         */
+        name?: (name: ResolveNameParams['name'], type?: ResolveNameParams['type']) => string;
+    };
+    /**
+     * Define some generators next to the client generators
+     */
+    generators?: Array<Generator<PluginClient>>;
+};
+type ResolvedOptions = {
+    output: Output;
+    group?: Options['group'];
+    baseURL: string | undefined;
+    parser: NonNullable<Options['parser']>;
+    importPath: NonNullable<Options['importPath']>;
+    dataReturnType: NonNullable<Options['dataReturnType']>;
+    pathParamsType: NonNullable<Options['pathParamsType']>;
+    paramsType: NonNullable<Options['paramsType']>;
+};
+type PluginClient = PluginFactoryOptions<'plugin-client', Options, ResolvedOptions, never, ResolvePathOptions>;
+
+export type { Options as O, PluginClient as P };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@kubb/plugin-client",
-  "version": "3.0.0-alpha.9",
+  "version": "3.0.0-beta.10",
   "description": "Generator plugin-client",
   "keywords": [
     "typescript",
@@ -72,27 +72,24 @@
     "!/**/__tests__/**"
   ],
   "dependencies": {
-    "@kubb/core": "3.0.0-alpha.9",
-    "@kubb/fs": "3.0.0-alpha.9",
-    "@kubb/oas": "3.0.0-alpha.9",
-    "@kubb/parser-ts": "3.0.0-alpha.9",
-    "@kubb/plugin-oas": "3.0.0-alpha.9",
-    "@kubb/plugin-ts": "3.0.0-alpha.9",
-    "@kubb/react": "3.0.0-alpha.9"
+    "@kubb/core": "3.0.0-beta.10",
+    "@kubb/fs": "3.0.0-beta.10",
+    "@kubb/oas": "3.0.0-beta.10",
+    "@kubb/plugin-oas": "3.0.0-beta.10",
+    "@kubb/plugin-ts": "3.0.0-beta.10",
+    "@kubb/plugin-zod": "3.0.0-beta.10",
+    "@kubb/react": "3.0.0-beta.10"
   },
   "devDependencies": {
-    "@types/react": "^18.3.4",
-    "axios": "^1.7.5",
-    "react": "^18.3.1",
-    "tsup": "^8.2.4",
-    "typescript": "^5.5.4",
-    "@kubb/config-biome": "3.0.0-alpha.9",
-    "@kubb/config-ts": "3.0.0-alpha.9",
-    "@kubb/config-tsup": "3.0.0-alpha.9"
+    "axios": "^1.7.7",
+    "tsup": "^8.3.5",
+    "typescript": "^5.6.3",
+    "@kubb/config-ts": "3.0.0-beta.10",
+    "@kubb/config-tsup": "3.0.0-beta.10"
   },
   "peerDependencies": {
     "axios": "^1.7.2",
-    "@kubb/react": "3.0.0-alpha.9"
+    "@kubb/react": "3.0.0-beta.10"
   },
   "peerDependenciesMeta": {
     "axios": {

package/src/components/Client.tsx

@@ -3,8 +3,8 @@ import { URLPath } from '@kubb/core/utils'
 import { type Operation, isOptional } from '@kubb/oas'
 import type { OperationSchemas } from '@kubb/plugin-oas'
 import { getComments, getPathParams } from '@kubb/plugin-oas/utils'
-import { File, Function, createParams } from '@kubb/react'
-import type { KubbNode, Params } from '@kubb/react/types'
+import { File, Function, FunctionParams } from '@kubb/react'
+import type { KubbNode } from '@kubb/react/types'
 import type { PluginClient } from '../types.ts'
 
 type Props = {
@@ -12,87 +12,147 @@ type Props = {
    * Name of the function
    */
   name: string
-  options: PluginClient['resolvedOptions']
-  typedSchemas: OperationSchemas
+  isExportable?: boolean
+  isIndexable?: boolean
+
+  baseURL: string | undefined
+  dataReturnType: PluginClient['resolvedOptions']['dataReturnType']
+  paramsType: PluginClient['resolvedOptions']['pathParamsType']
+  pathParamsType: PluginClient['resolvedOptions']['pathParamsType']
+  parser: PluginClient['resolvedOptions']['parser'] | undefined
+  typeSchemas: OperationSchemas
+  zodSchemas: OperationSchemas | undefined
   operation: Operation
 }
 
-export function Client({ name, options, typedSchemas, operation }: Props): KubbNode {
-  const contentType = operation.getContentType()
-  const baseURL = options.client.importPath === '@kubb/plugin-client/client' ? options.baseURL : undefined
-  const path = new URLPath(operation.path)
-  const isFormData = contentType === 'multipart/form-data'
-  const headers = [
-    contentType !== 'application/json' ? `'Content-Type': '${contentType}'` : undefined,
-    typedSchemas.headerParams?.name ? '...headers' : undefined,
-  ].filter(Boolean)
+type GetParamsProps = {
+  paramsType: PluginClient['resolvedOptions']['paramsType']
+  pathParamsType: PluginClient['resolvedOptions']['pathParamsType']
+  typeSchemas: OperationSchemas
+}
 
-  const params = createParams({
-    pathParams: {
-      mode: options.pathParamsType === 'object' ? 'object' : 'inlineSpread',
-      children: getPathParams(typedSchemas.pathParams, { typed: true }),
-    },
-    data: typedSchemas.request?.name
+function getParams({ paramsType, pathParamsType, typeSchemas }: GetParamsProps) {
+  if (paramsType === 'object') {
+    return FunctionParams.factory({
+      data: {
+        mode: 'object',
+        children: {
+          ...getPathParams(typeSchemas.pathParams, { typed: true }),
+          data: typeSchemas.request?.name
+            ? {
+                type: typeSchemas.request?.name,
+                optional: isOptional(typeSchemas.request?.schema),
+              }
+            : undefined,
+          params: typeSchemas.queryParams?.name
+            ? {
+                type: typeSchemas.queryParams?.name,
+                optional: isOptional(typeSchemas.queryParams?.schema),
+              }
+            : undefined,
+          headers: typeSchemas.headerParams?.name
+            ? {
+                type: typeSchemas.headerParams?.name,
+                optional: isOptional(typeSchemas.headerParams?.schema),
+              }
+            : undefined,
+        },
+      },
+      config: {
+        type: typeSchemas.request?.name ? `Partial<RequestConfig<${typeSchemas.request?.name}>>` : 'Partial<RequestConfig>',
+        default: '{}',
+      },
+    })
+  }
+
+  return FunctionParams.factory({
+    pathParams: typeSchemas.pathParams?.name
       ? {
-          type: typedSchemas.request?.name,
-          optional: isOptional(typedSchemas.request?.schema),
+          mode: pathParamsType === 'object' ? 'object' : 'inlineSpread',
+          children: getPathParams(typeSchemas.pathParams, { typed: true }),
+          type: typeSchemas.pathParams?.name,
+          optional: isOptional(typeSchemas.pathParams?.schema),
         }
       : undefined,
-    params: typedSchemas.queryParams?.name
+    data: typeSchemas.request?.name
       ? {
-          type: typedSchemas.queryParams?.name,
-          optional: isOptional(typedSchemas.queryParams?.schema),
+          type: typeSchemas.request?.name,
+          optional: isOptional(typeSchemas.request?.schema),
         }
       : undefined,
-    headers: typedSchemas.headerParams?.name
+    params: typeSchemas.queryParams?.name
       ? {
-          type: typedSchemas.headerParams?.name,
-          optional: isOptional(typedSchemas.headerParams?.schema),
+          type: typeSchemas.queryParams?.name,
+          optional: isOptional(typeSchemas.queryParams?.schema),
         }
       : undefined,
-    options: {
-      type: 'Partial<Parameters<typeof client>[0]>',
+    headers: typeSchemas.headerParams?.name
+      ? {
+          type: typeSchemas.headerParams?.name,
+          optional: isOptional(typeSchemas.headerParams?.schema),
+        }
+      : undefined,
+    config: {
+      type: typeSchemas.request?.name ? `Partial<RequestConfig<${typeSchemas.request?.name}>>` : 'Partial<RequestConfig>',
       default: '{}',
     },
   })
+}
 
-  const clientParams = createParams({
-    data: {
+export function Client({
+  name,
+  isExportable = true,
+  isIndexable = true,
+  typeSchemas,
+  baseURL,
+  dataReturnType,
+  parser,
+  zodSchemas,
+  paramsType,
+  pathParamsType,
+  operation,
+}: Props): KubbNode {
+  const path = new URLPath(operation.path)
+  const contentType = operation.getContentType()
+  const isFormData = contentType === 'multipart/form-data'
+  const headers = [
+    contentType !== 'application/json' ? `'Content-Type': '${contentType}'` : undefined,
+    typeSchemas.headerParams?.name ? '...headers' : undefined,
+  ].filter(Boolean)
+
+  const generics = [
+    typeSchemas.response.name,
+    typeSchemas.errors?.map((item) => item.name).join(' | ') || 'Error',
+    typeSchemas.request?.name || 'unknown',
+  ].filter(Boolean)
+  const params = getParams({ paramsType, pathParamsType, typeSchemas })
+  const clientParams = FunctionParams.factory({
+    config: {
       mode: 'object',
       children: {
         method: {
-          type: 'string',
-          value: JSON.stringify(operation.method),
+          value: JSON.stringify(operation.method.toUpperCase()),
         },
         url: {
-          type: 'string',
           value: path.template,
         },
         baseURL: baseURL
           ? {
-              type: 'string',
               value: JSON.stringify(baseURL),
             }
           : undefined,
-        params: typedSchemas.queryParams?.name
+        params: typeSchemas.queryParams?.name ? {} : undefined,
+        data: typeSchemas.request?.name
           ? {
-              type: 'any',
-            }
-          : undefined,
-        data: typedSchemas.request?.name
-          ? {
-              type: 'any',
               value: isFormData ? 'formData' : undefined,
             }
           : undefined,
         headers: headers.length
           ? {
-              type: 'any',
-              value: headers.length ? `{ ${headers.join(', ')}, ...options.headers }` : undefined,
+              value: headers.length ? `{ ${headers.join(', ')}, ...config.headers }` : undefined,
             }
           : undefined,
-        options: {
-          type: 'any',
+        config: {
           mode: 'inlineSpread',
         },
       },
@@ -104,36 +164,36 @@ export function Client({ name, options, typedSchemas, operation }: Props): KubbN
    const formData = new FormData()
    if(data) {
     Object.keys(data).forEach((key) => {
-      const value = data[key];
+      const value = data[key as keyof typeof data];
       if (typeof key === "string" && (typeof value === "string" || value instanceof Blob)) {
         formData.append(key, value);
       }
     })
    }
   `
-    : undefined
+    : ''
 
   return (
-    <File.Source name={name} isExportable isIndexable>
+    <File.Source name={name} isExportable={isExportable} isIndexable={isIndexable}>
       <Function
         name={name}
         async
-        export
-        returnType={
-          options.dataReturnType === 'data' ? `ResponseConfig<${typedSchemas.response.name}>["data"]` : `ResponseConfig<${typedSchemas.response.name}>`
-        }
-        params={params}
+        export={isExportable}
+        params={params.toConstructor()}
         JSDoc={{
           comments: getComments(operation),
         }}
       >
-        {formData || ''}
-        <Function.Call
-          name="res"
-          to={<Function name="client" async generics={[typedSchemas.response.name, typedSchemas.request?.name].filter(Boolean)} params={clientParams} />}
-        />
-        <Function.Return>{options.dataReturnType === 'data' ? 'res.data' : 'res'}</Function.Return>
+        {formData}
+        {`const res = await client<${generics.join(', ')}>(${clientParams.toCall()})`}
+        <br />
+        {dataReturnType === 'full' && parser === 'zod' && zodSchemas && `return {...res, data: ${zodSchemas.response.name}.parse(res.data)}`}
+        {dataReturnType === 'data' && parser === 'zod' && zodSchemas && `return ${zodSchemas.response.name}.parse(res.data)`}
+        {dataReturnType === 'full' && parser === 'client' && 'return res'}
+        {dataReturnType === 'data' && parser === 'client' && 'return res.data'}
       </Function>
     </File.Source>
   )
 }
+
+Client.getParams = getParams

package/src/generators/__snapshots__/deletePet.ts

@@ -0,0 +1,13 @@
+/* eslint-disable no-alert, no-console */
+import client from "@kubb/plugin-client/client";
+import type { RequestConfig } from "@kubb/plugin-client/client";
+
+ /**
+ * @description delete a pet
+ * @summary Deletes a pet
+ * @link /pet/:petId
+ */
+export async function deletePet(petId: DeletePetPathParams["petId"], headers?: DeletePetHeaderParams, config: Partial<RequestConfig> = {}) {
+    const res = await client<DeletePetMutationResponse, DeletePet400, unknown>({ method: "DELETE", url: `/pet/${petId}`, headers: { ...headers, ...config.headers }, ...config });
+    return res.data;
+}

package/src/generators/__snapshots__/deletePetObject.ts

@@ -0,0 +1,13 @@
+/* eslint-disable no-alert, no-console */
+import client from "@kubb/plugin-client/client";
+import type { RequestConfig } from "@kubb/plugin-client/client";
+
+ /**
+ * @description delete a pet
+ * @summary Deletes a pet
+ * @link /pet/:petId
+ */
+export async function deletePet({ petId }: DeletePetPathParams, headers?: DeletePetHeaderParams, config: Partial<RequestConfig> = {}) {
+    const res = await client<DeletePetMutationResponse, DeletePet400, unknown>({ method: "DELETE", url: `/pet/${petId}`, headers: { ...headers, ...config.headers }, ...config });
+    return res.data;
+}

package/src/generators/__snapshots__/findByTags.ts

@@ -0,0 +1,13 @@
+/* eslint-disable no-alert, no-console */
+import client from "@kubb/plugin-client/client";
+import type { RequestConfig } from "@kubb/plugin-client/client";
+
+ /**
+ * @description Multiple tags can be provided with comma separated strings. Use tag1, tag2, tag3 for testing.
+ * @summary Finds Pets by tags
+ * @link /pet/findByTags
+ */
+export async function findPetsByTags(params?: FindPetsByTagsQueryParams, config: Partial<RequestConfig> = {}) {
+    const res = await client<FindPetsByTagsQueryResponse, FindPetsByTags400, unknown>({ method: "GET", url: `/pet/findByTags`, params, ...config });
+    return res.data;
+}

package/src/generators/__snapshots__/findByTagsFull.ts

@@ -0,0 +1,13 @@
+/* eslint-disable no-alert, no-console */
+import client from "@kubb/plugin-client/client";
+import type { RequestConfig } from "@kubb/plugin-client/client";
+
+ /**
+ * @description Multiple tags can be provided with comma separated strings. Use tag1, tag2, tag3 for testing.
+ * @summary Finds Pets by tags
+ * @link /pet/findByTags
+ */
+export async function findPetsByTags(params?: FindPetsByTagsQueryParams, config: Partial<RequestConfig> = {}) {
+    const res = await client<FindPetsByTagsQueryResponse, FindPetsByTags400, unknown>({ method: "GET", url: `/pet/findByTags`, params, ...config });
+    return res;
+}

package/src/generators/__snapshots__/findByTagsObject.ts

@@ -0,0 +1,15 @@
+/* eslint-disable no-alert, no-console */
+import client from "@kubb/plugin-client/client";
+import type { RequestConfig } from "@kubb/plugin-client/client";
+
+ /**
+ * @description Multiple tags can be provided with comma separated strings. Use tag1, tag2, tag3 for testing.
+ * @summary Finds Pets by tags
+ * @link /pet/findByTags
+ */
+export async function findPetsByTags({ params }: {
+    params?: FindPetsByTagsQueryParams;
+}, config: Partial<RequestConfig> = {}) {
+    const res = await client<FindPetsByTagsQueryResponse, FindPetsByTags400, unknown>({ method: "GET", url: `/pet/findByTags`, params, ...config });
+    return res.data;
+}

package/src/generators/__snapshots__/findByTagsWithZod.ts

@@ -0,0 +1,13 @@
+/* eslint-disable no-alert, no-console */
+import client from "@kubb/plugin-client/client";
+import type { RequestConfig } from "@kubb/plugin-client/client";
+
+ /**
+ * @description Multiple tags can be provided with comma separated strings. Use tag1, tag2, tag3 for testing.
+ * @summary Finds Pets by tags
+ * @link /pet/findByTags
+ */
+export async function findPetsByTags(params?: FindPetsByTagsQueryParams, config: Partial<RequestConfig> = {}) {
+    const res = await client<FindPetsByTagsQueryResponse, FindPetsByTags400, unknown>({ method: "GET", url: `/pet/findByTags`, params, ...config });
+    return findPetsByTagsQueryResponse.parse(res.data);
+}

package/src/generators/__snapshots__/findByTagsWithZodFull.ts

@@ -0,0 +1,13 @@
+/* eslint-disable no-alert, no-console */
+import client from "@kubb/plugin-client/client";
+import type { RequestConfig } from "@kubb/plugin-client/client";
+
+ /**
+ * @description Multiple tags can be provided with comma separated strings. Use tag1, tag2, tag3 for testing.
+ * @summary Finds Pets by tags
+ * @link /pet/findByTags
+ */
+export async function findPetsByTags(params?: FindPetsByTagsQueryParams, config: Partial<RequestConfig> = {}) {
+    const res = await client<FindPetsByTagsQueryResponse, FindPetsByTags400, unknown>({ method: "GET", url: `/pet/findByTags`, params, ...config });
+    return { ...res, data: findPetsByTagsQueryResponse.parse(res.data) };
+}

package/src/generators/__snapshots__/importPath.ts

@@ -0,0 +1,13 @@
+/* eslint-disable no-alert, no-console */
+import client from "axios";
+import type { RequestConfig } from "axios";
+
+ /**
+ * @description Multiple tags can be provided with comma separated strings. Use tag1, tag2, tag3 for testing.
+ * @summary Finds Pets by tags
+ * @link /pet/findByTags
+ */
+export async function findPetsByTags(params?: FindPetsByTagsQueryParams, config: Partial<RequestConfig> = {}) {
+    const res = await client<FindPetsByTagsQueryResponse, FindPetsByTags400, unknown>({ method: "GET", url: `/pet/findByTags`, params, ...config });
+    return res.data;
+}

package/src/generators/__snapshots__/operations.ts

@@ -0,0 +1,82 @@
+export const operations = {
+    "updatePet": {
+        "path": "/pet",
+        "method": "put"
+    },
+    "addPet": {
+        "path": "/pet",
+        "method": "post"
+    },
+    "findPetsByStatus": {
+        "path": "/pet/findByStatus",
+        "method": "get"
+    },
+    "findPetsByTags": {
+        "path": "/pet/findByTags",
+        "method": "get"
+    },
+    "getPetById": {
+        "path": "/pet/:petId",
+        "method": "get"
+    },
+    "updatePetWithForm": {
+        "path": "/pet/:petId",
+        "method": "post"
+    },
+    "deletePet": {
+        "path": "/pet/:petId",
+        "method": "delete"
+    },
+    "uploadFile": {
+        "path": "/pet/:petId/uploadImage",
+        "method": "post"
+    },
+    "getInventory": {
+        "path": "/store/inventory",
+        "method": "get"
+    },
+    "placeOrder": {
+        "path": "/store/order",
+        "method": "post"
+    },
+    "placeOrderPatch": {
+        "path": "/store/order",
+        "method": "patch"
+    },
+    "getOrderById": {
+        "path": "/store/order/:orderId",
+        "method": "get"
+    },
+    "deleteOrder": {
+        "path": "/store/order/:orderId",
+        "method": "delete"
+    },
+    "createUser": {
+        "path": "/user",
+        "method": "post"
+    },
+    "createUsersWithListInput": {
+        "path": "/user/createWithList",
+        "method": "post"
+    },
+    "loginUser": {
+        "path": "/user/login",
+        "method": "get"
+    },
+    "logoutUser": {
+        "path": "/user/logout",
+        "method": "get"
+    },
+    "getUserByName": {
+        "path": "/user/:username",
+        "method": "get"
+    },
+    "updateUser": {
+        "path": "/user/:username",
+        "method": "put"
+    },
+    "deleteUser": {
+        "path": "/user/:username",
+        "method": "delete"
+    }
+} as const;

package/src/generators/__snapshots__/updatePetById.ts

@@ -0,0 +1,12 @@
+/* eslint-disable no-alert, no-console */
+import client from "@kubb/plugin-client/client";
+import type { RequestConfig } from "@kubb/plugin-client/client";
+
+ /**
+ * @summary Updates a pet in the store with form data
+ * @link /pet/:petId
+ */
+export async function updatePetWithForm(petId: UpdatePetWithFormPathParams["petId"], params?: UpdatePetWithFormQueryParams, config: Partial<RequestConfig> = {}) {
+    const res = await client<UpdatePetWithFormMutationResponse, UpdatePetWithForm405, unknown>({ method: "POST", url: `/pet/${petId}`, params, ...config });
+    return res.data;
+}