@orpc/vue-colada 0.0.0-next.f17a1a0 → 0.0.0-next.f47352c

package/README.md

@@ -1,5 +1,5 @@
 <div align="center">
-  <image align="center" src="https://orpc.unnoq.com/logo.webp" width=280 />
+  <image align="center" src="https://orpc.unnoq.com/logo.webp" width=280 alt="oRPC logo" />
 </div>
 
 <h1></h1>
@@ -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.
@@ -53,11 +53,16 @@ You can find the full documentation [here](https://orpc.unnoq.com).
 - [@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-colada`
 
@@ -92,6 +97,14 @@ export function Setup() {
 }
 ```
 
+## 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,52 @@
+import { ClientContext, Client, NestedClient } from '@orpc/client';
+import { EntryKey, UseQueryOptions, UseMutationOptions, _EmptyObject } from '@pinia/colada';
+import { SetOptional, MaybeOptionalOptions } from '@orpc/shared';
+import { MaybeRefOrGetter } from 'vue';
+
+interface BuildKeyOptions<TInput> {
+    input?: TInput;
+}
+declare function buildKey<TInput>(path: string[], options?: BuildKeyOptions<TInput>): EntryKey;
+
+interface GeneralUtils<TInput> {
+    key(options?: BuildKeyOptions<TInput>): EntryKey;
+}
+declare function createGeneralUtils<TInput>(path: string[]): GeneralUtils<TInput>;
+
+type UseQueryFnContext = Parameters<UseQueryOptions<any>['query']>[0];
+type QueryOptionsIn<TClientContext extends ClientContext, TInput, TOutput, TError, TInitialData extends TOutput | undefined> = (undefined extends TInput ? {
+    input?: MaybeRefOrGetter<TInput>;
+} : {
+    input: MaybeRefOrGetter<TInput>;
+}) & (Record<never, never> extends TClientContext ? {
+    context?: MaybeRefOrGetter<TClientContext>;
+} : {
+    context: MaybeRefOrGetter<TClientContext>;
+}) & SetOptional<QueryOptions<TOutput, TError, TInitialData>, 'key' | 'query'>;
+type QueryOptions<TOutput, TError, TInitialData extends TOutput | undefined> = UseQueryOptions<TOutput, TError, TInitialData>;
+type MutationOptionsIn<TClientContext extends ClientContext, TInput, TOutput, TError, TMutationContext extends Record<any, any>> = (Record<never, never> extends TClientContext ? {
+    context?: MaybeRefOrGetter<TClientContext>;
+} : {
+    context: MaybeRefOrGetter<TClientContext>;
+}) & SetOptional<UseMutationOptions<TOutput, TInput, TError, TMutationContext>, 'mutation'>;
+type MutationOptions<TInput, TOutput, TError, TMutationContext extends Record<any, any>> = UseMutationOptions<TOutput, TInput, TError, TMutationContext>;
+
+interface ProcedureUtils<TClientContext extends ClientContext, TInput, TOutput, TError> {
+    call: Client<TClientContext, TInput, 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>;
+}
+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>;
+
+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

@@ -0,0 +1,52 @@
+import { ClientContext, Client, NestedClient } from '@orpc/client';
+import { EntryKey, UseQueryOptions, UseMutationOptions, _EmptyObject } from '@pinia/colada';
+import { SetOptional, MaybeOptionalOptions } from '@orpc/shared';
+import { MaybeRefOrGetter } from 'vue';
+
+interface BuildKeyOptions<TInput> {
+    input?: TInput;
+}
+declare function buildKey<TInput>(path: string[], options?: BuildKeyOptions<TInput>): EntryKey;
+
+interface GeneralUtils<TInput> {
+    key(options?: BuildKeyOptions<TInput>): EntryKey;
+}
+declare function createGeneralUtils<TInput>(path: string[]): GeneralUtils<TInput>;
+
+type UseQueryFnContext = Parameters<UseQueryOptions<any>['query']>[0];
+type QueryOptionsIn<TClientContext extends ClientContext, TInput, TOutput, TError, TInitialData extends TOutput | undefined> = (undefined extends TInput ? {
+    input?: MaybeRefOrGetter<TInput>;
+} : {
+    input: MaybeRefOrGetter<TInput>;
+}) & (Record<never, never> extends TClientContext ? {
+    context?: MaybeRefOrGetter<TClientContext>;
+} : {
+    context: MaybeRefOrGetter<TClientContext>;
+}) & SetOptional<QueryOptions<TOutput, TError, TInitialData>, 'key' | 'query'>;
+type QueryOptions<TOutput, TError, TInitialData extends TOutput | undefined> = UseQueryOptions<TOutput, TError, TInitialData>;
+type MutationOptionsIn<TClientContext extends ClientContext, TInput, TOutput, TError, TMutationContext extends Record<any, any>> = (Record<never, never> extends TClientContext ? {
+    context?: MaybeRefOrGetter<TClientContext>;
+} : {
+    context: MaybeRefOrGetter<TClientContext>;
+}) & SetOptional<UseMutationOptions<TOutput, TInput, TError, TMutationContext>, 'mutation'>;
+type MutationOptions<TInput, TOutput, TError, TMutationContext extends Record<any, any>> = UseMutationOptions<TOutput, TInput, TError, TMutationContext>;
+
+interface ProcedureUtils<TClientContext extends ClientContext, TInput, TOutput, TError> {
+    call: Client<TClientContext, TInput, 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>;
+}
+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>;
+
+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

@@ -0,0 +1,71 @@
+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 StandardRPCJsonSerializer().serialize(options.input);
+  return [
+    ...path,
+    { input: stringifyJSON({ json, meta }) }
+  ];
+}
+
+function createGeneralUtils(path) {
+  return {
+    key(options) {
+      return buildKey(path, options);
+    }
+  };
+}
+
+function createProcedureUtils(client, options) {
+  return {
+    call: client,
+    queryOptions(...[{ input, context, ...rest } = {}]) {
+      return {
+        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(options.path, { input }),
+        mutation: (input) => client(input, { context: toValue(context) }),
+        ...rest
+      };
+    }
+  };
+}
+
+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 createORPCVueColadaUtils, createProcedureUtils, createRouterUtils };

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@orpc/vue-colada",
   "type": "module",
