@orpc/client 0.0.0-next.ca29a36 → 0.0.0-next.cac5dd3

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (49) hide show
  1. package/README.md +28 -18
  2. package/dist/adapters/fetch/index.d.mts +33 -0
  3. package/dist/adapters/fetch/index.d.ts +33 -0
  4. package/dist/adapters/fetch/index.mjs +29 -0
  5. package/dist/adapters/standard/index.d.mts +10 -0
  6. package/dist/adapters/standard/index.d.ts +10 -0
  7. package/dist/adapters/standard/index.mjs +4 -0
  8. package/dist/adapters/websocket/index.d.mts +29 -0
  9. package/dist/adapters/websocket/index.d.ts +29 -0
  10. package/dist/adapters/websocket/index.mjs +31 -0
  11. package/dist/index.d.mts +169 -0
  12. package/dist/index.d.ts +169 -0
  13. package/dist/index.mjs +65 -0
  14. package/dist/plugins/index.d.mts +162 -0
  15. package/dist/plugins/index.d.ts +162 -0
  16. package/dist/plugins/index.mjs +291 -0
  17. package/dist/shared/client.4TS_0JaO.d.mts +29 -0
  18. package/dist/shared/client.4TS_0JaO.d.ts +29 -0
  19. package/dist/shared/client.7ZYxJok_.d.ts +46 -0
  20. package/dist/shared/client.B2432-Lu.d.ts +91 -0
  21. package/dist/shared/client.CRWEpqLB.mjs +175 -0
  22. package/dist/shared/client.ClwIM_ku.d.mts +91 -0
  23. package/dist/shared/client.DpICn1BD.mjs +355 -0
  24. package/dist/shared/client.ds1abV85.d.mts +46 -0
  25. package/package.json +25 -24
  26. package/dist/chunk-7F3XVLRJ.js +0 -281
  27. package/dist/chunk-FF5VXXNP.js +0 -213
  28. package/dist/fetch.js +0 -127
  29. package/dist/index.js +0 -90
  30. package/dist/openapi.js +0 -232
  31. package/dist/rpc.js +0 -10
  32. package/dist/src/adapters/fetch/index.d.ts +0 -3
  33. package/dist/src/adapters/fetch/rpc-link.d.ts +0 -98
  34. package/dist/src/adapters/fetch/types.d.ts +0 -5
  35. package/dist/src/client.d.ts +0 -9
  36. package/dist/src/dynamic-link.d.ts +0 -12
  37. package/dist/src/error.d.ts +0 -106
  38. package/dist/src/event-iterator-state.d.ts +0 -9
  39. package/dist/src/event-iterator.d.ts +0 -12
  40. package/dist/src/index.d.ts +0 -9
  41. package/dist/src/openapi/bracket-notation.d.ts +0 -9
  42. package/dist/src/openapi/index.d.ts +0 -4
  43. package/dist/src/openapi/json-serializer.d.ts +0 -7
  44. package/dist/src/openapi/serializer.d.ts +0 -11
  45. package/dist/src/rpc/index.d.ts +0 -3
  46. package/dist/src/rpc/json-serializer.d.ts +0 -12
  47. package/dist/src/rpc/serializer.d.ts +0 -9
  48. package/dist/src/types.d.ts +0 -29
  49. package/dist/src/utils.d.ts +0 -17
package/README.md CHANGED
@@ -1,5 +1,5 @@
1
1
  <div align="center">
2
- <image align="center" src="https://orpc.unnoq.com/logo.webp" width=280 />
2
+ <image align="center" src="https://orpc.unnoq.com/logo.webp" width=280 alt="oRPC logo" />
3
3
  </div>
4
4
 
5
5
  <h1></h1>
@@ -21,28 +21,24 @@
21
21
 
22
22
  <h3 align="center">Typesafe APIs Made Simple 🪄</h3>
23
23
 
24
- **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.
24
+ **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
25
25
 
26
26
  ---
27
27
 
28
28
  ## Highlights
29
29
 
