@kubb/plugin-swr 3.0.0-alpha.2 → 3.0.0-alpha.20

package/src/generators/__snapshots__/clientGetImportPath.ts

@@ -0,0 +1,40 @@
+import client from "axios";
+import useSWR from "swr";
+import type { RequestConfig } from "axios";
+import type { Key, SWRConfiguration } from "swr";
+
+ /**
+ * @description Multiple tags can be provided with comma separated strings. Use tag1, tag2, tag3 for testing.
+ * @summary Finds Pets by tags
+ * @link /pet/findByTags
+ */
+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;
+}
+
+ export function findPetsByTagsQueryOptions(params?: FindPetsByTagsQueryParams, config: Partial<RequestConfig> = {}) {
+    return {
+        fetcher: async () => {
+            return findPetsByTags(params, config);
+        },
+    };
+}
+
+ /**
+ * @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 function useFindPetsByTags(params?: FindPetsByTagsQueryParams, options: {
+    query?: SWRConfiguration<FindPetsByTagsQueryResponse, FindPetsByTags400>;
+    client?: Partial<RequestConfig>;
+    shouldFetch?: boolean;
+} = {}) {
+    const { query: queryOptions, client: config = {}, shouldFetch = true } = options ?? {};
+    const swrKey = [`/pet/findByTags`, params] as const;
+    return useSWR<FindPetsByTagsQueryResponse, FindPetsByTags400, Key>(shouldFetch ? swrKey : null, {
+        ...findPetsByTagsQueryOptions(params, config),
+        ...queryOptions
+    });
+}

package/src/generators/__snapshots__/clientPostImportPath.ts

@@ -0,0 +1,30 @@
+import client from "axios";
+import useSWRMutation from "swr/mutation";
+import type { RequestConfig } from "axios";
+import type { Key } from "swr";
+import type { SWRMutationConfiguration } from "swr/mutation";
+
+ /**
+ * @summary Updates a pet in the store with form data
+ * @link /pet/:petId
+ */
+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;
+}
+
+ /**
+ * @summary Updates a pet in the store with form data
+ * @link /pet/:petId
+ */
+export function useUpdatePetWithForm(petId: UpdatePetWithFormPathParams["petId"], params?: UpdatePetWithFormQueryParams, options: {
+    mutation?: SWRMutationConfiguration<UpdatePetWithFormMutationResponse, UpdatePetWithForm405>;
+    client?: Partial<RequestConfig>;
+    shouldFetch?: boolean;
+} = {}) {
+    const { mutation: mutationOptions, client: config = {}, shouldFetch = true } = options ?? {};
+    const swrKey = [`/pet/${petId}`, params] as const;
+    return useSWRMutation<UpdatePetWithFormMutationResponse, UpdatePetWithForm405, Key>(shouldFetch ? swrKey : null, async (_url) => {
+        return updatePetWithForm(petId, params, config);
+    }, mutationOptions);
+}

package/src/generators/__snapshots__/findByTags.ts