-  "version": "0.0.0-next.f17a1a0",
+  "version": "0.0.0-next.f47352c",
   "license": "MIT",
   "homepage": "https://orpc.unnoq.com",
   "repository": {
@@ -19,17 +19,12 @@
   ],
   "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": {
@@ -37,14 +32,14 @@
     "vue": ">=3.3.0"
   },
   "dependencies": {
-    "@orpc/shared": "0.0.0-next.f17a1a0",
-    "@orpc/client": "0.0.0-next.f17a1a0"
+    "@orpc/client": "0.0.0-next.f47352c",
+    "@orpc/shared": "0.0.0-next.f47352c"
   },
   "devDependencies": {
     "pinia": "^2.3.0"
   },
   "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,102 +0,0 @@
-// src/key.ts
-import { RPCJsonSerializer } from "@orpc/client/rpc";
-function buildKey(path, options) {
-  if (options?.input === void 0) {
-    return path;
-  }
-  const [json, meta] = new RPCJsonSerializer().serialize(options.input);
-  return [
-    ...path,
-    { input: JSON.stringify({ json, meta }) }
-  ];
-}
-
-// src/general-utils.ts
-function createGeneralUtils(path) {
-  return {
-    key(options) {
-      return buildKey(path, options);
-    }
-  };
-}
-
-// src/procedure-utils.ts
-import { computed } from "vue";
-
-// src/utils.ts
-import { isObject } from "@orpc/shared";
-import { isRef } from "vue";
-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;
-}
-
-// src/procedure-utils.ts
-function createProcedureUtils(client, path) {
-  return {
-    call: client,
-    queryOptions(...[{ input, context, ...rest } = {}]) {
-      return {
-        key: computed(() => buildKey(path, { input: unrefDeep(input) })),
-        query: ({ signal }) => client(unrefDeep(input), { signal, context: unrefDeep(context) }),
-        ...rest
-      };
-    },
-    mutationOptions(...[{ context, ...rest } = {}]) {
-      return {
-        key: (input) => buildKey(path, { input }),
-        mutation: (input) => client(input, { context: unrefDeep(context) }),
-        ...rest
-      };
-    }
-  };
-}
-
-// src/router-utils.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 createORPCVueColadaUtils = createRouterUtils;
-export {
-  buildKey,
-  createGeneralUtils,
-  createORPCVueColadaUtils,
-  createProcedureUtils,
-  createRouterUtils
-};
-//# sourceMappingURL=index.js.map

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

