@kubb/plugin-react-query 5.7.0-canary.20261025T193222 → 5.7.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/index.cjs +313 -83
- package/dist/index.cjs.map +1 -1
- package/dist/index.d.cts +1 -17
- package/dist/index.d.ts +1 -17
- package/dist/index.js +312 -82
- package/dist/index.js.map +1 -1
- package/kubb-extension.json +1 -1
- package/package.json +8 -8
package/dist/index.d.cts
CHANGED
|
@@ -2,7 +2,6 @@ import { Exclude, Group, Include, Output, OutputOptions, Override, PluginType, R
|
|
|
2
2
|
import "@kubb/plugin-zod";
|
|
3
3
|
import "@kubb/plugin-ts";
|
|
4
4
|
import "kubb/jsx";
|
|
5
|
-
//#region ../../internals/client/src/resolveClient.d.ts
|
|
6
5
|
/**
|
|
7
6
|
* The client selector accepted by a consumer's `client` option. Each calls a registered contract
|
|
8
7
|
* client plugin.
|
|
@@ -17,8 +16,6 @@ type ResolvedContractClient = {
|
|
|
17
16
|
kind: 'contract';
|
|
18
17
|
pluginName: string;
|
|
19
18
|
};
|
|
20
|
-
//#endregion
|
|
21
|
-
//#region ../../internals/tanstack-query/src/types.d.ts
|
|
22
19
|
type ParamsCasing = 'camelcase' | undefined;
|
|
23
20
|
/**
|
|
24
21
|
* The hook a key is built for. Plain and suspense queries can share a key, but an infinite query
|
|
@@ -137,8 +134,6 @@ type Infinite = {
|
|
|
137
134
|
getPreviousPageParam?: string | PageParamFn | null;
|
|
138
135
|
};
|
|
139
136
|
type PageParamFn<TPage = any, TParam = any> = (page: TPage, allPages: Array<TPage>, pageParam: TParam, allPageParams: Array<TParam>) => TParam | undefined | null;
|
|
140
|
-
//#endregion
|
|
141
|
-
//#region ../../internals/tanstack-query/src/components/MutationKey.d.ts
|
|
142
137
|
/**
|
|
143
138
|
* Default `mutationKey` builder. Call it from a custom builder to extend the default key.
|
|
144
139
|
*
|
|
@@ -150,8 +145,6 @@ type PageParamFn<TPage = any, TParam = any> = (page: TPage, allPages: Array<TPag
|
|
|
150
145
|
* ```
|
|
151
146
|
*/
|
|
152
147
|
export declare const mutationKeyTransformer: Transformer;
|
|
153
|
-
//#endregion
|
|
154
|
-
//#region ../../internals/tanstack-query/src/components/QueryKey.d.ts
|
|
155
148
|
/**
|
|
156
149
|
* Default `queryKey` builder. Call it from a custom builder to extend the default key.
|
|
157
150
|
*
|
|
@@ -163,8 +156,6 @@ export declare const mutationKeyTransformer: Transformer;
|
|
|
163
156
|
* ```
|
|
164
157
|
*/
|
|
165
158
|
export declare const queryKeyTransformer: Transformer;
|
|
166
|
-
//#endregion
|
|
167
|
-
//#region ../../internals/tanstack-query/src/utils.d.ts
|
|
168
159
|
/**
|
|
169
160
|
* Helper to define a typed page param function for `infinite.getNextPageParam` or
|
|
170
161
|
* `infinite.getPreviousPageParam`. Serializes the function to a string for inlining in generated code.
|
|
@@ -174,8 +165,6 @@ export declare const queryKeyTransformer: Transformer;
|
|
|
174
165
|
* the config file.
|
|
175
166
|
*/
|
|
176
167
|
export declare function definePageParam<TPage = any, TParam = any>(fn: PageParamFn<TPage, TParam>): string;
|
|
177
|
-
//#endregion
|
|
178
|
-
//#region src/types.d.ts
|
|
179
168
|
/**
|
|
180
169
|
* The concrete resolver type for `@kubb/plugin-react-query`.
|
|
181
170
|
* Extends the base `Resolver` (which provides `default` naming and option helpers, the top-level
|
|
@@ -504,8 +493,6 @@ declare global {
|
|
|
504
493
|
}
|
|
505
494
|
}
|
|
506
495
|
}
|
|
507
|
-
//#endregion
|
|
508
|
-
//#region src/plugin.d.ts
|
|
509
496
|
/**
|
|
510
497
|
* Canonical plugin name for `@kubb/plugin-react-query`. Used for driver lookups
|
|
511
498
|
* and cross-plugin dependency references.
|
|
@@ -537,15 +524,13 @@ export declare const pluginReactQueryName = "plugin-react-query";
|
|
|
537
524
|
* ```
|
|
538
525
|
*/
|
|
539
526
|
export declare const pluginReactQuery: import("kubb/kit").PluginFactory<PluginReactQuery>;
|
|
540
|
-
//#endregion
|
|
541
|
-
//#region src/resolvers/resolverReactQuery.d.ts
|
|
542
527
|
/**
|
|
543
528
|
* Default resolver used by `@kubb/plugin-react-query`. Decides the names and
|
|
544
529
|
* file paths for every generated TanStack Query hook (`useFoo`,
|
|
545
530
|
* `useFooSuspense`, `useFooInfinite`, ...) and its companion helpers
|
|
546
531
|
* (`fooQueryKey`, `fooQueryOptions`).
|
|
547
532
|
*
|
|
548
|
-
* Functions
|
|
533
|
+
* Functions use safe camelCase identifiers; hooks get the `use`
|
|
549
534
|
* prefix; suspense and infinite variants are suffixed with `Suspense`/`Infinite`.
|
|
550
535
|
*
|
|
551
536
|
* @example Resolve hook and helper names
|
|
@@ -559,6 +544,5 @@ export declare const pluginReactQuery: import("kubb/kit").PluginFactory<PluginRe
|
|
|
559
544
|
* ```
|
|
560
545
|
*/
|
|
561
546
|
export declare const resolverReactQuery: ResolverReactQuery;
|
|
562
|
-
//#endregion
|
|
563
547
|
export { type PageParamFn, type PluginReactQuery, type ResolverReactQuery, type Transformer, pluginReactQuery as default };
|
|
564
548
|
//# sourceMappingURL=index.d.cts.map
|
package/dist/index.d.ts
CHANGED
|
@@ -2,7 +2,6 @@ import { Exclude, Group, Include, Output, OutputOptions, Override, PluginType, R
|
|
|
2
2
|
import "@kubb/plugin-zod";
|
|
3
3
|
import "@kubb/plugin-ts";
|
|
4
4
|
import "kubb/jsx";
|
|
5
|
-
//#region ../../internals/client/src/resolveClient.d.ts
|
|
6
5
|
/**
|
|
7
6
|
* The client selector accepted by a consumer's `client` option. Each calls a registered contract
|
|
8
7
|
* client plugin.
|
|
@@ -17,8 +16,6 @@ type ResolvedContractClient = {
|
|
|
17
16
|
kind: 'contract';
|
|
18
17
|
pluginName: string;
|
|
19
18
|
};
|
|
20
|
-
//#endregion
|
|
21
|
-
//#region ../../internals/tanstack-query/src/types.d.ts
|
|
22
19
|
type ParamsCasing = 'camelcase' | undefined;
|
|
23
20
|
/**
|
|
24
21
|
* The hook a key is built for. Plain and suspense queries can share a key, but an infinite query
|
|
@@ -137,8 +134,6 @@ type Infinite = {
|
|
|
137
134
|
getPreviousPageParam?: string | PageParamFn | null;
|
|
138
135
|
};
|
|
139
136
|
type PageParamFn<TPage = any, TParam = any> = (page: TPage, allPages: Array<TPage>, pageParam: TParam, allPageParams: Array<TParam>) => TParam | undefined | null;
|
|
140
|
-
//#endregion
|
|
141
|
-
//#region ../../internals/tanstack-query/src/components/MutationKey.d.ts
|
|
142
137
|
/**
|
|
143
138
|
* Default `mutationKey` builder. Call it from a custom builder to extend the default key.
|
|
144
139
|
*
|
|
@@ -150,8 +145,6 @@ type PageParamFn<TPage = any, TParam = any> = (page: TPage, allPages: Array<TPag
|
|
|
150
145
|
* ```
|
|
151
146
|
*/
|
|
152
147
|
export declare const mutationKeyTransformer: Transformer;
|
|
153
|
-
//#endregion
|
|
154
|
-
//#region ../../internals/tanstack-query/src/components/QueryKey.d.ts
|
|
155
148
|
/**
|
|
156
149
|
* Default `queryKey` builder. Call it from a custom builder to extend the default key.
|
|
157
150
|
*
|
|
@@ -163,8 +156,6 @@ export declare const mutationKeyTransformer: Transformer;
|
|
|
163
156
|
* ```
|
|
164
157
|
*/
|
|
165
158
|
export declare const queryKeyTransformer: Transformer;
|
|
166
|
-
//#endregion
|
|
167
|
-
//#region ../../internals/tanstack-query/src/utils.d.ts
|
|
168
159
|
/**
|
|
169
160
|
* Helper to define a typed page param function for `infinite.getNextPageParam` or
|
|
170
161
|
* `infinite.getPreviousPageParam`. Serializes the function to a string for inlining in generated code.
|
|
@@ -174,8 +165,6 @@ export declare const queryKeyTransformer: Transformer;
|
|
|
174
165
|
* the config file.
|
|
175
166
|
*/
|
|
176
167
|
export declare function definePageParam<TPage = any, TParam = any>(fn: PageParamFn<TPage, TParam>): string;
|
|
177
|
-
//#endregion
|
|
178
|
-
//#region src/types.d.ts
|
|
179
168
|
/**
|
|
180
169
|
* The concrete resolver type for `@kubb/plugin-react-query`.
|
|
181
170
|
* Extends the base `Resolver` (which provides `default` naming and option helpers, the top-level
|
|
@@ -504,8 +493,6 @@ declare global {
|
|
|
504
493
|
}
|
|
505
494
|
}
|
|
506
495
|
}
|
|
507
|
-
//#endregion
|
|
508
|
-
//#region src/plugin.d.ts
|
|
509
496
|
/**
|
|
510
497
|
* Canonical plugin name for `@kubb/plugin-react-query`. Used for driver lookups
|
|
511
498
|
* and cross-plugin dependency references.
|
|
@@ -537,15 +524,13 @@ export declare const pluginReactQueryName = "plugin-react-query";
|
|
|
537
524
|
* ```
|
|
538
525
|
*/
|
|
539
526
|
export declare const pluginReactQuery: import("kubb/kit").PluginFactory<PluginReactQuery>;
|
|
540
|
-
//#endregion
|
|
541
|
-
//#region src/resolvers/resolverReactQuery.d.ts
|
|
542
527
|
/**
|
|
543
528
|
* Default resolver used by `@kubb/plugin-react-query`. Decides the names and
|
|
544
529
|
* file paths for every generated TanStack Query hook (`useFoo`,
|
|
545
530
|
* `useFooSuspense`, `useFooInfinite`, ...) and its companion helpers
|
|
546
531
|
* (`fooQueryKey`, `fooQueryOptions`).
|
|
547
532
|
*
|
|
548
|
-
* Functions
|
|
533
|
+
* Functions use safe camelCase identifiers; hooks get the `use`
|
|
549
534
|
* prefix; suspense and infinite variants are suffixed with `Suspense`/`Infinite`.
|
|
550
535
|
*
|
|
551
536
|
* @example Resolve hook and helper names
|
|
@@ -559,6 +544,5 @@ export declare const pluginReactQuery: import("kubb/kit").PluginFactory<PluginRe
|
|
|
559
544
|
* ```
|
|
560
545
|
*/
|
|
561
546
|
export declare const resolverReactQuery: ResolverReactQuery;
|
|
562
|
-
//#endregion
|
|
563
547
|
export { type PageParamFn, type PluginReactQuery, type ResolverReactQuery, type Transformer, pluginReactQuery as default };
|
|
564
548
|
//# sourceMappingURL=index.d.ts.map
|