30
- - **End-to-End Type Safety 🔒**: Ensure complete type safety from inputs to outputs and errors, bridging server and client seamlessly.
31
- - **First-Class OpenAPI 📄**: Adheres to the OpenAPI standard out of the box, ensuring seamless integration and comprehensive API documentation.
32
- - **Contract-First Development 📜**: (Optional) Define your API contract upfront and implement it with confidence.
33
- - **Exceptional Developer Experience ✨**: Enjoy a streamlined workflow with robust typing and clear, in-code documentation.
34
- - **Multi-Runtime Support 🌍**: Run your code seamlessly on Cloudflare, Deno, Bun, Node.js, and more.
35
- - **Framework Integrations 🧩**: Supports Tanstack Query (React, Vue), Pinia Colada, and more.
36
- - **Server Actions ⚡️**: Fully compatible with React Server Actions on Next.js, TanStack Start, and more.
37
- - **Standard Schema Support 🗂️**: Effortlessly work with Zod, Valibot, ArkType, and others right out of the box.
38
- - **Fast & Lightweight 💨**: Built on native APIs across all runtimes – optimized for speed and efficiency.
39
- - **Native Types 📦**: Enjoy built-in support for Date, File, Blob, BigInt, URL and more with no extra setup.
40
- - **Lazy Router ⏱️**: Improve cold start times with our lazy routing feature.
41
- - **SSE & Streaming 📡**: Provides SSE and streaming features – perfect for real-time notifications and AI-powered streaming responses.
42
- - **Reusability 🔄**: Write once and reuse your code across multiple purposes effortlessly.
43
- - **Extendability 🔌**: Easily enhance oRPC with plugins, middleware, and interceptors.
44
- - **Reliability 🛡️**: Well-tested, fully TypeScript, production-ready, and MIT licensed for peace of mind.
45
- - **Simplicity 💡**: Enjoy straightforward, clean code with no hidden magic.
30
+ - **🔗 End-to-End Type Safety**: Ensure type-safe inputs, outputs, and errors from client to server.
31
+ - **📘 First-Class OpenAPI**: Built-in support that fully adheres to the OpenAPI standard.
32
+ - **📝 Contract-First Development**: Optionally define your API contract before implementation.
33
+ - **⚙️ Framework Integrations**: Seamlessly integrate with TanStack Query (React, Vue, Solid, Svelte), Pinia Colada, and more.
34
+ - **🚀 Server Actions**: Fully compatible with React Server Actions on Next.js, TanStack Start, and other platforms.
35
+ - **🔠 Standard Schema Support**: Works out of the box with Zod, Valibot, ArkType, and other schema validators.
36
+ - **🗃️ Native Types**: Supports native types like Date, File, Blob, BigInt, URL, and more.
37
+ - **⏱️ Lazy Router**: Enhance cold start times with our lazy routing feature.
38
+ - **📡 SSE & Streaming**: Enjoy full type-safe support for SSE and streaming.
39
+ - **🌍 Multi-Runtime Support**: Fast and lightweight on Cloudflare, Deno, Bun, Node.js, and beyond.
40
+ - **🔌 Extendability**: Easily extend functionality with plugins, middleware, and interceptors.
41
+ - **🛡️ Reliability**: Well-tested, TypeScript-based, production-ready, and MIT licensed.
46
42
 
47
43
  ## Documentation
48
44
 
