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

package/README.md

@@ -0,0 +1,97 @@
+<div align="center">
+  <image align="center" src="https://orpc.unnoq.com/logo.webp" width=280 />
+</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-colada">
+    <img alt="weekly downloads" src="https://img.shields.io/npm/dw/%40orpc%2Fvue-colada?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), 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-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/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/vue-colada`
+
+Integration with [Pinia Colada](https://pinia-colada.esm.dev/). Read the [documentation](https://orpc.unnoq.com/docs/pinia-colada) 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 mutation = useMutation(orpc.planet.create.mutationOptions({
+    context: { cache: true }, // Provide client context if needed
+  // additional options...
+  }))
+
+  mutation.mutate({ name: 'Earth' })
+
+  const queryCache = useQueryCache()
+
+  // Invalidate all planet queries
+  queryCache.invalidateQueries({
+    key: orpc.planet.key(),
+  })
+
+  // Invalidate the planet find query with id 123
+  queryCache.invalidateQueries({
+    key: orpc.planet.find.key({ input: { id: 123 } })
+  })
+}
+```
+
+## License
+
+Distributed under the MIT License. See [LICENSE](https://github.com/unnoq/orpc/blob/main/LICENSE) for more information.

package/dist/index.js

@@ -1,63 +1,69 @@
 // src/key.ts
-import { SuperJSON } from "@orpc/server/fetch";
+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 [
-    "__ORPC__",
     ...path,
-    ...options?.input !== void 0 ? [{ input: JSON.stringify(SuperJSON.serialize(options.input)) }] : []
+    { 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 deepUnref(value) {
+function unrefDeep(value) {
   if (isRef(value)) {
-    return deepUnref(value.value);
+    return unrefDeep(value.value);
   }
   if (Array.isArray(value)) {
-    return value.map(deepUnref);
+    return value.map(unrefDeep);
   }
-  if (value && typeof value === "object") {
+  if (isObject(value)) {
     return Object.keys(value).reduce((acc, key) => {
-      acc[key] = deepUnref(value[key]);
+      acc[key] = unrefDeep(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";
+// src/procedure-utils.ts
 function createProcedureUtils(client, path) {
   return {
-    queryOptions(...[options]) {
-      const input = options?.input;
+    call: client,
+    queryOptions(...[{ input, context, ...rest } = {}]) {
       return {
-        key: computed(() => buildKey(path, { input: deepUnref(input) })),
-        query: ({ signal }) => client(deepUnref(input), { signal, context: deepUnref(options?.context) }),
-        ...options
+        key: computed(() => buildKey(path, { input: unrefDeep(input) })),
+        query: ({ signal }) => client(unrefDeep(input), { signal, context: unrefDeep(context) }),
+        ...rest
       };
     },
-    mutationOptions(...[options]) {
+    mutationOptions(...[{ context, ...rest } = {}]) {
       return {
         key: (input) => buildKey(path, { input }),
-        mutation: (input, _) => client(input, { context: deepUnref(options?.context) }),
-        ...options
+        mutation: (input) => client(input, { context: unrefDeep(context) }),
+        ...rest
       };
     }
   };
 }
 
-// src/utils-router.ts
+// src/router-utils.ts
 function createRouterUtils(client, path = []) {
   const generalUtils = createGeneralUtils(path);
   const procedureUtils = createProcedureUtils(client, path);

package/dist/src/{utils-general.d.ts → general-utils.d.ts}

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

package/dist/src/index.d.ts

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

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

@@ -0,0 +1,10 @@
+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

@@ -0,0 +1,12 @@
+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 +1,25 @@
+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 MaybeDeepRef<T> = MaybeRef<T extends AnyFunction ? T : T extends object ? {
-    [K in keyof T]: MaybeDeepRef<T[K]>;
+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 InferCursor<T> = T extends {
-    cursor?: any;
-} ? T['cursor'] : never;
-export type QueryOptions<TInput, TOutput, TClientContext> = (undefined extends TInput ? {
-    input?: MaybeDeepRef<TInput>;
+export type QueryOptionsIn<TClientContext extends ClientContext, TInput, TOutput, TError extends Error> = (undefined extends TInput ? {
+    input?: MaybeRefDeep<TInput>;
 } : {
-    input: MaybeDeepRef<TInput>;
-}) & (undefined extends TClientContext ? {
-    context?: MaybeDeepRef<TClientContext>;
+    input: MaybeRefDeep<TInput>;
+}) & (Record<never, never> extends TClientContext ? {
+    context?: MaybeRefDeep<TClientContext>;
 } : {
-    context: MaybeDeepRef<TClientContext>;
-}) & SetOptional<UseQueryOptions<TOutput>, 'key' | 'query'>;
-export type MutationOptions<TInput, TOutput, TClientContext> = (undefined extends TClientContext ? {
-    context?: MaybeDeepRef<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: MaybeDeepRef<TClientContext>;
-}) & SetOptional<UseMutationOptions<TOutput, TInput>, 'mutation'>;
+    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 +1,7 @@
-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]>;
+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 deepUnref<T>(value: T): DeepUnref<T>;
+export declare function unrefDeep<T>(value: T): UnrefDeep<T>;
 //# sourceMappingURL=utils.d.ts.map

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@orpc/vue-colada",
   "type": "module",
-  "version": "0.0.0-next.e7d7758",
+  "version": "0.0.0-next.f17a1a0",
   "license": "MIT",
   "homepage": "https://orpc.unnoq.com",
   "repository": {
@@ -33,18 +33,14 @@
     "dist"
   ],
   "peerDependencies": {
-    "@pinia/colada": ">=0.13.1",
-    "vue": ">=3.3.0",
-    "@orpc/client": "0.0.0-next.e7d7758",
-    "@orpc/contract": "0.0.0-next.e7d7758",
-    "@orpc/server": "0.0.0-next.e7d7758"
+    "@pinia/colada": ">=0.13.5",
+    "vue": ">=3.3.0"
   },
   "dependencies": {
-    "@orpc/server": "0.0.0-next.e7d7758"
+    "@orpc/shared": "0.0.0-next.f17a1a0",
+    "@orpc/client": "0.0.0-next.f17a1a0"
   },
   "devDependencies": {
-    "@pinia/colada": "^0.13.1",
-    "@vue/test-utils": "^2.4.6",
     "pinia": "^2.3.0"
   },
   "scripts": {

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

@@ -1,26 +0,0 @@
-import type { ProcedureClient } from '@orpc/server';
-import type { IsEqual } from '@orpc/shared';
-import type { EntryKey } from '@pinia/colada';
-import type { ComputedRef } from 'vue';
-import type { MutationOptions, QueryOptions, UseQueryFnContext } from './types';
-/**
- * Utils at procedure level
- */
-export interface ProcedureUtils<TInput, TOutput, TClientContext> {
-    queryOptions: <U extends QueryOptions<TInput, TOutput, TClientContext>>(...opt: [options: U] | (undefined extends TInput & TClientContext ? [] : never)) => IsEqual<U, QueryOptions<TInput, TOutput, TClientContext>> extends true ? {
-        key: ComputedRef<EntryKey>;
-        query: (ctx: UseQueryFnContext) => Promise<TOutput>;
-    } : Omit<{
-        key: ComputedRef<EntryKey>;
-        query: (ctx: UseQueryFnContext) => Promise<TOutput>;
-    }, keyof U> & U;
-    mutationOptions: <U extends MutationOptions<TInput, TOutput, TClientContext>>(...opt: [options: U] | (undefined extends TClientContext ? [] : never)) => IsEqual<U, MutationOptions<TInput, TOutput, TClientContext>> extends true ? {
-        key: (input: TInput) => EntryKey;
-        mutation: (input: TInput) => Promise<TOutput>;
-    } : Omit<{
-        key: (input: TInput) => EntryKey;
-        mutation: (input: TInput) => Promise<TOutput>;
-    }, keyof U> & U;
-}
-export declare function createProcedureUtils<TInput, TOutput, TClientContext>(client: ProcedureClient<TInput, TOutput, TClientContext>, path: string[]): ProcedureUtils<TInput, TOutput, TClientContext>;
-//# sourceMappingURL=utils-procedure.d.ts.map

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

@@ -1,12 +0,0 @@
-import type { ProcedureClient, RouterClient } from '@orpc/server';
-import { type GeneralUtils } from './utils-general';
-import { type ProcedureUtils } from './utils-procedure';
-export type RouterUtils<T extends RouterClient<any, any>> = T extends ProcedureClient<infer TInput, infer TOutput, infer TClientContext> ? ProcedureUtils<TInput, TOutput, TClientContext> & GeneralUtils<TInput> : {
-    [K in keyof T]: T[K] extends RouterClient<any, 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 RouterClient<any, any>>(client: T, path?: string[]): RouterUtils<T>;
-//# sourceMappingURL=utils-router.d.ts.map