@kubb/plugin-swr 5.0.0-alpha.8 → 5.0.0-beta.100

package/src/generators/mutationGenerator.tsx

@@ -1,177 +0,0 @@
-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 { pluginTsName } from '@kubb/plugin-ts'
-import { pluginZodName } from '@kubb/plugin-zod'
-import { File } from '@kubb/react-fabric'
-import { difference } from 'remeda'
-import { Mutation, MutationKey } from '../components'
-import type { PluginSwr } from '../types'
-
-export const mutationGenerator = createReactGenerator<PluginSwr>({
-  name: 'swr-mutation',
-  Operation({ config, operation, generator, plugin }) {
-    const {
-      options,
-      options: { output },
-    } = plugin
-    const driver = usePluginDriver()
-
-    const oas = useOas()
-    const { getSchemas, getName, getFile } = useOperationManager(generator)
-
-    const isQuery = !!options.query && options.query?.methods.some((method) => operation.method === method)
-    const isMutation =
-      options.mutation !== false &&
-      !isQuery &&
-      difference(options.mutation ? options.mutation.methods : [], options.query ? options.query.methods : []).some((method) => operation.method === method)
-
-    const importPath = options.mutation ? options.mutation.importPath : 'swr'
-
-    const mutation = {
-      name: getName(operation, { type: 'function', prefix: 'use' }),
-      typeName: getName(operation, { type: 'type' }),
-      file: getFile(operation, { prefix: 'use' }),
-    }
-
-    const type = {
-      file: getFile(operation, { pluginName: pluginTsName }),
-      //todo remove type?
-      schemas: getSchemas(operation, { pluginName: pluginTsName, type: 'type' }),
-    }
-
-    const zod = {
-      file: getFile(operation, { pluginName: pluginZodName }),
-      schemas: getSchemas(operation, { pluginName: pluginZodName, type: 'function' }),
-    }
-
-    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',
-          }),
-      file: getFile(operation, { pluginName: pluginClientName }),
-    }
-
-    const mutationKey = {
-      name: getName(operation, { type: 'const', suffix: 'MutationKey' }),
-      typeName: getName(operation, { type: 'type', suffix: 'MutationKey' }),
-    }
-
-    if (!isMutation) {
-      return null
-    }
-
-    return (
-      <File
-        baseName={mutation.file.baseName}
-        path={mutation.file.path}
-        meta={mutation.file.meta}
-        banner={getBanner({ oas, output, config: driver.config })}
-        footer={getFooter({ oas, output })}
-      >
-        {options.parser === 'zod' && (
-          <File.Import name={[zod.schemas.response.name, zod.schemas.request?.name].filter(Boolean)} root={mutation.file.path} path={zod.file.path} />
-        )}
-        {options.client.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']} root={mutation.file.path} path={path.resolve(config.root, config.output.path, '.kubb/fetch.ts')} />
-            )}
-            <File.Import
-              name={['Client', 'RequestConfig', 'ResponseErrorConfig']}
-              root={mutation.file.path}
-              path={path.resolve(config.root, config.output.path, '.kubb/fetch.ts')}
-              isTypeOnly
-            />
-            {options.client.dataReturnType === 'full' && (
-              <File.Import
-                name={['ResponseConfig']}
-                root={mutation.file.path}
-                path={path.resolve(config.root, config.output.path, '.kubb/fetch.ts')}
-                isTypeOnly
-              />
-            )}
-          </>
-        )}
-        <File.Import name="useSWRMutation" path={importPath} />
-        <File.Import name={['SWRMutationConfiguration', 'SWRMutationResponse']} path={importPath} isTypeOnly />
-        {shouldUseClientPlugin && <File.Import name={[client.name]} root={mutation.file.path} path={client.file.path} />}
-        {!shouldUseClientPlugin && (
-          <File.Import name={['buildFormData']} root={mutation.file.path} path={path.resolve(config.root, config.output.path, '.kubb/config.ts')} />
-        )}
-        <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={mutation.file.path}
-          path={type.file.path}
-          isTypeOnly
-        />
-
-        <MutationKey
-          name={mutationKey.name}
-          typeName={mutationKey.typeName}
-          operation={operation}
-          pathParamsType={options.pathParamsType}
-          typeSchemas={type.schemas}
-          paramsCasing={options.paramsCasing}
-          transformer={options.mutationKey}
-        />
-
-        {!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}
-          />
-        )}
-        {options.mutation && (
-          <Mutation
-            name={mutation.name}
-            clientName={client.name}
-            typeName={mutation.typeName}
-            typeSchemas={type.schemas}
-            operation={operation}
-            dataReturnType={options.client.dataReturnType || 'data'}
-            paramsType={options.paramsType}
-            paramsCasing={options.paramsCasing}
-            pathParamsType={options.pathParamsType}
-            mutationKeyName={mutationKey.name}
-            mutationKeyTypeName={mutationKey.typeName}
-            paramsToTrigger={options.mutation.paramsToTrigger}
-          />
-        )}
-      </File>
-    )
-  },
-})

