@kubb/plugin-react-query 4.14.1 → 4.15.0

package/src/generators/__snapshots__/findByTagsWithCustomOptions.ts

@@ -0,0 +1,89 @@
+/**
+ * Generated by Kubb (https://kubb.dev/).
+ * Do not edit manually.
+ */
+import type { RequestConfig, ResponseErrorConfig } from './test/.kubb/fetch'
+import type { QueryKey, QueryClient, QueryObserverOptions, UseQueryResult } from '@tanstack/react-query'
+import { fetch } from './test/.kubb/fetch'
+import { queryOptions, useQuery } from '@tanstack/react-query'
+import { useCustomHookOptions } from 'useCustomHookOptions.ts'
+
+export const findPetsByTagsQueryKey = (params?: FindPetsByTagsQueryParams) => [{ url: '/pet/findByTags' }, ...(params ? [params] : [])] as const
+
+export type FindPetsByTagsQueryKey = ReturnType<typeof findPetsByTagsQueryKey>
+
+/**
+ * @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(
+  headers: FindPetsByTagsHeaderParams,
+  params?: FindPetsByTagsQueryParams,
+  config: Partial<RequestConfig> & { client?: typeof fetch } = {},
+) {
+  const { client: request = fetch, ...requestConfig } = config
+
+  const res = await request<FindPetsByTagsQueryResponse, ResponseErrorConfig<FindPetsByTags400>, unknown>({
+    method: 'GET',
+    url: `/pet/findByTags`,
+    params,
+    ...requestConfig,
+    headers: { ...headers, ...requestConfig.headers },
+  })
+  return findPetsByTagsQueryResponse.parse(res.data)
+}
+
+export function findPetsByTagsQueryOptions(
+  headers: FindPetsByTagsHeaderParams,
+  params?: FindPetsByTagsQueryParams,
+  config: Partial<RequestConfig> & { client?: typeof fetch } = {},
+) {
+  const queryKey = findPetsByTagsQueryKey(params)
+  return queryOptions<FindPetsByTagsQueryResponse, ResponseErrorConfig<FindPetsByTags400>, FindPetsByTagsQueryResponse, typeof queryKey>({
+    queryKey,
+    queryFn: async ({ signal }) => {
+      config.signal = signal
+      return findPetsByTags(headers, 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<
+  TData = FindPetsByTagsQueryResponse,
+  TQueryData = FindPetsByTagsQueryResponse,
+  TQueryKey extends QueryKey = FindPetsByTagsQueryKey,
+>(
+  headers: FindPetsByTagsHeaderParams,
+  params?: FindPetsByTagsQueryParams,
+  options: {
+    query?: Partial<QueryObserverOptions<FindPetsByTagsQueryResponse, ResponseErrorConfig<FindPetsByTags400>, TData, TQueryData, TQueryKey>> & {
+      client?: QueryClient
+    }
+    client?: Partial<RequestConfig> & { client?: typeof fetch }
+  } = {},
+) {
+  const { query: queryConfig = {}, client: config = {} } = options ?? {}
+  const { client: queryClient, ...queryOptions } = queryConfig
+  const queryKey = queryOptions?.queryKey ?? findPetsByTagsQueryKey(params)
+  const customOptions = useCustomHookOptions({ hookName: 'useFindPetsByTags', operationId: 'findPetsByTags' })
+
+  const query = useQuery(
+    {
+      ...findPetsByTagsQueryOptions(headers, params, config),
+      ...customOptions,
+      queryKey,
+      ...queryOptions,
+    } as unknown as QueryObserverOptions,
+    queryClient,
+  ) as UseQueryResult<TData, ResponseErrorConfig<FindPetsByTags400>> & { queryKey: TQueryKey }
+
+  query.queryKey = queryKey as TQueryKey
+
+  return query
+}

package/src/generators/__snapshots__/findInfiniteByTagsWithCustomOptions.ts

@@ -0,0 +1,103 @@
+/**
+ * Generated by Kubb (https://kubb.dev/).
+ * Do not edit manually.
+ */
+import type { RequestConfig, ResponseErrorConfig } from './test/.kubb/fetch'
+import type { InfiniteData, QueryKey, QueryClient, InfiniteQueryObserverOptions, UseInfiniteQueryResult } from '@tanstack/react-query'
+import { fetch } from './test/.kubb/fetch'
+import { infiniteQueryOptions, useInfiniteQuery } from '@tanstack/react-query'
+import { useCustomHookOptions } from 'useCustomHookOptions.ts'
+
+export const findPetsByTagsInfiniteQueryKey = (params?: FindPetsByTagsQueryParams) => [{ url: '/pet/findByTags' }, ...(params ? [params] : [])] as const
+
+export type FindPetsByTagsInfiniteQueryKey = ReturnType<typeof findPetsByTagsInfiniteQueryKey>
+
+/**
+ * @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 findPetsByTagsInfinite(
+  headers: FindPetsByTagsHeaderParams,
+  params?: FindPetsByTagsQueryParams,
+  config: Partial<RequestConfig> & { client?: typeof fetch } = {},
+) {
+  const { client: request = fetch, ...requestConfig } = config
+
+  const res = await request<FindPetsByTagsQueryResponse, ResponseErrorConfig<FindPetsByTags400>, unknown>({
+    method: 'GET',
+    url: `/pet/findByTags`,
+    params,
+    ...requestConfig,
+    headers: { ...headers, ...requestConfig.headers },
+  })
+  return findPetsByTagsQueryResponse.parse(res.data)
+}
+
+export function findPetsByTagsInfiniteQueryOptions(
+  headers: FindPetsByTagsHeaderParams,
+  params?: FindPetsByTagsQueryParams,
+  config: Partial<RequestConfig> & { client?: typeof fetch } = {},
+) {
+  const queryKey = findPetsByTagsInfiniteQueryKey(params)
+  return infiniteQueryOptions<
+    FindPetsByTagsQueryResponse,
+    ResponseErrorConfig<FindPetsByTags400>,
+    InfiniteData<FindPetsByTagsQueryResponse>,
+    typeof queryKey,
+    NonNullable<FindPetsByTagsQueryParams['pageSize']>
+  >({
+    queryKey,
+    queryFn: async ({ signal, pageParam }) => {
+      config.signal = signal
+
+      params = {
+        ...(params ?? {}),
+        ['pageSize']: pageParam as unknown as FindPetsByTagsQueryParams['pageSize'],
+      } as FindPetsByTagsQueryParams
+      return findPetsByTagsInfinite(headers, params, config)
+    },
+    initialPageParam: 0,
+    getNextPageParam: (lastPage, _allPages, lastPageParam) => (Array.isArray(lastPage) && lastPage.length === 0 ? undefined : lastPageParam + 1),
+    getPreviousPageParam: (_firstPage, _allPages, firstPageParam) => (firstPageParam <= 1 ? undefined : firstPageParam - 1),
+  })
+}
+
+/**
+ * @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 useFindPetsByTagsInfinite<
+  TQueryFnData = FindPetsByTagsQueryResponse,
+  TError = ResponseErrorConfig<FindPetsByTags400>,
+  TData = InfiniteData<TQueryFnData>,
+  TQueryKey extends QueryKey = FindPetsByTagsInfiniteQueryKey,
+  TPageParam = NonNullable<FindPetsByTagsQueryParams['pageSize']>,
+>(
+  headers: FindPetsByTagsHeaderParams,
+  params?: FindPetsByTagsQueryParams,
+  options: {
+    query?: Partial<InfiniteQueryObserverOptions<TQueryFnData, TError, TData, TQueryKey, TPageParam>> & { client?: QueryClient }
+    client?: Partial<RequestConfig> & { client?: typeof fetch }
+  } = {},
+) {
+  const { query: queryConfig = {}, client: config = {} } = options ?? {}
+  const { client: queryClient, ...queryOptions } = queryConfig
+  const queryKey = queryOptions?.queryKey ?? findPetsByTagsInfiniteQueryKey(params)
+  const customOptions = useCustomHookOptions({ hookName: 'useFindPetsByTagsInfinite', operationId: 'findPetsByTags' })
+
+  const query = useInfiniteQuery(
+    {
+      ...findPetsByTagsInfiniteQueryOptions(headers, params, config),
+      ...customOptions,
+      queryKey,
+      ...queryOptions,
+    } as unknown as InfiniteQueryObserverOptions<TQueryFnData, TError, TData, TQueryKey, TPageParam>,
+    queryClient,
+  ) as UseInfiniteQueryResult<TData, TError> & { queryKey: TQueryKey }
+
+  query.queryKey = queryKey as TQueryKey
+
+  return query
+}

package/src/generators/__snapshots__/findSuspenseByTagsWithCustomOptions.ts

@@ -0,0 +1,83 @@
+/**
+ * Generated by Kubb (https://kubb.dev/).
+ * Do not edit manually.
+ */
+import type { RequestConfig, ResponseErrorConfig } from './test/.kubb/fetch'
+import type { QueryKey, QueryClient, UseSuspenseQueryOptions, UseSuspenseQueryResult } from '@tanstack/react-query'
+import { fetch } from './test/.kubb/fetch'
+import { queryOptions, useSuspenseQuery } from '@tanstack/react-query'
+import { useCustomHookOptions } from 'useCustomHookOptions.ts'
+
+export const findPetsByTagsSuspenseQueryKey = (params?: FindPetsByTagsQueryParams) => [{ url: '/pet/findByTags' }, ...(params ? [params] : [])] as const
+
+export type FindPetsByTagsSuspenseQueryKey = ReturnType<typeof findPetsByTagsSuspenseQueryKey>
+
+/**
+ * @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 findPetsByTagsSuspense(
+  headers: FindPetsByTagsHeaderParams,
+  params?: FindPetsByTagsQueryParams,
+  config: Partial<RequestConfig> & { client?: typeof fetch } = {},
+) {
+  const { client: request = fetch, ...requestConfig } = config
+
+  const res = await request<FindPetsByTagsQueryResponse, ResponseErrorConfig<FindPetsByTags400>, unknown>({
+    method: 'GET',
+    url: `/pet/findByTags`,
+    params,
+    ...requestConfig,
+    headers: { ...headers, ...requestConfig.headers },
+  })
+  return findPetsByTagsQueryResponse.parse(res.data)
+}
+
+export function findPetsByTagsSuspenseQueryOptions(
+  headers: FindPetsByTagsHeaderParams,
+  params?: FindPetsByTagsQueryParams,
+  config: Partial<RequestConfig> & { client?: typeof fetch } = {},
+) {
+  const queryKey = findPetsByTagsSuspenseQueryKey(params)
+  return queryOptions<FindPetsByTagsQueryResponse, ResponseErrorConfig<FindPetsByTags400>, FindPetsByTagsQueryResponse, typeof queryKey>({
+    queryKey,
+    queryFn: async ({ signal }) => {
+      config.signal = signal
+      return findPetsByTagsSuspense(headers, 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 useFindPetsByTagsSuspense<TData = FindPetsByTagsQueryResponse, TQueryKey extends QueryKey = FindPetsByTagsSuspenseQueryKey>(
+  headers: FindPetsByTagsHeaderParams,
+  params?: FindPetsByTagsQueryParams,
+  options: {
+    query?: Partial<UseSuspenseQueryOptions<FindPetsByTagsQueryResponse, ResponseErrorConfig<FindPetsByTags400>, TData, TQueryKey>> & { client?: QueryClient }
+    client?: Partial<RequestConfig> & { client?: typeof fetch }
+  } = {},
+) {
+  const { query: queryConfig = {}, client: config = {} } = options ?? {}
+  const { client: queryClient, ...queryOptions } = queryConfig
+  const queryKey = queryOptions?.queryKey ?? findPetsByTagsSuspenseQueryKey(params)
+  const customOptions = useCustomHookOptions({ hookName: 'useFindPetsByTagsSuspense', operationId: 'findPetsByTags' })
+
+  const query = useSuspenseQuery(
+    {
+      ...findPetsByTagsSuspenseQueryOptions(headers, params, config),
+      ...customOptions,
+      queryKey,
+      ...queryOptions,
+    } as unknown as UseSuspenseQueryOptions,
+    queryClient,
+  ) as UseSuspenseQueryResult<TData, ResponseErrorConfig<FindPetsByTags400>> & { queryKey: TQueryKey }
+
+  query.queryKey = queryKey as TQueryKey
+
+  return query
+}

package/src/generators/__snapshots__/findSuspenseInfiniteByTagsWithCustomOptions.ts

@@ -0,0 +1,103 @@
+/**
+ * Generated by Kubb (https://kubb.dev/).
+ * Do not edit manually.
+ */
+import type { RequestConfig, ResponseErrorConfig } from './test/.kubb/fetch'
+import type { InfiniteData, QueryKey, QueryClient, UseSuspenseInfiniteQueryOptions, UseSuspenseInfiniteQueryResult } from '@tanstack/react-query'
+import { fetch } from './test/.kubb/fetch'
+import { infiniteQueryOptions, useSuspenseInfiniteQuery } from '@tanstack/react-query'
+import { useCustomHookOptions } from 'useCustomHookOptions.ts'
+
+export const findPetsByTagsSuspenseInfiniteQueryKey = (params?: FindPetsByTagsQueryParams) => [{ url: '/pet/findByTags' }, ...(params ? [params] : [])] as const
+
+export type FindPetsByTagsSuspenseInfiniteQueryKey = ReturnType<typeof findPetsByTagsSuspenseInfiniteQueryKey>
+
+/**
+ * @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 findPetsByTagsSuspenseInfinite(
+  headers: FindPetsByTagsHeaderParams,
+  params?: FindPetsByTagsQueryParams,
+  config: Partial<RequestConfig> & { client?: typeof fetch } = {},
+) {
+  const { client: request = fetch, ...requestConfig } = config
+
+  const res = await request<FindPetsByTagsQueryResponse, ResponseErrorConfig<FindPetsByTags400>, unknown>({
+    method: 'GET',
+    url: `/pet/findByTags`,
+    params,
+    ...requestConfig,
+    headers: { ...headers, ...requestConfig.headers },
+  })
+  return findPetsByTagsQueryResponse.parse(res.data)
+}
+
+export function findPetsByTagsSuspenseInfiniteQueryOptions(
+  headers: FindPetsByTagsHeaderParams,
+  params?: FindPetsByTagsQueryParams,
+  config: Partial<RequestConfig> & { client?: typeof fetch } = {},
+) {
+  const queryKey = findPetsByTagsSuspenseInfiniteQueryKey(params)
+  return infiniteQueryOptions<
+    FindPetsByTagsQueryResponse,
+    ResponseErrorConfig<FindPetsByTags400>,
+    InfiniteData<FindPetsByTagsQueryResponse>,
+    typeof queryKey,
+    NonNullable<FindPetsByTagsQueryParams['pageSize']>
+  >({
+    queryKey,
+    queryFn: async ({ signal, pageParam }) => {
+      config.signal = signal
+
+      params = {
+        ...(params ?? {}),
+        ['pageSize']: pageParam as unknown as FindPetsByTagsQueryParams['pageSize'],
+      } as FindPetsByTagsQueryParams
+      return findPetsByTagsSuspenseInfinite(headers, params, config)
+    },
+    initialPageParam: 0,
+    getNextPageParam: (lastPage, _allPages, lastPageParam) => (Array.isArray(lastPage) && lastPage.length === 0 ? undefined : lastPageParam + 1),
+    getPreviousPageParam: (_firstPage, _allPages, firstPageParam) => (firstPageParam <= 1 ? undefined : firstPageParam - 1),
+  })
+}
+
+/**
+ * @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 useFindPetsByTagsSuspenseInfinite<
+  TQueryFnData = FindPetsByTagsQueryResponse,
+  TError = ResponseErrorConfig<FindPetsByTags400>,
+  TData = InfiniteData<TQueryFnData>,
+  TQueryKey extends QueryKey = FindPetsByTagsSuspenseInfiniteQueryKey,
+  TPageParam = NonNullable<FindPetsByTagsQueryParams['pageSize']>,
+>(
+  headers: FindPetsByTagsHeaderParams,
+  params?: FindPetsByTagsQueryParams,
+  options: {
+    query?: Partial<UseSuspenseInfiniteQueryOptions<TQueryFnData, TError, TData, TQueryKey, TPageParam>> & { client?: QueryClient }
+    client?: Partial<RequestConfig> & { client?: typeof fetch }
+  } = {},
+) {
+  const { query: queryConfig = {}, client: config = {} } = options ?? {}
+  const { client: queryClient, ...queryOptions } = queryConfig
+  const queryKey = queryOptions?.queryKey ?? findPetsByTagsSuspenseInfiniteQueryKey(params)
+  const customOptions = useCustomHookOptions({ hookName: 'useFindPetsByTagsSuspenseInfinite', operationId: 'findPetsByTags' })
+
+  const query = useSuspenseInfiniteQuery(
+    {
+      ...findPetsByTagsSuspenseInfiniteQueryOptions(headers, params, config),
+      ...customOptions,
+      queryKey,
+      ...queryOptions,
+    } as unknown as UseSuspenseInfiniteQueryOptions<TQueryFnData, TError, TData, TQueryKey, TPageParam>,
+    queryClient,
+  ) as UseSuspenseInfiniteQueryResult<TData, TError> & { queryKey: TQueryKey }
+
+  query.queryKey = queryKey as TQueryKey
+
+  return query
+}

package/src/generators/__snapshots__/updatePetByIdWithCustomOptions.ts

@@ -0,0 +1,105 @@
+/**
+ * Generated by Kubb (https://kubb.dev/).
+ * Do not edit manually.
+ */
+import type { RequestConfig, ResponseErrorConfig } from './test/.kubb/fetch'
+import type { UseMutationOptions, UseMutationResult, QueryClient } from '@tanstack/react-query'
+import { fetch } from './test/.kubb/fetch'
+import { mutationOptions, useMutation } from '@tanstack/react-query'
+import { useCustomHookOptions } from 'useCustomHookOptions.ts'
+
+export const updatePetWithFormMutationKey = () => [{ url: '/pet/:pet_id' }] as const
+
+export type UpdatePetWithFormMutationKey = ReturnType<typeof updatePetWithFormMutationKey>
+
+/**
+ * @summary Updates a pet in the store with form data
+ * {@link /pet/:pet_id}
+ */
+export async function updatePetWithForm(
+  petId: UpdatePetWithFormPathParams['petId'],
+  data?: UpdatePetWithFormMutationRequest,
+  params?: UpdatePetWithFormQueryParams,
+  config: Partial<RequestConfig<UpdatePetWithFormMutationRequest>> & { client?: typeof fetch } = {},
+) {
+  const { client: request = fetch, ...requestConfig } = config
+
+  const requestData = updatePetWithFormMutationRequest.parse(data)
+
+  const res = await request<UpdatePetWithFormMutationResponse, ResponseErrorConfig<UpdatePetWithForm405>, UpdatePetWithFormMutationRequest>({
+    method: 'POST',
+    url: `/pet/${pet_id}`,
+    params,
+    data: requestData,
+    ...requestConfig,
+  })
+  return updatePetWithFormMutationResponse.parse(res.data)
+}
+
+export function updatePetWithFormMutationOptions(config: Partial<RequestConfig<UpdatePetWithFormMutationRequest>> & { client?: typeof fetch } = {}) {
+  const mutationKey = updatePetWithFormMutationKey()
+  return mutationOptions<
+    UpdatePetWithFormMutationResponse,
+    ResponseErrorConfig<UpdatePetWithForm405>,
+    { petId: UpdatePetWithFormPathParams['petId']; data?: UpdatePetWithFormMutationRequest; params?: UpdatePetWithFormQueryParams },
+    typeof mutationKey
+  >({
+    mutationKey,
+    mutationFn: async ({ petId, data, params }) => {
+      return updatePetWithForm(petId, data, params, config)
+    },
+  })
+}
+
+/**
+ * @summary Updates a pet in the store with form data
+ * {@link /pet/:pet_id}
+ */
+export function useUpdatePetWithForm<TContext>(
+  options: {
+    mutation?: UseMutationOptions<
+      UpdatePetWithFormMutationResponse,
+      ResponseErrorConfig<UpdatePetWithForm405>,
+      { petId: UpdatePetWithFormPathParams['petId']; data?: UpdatePetWithFormMutationRequest; params?: UpdatePetWithFormQueryParams },
+      TContext
+    > & { client?: QueryClient }
+    client?: Partial<RequestConfig<UpdatePetWithFormMutationRequest>> & { client?: typeof fetch }
+  } = {},
+) {
+  const { mutation = {}, client: config = {} } = options ?? {}
+  const { client: queryClient, ...mutationOptions } = mutation
+  const mutationKey = mutationOptions.mutationKey ?? updatePetWithFormMutationKey()
+
+  const baseOptions = updatePetWithFormMutationOptions(config) as UseMutationOptions<
+    UpdatePetWithFormMutationResponse,
+    ResponseErrorConfig<UpdatePetWithForm405>,
+    { petId: UpdatePetWithFormPathParams['petId']; data?: UpdatePetWithFormMutationRequest; params?: UpdatePetWithFormQueryParams },
+    TContext
+  >
+  const customOptions = useCustomHookOptions({ hookName: 'useUpdatePetWithForm', operationId: 'updatePetWithForm' }) as UseMutationOptions<
+    UpdatePetWithFormMutationResponse,
+    ResponseErrorConfig<UpdatePetWithForm405>,
+    { petId: UpdatePetWithFormPathParams['petId']; data?: UpdatePetWithFormMutationRequest; params?: UpdatePetWithFormQueryParams },
+    TContext
+  >
+
+  return useMutation<
+    UpdatePetWithFormMutationResponse,
+    ResponseErrorConfig<UpdatePetWithForm405>,
+    { petId: UpdatePetWithFormPathParams['petId']; data?: UpdatePetWithFormMutationRequest; params?: UpdatePetWithFormQueryParams },
+    TContext
+  >(
+    {
+      ...baseOptions,
+      ...customOptions,
+      mutationKey,
+      ...mutationOptions,
+    },
+    queryClient,
+  ) as UseMutationResult<
+    UpdatePetWithFormMutationResponse,
+    ResponseErrorConfig<UpdatePetWithForm405>,
+    { petId: UpdatePetWithFormPathParams['petId']; data?: UpdatePetWithFormMutationRequest; params?: UpdatePetWithFormQueryParams },
+    TContext
+  >
+}

