@kubb/plugin-swr 3.0.0-beta.9 → 3.0.0

package/dist/types-Bt7A3YoC.d.cts

@@ -1,101 +0,0 @@
-import { PluginFactoryOptions, Output, Group, ResolveNameParams } from '@kubb/core';
-import { HttpMethod } from '@kubb/oas';
-import { PluginClient } from '@kubb/plugin-client';
-import { ResolvePathOptions, Exclude, Include, Override, Generator } from '@kubb/plugin-oas';
-
-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 SWR hooks 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>>;
-    client?: Pick<PluginClient['options'], 'dataReturnType' | 'importPath'>;
-    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 'swr'
-         */
-        importPath?: string;
-    };
-    mutation?: {
-        /**
-         * Customize the queryKey, here you can specify a suffix.
-         */
-        key: (key: unknown[]) => unknown[];
-        /**
-         * 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 'swr/mutation'
-         */
-        importPath?: string;
-    };
-    /**
-     * 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'];
-    /**
-     * Which parser can be used before returning the data to `swr`.
-     * `'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 swr generators
-     */
-    generators?: Array<Generator<PluginSwr>>;
-};
-type ResolvedOptions = {
-    output: Output;
-    baseURL: string | undefined;
-    client: Required<NonNullable<Options['client']>>;
-    parser: Required<NonNullable<Options['parser']>>;
-    mutation: Required<NonNullable<Options['mutation']>>;
-    query: Required<NonNullable<Options['query']>>;
-    pathParamsType: NonNullable<Options['pathParamsType']>;
-};
-type PluginSwr = PluginFactoryOptions<'plugin-swr', Options, ResolvedOptions, never, ResolvePathOptions>;
-
-export type { Options as O, PluginSwr as P };

package/dist/types-Bt7A3YoC.d.ts

@@ -1,101 +0,0 @@
-import { PluginFactoryOptions, Output, Group, ResolveNameParams } from '@kubb/core';
-import { HttpMethod } from '@kubb/oas';
-import { PluginClient } from '@kubb/plugin-client';
-import { ResolvePathOptions, Exclude, Include, Override, Generator } from '@kubb/plugin-oas';
-
-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 SWR hooks 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>>;
-    client?: Pick<PluginClient['options'], 'dataReturnType' | 'importPath'>;
-    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 'swr'
-         */
-        importPath?: string;
-    };
-    mutation?: {
-        /**
-         * Customize the queryKey, here you can specify a suffix.
-         */
-        key: (key: unknown[]) => unknown[];
-        /**
-         * 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 'swr/mutation'
-         */
-        importPath?: string;
-    };
-    /**
-     * 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'];
-    /**
-     * Which parser can be used before returning the data to `swr`.
-     * `'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 swr generators
-     */
-    generators?: Array<Generator<PluginSwr>>;
-};
-type ResolvedOptions = {
-    output: Output;
-    baseURL: string | undefined;
-    client: Required<NonNullable<Options['client']>>;
-    parser: Required<NonNullable<Options['parser']>>;
-    mutation: Required<NonNullable<Options['mutation']>>;
-    query: Required<NonNullable<Options['query']>>;
-    pathParamsType: NonNullable<Options['pathParamsType']>;
-};
-type PluginSwr = PluginFactoryOptions<'plugin-swr', Options, ResolvedOptions, never, ResolvePathOptions>;
-
-export type { Options as O, PluginSwr as P };