@kubb/plugin-vue-query 3.0.0-beta.9 → 3.0.1

package/dist/types-BGseXQR_.d.ts

@@ -1,208 +0,0 @@
-import { PluginFactoryOptions, Output, Group, ResolveNameParams } from '@kubb/core';
-import { HttpMethod } from '@kubb/oas';
-import { ResolvePathOptions, Exclude, Include, Override, Generator } from '@kubb/plugin-oas';
-
-type Options$1 = {
-    /**
-     * 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$1>>;
-    /**
-     * 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;
-    /**
-     * 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 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$1 = {
-    output: Output;
-    group?: Options$1['group'];
-    baseURL: string | undefined;
-    parser: NonNullable<Options$1['parser']>;
-    importPath: NonNullable<Options$1['importPath']>;
-    dataReturnType: NonNullable<Options$1['dataReturnType']>;
-    pathParamsType: NonNullable<Options$1['pathParamsType']>;
-};
-type PluginClient = PluginFactoryOptions<'plugin-client', Options$1, ResolvedOptions$1, never, ResolvePathOptions>;
-
-type Query = {
-    /**
-     * Customize the queryKey, here you can specify a suffix.
-     */
-    key: (key: unknown[]) => unknown[];
-    /**
-     * 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 = {
-    /**
-     * Customize the queryKey, here you can specify a suffix.
-     */
-    key: (key: unknown[]) => unknown[];
-    /**
-     * 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'>;
-    /**
-     * 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 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;
-    /**
-     * Override some useQuery behaviours.
-     */
-    query?: Partial<Query> | false;
-    /**
-     * Override some useMutation behaviours.
-     */
-    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?: 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;
-    baseURL: string | undefined;
-    client: Required<NonNullable<PluginVueQuery['options']['client']>>;
-    parser: Required<NonNullable<Options['parser']>>;
-    pathParamsType: NonNullable<Options['pathParamsType']>;
-    /**
-     * Only used of infinite
-     */
-    infinite: NonNullable<Infinite> | false;
-    query: NonNullable<Required<Query>> | false;
-    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 };