@@ -1,7 +0,0 @@
-import type { EntryKey } from '@pinia/colada';
-import type { BuildKeyOptions } from './key';
-export interface GeneralUtils<TInput> {
-    key(options?: BuildKeyOptions<TInput>): EntryKey;
-}
-export declare function createGeneralUtils<TInput>(path: string[]): GeneralUtils<TInput>;
-//# sourceMappingURL=general-utils.d.ts.map

package/dist/src/index.d.ts

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

package/dist/src/key.d.ts

@@ -1,6 +0,0 @@
-import type { EntryKey } from '@pinia/colada';
-export interface BuildKeyOptions<TInput> {
-    input?: TInput;
-}
-export declare function buildKey<TInput>(path: string[], options?: BuildKeyOptions<TInput>): EntryKey;
-//# sourceMappingURL=key.d.ts.map

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

@@ -1,10 +0,0 @@
-import type { Client, ClientContext } from '@orpc/client';
-import type { MaybeOptionalOptions } from '@orpc/shared';
-import type { MutationOptions, MutationOptionsIn, QueryOptions, QueryOptionsIn } from './types';
-export 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>;
-    mutationOptions(...rest: MaybeOptionalOptions<MutationOptionsIn<TClientContext, TInput, TOutput, TError>>): MutationOptions<TInput, TOutput, TError>;
-}
-export declare function createProcedureUtils<TClientContext extends ClientContext, TInput, TOutput, TError extends Error>(client: Client<TClientContext, TInput, TOutput, TError>, path: string[]): ProcedureUtils<TClientContext, TInput, TOutput, TError>;
-//# sourceMappingURL=procedure-utils.d.ts.map

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

@@ -1,12 +0,0 @@
-import type { Client, NestedClient } from '@orpc/client';
-import { type GeneralUtils } from './general-utils';
-import { type ProcedureUtils } from './procedure-utils';
-export 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
- */
-export declare function createRouterUtils<T extends NestedClient<any>>(client: T, path?: string[]): RouterUtils<T>;
-//# sourceMappingURL=router-utils.d.ts.map

package/dist/src/types.d.ts

@@ -1,25 +0,0 @@
-import type { ClientContext } from '@orpc/client';
-import type { AnyFunction, SetOptional } from '@orpc/shared';
-import type { UseMutationOptions, UseQueryOptions } from '@pinia/colada';
-import type { MaybeRef } from 'vue';
-export type MaybeRefDeep<T> = MaybeRef<T extends AnyFunction ? T : T extends object ? {
-    [K in keyof T]: MaybeRefDeep<T[K]>;
-} : T>;
-export type UseQueryFnContext = Parameters<UseQueryOptions<any>['query']>[0];
-export type QueryOptionsIn<TClientContext extends ClientContext, TInput, TOutput, TError extends Error> = (undefined extends TInput ? {
-    input?: MaybeRefDeep<TInput>;
-} : {
-    input: MaybeRefDeep<TInput>;
-}) & (Record<never, never> extends TClientContext ? {
-    context?: MaybeRefDeep<TClientContext>;
-} : {
-    context: MaybeRefDeep<TClientContext>;
-}) & SetOptional<UseQueryOptions<TOutput, TError>, 'key' | 'query'>;
-export type QueryOptions<TOutput, TError extends Error> = UseQueryOptions<TOutput, TError>;
-export type MutationOptionsIn<TClientContext extends ClientContext, TInput, TOutput, TError extends Error> = (Record<never, never> extends TClientContext ? {
-    context?: MaybeRefDeep<TClientContext>;
-} : {
-    context: MaybeRefDeep<TClientContext>;
-}) & SetOptional<UseMutationOptions<TOutput, TInput, TError>, 'mutation'>;
-export type MutationOptions<TInput, TOutput, TError extends Error> = UseMutationOptions<TOutput, TInput, TError>;
-//# sourceMappingURL=types.d.ts.map

package/dist/src/utils.d.ts

@@ -1,7 +0,0 @@
-import type { Ref } from 'vue';
-import { type AnyFunction } from '@orpc/shared';
-export 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;
-export declare function unrefDeep<T>(value: T): UnrefDeep<T>;
-//# sourceMappingURL=utils.d.ts.map