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

package/src/plugin.ts

@@ -3,40 +3,59 @@ import path from 'node:path'
 import { FileManager, PluginManager, createPlugin } from '@kubb/core'
 import { camelCase, pascalCase } from '@kubb/core/transformers'
 import { renderTemplate } from '@kubb/core/utils'
-import { pluginOasName } from '@kubb/plugin-oas'
-import { getGroupedByTagFiles } from '@kubb/plugin-oas/utils'
+import { OperationGenerator, pluginOasName } from '@kubb/plugin-oas'
+
 import { pluginTsName } from '@kubb/plugin-ts'
 import { pluginZodName } from '@kubb/plugin-zod'
 
-import { OperationGenerator } from './OperationGenerator.tsx'
-import { Mutation, Query, QueryOptions } from './components/index.ts'
-
 import type { Plugin } from '@kubb/core'
 import type { PluginOas as SwaggerPluginOptions } from '@kubb/plugin-oas'
+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' }, group, exclude = [], include, override = [], parser, transformers = {}, templates, dataReturnType = 'data' } = options
+  const {
+    output = { path: 'hooks' },
+    group,
+    exclude = [],
+    include,
+    override = [],
+    parser = 'client',
+    transformers = {},
+    query,
+    mutation,
+    client,
+    pathParamsType = 'inline',
+  } = options
   const template = group?.output ? group.output : `${output.path}/{{tag}}SWRController`
 
   return {
     name: pluginSwrName,
     options: {
-      extName: output.extName,
-      templates: {
-        mutation: Mutation.templates,
-        query: Query.templates,
-        queryOptions: QueryOptions.templates,
-        ...templates,
+      output: {
+        exportType: 'barrelNamed',
+        ...output,
       },
+      pathParamsType,
       client: {
         importPath: '@kubb/plugin-client/client',
-        ...options.client,
+        dataReturnType: 'data',
+        ...client,
+      },
+      query: {
+        importPath: 'swr',
+        methods: ['get'],
+        ...query,
+      },
+      mutation: {
+        importPath: 'swr/mutation',
+        methods: ['post', 'put', 'delete', 'patch'],
+        ...mutation,
       },
-      dataReturnType,
       parser,
+      baseURL: undefined,
     },
     pre: [pluginOasName, pluginTsName, parser === 'zod' ? pluginZodName : undefined].filter(Boolean),
     resolvePath(baseName, pathMode, options) {
@@ -64,7 +83,6 @@ export const pluginSwr = createPlugin<PluginSwr>((options) => {
 
       if (type === 'file' || type === 'function') {
         resolvedName = camelCase(name, {
-          prefix: 'use',
           isFile: type === 'file',
         })
       }
@@ -85,48 +103,41 @@ export const pluginSwr = createPlugin<PluginSwr>((options) => {
       const oas = await swaggerPlugin.context.getOas()
       const root = path.resolve(this.config.root, this.config.output.path)
       const mode = FileManager.getMode(path.resolve(root, output.path))
-
-      const operationGenerator = new OperationGenerator(this.plugin.options, {
-        oas,
-        pluginManager: this.pluginManager,
-        plugin: this.plugin,
-        contentType: swaggerPlugin.context.contentType,
-        exclude,
-        include,
-        override,
-        mode,
-      })
-
-      const files = await operationGenerator.build()
+      const baseURL = await swaggerPlugin.context.getBaseURL()
+
+      const operationGenerator = new OperationGenerator(
+        {
+          ...this.plugin.options,
+          baseURL,
+        },
+        {
+          oas,
+          pluginManager: this.pluginManager,
+          plugin: this.plugin,
+          contentType: swaggerPlugin.context.contentType,
+          exclude,
+          include,
+          override,
+          mode,
+        },
+      )
+
+      const files = await operationGenerator.build(queryGenerator, mutationGenerator)
       await this.addFile(...files)
-    },
-    async buildEnd() {
-      if (this.config.output.write === false) {
-        return
-      }
 
-      const root = path.resolve(this.config.root, this.config.output.path)
-
-      if (group?.type === 'tag') {
-        const rootFiles = await getGroupedByTagFiles({
-          logger: this.logger,
-          files: this.fileManager.files,
-          plugin: this.plugin,
-          template,
-          exportAs: group.exportAs || '{{tag}}SWRHooks',
+      if (this.config.output.exportType) {
+        const barrelFiles = await this.fileManager.getBarrelFiles({
           root,
           output,
+          files: this.fileManager.files,
+          meta: {
+            pluginKey: this.plugin.key,
+          },
+          logger: this.logger,
         })
 
-        await this.addFile(...rootFiles)
+        await this.addFile(...barrelFiles)
       }
-
-      await this.fileManager.addIndexes({
-        root,
-        output,
-        meta: { pluginKey: this.plugin.key },
-        logger: this.logger,
-      })
     },
   }
 })

package/src/types.ts

@@ -1,37 +1,12 @@
-import type { Plugin, PluginFactoryOptions, ResolveNameParams } from '@kubb/core'
-import type * as KubbFile from '@kubb/fs/types'
+import type { Output, PluginFactoryOptions, ResolveNameParams } from '@kubb/core'
+import type { HttpMethod } from '@kubb/oas'
 import type { Exclude, Include, Override, ResolvePathOptions } from '@kubb/plugin-oas'
-import type { Mutation } from './components/Mutation.tsx'
-import type { Query } from './components/Query.tsx'
-import type { QueryOptions } from './components/QueryOptions.tsx'
-
-type Templates = {
-  mutation?: typeof Mutation.templates | false
-  query?: typeof Query.templates | false
-  queryOptions?: typeof QueryOptions.templates | false
-}
 
 export type Options = {
-  output?: {
-    /**
-     * Output to save the SWR hooks.
-     * @default `"hooks"`
-     */
-    path: string
-    /**
-     * Name to be used for the `export * as {{exportAs}} from './'`
-     */
-    exportAs?: string
-    /**
-     * Add an extension to the generated imports and exports, default it will not use an extension
-     */
-    extName?: KubbFile.Extname
-    /**
-     * Define what needs to exported, here you can also disable the export of barrel files
-     * @default `'barrel'`
-     */
-    exportType?: 'barrel' | 'barrelNamed' | false
-  }
+  /**
+   * @default 'hooks'
+   */
+  output?: Output
   /**
    * Group the SWR hooks based on the provided name.
    */
@@ -70,50 +45,83 @@ export type Options = {
     /**
      * Path to the client import path that will be used to do the API calls.
      * It will be used as `import client from '${client.importPath}'`.
-     * It allow both relative and absolute path.
+     * It allows both relative and absolute path.
      * the path will be applied as is, so relative path shoule be based on the file being generated.
      * @default '@kubb/plugin-client/client'
      */
     importPath?: string
+    /**
+     * ReturnType that needs to be used when calling client().
+     *
+     * `Data` will return ResponseConfig[data].
+     *
+     * `Full` will return ResponseConfig.
+     * @default `'data'`
+     * @private
+     */
+    dataReturnType?: 'data' | 'full'
+  }
+  query?: {
+    /**
+     * Define which HttpMethods can be used for queries
+     * @default ['get']
+     */
+    methods?: Array<HttpMethod>
+    /**
+     * Path to the useQuery that will be used to do the useQuery functionality.
+     * It will be used as `import { useQuery } from '${importPath}'`.
+     * It allows both relative and absolute path.
+     * the path will be applied as is, so relative path should be based on the file being generated.
+     * @default '@tanstack/react-query' if 'framework' is set to 'react'
+     */
+    importPath?: string
+  }
+  mutation?: {
+    /**
+     * Define which HttpMethods can be used for queries
+     * @default ['post', 'put', 'delete', 'patch']
+     */
+    methods?: Array<HttpMethod>
+    /**
+     * Path to the useQuery that will be used to do the useQuery functionality.
+     * It will be used as `import { useQuery } from '${importPath}'`.
+     * It allows both relative and absolute path.
+     * the path will be applied as is, so relative path should be based on the file being generated.
+     * @default '@tanstack/react-query' if 'framework' is set to 'react'
+     */
+    importPath?: string
   }
   /**
-   * ReturnType that needs to be used when calling client().
+   * How to pass your pathParams.
    *
-   * `Data` will return ResponseConfig[data].
+   * `object` will return the pathParams as an object.
    *
-   * `Full` will return ResponseConfig.
-   * @default `'data'`
+   * `inline` will return the pathParams as comma separated params.
+   * @default `'inline'`
    * @private
    */
-  dataReturnType?: 'data' | 'full'
+  pathParamsType?: 'object' | 'inline'
+  /**
+   * Which parser can be used before returning the data to `swr`.
+   * `'zod'` will use `@kubb/plugin-zod` to parse the data.
+   */
+  parser?: 'client' | 'zod'
   transformers?: {
     /**
      * Customize the names based on the type that is provided by the plugin.
      */
     name?: (name: ResolveNameParams['name'], type?: ResolveNameParams['type']) => string
   }
-  /**
-   * Which parser can be used before returning the data to `@tanstack/query`.
-   * `'zod'` will use `@kubb/plugin-zod` to parse the data.
-   */
-  parser?: 'zod'
-  /**
-   * Make it possible to override one of the templates
-   */
-  templates?: Partial<Templates>
 }
 
 type ResolvedOptions = {
-  extName: KubbFile.Extname | undefined
+  output: Output
+  baseURL: string | undefined
   client: Required<NonNullable<Options['client']>>
-  dataReturnType: NonNullable<Options['dataReturnType']>
-  templates: NonNullable<Templates>
-  parser: Options['parser']
-}
-
-export type FileMeta = {
-  pluginKey?: Plugin['key']
-  tag?: string
+  parser: Required<NonNullable<Options['parser']>>
+  mutation: Required<NonNullable<Options['mutation']>>
+  query: Required<NonNullable<Options['query']>>
+  pathParamsType: NonNullable<Options['pathParamsType']>
 }
 
 export type PluginSwr = PluginFactoryOptions<'plugin-swr', Options, ResolvedOptions, never, ResolvePathOptions>