@orpc/vue-query 0.0.0-next.ed15210 → 0.0.0-next.ee46dab

package/README.md

@@ -0,0 +1,123 @@
+<div align="center">
+  <image align="center" src="https://orpc.unnoq.com/logo.webp" width=280 alt="oRPC logo" />
+</div>
+
+<h1></h1>
+
+<div align="center">
+  <a href="https://codecov.io/gh/unnoq/orpc">
+    <img alt="codecov" src="https://codecov.io/gh/unnoq/orpc/branch/main/graph/badge.svg">
+  </a>
+  <a href="https://www.npmjs.com/package/@orpc/vue-query">
+    <img alt="weekly downloads" src="https://img.shields.io/npm/dw/%40orpc%2Fvue-query?logo=npm" />
+  </a>
+  <a href="https://github.com/unnoq/orpc/blob/main/LICENSE">
+    <img alt="MIT License" src="https://img.shields.io/github/license/unnoq/orpc?logo=open-source-initiative" />
+  </a>
+  <a href="https://discord.gg/TXEbwRBvQn">
+    <img alt="Discord" src="https://img.shields.io/discord/1308966753044398161?color=7389D8&label&logo=discord&logoColor=ffffff" />
+  </a>
+</div>
+
+<h3 align="center">Typesafe APIs Made Simple 🪄</h3>
+
+**oRPC is a powerful combination of RPC and OpenAPI**, makes it easy to build APIs that are end-to-end type-safe and adhere to OpenAPI standards, ensuring a smooth and enjoyable developer experience.
+
+---
+
+## Highlights
+
+- **End-to-End Type Safety 🔒**: Ensure complete type safety from inputs to outputs and errors, bridging server and client seamlessly.
+- **First-Class OpenAPI 📄**: Adheres to the OpenAPI standard out of the box, ensuring seamless integration and comprehensive API documentation.
+- **Contract-First Development 📜**: (Optional) Define your API contract upfront and implement it with confidence.
+- **Exceptional Developer Experience ✨**: Enjoy a streamlined workflow with robust typing and clear, in-code documentation.
+- **Multi-Runtime Support 🌍**: Run your code seamlessly on Cloudflare, Deno, Bun, Node.js, and more.
+- **Framework Integrations 🧩**: Supports Tanstack Query (React, Vue, Solid, Svelte), Pinia Colada, and more.
+- **Server Actions ⚡️**: Fully compatible with React Server Actions on Next.js, TanStack Start, and more.
+- **Standard Schema Support 🗂️**: Effortlessly work with Zod, Valibot, ArkType, and others right out of the box.
+- **Fast & Lightweight 💨**: Built on native APIs across all runtimes – optimized for speed and efficiency.
+- **Native Types 📦**: Enjoy built-in support for Date, File, Blob, BigInt, URL and more with no extra setup.
+- **Lazy Router ⏱️**: Improve cold start times with our lazy routing feature.
+- **SSE & Streaming 📡**: Provides SSE and streaming features – perfect for real-time notifications and AI-powered streaming responses.
+- **Reusability 🔄**: Write once and reuse your code across multiple purposes effortlessly.
+- **Extendability 🔌**: Easily enhance oRPC with plugins, middleware, and interceptors.
+- **Reliability 🛡️**: Well-tested, fully TypeScript, production-ready, and MIT licensed for peace of mind.
+- **Simplicity 💡**: Enjoy straightforward, clean code with no hidden magic.
+
+## Documentation
+
+You can find the full documentation [here](https://orpc.unnoq.com).
+
+## Packages
+
+- [@orpc/contract](https://www.npmjs.com/package/@orpc/contract): Build your API contract.
+- [@orpc/server](https://www.npmjs.com/package/@orpc/server): Build your API or implement API contract.
+- [@orpc/client](https://www.npmjs.com/package/@orpc/client): Consume your API on the client with type-safety.
+- [@orpc/react](https://www.npmjs.com/package/@orpc/react): Utilities for integrating oRPC with React and React Server Actions.
+- [@orpc/react-query](https://www.npmjs.com/package/@orpc/react-query): Integration with [React Query](https://tanstack.com/query/latest/docs/framework/react/overview).
+- [@orpc/vue-query](https://www.npmjs.com/package/@orpc/vue-query): Integration with [Vue Query](https://tanstack.com/query/latest/docs/framework/vue/overview).
+- [@orpc/solid-query](https://www.npmjs.com/package/@orpc/solid-query): Integration with [Solid Query](https://tanstack.com/query/latest/docs/framework/solid/overview).
+- [@orpc/svelte-query](https://www.npmjs.com/package/@orpc/svelte-query): Integration with [Svelte Query](https://tanstack.com/query/latest/docs/framework/svelte/overview).
+- [@orpc/vue-colada](https://www.npmjs.com/package/@orpc/vue-colada): Integration with [Pinia Colada](https://pinia-colada.esm.dev/).
+- [@orpc/openapi](https://www.npmjs.com/package/@orpc/openapi): Generate OpenAPI specs and handle OpenAPI requests.
+- [@orpc/zod](https://www.npmjs.com/package/@orpc/zod): More schemas that [Zod](https://zod.dev/) doesn't support yet.
+- [@orpc/valibot](https://www.npmjs.com/package/@orpc/valibot): OpenAPI spec generation from [Valibot](https://valibot.dev/).
+- [@orpc/arktype](https://www.npmjs.com/package/@orpc/arktype): OpenAPI spec generation from [ArkType](https://arktype.io/).
+
+## `@orpc/vue-query`
+
+Integration with [Vue Query](https://tanstack.com/query/latest/docs/framework/vue/overview). Read the [documentation](https://orpc.unnoq.com/docs/tanstack-query/vue) for more information.
+
+```ts
+export function Setup() {
+  const query = useQuery(orpc.planet.find.queryOptions({
+    input: { id: 123 }, // Specify input if needed
+    context: { cache: true }, // Provide client context if needed
+  // additional options...
+  }))
+
+  const query = useInfiniteQuery(orpc.planet.list.infiniteOptions({
+    input: (pageParam: number | undefined) => ({ limit: 10, offset: pageParam }),
+    context: { cache: true }, // Provide client context if needed
+    initialPageParam: undefined,
+    getNextPageParam: lastPage => lastPage.nextPageParam,
+  // additional options...
+  }))
+
+  const mutation = useMutation(orpc.planet.create.mutationOptions({
+    context: { cache: true }, // Provide client context if needed
+  // additional options...
+  }))
+
+  mutation.mutate({ name: 'Earth' })
+
+  const queryClient = useQueryClient()
+
+  // Invalidate all planet queries
+  queryClient.invalidateQueries({
+    queryKey: orpc.planet.key(),
+  })
+
+  // Invalidate only regular (non-infinite) planet queries
+  queryClient.invalidateQueries({
+    queryKey: orpc.planet.key({ type: 'query' })
+  })
+
+  // Invalidate the planet find query with id 123
+  queryClient.invalidateQueries({
+    queryKey: orpc.planet.find.key({ input: { id: 123 } })
+  })
+}
+```
+
+## Sponsors
+
+<p align="center">
+  <a href="https://cdn.jsdelivr.net/gh/unnoq/unnoq/sponsors.svg">
+    <img src='https://cdn.jsdelivr.net/gh/unnoq/unnoq/sponsors.svg'/>
+  </a>
+</p>
+
+## License
+
+Distributed under the MIT License. See [LICENSE](https://github.com/unnoq/orpc/blob/main/LICENSE) for more information.

package/dist/index.d.mts

@@ -0,0 +1,92 @@
+import { ClientContext, Client, NestedClient } from '@orpc/client';
+import { QueryKey, QueryObserverOptions, QueryFunctionContext, UseInfiniteQueryOptions, MutationObserverOptions, InfiniteData } from '@tanstack/vue-query';
+import { PartialDeep, AnyFunction, SetOptional, 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> {
+    key<UType extends KeyType = undefined>(options?: BuildKeyOptions<UType, TInput>): QueryKey;
+}
+declare function createGeneralUtils<TInput>(path: string[]): GeneralUtils<TInput>;
+
+/**
+ * Since `@tanstack/vue-query` is not exporting the type `MaybeRefDeep` we need to copy it from the source code.
+ * https://github.com/TanStack/query/blob/7ff544e12e79388e513b1cd886aeb946f80f0153/packages/vue-query/src/types.ts#L19C1-L27C2
+ */
+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>;
+}) & (Record<never, never> extends TClientContext ? {
+    context?: MaybeRefDeep<TClientContext>;
+} : {
+    context: MaybeRefDeep<TClientContext>;
+}) & {
+    [P in keyof Omit<QueryObserverOptions<TOutput, TError, TSelectData, TOutput>, 'queryKey' | 'enabled'>]: MaybeRefDeep<QueryObserverOptions<TOutput, TError, TSelectData, TOutput>[P]>;
+} & {
+    enabled?: MaybeRefOrGetter<QueryObserverOptions<TOutput, TError, TSelectData, TOutput>['enabled']>;
+    queryKey?: MaybeRefDeep<QueryObserverOptions<TOutput, TError, TSelectData, TOutput>['queryKey']>;
+    shallow?: MaybeRef<boolean>;
+};
+interface QueryOptionsBase<TOutput, TError> {
+    queryKey: ComputedRef<QueryKey>;
+    queryFn(ctx: QueryFunctionContext): Promise<TOutput>;
+    retry?(failureCount: number, error: TError): boolean;
+}
+type InfiniteOptionsIn<TClientContext extends ClientContext, TInput, TOutput, TError, TSelectData, TPageParam> = {
+    input: (pageParam: TPageParam) => MaybeRefDeep<TInput>;
+} & (Record<never, never> extends TClientContext ? {
+    context?: MaybeRefDeep<TClientContext>;
+} : {
+    context: MaybeRefDeep<TClientContext>;
+}) & SetOptional<UseInfiniteQueryOptions<TOutput, TError, TSelectData, TOutput, QueryKey, TPageParam>, 'queryKey'>;
+interface InfiniteOptionsBase<TOutput, TError, TPageParam> {
+    queryKey: ComputedRef<QueryKey>;
+    queryFn(ctx: QueryFunctionContext<QueryKey, TPageParam>): Promise<TOutput>;
+    retry?(failureCount: number, error: TError): boolean;
+}
+type MutationOptionsIn<TClientContext extends ClientContext, TInput, TOutput, TError, TMutationContext> = (Record<never, never> extends TClientContext ? {
+    context?: TClientContext;
+} : {
+    context: TClientContext;
+}) & MutationOptions<TInput, TOutput, TError, TMutationContext>;
+type MutationOptions<TInput, TOutput, TError, TMutationContext> = {
+    [P in keyof MutationObserverOptions<TOutput, TError, TInput, TMutationContext>]: MaybeRefDeep<MutationObserverOptions<TOutput, TError, TInput, TMutationContext>[P]>;
+} & {
+    shallow?: MaybeRef<boolean>;
+};
+
+interface ProcedureUtils<TClientContext extends ClientContext, TInput, TOutput, TError> {
+    call: Client<TClientContext, TInput, TOutput, TError>;
+    queryOptions<U, USelectData = TOutput>(...rest: MaybeOptionalOptions<U & QueryOptionsIn<TClientContext, TInput, TOutput, TError, USelectData>>): NoInfer<U & Omit<QueryOptionsBase<TOutput, TError>, keyof U>>;
+    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>>;
+    mutationOptions<UMutationContext>(...rest: MaybeOptionalOptions<MutationOptionsIn<TClientContext, TInput, TOutput, TError, UMutationContext>>): MutationOptions<TInput, TOutput, TError, UMutationContext>;
+}
+interface CreateProcedureUtilsOptions {
+    path: string[];
+}
+declare function createProcedureUtils<TClientContext extends ClientContext, TInput, TOutput, TError>(client: Client<TClientContext, TInput, TOutput, TError>, options: CreateProcedureUtilsOptions): ProcedureUtils<TClientContext, TInput, TOutput, TError>;
+
+type RouterUtils<T extends NestedClient<any>> = T extends Client<infer UClientContext, infer UInput, infer UOutput, infer UError> ? ProcedureUtils<UClientContext, UInput, UOutput, UError> & GeneralUtils<UInput> : {
+    [K in keyof T]: T[K] extends NestedClient<any> ? RouterUtils<T[K]> : never;
+} & GeneralUtils<unknown>;
+interface CreateRouterUtilsOptions {
+    path?: string[];
+}
+declare function createRouterUtils<T extends NestedClient<any>>(client: T, options?: CreateRouterUtilsOptions): RouterUtils<T>;
+
+type UnrefDeep<T> = T extends Ref<infer U> ? UnrefDeep<U> : T extends AnyFunction ? T : T extends object ? {
+    [K in keyof T]: UnrefDeep<T[K]>;
+} : T;
+declare function unrefDeep<T>(value: T): UnrefDeep<T>;
+
+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, type UnrefDeep, buildKey, createGeneralUtils, createRouterUtils as createORPCVueQueryUtils, createProcedureUtils, createRouterUtils, unrefDeep };

package/dist/index.d.ts

@@ -0,0 +1,92 @@
+import { ClientContext, Client, NestedClient } from '@orpc/client';
+import { QueryKey, QueryObserverOptions, QueryFunctionContext, UseInfiniteQueryOptions, MutationObserverOptions, InfiniteData } from '@tanstack/vue-query';
+import { PartialDeep, AnyFunction, SetOptional, 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> {
+    key<UType extends KeyType = undefined>(options?: BuildKeyOptions<UType, TInput>): QueryKey;
+}
+declare function createGeneralUtils<TInput>(path: string[]): GeneralUtils<TInput>;
+
+/**
+ * Since `@tanstack/vue-query` is not exporting the type `MaybeRefDeep` we need to copy it from the source code.
+ * https://github.com/TanStack/query/blob/7ff544e12e79388e513b1cd886aeb946f80f0153/packages/vue-query/src/types.ts#L19C1-L27C2
+ */
+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>;
+}) & (Record<never, never> extends TClientContext ? {
+    context?: MaybeRefDeep<TClientContext>;
+} : {
+    context: MaybeRefDeep<TClientContext>;
+}) & {
+    [P in keyof Omit<QueryObserverOptions<TOutput, TError, TSelectData, TOutput>, 'queryKey' | 'enabled'>]: MaybeRefDeep<QueryObserverOptions<TOutput, TError, TSelectData, TOutput>[P]>;
+} & {
+    enabled?: MaybeRefOrGetter<QueryObserverOptions<TOutput, TError, TSelectData, TOutput>['enabled']>;
+    queryKey?: MaybeRefDeep<QueryObserverOptions<TOutput, TError, TSelectData, TOutput>['queryKey']>;
+    shallow?: MaybeRef<boolean>;
+};
+interface QueryOptionsBase<TOutput, TError> {
+    queryKey: ComputedRef<QueryKey>;
+    queryFn(ctx: QueryFunctionContext): Promise<TOutput>;
+    retry?(failureCount: number, error: TError): boolean;
+}
+type InfiniteOptionsIn<TClientContext extends ClientContext, TInput, TOutput, TError, TSelectData, TPageParam> = {
+    input: (pageParam: TPageParam) => MaybeRefDeep<TInput>;
+} & (Record<never, never> extends TClientContext ? {
+    context?: MaybeRefDeep<TClientContext>;
+} : {
+    context: MaybeRefDeep<TClientContext>;
+}) & SetOptional<UseInfiniteQueryOptions<TOutput, TError, TSelectData, TOutput, QueryKey, TPageParam>, 'queryKey'>;
+interface InfiniteOptionsBase<TOutput, TError, TPageParam> {
+    queryKey: ComputedRef<QueryKey>;
+    queryFn(ctx: QueryFunctionContext<QueryKey, TPageParam>): Promise<TOutput>;
+    retry?(failureCount: number, error: TError): boolean;
+}
+type MutationOptionsIn<TClientContext extends ClientContext, TInput, TOutput, TError, TMutationContext> = (Record<never, never> extends TClientContext ? {
+    context?: TClientContext;
+} : {
+    context: TClientContext;
+}) & MutationOptions<TInput, TOutput, TError, TMutationContext>;
+type MutationOptions<TInput, TOutput, TError, TMutationContext> = {
+    [P in keyof MutationObserverOptions<TOutput, TError, TInput, TMutationContext>]: MaybeRefDeep<MutationObserverOptions<TOutput, TError, TInput, TMutationContext>[P]>;
+} & {
+    shallow?: MaybeRef<boolean>;
+};
+
+interface ProcedureUtils<TClientContext extends ClientContext, TInput, TOutput, TError> {
+    call: Client<TClientContext, TInput, TOutput, TError>;
+    queryOptions<U, USelectData = TOutput>(...rest: MaybeOptionalOptions<U & QueryOptionsIn<TClientContext, TInput, TOutput, TError, USelectData>>): NoInfer<U & Omit<QueryOptionsBase<TOutput, TError>, keyof U>>;
+    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>>;
+    mutationOptions<UMutationContext>(...rest: MaybeOptionalOptions<MutationOptionsIn<TClientContext, TInput, TOutput, TError, UMutationContext>>): MutationOptions<TInput, TOutput, TError, UMutationContext>;
+}
+interface CreateProcedureUtilsOptions {
+    path: string[];
+}
+declare function createProcedureUtils<TClientContext extends ClientContext, TInput, TOutput, TError>(client: Client<TClientContext, TInput, TOutput, TError>, options: CreateProcedureUtilsOptions): ProcedureUtils<TClientContext, TInput, TOutput, TError>;
+
+type RouterUtils<T extends NestedClient<any>> = T extends Client<infer UClientContext, infer UInput, infer UOutput, infer UError> ? ProcedureUtils<UClientContext, UInput, UOutput, UError> & GeneralUtils<UInput> : {
+    [K in keyof T]: T[K] extends NestedClient<any> ? RouterUtils<T[K]> : never;
+} & GeneralUtils<unknown>;
+interface CreateRouterUtilsOptions {
+    path?: string[];
+}
+declare function createRouterUtils<T extends NestedClient<any>>(client: T, options?: CreateRouterUtilsOptions): RouterUtils<T>;
+
+type UnrefDeep<T> = T extends Ref<infer U> ? UnrefDeep<U> : T extends AnyFunction ? T : T extends object ? {
+    [K in keyof T]: UnrefDeep<T[K]>;
+} : T;
+declare function unrefDeep<T>(value: T): UnrefDeep<T>;
+
+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, type UnrefDeep, buildKey, createGeneralUtils, createRouterUtils as createORPCVueQueryUtils, createProcedureUtils, createRouterUtils, unrefDeep };

package/dist/index.mjs

@@ -0,0 +1,95 @@
+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 {
+    key(options) {
+      return buildKey(path, options);
+    }
+  };
+}
+
+function unrefDeep(value) {
+  if (isRef(value)) {
+    return unrefDeep(value.value);
+  }
+  if (Array.isArray(value)) {
+    return value.map(unrefDeep);
+  }
+  if (isObject(value)) {
+    return Object.keys(value).reduce((acc, key) => {
+      acc[key] = unrefDeep(value[key]);
+      return acc;
+    }, {});
+  }
+  return value;
+}
+
+function createProcedureUtils(client, options) {
+  return {
+    call: client,
+    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) }),
+        ...optionsIn
+      };
+    },
+    infiniteOptions(optionsIn) {
+      return {
+        queryKey: computed(() => {
+          return buildKey(options.path, { type: "infinite", input: unrefDeep(optionsIn.input(unrefDeep(optionsIn.initialPageParam))) });
+        }),
+        queryFn: ({ pageParam, signal }) => {
+          return client(unrefDeep(optionsIn.input(pageParam)), { signal, context: unrefDeep(optionsIn.context) });
+        },
+        ...optionsIn
+      };
+    },
+    mutationOptions(...[optionsIn = {}]) {
+      return {
+        mutationKey: buildKey(options.path, { type: "mutation" }),
+        mutationFn: (input) => client(input, { context: unrefDeep(optionsIn.context) }),
+        ...optionsIn
+      };
+    }
+  };
+}
+
+function createRouterUtils(client, options = {}) {
+  const path = options.path ?? [];
+  const generalUtils = createGeneralUtils(path);
+  const procedureUtils = createProcedureUtils(client, { path });
+  const recursive = new Proxy({
+    ...generalUtils,
+    ...procedureUtils
+  }, {
+    get(target, prop) {
+      const value = Reflect.get(target, prop);
+      if (typeof prop !== "string") {
+        return value;
+      }
+      const nextUtils = createRouterUtils(client[prop], { ...options, path: [...path, prop] });
+      if (typeof value !== "function") {
+        return nextUtils;
+      }
+      return new Proxy(value, {
+        get(_, prop2) {
+          return Reflect.get(nextUtils, prop2);
+        }
+      });
+    }
+  });
+  return recursive;
+}
+
+export { buildKey, 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.ed15210",
+  "version": "0.0.0-next.ee46dab",
   "license": "MIT",
   "homepage": "https://orpc.unnoq.com",
   "repository": {
@@ -18,27 +18,24 @@
   ],
   "exports": {
     ".": {
-      "types": "./dist/src/index.d.ts",
-      "import": "./dist/index.js",
-      "default": "./dist/index.js"
-    },
-    "./🔒/*": {
-      "types": "./dist/src/*.d.ts"
+      "types": "./dist/index.d.mts",
+      "import": "./dist/index.mjs",
+      "default": "./dist/index.mjs"
     }
   },
   "files": [
-    "!**/*.map",
-    "!**/*.tsbuildinfo",
     "dist"
   ],
   "peerDependencies": {
     "@tanstack/vue-query": ">=5.50.0",
     "vue": ">=3.3.0",
-    "@orpc/contract": "0.0.0-next.ed15210",
-    "@orpc/client": "0.0.0-next.ed15210"
+    "@orpc/client": "0.0.0-next.ee46dab"
+  },
+  "dependencies": {
+    "@orpc/shared": "0.0.0-next.ee46dab"
   },
   "scripts": {
-    "build": "tsup --clean --sourcemap --entry.index=src/index.ts --format=esm --onSuccess='tsc -b --noCheck'",
+    "build": "unbuild",
     "build:watch": "pnpm run build --watch",
     "type:check": "tsc -b"
   }

package/dist/index.js

@@ -1,111 +0,0 @@
-// src/key.ts
-function buildKey(path, options) {
-  const withInput = options?.input !== void 0 ? { input: options?.input } : {};
-  const withType = options?.type !== void 0 ? { type: options?.type } : {};
-  return [
-    "__ORPC__",
-    path,
-    {
-      ...withInput,
-      ...withType
-    }
-  ];
-}
-
-// src/utils.ts
-import { isRef } from "vue";
-function deepUnref(value) {
-  if (isRef(value)) {
-    return deepUnref(value.value);
-  }
-  if (Array.isArray(value)) {
-    return value.map(deepUnref);
-  }
-  if (value && typeof value === "object") {
-    return Object.keys(value).reduce((acc, key) => {
-      acc[key] = deepUnref(value[key]);
-      return acc;
-    }, {});
-  }
-  return value;
-}
-
-// src/utils-general.ts
-function createGeneralUtils(path) {
-  return {
-    key(options) {
-      return buildKey(path, deepUnref(options));
-    }
-  };
-}
-
-// src/utils-procedure.ts
-import { computed } from "vue";
-function createProcedureUtils(client, path) {
-  return {
-    queryOptions(...[options]) {
-      const input = options?.input;
-      return {
-        queryKey: computed(() => buildKey(path, { type: "query", input: deepUnref(input) })),
-        queryFn: ({ signal }) => client(deepUnref(input), { signal, context: deepUnref(options?.context) }),
-        ...options
-      };
-    },
-    infiniteOptions(options) {
-      const input = options.input;
-      return {
-        initialPageParam: void 0,
-        queryKey: computed(() => buildKey(path, { type: "infinite", input: deepUnref(input) })),
-        queryFn: ({ pageParam, signal }) => {
-          return client({ ...deepUnref(input), cursor: pageParam }, { signal, context: deepUnref(options.context) });
-        },
-        ...options
-      };
-    },
-    mutationOptions(...[options]) {
-      return {
-        mutationKey: buildKey(path, { type: "mutation" }),
-        mutationFn: (input) => client(input, { context: deepUnref(options?.context) }),
-        ...options
-      };
-    }
-  };
-}
-
-// src/utils-router.ts
-function createRouterUtils(client, path = []) {
-  const generalUtils = createGeneralUtils(path);
-  const procedureUtils = createProcedureUtils(client, path);
-  const recursive = new Proxy({
-    ...generalUtils,
-    ...procedureUtils
-  }, {
-    get(target, prop) {
-      const value = Reflect.get(target, prop);
-      if (typeof prop !== "string") {
-        return value;
-      }
-      const nextUtils = createRouterUtils(client[prop], [...path, prop]);
-      if (typeof value !== "function") {
-        return nextUtils;
-      }
-      return new Proxy(value, {
-        get(_, prop2) {
-          return Reflect.get(nextUtils, prop2);
-        }
-      });
-    }
-  });
-  return recursive;
-}
-
-// src/index.ts
-var createORPCVueQueryUtils = createRouterUtils;
-export {
-  buildKey,
-  createGeneralUtils,
-  createORPCVueQueryUtils,
-  createProcedureUtils,
-  createRouterUtils
-};
-//# sourceMappingURL=index.js.map

package/dist/src/index.d.ts

@@ -1,8 +0,0 @@
-import { createRouterUtils } from './utils-router';
-export * from './key';
-export * from './types';
-export * from './utils-general';
-export * from './utils-procedure';
-export * from './utils-router';
-export declare const createORPCVueQueryUtils: typeof createRouterUtils;
-//# sourceMappingURL=index.d.ts.map

package/dist/src/key.d.ts

@@ -1,9 +0,0 @@
-import type { PartialDeep } from '@orpc/shared';
-import type { QueryKey } from '@tanstack/vue-query';
-export type KeyType = 'query' | 'infinite' | 'mutation' | undefined;
-export interface BuildKeyOptions<TType extends KeyType, TInput> {
-    type?: TType;
-    input?: TType extends 'mutation' ? never : PartialDeep<TInput>;
-}
-export declare function buildKey<TType extends KeyType, TInput>(path: string[], options?: BuildKeyOptions<TType, TInput>): QueryKey;
-//# sourceMappingURL=key.d.ts.map

package/dist/src/types.d.ts

@@ -1,59 +0,0 @@
-import type { AnyFunction, SetOptional } from '@orpc/shared';
-import type { MutationObserverOptions, QueryFunctionContext, QueryKey, QueryObserverOptions, UseInfiniteQueryOptions } from '@tanstack/vue-query';
-import type { ComputedRef, MaybeRef, MaybeRefOrGetter } from 'vue';
-export type MaybeDeepRef<T> = MaybeRef<T extends AnyFunction ? T : T extends object ? {
-    [K in keyof T]: MaybeDeepRef<T[K]>;
-} : T>;
-export type NonUndefinedGuard<T> = T extends undefined ? never : T;
-export type InferCursor<T> = T extends {
-    cursor?: any;
-} ? T['cursor'] : never;
-export type QueryOptionsExtra<TClientContext, TInput, TOutput, TError extends Error, TSelectData> = (undefined extends TInput ? {
-    input?: MaybeDeepRef<TInput>;
-} : {
-    input: MaybeDeepRef<TInput>;
-}) & (undefined extends TClientContext ? {
-    context?: MaybeDeepRef<TClientContext>;
-} : {
-    context: MaybeDeepRef<TClientContext>;
-}) & SetOptional<{
-    [P in keyof QueryObserverOptions<TOutput, TError, TSelectData, TOutput, QueryKey>]: P extends 'enabled' ? MaybeRefOrGetter<QueryObserverOptions<TOutput, TError, TSelectData, TOutput, QueryKey>[P]> : MaybeDeepRef<QueryObserverOptions<TOutput, TError, TSelectData, TOutput, QueryKey>[P]>;
-}, 'queryKey'> & {
-    shallow?: MaybeRef<boolean>;
-    initialData?: NonUndefinedGuard<TOutput> | (() => NonUndefinedGuard<TOutput>) | undefined;
-};
-export interface QueryOptionsBase<TOutput, TError extends Error> {
-    queryKey: ComputedRef<QueryKey>;
-    queryFn: (ctx: QueryFunctionContext) => Promise<TOutput>;
-    retry?: (failureCount: number, error: TError) => boolean;
-}
-export type InfiniteOptionsExtra<TClientContext, TInput, TOutput, TError extends Error, TSelectData> = (undefined extends TInput ? {
-    input?: MaybeDeepRef<Omit<TInput, 'cursor'>>;
-} : {
-    input: MaybeDeepRef<Omit<TInput, 'cursor'>>;
-}) & (undefined extends TClientContext ? {
-    context?: MaybeDeepRef<TClientContext>;
-} : {
-    context: MaybeDeepRef<TClientContext>;
-}) & SetOptional<UseInfiniteQueryOptions<TOutput, TError, TSelectData, TOutput, QueryKey, InferCursor<TInput>>, 'queryKey' | (undefined extends InferCursor<TInput> ? 'initialPageParam' : never)>;
-export interface InfiniteOptionsBase<TInput, TOutput, TError extends Error> {
-    queryKey: ComputedRef<QueryKey>;
-    queryFn: (ctx: QueryFunctionContext<QueryKey, InferCursor<TInput>>) => Promise<TOutput>;
-    initialPageParam: undefined;
-    retry?: (failureCount: number, error: TError) => boolean;
-}
-export type MutationOptionsExtra<TClientContext, TInput, TOutput, TError extends Error> = (undefined extends TClientContext ? {
-    context?: MaybeDeepRef<TClientContext>;
-} : {
-    context: MaybeDeepRef<TClientContext>;
-}) & {
-    [P in keyof MutationObserverOptions<TOutput, TError, TInput, unknown>]: MaybeDeepRef<MutationObserverOptions<TOutput, TError, TInput, unknown>[P]>;
-} & {
-    shallow?: MaybeRef<boolean>;
-};
-export interface MutationOptionsBase<TInput, TOutput, TError extends Error> {
-    mutationKey: QueryKey;
-    mutationFn: (input: TInput) => Promise<TOutput>;
-    retry?: (failureCount: number, error: TError) => boolean;
-}
-//# sourceMappingURL=types.d.ts.map

package/dist/src/utils-general.d.ts

@@ -1,11 +0,0 @@
-import type { QueryKey } from '@tanstack/vue-query';
-import type { BuildKeyOptions, KeyType } from './key';
-import type { MaybeDeepRef } from './types';
-/**
- * Utils at any level (procedure or router)
- */
-export interface GeneralUtils<TInput> {
-    key: <UType extends KeyType = undefined>(options?: MaybeDeepRef<BuildKeyOptions<UType, TInput>>) => QueryKey;
-}
-export declare function createGeneralUtils<TInput>(path: string[]): GeneralUtils<TInput>;
-//# sourceMappingURL=utils-general.d.ts.map

package/dist/src/utils-procedure.d.ts

@@ -1,13 +0,0 @@
-import type { Client } from '@orpc/contract';
-import type { IsEqual } from '@orpc/shared';
-import type { InfiniteOptionsBase, InfiniteOptionsExtra, MutationOptionsBase, MutationOptionsExtra, QueryOptionsBase, QueryOptionsExtra } from './types';
-/**
- * Utils at procedure level
- */
-export interface ProcedureUtils<TClientContext, TInput, TOutput, TError extends Error> {
-    queryOptions: <U extends QueryOptionsExtra<TClientContext, TInput, TOutput, TError, any>>(...opt: [options: U] | (undefined extends TInput & TClientContext ? [] : never)) => IsEqual<U, QueryOptionsExtra<TClientContext, TInput, TOutput, TError, any>> extends true ? QueryOptionsBase<TOutput, TError> : Omit<QueryOptionsBase<TOutput, TError>, keyof U> & U;
-    infiniteOptions: <U extends InfiniteOptionsExtra<TClientContext, TInput, TOutput, TError, any>>(options: U) => Omit<InfiniteOptionsBase<TInput, TOutput, TError>, keyof U> & U;
-    mutationOptions: <U extends MutationOptionsExtra<TClientContext, TInput, TOutput, TError>>(...opt: [options: U] | (undefined extends TClientContext ? [] : never)) => IsEqual<U, MutationOptionsExtra<TClientContext, TInput, TOutput, TError>> extends true ? MutationOptionsBase<TInput, TOutput, TError> : Omit<MutationOptionsBase<TInput, TOutput, TError>, keyof U> & U;
-}
-export declare function createProcedureUtils<TClientContext, TInput, TOutput, TError extends Error>(client: Client<TClientContext, TInput, TOutput, TError>, path: string[]): ProcedureUtils<TClientContext, TInput, TOutput, TError>;
-//# sourceMappingURL=utils-procedure.d.ts.map

package/dist/src/utils-router.d.ts

@@ -1,12 +0,0 @@
-import type { Client, NestedClient } from '@orpc/contract';
-import { type GeneralUtils } from './utils-general';
-import { type ProcedureUtils } from './utils-procedure';
-export type RouterUtils<T extends NestedClient<any>> = T extends Client<infer TClientContext, infer UInput, infer UOutput, infer UError> ? ProcedureUtils<TClientContext, UInput, UOutput, UError> & GeneralUtils<UInput> : {
-    [K in keyof T]: T[K] extends NestedClient<any> ? RouterUtils<T[K]> : never;
-} & GeneralUtils<unknown>;
-/**
- * @param client - The client create form `@orpc/client`
- * @param path - The base path for query key
- */
-export declare function createRouterUtils<T extends NestedClient<any>>(client: T, path?: string[]): RouterUtils<T>;
-//# sourceMappingURL=utils-router.d.ts.map

package/dist/src/utils.d.ts

@@ -1,7 +0,0 @@
-import type { AnyFunction } from '@orpc/shared';
-import type { Ref } from 'vue';
-export type DeepUnref<T> = T extends Ref<infer U> ? DeepUnref<U> : T extends AnyFunction ? T : T extends object ? {
-    [K in keyof T]: DeepUnref<T[K]>;
-} : T;
-export declare function deepUnref<T>(value: T): DeepUnref<T>;
-//# sourceMappingURL=utils.d.ts.map