@orpc/vue-colada 0.46.0 → 0.48.0

package/README.md

@@ -32,7 +32,7 @@
 - **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), Pinia Colada, 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.
@@ -55,6 +55,8 @@ You can find the full documentation [here](https://orpc.unnoq.com).
 - [@orpc/client](https://www.npmjs.com/package/@orpc/client): Consume your API on the client with type-safety.
 - [@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.

package/dist/index.d.mts

@@ -1,7 +1,7 @@
 import { ClientContext, Client, NestedClient } from '@orpc/client';
 import { EntryKey, UseQueryOptions, UseMutationOptions, _EmptyObject } from '@pinia/colada';
-import { AnyFunction, SetOptional, MaybeOptionalOptions } from '@orpc/shared';
-import { MaybeRef } from 'vue';
+import { SetOptional, MaybeOptionalOptions } from '@orpc/shared';
+import { MaybeRefOrGetter } from 'vue';
 
 interface BuildKeyOptions<TInput> {
     input?: TInput;
@@ -13,43 +13,40 @@ interface GeneralUtils<TInput> {
 }
 declare function createGeneralUtils<TInput>(path: string[]): GeneralUtils<TInput>;
 
-type MaybeRefDeep<T> = MaybeRef<T extends AnyFunction ? T : T extends object ? {
-    [K in keyof T]: MaybeRefDeep<T[K]>;
-} : T>;
 type UseQueryFnContext = Parameters<UseQueryOptions<any>['query']>[0];
-type QueryOptionsIn<TClientContext extends ClientContext, TInput, TOutput, TError extends Error> = (undefined extends TInput ? {
-    input?: MaybeRefDeep<TInput>;
+type QueryOptionsIn<TClientContext extends ClientContext, TInput, TOutput, TError extends Error, TInitialData extends TOutput | undefined> = (undefined extends TInput ? {
+    input?: MaybeRefOrGetter<TInput>;
 } : {
-    input: MaybeRefDeep<TInput>;
+    input: MaybeRefOrGetter<TInput>;
 }) & (Record<never, never> extends TClientContext ? {
-    context?: MaybeRefDeep<TClientContext>;
+    context?: MaybeRefOrGetter<TClientContext>;
 } : {
-    context: MaybeRefDeep<TClientContext>;
-}) & SetOptional<UseQueryOptions<TOutput, TError>, 'key' | 'query'>;
-type QueryOptions<TOutput, TError extends Error> = UseQueryOptions<TOutput, TError>;
+    context: MaybeRefOrGetter<TClientContext>;
+}) & SetOptional<QueryOptions<TOutput, TError, TInitialData>, 'key' | 'query'>;
+type QueryOptions<TOutput, TError extends Error, TInitialData extends TOutput | undefined> = UseQueryOptions<TOutput, TError, TInitialData>;
 type MutationOptionsIn<TClientContext extends ClientContext, TInput, TOutput, TError extends Error, TMutationContext extends Record<any, any>> = (Record<never, never> extends TClientContext ? {
-    context?: MaybeRefDeep<TClientContext>;
+    context?: MaybeRefOrGetter<TClientContext>;
 } : {
-    context: MaybeRefDeep<TClientContext>;
+    context: MaybeRefOrGetter<TClientContext>;
 }) & SetOptional<UseMutationOptions<TOutput, TInput, TError, TMutationContext>, 'mutation'>;
 type MutationOptions<TInput, TOutput, TError extends Error, TMutationContext extends Record<any, any>> = UseMutationOptions<TOutput, TInput, TError, TMutationContext>;
 
 interface ProcedureUtils<TClientContext extends ClientContext, TInput, TOutput, TError extends Error> {
     call: Client<TClientContext, TInput, TOutput, TError>;
-    queryOptions(...rest: MaybeOptionalOptions<QueryOptionsIn<TClientContext, TInput, TOutput, TError>>): QueryOptions<TOutput, TError>;
+    queryOptions<UInitialData extends TOutput | undefined = TOutput | undefined>(...rest: MaybeOptionalOptions<QueryOptionsIn<TClientContext, TInput, TOutput, TError, UInitialData>>): QueryOptions<TOutput, TError, UInitialData>;
     mutationOptions<UMutationContext extends Record<any, any> = _EmptyObject>(...rest: MaybeOptionalOptions<MutationOptionsIn<TClientContext, TInput, TOutput, TError, UMutationContext>>): MutationOptions<TInput, TOutput, TError, UMutationContext>;
 }
-declare function createProcedureUtils<TClientContext extends ClientContext, TInput, TOutput, TError extends Error>(client: Client<TClientContext, TInput, TOutput, TError>, path: string[]): ProcedureUtils<TClientContext, TInput, TOutput, TError>;
+interface CreateProcedureUtilsOptions {
+    path: string[];
+}
+declare function createProcedureUtils<TClientContext extends ClientContext, TInput, TOutput, TError extends Error>(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>;
-/**
- * @param client - Any kind of oRPC clients: `createRouterClient`, `createORPCClient`, ...
- * @param path - The base path for query key, when it it will be prefix to all keys
- */
-declare function createRouterUtils<T extends NestedClient<any>>(client: T, path?: string[]): RouterUtils<T>;
-
-declare const createORPCVueColadaUtils: typeof createRouterUtils;
+interface CreateRouterUtilsOptions {
+    path?: string[];
+}
+declare function createRouterUtils<T extends NestedClient<any>>(client: T, options?: CreateRouterUtilsOptions): RouterUtils<T>;
 
-export { type BuildKeyOptions, type GeneralUtils, type MaybeRefDeep, type MutationOptions, type MutationOptionsIn, type ProcedureUtils, type QueryOptions, type QueryOptionsIn, type RouterUtils, type UseQueryFnContext, buildKey, createGeneralUtils, createORPCVueColadaUtils, createProcedureUtils, createRouterUtils };
+export { type BuildKeyOptions, type CreateProcedureUtilsOptions, type CreateRouterUtilsOptions, type GeneralUtils, type MutationOptions, type MutationOptionsIn, type ProcedureUtils, type QueryOptions, type QueryOptionsIn, type RouterUtils, type UseQueryFnContext, buildKey, createGeneralUtils, createRouterUtils as createORPCVueColadaUtils, createProcedureUtils, createRouterUtils };

package/dist/index.d.ts

@@ -1,7 +1,7 @@
 import { ClientContext, Client, NestedClient } from '@orpc/client';
 import { EntryKey, UseQueryOptions, UseMutationOptions, _EmptyObject } from '@pinia/colada';
-import { AnyFunction, SetOptional, MaybeOptionalOptions } from '@orpc/shared';
-import { MaybeRef } from 'vue';
+import { SetOptional, MaybeOptionalOptions } from '@orpc/shared';
+import { MaybeRefOrGetter } from 'vue';
 
 interface BuildKeyOptions<TInput> {
     input?: TInput;
@@ -13,43 +13,40 @@ interface GeneralUtils<TInput> {
 }
 declare function createGeneralUtils<TInput>(path: string[]): GeneralUtils<TInput>;
 
-type MaybeRefDeep<T> = MaybeRef<T extends AnyFunction ? T : T extends object ? {
-    [K in keyof T]: MaybeRefDeep<T[K]>;
-} : T>;
 type UseQueryFnContext = Parameters<UseQueryOptions<any>['query']>[0];
-type QueryOptionsIn<TClientContext extends ClientContext, TInput, TOutput, TError extends Error> = (undefined extends TInput ? {
-    input?: MaybeRefDeep<TInput>;
+type QueryOptionsIn<TClientContext extends ClientContext, TInput, TOutput, TError extends Error, TInitialData extends TOutput | undefined> = (undefined extends TInput ? {
+    input?: MaybeRefOrGetter<TInput>;
 } : {
-    input: MaybeRefDeep<TInput>;
+    input: MaybeRefOrGetter<TInput>;
 }) & (Record<never, never> extends TClientContext ? {
-    context?: MaybeRefDeep<TClientContext>;
+    context?: MaybeRefOrGetter<TClientContext>;
 } : {
-    context: MaybeRefDeep<TClientContext>;
-}) & SetOptional<UseQueryOptions<TOutput, TError>, 'key' | 'query'>;
-type QueryOptions<TOutput, TError extends Error> = UseQueryOptions<TOutput, TError>;
+    context: MaybeRefOrGetter<TClientContext>;
+}) & SetOptional<QueryOptions<TOutput, TError, TInitialData>, 'key' | 'query'>;
+type QueryOptions<TOutput, TError extends Error, TInitialData extends TOutput | undefined> = UseQueryOptions<TOutput, TError, TInitialData>;
 type MutationOptionsIn<TClientContext extends ClientContext, TInput, TOutput, TError extends Error, TMutationContext extends Record<any, any>> = (Record<never, never> extends TClientContext ? {
-    context?: MaybeRefDeep<TClientContext>;
+    context?: MaybeRefOrGetter<TClientContext>;
 } : {
-    context: MaybeRefDeep<TClientContext>;
+    context: MaybeRefOrGetter<TClientContext>;
 }) & SetOptional<UseMutationOptions<TOutput, TInput, TError, TMutationContext>, 'mutation'>;
 type MutationOptions<TInput, TOutput, TError extends Error, TMutationContext extends Record<any, any>> = UseMutationOptions<TOutput, TInput, TError, TMutationContext>;
 
 interface ProcedureUtils<TClientContext extends ClientContext, TInput, TOutput, TError extends Error> {
     call: Client<TClientContext, TInput, TOutput, TError>;
-    queryOptions(...rest: MaybeOptionalOptions<QueryOptionsIn<TClientContext, TInput, TOutput, TError>>): QueryOptions<TOutput, TError>;
+    queryOptions<UInitialData extends TOutput | undefined = TOutput | undefined>(...rest: MaybeOptionalOptions<QueryOptionsIn<TClientContext, TInput, TOutput, TError, UInitialData>>): QueryOptions<TOutput, TError, UInitialData>;
     mutationOptions<UMutationContext extends Record<any, any> = _EmptyObject>(...rest: MaybeOptionalOptions<MutationOptionsIn<TClientContext, TInput, TOutput, TError, UMutationContext>>): MutationOptions<TInput, TOutput, TError, UMutationContext>;
 }
-declare function createProcedureUtils<TClientContext extends ClientContext, TInput, TOutput, TError extends Error>(client: Client<TClientContext, TInput, TOutput, TError>, path: string[]): ProcedureUtils<TClientContext, TInput, TOutput, TError>;
+interface CreateProcedureUtilsOptions {
+    path: string[];
+}
+declare function createProcedureUtils<TClientContext extends ClientContext, TInput, TOutput, TError extends Error>(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>;
-/**
- * @param client - Any kind of oRPC clients: `createRouterClient`, `createORPCClient`, ...
- * @param path - The base path for query key, when it it will be prefix to all keys
- */
-declare function createRouterUtils<T extends NestedClient<any>>(client: T, path?: string[]): RouterUtils<T>;
-
-declare const createORPCVueColadaUtils: typeof createRouterUtils;
+interface CreateRouterUtilsOptions {
+    path?: string[];
+}
+declare function createRouterUtils<T extends NestedClient<any>>(client: T, options?: CreateRouterUtilsOptions): RouterUtils<T>;
 
-export { type BuildKeyOptions, type GeneralUtils, type MaybeRefDeep, type MutationOptions, type MutationOptionsIn, type ProcedureUtils, type QueryOptions, type QueryOptionsIn, type RouterUtils, type UseQueryFnContext, buildKey, createGeneralUtils, createORPCVueColadaUtils, createProcedureUtils, createRouterUtils };
+export { type BuildKeyOptions, type CreateProcedureUtilsOptions, type CreateRouterUtilsOptions, type GeneralUtils, type MutationOptions, type MutationOptionsIn, type ProcedureUtils, type QueryOptions, type QueryOptionsIn, type RouterUtils, type UseQueryFnContext, buildKey, createGeneralUtils, createRouterUtils as createORPCVueColadaUtils, createProcedureUtils, createRouterUtils };

package/dist/index.mjs

@@ -1,12 +1,12 @@
-import { RPCJsonSerializer } from '@orpc/client/standard';
-import { stringifyJSON, isObject } from '@orpc/shared';
-import { isRef, computed } from 'vue';
+import { StandardRPCJsonSerializer } from '@orpc/client/standard';
+import { stringifyJSON } from '@orpc/shared';
+import { toValue, computed } from 'vue';
 
 function buildKey(path, options) {
   if (options?.input === void 0) {
     return path;
   }
-  const [json, meta] = new RPCJsonSerializer().serialize(options.input);
+  const [json, meta] = new StandardRPCJsonSerializer().serialize(options.input);
   return [
     ...path,
     { input: stringifyJSON({ json, meta }) }
@@ -21,45 +21,30 @@ function createGeneralUtils(path) {
   };
 }
 
-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, path) {
+function createProcedureUtils(client, options) {
   return {
     call: client,
     queryOptions(...[{ input, context, ...rest } = {}]) {
       return {
-        key: computed(() => buildKey(path, { input: unrefDeep(input) })),
-        query: ({ signal }) => client(unrefDeep(input), { signal, context: unrefDeep(context) }),
+        key: computed(() => buildKey(options.path, { input: toValue(input) })),
+        query: ({ signal }) => client(toValue(input), { signal, context: toValue(context) }),
         ...rest
       };
     },
     mutationOptions(...[{ context, ...rest } = {}]) {
       return {
-        key: (input) => buildKey(path, { input }),
-        mutation: (input) => client(input, { context: unrefDeep(context) }),
+        key: (input) => buildKey(options.path, { input }),
+        mutation: (input) => client(input, { context: toValue(context) }),
         ...rest
       };
     }
   };
 }
 
-function createRouterUtils(client, path = []) {
+function createRouterUtils(client, options = {}) {
+  const path = options.path ?? [];
   const generalUtils = createGeneralUtils(path);
-  const procedureUtils = createProcedureUtils(client, path);
+  const procedureUtils = createProcedureUtils(client, { path });
   const recursive = new Proxy({
     ...generalUtils,
     ...procedureUtils
@@ -69,7 +54,7 @@ function createRouterUtils(client, path = []) {
       if (typeof prop !== "string") {
         return value;
       }
-      const nextUtils = createRouterUtils(client[prop], [...path, prop]);
+      const nextUtils = createRouterUtils(client[prop], { ...options, path: [...path, prop] });
       if (typeof value !== "function") {
         return nextUtils;
       }
@@ -83,6 +68,4 @@ function createRouterUtils(client, path = []) {
   return recursive;
 }
 
-const createORPCVueColadaUtils = createRouterUtils;
-
-export { buildKey, createGeneralUtils, createORPCVueColadaUtils, createProcedureUtils, createRouterUtils };
+export { buildKey, createGeneralUtils, createRouterUtils as createORPCVueColadaUtils, createProcedureUtils, createRouterUtils };

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@orpc/vue-colada",
   "type": "module",
-  "version": "0.46.0",
+  "version": "0.48.0",
   "license": "MIT",
   "homepage": "https://orpc.unnoq.com",
   "repository": {
@@ -32,8 +32,8 @@
     "vue": ">=3.3.0"
   },
   "dependencies": {
-    "@orpc/client": "0.46.0",
-    "@orpc/shared": "0.46.0"
+    "@orpc/client": "0.48.0",
+    "@orpc/shared": "0.48.0"
   },
   "devDependencies": {
     "pinia": "^2.3.0"