@kubb/plugin-client 3.16.2 → 3.16.4

package/dist/types-DFo3xInC.d.ts

@@ -1,119 +0,0 @@
-import { Output, Group, ResolveNameParams, PluginFactoryOptions } from '@kubb/core';
-import { Oas, contentType } from '@kubb/oas';
-import { Exclude, Include, Override, Generator, ResolvePathOptions } from '@kubb/plugin-oas';
-
-type Options = {
-    /**
-     * Specify the export location for the files and define the behavior of the output
-     * @default { path: 'clients', barrelType: 'named' }
-     */
-    output?: Output<Oas>;
-    /**
-     * Define which contentType should be used.
-     * By default, the first JSON valid mediaType will be used
-     */
-    contentType?: contentType;
-    /**
-     * 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>>;
-    /**
-     * Create `operations.ts` file with all operations grouped by methods.
-     * @default false
-     */
-    operations?: boolean;
-    /**
-     * Export urls that are used by operation x
-     * `export` will make them part of your barrel file
-     * false will not make them exportable
-     * @example getGetPetByIdUrl
-     */
-    urlType?: 'export' | false;
-    /**
-     * 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/clients/axios'
-     */
-    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 style your params, by default no casing is applied
-     * - 'camelcase' will use camelcase for the params names
-     */
-    paramsCasing?: 'camelcase';
-    /**
-     * 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';
-    /**
-     * Which client should be used to do the HTTP calls
-     * - 'axios' will use `@kubb/plugin-client/clients/axios` to fetch data.
-     * - 'fetch' will use `@kubb/plugin-client/clients/fetch` to fetch data.
-     * @default 'axios'
-     */
-    client?: 'axios' | 'fetch';
-    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 = {
-    output: Output<Oas>;
-    group?: Options['group'];
-    baseURL: string | undefined;
-    parser: NonNullable<Options['parser']>;
-    urlType: NonNullable<Options['urlType']>;
-    importPath: NonNullable<Options['importPath']>;
-    dataReturnType: NonNullable<Options['dataReturnType']>;
-    pathParamsType: NonNullable<Options['pathParamsType']>;
-    paramsType: NonNullable<Options['paramsType']>;
-    paramsCasing: Options['paramsCasing'];
-};
-type PluginClient = PluginFactoryOptions<'plugin-client', Options, ResolvedOptions, never, ResolvePathOptions>;
-
-export type { Options as O, PluginClient as P };