@@ -0,0 +1,40 @@
+import client from "@kubb/plugin-client/client";
+import useSWR from "swr";
+import type { RequestConfig } from "@kubb/plugin-client/client";
+import type { Key, SWRConfiguration } from "swr";
+
+ /**
+ * @description Multiple tags can be provided with comma separated strings. Use tag1, tag2, tag3 for testing.
+ * @summary Finds Pets by tags
+ * @link /pet/findByTags
+ */
+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;
+}
+
+ export function findPetsByTagsQueryOptions(params?: FindPetsByTagsQueryParams, config: Partial<RequestConfig> = {}) {
+    return {
+        fetcher: async () => {
+            return findPetsByTags(params, config);
+        },
+    };
+}
+
+ /**
+ * @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 function useFindPetsByTags(params?: FindPetsByTagsQueryParams, options: {
+    query?: SWRConfiguration<FindPetsByTagsQueryResponse, FindPetsByTags400>;
+    client?: Partial<RequestConfig>;
+    shouldFetch?: boolean;
+} = {}) {
+    const { query: queryOptions, client: config = {}, shouldFetch = true } = options ?? {};
+    const swrKey = [`/pet/findByTags`, params] as const;
+    return useSWR<FindPetsByTagsQueryResponse, FindPetsByTags400, Key>(shouldFetch ? swrKey : null, {
+        ...findPetsByTagsQueryOptions(params, config),
+        ...queryOptions
+    });
+}

package/src/generators/__snapshots__/findByTagsPathParamsObject.ts

@@ -0,0 +1,40 @@
+import client from "@kubb/plugin-client/client";
+import useSWR from "swr";
+import type { RequestConfig } from "@kubb/plugin-client/client";
+import type { Key, SWRConfiguration } from "swr";
+
+ /**
+ * @description Multiple tags can be provided with comma separated strings. Use tag1, tag2, tag3 for testing.
+ * @summary Finds Pets by tags
+ * @link /pet/findByTags
+ */
+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;
+}
+
+ export function findPetsByTagsQueryOptions(params?: FindPetsByTagsQueryParams, config: Partial<RequestConfig> = {}) {
+    return {
+        fetcher: async () => {
+            return findPetsByTags(params, config);
+        },
+    };
+}
+
+ /**
+ * @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 function useFindPetsByTags(params?: FindPetsByTagsQueryParams, options: {
+    query?: SWRConfiguration<FindPetsByTagsQueryResponse, FindPetsByTags400>;
+    client?: Partial<RequestConfig>;
+    shouldFetch?: boolean;
+} = {}) {
+    const { query: queryOptions, client: config = {}, shouldFetch = true } = options ?? {};
+    const swrKey = [`/pet/findByTags`, params] as const;
+    return useSWR<FindPetsByTagsQueryResponse, FindPetsByTags400, Key>(shouldFetch ? swrKey : null, {
+        ...findPetsByTagsQueryOptions(params, config),
+        ...queryOptions
+    });
+}

package/src/generators/__snapshots__/findByTagsWithZod.ts

@@ -0,0 +1,40 @@
+import client from "@kubb/plugin-client/client";
+import useSWR from "swr";
+import type { RequestConfig } from "@kubb/plugin-client/client";
+import type { Key, SWRConfiguration } from "swr";
+
+ /**
+ * @description Multiple tags can be provided with comma separated strings. Use tag1, tag2, tag3 for testing.
+ * @summary Finds Pets by tags
+ * @link /pet/findByTags
+ */
+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);
+}
+
+ export function findPetsByTagsQueryOptions(params?: FindPetsByTagsQueryParams, config: Partial<RequestConfig> = {}) {
+    return {
+        fetcher: async () => {
+            return findPetsByTags(params, config);
+        },
+    };
+}
+
+ /**
+ * @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 function useFindPetsByTags(params?: FindPetsByTagsQueryParams, options: {
+    query?: SWRConfiguration<FindPetsByTagsQueryResponse, FindPetsByTags400>;
+    client?: Partial<RequestConfig>;
+    shouldFetch?: boolean;
+} = {}) {
+    const { query: queryOptions, client: config = {}, shouldFetch = true } = options ?? {};
+    const swrKey = [`/pet/findByTags`, params] as const;
+    return useSWR<FindPetsByTagsQueryResponse, FindPetsByTags400, Key>(shouldFetch ? swrKey : null, {
+        ...findPetsByTagsQueryOptions(params, config),
+        ...queryOptions
+    });
+}

package/src/generators/__snapshots__/getAsMutation.ts

@@ -0,0 +1,32 @@
+import client from "@kubb/plugin-client/client";
+import useSWRMutation from "custom-swr/mutation";
+import type { RequestConfig } from "@kubb/plugin-client/client";
+import type { SWRMutationConfiguration } from "custom-swr/mutation";
+import type { Key } from "swr";
+
+ /**
+ * @description Multiple tags can be provided with comma separated strings. Use tag1, tag2, tag3 for testing.
+ * @summary Finds Pets by tags
+ * @link /pet/findByTags
+ */
+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;
+}
+
+ /**
+ * @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 function useFindPetsByTags(params?: FindPetsByTagsQueryParams, options: {
+    mutation?: SWRMutationConfiguration<FindPetsByTagsQueryResponse, FindPetsByTags400>;
+    client?: Partial<RequestConfig>;
+    shouldFetch?: boolean;
+} = {}) {
+    const { mutation: mutationOptions, client: config = {}, shouldFetch = true } = options ?? {};
+    const swrKey = [`/pet/findByTags`, params] as const;
+    return useSWRMutation<FindPetsByTagsQueryResponse, FindPetsByTags400, Key>(shouldFetch ? swrKey : null, async (_url) => {
+        return findPetsByTags(params, config);
+    }, mutationOptions);
+}

package/src/generators/__snapshots__/postAsQuery.ts

@@ -0,0 +1,39 @@
+import client from "@kubb/plugin-client/client";
+import useSWR from "custom-swr";
+import type { RequestConfig } from "@kubb/plugin-client/client";
+import type { SWRConfiguration } from "custom-swr";
+import type { Key } from "swr";
+
+ /**
+ * @summary Updates a pet in the store with form data
+ * @link /pet/:petId
+ */
+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;
+}
+
+ export function updatePetWithFormQueryOptions(petId: UpdatePetWithFormPathParams["petId"], params?: UpdatePetWithFormQueryParams, config: Partial<RequestConfig> = {}) {
+    return {
+        fetcher: async () => {
+            return updatePetWithForm(petId, params, config);
+        },
+    };
+}
+
+ /**
+ * @summary Updates a pet in the store with form data
+ * @link /pet/:petId
+ */
+export function useUpdatePetWithForm(petId: UpdatePetWithFormPathParams["petId"], params?: UpdatePetWithFormQueryParams, options: {
+    query?: SWRConfiguration<UpdatePetWithFormMutationResponse, UpdatePetWithForm405>;
+    client?: Partial<RequestConfig>;
+    shouldFetch?: boolean;
+} = {}) {
+    const { query: queryOptions, client: config = {}, shouldFetch = true } = options ?? {};
+    const swrKey = [`/pet/${petId}`, params] as const;
+    return useSWR<UpdatePetWithFormMutationResponse, UpdatePetWithForm405, Key>(shouldFetch ? swrKey : null, {
+        ...updatePetWithFormQueryOptions(petId, params, config),
+        ...queryOptions
+    });
+}

