@kubb/plugin-svelte-query 3.0.0-alpha.31 → 3.0.0-beta.10

package/dist/types-s0tn0Q8J.d.ts

@@ -1,138 +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 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/svelte-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/svelte-query'
-     */
-    importPath?: string;
-};
-type Options = {
-    /**
-     * @default 'hooks'
-     */
-    output?: Output;
-    /**
-     * Group the @tanstack/query hooks based on the provided name.
-     */
-    group?: Group;
-    client?: {
-        /**
-         * Path to the client 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.
-         * the path will be applied as is, so relative path should 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';
-    };
-    /**
-     * ReturnType that needs to be used when calling client().
-     *
-     * `Data` will return ResponseConfig[data].
-     *
-     * `Full` will return ResponseConfig.
-     * @default `'data'`
-     * @private
-     */
-    /**
-     * 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'`
-     * @private
-     */
-    pathParamsType?: 'object' | 'inline';
-    /**
-     * 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?: '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 svelte-query generators
-     */
-    generators?: Array<Generator<PluginSvelteQuery>>;
-};
-type ResolvedOptions = {
-    output: Output;
-    baseURL: string | undefined;
-    client: Required<NonNullable<PluginSvelteQuery['options']['client']>>;
-    parser: Required<NonNullable<Options['parser']>>;
-    pathParamsType: NonNullable<Options['pathParamsType']>;
-    query: NonNullable<Required<Query>> | false;
-    mutation: NonNullable<Required<Mutation>> | false;
-};
-type PluginSvelteQuery = PluginFactoryOptions<'plugin-svelte-query', Options, ResolvedOptions, never, ResolvePathOptions>;
-
-export type { Options as O, PluginSvelteQuery as P };