@orpc/vue-query 0.0.0-next.a5c2886 → 0.0.0-next.a7609ce

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.
Files changed (5) hide show
  1. package/README.md +11 -0
  2. package/dist/index.d.mts +26 -14
  3. package/dist/index.d.ts +26 -14
  4. package/dist/index.mjs +1 -1
  5. package/package.json +5 -4
package/README.md CHANGED
@@ -53,6 +53,7 @@ You can find the full documentation [here](https://orpc.unnoq.com).
53
53
  - [@orpc/contract](https://www.npmjs.com/package/@orpc/contract): Build your API contract.
54
54
  - [@orpc/server](https://www.npmjs.com/package/@orpc/server): Build your API or implement API contract.
55
55
  - [@orpc/client](https://www.npmjs.com/package/@orpc/client): Consume your API on the client with type-safety.
56
+ - [@orpc/react](https://www.npmjs.com/package/@orpc/react): Utilities for integrating oRPC with React and React Server Actions.
56
57
  - [@orpc/react-query](https://www.npmjs.com/package/@orpc/react-query): Integration with [React Query](https://tanstack.com/query/latest/docs/framework/react/overview).
57
58
  - [@orpc/vue-query](https://www.npmjs.com/package/@orpc/vue-query): Integration with [Vue Query](https://tanstack.com/query/latest/docs/framework/vue/overview).
58
59
  - [@orpc/solid-query](https://www.npmjs.com/package/@orpc/solid-query): Integration with [Solid Query](https://tanstack.com/query/latest/docs/framework/solid/overview).
@@ -60,6 +61,8 @@ You can find the full documentation [here](https://orpc.unnoq.com).
60
61
  - [@orpc/vue-colada](https://www.npmjs.com/package/@orpc/vue-colada): Integration with [Pinia Colada](https://pinia-colada.esm.dev/).
61
62
  - [@orpc/openapi](https://www.npmjs.com/package/@orpc/openapi): Generate OpenAPI specs and handle OpenAPI requests.
62
63
  - [@orpc/zod](https://www.npmjs.com/package/@orpc/zod): More schemas that [Zod](https://zod.dev/) doesn't support yet.
64
+ - [@orpc/valibot](https://www.npmjs.com/package/@orpc/valibot): OpenAPI spec generation from [Valibot](https://valibot.dev/).
65
+ - [@orpc/arktype](https://www.npmjs.com/package/@orpc/arktype): OpenAPI spec generation from [ArkType](https://arktype.io/).
63
66
 
64
67
  ## `@orpc/vue-query`
65
68
 
@@ -107,6 +110,14 @@ export function Setup() {
107
110
  }
108
111
  ```
109
112
 
113
+ ## Sponsors
114
+
115
+ <p align="center">
116
+ <a href="https://cdn.jsdelivr.net/gh/unnoq/unnoq/sponsors.svg">
117
+ <img src='https://cdn.jsdelivr.net/gh/unnoq/unnoq/sponsors.svg'/>
118
+ </a>
119
+ </p>
120
+
110
121
  ## License
111
122
 
112
123
  Distributed under the MIT License. See [LICENSE](https://github.com/unnoq/orpc/blob/main/LICENSE) for more information.
package/dist/index.d.mts CHANGED
@@ -1,7 +1,7 @@
1
1
  import { ClientContext, Client, NestedClient } from '@orpc/client';
2
- import { QueryKey, QueryObserverOptions, QueryFunctionContext, UseInfiniteQueryOptions, MutationObserverOptions, InfiniteData } from '@tanstack/vue-query';
3
- import { PartialDeep, AnyFunction, SetOptional, MaybeOptionalOptions } from '@orpc/shared';
4
- import { MaybeRef, MaybeRefOrGetter, ComputedRef } from 'vue';
2
+ import { QueryKey, QueryObserverOptions, QueryFunctionContext, InfiniteQueryObserverOptions, MutationObserverOptions, InfiniteData } from '@tanstack/vue-query';
3
+ import { PartialDeep, AnyFunction, MaybeOptionalOptions } from '@orpc/shared';
4
+ import { MaybeRef, MaybeRefOrGetter, ComputedRef, Ref } from 'vue';
5
5
 
6
6
  type KeyType = 'query' | 'infinite' | 'mutation' | undefined;
7
7
  interface BuildKeyOptions<TType extends KeyType, TInput> {
@@ -22,7 +22,7 @@ declare function createGeneralUtils<TInput>(path: string[]): GeneralUtils<TInput
22
22
  type MaybeRefDeep<T> = MaybeRef<T extends AnyFunction ? T : T extends object ? {
23
23
  [Property in keyof T]: MaybeRefDeep<T[Property]>;
24
24
  } : T>;
25
- type QueryOptionsIn<TClientContext extends ClientContext, TInput, TOutput, TError extends Error, TSelectData> = (undefined extends TInput ? {
25
+ type QueryOptionsIn<TClientContext extends ClientContext, TInput, TOutput, TError, TSelectData> = (undefined extends TInput ? {
26
26
  input?: MaybeRefDeep<TInput>;
27
27
  } : {
28
28
  input: MaybeRefDeep<TInput>;
@@ -35,37 +35,43 @@ type QueryOptionsIn<TClientContext extends ClientContext, TInput, TOutput, TErro
35
35
  } & {
36
36
  enabled?: MaybeRefOrGetter<QueryObserverOptions<TOutput, TError, TSelectData, TOutput>['enabled']>;
37
37
  queryKey?: MaybeRefDeep<QueryObserverOptions<TOutput, TError, TSelectData, TOutput>['queryKey']>;
38
- shallow?: MaybeRef<boolean>;
38
+ shallow?: boolean;
39
39
  };
40
- interface QueryOptionsBase<TOutput, TError extends Error> {
40
+ interface QueryOptionsBase<TOutput, TError> {
41
41
  queryKey: ComputedRef<QueryKey>;
42
42
  queryFn(ctx: QueryFunctionContext): Promise<TOutput>;
43
43
  retry?(failureCount: number, error: TError): boolean;
44
44
  }
45
- type InfiniteOptionsIn<TClientContext extends ClientContext, TInput, TOutput, TError extends Error, TSelectData, TPageParam> = {
45
+ type InfiniteOptionsIn<TClientContext extends ClientContext, TInput, TOutput, TError, TSelectData, TPageParam> = {
46
46
  input: (pageParam: TPageParam) => MaybeRefDeep<TInput>;
47
47
  } & (Record<never, never> extends TClientContext ? {
48
48
  context?: MaybeRefDeep<TClientContext>;
49
49
  } : {
50
50
  context: MaybeRefDeep<TClientContext>;
51
- }) & SetOptional<UseInfiniteQueryOptions<TOutput, TError, TSelectData, TOutput, QueryKey, TPageParam>, 'queryKey'>;
52
- interface InfiniteOptionsBase<TOutput, TError extends Error, TPageParam> {
51
+ }) & {
52
+ [Property in keyof Omit<InfiniteQueryObserverOptions<TOutput, TError, TSelectData, TOutput, QueryKey, TPageParam>, 'queryKey' | 'enabled'>]: MaybeRefDeep<InfiniteQueryObserverOptions<TOutput, TError, TSelectData, TOutput, QueryKey, TPageParam>[Property]>;
53
+ } & {
54
+ enabled?: MaybeRefOrGetter<InfiniteQueryObserverOptions<TOutput, TError, TSelectData, TOutput, QueryKey, TPageParam>['enabled']>;
55
+ queryKey?: MaybeRefDeep<InfiniteQueryObserverOptions<TOutput, TError, TSelectData, TOutput, QueryKey, TPageParam>['queryKey']>;
56
+ shallow?: boolean;
57
+ };
58
+ interface InfiniteOptionsBase<TOutput, TError, TPageParam> {
53
59
  queryKey: ComputedRef<QueryKey>;
54
60
  queryFn(ctx: QueryFunctionContext<QueryKey, TPageParam>): Promise<TOutput>;
55
61
  retry?(failureCount: number, error: TError): boolean;
56
62
  }
57
- type MutationOptionsIn<TClientContext extends ClientContext, TInput, TOutput, TError extends Error, TMutationContext> = (Record<never, never> extends TClientContext ? {
63
+ type MutationOptionsIn<TClientContext extends ClientContext, TInput, TOutput, TError, TMutationContext> = (Record<never, never> extends TClientContext ? {
58
64
  context?: TClientContext;
59
65
  } : {
60
66
  context: TClientContext;
61
67
  }) & MutationOptions<TInput, TOutput, TError, TMutationContext>;
62
- type MutationOptions<TInput, TOutput, TError extends Error, TMutationContext> = {
68
+ type MutationOptions<TInput, TOutput, TError, TMutationContext> = {
63
69
  [P in keyof MutationObserverOptions<TOutput, TError, TInput, TMutationContext>]: MaybeRefDeep<MutationObserverOptions<TOutput, TError, TInput, TMutationContext>[P]>;
64
70
  } & {
65
71
  shallow?: MaybeRef<boolean>;
66
72
  };
67
73
 
68
- interface ProcedureUtils<TClientContext extends ClientContext, TInput, TOutput, TError extends Error> {
74
+ interface ProcedureUtils<TClientContext extends ClientContext, TInput, TOutput, TError> {
69
75
  call: Client<TClientContext, TInput, TOutput, TError>;
70
76
  queryOptions<U, USelectData = TOutput>(...rest: MaybeOptionalOptions<U & QueryOptionsIn<TClientContext, TInput, TOutput, TError, USelectData>>): NoInfer<U & Omit<QueryOptionsBase<TOutput, TError>, keyof U>>;
71
77
  infiniteOptions<U, UPageParam, USelectData = InfiniteData<TOutput, UPageParam>>(options: U & InfiniteOptionsIn<TClientContext, TInput, TOutput, TError, USelectData, UPageParam>): NoInfer<U & Omit<InfiniteOptionsBase<TOutput, TError, UPageParam>, keyof U>>;
@@ -74,7 +80,7 @@ interface ProcedureUtils<TClientContext extends ClientContext, TInput, TOutput,
74
80
  interface CreateProcedureUtilsOptions {
75
81
  path: string[];
76
82
  }
77
- declare function createProcedureUtils<TClientContext extends ClientContext, TInput, TOutput, TError extends Error>(client: Client<TClientContext, TInput, TOutput, TError>, options: CreateProcedureUtilsOptions): ProcedureUtils<TClientContext, TInput, TOutput, TError>;
83
+ declare function createProcedureUtils<TClientContext extends ClientContext, TInput, TOutput, TError>(client: Client<TClientContext, TInput, TOutput, TError>, options: CreateProcedureUtilsOptions): ProcedureUtils<TClientContext, TInput, TOutput, TError>;
78
84
 
79
85
  type RouterUtils<T extends NestedClient<any>> = T extends Client<infer UClientContext, infer UInput, infer UOutput, infer UError> ? ProcedureUtils<UClientContext, UInput, UOutput, UError> & GeneralUtils<UInput> : {
80
86
  [K in keyof T]: T[K] extends NestedClient<any> ? RouterUtils<T[K]> : never;
@@ -84,4 +90,10 @@ interface CreateRouterUtilsOptions {
84
90
  }
85
91
  declare function createRouterUtils<T extends NestedClient<any>>(client: T, options?: CreateRouterUtilsOptions): RouterUtils<T>;
86
92
 
87
- export { type BuildKeyOptions, type CreateProcedureUtilsOptions, type CreateRouterUtilsOptions, type GeneralUtils, type InfiniteOptionsBase, type InfiniteOptionsIn, type KeyType, type MaybeRefDeep, type MutationOptions, type MutationOptionsIn, type ProcedureUtils, type QueryOptionsBase, type QueryOptionsIn, type RouterUtils, buildKey, createGeneralUtils, createRouterUtils as createORPCVueQueryUtils, createProcedureUtils, createRouterUtils };
93
+ type UnrefDeep<T> = T extends Ref<infer U> ? UnrefDeep<U> : T extends AnyFunction ? T : T extends object ? {
94
+ [K in keyof T]: UnrefDeep<T[K]>;
95
+ } : T;
96
+ declare function unrefDeep<T>(value: T): UnrefDeep<T>;
97
+
98
+ export { buildKey, createGeneralUtils, createRouterUtils as createORPCVueQueryUtils, createProcedureUtils, createRouterUtils, unrefDeep };
99
+ export type { BuildKeyOptions, CreateProcedureUtilsOptions, CreateRouterUtilsOptions, GeneralUtils, InfiniteOptionsBase, InfiniteOptionsIn, KeyType, MaybeRefDeep, MutationOptions, MutationOptionsIn, ProcedureUtils, QueryOptionsBase, QueryOptionsIn, RouterUtils, UnrefDeep };
package/dist/index.d.ts CHANGED
@@ -1,7 +1,7 @@
1
1
  import { ClientContext, Client, NestedClient } from '@orpc/client';
2
- import { QueryKey, QueryObserverOptions, QueryFunctionContext, UseInfiniteQueryOptions, MutationObserverOptions, InfiniteData } from '@tanstack/vue-query';
3
- import { PartialDeep, AnyFunction, SetOptional, MaybeOptionalOptions } from '@orpc/shared';
4
- import { MaybeRef, MaybeRefOrGetter, ComputedRef } from 'vue';
2
+ import { QueryKey, QueryObserverOptions, QueryFunctionContext, InfiniteQueryObserverOptions, MutationObserverOptions, InfiniteData } from '@tanstack/vue-query';
3
+ import { PartialDeep, AnyFunction, MaybeOptionalOptions } from '@orpc/shared';
4
+ import { MaybeRef, MaybeRefOrGetter, ComputedRef, Ref } from 'vue';
5
5
 
6
6
  type KeyType = 'query' | 'infinite' | 'mutation' | undefined;
7
7
  interface BuildKeyOptions<TType extends KeyType, TInput> {
@@ -22,7 +22,7 @@ declare function createGeneralUtils<TInput>(path: string[]): GeneralUtils<TInput
22
22
  type MaybeRefDeep<T> = MaybeRef<T extends AnyFunction ? T : T extends object ? {
23
23
  [Property in keyof T]: MaybeRefDeep<T[Property]>;
24
24
  } : T>;
25
- type QueryOptionsIn<TClientContext extends ClientContext, TInput, TOutput, TError extends Error, TSelectData> = (undefined extends TInput ? {
25
+ type QueryOptionsIn<TClientContext extends ClientContext, TInput, TOutput, TError, TSelectData> = (undefined extends TInput ? {
26
26
  input?: MaybeRefDeep<TInput>;
27
27
  } : {
28
28
  input: MaybeRefDeep<TInput>;
@@ -35,37 +35,43 @@ type QueryOptionsIn<TClientContext extends ClientContext, TInput, TOutput, TErro
35
35
  } & {
36
36
  enabled?: MaybeRefOrGetter<QueryObserverOptions<TOutput, TError, TSelectData, TOutput>['enabled']>;
37
37
  queryKey?: MaybeRefDeep<QueryObserverOptions<TOutput, TError, TSelectData, TOutput>['queryKey']>;
38
- shallow?: MaybeRef<boolean>;
38
+ shallow?: boolean;
39
39
  };
40
- interface QueryOptionsBase<TOutput, TError extends Error> {
40
+ interface QueryOptionsBase<TOutput, TError> {
41
41
  queryKey: ComputedRef<QueryKey>;
42
42
  queryFn(ctx: QueryFunctionContext): Promise<TOutput>;
43
43
  retry?(failureCount: number, error: TError): boolean;
44
44
  }
45
- type InfiniteOptionsIn<TClientContext extends ClientContext, TInput, TOutput, TError extends Error, TSelectData, TPageParam> = {
45
+ type InfiniteOptionsIn<TClientContext extends ClientContext, TInput, TOutput, TError, TSelectData, TPageParam> = {
46
46
  input: (pageParam: TPageParam) => MaybeRefDeep<TInput>;
47
47
  } & (Record<never, never> extends TClientContext ? {
48
48
  context?: MaybeRefDeep<TClientContext>;
49
49
  } : {
50
50
  context: MaybeRefDeep<TClientContext>;
51
- }) & SetOptional<UseInfiniteQueryOptions<TOutput, TError, TSelectData, TOutput, QueryKey, TPageParam>, 'queryKey'>;
52
- interface InfiniteOptionsBase<TOutput, TError extends Error, TPageParam> {
51
+ }) & {
52
+ [Property in keyof Omit<InfiniteQueryObserverOptions<TOutput, TError, TSelectData, TOutput, QueryKey, TPageParam>, 'queryKey' | 'enabled'>]: MaybeRefDeep<InfiniteQueryObserverOptions<TOutput, TError, TSelectData, TOutput, QueryKey, TPageParam>[Property]>;
53
+ } & {
54
+ enabled?: MaybeRefOrGetter<InfiniteQueryObserverOptions<TOutput, TError, TSelectData, TOutput, QueryKey, TPageParam>['enabled']>;
55
+ queryKey?: MaybeRefDeep<InfiniteQueryObserverOptions<TOutput, TError, TSelectData, TOutput, QueryKey, TPageParam>['queryKey']>;
56
+ shallow?: boolean;
57
+ };
58
+ interface InfiniteOptionsBase<TOutput, TError, TPageParam> {
53
59
  queryKey: ComputedRef<QueryKey>;
54
60
  queryFn(ctx: QueryFunctionContext<QueryKey, TPageParam>): Promise<TOutput>;
55
61
  retry?(failureCount: number, error: TError): boolean;
56
62
  }
57
- type MutationOptionsIn<TClientContext extends ClientContext, TInput, TOutput, TError extends Error, TMutationContext> = (Record<never, never> extends TClientContext ? {
63
+ type MutationOptionsIn<TClientContext extends ClientContext, TInput, TOutput, TError, TMutationContext> = (Record<never, never> extends TClientContext ? {
58
64
  context?: TClientContext;
59
65
  } : {
60
66
  context: TClientContext;
61
67
  }) & MutationOptions<TInput, TOutput, TError, TMutationContext>;
62
- type MutationOptions<TInput, TOutput, TError extends Error, TMutationContext> = {
68
+ type MutationOptions<TInput, TOutput, TError, TMutationContext> = {
63
69
  [P in keyof MutationObserverOptions<TOutput, TError, TInput, TMutationContext>]: MaybeRefDeep<MutationObserverOptions<TOutput, TError, TInput, TMutationContext>[P]>;
64
70
  } & {
65
71
  shallow?: MaybeRef<boolean>;
66
72
  };
67
73
 
68
- interface ProcedureUtils<TClientContext extends ClientContext, TInput, TOutput, TError extends Error> {
74
+ interface ProcedureUtils<TClientContext extends ClientContext, TInput, TOutput, TError> {
69
75
  call: Client<TClientContext, TInput, TOutput, TError>;
70
76
  queryOptions<U, USelectData = TOutput>(...rest: MaybeOptionalOptions<U & QueryOptionsIn<TClientContext, TInput, TOutput, TError, USelectData>>): NoInfer<U & Omit<QueryOptionsBase<TOutput, TError>, keyof U>>;
71
77
  infiniteOptions<U, UPageParam, USelectData = InfiniteData<TOutput, UPageParam>>(options: U & InfiniteOptionsIn<TClientContext, TInput, TOutput, TError, USelectData, UPageParam>): NoInfer<U & Omit<InfiniteOptionsBase<TOutput, TError, UPageParam>, keyof U>>;
@@ -74,7 +80,7 @@ interface ProcedureUtils<TClientContext extends ClientContext, TInput, TOutput,
74
80
  interface CreateProcedureUtilsOptions {
75
81
  path: string[];
76
82
  }
77
- declare function createProcedureUtils<TClientContext extends ClientContext, TInput, TOutput, TError extends Error>(client: Client<TClientContext, TInput, TOutput, TError>, options: CreateProcedureUtilsOptions): ProcedureUtils<TClientContext, TInput, TOutput, TError>;
83
+ declare function createProcedureUtils<TClientContext extends ClientContext, TInput, TOutput, TError>(client: Client<TClientContext, TInput, TOutput, TError>, options: CreateProcedureUtilsOptions): ProcedureUtils<TClientContext, TInput, TOutput, TError>;
78
84
 
79
85
  type RouterUtils<T extends NestedClient<any>> = T extends Client<infer UClientContext, infer UInput, infer UOutput, infer UError> ? ProcedureUtils<UClientContext, UInput, UOutput, UError> & GeneralUtils<UInput> : {
80
86
  [K in keyof T]: T[K] extends NestedClient<any> ? RouterUtils<T[K]> : never;
@@ -84,4 +90,10 @@ interface CreateRouterUtilsOptions {
84
90
  }
85
91
  declare function createRouterUtils<T extends NestedClient<any>>(client: T, options?: CreateRouterUtilsOptions): RouterUtils<T>;
86
92
 
87
- export { type BuildKeyOptions, type CreateProcedureUtilsOptions, type CreateRouterUtilsOptions, type GeneralUtils, type InfiniteOptionsBase, type InfiniteOptionsIn, type KeyType, type MaybeRefDeep, type MutationOptions, type MutationOptionsIn, type ProcedureUtils, type QueryOptionsBase, type QueryOptionsIn, type RouterUtils, buildKey, createGeneralUtils, createRouterUtils as createORPCVueQueryUtils, createProcedureUtils, createRouterUtils };
93
+ type UnrefDeep<T> = T extends Ref<infer U> ? UnrefDeep<U> : T extends AnyFunction ? T : T extends object ? {
94
+ [K in keyof T]: UnrefDeep<T[K]>;
95
+ } : T;
96
+ declare function unrefDeep<T>(value: T): UnrefDeep<T>;
97
+
98
+ export { buildKey, createGeneralUtils, createRouterUtils as createORPCVueQueryUtils, createProcedureUtils, createRouterUtils, unrefDeep };
99
+ export type { BuildKeyOptions, CreateProcedureUtilsOptions, CreateRouterUtilsOptions, GeneralUtils, InfiniteOptionsBase, InfiniteOptionsIn, KeyType, MaybeRefDeep, MutationOptions, MutationOptionsIn, ProcedureUtils, QueryOptionsBase, QueryOptionsIn, RouterUtils, UnrefDeep };
package/dist/index.mjs CHANGED
@@ -92,4 +92,4 @@ function createRouterUtils(client, options = {}) {
92
92
  return recursive;
93
93
  }
94
94
 
95
- export { buildKey, createGeneralUtils, createRouterUtils as createORPCVueQueryUtils, createProcedureUtils, createRouterUtils };
95
+ export { buildKey, createGeneralUtils, createRouterUtils as createORPCVueQueryUtils, createProcedureUtils, createRouterUtils, unrefDeep };
package/package.json CHANGED
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "name": "@orpc/vue-query",
3
3
  "type": "module",
4
- "version": "0.0.0-next.a5c2886",
4
+ "version": "0.0.0-next.a7609ce",
5
5
  "license": "MIT",
6
6
  "homepage": "https://orpc.unnoq.com",
7
7
  "repository": {
@@ -27,12 +27,13 @@
27
27
  "dist"
28
28
  ],
29
29
  "peerDependencies": {
30
- "@tanstack/vue-query": ">=5.50.0",
30
+ "@tanstack/vue-query": ">=5.55.0",
31
31
  "vue": ">=3.3.0",
32
- "@orpc/client": "0.0.0-next.a5c2886"
32
+ "@orpc/client": "0.0.0-next.a7609ce"
33
33
  },
34
34
  "dependencies": {
35
- "@orpc/shared": "0.0.0-next.a5c2886"
35
+ "@tanstack/vue-query": "^5.72.2",
36
+ "@orpc/shared": "0.0.0-next.a7609ce"
36
37
  },
37
38
  "scripts": {
38
39
  "build": "unbuild",