@kubb/plugin-react-query 5.0.0-beta.87 → 5.0.0-beta.95

package/dist/index.d.ts

@@ -21,6 +21,15 @@ import { Exclude, Group, Include, Output, OutputOptions, Override, PluginFactory
  * client plugin.
  */
 type ClientSelector = 'fetch' | 'axios';
+/**
+ * The resolved client strategy stored in a consumer plugin's options: the generated code always
+ * imports and calls a registered contract client plugin's `<op>`. The client runtime lives in
+ * plugin-axios / plugin-fetch, so nothing is bundled by the consumer.
+ */
+type ResolvedContractClient = {
+  kind: 'contract';
+  pluginName: string;
+};
 //#endregion
 //#region ../../internals/tanstack-query/src/types.d.ts
 type ParamsCasing = 'camelcase' | undefined;
@@ -28,6 +37,76 @@ type Transformer = (props: {
   node: ast.OperationNode;
   casing: ParamsCasing;
 }) => Array<unknown>;
+/**
+ * Configures the query side of a TanStack-family plugin: which HTTP methods produce query
+ * hooks and where the query runtime is imported from.
+ */
+type Query = {
+  /**
+   * HTTP methods treated as queries. Operations using these methods produce
+   * `useQuery`-style hooks.
+   *
+   * @default ['GET']
+   */
+  methods?: Array<string>;
+  /**
+   * Module specifier used in the `import { useQuery } from '...'` statement at
+   * the top of every generated file. Each plugin defaults this to its own runtime
+   * package. Useful for routing through a wrapper that injects a default
+   * `queryClient`.
+   */
+  importPath?: string;
+};
+/**
+ * Configures the mutation side of a TanStack-family plugin: which HTTP methods produce
+ * mutation hooks and where the mutation runtime is imported from.
+ */
+type Mutation = {
+  /**
+   * HTTP methods treated as mutations. Operations using these methods produce
+   * `useMutation`-style hooks.
+   *
+   * @default ['POST', 'PUT', 'PATCH', 'DELETE']
+   */
+  methods?: Array<string>;
+  /**
+   * Module specifier used in the `import { useMutation } from '...'` statement
+   * at the top of every generated file. Each plugin defaults this to its own
+   * runtime package.
+   */
+  importPath?: string;
+};
+type Infinite = {
+  /**
+   * Name of the query parameter that holds the page cursor.
+   *
+   * @default 'id'
+   */
+  queryParam?: string;
+  /**
+   * Path to the cursor field on the response. Leave undefined when the cursor
+   * is not known.
+   *
+   * @deprecated Use `nextParam` and `previousParam` for richer pagination control.
+   */
+  cursorParam?: string | null;
+  /**
+   * Path to the next-page cursor on the response. Supports dot notation
+   * (`'pagination.next.id'`) or array form (`['pagination', 'next', 'id']`).
+   */
+  nextParam?: string | Array<string> | null;
+  /**
+   * Path to the previous-page cursor on the response. Supports dot notation
+   * or array form.
+   */
+  previousParam?: string | Array<string> | null;
+  /**
+   * Initial value for `pageParam` on the first fetch.
+   *
+   * @default 0
+   */
+  initialPageParam?: unknown;
+};
 //#endregion
 //#region src/types.d.ts
 /**
@@ -218,70 +297,6 @@ type QueryKey = Transformer;
  * strings in `JSON.stringify(...)`.
  */
 type MutationKey = Transformer;
-type Query = {
-  /**
-   * HTTP methods treated as queries. Operations using these methods produce
-   * `useQuery`-style hooks.
-   *
-   * @default ['GET']
-   */
-  methods?: Array<string>;
-  /**
-   * Module specifier used in the `import { useQuery } from '...'` statement at
-   * the top of every generated hook file. Useful for routing through a wrapper
-   * that injects a default `queryClient`.
-   *
-   * @default '@tanstack/react-query'
-   */
-  importPath?: string;
-};
-type Mutation = {
-  /**
-   * HTTP methods treated as mutations. Operations using these methods produce
-   * `useMutation`-style hooks.
-   *
-   * @default ['POST', 'PUT', 'PATCH', 'DELETE']
-   */
-  methods?: Array<string>;
-  /**
-   * Module specifier used in the `import { useMutation } from '...'` statement
-   * at the top of every generated hook file.
-   *
-   * @default '@tanstack/react-query'
-   */
-  importPath?: string;
-};
-type Infinite = {
-  /**
-   * Name of the query parameter that holds the page cursor.
-   *
-   * @default 'id'
-   */
-  queryParam?: string;
-  /**
-   * Path to the cursor field on the response. Leave undefined when the cursor
-   * is not known.
-   *
-   * @deprecated Use `nextParam` and `previousParam` for richer pagination control.
-   */
-  cursorParam?: string | null;
-  /**
-   * Path to the next-page cursor on the response. Supports dot notation
-   * (`'pagination.next.id'`) or array form (`['pagination', 'next', 'id']`).
-   */
-  nextParam?: string | Array<string> | null;
-  /**
-   * Path to the previous-page cursor on the response. Supports dot notation
-   * or array form.
-   */
-  previousParam?: string | Array<string> | null;
-  /**
-   * Initial value for `pageParam` on the first fetch.
-   *
-   * @default 0
-   */
-  initialPageParam?: unknown;
-};
 type CustomOptions = {
   /**
    * Module specifier of your custom-options hook. Imported as a named import,
@@ -386,10 +401,7 @@ type Options = OutputOptions & {
  * The resolved client strategy for the generated hooks, computed once during setup. The hooks always
  * import and call a registered contract client plugin's `<op>`.
  */
-type ResolvedClient = {
-  kind: 'contract';
-  pluginName: string;
-};
+type ResolvedClient = ResolvedContractClient;
 type ResolvedOptions = {
   output: Output;
   group: Group | null;
@@ -441,7 +453,7 @@ declare const pluginReactQueryName = "plugin-react-query";
  * import { pluginReactQuery } from '@kubb/plugin-react-query'
  *
  * export default defineConfig({
- *   input: { path: './petStore.yaml' },
+ *   input: './petStore.yaml',
  *   output: { path: './src/gen' },
  *   plugins: [
  *     pluginTs(),
@@ -455,5 +467,27 @@ declare const pluginReactQueryName = "plugin-react-query";
  */
 declare const pluginReactQuery: (options?: Options | undefined) => import("kubb/kit").Plugin<PluginReactQuery>;
 //#endregion
-export { type PluginReactQuery, pluginReactQuery as default, pluginReactQuery, pluginReactQueryName };
+//#region src/resolvers/resolverReactQuery.d.ts
+/**
+ * Default resolver used by `@kubb/plugin-react-query`. Decides the names and
+ * file paths for every generated TanStack Query hook (`useFoo`,
+ * `useFooSuspense`, `useFooInfinite`, ...) and its companion helpers
+ * (`fooQueryKey`, `fooQueryOptions`).
+ *
+ * Functions and files use the built-in camelCase casing; hooks get the `use`
+ * prefix; suspense and infinite variants are suffixed with `Suspense`/`Infinite`.
+ *
+ * @example Resolve hook and helper names
+ * ```ts
+ * import { resolverReactQuery } from '@kubb/plugin-react-query'
+ *
+ * resolverReactQuery.query.name(operationNode)       // 'useGetPetById'
+ * resolverReactQuery.mutation.name(operationNode)    // 'useUpdatePet'
+ * resolverReactQuery.query.keyName(operationNode)     // 'getPetByIdQueryKey'
+ * resolverReactQuery.query.optionsName(operationNode) // 'getPetByIdQueryOptions'
+ * ```
+ */
+declare const resolverReactQuery: ResolverReactQuery;
+//#endregion
+export { type PluginReactQuery, type ResolverReactQuery, pluginReactQuery as default, pluginReactQuery, pluginReactQueryName, resolverReactQuery };
 //# sourceMappingURL=index.d.ts.map