@kubb/plugin-react-query 5.0.0-alpha.9 → 5.0.0-beta.100

package/src/components/InfiniteQueryOptions.tsx

@@ -1,289 +0,0 @@
-import { getNestedAccessor } from '@internals/utils'
-import { isAllOptional, isOptional } from '@kubb/oas'
-import { Client } from '@kubb/plugin-client/components'
-import type { OperationSchemas } from '@kubb/plugin-oas'
-import { getPathParams } from '@kubb/plugin-oas/utils'
-import { File, Function, FunctionParams } from '@kubb/react-fabric'
-import type { FabricReactNode } from '@kubb/react-fabric/types'
-import type { Infinite, PluginReactQuery } from '../types.ts'
-import { QueryKey } from './QueryKey.tsx'
-
-type Props = {
-  name: string
-  clientName: string
-  queryKeyName: string
-  typeSchemas: OperationSchemas
-  paramsCasing: PluginReactQuery['resolvedOptions']['paramsCasing']
-  paramsType: PluginReactQuery['resolvedOptions']['paramsType']
-  pathParamsType: PluginReactQuery['resolvedOptions']['pathParamsType']
-  dataReturnType: PluginReactQuery['resolvedOptions']['client']['dataReturnType']
-  initialPageParam: Infinite['initialPageParam']
-  cursorParam: Infinite['cursorParam']
-  nextParam: Infinite['nextParam']
-  previousParam: Infinite['previousParam']
-  queryParam: Infinite['queryParam']
-}
-
-type GetParamsProps = {
-  paramsCasing: PluginReactQuery['resolvedOptions']['paramsCasing']
-  paramsType: PluginReactQuery['resolvedOptions']['paramsType']
-  pathParamsType: PluginReactQuery['resolvedOptions']['pathParamsType']
-  typeSchemas: OperationSchemas
-}
-
-function getParams({ paramsType, paramsCasing, pathParamsType, typeSchemas }: GetParamsProps) {
-  if (paramsType === 'object') {
-    const pathParams = getPathParams(typeSchemas.pathParams, { typed: true, casing: paramsCasing })
-
-    const children = {
-      ...pathParams,
-      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,
-    }
-
-    // Check if all children are optional or undefined
-    const allChildrenAreOptional = Object.values(children).every((child) => !child || child.optional)
-
-    return FunctionParams.factory({
-      data: {
-        mode: 'object',
-        children,
-        default: allChildrenAreOptional ? '{}' : undefined,
-      },
-      config: {
-        type: typeSchemas.request?.name
-          ? `Partial<RequestConfig<${typeSchemas.request?.name}>> & { client?: Client }`
-          : 'Partial<RequestConfig> & { client?: Client }',
-        default: '{}',
-      },
-    })
-  }
-
-  return FunctionParams.factory({
-    pathParams: typeSchemas.pathParams?.name
-      ? {
-          mode: pathParamsType === 'object' ? 'object' : 'inlineSpread',
-          children: getPathParams(typeSchemas.pathParams, {
-            typed: true,
-            casing: paramsCasing,
-          }),
-          default: isAllOptional(typeSchemas.pathParams?.schema) ? '{}' : undefined,
-        }
-      : undefined,
-    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}>> & { client?: Client }`
-        : 'Partial<RequestConfig> & { client?: Client }',
-      default: '{}',
-    },
-  })
-}
-
-export function InfiniteQueryOptions({
-  name,
-  clientName,
-  initialPageParam,
-  cursorParam,
-  nextParam,
-  previousParam,
-  typeSchemas,
-  paramsCasing,
-  paramsType,
-  dataReturnType,
-  pathParamsType,
-  queryParam,
-  queryKeyName,
-}: Props): FabricReactNode {
-  const queryFnDataType = dataReturnType === 'data' ? typeSchemas.response.name : `ResponseConfig<${typeSchemas.response.name}>`
-  const errorType = `ResponseErrorConfig<${typeSchemas.errors?.map((item) => item.name).join(' | ') || 'Error'}>`
-  const isInitialPageParamDefined = initialPageParam !== undefined && initialPageParam !== null
-  const fallbackPageParamType =
-    typeof initialPageParam === 'number'
-      ? 'number'
-      : typeof initialPageParam === 'string'
-        ? initialPageParam.includes(' as ')
-          ? (() => {
-              const parts = initialPageParam.split(' as ')
-              return parts[parts.length - 1] ?? 'unknown'
-            })()
-          : 'string'
-        : typeof initialPageParam === 'boolean'
-          ? 'boolean'
-          : 'unknown'
-  const queryParamType = queryParam && typeSchemas.queryParams?.name ? `${typeSchemas.queryParams?.name}['${queryParam}']` : undefined
-  const pageParamType = queryParamType ? (isInitialPageParamDefined ? `NonNullable<${queryParamType}>` : queryParamType) : fallbackPageParamType
-
-  const params = getParams({
-    paramsType,
-    paramsCasing,
-    pathParamsType,
-    typeSchemas,
-  })
-  const clientParams = Client.getParams({
-    paramsCasing,
-    typeSchemas,
-    paramsType,
-    pathParamsType,
-    isConfigurable: true,
-  })
-  const queryKeyParams = QueryKey.getParams({
-    pathParamsType,
-    typeSchemas,
-    paramsCasing,
-  })
-
-  // Determine if we should use the new nextParam/previousParam or fall back to legacy cursorParam behavior
-  const hasNewParams = nextParam !== undefined || previousParam !== undefined
-
-  let getNextPageParamExpr: string | undefined
-  let getPreviousPageParamExpr: string | undefined
-
-  if (hasNewParams) {
-    // Use the new nextParam and previousParam
-    if (nextParam) {
-      const accessor = getNestedAccessor(nextParam, 'lastPage')
-      if (accessor) {
-        getNextPageParamExpr = `getNextPageParam: (lastPage) => ${accessor}`
-      }
-    }
-    if (previousParam) {
-      const accessor = getNestedAccessor(previousParam, 'firstPage')
-      if (accessor) {
-        getPreviousPageParamExpr = `getPreviousPageParam: (firstPage) => ${accessor}`
-      }
-    }
-  } else if (cursorParam) {
-    // Legacy behavior: use cursorParam for both next and previous
-    getNextPageParamExpr = `getNextPageParam: (lastPage) => lastPage['${cursorParam}']`
-    getPreviousPageParamExpr = `getPreviousPageParam: (firstPage) => firstPage['${cursorParam}']`
-  } else {
-    // Fallback behavior: page-based pagination
-    if (dataReturnType === 'full') {
-      getNextPageParamExpr =
-        'getNextPageParam: (lastPage, _allPages, lastPageParam) => Array.isArray(lastPage.data) && lastPage.data.length === 0 ? undefined : lastPageParam + 1'
-    } else {
-      getNextPageParamExpr =
-        'getNextPageParam: (lastPage, _allPages, lastPageParam) => Array.isArray(lastPage) && lastPage.length === 0 ? undefined : lastPageParam + 1'
-    }
-    getPreviousPageParamExpr = 'getPreviousPageParam: (_firstPage, _allPages, firstPageParam) => firstPageParam <= 1 ? undefined : firstPageParam - 1'
-  }
-
-  const queryOptions = [
-    `initialPageParam: ${typeof initialPageParam === 'string' ? JSON.stringify(initialPageParam) : initialPageParam}`,
-    getNextPageParamExpr,
-    getPreviousPageParamExpr,
-  ].filter(Boolean)
-
-  const infiniteOverrideParams =
-    queryParam && typeSchemas.queryParams?.name
-      ? `
-          params = {
-            ...(params ?? {}),
-            ['${queryParam}']: pageParam as unknown as ${typeSchemas.queryParams?.name}['${queryParam}'],
-          } as ${typeSchemas.queryParams?.name}`
-      : ''
-
-  // Only add enabled check for required (non-optional) parameters
-  // Optional parameters with defaults should not prevent query execution
-  const enabled = Object.entries(queryKeyParams.flatParams)
-    .map(([key, item]) => {
-      // Only include if the parameter exists and is NOT optional
-      // This ensures we only check required parameters
-      return item && !item.optional && !item.default ? key : undefined
-    })
-    .filter(Boolean)
-    .join('&& ')
-
-  const enabledText = enabled ? `enabled: !!(${enabled}),` : ''
-
-  if (infiniteOverrideParams) {
-    return (
-      <File.Source name={name} isExportable isIndexable>
-        <Function name={name} export params={params.toConstructor()}>
-          {`
-      const queryKey = ${queryKeyName}(${queryKeyParams.toCall()})
-      return infiniteQueryOptions<${queryFnDataType}, ${errorType}, InfiniteData<${queryFnDataType}>, typeof queryKey, ${pageParamType}>({
-       ${enabledText}
-       queryKey,
-       queryFn: async ({ signal, pageParam }) => {
-          ${infiniteOverrideParams}
-          return ${clientName}(${clientParams.toCall({
-            transformName(name) {
-              if (name === 'config') {
-                return '{ ...config, signal: config.signal ?? signal }'
-              }
-
-              return name
-            },
-          })})
-        },
-       ${queryOptions.join(',\n')}
-      })
-`}
-        </Function>
-      </File.Source>
-    )
-  }
-
-  return (
-    <File.Source name={name} isExportable isIndexable>
-      <Function name={name} export params={params.toConstructor()}>
-        {`
-      const queryKey = ${queryKeyName}(${queryKeyParams.toCall()})
-      return infiniteQueryOptions<${queryFnDataType}, ${errorType}, InfiniteData<${queryFnDataType}>, typeof queryKey, ${pageParamType}>({
-       ${enabledText}
-       queryKey,
-       queryFn: async ({ signal }) => {
-          return ${clientName}(${clientParams.toCall({
-            transformName(name) {
-              if (name === 'config') {
-                return '{ ...config, signal: config.signal ?? signal }'
-              }
-
-              return name
-            },
-          })})
-        },
-       ${queryOptions.join(',\n')}
-      })
-`}
-      </Function>
-    </File.Source>
-  )
-}
-
-InfiniteQueryOptions.getParams = getParams

package/src/components/Mutation.tsx

@@ -1,158 +0,0 @@
-import { isOptional, type Operation } from '@kubb/oas'
-import type { OperationSchemas } from '@kubb/plugin-oas'
-import { getComments, getPathParams } from '@kubb/plugin-oas/utils'
-import { File, Function, FunctionParams } from '@kubb/react-fabric'
-import type { FabricReactNode } from '@kubb/react-fabric/types'
-import type { PluginReactQuery } from '../types.ts'
-import { MutationKey } from './MutationKey.tsx'
-import { MutationOptions } from './MutationOptions.tsx'
-
-type Props = {
-  /**
-   * Name of the function
-   */
-  name: string
-  typeName: string
-  mutationOptionsName: string
-  mutationKeyName: string
-  typeSchemas: OperationSchemas
-  operation: Operation
-  dataReturnType: PluginReactQuery['resolvedOptions']['client']['dataReturnType']
-  paramsCasing: PluginReactQuery['resolvedOptions']['paramsCasing']
-  pathParamsType: PluginReactQuery['resolvedOptions']['pathParamsType']
-  customOptions: PluginReactQuery['resolvedOptions']['customOptions']
-}
-
-type GetParamsProps = {
-  paramsCasing: PluginReactQuery['resolvedOptions']['paramsCasing']
-  pathParamsType: PluginReactQuery['resolvedOptions']['pathParamsType']
-  dataReturnType: PluginReactQuery['resolvedOptions']['client']['dataReturnType']
-  typeSchemas: OperationSchemas
-}
-
-function getParams({ paramsCasing, dataReturnType, typeSchemas }: GetParamsProps) {
-  const TData = dataReturnType === 'data' ? typeSchemas.response.name : `ResponseConfig<${typeSchemas.response.name}>`
-  const pathParams = getPathParams(typeSchemas.pathParams, { typed: true, casing: paramsCasing })
-
-  const mutationParams = FunctionParams.factory({
-    ...pathParams,
-    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,
-  })
-  const TRequest = mutationParams.toConstructor()
-  const TError = `ResponseErrorConfig<${typeSchemas.errors?.map((item) => item.name).join(' | ') || 'Error'}>`
-  const generics = [TData, TError, TRequest ? `{${TRequest}}` : 'void', 'TContext'].join(', ')
-
-  return FunctionParams.factory({
-    options: {
-      type: `
-{
-  mutation?: UseMutationOptions<${generics}> & { client?: QueryClient },
-  client?: ${typeSchemas.request?.name ? `Partial<RequestConfig<${typeSchemas.request?.name}>> & { client?: Client }` : 'Partial<RequestConfig> & { client?: Client }'},
-}
-`,
-      default: '{}',
-    },
-  })
-}
-
-export function Mutation({
-  name,
-  mutationOptionsName,
-  paramsCasing,
-  pathParamsType,
-  dataReturnType,
-  typeSchemas,
-  operation,
-  mutationKeyName,
-  customOptions,
-}: Props): FabricReactNode {
-  const mutationKeyParams = MutationKey.getParams({
-    pathParamsType,
-    typeSchemas,
-  })
-
-  const params = getParams({
-    paramsCasing,
-    pathParamsType,
-    dataReturnType,
-    typeSchemas,
-  })
-
-  const mutationParams = FunctionParams.factory({
-    ...getPathParams(typeSchemas.pathParams, { typed: true, casing: paramsCasing }),
-    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,
-  })
-
-  const mutationOptionsParams = MutationOptions.getParams({ typeSchemas })
-
-  const TRequest = mutationParams.toConstructor()
-  const TData = dataReturnType === 'data' ? typeSchemas.response.name : `ResponseConfig<${typeSchemas.response.name}>`
-  const TError = `ResponseErrorConfig<${typeSchemas.errors?.map((item) => item.name).join(' | ') || 'Error'}>`
-  const generics = [TData, TError, TRequest ? `{${TRequest}}` : 'void', 'TContext'].join(', ')
-  const returnType = `UseMutationResult<${generics}>`
-
-  const mutationOptions = `${mutationOptionsName}(${mutationOptionsParams.toCall()})`
-
-  return (
-    <File.Source name={name} isExportable isIndexable>
-      <Function
-        name={name}
-        export
-        params={params.toConstructor()}
-        JSDoc={{
-          comments: getComments(operation),
-        }}
-        generics={['TContext']}
-      >
-        {`
-        const { mutation = {}, client: config = {} } = options ?? {}
-        const { client: queryClient, ...mutationOptions } = mutation;
-        const mutationKey = mutationOptions.mutationKey ?? ${mutationKeyName}(${mutationKeyParams.toCall()})
-
-        const baseOptions = ${mutationOptions} as UseMutationOptions<${generics}>
-        ${customOptions ? `const customOptions = ${customOptions.name}({ hookName: '${name}', operationId: '${operation.getOperationId()}' }) as UseMutationOptions<${generics}>` : ''}
-
-        return useMutation<${generics}>({
-          ...baseOptions,${customOptions ? '\n...customOptions,' : ''}
-          mutationKey,
-          ...mutationOptions,
-        }, queryClient) as ${returnType}
-    `}
-      </Function>
-    </File.Source>
-  )
-}

package/src/components/MutationKey.tsx

@@ -1 +0,0 @@
-export { MutationKey } from '@internals/tanstack-query'

package/src/components/MutationOptions.tsx

@@ -1,122 +0,0 @@
-import { isOptional } from '@kubb/oas'
-import { Client } from '@kubb/plugin-client/components'
-import type { OperationSchemas } from '@kubb/plugin-oas'
-import { getPathParams } from '@kubb/plugin-oas/utils'
-import { File, Function, FunctionParams } from '@kubb/react-fabric'
-import type { FabricReactNode, Params } from '@kubb/react-fabric/types'
-import type { PluginReactQuery } from '../types.ts'
-import { MutationKey } from './MutationKey.tsx'
-
-type Props = {
-  name: string
-  clientName: string
-  mutationKeyName: string
-  typeSchemas: OperationSchemas
-  paramsCasing: PluginReactQuery['resolvedOptions']['paramsCasing']
-  paramsType: PluginReactQuery['resolvedOptions']['paramsType']
-  pathParamsType: PluginReactQuery['resolvedOptions']['pathParamsType']
-  dataReturnType: PluginReactQuery['resolvedOptions']['client']['dataReturnType']
-}
-
-type GetParamsProps = {
-  typeSchemas: OperationSchemas
-}
-
-function getParams({ typeSchemas }: GetParamsProps) {
-  return FunctionParams.factory({
-    config: {
-      type: typeSchemas.request?.name
-        ? `Partial<RequestConfig<${typeSchemas.request?.name}>> & { client?: Client }`
-        : 'Partial<RequestConfig> & { client?: Client }',
-      default: '{}',
-    },
-  })
-}
-
-export function MutationOptions({
-  name,
-  clientName,
-  dataReturnType,
-  typeSchemas,
-  paramsCasing,
-  paramsType,
-  pathParamsType,
-  mutationKeyName,
-}: Props): FabricReactNode {
-  const params = getParams({ typeSchemas })
-  const TData = dataReturnType === 'data' ? typeSchemas.response.name : `ResponseConfig<${typeSchemas.response.name}>`
-  const TError = typeSchemas.errors?.map((item) => item.name).join(' | ') || 'Error'
-
-  const clientParams = Client.getParams({
-    typeSchemas,
-    paramsCasing,
-    paramsType,
-    pathParamsType,
-    isConfigurable: true,
-  })
-
-  const mutationKeyParams = MutationKey.getParams({
-    pathParamsType,
-    typeSchemas,
-  })
-
-  const mutationParams = FunctionParams.factory({
-    ...getPathParams(typeSchemas.pathParams, { typed: true, casing: paramsCasing }),
-    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,
-  })
-
-  const dataParams = FunctionParams.factory({
-    data: {
-      // No use of pathParams because useMutation can only take one argument in object form,
-      // see https://tanstack.com/query/latest/docs/framework/react/reference/useMutation#usemutation
-      mode: 'object',
-      children: Object.entries(mutationParams.params).reduce((acc, [key, value]) => {
-        if (value) {
-          acc[key] = {
-            ...value,
-            type: undefined,
-          }
-        }
-
-        return acc
-      }, {} as Params),
-    },
-  })
-
-  const TRequest = mutationParams.toConstructor()
-
-  return (
-    <File.Source name={name} isExportable isIndexable>
-      <Function name={name} export params={params.toConstructor()} generics={['TContext = unknown']}>
-        {`
-      const mutationKey = ${mutationKeyName}(${mutationKeyParams.toCall()})
-      return mutationOptions<${TData}, ResponseErrorConfig<${TError}>, ${TRequest ? `{${TRequest}}` : 'void'}, TContext>({
-        mutationKey,
-        mutationFn: async(${dataParams.toConstructor()}) => {
-          return ${clientName}(${clientParams.toCall()})
-        },
-      })
-`}
-      </Function>
-    </File.Source>
-  )
-}
-
-MutationOptions.getParams = getParams