@kubb/plugin-vue-query 5.0.0-beta.3 → 5.0.0-beta.30

package/dist/types-nVDTfuS1.d.ts

@@ -1,194 +0,0 @@
-import { t as __name } from "./chunk--u3MIqq1.js";
-import { Exclude, Generator, Group, Include, Output, Override, PluginFactoryOptions, Resolver, ast } from "@kubb/core";
-import { ClientImportPath, PluginClient } from "@kubb/plugin-client";
-
-//#region src/types.d.ts
-type Transformer = (props: {
-  node: ast.OperationNode;
-  casing: 'camelcase' | undefined;
-}) => unknown[];
-/**
- * Resolver for Vue Query that provides naming methods for hook functions.
- */
-type ResolverVueQuery = Resolver & {
-  /**
-   * Resolves the hook function name for an operation.
-   */
-  resolveName(this: ResolverVueQuery, name: string): string;
-};
-/**
- * Customize the queryKey.
- */
-type QueryKey = Transformer;
-/**
- * Customize the mutationKey.
- */
-type MutationKey = Transformer;
-type Query = {
-  /**
-   * HTTP methods to use for queries.
-   *
-   * @default ['get']
-   */
-  methods?: Array<string>;
-  /**
-   * Path to the useQuery hook for useQuery functionality.
-   * Used as `import { useQuery } from '${importPath}'`.
-   * Accepts relative and absolute paths.
-   * Path is used as-is; relative paths are based on the generated file location.
-   * @default '@tanstack/vue-query'
-   */
-  importPath?: string;
-};
-type Mutation = {
-  /**
-   * HTTP methods to use for mutations.
-   *
-   * @default ['post', 'put', 'delete']
-   */
-  methods?: Array<string>;
-  /**
-   * Path to the useMutation hook for useMutation functionality.
-   * Used as `import { useMutation } from '${importPath}'`.
-   * Accepts relative and absolute paths.
-   * Path is used as-is; relative paths are based on the generated file location.
-   * @default '@tanstack/vue-query'
-   */
-  importPath?: string;
-};
-type Infinite = {
-  /**
-   * Specify the params key used for `pageParam`.
-   * @default 'id'
-   */
-  queryParam: string;
-  /**
-   * Which field of the data is used, set it to undefined when no cursor is known.
-   * @deprecated Use `nextParam` and `previousParam` instead for more flexible pagination handling.
-   */
-  cursorParam?: string | undefined;
-  /**
-   * Which field of the data is used to get the cursor for the next page.
-   * Supports dot notation (e.g. 'pagination.next.id') or array path (e.g. ['pagination', 'next', 'id']) to access nested fields.
-   */
-  nextParam?: string | string[] | undefined;
-  /**
-   * Which field of the data is used to get the cursor for the previous page.
-   * Supports dot notation (e.g. 'pagination.prev.id') or array path (e.g. ['pagination', 'prev', 'id']) to access nested fields.
-   */
-  previousParam?: string | 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?: ClientImportPath & Pick<PluginClient['options'], 'clientType' | 'dataReturnType' | 'baseURL' | 'bundle' | 'paramsCasing'>;
-  /**
-   * Tags, operations, or paths to exclude from generation.
-   */
-  exclude?: Array<Exclude>;
-  /**
-   * Tags, operations, or paths to include in generation.
-   */
-  include?: Array<Include>;
-  /**
-   * Override options for specific tags, operations, or paths.
-   */
-  override?: Array<Override<ResolvedOptions>>;
-  /**
-   * Apply casing to parameter names.
-   */
-  paramsCasing?: 'camelcase';
-  /**
-   * How parameters are passed: grouped in an object or spread inline.
-   *
-   * @default 'inline'
-   */
-  paramsType?: 'object' | 'inline';
-  /**
-   * How path parameters are passed: grouped in an object or spread inline.
-   *
-   * @default 'inline'
-   */
-  pathParamsType?: PluginClient['options']['pathParamsType'];
-  /**
-   * Add infinite query hooks.
-   */
-  infinite?: Partial<Infinite> | false;
-  queryKey?: QueryKey;
-  /**
-   * Configure useQuery behavior.
-   */
-  query?: Partial<Query> | false;
-  mutationKey?: MutationKey;
-  /**
-   * Configure useMutation behavior.
-   */
-  mutation?: Partial<Mutation> | false;
-  /**
-   * Parser to use for validating response data.
-   */
-  parser?: PluginClient['options']['parser'];
-  transformers?: {
-    /**
-     * Override the default naming for hooks.
-     */
-    name?: (name: string, type?: string) => string;
-  };
-  /**
-   * Override naming conventions for function names and types.
-   */
-  resolver?: Partial<ResolverVueQuery> & ThisType<ResolverVueQuery>;
-  /**
-   * AST visitor to transform generated nodes.
-   */
-  transformer?: ast.Visitor;
-  /**
-   * Additional generators alongside the default generators.
-   */
-  generators?: Array<Generator<PluginVueQuery>>;
-};
-type ResolvedOptions = {
-  output: Output;
-  group: Group | undefined;
-  exclude: NonNullable<Options['exclude']>;
-  include: Options['include'];
-  override: NonNullable<Options['override']>;
-  client: Pick<PluginClient['options'], 'client' | 'clientType' | 'dataReturnType' | 'importPath' | 'baseURL' | 'bundle' | 'paramsCasing'>;
-  parser: Required<NonNullable<Options['parser']>>;
-  pathParamsType: NonNullable<Options['pathParamsType']>;
-  paramsCasing: Options['paramsCasing'];
-  paramsType: NonNullable<Options['paramsType']>;
-  /**
-   * Only used for infinite
-   */
-  infinite: NonNullable<Infinite> | false;
-  queryKey: QueryKey | undefined;
-  query: NonNullable<Required<Query>> | false;
-  mutationKey: MutationKey | undefined;
-  mutation: NonNullable<Required<Mutation>> | false;
-  resolver: ResolverVueQuery;
-  transformers: NonNullable<Options['transformers']>;
-};
-type PluginVueQuery = PluginFactoryOptions<'plugin-vue-query', Options, ResolvedOptions, ResolverVueQuery>;
-declare global {
-  namespace Kubb {
-    interface PluginRegistry {
-      'plugin-vue-query': PluginVueQuery;
-    }
-  }
-}
-//#endregion
-export { Transformer as i, Options as n, PluginVueQuery as r, Infinite as t };
-//# sourceMappingURL=types-nVDTfuS1.d.ts.map