@kubb/plugin-swr/dist/types-CuBoU7mG.d.ts

SWR hooks generator plugin for Kubb, creating type-safe data fetching hooks from OpenAPI specifications for React and Next.js applications.

import { t as __name } from "./chunk-DKWOrOAv.js";
import { Group, Output, PluginFactoryOptions, ResolveNameParams } from "@kubb/core";
import { ClientImportPath, PluginClient } from "@kubb/plugin-client";
import { Exclude, Include, OperationSchemas, Override, ResolvePathOptions } from "@kubb/plugin-oas";
import { HttpMethod, Oas, Operation, contentType } from "@kubb/oas";
import { Generator } from "@kubb/plugin-oas/generators";

//#region src/types.d.ts
type TransformerProps = {
  operation: Operation;
  schemas: OperationSchemas;
  casing: 'camelcase' | undefined;
};
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 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 'swr'
   */
  importPath?: string;
};
type Mutation = {
  /**
   * Define which HttpMethods can be used for queries
   * @default ['post', 'put', 'delete', 'patch']
   */
  methods?: Array<HttpMethod>;
  /**
   * 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 'swr/mutation'
   */
  importPath?: string;
  /**
   * When true, mutation parameters (path params, query params, headers, body) is passed via `trigger()` instead of as hook arguments.
   * This aligns with React Query's mutation pattern where variables are passed when triggering the mutation.
   * @default false
   * @deprecated This will become the default behavior in v5. Set to `true` to opt-in early.
   */
  paramsToTrigger?: boolean;
};
type Options = {
  /**
   * Specify the export location for the files and define the behavior of the output
   * @default { path: 'hooks', barrelType: 'named' }
   */
  output?: Output<Oas>;
  /**
   * Define which contentType should be used.
   * By default, the first JSON valid mediaType is used
   */
  contentType?: contentType;
  /**
   * 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?: ClientImportPath & Pick<PluginClient['options'], 'clientType' | 'dataReturnType' | 'baseURL' | 'bundle' | 'paramsCasing'>;
  queryKey?: QueryKey;
  query?: Query | false;
  mutationKey?: MutationKey;
  mutation?: Mutation | false;
  /**
   * How to style your params, by default no casing is applied
   * - 'camelcase' uses camelcase for the params names
   */
  paramsCasing?: 'camelcase';
  /**
   * How to pass your params
   * - 'object' returns the params and pathParams as an object.
   * - 'inline' returns the params as comma separated params.
   * @default 'inline'
   */
  paramsType?: 'object' | 'inline';
  /**
   * How to pass your pathParams.
   * - 'object' returns the pathParams as an object.
   * - 'inline': returns the pathParams as comma separated params.
   * @default 'inline'
   */
  pathParamsType?: PluginClient['options']['pathParamsType'];
  /**
   * Which parser should be used before returning the data to `swr`.
   * `'zod'` uses `@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<Oas>;
  client: Pick<PluginClient['options'], 'client' | 'clientType' | 'dataReturnType' | 'importPath' | 'baseURL' | 'bundle' | 'paramsCasing'>;
  parser: Required<NonNullable<Options['parser']>>;
  queryKey: QueryKey | undefined;
  query: NonNullable<Required<Query>> | false;
  mutationKey: MutationKey | undefined;
  mutation: (Required<Pick<Mutation, 'methods' | 'importPath'>> & Pick<Mutation, 'paramsToTrigger'>) | false;
  paramsCasing: Options['paramsCasing'];
  paramsType: NonNullable<Options['paramsType']>;
  pathParamsType: NonNullable<Options['pathParamsType']>;
  group: Options['group'];
};
type PluginSwr = PluginFactoryOptions<'plugin-swr', Options, ResolvedOptions, never, ResolvePathOptions>;
//#endregion
export { PluginSwr as n, Transformer as r, Options as t };
//# sourceMappingURL=types-CuBoU7mG.d.ts.map