package/src/generators/__snapshots__/updatePetById.ts

@@ -0,0 +1,30 @@
+import client from "@kubb/plugin-client/client";
+import useSWRMutation from "swr/mutation";
+import type { RequestConfig } from "@kubb/plugin-client/client";
+import type { Key } from "swr";
+import type { SWRMutationConfiguration } from "swr/mutation";
+
+ /**
+ * @summary Updates a pet in the store with form data
+ * @link /pet/:petId
+ */
+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;
+}
+
+ /**
+ * @summary Updates a pet in the store with form data
+ * @link /pet/:petId
+ */
+export function useUpdatePetWithForm(petId: UpdatePetWithFormPathParams["petId"], params?: UpdatePetWithFormQueryParams, options: {
+    mutation?: SWRMutationConfiguration<UpdatePetWithFormMutationResponse, UpdatePetWithForm405>;
+    client?: Partial<RequestConfig>;
+    shouldFetch?: boolean;
+} = {}) {
+    const { mutation: mutationOptions, client: config = {}, shouldFetch = true } = options ?? {};
+    const swrKey = [`/pet/${petId}`, params] as const;
+    return useSWRMutation<UpdatePetWithFormMutationResponse, UpdatePetWithForm405, Key>(shouldFetch ? swrKey : null, async (_url) => {
+        return updatePetWithForm(petId, params, config);
+    }, mutationOptions);
+}

package/src/generators/__snapshots__/updatePetByIdPathParamsObject.ts