@@ -53,11 +49,17 @@ You can find the full documentation [here](https://orpc.unnoq.com).
53
49
  - [@orpc/contract](https://www.npmjs.com/package/@orpc/contract): Build your API contract.
54
50
  - [@orpc/server](https://www.npmjs.com/package/@orpc/server): Build your API or implement API contract.
55
51
  - [@orpc/client](https://www.npmjs.com/package/@orpc/client): Consume your API on the client with type-safety.
52
+ - [@orpc/nest](https://www.npmjs.com/package/@orpc/nest): Deeply integrate oRPC with NestJS.
53
+ - [@orpc/react](https://www.npmjs.com/package/@orpc/react): Utilities for integrating oRPC with React and React Server Actions.
56
54
  - [@orpc/react-query](https://www.npmjs.com/package/@orpc/react-query): Integration with [React Query](https://tanstack.com/query/latest/docs/framework/react/overview).
57
55
  - [@orpc/vue-query](https://www.npmjs.com/package/@orpc/vue-query): Integration with [Vue Query](https://tanstack.com/query/latest/docs/framework/vue/overview).
56
+ - [@orpc/solid-query](https://www.npmjs.com/package/@orpc/solid-query): Integration with [Solid Query](https://tanstack.com/query/latest/docs/framework/solid/overview).
57
+ - [@orpc/svelte-query](https://www.npmjs.com/package/@orpc/svelte-query): Integration with [Svelte Query](https://tanstack.com/query/latest/docs/framework/svelte/overview).
58
58
  - [@orpc/vue-colada](https://www.npmjs.com/package/@orpc/vue-colada): Integration with [Pinia Colada](https://pinia-colada.esm.dev/).
59
59
  - [@orpc/openapi](https://www.npmjs.com/package/@orpc/openapi): Generate OpenAPI specs and handle OpenAPI requests.
60
60
  - [@orpc/zod](https://www.npmjs.com/package/@orpc/zod): More schemas that [Zod](https://zod.dev/) doesn't support yet.
61
+ - [@orpc/valibot](https://www.npmjs.com/package/@orpc/valibot): OpenAPI spec generation from [Valibot](https://valibot.dev/).
62
+ - [@orpc/arktype](https://www.npmjs.com/package/@orpc/arktype): OpenAPI spec generation from [ArkType](https://arktype.io/).
61
63
 
62
64
  ## `@orpc/client`
63
65
 
@@ -83,6 +85,14 @@ const client: RouterClient<typeof router> = createORPCClient(link)
83
85
  const client: ContractRouterClient<typeof contract> = createORPCClient(link)
84
86
  ```
85
87
 
88
+ ## Sponsors
89
+
90
+ <p align="center">
91
+ <a href="https://cdn.jsdelivr.net/gh/unnoq/unnoq/sponsors.svg">
92
+ <img src='https://cdn.jsdelivr.net/gh/unnoq/unnoq/sponsors.svg'/>
93
+ </a>
94
+ </p>
95
+
86
96
  ## License
87
97
 
88
98
  Distributed under the MIT License. See [LICENSE](https://github.com/unnoq/orpc/blob/main/LICENSE) for more information.
@@ -0,0 +1,33 @@
1
+ import { StandardRequest, StandardLazyResponse } from '@orpc/standard-server';
2
+ import { ToFetchRequestOptions } from '@orpc/standard-server-fetch';
3
+ import { a as ClientContext, b as ClientOptions } from '../../shared/client.4TS_0JaO.mjs';
4
+ import { f as StandardLinkClient } from '../../shared/client.ds1abV85.mjs';
5
+ import { f as StandardRPCLinkOptions, g as StandardRPCLink } from '../../shared/client.ClwIM_ku.mjs';
6
+ import '@orpc/shared';
7
+
8
+ interface LinkFetchClientOptions<T extends ClientContext> extends ToFetchRequestOptions {
9
+ fetch?: (request: Request, init: {
10
+ redirect?: Request['redirect'];
11
+ }, options: ClientOptions<T>, path: readonly string[], input: unknown) => Promise<Response>;
12
+ }
13
+ declare class LinkFetchClient<T extends ClientContext> implements StandardLinkClient<T> {
14
+ private readonly fetch;
15
+ private readonly toFetchRequestOptions;
16
+ constructor(options: LinkFetchClientOptions<T>);
17
+ call(request: StandardRequest, options: ClientOptions<T>, path: readonly string[], input: unknown): Promise<StandardLazyResponse>;
18
+ }
19
+
20
+ interface RPCLinkOptions<T extends ClientContext> extends StandardRPCLinkOptions<T>, LinkFetchClientOptions<T> {
21
+ }
22
+ /**
23
+ * The RPC Link communicates with the server using the RPC protocol.
24
+ *
25
+ * @see {@link https://orpc.unnoq.com/docs/client/rpc-link RPC Link Docs}
26
+ * @see {@link https://orpc.unnoq.com/docs/advanced/rpc-protocol RPC Protocol Docs}
27
+ */
28
+ declare class RPCLink<T extends ClientContext> extends StandardRPCLink<T> {
29
+ constructor(options: RPCLinkOptions<T>);
30
+ }
31
+
32
+ export { LinkFetchClient, RPCLink };
33
+ export type { LinkFetchClientOptions, RPCLinkOptions };
@@ -0,0 +1,33 @@
1
+ import { StandardRequest, StandardLazyResponse } from '@orpc/standard-server';
2
+ import { ToFetchRequestOptions } from '@orpc/standard-server-fetch';
3
+ import { a as ClientContext, b as ClientOptions } from '../../shared/client.4TS_0JaO.js';
4
+ import { f as StandardLinkClient } from '../../shared/client.7ZYxJok_.js';
5
+ import { f as StandardRPCLinkOptions, g as StandardRPCLink } from '../../shared/client.B2432-Lu.js';
6
+ import '@orpc/shared';
7
+
8
+ interface LinkFetchClientOptions<T extends ClientContext> extends ToFetchRequestOptions {
9
+ fetch?: (request: Request, init: {
10
+ redirect?: Request['redirect'];
11
+ }, options: ClientOptions<T>, path: readonly string[], input: unknown) => Promise<Response>;
12
+ }
13
+ declare class LinkFetchClient<T extends ClientContext> implements StandardLinkClient<T> {
14
+ private readonly fetch;
15
+ private readonly toFetchRequestOptions;
16
+ constructor(options: LinkFetchClientOptions<T>);
17
+ call(request: StandardRequest, options: ClientOptions<T>, path: readonly string[], input: unknown): Promise<StandardLazyResponse>;
18
+ }
19
+
20
+ interface RPCLinkOptions<T extends ClientContext> extends StandardRPCLinkOptions<T>, LinkFetchClientOptions<T> {
21
+ }
22
+ /**
23
+ * The RPC Link communicates with the server using the RPC protocol.
24
+ *
25
+ * @see {@link https://orpc.unnoq.com/docs/client/rpc-link RPC Link Docs}
26
+ * @see {@link https://orpc.unnoq.com/docs/advanced/rpc-protocol RPC Protocol Docs}
27
+ */
28
+ declare class RPCLink<T extends ClientContext> extends StandardRPCLink<T> {
29
+ constructor(options: RPCLinkOptions<T>);
30
+ }
31
+
32
+ export { LinkFetchClient, RPCLink };
33
+ export type { LinkFetchClientOptions, RPCLinkOptions };
@@ -0,0 +1,29 @@
1
+ import { toFetchRequest, toStandardLazyResponse } from '@orpc/standard-server-fetch';
2
+ import '@orpc/shared';
3
+ import { c as StandardRPCLink } from '../../shared/client.DpICn1BD.mjs';
4
+ import '@orpc/standard-server';
5
+ import '../../shared/client.CRWEpqLB.mjs';
6
+
7
+ class LinkFetchClient {
8
+ fetch;
9
+ toFetchRequestOptions;
10
+ constructor(options) {
11
+ this.fetch = options?.fetch ?? globalThis.fetch.bind(globalThis);
12
+ this.toFetchRequestOptions = options;
13
+ }
14
+ async call(request, options, path, input) {
15
+ const fetchRequest = toFetchRequest(request, this.toFetchRequestOptions);
16
+ const fetchResponse = await this.fetch(fetchRequest, { redirect: "manual" }, options, path, input);
17
+ const lazyResponse = toStandardLazyResponse(fetchResponse);
18
+ return lazyResponse;
19
+ }
20
+ }
21
+
22
+ class RPCLink extends StandardRPCLink {
23
+ constructor(options) {
24
+ const linkClient = new LinkFetchClient(options);
25
+ super(linkClient, options);
26
+ }
27
+ }
28
+
29
+ export { LinkFetchClient, RPCLink };
@@ -0,0 +1,10 @@
1
+ export { C as CompositeStandardLinkPlugin, d as StandardLink, f as StandardLinkClient, S as StandardLinkClientInterceptorOptions, e as StandardLinkCodec, c as StandardLinkInterceptorOptions, b as StandardLinkOptions, a as StandardLinkPlugin } from '../../shared/client.ds1abV85.mjs';
2
+ export { S as STANDARD_RPC_JSON_SERIALIZER_BUILT_IN_TYPES, c as StandardRPCCustomJsonSerializer, b as StandardRPCJsonSerialized, a as StandardRPCJsonSerializedMetaItem, e as StandardRPCJsonSerializer, d as StandardRPCJsonSerializerOptions, g as StandardRPCLink, i as StandardRPCLinkCodec, h as StandardRPCLinkCodecOptions, f as StandardRPCLinkOptions, j as StandardRPCSerializer } from '../../shared/client.ClwIM_ku.mjs';
3
+ import { H as HTTPPath } from '../../shared/client.4TS_0JaO.mjs';
4
+ import '@orpc/shared';
5
+ import '@orpc/standard-server';
6
+
7
+ declare function toHttpPath(path: readonly string[]): HTTPPath;
8
+ declare function getMalformedResponseErrorCode(status: number): string;
9
+
10
+ export { getMalformedResponseErrorCode, toHttpPath };
@@ -0,0 +1,10 @@
1
+ export { C as CompositeStandardLinkPlugin, d as StandardLink, f as StandardLinkClient, S as StandardLinkClientInterceptorOptions, e as StandardLinkCodec, c as StandardLinkInterceptorOptions, b as StandardLinkOptions, a as StandardLinkPlugin } from '../../shared/client.7ZYxJok_.js';
2
+ export { S as STANDARD_RPC_JSON_SERIALIZER_BUILT_IN_TYPES, c as StandardRPCCustomJsonSerializer, b as StandardRPCJsonSerialized, a as StandardRPCJsonSerializedMetaItem, e as StandardRPCJsonSerializer, d as StandardRPCJsonSerializerOptions, g as StandardRPCLink, i as StandardRPCLinkCodec, h as StandardRPCLinkCodecOptions, f as StandardRPCLinkOptions, j as StandardRPCSerializer } from '../../shared/client.B2432-Lu.js';
3
+ import { H as HTTPPath } from '../../shared/client.4TS_0JaO.js';
4
+ import '@orpc/shared';
5
+ import '@orpc/standard-server';
6
+
7
+ declare function toHttpPath(path: readonly string[]): HTTPPath;
8
+ declare function getMalformedResponseErrorCode(status: number): string;
9
+
10
+ export { getMalformedResponseErrorCode, toHttpPath };
@@ -0,0 +1,4 @@
1
+ export { C as CompositeStandardLinkPlugin, a as STANDARD_RPC_JSON_SERIALIZER_BUILT_IN_TYPES, S as StandardLink, b as StandardRPCJsonSerializer, c as StandardRPCLink, d as StandardRPCLinkCodec, e as StandardRPCSerializer, g as getMalformedResponseErrorCode, t as toHttpPath } from '../../shared/client.DpICn1BD.mjs';
2
+ import '@orpc/shared';
3
+ import '@orpc/standard-server';
4
+ import '../../shared/client.CRWEpqLB.mjs';
@@ -0,0 +1,29 @@
1
+ import { StandardRequest, StandardLazyResponse } from '@orpc/standard-server';
2
+ import { a as ClientContext, b as ClientOptions } from '../../shared/client.4TS_0JaO.mjs';
3
+ import { f as StandardLinkClient } from '../../shared/client.ds1abV85.mjs';
4
+ import { f as StandardRPCLinkOptions, g as StandardRPCLink } from '../../shared/client.ClwIM_ku.mjs';
5
+ import '@orpc/shared';
6
+
7
+ interface experimental_LinkWebsocketClientOptions {
8
+ websocket: Pick<WebSocket, 'addEventListener' | 'send'>;
9
+ }
10
+ declare class experimental_LinkWebsocketClient<T extends ClientContext> implements StandardLinkClient<T> {
11
+ private readonly peer;
12
+ constructor(options: experimental_LinkWebsocketClientOptions);
13
+ call(request: StandardRequest, _options: ClientOptions<T>, _path: readonly string[], _input: unknown): Promise<StandardLazyResponse>;
14
+ }
15
+
16
+ interface experimental_RPCLinkOptions<T extends ClientContext> extends Omit<StandardRPCLinkOptions<T>, 'url' | 'headers' | 'method' | 'fallbackMethod' | 'maxUrlLength'>, experimental_LinkWebsocketClientOptions {
17
+ }
18
+ /**
19
+ * The RPC Link communicates with the server using the RPC protocol over WebSocket.
20
+ *
21
+ * @see {@link https://orpc.unnoq.com/docs/client/rpc-link RPC Link Docs}
22
+ * @see {@link https://orpc.unnoq.com/docs/adapters/websocket WebSocket Adapter Docs}
23
+ */
24
+ declare class experimental_RPCLink<T extends ClientContext> extends StandardRPCLink<T> {
25
+ constructor(options: experimental_RPCLinkOptions<T>);
26
+ }
27
+
28
+ export { experimental_LinkWebsocketClient, experimental_RPCLink };
29
+ export type { experimental_LinkWebsocketClientOptions, experimental_RPCLinkOptions };
@@ -0,0 +1,29 @@
1
+ import { StandardRequest, StandardLazyResponse } from '@orpc/standard-server';
2
+ import { a as ClientContext, b as ClientOptions } from '../../shared/client.4TS_0JaO.js';
3
+ import { f as StandardLinkClient } from '../../shared/client.7ZYxJok_.js';
4
+ import { f as StandardRPCLinkOptions, g as StandardRPCLink } from '../../shared/client.B2432-Lu.js';
5
+ import '@orpc/shared';
6
+
7
+ interface experimental_LinkWebsocketClientOptions {
8
+ websocket: Pick<WebSocket, 'addEventListener' | 'send'>;
9
+ }
10
+ declare class experimental_LinkWebsocketClient<T extends ClientContext> implements StandardLinkClient<T> {
11
+ private readonly peer;
12
+ constructor(options: experimental_LinkWebsocketClientOptions);
13
+ call(request: StandardRequest, _options: ClientOptions<T>, _path: readonly string[], _input: unknown): Promise<StandardLazyResponse>;
14
+ }
15
+
16
+ interface experimental_RPCLinkOptions<T extends ClientContext> extends Omit<StandardRPCLinkOptions<T>, 'url' | 'headers' | 'method' | 'fallbackMethod' | 'maxUrlLength'>, experimental_LinkWebsocketClientOptions {
17
+ }
18
+ /**
19
+ * The RPC Link communicates with the server using the RPC protocol over WebSocket.
20
+ *
21
+ * @see {@link https://orpc.unnoq.com/docs/client/rpc-link RPC Link Docs}
22
+ * @see {@link https://orpc.unnoq.com/docs/adapters/websocket WebSocket Adapter Docs}
23
+ */
24
+ declare class experimental_RPCLink<T extends ClientContext> extends StandardRPCLink<T> {
25
+ constructor(options: experimental_RPCLinkOptions<T>);
26
+ }
27
+
28
+ export { experimental_LinkWebsocketClient, experimental_RPCLink };
29
+ export type { experimental_LinkWebsocketClientOptions, experimental_RPCLinkOptions };
@@ -0,0 +1,31 @@
1
+ import { ClientPeer } from '@orpc/standard-server-peer';
2
+ import '@orpc/shared';
3
+ import { c as StandardRPCLink } from '../../shared/client.DpICn1BD.mjs';
4
+ import '@orpc/standard-server';
5
+ import '../../shared/client.CRWEpqLB.mjs';
6
+
7
+ class experimental_LinkWebsocketClient {
8
+ peer;
9
+ constructor(options) {
10
+ this.peer = new ClientPeer(options.websocket.send.bind(options.websocket));
11
+ options.websocket.addEventListener("message", (event) => {
12
+ this.peer.message(event.data);
13
+ });
14
+ options.websocket.addEventListener("close", () => {
15
+ this.peer.close();
16
+ });
17
+ }
18
+ async call(request, _options, _path, _input) {
19
+ const response = await this.peer.request(request);
20
+ return { ...response, body: () => Promise.resolve(response.body) };
21
+ }
22
+ }
23
+
24
+ class experimental_RPCLink extends StandardRPCLink {
25
+ constructor(options) {
26
+ const linkClient = new experimental_LinkWebsocketClient(options);
27
+ super(linkClient, { ...options, url: "orpc:/" });
28
+ }
29
+ }
30
+
31
+ export { experimental_LinkWebsocketClient, experimental_RPCLink };
@@ -0,0 +1,169 @@
1
+ import { N as NestedClient, C as ClientLink, I as InferClientContext, a as ClientContext, b as ClientOptions, c as ClientPromiseResult, F as FriendlyClientOptions } from './shared/client.4TS_0JaO.mjs';
2
+ export { f as Client, e as ClientRest, d as HTTPMethod, H as HTTPPath } from './shared/client.4TS_0JaO.mjs';
3
+ import { Promisable, MaybeOptionalOptions, ThrowableError } from '@orpc/shared';
4
+ export { Registry, ThrowableError, onError, onFinish, onStart, onSuccess } from '@orpc/shared';
5
+ export { ErrorEvent } from '@orpc/standard-server';
6
+
7
+ interface createORPCClientOptions {
8
+ /**
9
+ * Use as base path for all procedure, useful when you only want to call a subset of the procedure.
10
+ */
11
+ path?: string[];
12
+ }
13
+ /**
14
+ * Create a oRPC client-side client from a link.
15
+ *
16
+ * @see {@link https://orpc.unnoq.com/docs/client/client-side Client-side Client Docs}
17
+ */
18
+ declare function createORPCClient<T extends NestedClient<any>>(link: ClientLink<InferClientContext<T>>, options?: createORPCClientOptions): T;
19
+
20
+ /**
21
+ * DynamicLink provides a way to dynamically resolve and delegate calls to other ClientLinks
22
+ * based on the request path, input, and context.
23
+ *
24
+ * @see {@link https://orpc.unnoq.com/docs/client/dynamic-link Dynamic Link Docs}
25
+ */
26
+ declare class DynamicLink<TClientContext extends ClientContext> implements ClientLink<TClientContext> {
27
+ private readonly linkResolver;
28
+ constructor(linkResolver: (options: ClientOptions<TClientContext>, path: readonly string[], input: unknown) => Promisable<ClientLink<TClientContext>>);
29
+ call(path: readonly string[], input: unknown, options: ClientOptions<TClientContext>): Promise<unknown>;
30
+ }
31
+
32
+ declare const COMMON_ORPC_ERROR_DEFS: {
33
+ readonly BAD_REQUEST: {
34
+ readonly status: 400;
35
+ readonly message: "Bad Request";
36
+ };
37
+ readonly UNAUTHORIZED: {
38
+ readonly status: 401;
39
+ readonly message: "Unauthorized";
40
+ };
41
+ readonly FORBIDDEN: {
42
+ readonly status: 403;
43
+ readonly message: "Forbidden";
44
+ };
45
+ readonly NOT_FOUND: {
46
+ readonly status: 404;
47
+ readonly message: "Not Found";
48
+ };
49
+ readonly METHOD_NOT_SUPPORTED: {
50
+ readonly status: 405;
51
+ readonly message: "Method Not Supported";
52
+ };
53
+ readonly NOT_ACCEPTABLE: {
54
+ readonly status: 406;
55
+ readonly message: "Not Acceptable";
56
+ };
57
+ readonly TIMEOUT: {
58
+ readonly status: 408;
59
+ readonly message: "Request Timeout";
60
+ };
61
+ readonly CONFLICT: {
62
+ readonly status: 409;
63
+ readonly message: "Conflict";
64
+ };
65
+ readonly PRECONDITION_FAILED: {
66
+ readonly status: 412;
67
+ readonly message: "Precondition Failed";
68
+ };
69
+ readonly PAYLOAD_TOO_LARGE: {
70
+ readonly status: 413;
71
+ readonly message: "Payload Too Large";
72
+ };
73
+ readonly UNSUPPORTED_MEDIA_TYPE: {
74
+ readonly status: 415;
75
+ readonly message: "Unsupported Media Type";
76
+ };
77
+ readonly UNPROCESSABLE_CONTENT: {
78
+ readonly status: 422;
79
+ readonly message: "Unprocessable Content";
80
+ };
81
+ readonly TOO_MANY_REQUESTS: {
82
+ readonly status: 429;
83
+ readonly message: "Too Many Requests";
84
+ };
85
+ readonly CLIENT_CLOSED_REQUEST: {
86
+ readonly status: 499;
87
+ readonly message: "Client Closed Request";
88
+ };
89
+ readonly INTERNAL_SERVER_ERROR: {
90
+ readonly status: 500;
91
+ readonly message: "Internal Server Error";
92
+ };
93
+ readonly NOT_IMPLEMENTED: {
94
+ readonly status: 501;
95
+ readonly message: "Not Implemented";
96
+ };
97
+ readonly BAD_GATEWAY: {
98
+ readonly status: 502;
99
+ readonly message: "Bad Gateway";
100
+ };
101
+ readonly SERVICE_UNAVAILABLE: {
102
+ readonly status: 503;
103
+ readonly message: "Service Unavailable";
104
+ };
105
+ readonly GATEWAY_TIMEOUT: {
106
+ readonly status: 504;
107
+ readonly message: "Gateway Timeout";
108
+ };
109
+ };
110
+ type CommonORPCErrorCode = keyof typeof COMMON_ORPC_ERROR_DEFS;
111
+ type ORPCErrorCode = CommonORPCErrorCode | (string & {});
112
+ declare function fallbackORPCErrorStatus(code: ORPCErrorCode, status: number | undefined): number;
113
+ declare function fallbackORPCErrorMessage(code: ORPCErrorCode, message: string | undefined): string;
114
+ type ORPCErrorOptions<TData> = ErrorOptions & {
115
+ defined?: boolean;
116
+ status?: number;
117
+ message?: string;
118
+ } & (undefined extends TData ? {
119
+ data?: TData;
120
+ } : {
121
+ data: TData;
122
+ });
123
+ declare class ORPCError<TCode extends ORPCErrorCode, TData> extends Error {
124
+ readonly defined: boolean;
125
+ readonly code: TCode;
126
+ readonly status: number;
127
+ readonly data: TData;
128
+ constructor(code: TCode, ...[options]: MaybeOptionalOptions<ORPCErrorOptions<TData>>);
129
+ toJSON(): ORPCErrorJSON<TCode, TData>;
130
+ }
131
+ type ORPCErrorJSON<TCode extends string, TData> = Pick<ORPCError<TCode, TData>, 'defined' | 'code' | 'status' | 'message' | 'data'>;
132
+ declare function isDefinedError<T>(error: T): error is Extract<T, ORPCError<any, any>>;
133
+ declare function toORPCError(error: unknown): ORPCError<any, any>;
134
+ declare function isORPCErrorStatus(status: number): boolean;
135
+ declare function isORPCErrorJson(json: unknown): json is ORPCErrorJSON<ORPCErrorCode, unknown>;
136
+ declare function createORPCErrorFromJson<TCode extends ORPCErrorCode, TData>(json: ORPCErrorJSON<TCode, TData>, options?: ErrorOptions): ORPCError<TCode, TData>;
137
+
138
+ declare function mapEventIterator<TYield, TReturn, TNext, TMap = TYield | TReturn>(iterator: AsyncIterator<TYield, TReturn, TNext>, maps: {
139
+ value: (value: NoInfer<TYield | TReturn>, done: boolean | undefined) => Promise<TMap>;
140
+ error: (error: unknown) => Promise<unknown>;
141
+ }): AsyncGenerator<TMap, TMap, TNext>;
142
+
143
+ type SafeResult<TOutput, TError> = [error: null, data: TOutput, isDefined: false, isSuccess: true] & {
144
+ error: null;
145
+ data: TOutput;
146
+ isDefined: false;
147
+ isSuccess: true;
148
+ } | [error: Exclude<TError, ORPCError<any, any>>, data: undefined, isDefined: false, isSuccess: false] & {
149
+ error: Exclude<TError, ORPCError<any, any>>;
150
+ data: undefined;
151
+ isDefined: false;
152
+ isSuccess: false;
153
+ } | [error: Extract<TError, ORPCError<any, any>>, data: undefined, isDefined: true, isSuccess: false] & {
154
+ error: Extract<TError, ORPCError<any, any>>;
155
+ data: undefined;
156
+ isDefined: true;
157
+ isSuccess: false;
158
+ };
159
+ /**
160
+ * Works like try/catch, but can infer error types.
161
+ *
162
+ * @info support both tuple `[error, data, isDefined, isSuccess]` and object `{ error, data, isDefined, isSuccess }` styles.
163
+ * @see {@link https://orpc.unnoq.com/docs/client/error-handling Client Error Handling Docs}
164
+ */
165
+ declare function safe<TOutput, TError = ThrowableError>(promise: ClientPromiseResult<TOutput, TError>): Promise<SafeResult<TOutput, TError>>;
166
+ declare function resolveFriendlyClientOptions<T extends ClientContext>(options: FriendlyClientOptions<T>): ClientOptions<T>;
167
+
168
+ export { COMMON_ORPC_ERROR_DEFS, ClientContext, ClientLink, ClientOptions, ClientPromiseResult, DynamicLink, FriendlyClientOptions, InferClientContext, NestedClient, ORPCError, createORPCClient, createORPCErrorFromJson, fallbackORPCErrorMessage, fallbackORPCErrorStatus, isDefinedError, isORPCErrorJson, isORPCErrorStatus, mapEventIterator, resolveFriendlyClientOptions, safe, toORPCError };
169
+ export type { CommonORPCErrorCode, ORPCErrorCode, ORPCErrorJSON, ORPCErrorOptions, SafeResult, createORPCClientOptions };
@@ -0,0 +1,169 @@
1
+ import { N as NestedClient, C as ClientLink, I as InferClientContext, a as ClientContext, b as ClientOptions, c as ClientPromiseResult, F as FriendlyClientOptions } from './shared/client.4TS_0JaO.js';
2
+ export { f as Client, e as ClientRest, d as HTTPMethod, H as HTTPPath } from './shared/client.4TS_0JaO.js';
3
+ import { Promisable, MaybeOptionalOptions, ThrowableError } from '@orpc/shared';
4
+ export { Registry, ThrowableError, onError, onFinish, onStart, onSuccess } from '@orpc/shared';
5
+ export { ErrorEvent } from '@orpc/standard-server';
6
+
7
+ interface createORPCClientOptions {
8
+ /**
9
+ * Use as base path for all procedure, useful when you only want to call a subset of the procedure.
10
+ */
11
+ path?: string[];
12
+ }
13
+ /**
14
+ * Create a oRPC client-side client from a link.
15
+ *
16
+ * @see {@link https://orpc.unnoq.com/docs/client/client-side Client-side Client Docs}
17
+ */
18
+ declare function createORPCClient<T extends NestedClient<any>>(link: ClientLink<InferClientContext<T>>, options?: createORPCClientOptions): T;
19
+
20
+ /**
21
+ * DynamicLink provides a way to dynamically resolve and delegate calls to other ClientLinks
22
+ * based on the request path, input, and context.
23
+ *
24
+ * @see {@link https://orpc.unnoq.com/docs/client/dynamic-link Dynamic Link Docs}
25
+ */
26
+ declare class DynamicLink<TClientContext extends ClientContext> implements ClientLink<TClientContext> {
27
+ private readonly linkResolver;
28
+ constructor(linkResolver: (options: ClientOptions<TClientContext>, path: readonly string[], input: unknown) => Promisable<ClientLink<TClientContext>>);
29
+ call(path: readonly string[], input: unknown, options: ClientOptions<TClientContext>): Promise<unknown>;
30
+ }
31
+
32
+ declare const COMMON_ORPC_ERROR_DEFS: {
33
+ readonly BAD_REQUEST: {
34
+ readonly status: 400;
35
+ readonly message: "Bad Request";
36
+ };
37
+ readonly UNAUTHORIZED: {
38
+ readonly status: 401;
39
+ readonly message: "Unauthorized";
40
+ };
41
+ readonly FORBIDDEN: {
42
+ readonly status: 403;
43
+ readonly message: "Forbidden";
44
+ };
45
+ readonly NOT_FOUND: {
46
+ readonly status: 404;
47
+ readonly message: "Not Found";
48
+ };
49
+ readonly METHOD_NOT_SUPPORTED: {
50
+ readonly status: 405;
51
+ readonly message: "Method Not Supported";
52
+ };
53
+ readonly NOT_ACCEPTABLE: {
54
+ readonly status: 406;
55
+ readonly message: "Not Acceptable";
56
+ };
57
+ readonly TIMEOUT: {
58
+ readonly status: 408;
59
+ readonly message: "Request Timeout";
60
+ };
61
+ readonly CONFLICT: {
62
+ readonly status: 409;
63
+ readonly message: "Conflict";
64
+ };
65
+ readonly PRECONDITION_FAILED: {
66
+ readonly status: 412;
67
+ readonly message: "Precondition Failed";
68
+ };
69
+ readonly PAYLOAD_TOO_LARGE: {
70
+ readonly status: 413;
71
+ readonly message: "Payload Too Large";
72
+ };
73
+ readonly UNSUPPORTED_MEDIA_TYPE: {
74
+ readonly status: 415;
75
+ readonly message: "Unsupported Media Type";
76
+ };
77
+ readonly UNPROCESSABLE_CONTENT: {
78
+ readonly status: 422;
79
+ readonly message: "Unprocessable Content";
80
+ };
81
+ readonly TOO_MANY_REQUESTS: {
82
+ readonly status: 429;
83
+ readonly message: "Too Many Requests";
84
+ };
85
+ readonly CLIENT_CLOSED_REQUEST: {
86
+ readonly status: 499;
87
+ readonly message: "Client Closed Request";
88
+ };
89
+ readonly INTERNAL_SERVER_ERROR: {
90
+ readonly status: 500;
91
+ readonly message: "Internal Server Error";
92
+ };
93
+ readonly NOT_IMPLEMENTED: {
94
+ readonly status: 501;
95
+ readonly message: "Not Implemented";
96
+ };
97
+ readonly BAD_GATEWAY: {
98
+ readonly status: 502;
99
+ readonly message: "Bad Gateway";
100
+ };
101
+ readonly SERVICE_UNAVAILABLE: {
102
+ readonly status: 503;
103
+ readonly message: "Service Unavailable";
104
+ };
105
+ readonly GATEWAY_TIMEOUT: {
106
+ readonly status: 504;
107
+ readonly message: "Gateway Timeout";
108
+ };
109
+ };
110
+ type CommonORPCErrorCode = keyof typeof COMMON_ORPC_ERROR_DEFS;
111
+ type ORPCErrorCode = CommonORPCErrorCode | (string & {});
112
+ declare function fallbackORPCErrorStatus(code: ORPCErrorCode, status: number | undefined): number;
113
+ declare function fallbackORPCErrorMessage(code: ORPCErrorCode, message: string | undefined): string;
114
+ type ORPCErrorOptions<TData> = ErrorOptions & {
115
+ defined?: boolean;
116
+ status?: number;
117
+ message?: string;
118
+ } & (undefined extends TData ? {
119
+ data?: TData;
120
+ } : {
121
+ data: TData;
122
+ });
123
+ declare class ORPCError<TCode extends ORPCErrorCode, TData> extends Error {
124
+ readonly defined: boolean;
125
+ readonly code: TCode;
126
+ readonly status: number;
127
+ readonly data: TData;
128
+ constructor(code: TCode, ...[options]: MaybeOptionalOptions<ORPCErrorOptions<TData>>);
129
+ toJSON(): ORPCErrorJSON<TCode, TData>;
130
+ }
131
+ type ORPCErrorJSON<TCode extends string, TData> = Pick<ORPCError<TCode, TData>, 'defined' | 'code' | 'status' | 'message' | 'data'>;
132
+ declare function isDefinedError<T>(error: T): error is Extract<T, ORPCError<any, any>>;
133
+ declare function toORPCError(error: unknown): ORPCError<any, any>;
134
+ declare function isORPCErrorStatus(status: number): boolean;
135
+ declare function isORPCErrorJson(json: unknown): json is ORPCErrorJSON<ORPCErrorCode, unknown>;
136
+ declare function createORPCErrorFromJson<TCode extends ORPCErrorCode, TData>(json: ORPCErrorJSON<TCode, TData>, options?: ErrorOptions): ORPCError<TCode, TData>;
137
+
138
+ declare function mapEventIterator<TYield, TReturn, TNext, TMap = TYield | TReturn>(iterator: AsyncIterator<TYield, TReturn, TNext>, maps: {
139
+ value: (value: NoInfer<TYield | TReturn>, done: boolean | undefined) => Promise<TMap>;
140
+ error: (error: unknown) => Promise<unknown>;
141
+ }): AsyncGenerator<TMap, TMap, TNext>;
142
+
143
+ type SafeResult<TOutput, TError> = [error: null, data: TOutput, isDefined: false, isSuccess: true] & {
144
+ error: null;
145
+ data: TOutput;
146
+ isDefined: false;
147
+ isSuccess: true;
148
+ } | [error: Exclude<TError, ORPCError<any, any>>, data: undefined, isDefined: false, isSuccess: false] & {
149
+ error: Exclude<TError, ORPCError<any, any>>;
150
+ data: undefined;
151
+ isDefined: false;
152
+ isSuccess: false;
153
+ } | [error: Extract<TError, ORPCError<any, any>>, data: undefined, isDefined: true, isSuccess: false] & {
154
+ error: Extract<TError, ORPCError<any, any>>;
155
+ data: undefined;
156
+ isDefined: true;
157
+ isSuccess: false;
158
+ };
159
+ /**
160
+ * Works like try/catch, but can infer error types.
161
+ *
162
+ * @info support both tuple `[error, data, isDefined, isSuccess]` and object `{ error, data, isDefined, isSuccess }` styles.
163
+ * @see {@link https://orpc.unnoq.com/docs/client/error-handling Client Error Handling Docs}
164
+ */
165
+ declare function safe<TOutput, TError = ThrowableError>(promise: ClientPromiseResult<TOutput, TError>): Promise<SafeResult<TOutput, TError>>;
166
+ declare function resolveFriendlyClientOptions<T extends ClientContext>(options: FriendlyClientOptions<T>): ClientOptions<T>;
167
+
168
+ export { COMMON_ORPC_ERROR_DEFS, ClientContext, ClientLink, ClientOptions, ClientPromiseResult, DynamicLink, FriendlyClientOptions, InferClientContext, NestedClient, ORPCError, createORPCClient, createORPCErrorFromJson, fallbackORPCErrorMessage, fallbackORPCErrorStatus, isDefinedError, isORPCErrorJson, isORPCErrorStatus, mapEventIterator, resolveFriendlyClientOptions, safe, toORPCError };
169
+ export type { CommonORPCErrorCode, ORPCErrorCode, ORPCErrorJSON, ORPCErrorOptions, SafeResult, createORPCClientOptions };