package/src/generators/customHookOptionsFileGenerator.tsx

@@ -0,0 +1,98 @@
+import fs from 'node:fs'
+import path from 'node:path'
+import { usePluginManager } from '@kubb/core/hooks'
+import type { Operation } from '@kubb/oas'
+import { createReactGenerator } from '@kubb/plugin-oas/generators'
+import { useOperationManager } from '@kubb/plugin-oas/hooks'
+import { File, Function } from '@kubb/react-fabric'
+import type { PluginReactQuery } from '../types'
+
+export const customHookOptionsFileGenerator = createReactGenerator<PluginReactQuery>({
+  name: 'react-query-custom-hook-options-file',
+  Operations({ operations, generator, plugin, config }) {
+    const {
+      options,
+      options: { output },
+      key: pluginKey,
+    } = plugin
+    const pluginManager = usePluginManager()
+
+    const { getFile } = useOperationManager(generator)
+
+    if (!options.customOptions) {
+      return null
+    }
+
+    const override = output.override ?? config.output.override ?? false
+    const { importPath, name } = options.customOptions
+
+    const root = path.resolve(config.root, config.output.path)
+
+    const reactQueryImportPath = options.query ? options.query.importPath : '@tanstack/react-query'
+
+    const getHookFilePath = (operations: Operation[]) => {
+      const firstOperation = operations[0]
+      if (firstOperation != null) {
+        // Get the file of the first generated hook
+        return getFile(firstOperation, { prefix: 'use' }).path
+      }
+      // Get the index file of the hooks directory
+      return pluginManager.getFile({ name: 'index', extname: '.ts', pluginKey }).path
+    }
+
+    const ensureExtension = (filePath: string, extname: string) => {
+      if (path.extname(filePath) === '') {
+        return filePath + extname
+      }
+      return filePath
+    }
+
+    const getExternalFile = (filePath: string, rootPath: string) => {
+      const actualFilePath = ensureExtension(filePath, '.ts')
+      return {
+        baseName: path.basename(actualFilePath) as `${string}.${string}`,
+        name: path.basename(actualFilePath, path.extname(actualFilePath)),
+        path: path.resolve(rootPath, actualFilePath),
+      }
+    }
+
+    const basePath = path.dirname(getHookFilePath(operations))
+    const file = getExternalFile(importPath, basePath)
+
+    if (fs.existsSync(file.path) && !override) {
+      return null
+    }
+
+    return (
+      <File baseName={file.baseName} path={file.path}>
+        <File.Import name={['QueryClient']} path={reactQueryImportPath} isTypeOnly />
+        <File.Import name={['useQueryClient']} path={reactQueryImportPath} />
+        <File.Import name={['HookOptions']} root={file.path} path={path.resolve(root, './index.ts')} />
+        <File.Source name={file.name} isExportable isIndexable>
+          <Function name="getCustomHookOptions" params="{ queryClient }: { queryClient: QueryClient }" returnType="Partial<HookOptions>">
+            {`return {
+              // TODO: Define custom hook options here
+              // Example:
+              // useUpdatePetHook: {
+              //   onSuccess: () => {
+              //     void queryClient.invalidateQueries({ queryKey: ['pet'] })
+              //   }
+              // }
+            }`}
+          </Function>
+          <Function
+            name={name}
+            generics="T extends keyof HookOptions"
+            params="{ hookName, operationId }: { hookName: T, operationId: string }"
+            returnType="HookOptions[T]"
+            export
+          >
+            {`const queryClient = useQueryClient()
+            const customOptions = getCustomHookOptions({ queryClient })
+            return customOptions[hookName] ?? {}`}
+          </Function>
+        </File.Source>
+      </File>
+    )
+  },
+})