@orpc/vue-query 0.0.0-next.d8301f4 → 0.0.0-next.d9485b0

package/dist/index.d.mts

@@ -1,22 +1,17 @@
 import { ClientContext, Client, NestedClient } from '@orpc/client';
-import { QueryKey, QueryObserverOptions, QueryFunctionContext, InfiniteQueryObserverOptions, MutationObserverOptions, InfiniteData } from '@tanstack/vue-query';
-import { PartialDeep, AnyFunction, MaybeOptionalOptions } from '@orpc/shared';
+import { OperationType, BuildKeyOptions } from '@orpc/tanstack-query';
+export { BuildKeyOptions, OperationType as KeyType, buildKey } from '@orpc/tanstack-query';
+import { QueryKey, SkipToken, QueryObserverOptions, QueryFunctionContext, experimental_streamedQuery, InfiniteQueryObserverOptions, MutationObserverOptions, InfiniteData } from '@tanstack/vue-query';
+import { AnyFunction, MaybeOptionalOptions } from '@orpc/shared';
 import { MaybeRef, MaybeRefOrGetter, ComputedRef, Ref } from 'vue';
 
-type KeyType = 'query' | 'infinite' | 'mutation' | undefined;
-interface BuildKeyOptions<TType extends KeyType, TInput> {
-    type?: TType;
-    input?: TType extends 'mutation' ? never : PartialDeep<TInput>;
-}
-declare function buildKey<TType extends KeyType, TInput>(path: string[], options?: BuildKeyOptions<TType, TInput>): QueryKey;
-
 interface GeneralUtils<TInput> {
     /**
      * Generate a query/mutation key for checking status, invalidate, set, get, etc.
      *
      * @see {@link https://orpc.unnoq.com/docs/tanstack-query/basic#query-mutation-key Tanstack Query/Mutation Key Docs}
      */
-    key<UType extends KeyType = undefined>(options?: BuildKeyOptions<UType, TInput>): QueryKey;
+    key<UType extends OperationType>(options?: BuildKeyOptions<UType, TInput>): QueryKey;
 }
 declare function createGeneralUtils<TInput>(path: string[]): GeneralUtils<TInput>;
 
