@kubb/plugin-react-query 3.0.0-alpha.3 → 3.0.0-alpha.30

package/src/types.ts

@@ -1,30 +1,16 @@
-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 { Operations } from './components/Operations.tsx'
-import type { Query as QueryTemplate } from './components/Query.tsx'
-import type { QueryImports } from './components/QueryImports.tsx'
-import type { QueryKey } from './components/QueryKey.tsx'
-import type { QueryOptions as QueryOptionsTemplate } from './components/QueryOptions.tsx'
+import type { PluginClient } from '@kubb/plugin-client'
+import type { Exclude, Generator, Include, Override, ResolvePathOptions } from '@kubb/plugin-oas'
 
-type Templates = {
-  operations?: typeof Operations.templates | false
-  mutation?: typeof Mutation.templates | false
-  query?: typeof QueryTemplate.templates | false
-  queryOptions?: typeof QueryOptionsTemplate.templates | false
-  queryKey?: typeof QueryKey.templates | false
-}
-
-export type Suspense = object
+type Suspense = object
 
-export type Query = {
+type Query = {
   /**
    * Customize the queryKey, here you can specify a suffix.
    */
-  queryKey: (key: unknown[]) => unknown[]
+  key: (key: unknown[]) => unknown[]
   /**
    * Define which HttpMethods can be used for queries
    * @default ['get']
@@ -40,14 +26,11 @@ export type Query = {
   importPath?: string
 }
 
-export type QueryOptions = object
-
-export type Mutate = {
+type Mutation = {
   /**
-   * Define the way of passing through the queryParams, headerParams and data.
-   * @default `'hook'`
+   * Customize the queryKey, here you can specify a suffix.
    */
-  variablesType: 'mutate' | 'hook'
+  key: (key: unknown[]) => unknown[]
   /**
    * Define which HttpMethods can be used for mutations
    * @default ['post', 'put', 'delete']
@@ -82,26 +65,10 @@ export type Infinite = {
 }
 
 export type Options = {
-  output?: {
-    /**
-     * Output to save the @tanstack/query 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 @tanstack/query hooks based on the provided name.
    */
@@ -134,6 +101,16 @@ export type Options = {
      * @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'
   }
   /**
    * ReturnType that needs to be used when calling client().
@@ -144,31 +121,7 @@ export type Options = {
    * @default `'data'`
    * @private
    */
-  /**
-   * ReturnType that needs to be used when calling client().
-   *
-   * `Data` will return ResponseConfig[data].
-   *
-   * `Full` will return ResponseConfig.
-   * @default `'data'`
-   * @private
-   */
-  dataReturnType?: 'data' | 'full'
-  /**
-   * How to pass your pathParams.
-   *
-   * `object` will return the pathParams as an object.
-   *
-   * `inline` will return the pathParams as comma separated params.
-   * @default `'inline'`
-   * @private
-   */
-  pathParamsType?: 'object' | 'inline'
-  /**
-   * Which parser can be used before returning the data to `@tanstack/query`.
-   * `'zod'` will use `@kubb/plugin-zod` to parse the data.
-   */
-  parser?: 'zod'
+
   /**
    * Array containing exclude parameters to exclude/skip tags/operations/methods/paths.
    */
@@ -181,6 +134,16 @@ export type Options = {
    * Array containing override parameters to override `options` based on tags/operations/methods/paths.
    */
   override?: Array<Override<ResolvedOptions>>
+  /**
+   * How to pass your pathParams.
+   *
+   * `object` will return the pathParams as an object.
+   *
+   * `inline` will return the pathParams as comma separated params.
+   * @default `'inline'`
+   * @private
+   */
+  pathParamsType?: 'object' | 'inline'
   /**
    * When set, an infiniteQuery hooks will be added.
    */
@@ -193,11 +156,15 @@ export type Options = {
    * Override some useQuery behaviours.
    */
   query?: Partial<Query> | false
-  queryOptions?: Partial<QueryOptions> | false
   /**
    * Override some useMutation behaviours.
    */
-  mutate?: Mutate | false
+  mutation?: Mutation | false
+  /**
+   * Which parser can be used before returning the data to `@tanstack/query`.
+   * `'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.
@@ -205,30 +172,24 @@ export type Options = {
     name?: (name: ResolveNameParams['name'], type?: ResolveNameParams['type']) => string
   }
   /**
-   * Make it possible to override one of the templates
+   * Define some generators next to the react-query generators
    */
-  templates?: Partial<Templates>
+  generators?: Array<Generator<PluginReactQuery>>
 }
 
 type ResolvedOptions = {
+  output: Output
+  baseURL: string | undefined
   client: Required<NonNullable<PluginReactQuery['options']['client']>>
-  dataReturnType: NonNullable<PluginReactQuery['options']['dataReturnType']>
-  pathParamsType: NonNullable<PluginReactQuery['options']['pathParamsType']>
-  parser: PluginReactQuery['options']['parser']
+  parser: Required<NonNullable<Options['parser']>>
+  pathParamsType: NonNullable<Options['pathParamsType']>
   /**
    * Only used of infinite
    */
-  infinite: Infinite | false
+  infinite: NonNullable<Infinite> | false
   suspense: Suspense | false
-  query: Query | false
-  queryOptions: QueryOptions | false
-  mutate: Mutate | false
-  templates: NonNullable<Templates>
-}
-
-export type FileMeta = {
-  pluginKey?: Plugin['key']
-  tag?: string
+  query: NonNullable<Required<Query>> | false
+  mutation: NonNullable<Required<Mutation>> | false
 }
 
 export type PluginReactQuery = PluginFactoryOptions<'plugin-react-query', Options, ResolvedOptions, never, ResolvePathOptions>