@kubb/plugin-svelte-query 0.0.0-canary-20241104172400

package/dist/types-B9W9aYra.d.cts

@@ -0,0 +1,365 @@
+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 = {
+    /**
+     * 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> | 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> | 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/svelte-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/svelte-query'
+     */
+    importPath?: string;
+};
+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'];
+    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 svelte-query generators
+     */
+    generators?: Array<Generator<PluginSvelteQuery>>;
+};
+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']>;
+    queryKey: QueryKey | undefined;
+    query: NonNullable<Required<Query>> | false;
+    mutationKey: MutationKey | undefined;
+    mutation: NonNullable<Required<Mutation>> | false;
+};
+type PluginSvelteQuery = PluginFactoryOptions<'plugin-svelte-query', Options, ResolvedOptions, never, ResolvePathOptions>;
+
+export type { Options as O, PluginSvelteQuery as P, Transformer as T };