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

package/src/generators/suspenseQueryGenerator.tsx

@@ -1,203 +1,204 @@
 import path from 'node:path'
-import { usePluginDriver } from '@kubb/core/hooks'
-import { pluginClientName } from '@kubb/plugin-client'
-import { Client } from '@kubb/plugin-client/components'
-import { createReactGenerator } from '@kubb/plugin-oas/generators'
-import { useOas, useOperationManager } from '@kubb/plugin-oas/hooks'
-import { getBanner, getFooter } from '@kubb/plugin-oas/utils'
+import { ast, defineGenerator } from '@kubb/core'
+import { Client, pluginClientName } from '@kubb/plugin-client'
 import { pluginTsName } from '@kubb/plugin-ts'
 import { pluginZodName } from '@kubb/plugin-zod'
-import { File } from '@kubb/react-fabric'
+import { File, jsxRenderer } from '@kubb/renderer-jsx'
 import { difference } from 'remeda'
 import { QueryKey, QueryOptions, SuspenseQuery } from '../components'
 import type { PluginReactQuery } from '../types'
+import { transformName } from '../utils.ts'
 
-export const suspenseQueryGenerator = createReactGenerator<PluginReactQuery>({
+export const suspenseQueryGenerator = defineGenerator<PluginReactQuery>({
   name: 'react-suspense-query',
-  Operation({ config, operation, generator, plugin }) {
+  renderer: jsxRenderer,
+  operation(node, ctx) {
+    const { adapter, config, driver, resolver, root } = ctx
     const {
-      options,
-      options: { output },
-    } = plugin
-    const driver = usePluginDriver()
+      output,
+      query,
+      mutation,
+      suspense,
+      paramsCasing,
+      paramsType,
+      pathParamsType,
+      parser,
+      client: clientOptions,
+      group,
+      transformers,
+      customOptions,
+    } = ctx.options
 
-    const oas = useOas()
-    const { getSchemas, getName, getFile } = useOperationManager(generator)
+    const pluginTs = driver.getPlugin(pluginTsName)
+    if (!pluginTs) return null
+    const tsResolver = driver.getResolver(pluginTsName)
 
-    const isQuery = typeof options.query === 'boolean' ? true : options.query?.methods.some((method) => operation.method === method)
-    const isMutation = difference(options.mutation ? options.mutation.methods : [], options.query ? options.query.methods : []).some(
-      (method) => operation.method === method,
-    )
+    // query: false means "this IS a query op" (suspense hooks still generate)
+    const isQuery = query === false || (!!query && query.methods.some((method) => node.method.toLowerCase() === method.toLowerCase()))
+    const isMutation =
+      mutation !== false &&
+      !isQuery &&
+      difference(mutation ? mutation.methods : [], query ? query.methods : []).some((method) => node.method.toLowerCase() === method.toLowerCase())
+    const isSuspense = !!suspense
 
-    const isSuspense = !!options.suspense
+    if (!isQuery || isMutation || !isSuspense) return null
 
-    const importPath = options.query ? options.query.importPath : '@tanstack/react-query'
+    const importPath = query ? query.importPath : '@tanstack/react-query'
 
-    const query = {
-      name: getName(operation, {
-        type: 'function',
-        prefix: 'use',
-        suffix: 'suspense',
-      }),
-      typeName: getName(operation, { type: 'type' }),
-      file: getFile(operation, { prefix: 'use', suffix: 'suspense' }),
-    }
+    const baseName = resolver.resolveName(node.operationId)
+    const capitalize = (s: string) => s.charAt(0).toUpperCase() + s.slice(1)
+    const queryName = transformName(`use${capitalize(baseName)}Suspense`, 'function', transformers)
+    const queryOptionsName = transformName(`${baseName}SuspenseQueryOptions`, 'function', transformers)
+    const queryKeyName = transformName(`${baseName}SuspenseQueryKey`, 'const', transformers)
+    const queryKeyTypeName = transformName(`${capitalize(baseName)}SuspenseQueryKey`, 'type', transformers)
+    const clientName = transformName(`${baseName}Suspense`, 'function', transformers)
 
-    const hasClientPlugin = !!driver.getPluginByName(pluginClientName)
-    // Class-based clients are not compatible with query hooks, so we generate inline clients
-    const shouldUseClientPlugin = hasClientPlugin && options.client.clientType !== 'class'
-    const client = {
-      name: shouldUseClientPlugin
-        ? getName(operation, {
-            type: 'function',
-            pluginName: pluginClientName,
-          })
-        : getName(operation, {
-            type: 'function',
-            suffix: 'suspense',
-          }),
-      file: getFile(operation, { pluginName: pluginClientName }),
+    const meta = {
+      file: resolver.resolveFile({ name: queryName, extname: '.ts', tag: node.tags[0] ?? 'default', path: node.path }, { root, output, group }),
+      fileTs: tsResolver.resolveFile(
+        { name: node.operationId, extname: '.ts', tag: node.tags[0] ?? 'default', path: node.path },
+        { root, output: pluginTs.options?.output ?? output, group: pluginTs.options?.group },
+      ),
     }
 
-    const queryOptions = {
-      name: getName(operation, {
-        type: 'function',
-        suffix: 'SuspenseQueryOptions',
-      }),
-    }
+    const casedParams = ast.caseParams(node.parameters, paramsCasing)
+    const pathParams = casedParams.filter((p) => p.in === 'path')
+    const queryParams = casedParams.filter((p) => p.in === 'query')
+    const headerParams = casedParams.filter((p) => p.in === 'header')
 
-    const queryKey = {
-      name: getName(operation, { type: 'const', suffix: 'SuspenseQueryKey' }),
-      typeName: getName(operation, {
-        type: 'type',
-        suffix: 'SuspenseQueryKey',
-      }),
-    }
+    const importedTypeNames = [
+      node.requestBody?.content?.[0]?.schema ? tsResolver.resolveDataName(node) : undefined,
+      tsResolver.resolveResponseName(node),
+      ...pathParams.map((p) => tsResolver.resolvePathParamsName(node, p)),
+      ...queryParams.map((p) => tsResolver.resolveQueryParamsName(node, p)),
+      ...headerParams.map((p) => tsResolver.resolveHeaderParamsName(node, p)),
+      ...node.responses.map((res) => tsResolver.resolveResponseStatusName(node, res.statusCode)),
+    ].filter((name): name is string => !!name && name !== queryKeyTypeName)
 
-    const type = {
-      file: getFile(operation, { pluginName: pluginTsName }),
-      //todo remove type?
-      schemas: getSchemas(operation, {
-        pluginName: pluginTsName,
-        type: 'type',
-      }),
-    }
+    const pluginZod = parser === 'zod' ? driver.getPlugin(pluginZodName) : undefined
+    const zodResolver = pluginZod ? driver.getResolver(pluginZodName) : undefined
+    const fileZod = zodResolver
+      ? zodResolver.resolveFile(
+          { name: node.operationId, extname: '.ts', tag: node.tags[0] ?? 'default', path: node.path },
+          { root, output: pluginZod?.options?.output ?? output, group: pluginZod?.options?.group },
+        )
+      : undefined
+    const zodSchemaNames =
+      zodResolver && parser === 'zod'
+        ? [zodResolver.resolveResponseName?.(node), node.requestBody?.content?.[0]?.schema ? zodResolver.resolveDataName?.(node) : undefined].filter(Boolean)
+        : []
 
-    const zod = {
-      file: getFile(operation, { pluginName: pluginZodName }),
-      schemas: getSchemas(operation, {
-        pluginName: pluginZodName,
-        type: 'function',
-      }),
-    }
+    const clientPlugin = driver.getPlugin(pluginClientName)
+    const hasClientPlugin = clientPlugin?.name === pluginClientName
+    const shouldUseClientPlugin = hasClientPlugin && clientOptions.clientType !== 'class'
+    const clientResolver = shouldUseClientPlugin ? driver.getResolver(pluginClientName) : undefined
 
-    if (!isQuery || isMutation || !isSuspense) {
-      return null
-    }
+    const clientFile = shouldUseClientPlugin
+      ? clientResolver?.resolveFile(
+          { name: node.operationId, extname: '.ts', tag: node.tags[0] ?? 'default', path: node.path },
+          {
+            root,
+            output: clientPlugin?.options?.output ?? output,
+            group: clientPlugin?.options?.group,
+          },
+        )
+      : undefined
+
+    const resolvedClientName = shouldUseClientPlugin ? (clientResolver?.resolveName(node.operationId) ?? clientName) : clientName
 
     return (
       <File
-        baseName={query.file.baseName}
-        path={query.file.path}
-        meta={query.file.meta}
-        banner={getBanner({ oas, output, config: driver.config })}
-        footer={getFooter({ oas, output })}
+        baseName={meta.file.baseName}
+        path={meta.file.path}
+        meta={meta.file.meta}
+        banner={resolver.resolveBanner(adapter.inputNode, { output, config })}
+        footer={resolver.resolveFooter(adapter.inputNode, { output, config })}
       >
-        {options.parser === 'zod' && (
-          <File.Import name={[zod.schemas.response.name, zod.schemas.request?.name].filter(Boolean)} root={query.file.path} path={zod.file.path} />
+        {parser === 'zod' && fileZod && zodSchemaNames.length > 0 && (
+          <File.Import name={zodSchemaNames as string[]} root={meta.file.path} path={fileZod.path} />
         )}
-        {options.client.importPath ? (
+        {clientOptions.importPath ? (
           <>
-            {!shouldUseClientPlugin && <File.Import name={'fetch'} path={options.client.importPath} />}
-            <File.Import name={['Client', 'RequestConfig', 'ResponseErrorConfig']} path={options.client.importPath} isTypeOnly />
-            {options.client.dataReturnType === 'full' && <File.Import name={['ResponseConfig']} path={options.client.importPath} isTypeOnly />}
+            {!shouldUseClientPlugin && <File.Import name={'fetch'} path={clientOptions.importPath} />}
+            <File.Import name={['Client', 'RequestConfig', 'ResponseErrorConfig']} path={clientOptions.importPath} isTypeOnly />
+            {clientOptions.dataReturnType === 'full' && <File.Import name={['ResponseConfig']} path={clientOptions.importPath} isTypeOnly />}
           </>
         ) : (
           <>
-            {!shouldUseClientPlugin && (
-              <File.Import name={['fetch']} root={query.file.path} path={path.resolve(config.root, config.output.path, '.kubb/fetch.ts')} />
-            )}
+            {!shouldUseClientPlugin && <File.Import name={['fetch']} root={meta.file.path} path={path.resolve(root, '.kubb/fetch.ts')} />}
             <File.Import
               name={['Client', 'RequestConfig', 'ResponseErrorConfig']}
-              root={query.file.path}
-              path={path.resolve(config.root, config.output.path, '.kubb/fetch.ts')}
+              root={meta.file.path}
+              path={path.resolve(root, '.kubb/fetch.ts')}
               isTypeOnly
             />
-            {options.client.dataReturnType === 'full' && (
-              <File.Import name={['ResponseConfig']} root={query.file.path} path={path.resolve(config.root, config.output.path, '.kubb/fetch.ts')} isTypeOnly />
+            {clientOptions.dataReturnType === 'full' && (
+              <File.Import name={['ResponseConfig']} root={meta.file.path} path={path.resolve(root, '.kubb/fetch.ts')} isTypeOnly />
             )}
           </>
         )}
-        {shouldUseClientPlugin && <File.Import name={[client.name]} root={query.file.path} path={client.file.path} />}
-        {!shouldUseClientPlugin && (
-          <File.Import name={['buildFormData']} root={query.file.path} path={path.resolve(config.root, config.output.path, '.kubb/config.ts')} />
+        {shouldUseClientPlugin && clientFile && <File.Import name={[resolvedClientName]} root={meta.file.path} path={clientFile.path} />}
+        {!shouldUseClientPlugin && <File.Import name={['buildFormData']} root={meta.file.path} path={path.resolve(root, '.kubb/config.ts')} />}
+        {customOptions && <File.Import name={[customOptions.name]} path={customOptions.importPath} />}
+        {meta.fileTs && importedTypeNames.length > 0 && (
+          <File.Import name={Array.from(new Set(importedTypeNames))} root={meta.file.path} path={meta.fileTs.path} isTypeOnly />
         )}
-        {options.customOptions && <File.Import name={[options.customOptions.name]} path={options.customOptions.importPath} />}
-        <File.Import
-          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
-        />
+
         <QueryKey
-          name={queryKey.name}
-          typeName={queryKey.typeName}
-          operation={operation}
-          paramsCasing={options.paramsCasing}
-          pathParamsType={options.pathParamsType}
-          typeSchemas={type.schemas}
-          transformer={options.queryKey}
+          name={queryKeyName}
+          typeName={queryKeyTypeName}
+          node={node}
+          tsResolver={tsResolver}
+          pathParamsType={pathParamsType}
+          paramsCasing={paramsCasing}
+          transformer={ctx.options.queryKey}
         />
 
         {!shouldUseClientPlugin && (
           <Client
-            name={client.name}
-            baseURL={options.client.baseURL}
-            operation={operation}
-            typeSchemas={type.schemas}
-            zodSchemas={zod.schemas}
-            dataReturnType={options.client.dataReturnType || 'data'}
-            paramsCasing={options.client?.paramsCasing || options.paramsCasing}
-            paramsType={options.paramsType}
-            pathParamsType={options.pathParamsType}
-            parser={options.parser}
+            name={resolvedClientName}
+            baseURL={clientOptions.baseURL}
+            dataReturnType={clientOptions.dataReturnType || 'data'}
+            paramsCasing={clientOptions.paramsCasing || paramsCasing}
+            paramsType={paramsType}
+            pathParamsType={pathParamsType}
+            parser={parser}
+            node={node}
+            tsResolver={tsResolver}
+            zodResolver={zodResolver}
           />
         )}
+
         <File.Import name={['queryOptions']} path={importPath} />
+
         <QueryOptions
-          name={queryOptions.name}
-          clientName={client.name}
-          queryKeyName={queryKey.name}
-          typeSchemas={type.schemas}
-          paramsCasing={options.paramsCasing}
-          paramsType={options.paramsType}
-          pathParamsType={options.pathParamsType}
-          dataReturnType={options.client.dataReturnType}
+          name={queryOptionsName}
+          clientName={resolvedClientName}
+          queryKeyName={queryKeyName}
+          node={node}
+          tsResolver={tsResolver}
+          paramsCasing={paramsCasing}
+          paramsType={paramsType}
+          pathParamsType={pathParamsType}
+          dataReturnType={clientOptions.dataReturnType || 'data'}
         />
-        {options.suspense && (
+
+        {suspense && (
           <>
             <File.Import name={['useSuspenseQuery']} path={importPath} />
             <File.Import name={['QueryKey', 'QueryClient', 'UseSuspenseQueryOptions', 'UseSuspenseQueryResult']} path={importPath} isTypeOnly />
-
             <SuspenseQuery
-              name={query.name}
-              queryOptionsName={queryOptions.name}
-              typeSchemas={type.schemas}
-              paramsType={options.paramsType}
-              paramsCasing={options.paramsCasing}
-              pathParamsType={options.pathParamsType}
-              operation={operation}
-              dataReturnType={options.client.dataReturnType || 'data'}
-              queryKeyName={queryKey.name}
-              queryKeyTypeName={queryKey.typeName}
-              customOptions={options.customOptions}
+              name={queryName}
+              queryOptionsName={queryOptionsName}
+              queryKeyName={queryKeyName}
+              queryKeyTypeName={queryKeyTypeName}
+              node={node}
+              tsResolver={tsResolver}
+              paramsCasing={paramsCasing}
+              paramsType={paramsType}
+              pathParamsType={pathParamsType}
+              dataReturnType={clientOptions.dataReturnType || 'data'}
+              customOptions={customOptions}
             />
           </>
         )}

package/src/index.ts

@@ -1,2 +1,2 @@
-export { pluginReactQuery, pluginReactQueryName } from './plugin.ts'
+export { default, pluginReactQuery, pluginReactQueryName } from './plugin.ts'
 export type { PluginReactQuery } from './types.ts'