@orpc/client 0.0.0-next.df486d6 → 0.0.0-next.e000d9a
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.
- package/README.md +14 -17
- package/dist/adapters/fetch/index.d.mts +9 -3
- package/dist/adapters/fetch/index.d.ts +9 -3
- package/dist/adapters/standard/index.d.mts +3 -3
- package/dist/adapters/standard/index.d.ts +3 -3
- package/dist/adapters/websocket/index.d.mts +29 -0
- package/dist/adapters/websocket/index.d.ts +29 -0
- package/dist/adapters/websocket/index.mjs +31 -0
- package/dist/index.d.mts +15 -2
- package/dist/index.d.ts +15 -2
- package/dist/plugins/index.d.mts +21 -3
- package/dist/plugins/index.d.ts +21 -3
- package/dist/shared/{client.CipPQkhk.d.ts → client.4TS_0JaO.d.mts} +1 -1
- package/dist/shared/{client.CipPQkhk.d.mts → client.4TS_0JaO.d.ts} +1 -1
- package/dist/shared/{client.C9U9n1f3.d.ts → client.7ZYxJok_.d.ts} +1 -1
- package/dist/shared/{client.8TjrVhkC.d.ts → client.B2432-Lu.d.ts} +4 -4
- package/dist/shared/{client.BjJBZryq.d.mts → client.ClwIM_ku.d.mts} +4 -4
- package/dist/shared/{client.FXep-a3a.d.mts → client.ds1abV85.d.mts} +1 -1
- package/package.json +11 -5
package/README.md
CHANGED
@@ -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
|
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
|
-
-
|
31
|
-
-
|
32
|
-
-
|
33
|
-
-
|
34
|
-
-
|
35
|
-
-
|
36
|
-
-
|
37
|
-
-
|
38
|
-
-
|
39
|
-
-
|
40
|
-
-
|
41
|
-
-
|
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,6 +49,7 @@ 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.
|
56
53
|
- [@orpc/react](https://www.npmjs.com/package/@orpc/react): Utilities for integrating oRPC with React and React Server Actions.
|
57
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).
|
58
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).
|
@@ -1,8 +1,8 @@
|
|
1
1
|
import { StandardRequest, StandardLazyResponse } from '@orpc/standard-server';
|
2
2
|
import { ToFetchRequestOptions } from '@orpc/standard-server-fetch';
|
3
|
-
import { a as ClientContext, b as ClientOptions } from '../../shared/client.
|
4
|
-
import { f as StandardLinkClient } from '../../shared/client.
|
5
|
-
import { f as StandardRPCLinkOptions, g as StandardRPCLink } from '../../shared/client.
|
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
6
|
import '@orpc/shared';
|
7
7
|
|
8
8
|
interface LinkFetchClientOptions<T extends ClientContext> extends ToFetchRequestOptions {
|
@@ -19,6 +19,12 @@ declare class LinkFetchClient<T extends ClientContext> implements StandardLinkCl
|
|
19
19
|
|
20
20
|
interface RPCLinkOptions<T extends ClientContext> extends StandardRPCLinkOptions<T>, LinkFetchClientOptions<T> {
|
21
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
|
+
*/
|
22
28
|
declare class RPCLink<T extends ClientContext> extends StandardRPCLink<T> {
|
23
29
|
constructor(options: RPCLinkOptions<T>);
|
24
30
|
}
|
@@ -1,8 +1,8 @@
|
|
1
1
|
import { StandardRequest, StandardLazyResponse } from '@orpc/standard-server';
|
2
2
|
import { ToFetchRequestOptions } from '@orpc/standard-server-fetch';
|
3
|
-
import { a as ClientContext, b as ClientOptions } from '../../shared/client.
|
4
|
-
import { f as StandardLinkClient } from '../../shared/client.
|
5
|
-
import { f as StandardRPCLinkOptions, g as StandardRPCLink } from '../../shared/client.
|
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
6
|
import '@orpc/shared';
|
7
7
|
|
8
8
|
interface LinkFetchClientOptions<T extends ClientContext> extends ToFetchRequestOptions {
|
@@ -19,6 +19,12 @@ declare class LinkFetchClient<T extends ClientContext> implements StandardLinkCl
|
|
19
19
|
|
20
20
|
interface RPCLinkOptions<T extends ClientContext> extends StandardRPCLinkOptions<T>, LinkFetchClientOptions<T> {
|
21
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
|
+
*/
|
22
28
|
declare class RPCLink<T extends ClientContext> extends StandardRPCLink<T> {
|
23
29
|
constructor(options: RPCLinkOptions<T>);
|
24
30
|
}
|
@@ -1,6 +1,6 @@
|
|
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.
|
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.
|
3
|
-
import { H as HTTPPath } from '../../shared/client.
|
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
4
|
import '@orpc/shared';
|
5
5
|
import '@orpc/standard-server';
|
6
6
|
|
@@ -1,6 +1,6 @@
|
|
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.
|
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.
|
3
|
-
import { H as HTTPPath } from '../../shared/client.
|
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
4
|
import '@orpc/shared';
|
5
5
|
import '@orpc/standard-server';
|
6
6
|
|
@@ -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 };
|
package/dist/index.d.mts
CHANGED
@@ -1,5 +1,5 @@
|
|
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.
|
2
|
-
export { f as Client, e as ClientRest, d as HTTPMethod, H as HTTPPath } from './shared/client.
|
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
3
|
import { Promisable, MaybeOptionalOptions, ThrowableError } from '@orpc/shared';
|
4
4
|
export { Registry, ThrowableError, onError, onFinish, onStart, onSuccess } from '@orpc/shared';
|
5
5
|
export { ErrorEvent } from '@orpc/standard-server';
|
@@ -10,11 +10,18 @@ interface createORPCClientOptions {
|
|
10
10
|
*/
|
11
11
|
path?: string[];
|
12
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
|
+
*/
|
13
18
|
declare function createORPCClient<T extends NestedClient<any>>(link: ClientLink<InferClientContext<T>>, options?: createORPCClientOptions): T;
|
14
19
|
|
15
20
|
/**
|
16
21
|
* DynamicLink provides a way to dynamically resolve and delegate calls to other ClientLinks
|
17
22
|
* based on the request path, input, and context.
|
23
|
+
*
|
24
|
+
* @see {@link https://orpc.unnoq.com/docs/client/dynamic-link Dynamic Link Docs}
|
18
25
|
*/
|
19
26
|
declare class DynamicLink<TClientContext extends ClientContext> implements ClientLink<TClientContext> {
|
20
27
|
private readonly linkResolver;
|
@@ -149,6 +156,12 @@ type SafeResult<TOutput, TError> = [error: null, data: TOutput, isDefined: false
|
|
149
156
|
isDefined: true;
|
150
157
|
isSuccess: false;
|
151
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
|
+
*/
|
152
165
|
declare function safe<TOutput, TError = ThrowableError>(promise: ClientPromiseResult<TOutput, TError>): Promise<SafeResult<TOutput, TError>>;
|
153
166
|
declare function resolveFriendlyClientOptions<T extends ClientContext>(options: FriendlyClientOptions<T>): ClientOptions<T>;
|
154
167
|
|
package/dist/index.d.ts
CHANGED
@@ -1,5 +1,5 @@
|
|
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.
|
2
|
-
export { f as Client, e as ClientRest, d as HTTPMethod, H as HTTPPath } from './shared/client.
|
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
3
|
import { Promisable, MaybeOptionalOptions, ThrowableError } from '@orpc/shared';
|
4
4
|
export { Registry, ThrowableError, onError, onFinish, onStart, onSuccess } from '@orpc/shared';
|
5
5
|
export { ErrorEvent } from '@orpc/standard-server';
|
@@ -10,11 +10,18 @@ interface createORPCClientOptions {
|
|
10
10
|
*/
|
11
11
|
path?: string[];
|
12
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
|
+
*/
|
13
18
|
declare function createORPCClient<T extends NestedClient<any>>(link: ClientLink<InferClientContext<T>>, options?: createORPCClientOptions): T;
|
14
19
|
|
15
20
|
/**
|
16
21
|
* DynamicLink provides a way to dynamically resolve and delegate calls to other ClientLinks
|
17
22
|
* based on the request path, input, and context.
|
23
|
+
*
|
24
|
+
* @see {@link https://orpc.unnoq.com/docs/client/dynamic-link Dynamic Link Docs}
|
18
25
|
*/
|
19
26
|
declare class DynamicLink<TClientContext extends ClientContext> implements ClientLink<TClientContext> {
|
20
27
|
private readonly linkResolver;
|
@@ -149,6 +156,12 @@ type SafeResult<TOutput, TError> = [error: null, data: TOutput, isDefined: false
|
|
149
156
|
isDefined: true;
|
150
157
|
isSuccess: false;
|
151
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
|
+
*/
|
152
165
|
declare function safe<TOutput, TError = ThrowableError>(promise: ClientPromiseResult<TOutput, TError>): Promise<SafeResult<TOutput, TError>>;
|
153
166
|
declare function resolveFriendlyClientOptions<T extends ClientContext>(options: FriendlyClientOptions<T>): ClientOptions<T>;
|
154
167
|
|
package/dist/plugins/index.d.mts
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
import { Value } from '@orpc/shared';
|
2
2
|
import { StandardHeaders, StandardRequest } from '@orpc/standard-server';
|
3
|
-
import { S as StandardLinkClientInterceptorOptions, a as StandardLinkPlugin, b as StandardLinkOptions, c as StandardLinkInterceptorOptions } from '../shared/client.
|
4
|
-
import { a as ClientContext } from '../shared/client.
|
3
|
+
import { S as StandardLinkClientInterceptorOptions, a as StandardLinkPlugin, b as StandardLinkOptions, c as StandardLinkInterceptorOptions } from '../shared/client.ds1abV85.mjs';
|
4
|
+
import { a as ClientContext } from '../shared/client.4TS_0JaO.mjs';
|
5
5
|
|
6
6
|
interface BatchLinkPluginGroup<T extends ClientContext> {
|
7
7
|
condition(options: StandardLinkClientInterceptorOptions<T>): boolean;
|
@@ -51,6 +51,12 @@ interface BatchLinkPluginOptions<T extends ClientContext> {
|
|
51
51
|
*/
|
52
52
|
exclude?: (options: StandardLinkClientInterceptorOptions<T>) => boolean;
|
53
53
|
}
|
54
|
+
/**
|
55
|
+
* The Batch Request/Response Plugin allows you to combine multiple requests and responses into a single batch,
|
56
|
+
* reducing the overhead of sending each one separately.
|
57
|
+
*
|
58
|
+
* @see {@link https://orpc.unnoq.com/docs/plugins/batch-request-response Batch Request/Response Plugin Docs}
|
59
|
+
*/
|
54
60
|
declare class BatchLinkPlugin<T extends ClientContext> implements StandardLinkPlugin<T> {
|
55
61
|
#private;
|
56
62
|
private readonly groups;
|
@@ -62,7 +68,7 @@ declare class BatchLinkPlugin<T extends ClientContext> implements StandardLinkPl
|
|
62
68
|
private readonly exclude;
|
63
69
|
private pending;
|
64
70
|
order: number;
|
65
|
-
constructor(options: BatchLinkPluginOptions<T
|
71
|
+
constructor(options: NoInfer<BatchLinkPluginOptions<T>>);
|
66
72
|
init(options: StandardLinkOptions<T>): void;
|
67
73
|
}
|
68
74
|
|
@@ -101,6 +107,11 @@ declare class ClientRetryPluginInvalidEventIteratorRetryResponse extends Error {
|
|
101
107
|
interface ClientRetryPluginOptions {
|
102
108
|
default?: ClientRetryPluginContext;
|
103
109
|
}
|
110
|
+
/**
|
111
|
+
* The Client Retry Plugin enables retrying client calls when errors occur.
|
112
|
+
*
|
113
|
+
* @see {@link https://orpc.unnoq.com/docs/plugins/client-retry Client Retry Plugin Docs}
|
114
|
+
*/
|
104
115
|
declare class ClientRetryPlugin<T extends ClientRetryPluginContext> implements StandardLinkPlugin<T> {
|
105
116
|
private readonly defaultRetry;
|
106
117
|
private readonly defaultRetryDelay;
|
@@ -131,6 +142,13 @@ interface SimpleCsrfProtectionLinkPluginOptions<T extends ClientContext> {
|
|
131
142
|
*/
|
132
143
|
exclude?: Value<boolean, [options: StandardLinkClientInterceptorOptions<T>]>;
|
133
144
|
}
|
145
|
+
/**
|
146
|
+
* This plugin adds basic Cross-Site Request Forgery (CSRF) protection to your oRPC application.
|
147
|
+
* It helps ensure that requests to your procedures originate from JavaScript code,
|
148
|
+
* not from other sources like standard HTML forms or direct browser navigation.
|
149
|
+
*
|
150
|
+
* @see {@link https://orpc.unnoq.com/docs/plugins/simple-csrf-protection Simple CSRF Protection Plugin Docs}
|
151
|
+
*/
|
134
152
|
declare class SimpleCsrfProtectionLinkPlugin<T extends ClientContext> implements StandardLinkPlugin<T> {
|
135
153
|
private readonly headerName;
|
136
154
|
private readonly headerValue;
|
package/dist/plugins/index.d.ts
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
import { Value } from '@orpc/shared';
|
2
2
|
import { StandardHeaders, StandardRequest } from '@orpc/standard-server';
|
3
|
-
import { S as StandardLinkClientInterceptorOptions, a as StandardLinkPlugin, b as StandardLinkOptions, c as StandardLinkInterceptorOptions } from '../shared/client.
|
4
|
-
import { a as ClientContext } from '../shared/client.
|
3
|
+
import { S as StandardLinkClientInterceptorOptions, a as StandardLinkPlugin, b as StandardLinkOptions, c as StandardLinkInterceptorOptions } from '../shared/client.7ZYxJok_.js';
|
4
|
+
import { a as ClientContext } from '../shared/client.4TS_0JaO.js';
|
5
5
|
|
6
6
|
interface BatchLinkPluginGroup<T extends ClientContext> {
|
7
7
|
condition(options: StandardLinkClientInterceptorOptions<T>): boolean;
|
@@ -51,6 +51,12 @@ interface BatchLinkPluginOptions<T extends ClientContext> {
|
|
51
51
|
*/
|
52
52
|
exclude?: (options: StandardLinkClientInterceptorOptions<T>) => boolean;
|
53
53
|
}
|
54
|
+
/**
|
55
|
+
* The Batch Request/Response Plugin allows you to combine multiple requests and responses into a single batch,
|
56
|
+
* reducing the overhead of sending each one separately.
|
57
|
+
*
|
58
|
+
* @see {@link https://orpc.unnoq.com/docs/plugins/batch-request-response Batch Request/Response Plugin Docs}
|
59
|
+
*/
|
54
60
|
declare class BatchLinkPlugin<T extends ClientContext> implements StandardLinkPlugin<T> {
|
55
61
|
#private;
|
56
62
|
private readonly groups;
|
@@ -62,7 +68,7 @@ declare class BatchLinkPlugin<T extends ClientContext> implements StandardLinkPl
|
|
62
68
|
private readonly exclude;
|
63
69
|
private pending;
|
64
70
|
order: number;
|
65
|
-
constructor(options: BatchLinkPluginOptions<T
|
71
|
+
constructor(options: NoInfer<BatchLinkPluginOptions<T>>);
|
66
72
|
init(options: StandardLinkOptions<T>): void;
|
67
73
|
}
|
68
74
|
|
@@ -101,6 +107,11 @@ declare class ClientRetryPluginInvalidEventIteratorRetryResponse extends Error {
|
|
101
107
|
interface ClientRetryPluginOptions {
|
102
108
|
default?: ClientRetryPluginContext;
|
103
109
|
}
|
110
|
+
/**
|
111
|
+
* The Client Retry Plugin enables retrying client calls when errors occur.
|
112
|
+
*
|
113
|
+
* @see {@link https://orpc.unnoq.com/docs/plugins/client-retry Client Retry Plugin Docs}
|
114
|
+
*/
|
104
115
|
declare class ClientRetryPlugin<T extends ClientRetryPluginContext> implements StandardLinkPlugin<T> {
|
105
116
|
private readonly defaultRetry;
|
106
117
|
private readonly defaultRetryDelay;
|
@@ -131,6 +142,13 @@ interface SimpleCsrfProtectionLinkPluginOptions<T extends ClientContext> {
|
|
131
142
|
*/
|
132
143
|
exclude?: Value<boolean, [options: StandardLinkClientInterceptorOptions<T>]>;
|
133
144
|
}
|
145
|
+
/**
|
146
|
+
* This plugin adds basic Cross-Site Request Forgery (CSRF) protection to your oRPC application.
|
147
|
+
* It helps ensure that requests to your procedures originate from JavaScript code,
|
148
|
+
* not from other sources like standard HTML forms or direct browser navigation.
|
149
|
+
*
|
150
|
+
* @see {@link https://orpc.unnoq.com/docs/plugins/simple-csrf-protection Simple CSRF Protection Plugin Docs}
|
151
|
+
*/
|
134
152
|
declare class SimpleCsrfProtectionLinkPlugin<T extends ClientContext> implements StandardLinkPlugin<T> {
|
135
153
|
private readonly headerName;
|
136
154
|
private readonly headerValue;
|
@@ -1,7 +1,7 @@
|
|
1
1
|
import { PromiseWithError } from '@orpc/shared';
|
2
2
|
|
3
3
|
type HTTPPath = `/${string}`;
|
4
|
-
type HTTPMethod = 'GET' | 'POST' | 'PUT' | 'DELETE' | 'PATCH';
|
4
|
+
type HTTPMethod = 'HEAD' | 'GET' | 'POST' | 'PUT' | 'DELETE' | 'PATCH';
|
5
5
|
type ClientContext = Record<PropertyKey, any>;
|
6
6
|
interface ClientOptions<T extends ClientContext> {
|
7
7
|
signal?: AbortSignal;
|
@@ -1,7 +1,7 @@
|
|
1
1
|
import { PromiseWithError } from '@orpc/shared';
|
2
2
|
|
3
3
|
type HTTPPath = `/${string}`;
|
4
|
-
type HTTPMethod = 'GET' | 'POST' | 'PUT' | 'DELETE' | 'PATCH';
|
4
|
+
type HTTPMethod = 'HEAD' | 'GET' | 'POST' | 'PUT' | 'DELETE' | 'PATCH';
|
5
5
|
type ClientContext = Record<PropertyKey, any>;
|
6
6
|
interface ClientOptions<T extends ClientContext> {
|
7
7
|
signal?: AbortSignal;
|
@@ -1,6 +1,6 @@
|
|
1
1
|
import { Interceptor, ThrowableError } from '@orpc/shared';
|
2
2
|
import { StandardRequest, StandardLazyResponse } from '@orpc/standard-server';
|
3
|
-
import { a as ClientContext, b as ClientOptions, C as ClientLink } from './client.
|
3
|
+
import { a as ClientContext, b as ClientOptions, C as ClientLink } from './client.4TS_0JaO.js';
|
4
4
|
|
5
5
|
interface StandardLinkPlugin<T extends ClientContext> {
|
6
6
|
order?: number;
|
@@ -1,5 +1,5 @@
|
|
1
|
-
import { a as ClientContext, b as ClientOptions, d as HTTPMethod } from './client.
|
2
|
-
import { e as StandardLinkCodec, b as StandardLinkOptions, d as StandardLink, f as StandardLinkClient } from './client.
|
1
|
+
import { a as ClientContext, b as ClientOptions, d as HTTPMethod } from './client.4TS_0JaO.js';
|
2
|
+
import { e as StandardLinkCodec, b as StandardLinkOptions, d as StandardLink, f as StandardLinkClient } from './client.7ZYxJok_.js';
|
3
3
|
import { Segment, Value } from '@orpc/shared';
|
4
4
|
import { StandardHeaders, StandardRequest, StandardLazyResponse } from '@orpc/standard-server';
|
5
5
|
|
@@ -56,14 +56,14 @@ interface StandardRPCLinkCodecOptions<T extends ClientContext> {
|
|
56
56
|
*
|
57
57
|
* @default 'POST'
|
58
58
|
*/
|
59
|
-
method?: Value<HTTPMethod, [options: ClientOptions<T>, path: readonly string[], input: unknown]>;
|
59
|
+
method?: Value<Exclude<HTTPMethod, 'HEAD'>, [options: ClientOptions<T>, path: readonly string[], input: unknown]>;
|
60
60
|
/**
|
61
61
|
* The method to use when the payload cannot safely pass to the server with method return from method function.
|
62
62
|
* GET is not allowed, it's very dangerous.
|
63
63
|
*
|
64
64
|
* @default 'POST'
|
65
65
|
*/
|
66
|
-
fallbackMethod?: Exclude<HTTPMethod, 'GET'>;
|
66
|
+
fallbackMethod?: Exclude<HTTPMethod, 'HEAD' | 'GET'>;
|
67
67
|
/**
|
68
68
|
* Inject headers to the request.
|
69
69
|
*/
|
@@ -1,5 +1,5 @@
|
|
1
|
-
import { a as ClientContext, b as ClientOptions, d as HTTPMethod } from './client.
|
2
|
-
import { e as StandardLinkCodec, b as StandardLinkOptions, d as StandardLink, f as StandardLinkClient } from './client.
|
1
|
+
import { a as ClientContext, b as ClientOptions, d as HTTPMethod } from './client.4TS_0JaO.mjs';
|
2
|
+
import { e as StandardLinkCodec, b as StandardLinkOptions, d as StandardLink, f as StandardLinkClient } from './client.ds1abV85.mjs';
|
3
3
|
import { Segment, Value } from '@orpc/shared';
|
4
4
|
import { StandardHeaders, StandardRequest, StandardLazyResponse } from '@orpc/standard-server';
|
5
5
|
|
@@ -56,14 +56,14 @@ interface StandardRPCLinkCodecOptions<T extends ClientContext> {
|
|
56
56
|
*
|
57
57
|
* @default 'POST'
|
58
58
|
*/
|
59
|
-
method?: Value<HTTPMethod, [options: ClientOptions<T>, path: readonly string[], input: unknown]>;
|
59
|
+
method?: Value<Exclude<HTTPMethod, 'HEAD'>, [options: ClientOptions<T>, path: readonly string[], input: unknown]>;
|
60
60
|
/**
|
61
61
|
* The method to use when the payload cannot safely pass to the server with method return from method function.
|
62
62
|
* GET is not allowed, it's very dangerous.
|
63
63
|
*
|
64
64
|
* @default 'POST'
|
65
65
|
*/
|
66
|
-
fallbackMethod?: Exclude<HTTPMethod, 'GET'>;
|
66
|
+
fallbackMethod?: Exclude<HTTPMethod, 'HEAD' | 'GET'>;
|
67
67
|
/**
|
68
68
|
* Inject headers to the request.
|
69
69
|
*/
|
@@ -1,6 +1,6 @@
|
|
1
1
|
import { Interceptor, ThrowableError } from '@orpc/shared';
|
2
2
|
import { StandardRequest, StandardLazyResponse } from '@orpc/standard-server';
|
3
|
-
import { a as ClientContext, b as ClientOptions, C as ClientLink } from './client.
|
3
|
+
import { a as ClientContext, b as ClientOptions, C as ClientLink } from './client.4TS_0JaO.mjs';
|
4
4
|
|
5
5
|
interface StandardLinkPlugin<T extends ClientContext> {
|
6
6
|
order?: number;
|
package/package.json
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
{
|
2
2
|
"name": "@orpc/client",
|
3
3
|
"type": "module",
|
4
|
-
"version": "0.0.0-next.
|
4
|
+
"version": "0.0.0-next.e000d9a",
|
5
5
|
"license": "MIT",
|
6
6
|
"homepage": "https://orpc.unnoq.com",
|
7
7
|
"repository": {
|
@@ -33,18 +33,24 @@
|
|
33
33
|
"types": "./dist/adapters/fetch/index.d.mts",
|
34
34
|
"import": "./dist/adapters/fetch/index.mjs",
|
35
35
|
"default": "./dist/adapters/fetch/index.mjs"
|
36
|
+
},
|
37
|
+
"./websocket": {
|
38
|
+
"types": "./dist/adapters/websocket/index.d.mts",
|
39
|
+
"import": "./dist/adapters/websocket/index.mjs",
|
40
|
+
"default": "./dist/adapters/websocket/index.mjs"
|
36
41
|
}
|
37
42
|
},
|
38
43
|
"files": [
|
39
44
|
"dist"
|
40
45
|
],
|
41
46
|
"dependencies": {
|
42
|
-
"@orpc/shared": "0.0.0-next.
|
43
|
-
"@orpc/standard-server-fetch": "0.0.0-next.
|
44
|
-
"@orpc/standard-server": "0.0.0-next.
|
47
|
+
"@orpc/shared": "0.0.0-next.e000d9a",
|
48
|
+
"@orpc/standard-server-fetch": "0.0.0-next.e000d9a",
|
49
|
+
"@orpc/standard-server-peer": "0.0.0-next.e000d9a",
|
50
|
+
"@orpc/standard-server": "0.0.0-next.e000d9a"
|
45
51
|
},
|
46
52
|
"devDependencies": {
|
47
|
-
"zod": "^3.
|
53
|
+
"zod": "^3.25.11"
|
48
54
|
},
|
49
55
|
"scripts": {
|
50
56
|
"build": "unbuild",
|