@@ -28,9 +23,9 @@ type MaybeRefDeep<T> = MaybeRef<T extends AnyFunction ? T : T extends object ? {
     [Property in keyof T]: MaybeRefDeep<T[Property]>;
 } : T>;
 type QueryOptionsIn<TClientContext extends ClientContext, TInput, TOutput, TError, TSelectData> = (undefined extends TInput ? {
-    input?: MaybeRefDeep<TInput>;
+    input?: MaybeRefDeep<TInput | SkipToken>;
 } : {
-    input: MaybeRefDeep<TInput>;
+    input: MaybeRefDeep<TInput | SkipToken>;
 }) & (Record<never, never> extends TClientContext ? {
     context?: MaybeRefDeep<TClientContext>;
 } : {
@@ -45,17 +40,22 @@ type QueryOptionsIn<TClientContext extends ClientContext, TInput, TOutput, TErro
 interface QueryOptionsBase<TOutput, TError> {
     queryKey: ComputedRef<QueryKey>;
     queryFn(ctx: QueryFunctionContext): Promise<TOutput>;
-    retry?(failureCount: number, error: TError): boolean;
+    throwOnError?(error: TError): boolean;
+    enabled: ComputedRef<boolean>;
+}
+type experimental_StreamedQueryOptions = Omit<Parameters<typeof experimental_streamedQuery>[0], 'queryFn'>;
+type experimental_InferStreamedOutput<TOutput> = TOutput extends AsyncIterable<infer U> ? U[] : never;
+type experimental_StreamedOptionsIn<TClientContext extends ClientContext, TInput, TOutput, TError, TSelectData> = QueryOptionsIn<TClientContext, TInput, TOutput, TError, TSelectData> & experimental_StreamedQueryOptions;
+interface experimental_StreamedOptionsBase<TOutput, TError> extends QueryOptionsBase<TOutput, TError> {
 }
-type InfiniteOptionsIn<TClientContext extends ClientContext, TInput, TOutput, TError, TSelectData, TPageParam> = {
-    input: (pageParam: TPageParam) => MaybeRefDeep<TInput>;
-} & (Record<never, never> extends TClientContext ? {
+type InfiniteOptionsIn<TClientContext extends ClientContext, TInput, TOutput, TError, TSelectData, TPageParam> = (Record<never, never> extends TClientContext ? {
     context?: MaybeRefDeep<TClientContext>;
 } : {
     context: MaybeRefDeep<TClientContext>;
 }) & {
     [Property in keyof Omit<InfiniteQueryObserverOptions<TOutput, TError, TSelectData, TOutput, QueryKey, TPageParam>, 'queryKey' | 'enabled'>]: MaybeRefDeep<InfiniteQueryObserverOptions<TOutput, TError, TSelectData, TOutput, QueryKey, TPageParam>[Property]>;
 } & {
+    input: MaybeRef<((pageParam: TPageParam) => MaybeRefDeep<TInput>) | SkipToken>;
     enabled?: MaybeRefOrGetter<InfiniteQueryObserverOptions<TOutput, TError, TSelectData, TOutput, QueryKey, TPageParam>['enabled']>;
     queryKey?: MaybeRefDeep<InfiniteQueryObserverOptions<TOutput, TError, TSelectData, TOutput, QueryKey, TPageParam>['queryKey']>;
     shallow?: boolean;
@@ -63,7 +63,8 @@ type InfiniteOptionsIn<TClientContext extends ClientContext, TInput, TOutput, TE
 interface InfiniteOptionsBase<TOutput, TError, TPageParam> {
     queryKey: ComputedRef<QueryKey>;
     queryFn(ctx: QueryFunctionContext<QueryKey, TPageParam>): Promise<TOutput>;
-    retry?(failureCount: number, error: TError): boolean;
+    throwOnError?(error: TError): boolean;
+    enabled: ComputedRef<boolean>;
 }
 type MutationOptionsIn<TClientContext extends ClientContext, TInput, TOutput, TError, TMutationContext> = (Record<never, never> extends TClientContext ? {
     context?: TClientContext;
@@ -89,6 +90,13 @@ interface ProcedureUtils<TClientContext extends ClientContext, TInput, TOutput,
      * @see {@link https://orpc.unnoq.com/docs/tanstack-query/basic#query-options-utility Tanstack Query Options Utility Docs}
      */
     queryOptions<U, USelectData = TOutput>(...rest: MaybeOptionalOptions<U & QueryOptionsIn<TClientContext, TInput, TOutput, TError, USelectData>>): NoInfer<U & Omit<QueryOptionsBase<TOutput, TError>, keyof U>>;
+    /**
+     * Generate [Event Iterator](https://orpc.unnoq.com/docs/event-iterator) options used for useQuery/prefetchQuery/...
+     * Built on top of [steamedQuery](https://tanstack.com/query/latest/docs/reference/streamedQuery)
+     *
+     * @see {@link https://orpc.unnoq.com/docs/tanstack-query/basic#streamed-query-options-utility Tanstack Streamed Query Options Utility Docs}
+     */
+    experimental_streamedOptions<U, USelectData = experimental_InferStreamedOutput<TOutput>>(...rest: MaybeOptionalOptions<U & experimental_StreamedOptionsIn<TClientContext, TInput, experimental_InferStreamedOutput<TOutput>, TError, USelectData>>): NoInfer<U & Omit<experimental_StreamedOptionsBase<experimental_InferStreamedOutput<TOutput>, TError>, keyof U>>;
     /**
      * Generate options used for useInfiniteQuery/prefetchInfiniteQuery/...
      *
@@ -126,5 +134,5 @@ type UnrefDeep<T> = T extends Ref<infer U> ? UnrefDeep<U> : T extends AnyFunctio
 } : T;
 declare function unrefDeep<T>(value: T): UnrefDeep<T>;
 
-export { buildKey, createGeneralUtils, createRouterUtils as createORPCVueQueryUtils, createProcedureUtils, createRouterUtils, unrefDeep };
-export type { BuildKeyOptions, CreateProcedureUtilsOptions, CreateRouterUtilsOptions, GeneralUtils, InfiniteOptionsBase, InfiniteOptionsIn, KeyType, MaybeRefDeep, MutationOptions, MutationOptionsIn, ProcedureUtils, QueryOptionsBase, QueryOptionsIn, RouterUtils, UnrefDeep };
+export { createGeneralUtils, createRouterUtils as createORPCVueQueryUtils, createProcedureUtils, createRouterUtils, unrefDeep };
+export type { CreateProcedureUtilsOptions, CreateRouterUtilsOptions, GeneralUtils, InfiniteOptionsBase, InfiniteOptionsIn, MaybeRefDeep, MutationOptions, MutationOptionsIn, ProcedureUtils, QueryOptionsBase, QueryOptionsIn, RouterUtils, UnrefDeep, experimental_InferStreamedOutput, experimental_StreamedOptionsBase, experimental_StreamedOptionsIn };

package/dist/index.d.ts

@@ -1,22 +1,17 @@
 import { ClientContext, Client, NestedClient } from '@orpc/client';
-import { QueryKey, QueryObserverOptions, QueryFunctionContext, InfiniteQueryObserverOptions, MutationObserverOptions, InfiniteData } from '@tanstack/vue-query';
-import { PartialDeep, AnyFunction, MaybeOptionalOptions } from '@orpc/shared';
+import { OperationType, BuildKeyOptions } from '@orpc/tanstack-query';
+export { BuildKeyOptions, OperationType as KeyType, buildKey } from '@orpc/tanstack-query';
+import { QueryKey, SkipToken, QueryObserverOptions, QueryFunctionContext, experimental_streamedQuery, InfiniteQueryObserverOptions, MutationObserverOptions, InfiniteData } from '@tanstack/vue-query';
+import { AnyFunction, MaybeOptionalOptions } from '@orpc/shared';
 import { MaybeRef, MaybeRefOrGetter, ComputedRef, Ref } from 'vue';
 
-type KeyType = 'query' | 'infinite' | 'mutation' | undefined;
-interface BuildKeyOptions<TType extends KeyType, TInput> {
-    type?: TType;
-    input?: TType extends 'mutation' ? never : PartialDeep<TInput>;
-}
-declare function buildKey<TType extends KeyType, TInput>(path: string[], options?: BuildKeyOptions<TType, TInput>): QueryKey;
-
 interface GeneralUtils<TInput> {
     /**
      * Generate a query/mutation key for checking status, invalidate, set, get, etc.
      *
      * @see {@link https://orpc.unnoq.com/docs/tanstack-query/basic#query-mutation-key Tanstack Query/Mutation Key Docs}
      */
-    key<UType extends KeyType = undefined>(options?: BuildKeyOptions<UType, TInput>): QueryKey;
+    key<UType extends OperationType>(options?: BuildKeyOptions<UType, TInput>): QueryKey;
 }
 declare function createGeneralUtils<TInput>(path: string[]): GeneralUtils<TInput>;
 
@@ -28,9 +23,9 @@ type MaybeRefDeep<T> = MaybeRef<T extends AnyFunction ? T : T extends object ? {
     [Property in keyof T]: MaybeRefDeep<T[Property]>;
 } : T>;
 type QueryOptionsIn<TClientContext extends ClientContext, TInput, TOutput, TError, TSelectData> = (undefined extends TInput ? {
-    input?: MaybeRefDeep<TInput>;
+    input?: MaybeRefDeep<TInput | SkipToken>;
 } : {
-    input: MaybeRefDeep<TInput>;
+    input: MaybeRefDeep<TInput | SkipToken>;
 }) & (Record<never, never> extends TClientContext ? {
     context?: MaybeRefDeep<TClientContext>;
 } : {
@@ -45,17 +40,22 @@ type QueryOptionsIn<TClientContext extends ClientContext, TInput, TOutput, TErro
 interface QueryOptionsBase<TOutput, TError> {
     queryKey: ComputedRef<QueryKey>;
     queryFn(ctx: QueryFunctionContext): Promise<TOutput>;
-    retry?(failureCount: number, error: TError): boolean;
+    throwOnError?(error: TError): boolean;
+    enabled: ComputedRef<boolean>;
+}
+type experimental_StreamedQueryOptions = Omit<Parameters<typeof experimental_streamedQuery>[0], 'queryFn'>;
+type experimental_InferStreamedOutput<TOutput> = TOutput extends AsyncIterable<infer U> ? U[] : never;
+type experimental_StreamedOptionsIn<TClientContext extends ClientContext, TInput, TOutput, TError, TSelectData> = QueryOptionsIn<TClientContext, TInput, TOutput, TError, TSelectData> & experimental_StreamedQueryOptions;
+interface experimental_StreamedOptionsBase<TOutput, TError> extends QueryOptionsBase<TOutput, TError> {
 }
-type InfiniteOptionsIn<TClientContext extends ClientContext, TInput, TOutput, TError, TSelectData, TPageParam> = {
-    input: (pageParam: TPageParam) => MaybeRefDeep<TInput>;
-} & (Record<never, never> extends TClientContext ? {
+type InfiniteOptionsIn<TClientContext extends ClientContext, TInput, TOutput, TError, TSelectData, TPageParam> = (Record<never, never> extends TClientContext ? {
     context?: MaybeRefDeep<TClientContext>;
 } : {
     context: MaybeRefDeep<TClientContext>;
 }) & {
     [Property in keyof Omit<InfiniteQueryObserverOptions<TOutput, TError, TSelectData, TOutput, QueryKey, TPageParam>, 'queryKey' | 'enabled'>]: MaybeRefDeep<InfiniteQueryObserverOptions<TOutput, TError, TSelectData, TOutput, QueryKey, TPageParam>[Property]>;
 } & {
+    input: MaybeRef<((pageParam: TPageParam) => MaybeRefDeep<TInput>) | SkipToken>;
     enabled?: MaybeRefOrGetter<InfiniteQueryObserverOptions<TOutput, TError, TSelectData, TOutput, QueryKey, TPageParam>['enabled']>;
     queryKey?: MaybeRefDeep<InfiniteQueryObserverOptions<TOutput, TError, TSelectData, TOutput, QueryKey, TPageParam>['queryKey']>;
     shallow?: boolean;
@@ -63,7 +63,8 @@ type InfiniteOptionsIn<TClientContext extends ClientContext, TInput, TOutput, TE
 interface InfiniteOptionsBase<TOutput, TError, TPageParam> {
     queryKey: ComputedRef<QueryKey>;
     queryFn(ctx: QueryFunctionContext<QueryKey, TPageParam>): Promise<TOutput>;
-    retry?(failureCount: number, error: TError): boolean;
+    throwOnError?(error: TError): boolean;
+    enabled: ComputedRef<boolean>;
 }
 type MutationOptionsIn<TClientContext extends ClientContext, TInput, TOutput, TError, TMutationContext> = (Record<never, never> extends TClientContext ? {
     context?: TClientContext;
@@ -89,6 +90,13 @@ interface ProcedureUtils<TClientContext extends ClientContext, TInput, TOutput,
      * @see {@link https://orpc.unnoq.com/docs/tanstack-query/basic#query-options-utility Tanstack Query Options Utility Docs}
      */
     queryOptions<U, USelectData = TOutput>(...rest: MaybeOptionalOptions<U & QueryOptionsIn<TClientContext, TInput, TOutput, TError, USelectData>>): NoInfer<U & Omit<QueryOptionsBase<TOutput, TError>, keyof U>>;
+    /**
+     * Generate [Event Iterator](https://orpc.unnoq.com/docs/event-iterator) options used for useQuery/prefetchQuery/...
+     * Built on top of [steamedQuery](https://tanstack.com/query/latest/docs/reference/streamedQuery)
+     *
+     * @see {@link https://orpc.unnoq.com/docs/tanstack-query/basic#streamed-query-options-utility Tanstack Streamed Query Options Utility Docs}
+     */
+    experimental_streamedOptions<U, USelectData = experimental_InferStreamedOutput<TOutput>>(...rest: MaybeOptionalOptions<U & experimental_StreamedOptionsIn<TClientContext, TInput, experimental_InferStreamedOutput<TOutput>, TError, USelectData>>): NoInfer<U & Omit<experimental_StreamedOptionsBase<experimental_InferStreamedOutput<TOutput>, TError>, keyof U>>;
     /**
      * Generate options used for useInfiniteQuery/prefetchInfiniteQuery/...
      *
@@ -126,5 +134,5 @@ type UnrefDeep<T> = T extends Ref<infer U> ? UnrefDeep<U> : T extends AnyFunctio
 } : T;
 declare function unrefDeep<T>(value: T): UnrefDeep<T>;
 
-export { buildKey, createGeneralUtils, createRouterUtils as createORPCVueQueryUtils, createProcedureUtils, createRouterUtils, unrefDeep };
-export type { BuildKeyOptions, CreateProcedureUtilsOptions, CreateRouterUtilsOptions, GeneralUtils, InfiniteOptionsBase, InfiniteOptionsIn, KeyType, MaybeRefDeep, MutationOptions, MutationOptionsIn, ProcedureUtils, QueryOptionsBase, QueryOptionsIn, RouterUtils, UnrefDeep };
+export { createGeneralUtils, createRouterUtils as createORPCVueQueryUtils, createProcedureUtils, createRouterUtils, unrefDeep };
+export type { CreateProcedureUtilsOptions, CreateRouterUtilsOptions, GeneralUtils, InfiniteOptionsBase, InfiniteOptionsIn, MaybeRefDeep, MutationOptions, MutationOptionsIn, ProcedureUtils, QueryOptionsBase, QueryOptionsIn, RouterUtils, UnrefDeep, experimental_InferStreamedOutput, experimental_StreamedOptionsBase, experimental_StreamedOptionsIn };

package/dist/index.mjs

@@ -1,14 +1,8 @@
+import { buildKey } from '@orpc/tanstack-query';
+export { buildKey } from '@orpc/tanstack-query';
+import { isObject, isAsyncIteratorObject } from '@orpc/shared';
+import { skipToken, experimental_streamedQuery } from '@tanstack/vue-query';
 import { isRef, computed } from 'vue';
-import { isObject } from '@orpc/shared';
-
-function buildKey(path, options) {
-  const withInput = options?.input !== void 0 ? { input: options?.input } : {};
-  const withType = options?.type !== void 0 ? { type: options?.type } : {};
-  return [path, {
-    ...withInput,
-    ...withType
-  }];
-}
 
 function createGeneralUtils(path) {
   return {
@@ -40,18 +34,55 @@ function createProcedureUtils(client, options) {
     queryOptions(...[optionsIn = {}]) {
       return {
         queryKey: computed(() => buildKey(options.path, { type: "query", input: unrefDeep(optionsIn.input) })),
-        queryFn: ({ signal }) => client(unrefDeep(optionsIn.input), { signal, context: unrefDeep(optionsIn.context) }),
+        queryFn: ({ signal }) => {
+          const input = unrefDeep(optionsIn.input);
+          if (input === skipToken) {
+            throw new Error("queryFn should not be called with skipToken used as input");
+          }
+          return client(input, { signal, context: unrefDeep(optionsIn.context) });
+        },
+        enabled: computed(() => unrefDeep(optionsIn.input) !== skipToken),
+        ...optionsIn
+      };
+    },
+    experimental_streamedOptions(...[optionsIn = {}]) {
+      return {
+        enabled: computed(() => unrefDeep(optionsIn.input) !== skipToken),
+        queryKey: computed(() => buildKey(options.path, { type: "streamed", input: unrefDeep(optionsIn.input) })),
+        queryFn: experimental_streamedQuery({
+          ...optionsIn,
+          queryFn: async ({ signal }) => {
+            const input = unrefDeep(optionsIn.input);
+            if (input === skipToken) {
+              throw new Error("queryFn should not be called with skipToken used as input");
+            }
+            const output = await client(input, { signal, context: unrefDeep(optionsIn.context) });
+            if (!isAsyncIteratorObject(output)) {
+              throw new Error("streamedQuery requires an event iterator output");
+            }
+            return output;
+          }
+        }),
         ...optionsIn
       };
     },
     infiniteOptions(optionsIn) {
       return {
         queryKey: computed(() => {
-          return buildKey(options.path, { type: "infinite", input: unrefDeep(optionsIn.input(unrefDeep(optionsIn.initialPageParam))) });
+          const input = unrefDeep(optionsIn.input);
+          return buildKey(options.path, {
+            type: "infinite",
+            input: input === skipToken ? skipToken : unrefDeep(input(unrefDeep(optionsIn.initialPageParam)))
+          });
         }),
         queryFn: ({ pageParam, signal }) => {
-          return client(unrefDeep(optionsIn.input(pageParam)), { signal, context: unrefDeep(optionsIn.context) });
+          const input = unrefDeep(optionsIn.input);
+          if (input === skipToken) {
+            throw new Error("queryFn should not be called with skipToken used as input");
+          }
+          return client(unrefDeep(input(pageParam)), { signal, context: unrefDeep(optionsIn.context) });
         },
+        enabled: computed(() => unrefDeep(optionsIn.input) !== skipToken),
         ...optionsIn
       };
     },
@@ -92,4 +123,4 @@ function createRouterUtils(client, options = {}) {
   return recursive;
 }
 
-export { buildKey, createGeneralUtils, createRouterUtils as createORPCVueQueryUtils, createProcedureUtils, createRouterUtils, unrefDeep };
+export { createGeneralUtils, createRouterUtils as createORPCVueQueryUtils, createProcedureUtils, createRouterUtils, unrefDeep };

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@orpc/vue-query",
   "type": "module",
-  "version": "0.0.0-next.d8301f4",
+  "version": "0.0.0-next.d9485b0",
   "license": "MIT",
   "homepage": "https://orpc.unnoq.com",
   "repository": {
@@ -29,11 +29,14 @@
   "peerDependencies": {
     "@tanstack/vue-query": ">=5.55.0",
     "vue": ">=3.3.0",
-    "@orpc/client": "0.0.0-next.d8301f4"
+    "@orpc/client": "0.0.0-next.d9485b0"
   },
   "dependencies": {
-    "@tanstack/vue-query": "^5.72.3",
-    "@orpc/shared": "0.0.0-next.d8301f4"
+    "@orpc/shared": "0.0.0-next.d9485b0",
+    "@orpc/tanstack-query": "0.0.0-next.d9485b0"
+  },
+  "devDependencies": {
+    "@tanstack/vue-query": "^5.72.3"
   },
   "scripts": {
     "build": "unbuild",