package/src/generators/queryGenerator.tsx

@@ -1,186 +0,0 @@
-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 { pluginTsName } from '@kubb/plugin-ts'
-import { pluginZodName } from '@kubb/plugin-zod'
-import { File } from '@kubb/react-fabric'
-import { difference } from 'remeda'
-import { Query, QueryKey, QueryOptions } from '../components'
-import type { PluginSwr } from '../types'
-
-export const queryGenerator = createReactGenerator<PluginSwr>({
-  name: 'swr-query',
-  Operation({ config, operation, generator, plugin }) {
-    const {
-      options,
-      options: { output },
-    } = plugin
-    const driver = usePluginDriver()
-
-    const oas = useOas()
-    const { getSchemas, getName, getFile } = useOperationManager(generator)
-
-    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,
-    )
-    const importPath = options.query ? options.query.importPath : 'swr/mutation'
-
-    const query = {
-      name: getName(operation, { type: 'function', prefix: 'use' }),
-      typeName: getName(operation, { type: 'type' }),
-      file: getFile(operation, { prefix: 'use' }),
-    }
-
-    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',
-          }),
-      file: getFile(operation, { pluginName: pluginClientName }),
-    }
-
-    const queryOptions = {
-      name: getName(operation, { type: 'function', suffix: 'QueryOptions' }),
-    }
-    const queryKey = {
-      name: getName(operation, { type: 'const', suffix: 'QueryKey' }),
-      typeName: getName(operation, { type: 'type', suffix: 'QueryKey' }),
-    }
-
-    const type = {
-      file: getFile(operation, { pluginName: pluginTsName }),
-      //todo remove type?
-      schemas: getSchemas(operation, {
-        pluginName: pluginTsName,
-        type: 'type',
-      }),
-    }
-
-    const zod = {
-      file: getFile(operation, { pluginName: pluginZodName }),
-      schemas: getSchemas(operation, {
-        pluginName: pluginZodName,
-        type: 'function',
-      }),
-    }
-
-    if (!isQuery || isMutation) {
-      return null
-    }
-
-    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 })}
-      >
-        {options.parser === 'zod' && (
-          <File.Import name={[zod.schemas.response.name, zod.schemas.request?.name].filter(Boolean)} root={query.file.path} path={zod.file.path} />
-        )}
-        {options.client.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']} root={query.file.path} path={path.resolve(config.root, config.output.path, '.kubb/fetch.ts')} />
-            )}
-            <File.Import
-              name={['Client', 'RequestConfig', 'ResponseErrorConfig']}
-              root={query.file.path}
-              path={path.resolve(config.root, config.output.path, '.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 />
-            )}
-          </>
-        )}
-        {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')} />
-        )}
-
-        <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}
-          pathParamsType={options.pathParamsType}
-          typeSchemas={type.schemas}
-          paramsCasing={options.paramsCasing}
-          transformer={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}
-          />
-        )}
-        <QueryOptions
-          name={queryOptions.name}
-          clientName={client.name}
-          typeSchemas={type.schemas}
-          paramsType={options.paramsType}
-          paramsCasing={options.paramsCasing}
-          pathParamsType={options.pathParamsType}
-        />
-        {options.query && (
-          <>
-            <File.Import name="useSWR" path={importPath} />
-            <File.Import name={['SWRResponse']} path={importPath} isTypeOnly />
-            <Query
-              name={query.name}
-              queryOptionsName={queryOptions.name}
-              typeSchemas={type.schemas}
-              paramsType={options.paramsType}
-              pathParamsType={options.pathParamsType}
-              operation={operation}
-              dataReturnType={options.client.dataReturnType || 'data'}
-              queryKeyName={queryKey.name}
-              paramsCasing={options.paramsCasing}
-              queryKeyTypeName={queryKey.typeName}
-            />
-          </>
-        )}
-      </File>
-    )
-  },
-})