@@ -0,0 +1,34 @@
+import client from "@kubb/plugin-client/client";
+import useSWRMutation from "swr/mutation";
+import type { RequestConfig } from "@kubb/plugin-client/client";
+import type { Key } from "swr";
+import type { SWRMutationConfiguration } from "swr/mutation";
+
+ /**
+ * @summary Updates a pet in the store with form data
+ * @link /pet/:petId
+ */
+async function updatePetWithForm({ petId }: {
+    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;
+}
+
+ /**
+ * @summary Updates a pet in the store with form data
+ * @link /pet/:petId
+ */
+export function useUpdatePetWithForm({ petId }: {
+    petId: UpdatePetWithFormPathParams["petId"];
+}, params?: UpdatePetWithFormQueryParams, options: {
+    mutation?: SWRMutationConfiguration<UpdatePetWithFormMutationResponse, UpdatePetWithForm405>;
+    client?: Partial<RequestConfig>;
+    shouldFetch?: boolean;
+} = {}) {
+    const { mutation: mutationOptions, client: config = {}, shouldFetch = true } = options ?? {};
+    const swrKey = [`/pet/${petId}`, params] as const;
+    return useSWRMutation<UpdatePetWithFormMutationResponse, UpdatePetWithForm405, Key>(shouldFetch ? swrKey : null, async (_url) => {
+        return updatePetWithForm({ petId }, params, config);
+    }, mutationOptions);
+}

package/src/generators/index.ts

@@ -0,0 +1,2 @@
+export { queryGenerator } from './queryGenerator.tsx'
+export { mutationGenerator } from './mutationGenerator.tsx'

package/src/generators/mutationGenerator.tsx

@@ -0,0 +1,96 @@
+import { pluginClientName } from '@kubb/plugin-client'
+import { Client } from '@kubb/plugin-client/components'
+import { createReactGenerator } from '@kubb/plugin-oas'
+import { useOperationManager } from '@kubb/plugin-oas/hooks'
+import { pluginTsName } from '@kubb/plugin-ts'
+import { pluginZodName } from '@kubb/plugin-zod'
+import { File, useApp } from '@kubb/react'
+import { Mutation } from '../components'
+import type { PluginSwr } from '../types'
+
+export const mutationGenerator = createReactGenerator<PluginSwr>({
+  name: 'swr-mutation',
+  Operation({ options, operation }) {
+    const {
+      plugin: {
+        options: { output },
+      },
+    } = useApp<PluginSwr>()
+    const { getSchemas, getName, getFile } = useOperationManager()
+
+    const isMutate = typeof options.query === 'boolean' ? options.mutation : !!options.mutation.methods?.some((method) => operation.method === method)
+
+    const mutation = {
+      name: getName(operation, { type: 'function', prefix: 'use' }),
+      typeName: getName(operation, { type: 'type' }),
+      file: getFile(operation, { prefix: 'use' }),
+    }
+
+    const type = {
+      file: getFile(operation, { pluginKey: [pluginTsName] }),
+      //todo remove type?
+      schemas: getSchemas(operation, { pluginKey: [pluginTsName], type: 'type' }),
+    }
+
+    const zod = {
+      file: getFile(operation, { pluginKey: [pluginZodName] }),
+      schemas: getSchemas(operation, { pluginKey: [pluginZodName], type: 'function' }),
+    }
+
+    const client = {
+      name: getName(operation, { type: 'function', pluginKey: [pluginClientName] }),
+    }
+
+    if (!isMutate) {
+      return null
+    }
+
+    return (
+      <File baseName={mutation.file.baseName} path={mutation.file.path} meta={mutation.file.meta} banner={output?.banner} footer={output?.footer}>
+        {options.parser === 'zod' && (
+          <File.Import extName={output?.extName} name={[zod.schemas.response.name]} root={mutation.file.path} path={zod.file.path} />
+        )}
+        <File.Import name={['Key']} path="swr" isTypeOnly />
+        <File.Import name="useSWRMutation" path={options.mutation.importPath} />
+        <File.Import name={['SWRMutationConfiguration', 'SWRMutationResponse']} path={options.mutation.importPath} isTypeOnly />
+        <File.Import name={'client'} path={options.client.importPath} />
+        <File.Import name={['RequestConfig', 'ResponseConfig']} path={options.client.importPath} isTypeOnly />
+        <File.Import
+          extName={output?.extName}
+          name={[
+            type.schemas.request?.name,
+            type.schemas.response.name,
+            type.schemas.pathParams?.name,
+            type.schemas.queryParams?.name,
+            type.schemas.headerParams?.name,
+            ...(type.schemas.statusCodes?.map((item) => item.name) || []),
+          ].filter(Boolean)}
+          root={mutation.file.path}
+          path={type.file.path}
+          isTypeOnly
+        />
+        <Client
+          name={client.name}
+          isExportable={false}
+          isIndexable={false}
+          baseURL={options.baseURL}
+          operation={operation}
+          typeSchemas={type.schemas}
+          zodSchemas={zod.schemas}
+          dataReturnType={options.client.dataReturnType}
+          pathParamsType={options.pathParamsType}
+          parser={options.parser}
+        />
+        <Mutation
+          name={mutation.name}
+          clientName={client.name}
+          typeName={mutation.typeName}
+          typeSchemas={type.schemas}
+          operation={operation}
+          dataReturnType={options.client.dataReturnType}
+          pathParamsType={options.pathParamsType}
+        />
+      </File>
+    )
+  },
+})

package/src/generators/queryGenerator.tsx

@@ -0,0 +1,101 @@
+import transformers from '@kubb/core/transformers'
+import { pluginClientName } from '@kubb/plugin-client'
+import { Client } from '@kubb/plugin-client/components'
+import { createReactGenerator } from '@kubb/plugin-oas'
+import { useOperationManager } from '@kubb/plugin-oas/hooks'
+import { pluginTsName } from '@kubb/plugin-ts'
+import { pluginZodName } from '@kubb/plugin-zod'
+import { File, useApp } from '@kubb/react'
+import { Query, QueryOptions } from '../components'
+import type { PluginSwr } from '../types'
+
+export const queryGenerator = createReactGenerator<PluginSwr>({
+  name: 'swr-query',
+  Operation({ options, operation }) {
+    const {
+      plugin: {
+        options: { output },
+      },
+    } = useApp<PluginSwr>()
+    const { getSchemas, getName, getFile } = useOperationManager()
+
+    const isQuery = typeof options.query === 'boolean' ? options.query : !!options.query.methods?.some((method) => operation.method === method)
+
+    const query = {
+      name: getName(operation, { type: 'function', prefix: 'use' }),
+      typeName: getName(operation, { type: 'type' }),
+      file: getFile(operation, { prefix: 'use' }),
+    }
+
+    const client = {
+      name: getName(operation, { type: 'function', pluginKey: [pluginClientName] }),
+    }
+
+    const queryOptions = {
+      name: transformers.camelCase(`${operation.getOperationId()} QueryOptions`),
+    }
+
+    const type = {
+      file: getFile(operation, { pluginKey: [pluginTsName] }),
+      //todo remove type?
+      schemas: getSchemas(operation, { pluginKey: [pluginTsName], type: 'type' }),
+    }
+
+    const zod = {
+      file: getFile(operation, { pluginKey: [pluginZodName] }),
+      schemas: getSchemas(operation, { pluginKey: [pluginZodName], type: 'function' }),
+    }
+
+    if (!isQuery) {
+      return null
+    }
+
+    return (
+      <File baseName={query.file.baseName} path={query.file.path} meta={query.file.meta} banner={output?.banner} footer={output?.footer}>
+        {options.parser === 'zod' && <File.Import extName={output?.extName} name={[zod.schemas.response.name]} root={query.file.path} path={zod.file.path} />}
+        <File.Import name={['Key']} path="swr" isTypeOnly />
+        <File.Import name="useSWR" path={options.query.importPath} />
+        <File.Import name={['SWRConfiguration', 'SWRResponse']} path={options.query.importPath} isTypeOnly />
+        <File.Import name={'client'} path={options.client.importPath} />
+        <File.Import name={['RequestConfig']} path={options.client.importPath} isTypeOnly />
+        {options.client.dataReturnType === 'full' && <File.Import name={['ResponseConfig']} path={options.client.importPath} isTypeOnly />}
+
+        <File.Import
+          extName={output?.extName}
+          name={[
+            type.schemas.request?.name,
+            type.schemas.response.name,
+            type.schemas.pathParams?.name,
+            type.schemas.queryParams?.name,
+            type.schemas.headerParams?.name,
+            ...(type.schemas.statusCodes?.map((item) => item.name) || []),
+          ].filter(Boolean)}
+          root={query.file.path}
+          path={type.file.path}
+          isTypeOnly
+        />
+        <Client
+          name={client.name}
+          isExportable={false}
+          isIndexable={false}
+          baseURL={options.baseURL}
+          operation={operation}
+          typeSchemas={type.schemas}
+          zodSchemas={zod.schemas}
+          dataReturnType={options.client.dataReturnType}
+          pathParamsType={options.pathParamsType}
+          parser={options.parser}
+        />
+        <QueryOptions name={queryOptions.name} clientName={client.name} typeSchemas={type.schemas} pathParamsType={options.pathParamsType} />
+        <Query
+          name={query.name}
+          queryOptionsName={queryOptions.name}
+          typeSchemas={type.schemas}
+          pathParamsType={options.pathParamsType}
+          operation={operation}
+          dataReturnType={options.client.dataReturnType}
+        />
+      </File>
+    )
+  },
+})