@kubb/plugin-vue-query 3.0.0-beta.8 → 3.0.0

package/dist/types-C8LfCZUP.d.ts

@@ -0,0 +1,389 @@
+import { PluginFactoryOptions, Output, Group, ResolveNameParams } from '@kubb/core';
+import { HttpMethod, Operation } from '@kubb/oas';
+import { ResolvePathOptions, Exclude, Include, Override, Generator, OperationSchemas } from '@kubb/plugin-oas';
+
+type Options$2 = {
+    /**
+     * Specify the export location for the files and define the behavior of the output
+     * @default { path: 'clients', barrelType: 'named' }
+     */
+    output?: Output;
+    /**
+     * Group the clients based on the provided name.
+     */
+    group?: Group;
+    /**
+     * Array containing exclude parameters to exclude/skip tags/operations/methods/paths.
+     */
+    exclude?: Array<Exclude>;
+    /**
+     * Array containing include parameters to include tags/operations/methods/paths.
+     */
+    include?: Array<Include>;
+    /**
+     * Array containing override parameters to override `options` based on tags/operations/methods/paths.
+     */
+    override?: Array<Override<ResolvedOptions$2>>;
+    /**
+     * Create `operations.ts` file with all operations grouped by methods.
+     * @default false
+     */
+    operations?: boolean;
+    /**
+     * 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 allows both relative and absolute path but be aware that we will not change the path.
+     * @default '@kubb/plugin-client/client'
+     */
+    importPath?: string;
+    /**
+     * Allows you to set a custom base url for all generated calls.
+     */
+    baseURL?: string;
+    /**
+     * ReturnType that will be used when calling the client.
+     * - 'data' will return ResponseConfig[data].
+     * - 'full' will return ResponseConfig.
+     * @default 'data'
+     */
+    dataReturnType?: 'data' | 'full';
+    /**
+     * How to pass your params
+     * - 'object' will return the params and pathParams as an object.
+     * - 'inline' will return the params as comma separated params.
+     * @default 'inline'
+     */
+    paramsType?: 'object' | 'inline';
+    /**
+     * How to pass your pathParams.
+     * - 'object' will return the pathParams as an object.
+     * - 'inline' will return the pathParams as comma separated params.
+     * @default 'inline'
+     */
+    pathParamsType?: 'object' | 'inline';
+    /**
+     * Which parser can be used before returning the data
+     * - 'zod'  will use `@kubb/plugin-zod` to parse the data.
+     * @default 'client'
+     */
+    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;
+    };
+    /**
+     * Define some generators next to the client generators
+     */
+    generators?: Array<Generator<PluginClient>>;
+};
+type ResolvedOptions$2 = {
+    output: Output;
+    group?: Options$2['group'];
+    baseURL: string | undefined;
+    parser: NonNullable<Options$2['parser']>;
+    importPath: NonNullable<Options$2['importPath']>;
+    dataReturnType: NonNullable<Options$2['dataReturnType']>;
+    pathParamsType: NonNullable<Options$2['pathParamsType']>;
+    paramsType: NonNullable<Options$2['paramsType']>;
+};
+type PluginClient = PluginFactoryOptions<'plugin-client', Options$2, ResolvedOptions$2, never, ResolvePathOptions>;
+
+type TransformerProps$1 = {
+    operation: Operation;
+    schemas: OperationSchemas;
+};
+type Transformer$1 = (props: TransformerProps$1) => unknown[];
+type Suspense = object;
+/**
+ * Customize the queryKey
+ */
+type QueryKey$1 = Transformer$1;
+/**
+ * Customize the mutationKey
+ */
+type MutationKey$1 = Transformer$1;
+type Query$1 = {
+    /**
+     * 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'
+     */
+    importPath?: string;
+};
+type Mutation$1 = {
+    /**
+     * Define which HttpMethods can be used for mutations
+     * @default ['post', 'put', 'delete']
+     */
+    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'
+     */
+    importPath?: string;
+};
+type Infinite$1 = {
+    /**
+     * Specify the params key used for `pageParam`.
+     * @default 'id'
+     */
+    queryParam: string;
+    /**
+     * Which field of the data will be used, set it to undefined when no cursor is known.
+     */
+    cursorParam?: string | undefined;
+    /**
+     * The initial value, the value of the first page.
+     * @default 0
+     */
+    initialPageParam: unknown;
+};
+type Options$1 = {
+    /**
+     * Specify the export location for the files and define the behavior of the output
+     * @default { path: 'hooks', barrelType: 'named' }
+     */
+    output?: Output;
+    /**
+     * Group the @tanstack/query hooks based on the provided name.
+     */
+    group?: Group;
+    client?: Pick<PluginClient['options'], 'dataReturnType' | 'importPath' | 'baseURL'>;
+    /**
+     * Array containing exclude parameters to exclude/skip tags/operations/methods/paths.
+     */
+    exclude?: Array<Exclude>;
+    /**
+     * Array containing include parameters to include tags/operations/methods/paths.
+     */
+    include?: Array<Include>;
+    /**
+     * Array containing override parameters to override `options` based on tags/operations/methods/paths.
+     */
+    override?: Array<Override<ResolvedOptions$1>>;
+    /**
+     * How to pass your params
+     * - 'object' will return the params and pathParams as an object.
+     * - 'inline' will return the params as comma separated params.
+     * @default 'inline'
+     */
+    paramsType?: 'object' | 'inline';
+    /**
+     * How to pass your pathParams.
+     * - 'object' will return the pathParams as an object.
+     * - 'inline' will return the pathParams as comma separated params.
+     * @default 'inline'
+     */
+    pathParamsType?: PluginClient['options']['pathParamsType'];
+    /**
+     * When set, an infiniteQuery hooks will be added.
+     */
+    infinite?: Partial<Infinite$1> | false;
+    /**
+     * When set, a suspenseQuery hooks will be added.
+     */
+    suspense?: Partial<Suspense> | false;
+    queryKey?: QueryKey$1;
+    /**
+     * Override some useQuery behaviours.
+     */
+    query?: Partial<Query$1> | false;
+    mutationKey?: MutationKey$1;
+    /**
+     * Override some useMutation behaviours.
+     */
+    mutation?: Partial<Mutation$1> | false;
+    /**
+     * Which parser should be used before returning the data to `@tanstack/query`.
+     * `'zod'` will use `@kubb/plugin-zod` to parse the data.
+     */
+    parser?: PluginClient['options']['parser'];
+    transformers?: {
+        /**
+         * Customize the names based on the type that is provided by the plugin.
+         */
+        name?: (name: ResolveNameParams['name'], type?: ResolveNameParams['type']) => string;
+    };
+    /**
+     * Define some generators next to the react-query generators
+     */
+    generators?: Array<Generator<PluginReactQuery>>;
+};
+type ResolvedOptions$1 = {
+    output: Output;
+    client: Required<Omit<NonNullable<PluginReactQuery['options']['client']>, 'baseURL'>> & {
+        baseURL?: string;
+    };
+    parser: Required<NonNullable<Options$1['parser']>>;
+    pathParamsType: NonNullable<Options$1['pathParamsType']>;
+    paramsType: NonNullable<Options$1['paramsType']>;
+    /**
+     * Only used of infinite
+     */
+    infinite: NonNullable<Infinite$1> | false;
+    suspense: Suspense | false;
+    queryKey: QueryKey$1 | undefined;
+    query: NonNullable<Required<Query$1>> | false;
+    mutationKey: MutationKey$1 | undefined;
+    mutation: NonNullable<Required<Mutation$1>> | false;
+};
+type PluginReactQuery = PluginFactoryOptions<'plugin-react-query', Options$1, ResolvedOptions$1, never, ResolvePathOptions>;
+
+type TransformerProps = {
+    operation: Operation;
+    schemas: OperationSchemas;
+};
+type Transformer = (props: TransformerProps) => unknown[];
+/**
+ * Customize the queryKey
+ */
+type QueryKey = Transformer;
+/**
+ * Customize the mutationKey
+ */
+type MutationKey = Transformer;
+type 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'
+     */
+    importPath?: string;
+};
+type Mutation = {
+    /**
+     * Define which HttpMethods can be used for mutations
+     * @default ['post', 'put', 'delete']
+     */
+    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'
+     */
+    importPath?: string;
+};
+type Infinite = {
+    /**
+     * Specify the params key used for `pageParam`.
+     * @default `'id'`
+     */
+    queryParam: string;
+    /**
+     * Which field of the data will be used, set it to undefined when no cursor is known.
+     */
+    cursorParam?: string | undefined;
+    /**
+     * The initial value, the value of the first page.
+     * @default `0`
+     */
+    initialPageParam: unknown;
+};
+type Options = {
+    /**
+     * Specify the export location for the files and define the behavior of the output
+     * @default { path: 'hooks', barrelType: 'named' }
+     */
+    output?: Output;
+    /**
+     * Group the @tanstack/query hooks based on the provided name.
+     */
+    group?: Group;
+    client?: Pick<PluginClient['options'], 'dataReturnType' | 'importPath' | 'baseURL'>;
+    /**
+     * Array containing exclude parameters to exclude/skip tags/operations/methods/paths.
+     */
+    exclude?: Array<Exclude>;
+    /**
+     * Array containing include parameters to include tags/operations/methods/paths.
+     */
+    include?: Array<Include>;
+    /**
+     * Array containing override parameters to override `options` based on tags/operations/methods/paths.
+     */
+    override?: Array<Override<ResolvedOptions>>;
+    /**
+     * How to pass your params
+     * - 'object' will return the params and pathParams as an object.
+     * - 'inline' will return the params as comma separated params.
+     * @default 'inline'
+     */
+    paramsType?: 'object' | 'inline';
+    /**
+     * How to pass your pathParams.
+     * - 'object' will return the pathParams as an object.
+     * - 'inline' will return the pathParams as comma separated params.
+     * @default 'inline'
+     */
+    pathParamsType?: PluginClient['options']['pathParamsType'];
+    /**
+     * When set, an infiniteQuery hooks will be added.
+     */
+    infinite?: Partial<Infinite> | false;
+    queryKey?: QueryKey;
+    /**
+     * Override some useQuery behaviours.
+     */
+    query?: Partial<Query> | false;
+    mutationKey?: MutationKey;
+    /**
+     * Override some useMutation behaviours.
+     */
+    mutation?: Mutation | false;
+    /**
+     * Which parser should be used before returning the data to `@tanstack/query`.
+     * `'zod'` will use `@kubb/plugin-zod` to parse the data.
+     */
+    parser?: PluginClient['options']['parser'];
+    transformers?: {
+        /**
+         * Customize the names based on the type that is provided by the plugin.
+         */
+        name?: (name: ResolveNameParams['name'], type?: ResolveNameParams['type']) => string;
+    };
+    /**
+     * Define some generators next to the vue-query generators
+     */
+    generators?: Array<Generator<PluginVueQuery>>;
+};
+type ResolvedOptions = {
+    output: Output;
+    client: Required<Omit<NonNullable<PluginReactQuery['options']['client']>, 'baseURL'>> & {
+        baseURL?: string;
+    };
+    parser: Required<NonNullable<Options['parser']>>;
+    paramsType: NonNullable<Options['paramsType']>;
+    pathParamsType: NonNullable<Options['pathParamsType']>;
+    /**
+     * Only used of infinite
+     */
+    infinite: NonNullable<Infinite> | false;
+    queryKey: QueryKey | undefined;
+    query: NonNullable<Required<Query>> | false;
+    mutationKey: MutationKey | undefined;
+    mutation: NonNullable<Required<Mutation>> | false;
+};
+type PluginVueQuery = PluginFactoryOptions<'plugin-vue-query', Options, ResolvedOptions, never, ResolvePathOptions>;
+
+export type { Infinite as I, Options as O, PluginVueQuery as P, Transformer as T };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@kubb/plugin-vue-query",
-  "version": "3.0.0-beta.8",
+  "version": "3.0.0",
   "description": "Generator vue-query hooks",
   "keywords": [
     "faker",
@@ -62,24 +62,24 @@
     "!/**/__tests__/**"
   ],
   "dependencies": {
-    "@kubb/core": "3.0.0-beta.8",
-    "@kubb/fs": "3.0.0-beta.8",
-    "@kubb/oas": "3.0.0-beta.8",
-    "@kubb/plugin-oas": "3.0.0-beta.8",
-    "@kubb/plugin-ts": "3.0.0-beta.8",
-    "@kubb/plugin-zod": "3.0.0-beta.8",
-    "@kubb/react": "3.0.0-beta.8"
+    "@kubb/core": "3.0.0",
+    "@kubb/oas": "3.0.0",
+    "@kubb/fs": "3.0.0",
+    "@kubb/plugin-oas": "3.0.0",
+    "@kubb/plugin-ts": "3.0.0",
+    "@kubb/plugin-zod": "3.0.0",
+    "@kubb/react": "3.0.0"
   },
   "devDependencies": {
-    "@types/react": "^18.3.11",
+    "@types/react": "^18.3.12",
     "react": "^18.3.1",
-    "tsup": "^8.3.0",
+    "tsup": "^8.3.5",
     "typescript": "^5.6.3",
-    "@kubb/config-ts": "3.0.0-beta.8",
-    "@kubb/config-tsup": "3.0.0-beta.8"
+    "@kubb/config-ts": "3.0.0",
+    "@kubb/config-tsup": "3.0.0"
   },
   "peerDependencies": {
-    "@kubb/react": "3.0.0-beta.8"
+    "@kubb/react": "3.0.0"
   },
   "engines": {
     "node": ">=20"

package/src/components/InfiniteQuery.tsx

@@ -18,22 +18,72 @@ type Props = {
   queryKeyTypeName: string
   typeSchemas: OperationSchemas
   operation: Operation
+  paramsType: PluginVueQuery['resolvedOptions']['paramsType']
   pathParamsType: PluginVueQuery['resolvedOptions']['pathParamsType']
   dataReturnType: PluginVueQuery['resolvedOptions']['client']['dataReturnType']
 }
 
 type GetParamsProps = {
+  paramsType: PluginVueQuery['resolvedOptions']['paramsType']
   pathParamsType: PluginVueQuery['resolvedOptions']['pathParamsType']
   dataReturnType: PluginVueQuery['resolvedOptions']['client']['dataReturnType']
   typeSchemas: OperationSchemas
 }
 
-function getParams({ pathParamsType, dataReturnType, typeSchemas }: GetParamsProps) {
+function getParams({ paramsType, pathParamsType, dataReturnType, typeSchemas }: GetParamsProps) {
   const TData = dataReturnType === 'data' ? typeSchemas.response.name : `ResponseConfig<${typeSchemas.response.name}>`
 
+  if (paramsType === 'object') {
+    return FunctionParams.factory({
+      data: {
+        mode: 'object',
+        children: {
+          ...getPathParams(typeSchemas.pathParams, {
+            typed: true,
+            override(item) {
+              return {
+                ...item,
+                type: `MaybeRef<${item.type}>`,
+              }
+            },
+          }),
+          data: typeSchemas.request?.name
+            ? {
+                type: `MaybeRef<${typeSchemas.request?.name}>`,
+                optional: isOptional(typeSchemas.request?.schema),
+              }
+            : undefined,
+          params: typeSchemas.queryParams?.name
+            ? {
+                type: `MaybeRef<${typeSchemas.queryParams?.name}>`,
+                optional: isOptional(typeSchemas.queryParams?.schema),
+              }
+            : undefined,
+          headers: typeSchemas.headerParams?.name
+            ? {
+                type: `MaybeRef<${typeSchemas.headerParams?.name}>`,
+                optional: isOptional(typeSchemas.headerParams?.schema),
+              }
+            : undefined,
+        },
+      },
+      options: {
+        type: `
+{
+  query?: Partial<InfiniteQueryObserverOptions<${[TData, typeSchemas.errors?.map((item) => item.name).join(' | ') || 'Error', 'TData', 'TQueryData', 'TQueryKey'].join(', ')}>>,
+  client?: ${typeSchemas.request?.name ? `Partial<RequestConfig<${typeSchemas.request?.name}>>` : 'Partial<RequestConfig>'}
+}
+`,
+        default: '{}',
+      },
+    })
+  }
+
   return FunctionParams.factory({
     pathParams: {
       mode: pathParamsType === 'object' ? 'object' : 'inlineSpread',
+      type: typeSchemas.pathParams?.name,
+      optional: isOptional(typeSchemas.pathParams?.schema),
       children: getPathParams(typeSchemas.pathParams, {
         typed: true,
         override(item) {
@@ -79,6 +129,7 @@ export function InfiniteQuery({
   queryKeyTypeName,
   queryOptionsName,
   queryKeyName,
+  paramsType,
   pathParamsType,
   dataReturnType,
   typeSchemas,
@@ -93,10 +144,12 @@ export function InfiniteQuery({
     typeSchemas,
   })
   const queryOptionsParams = QueryOptions.getParams({
+    paramsType,
     pathParamsType,
     typeSchemas,
   })
   const params = getParams({
+    paramsType,
     pathParamsType,
     dataReturnType,
     typeSchemas,

package/src/components/InfiniteQueryOptions.tsx

@@ -14,6 +14,7 @@ type Props = {
   clientName: string
   queryKeyName: string
   typeSchemas: OperationSchemas
+  paramsType: PluginVueQuery['resolvedOptions']['paramsType']
   pathParamsType: PluginVueQuery['resolvedOptions']['pathParamsType']
   dataReturnType: PluginVueQuery['resolvedOptions']['client']['dataReturnType']
   initialPageParam: Infinite['initialPageParam']
@@ -22,14 +23,58 @@ type Props = {
 }
 
 type GetParamsProps = {
+  paramsType: PluginVueQuery['resolvedOptions']['paramsType']
   pathParamsType: PluginVueQuery['resolvedOptions']['pathParamsType']
   typeSchemas: OperationSchemas
 }
 
-function getParams({ pathParamsType, typeSchemas }: GetParamsProps) {
+function getParams({ paramsType, pathParamsType, typeSchemas }: GetParamsProps) {
+  if (paramsType === 'object') {
+    return FunctionParams.factory({
+      data: {
+        mode: 'object',
+        children: {
+          ...getPathParams(typeSchemas.pathParams, {
+            typed: true,
+            override(item) {
+              return {
+                ...item,
+                type: `MaybeRef<${item.type}>`,
+              }
+            },
+          }),
+          data: typeSchemas.request?.name
+            ? {
+                type: `MaybeRef<${typeSchemas.request?.name}>`,
+                optional: isOptional(typeSchemas.request?.schema),
+              }
+            : undefined,
+          params: typeSchemas.queryParams?.name
+            ? {
+                type: `MaybeRef<${typeSchemas.queryParams?.name}>`,
+                optional: isOptional(typeSchemas.queryParams?.schema),
+              }
+            : undefined,
+          headers: typeSchemas.headerParams?.name
+            ? {
+                type: `MaybeRef<${typeSchemas.queryParams?.name}>`,
+                optional: isOptional(typeSchemas.headerParams?.schema),
+              }
+            : undefined,
+        },
+      },
+      config: {
+        type: typeSchemas.request?.name ? `Partial<RequestConfig<${typeSchemas.request?.name}>>` : 'Partial<RequestConfig>',
+        default: '{}',
+      },
+    })
+  }
+
   return FunctionParams.factory({
     pathParams: {
       mode: pathParamsType === 'object' ? 'object' : 'inlineSpread',
+      type: typeSchemas.pathParams?.name,
+      optional: isOptional(typeSchemas.pathParams?.schema),
       children: getPathParams(typeSchemas.pathParams, {
         typed: true,
         override(item) {
@@ -71,13 +116,15 @@ export function InfiniteQueryOptions({
   initialPageParam,
   cursorParam,
   typeSchemas,
+  paramsType,
   dataReturnType,
   pathParamsType,
   queryParam,
   queryKeyName,
 }: Props): ReactNode {
-  const params = getParams({ pathParamsType, typeSchemas })
+  const params = getParams({ paramsType, pathParamsType, typeSchemas })
   const clientParams = Client.getParams({
+    paramsType,
     typeSchemas,
     pathParamsType,
   })

package/src/components/Mutation.tsx

@@ -19,6 +19,7 @@ type Props = {
   mutationKeyName: string
   typeSchemas: OperationSchemas
   operation: Operation
+  paramsType: PluginVueQuery['resolvedOptions']['paramsType']
   dataReturnType: PluginVueQuery['resolvedOptions']['client']['dataReturnType']
   pathParamsType: PluginVueQuery['resolvedOptions']['pathParamsType']
 }
@@ -66,7 +67,7 @@ function getParams({ dataReturnType, typeSchemas }: GetParamsProps) {
     options: {
       type: `
 {
-  mutation?: MutationObserverOptions<${[TData, typeSchemas.errors?.map((item) => item.name).join(' | ') || 'Error', `{${TRequest}}`].join(', ')}>,
+  mutation?: MutationObserverOptions<${[TData, typeSchemas.errors?.map((item) => item.name).join(' | ') || 'Error', TRequest ? `{${TRequest}}` : undefined].filter(Boolean).join(', ')}>,
   client?: ${typeSchemas.request?.name ? `Partial<RequestConfig<${typeSchemas.request?.name}>>` : 'Partial<RequestConfig>'},
 }
 `,
@@ -75,7 +76,7 @@ function getParams({ dataReturnType, typeSchemas }: GetParamsProps) {
   })
 }
 
-export function Mutation({ name, clientName, pathParamsType, dataReturnType, typeSchemas, operation, mutationKeyName }: Props): ReactNode {
+export function Mutation({ name, clientName, paramsType, pathParamsType, dataReturnType, typeSchemas, operation, mutationKeyName }: Props): ReactNode {
   const mutationKeyParams = MutationKey.getParams({
     pathParamsType,
     typeSchemas,
@@ -88,6 +89,7 @@ export function Mutation({ name, clientName, pathParamsType, dataReturnType, typ
   })
 
   const clientParams = Client.getParams({
+    paramsType,
     typeSchemas,
     pathParamsType,
   })
@@ -133,7 +135,9 @@ export function Mutation({ name, clientName, pathParamsType, dataReturnType, typ
 
   const TRequest = mutationParams.toConstructor({ valueAsType: true })
   const TData = dataReturnType === 'data' ? typeSchemas.response.name : `ResponseConfig<${typeSchemas.response.name}>`
-  const generics = [TData, typeSchemas.errors?.map((item) => item.name).join(' | ') || 'Error', `{${TRequest}}`].join(', ')
+  const generics = [TData, typeSchemas.errors?.map((item) => item.name).join(' | ') || 'Error', TRequest ? `{${TRequest}}` : undefined]
+    .filter(Boolean)
+    .join(', ')
 
   return (
     <File.Source name={name} isExportable isIndexable>