package/src/index.ts

@@ -1,2 +0,0 @@
-export { pluginSwr, pluginSwrName } from './plugin.ts'
-export type { PluginSwr } from './types.ts'

package/src/plugin.ts

@@ -1,207 +0,0 @@
-import path from 'node:path'
-import { camelCase, pascalCase } from '@internals/utils'
-import { createPlugin, type Group, getBarrelFiles, getMode } from '@kubb/core'
-import { pluginClientName } from '@kubb/plugin-client'
-import { source as axiosClientSource } from '@kubb/plugin-client/templates/clients/axios.source'
-import { source as fetchClientSource } from '@kubb/plugin-client/templates/clients/fetch.source'
-import { source as configSource } from '@kubb/plugin-client/templates/config.source'
-import { OperationGenerator, pluginOasName } from '@kubb/plugin-oas'
-import { pluginTsName } from '@kubb/plugin-ts'
-import { pluginZodName } from '@kubb/plugin-zod'
-import { MutationKey, QueryKey } from './components'
-import { mutationGenerator, queryGenerator } from './generators'
-import type { PluginSwr } from './types.ts'
-
-export const pluginSwrName = 'plugin-swr' satisfies PluginSwr['name']
-
-export const pluginSwr = createPlugin<PluginSwr>((options) => {
-  const {
-    output = { path: 'hooks', barrelType: 'named' },
-    group,
-    exclude = [],
-    include,
-    override = [],
-    parser = 'client',
-    transformers = {},
-    query,
-    mutation,
-    client,
-    paramsType = 'inline',
-    pathParamsType = paramsType === 'object' ? 'object' : options.pathParamsType || 'inline',
-    mutationKey = MutationKey.getTransformer,
-    queryKey = QueryKey.getTransformer,
-    generators = [queryGenerator, mutationGenerator].filter(Boolean),
-    paramsCasing,
-    contentType,
-  } = options
-
-  const clientName = client?.client ?? 'axios'
-  const clientImportPath = client?.importPath ?? (!client?.bundle ? `@kubb/plugin-client/clients/${clientName}` : undefined)
-
-  return {
-    name: pluginSwrName,
-    options: {
-      output,
-      client: {
-        bundle: client?.bundle,
-        baseURL: client?.baseURL,
-        client: clientName,
-        clientType: client?.clientType ?? 'function',
-        importPath: clientImportPath,
-        dataReturnType: client?.dataReturnType ?? 'data',
-        paramsCasing,
-      },
-      queryKey,
-      query:
-        query === false
-          ? false
-          : {
-              importPath: 'swr',
-              methods: ['get'],
-              ...query,
-            },
-      mutationKey,
-      mutation:
-        mutation === false
-          ? false
-          : {
-              importPath: 'swr/mutation',
-              methods: ['post', 'put', 'delete', 'patch'],
-              ...mutation,
-            },
-      parser,
-      paramsType,
-      pathParamsType,
-      paramsCasing,
-      group,
-    },
-    pre: [pluginOasName, pluginTsName, parser === 'zod' ? pluginZodName : undefined].filter(Boolean),
-    resolvePath(baseName, pathMode, options) {
-      const root = path.resolve(this.config.root, this.config.output.path)
-      const mode = pathMode ?? getMode(path.resolve(root, output.path))
-
-      if (mode === 'single') {
-        /**
-         * when output is a file then we will always append to the same file(output file), see fileManager.addOrAppend
-         * Other plugins then need to call addOrAppend instead of just add from the fileManager class
-         */
-        return path.resolve(root, output.path)
-      }
-
-      if (group && (options?.group?.path || options?.group?.tag)) {
-        const groupName: Group['name'] = group?.name
-          ? group.name
-          : (ctx) => {
-              if (group?.type === 'path') {
-                return `${ctx.group.split('/')[1]}`
-              }
-              return `${camelCase(ctx.group)}Controller`
-            }
-
-        return path.resolve(
-          root,
-          output.path,
-          groupName({
-            group: group.type === 'path' ? options.group.path! : options.group.tag!,
-          }),
-          baseName,
-        )
-      }
-
-      return path.resolve(root, output.path, baseName)
-    },
-    resolveName(name, type) {
-      let resolvedName = camelCase(name)
-
-      if (type === 'file' || type === 'function') {
-        resolvedName = camelCase(name, {
-          isFile: type === 'file',
-        })
-      }
-
-      if (type === 'type') {
-        resolvedName = pascalCase(name)
-      }
-
-      if (type) {
-        return transformers?.name?.(resolvedName, type) || resolvedName
-      }
-
-      return resolvedName
-    },
-    async install() {
-      const root = path.resolve(this.config.root, this.config.output.path)
-      const mode = getMode(path.resolve(root, output.path))
-      const oas = await this.getOas()
-      const baseURL = await this.getBaseURL()
-
-      if (baseURL) {
-        this.plugin.options.client.baseURL = baseURL
-      }
-
-      const hasClientPlugin = !!this.driver.getPluginByName(pluginClientName)
-
-      if (this.plugin.options.client.bundle && !hasClientPlugin && !this.plugin.options.client.importPath) {
-        // pre add bundled fetch
-        await this.upsertFile({
-          baseName: 'fetch.ts',
-          path: path.resolve(root, '.kubb/fetch.ts'),
-          sources: [
-            {
-              name: 'fetch',
-              value: this.plugin.options.client.client === 'fetch' ? fetchClientSource : axiosClientSource,
-              isExportable: true,
-              isIndexable: true,
-            },
-          ],
-          imports: [],
-          exports: [],
-        })
-      }
-
-      if (!hasClientPlugin) {
-        await this.addFile({
-          baseName: 'config.ts',
-          path: path.resolve(root, '.kubb/config.ts'),
-          sources: [
-            {
-              name: 'config',
-              value: configSource,
-              isExportable: false,
-              isIndexable: false,
-            },
-          ],
-          imports: [],
-          exports: [],
-        })
-      }
-
-      const operationGenerator = new OperationGenerator(this.plugin.options, {
-        fabric: this.fabric,
-        oas,
-        driver: this.driver,
-        events: this.events,
-        plugin: this.plugin,
-        contentType,
-        exclude,
-        include,
-        override,
-        mode,
-      })
-
-      const files = await operationGenerator.build(...generators)
-      await this.upsertFile(...files)
-
-      const barrelFiles = await getBarrelFiles(this.fabric.files, {
-        type: output.barrelType ?? 'named',
-        root,
-        output,
-        meta: {
-          pluginName: this.plugin.name,
-        },
-      })
-
-      await this.upsertFile(...barrelFiles)
-    },
-  }
-})