@orpc/client 1.6.8 → 1.7.1
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/dist/adapters/fetch/index.d.mts +3 -3
- package/dist/adapters/fetch/index.d.ts +3 -3
- package/dist/adapters/message-port/index.d.mts +12 -12
- package/dist/adapters/message-port/index.d.ts +12 -12
- package/dist/adapters/message-port/index.mjs +4 -4
- 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 +11 -11
- package/dist/adapters/websocket/index.d.ts +11 -11
- package/dist/adapters/websocket/index.mjs +6 -6
- package/dist/index.d.mts +39 -23
- package/dist/index.d.ts +39 -23
- package/dist/index.mjs +20 -3
- package/dist/plugins/index.d.mts +2 -2
- package/dist/plugins/index.d.ts +2 -2
- package/dist/shared/{client.4TS_0JaO.d.mts → client.BOYsZIRq.d.mts} +1 -1
- package/dist/shared/{client.4TS_0JaO.d.ts → client.BOYsZIRq.d.ts} +1 -1
- package/dist/shared/{client.BMoG_EdN.d.mts → client.C4VxIexA.d.mts} +1 -1
- package/dist/shared/{client.C0KbSWlC.d.ts → client.CXXEPIbK.d.ts} +1 -1
- package/dist/shared/{client.7UM0t5o-.d.ts → client.WCinBImJ.d.ts} +2 -2
- package/dist/shared/{client.BdD8cpjs.d.mts → client.aTp4sII-.d.mts} +2 -2
- package/package.json +6 -6
@@ -1,8 +1,8 @@
|
|
1
1
|
import { StandardRequest, StandardLazyResponse } from '@orpc/standard-server';
|
2
2
|
import { ToFetchRequestOptions } from '@orpc/standard-server-fetch';
|
3
|
-
import {
|
4
|
-
import { f as StandardLinkClient } from '../../shared/client.
|
5
|
-
import { f as StandardRPCLinkOptions, g as StandardRPCLink } from '../../shared/client.
|
3
|
+
import { b as ClientContext, c as ClientOptions } from '../../shared/client.BOYsZIRq.mjs';
|
4
|
+
import { f as StandardLinkClient } from '../../shared/client.C4VxIexA.mjs';
|
5
|
+
import { f as StandardRPCLinkOptions, g as StandardRPCLink } from '../../shared/client.aTp4sII-.mjs';
|
6
6
|
import '@orpc/shared';
|
7
7
|
|
8
8
|
interface LinkFetchClientOptions<T extends ClientContext> extends ToFetchRequestOptions {
|
@@ -1,8 +1,8 @@
|
|
1
1
|
import { StandardRequest, StandardLazyResponse } from '@orpc/standard-server';
|
2
2
|
import { ToFetchRequestOptions } from '@orpc/standard-server-fetch';
|
3
|
-
import {
|
4
|
-
import { f as StandardLinkClient } from '../../shared/client.
|
5
|
-
import { f as StandardRPCLinkOptions, g as StandardRPCLink } from '../../shared/client.
|
3
|
+
import { b as ClientContext, c as ClientOptions } from '../../shared/client.BOYsZIRq.js';
|
4
|
+
import { f as StandardLinkClient } from '../../shared/client.CXXEPIbK.js';
|
5
|
+
import { f as StandardRPCLinkOptions, g as StandardRPCLink } from '../../shared/client.WCinBImJ.js';
|
6
6
|
import '@orpc/shared';
|
7
7
|
|
8
8
|
interface LinkFetchClientOptions<T extends ClientContext> extends ToFetchRequestOptions {
|
@@ -1,7 +1,7 @@
|
|
1
1
|
import { StandardRequest, StandardLazyResponse } from '@orpc/standard-server';
|
2
|
-
import {
|
3
|
-
import { f as StandardLinkClient } from '../../shared/client.
|
4
|
-
import { f as StandardRPCLinkOptions, g as StandardRPCLink } from '../../shared/client.
|
2
|
+
import { b as ClientContext, c as ClientOptions } from '../../shared/client.BOYsZIRq.mjs';
|
3
|
+
import { f as StandardLinkClient } from '../../shared/client.C4VxIexA.mjs';
|
4
|
+
import { f as StandardRPCLinkOptions, g as StandardRPCLink } from '../../shared/client.aTp4sII-.mjs';
|
5
5
|
import '@orpc/shared';
|
6
6
|
|
7
7
|
/**
|
@@ -29,21 +29,21 @@ type SupportedMessagePort = Pick<MessagePort, 'addEventListener' | 'postMessage'
|
|
29
29
|
/**
|
30
30
|
* Message port can support [The structured clone algorithm](https://developer.mozilla.org/en-US/docs/Web/API/Web_Workers_API/Structured_clone_algorithm)
|
31
31
|
*/
|
32
|
-
type SupportedMessagePortData = string | ArrayBufferLike;
|
32
|
+
type SupportedMessagePortData = string | ArrayBufferLike | Uint8Array;
|
33
33
|
declare function postMessagePortMessage(port: SupportedMessagePort, data: SupportedMessagePortData): void;
|
34
34
|
declare function onMessagePortMessage(port: SupportedMessagePort, callback: (data: SupportedMessagePortData) => void): void;
|
35
35
|
declare function onMessagePortClose(port: SupportedMessagePort, callback: () => void): void;
|
36
36
|
|
37
|
-
interface
|
37
|
+
interface LinkMessagePortClientOptions {
|
38
38
|
port: SupportedMessagePort;
|
39
39
|
}
|
40
|
-
declare class
|
40
|
+
declare class LinkMessagePortClient<T extends ClientContext> implements StandardLinkClient<T> {
|
41
41
|
private readonly peer;
|
42
|
-
constructor(options:
|
42
|
+
constructor(options: LinkMessagePortClientOptions);
|
43
43
|
call(request: StandardRequest, _options: ClientOptions<T>, _path: readonly string[], _input: unknown): Promise<StandardLazyResponse>;
|
44
44
|
}
|
45
45
|
|
46
|
-
interface
|
46
|
+
interface RPCLinkOptions<T extends ClientContext> extends Omit<StandardRPCLinkOptions<T>, 'url' | 'headers' | 'method' | 'fallbackMethod' | 'maxUrlLength'>, LinkMessagePortClientOptions {
|
47
47
|
}
|
48
48
|
/**
|
49
49
|
* The RPC Link for common message port implementations.
|
@@ -51,9 +51,9 @@ interface experimental_RPCLinkOptions<T extends ClientContext> extends Omit<Stan
|
|
51
51
|
* @see {@link https://orpc.unnoq.com/docs/client/rpc-link RPC Link Docs}
|
52
52
|
* @see {@link https://orpc.unnoq.com/docs/adapters/message-port Message Port Adapter Docs}
|
53
53
|
*/
|
54
|
-
declare class
|
55
|
-
constructor(options:
|
54
|
+
declare class RPCLink<T extends ClientContext> extends StandardRPCLink<T> {
|
55
|
+
constructor(options: RPCLinkOptions<T>);
|
56
56
|
}
|
57
57
|
|
58
|
-
export {
|
59
|
-
export type { BrowserPortLike,
|
58
|
+
export { LinkMessagePortClient, RPCLink, onMessagePortClose, onMessagePortMessage, postMessagePortMessage };
|
59
|
+
export type { BrowserPortLike, LinkMessagePortClientOptions, MessagePortMainLike, RPCLinkOptions, SupportedMessagePort, SupportedMessagePortData };
|
@@ -1,7 +1,7 @@
|
|
1
1
|
import { StandardRequest, StandardLazyResponse } from '@orpc/standard-server';
|
2
|
-
import {
|
3
|
-
import { f as StandardLinkClient } from '../../shared/client.
|
4
|
-
import { f as StandardRPCLinkOptions, g as StandardRPCLink } from '../../shared/client.
|
2
|
+
import { b as ClientContext, c as ClientOptions } from '../../shared/client.BOYsZIRq.js';
|
3
|
+
import { f as StandardLinkClient } from '../../shared/client.CXXEPIbK.js';
|
4
|
+
import { f as StandardRPCLinkOptions, g as StandardRPCLink } from '../../shared/client.WCinBImJ.js';
|
5
5
|
import '@orpc/shared';
|
6
6
|
|
7
7
|
/**
|
@@ -29,21 +29,21 @@ type SupportedMessagePort = Pick<MessagePort, 'addEventListener' | 'postMessage'
|
|
29
29
|
/**
|
30
30
|
* Message port can support [The structured clone algorithm](https://developer.mozilla.org/en-US/docs/Web/API/Web_Workers_API/Structured_clone_algorithm)
|
31
31
|
*/
|
32
|
-
type SupportedMessagePortData = string | ArrayBufferLike;
|
32
|
+
type SupportedMessagePortData = string | ArrayBufferLike | Uint8Array;
|
33
33
|
declare function postMessagePortMessage(port: SupportedMessagePort, data: SupportedMessagePortData): void;
|
34
34
|
declare function onMessagePortMessage(port: SupportedMessagePort, callback: (data: SupportedMessagePortData) => void): void;
|
35
35
|
declare function onMessagePortClose(port: SupportedMessagePort, callback: () => void): void;
|
36
36
|
|
37
|
-
interface
|
37
|
+
interface LinkMessagePortClientOptions {
|
38
38
|
port: SupportedMessagePort;
|
39
39
|
}
|
40
|
-
declare class
|
40
|
+
declare class LinkMessagePortClient<T extends ClientContext> implements StandardLinkClient<T> {
|
41
41
|
private readonly peer;
|
42
|
-
constructor(options:
|
42
|
+
constructor(options: LinkMessagePortClientOptions);
|
43
43
|
call(request: StandardRequest, _options: ClientOptions<T>, _path: readonly string[], _input: unknown): Promise<StandardLazyResponse>;
|
44
44
|
}
|
45
45
|
|
46
|
-
interface
|
46
|
+
interface RPCLinkOptions<T extends ClientContext> extends Omit<StandardRPCLinkOptions<T>, 'url' | 'headers' | 'method' | 'fallbackMethod' | 'maxUrlLength'>, LinkMessagePortClientOptions {
|
47
47
|
}
|
48
48
|
/**
|
49
49
|
* The RPC Link for common message port implementations.
|
@@ -51,9 +51,9 @@ interface experimental_RPCLinkOptions<T extends ClientContext> extends Omit<Stan
|
|
51
51
|
* @see {@link https://orpc.unnoq.com/docs/client/rpc-link RPC Link Docs}
|
52
52
|
* @see {@link https://orpc.unnoq.com/docs/adapters/message-port Message Port Adapter Docs}
|
53
53
|
*/
|
54
|
-
declare class
|
55
|
-
constructor(options:
|
54
|
+
declare class RPCLink<T extends ClientContext> extends StandardRPCLink<T> {
|
55
|
+
constructor(options: RPCLinkOptions<T>);
|
56
56
|
}
|
57
57
|
|
58
|
-
export {
|
59
|
-
export type { BrowserPortLike,
|
58
|
+
export { LinkMessagePortClient, RPCLink, onMessagePortClose, onMessagePortMessage, postMessagePortMessage };
|
59
|
+
export type { BrowserPortLike, LinkMessagePortClientOptions, MessagePortMainLike, RPCLinkOptions, SupportedMessagePort, SupportedMessagePortData };
|
@@ -42,7 +42,7 @@ function onMessagePortClose(port, callback) {
|
|
42
42
|
}
|
43
43
|
}
|
44
44
|
|
45
|
-
class
|
45
|
+
class LinkMessagePortClient {
|
46
46
|
peer;
|
47
47
|
constructor(options) {
|
48
48
|
this.peer = new ClientPeer((message) => {
|
@@ -61,11 +61,11 @@ class experimental_LinkMessagePortClient {
|
|
61
61
|
}
|
62
62
|
}
|
63
63
|
|
64
|
-
class
|
64
|
+
class RPCLink extends StandardRPCLink {
|
65
65
|
constructor(options) {
|
66
|
-
const linkClient = new
|
66
|
+
const linkClient = new LinkMessagePortClient(options);
|
67
67
|
super(linkClient, { ...options, url: "orpc:/" });
|
68
68
|
}
|
69
69
|
}
|
70
70
|
|
71
|
-
export {
|
71
|
+
export { LinkMessagePortClient, RPCLink, onMessagePortClose, onMessagePortMessage, postMessagePortMessage };
|
@@ -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.C4VxIexA.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.aTp4sII-.mjs';
|
3
|
+
import { H as HTTPPath } from '../../shared/client.BOYsZIRq.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.CXXEPIbK.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.WCinBImJ.js';
|
3
|
+
import { H as HTTPPath } from '../../shared/client.BOYsZIRq.js';
|
4
4
|
import '@orpc/shared';
|
5
5
|
import '@orpc/standard-server';
|
6
6
|
|
@@ -1,19 +1,19 @@
|
|
1
1
|
import { StandardRequest, StandardLazyResponse } from '@orpc/standard-server';
|
2
|
-
import {
|
3
|
-
import { f as StandardLinkClient } from '../../shared/client.
|
4
|
-
import { f as StandardRPCLinkOptions, g as StandardRPCLink } from '../../shared/client.
|
2
|
+
import { b as ClientContext, c as ClientOptions } from '../../shared/client.BOYsZIRq.mjs';
|
3
|
+
import { f as StandardLinkClient } from '../../shared/client.C4VxIexA.mjs';
|
4
|
+
import { f as StandardRPCLinkOptions, g as StandardRPCLink } from '../../shared/client.aTp4sII-.mjs';
|
5
5
|
import '@orpc/shared';
|
6
6
|
|
7
|
-
interface
|
7
|
+
interface LinkWebsocketClientOptions {
|
8
8
|
websocket: Pick<WebSocket, 'addEventListener' | 'send' | 'readyState'>;
|
9
9
|
}
|
10
|
-
declare class
|
10
|
+
declare class LinkWebsocketClient<T extends ClientContext> implements StandardLinkClient<T> {
|
11
11
|
private readonly peer;
|
12
|
-
constructor(options:
|
12
|
+
constructor(options: LinkWebsocketClientOptions);
|
13
13
|
call(request: StandardRequest, _options: ClientOptions<T>, _path: readonly string[], _input: unknown): Promise<StandardLazyResponse>;
|
14
14
|
}
|
15
15
|
|
16
|
-
interface
|
16
|
+
interface RPCLinkOptions<T extends ClientContext> extends Omit<StandardRPCLinkOptions<T>, 'url' | 'headers' | 'method' | 'fallbackMethod' | 'maxUrlLength'>, LinkWebsocketClientOptions {
|
17
17
|
}
|
18
18
|
/**
|
19
19
|
* The RPC Link communicates with the server using the RPC protocol over WebSocket.
|
@@ -21,9 +21,9 @@ interface experimental_RPCLinkOptions<T extends ClientContext> extends Omit<Stan
|
|
21
21
|
* @see {@link https://orpc.unnoq.com/docs/client/rpc-link RPC Link Docs}
|
22
22
|
* @see {@link https://orpc.unnoq.com/docs/adapters/websocket WebSocket Adapter Docs}
|
23
23
|
*/
|
24
|
-
declare class
|
25
|
-
constructor(options:
|
24
|
+
declare class RPCLink<T extends ClientContext> extends StandardRPCLink<T> {
|
25
|
+
constructor(options: RPCLinkOptions<T>);
|
26
26
|
}
|
27
27
|
|
28
|
-
export {
|
29
|
-
export type {
|
28
|
+
export { LinkWebsocketClient, RPCLink };
|
29
|
+
export type { LinkWebsocketClientOptions, RPCLinkOptions };
|
@@ -1,19 +1,19 @@
|
|
1
1
|
import { StandardRequest, StandardLazyResponse } from '@orpc/standard-server';
|
2
|
-
import {
|
3
|
-
import { f as StandardLinkClient } from '../../shared/client.
|
4
|
-
import { f as StandardRPCLinkOptions, g as StandardRPCLink } from '../../shared/client.
|
2
|
+
import { b as ClientContext, c as ClientOptions } from '../../shared/client.BOYsZIRq.js';
|
3
|
+
import { f as StandardLinkClient } from '../../shared/client.CXXEPIbK.js';
|
4
|
+
import { f as StandardRPCLinkOptions, g as StandardRPCLink } from '../../shared/client.WCinBImJ.js';
|
5
5
|
import '@orpc/shared';
|
6
6
|
|
7
|
-
interface
|
7
|
+
interface LinkWebsocketClientOptions {
|
8
8
|
websocket: Pick<WebSocket, 'addEventListener' | 'send' | 'readyState'>;
|
9
9
|
}
|
10
|
-
declare class
|
10
|
+
declare class LinkWebsocketClient<T extends ClientContext> implements StandardLinkClient<T> {
|
11
11
|
private readonly peer;
|
12
|
-
constructor(options:
|
12
|
+
constructor(options: LinkWebsocketClientOptions);
|
13
13
|
call(request: StandardRequest, _options: ClientOptions<T>, _path: readonly string[], _input: unknown): Promise<StandardLazyResponse>;
|
14
14
|
}
|
15
15
|
|
16
|
-
interface
|
16
|
+
interface RPCLinkOptions<T extends ClientContext> extends Omit<StandardRPCLinkOptions<T>, 'url' | 'headers' | 'method' | 'fallbackMethod' | 'maxUrlLength'>, LinkWebsocketClientOptions {
|
17
17
|
}
|
18
18
|
/**
|
19
19
|
* The RPC Link communicates with the server using the RPC protocol over WebSocket.
|
@@ -21,9 +21,9 @@ interface experimental_RPCLinkOptions<T extends ClientContext> extends Omit<Stan
|
|
21
21
|
* @see {@link https://orpc.unnoq.com/docs/client/rpc-link RPC Link Docs}
|
22
22
|
* @see {@link https://orpc.unnoq.com/docs/adapters/websocket WebSocket Adapter Docs}
|
23
23
|
*/
|
24
|
-
declare class
|
25
|
-
constructor(options:
|
24
|
+
declare class RPCLink<T extends ClientContext> extends StandardRPCLink<T> {
|
25
|
+
constructor(options: RPCLinkOptions<T>);
|
26
26
|
}
|
27
27
|
|
28
|
-
export {
|
29
|
-
export type {
|
28
|
+
export { LinkWebsocketClient, RPCLink };
|
29
|
+
export type { LinkWebsocketClientOptions, RPCLinkOptions };
|
@@ -1,10 +1,10 @@
|
|
1
|
+
import { readAsBuffer } from '@orpc/shared';
|
1
2
|
import { ClientPeer } from '@orpc/standard-server-peer';
|
2
|
-
import '@orpc/shared';
|
3
3
|
import { c as StandardRPCLink } from '../../shared/client.DwfV9Oyl.mjs';
|
4
4
|
import '@orpc/standard-server';
|
5
5
|
import '../../shared/client.DHOfWE0c.mjs';
|
6
6
|
|
7
|
-
class
|
7
|
+
class LinkWebsocketClient {
|
8
8
|
peer;
|
9
9
|
constructor(options) {
|
10
10
|
const untilOpen = new Promise((resolve) => {
|
@@ -21,7 +21,7 @@ class experimental_LinkWebsocketClient {
|
|
21
21
|
return options.websocket.send(message);
|
22
22
|
});
|
23
23
|
options.websocket.addEventListener("message", async (event) => {
|
24
|
-
const message = event.data instanceof Blob ? await event.data
|
24
|
+
const message = event.data instanceof Blob ? await readAsBuffer(event.data) : event.data;
|
25
25
|
this.peer.message(message);
|
26
26
|
});
|
27
27
|
options.websocket.addEventListener("close", () => {
|
@@ -34,11 +34,11 @@ class experimental_LinkWebsocketClient {
|
|
34
34
|
}
|
35
35
|
}
|
36
36
|
|
37
|
-
class
|
37
|
+
class RPCLink extends StandardRPCLink {
|
38
38
|
constructor(options) {
|
39
|
-
const linkClient = new
|
39
|
+
const linkClient = new LinkWebsocketClient(options);
|
40
40
|
super(linkClient, { ...options, url: "orpc:/" });
|
41
41
|
}
|
42
42
|
}
|
43
43
|
|
44
|
-
export {
|
44
|
+
export { LinkWebsocketClient, RPCLink };
|
package/dist/index.d.mts
CHANGED
@@ -1,6 +1,6 @@
|
|
1
|
-
import { N as NestedClient, C as ClientLink, I as InferClientContext, a as
|
2
|
-
export { f as
|
3
|
-
import {
|
1
|
+
import { N as NestedClient, C as ClientLink, I as InferClientContext, a as ClientPromiseResult, b as ClientContext, F as FriendlyClientOptions, c as ClientOptions, d as Client, e as ClientRest } from './shared/client.BOYsZIRq.mjs';
|
2
|
+
export { f as HTTPMethod, H as HTTPPath } from './shared/client.BOYsZIRq.mjs';
|
3
|
+
import { MaybeOptionalOptions, ThrowableError, Promisable, AsyncIteratorClass } from '@orpc/shared';
|
4
4
|
export { EventPublisher, EventPublisherOptions, EventPublisherSubscribeIteratorOptions, Registry, ThrowableError, onError, onFinish, onStart, onSuccess } from '@orpc/shared';
|
5
5
|
export { ErrorEvent } from '@orpc/standard-server';
|
6
6
|
|
@@ -8,7 +8,7 @@ interface createORPCClientOptions {
|
|
8
8
|
/**
|
9
9
|
* Use as base path for all procedure, useful when you only want to call a subset of the procedure.
|
10
10
|
*/
|
11
|
-
path?: string[];
|
11
|
+
path?: readonly string[];
|
12
12
|
}
|
13
13
|
/**
|
14
14
|
* Create a oRPC client-side client from a link.
|
@@ -17,18 +17,6 @@ interface createORPCClientOptions {
|
|
17
17
|
*/
|
18
18
|
declare function createORPCClient<T extends NestedClient<any>>(link: ClientLink<InferClientContext<T>>, options?: createORPCClientOptions): T;
|
19
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
20
|
declare const COMMON_ORPC_ERROR_DEFS: {
|
33
21
|
readonly BAD_REQUEST: {
|
34
22
|
readonly status: 400;
|
@@ -135,11 +123,6 @@ declare function isORPCErrorStatus(status: number): boolean;
|
|
135
123
|
declare function isORPCErrorJson(json: unknown): json is ORPCErrorJSON<ORPCErrorCode, unknown>;
|
136
124
|
declare function createORPCErrorFromJson<TCode extends ORPCErrorCode, TData>(json: ORPCErrorJSON<TCode, TData>, options?: ErrorOptions): ORPCError<TCode, TData>;
|
137
125
|
|
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
|
-
}): AsyncIteratorClass<TMap, TMap, TNext>;
|
142
|
-
|
143
126
|
type SafeResult<TOutput, TError> = [error: null, data: TOutput, isDefined: false, isSuccess: true] & {
|
144
127
|
error: null;
|
145
128
|
data: TOutput;
|
@@ -165,5 +148,38 @@ type SafeResult<TOutput, TError> = [error: null, data: TOutput, isDefined: false
|
|
165
148
|
declare function safe<TOutput, TError = ThrowableError>(promise: ClientPromiseResult<TOutput, TError>): Promise<SafeResult<TOutput, TError>>;
|
166
149
|
declare function resolveFriendlyClientOptions<T extends ClientContext>(options: FriendlyClientOptions<T>): ClientOptions<T>;
|
167
150
|
|
168
|
-
|
169
|
-
|
151
|
+
type SafeClient<T extends NestedClient<any>> = T extends Client<infer UContext, infer UInput, infer UOutput, infer UError> ? (...rest: ClientRest<UContext, UInput>) => Promise<SafeResult<UOutput, UError>> : {
|
152
|
+
[K in keyof T]: T[K] extends NestedClient<any> ? SafeClient<T[K]> : never;
|
153
|
+
};
|
154
|
+
/**
|
155
|
+
* Create a safe client that automatically wraps all procedure calls with the `safe` util.
|
156
|
+
*
|
157
|
+
* @example
|
158
|
+
* ```ts
|
159
|
+
* const safeClient = createSafeClient(client)
|
160
|
+
* const { error, data, isDefined } = await safeClient.doSomething({ id: '123' })
|
161
|
+
* ```
|
162
|
+
*
|
163
|
+
* @see {@link https://orpc.unnoq.com/docs/client/error-handling#using-createsafeclient Safe Client Docs}
|
164
|
+
*/
|
165
|
+
declare function createSafeClient<T extends NestedClient<any>>(client: T): SafeClient<T>;
|
166
|
+
|
167
|
+
/**
|
168
|
+
* DynamicLink provides a way to dynamically resolve and delegate calls to other ClientLinks
|
169
|
+
* based on the request path, input, and context.
|
170
|
+
*
|
171
|
+
* @see {@link https://orpc.unnoq.com/docs/client/dynamic-link Dynamic Link Docs}
|
172
|
+
*/
|
173
|
+
declare class DynamicLink<TClientContext extends ClientContext> implements ClientLink<TClientContext> {
|
174
|
+
private readonly linkResolver;
|
175
|
+
constructor(linkResolver: (options: ClientOptions<TClientContext>, path: readonly string[], input: unknown) => Promisable<ClientLink<TClientContext>>);
|
176
|
+
call(path: readonly string[], input: unknown, options: ClientOptions<TClientContext>): Promise<unknown>;
|
177
|
+
}
|
178
|
+
|
179
|
+
declare function mapEventIterator<TYield, TReturn, TNext, TMap = TYield | TReturn>(iterator: AsyncIterator<TYield, TReturn, TNext>, maps: {
|
180
|
+
value: (value: NoInfer<TYield | TReturn>, done: boolean | undefined) => Promise<TMap>;
|
181
|
+
error: (error: unknown) => Promise<unknown>;
|
182
|
+
}): AsyncIteratorClass<TMap, TMap, TNext>;
|
183
|
+
|
184
|
+
export { COMMON_ORPC_ERROR_DEFS, Client, ClientContext, ClientLink, ClientOptions, ClientPromiseResult, ClientRest, DynamicLink, FriendlyClientOptions, InferClientContext, NestedClient, ORPCError, createORPCClient, createORPCErrorFromJson, createSafeClient, fallbackORPCErrorMessage, fallbackORPCErrorStatus, isDefinedError, isORPCErrorJson, isORPCErrorStatus, mapEventIterator, resolveFriendlyClientOptions, safe, toORPCError };
|
185
|
+
export type { CommonORPCErrorCode, ORPCErrorCode, ORPCErrorJSON, ORPCErrorOptions, SafeClient, SafeResult, createORPCClientOptions };
|
package/dist/index.d.ts
CHANGED
@@ -1,6 +1,6 @@
|
|
1
|
-
import { N as NestedClient, C as ClientLink, I as InferClientContext, a as
|
2
|
-
export { f as
|
3
|
-
import {
|
1
|
+
import { N as NestedClient, C as ClientLink, I as InferClientContext, a as ClientPromiseResult, b as ClientContext, F as FriendlyClientOptions, c as ClientOptions, d as Client, e as ClientRest } from './shared/client.BOYsZIRq.js';
|
2
|
+
export { f as HTTPMethod, H as HTTPPath } from './shared/client.BOYsZIRq.js';
|
3
|
+
import { MaybeOptionalOptions, ThrowableError, Promisable, AsyncIteratorClass } from '@orpc/shared';
|
4
4
|
export { EventPublisher, EventPublisherOptions, EventPublisherSubscribeIteratorOptions, Registry, ThrowableError, onError, onFinish, onStart, onSuccess } from '@orpc/shared';
|
5
5
|
export { ErrorEvent } from '@orpc/standard-server';
|
6
6
|
|
@@ -8,7 +8,7 @@ interface createORPCClientOptions {
|
|
8
8
|
/**
|
9
9
|
* Use as base path for all procedure, useful when you only want to call a subset of the procedure.
|
10
10
|
*/
|
11
|
-
path?: string[];
|
11
|
+
path?: readonly string[];
|
12
12
|
}
|
13
13
|
/**
|
14
14
|
* Create a oRPC client-side client from a link.
|
@@ -17,18 +17,6 @@ interface createORPCClientOptions {
|
|
17
17
|
*/
|
18
18
|
declare function createORPCClient<T extends NestedClient<any>>(link: ClientLink<InferClientContext<T>>, options?: createORPCClientOptions): T;
|
19
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
20
|
declare const COMMON_ORPC_ERROR_DEFS: {
|
33
21
|
readonly BAD_REQUEST: {
|
34
22
|
readonly status: 400;
|
@@ -135,11 +123,6 @@ declare function isORPCErrorStatus(status: number): boolean;
|
|
135
123
|
declare function isORPCErrorJson(json: unknown): json is ORPCErrorJSON<ORPCErrorCode, unknown>;
|
136
124
|
declare function createORPCErrorFromJson<TCode extends ORPCErrorCode, TData>(json: ORPCErrorJSON<TCode, TData>, options?: ErrorOptions): ORPCError<TCode, TData>;
|
137
125
|
|
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
|
-
}): AsyncIteratorClass<TMap, TMap, TNext>;
|
142
|
-
|
143
126
|
type SafeResult<TOutput, TError> = [error: null, data: TOutput, isDefined: false, isSuccess: true] & {
|
144
127
|
error: null;
|
145
128
|
data: TOutput;
|
@@ -165,5 +148,38 @@ type SafeResult<TOutput, TError> = [error: null, data: TOutput, isDefined: false
|
|
165
148
|
declare function safe<TOutput, TError = ThrowableError>(promise: ClientPromiseResult<TOutput, TError>): Promise<SafeResult<TOutput, TError>>;
|
166
149
|
declare function resolveFriendlyClientOptions<T extends ClientContext>(options: FriendlyClientOptions<T>): ClientOptions<T>;
|
167
150
|
|
168
|
-
|
169
|
-
|
151
|
+
type SafeClient<T extends NestedClient<any>> = T extends Client<infer UContext, infer UInput, infer UOutput, infer UError> ? (...rest: ClientRest<UContext, UInput>) => Promise<SafeResult<UOutput, UError>> : {
|
152
|
+
[K in keyof T]: T[K] extends NestedClient<any> ? SafeClient<T[K]> : never;
|
153
|
+
};
|
154
|
+
/**
|
155
|
+
* Create a safe client that automatically wraps all procedure calls with the `safe` util.
|
156
|
+
*
|
157
|
+
* @example
|
158
|
+
* ```ts
|
159
|
+
* const safeClient = createSafeClient(client)
|
160
|
+
* const { error, data, isDefined } = await safeClient.doSomething({ id: '123' })
|
161
|
+
* ```
|
162
|
+
*
|
163
|
+
* @see {@link https://orpc.unnoq.com/docs/client/error-handling#using-createsafeclient Safe Client Docs}
|
164
|
+
*/
|
165
|
+
declare function createSafeClient<T extends NestedClient<any>>(client: T): SafeClient<T>;
|
166
|
+
|
167
|
+
/**
|
168
|
+
* DynamicLink provides a way to dynamically resolve and delegate calls to other ClientLinks
|
169
|
+
* based on the request path, input, and context.
|
170
|
+
*
|
171
|
+
* @see {@link https://orpc.unnoq.com/docs/client/dynamic-link Dynamic Link Docs}
|
172
|
+
*/
|
173
|
+
declare class DynamicLink<TClientContext extends ClientContext> implements ClientLink<TClientContext> {
|
174
|
+
private readonly linkResolver;
|
175
|
+
constructor(linkResolver: (options: ClientOptions<TClientContext>, path: readonly string[], input: unknown) => Promisable<ClientLink<TClientContext>>);
|
176
|
+
call(path: readonly string[], input: unknown, options: ClientOptions<TClientContext>): Promise<unknown>;
|
177
|
+
}
|
178
|
+
|
179
|
+
declare function mapEventIterator<TYield, TReturn, TNext, TMap = TYield | TReturn>(iterator: AsyncIterator<TYield, TReturn, TNext>, maps: {
|
180
|
+
value: (value: NoInfer<TYield | TReturn>, done: boolean | undefined) => Promise<TMap>;
|
181
|
+
error: (error: unknown) => Promise<unknown>;
|
182
|
+
}): AsyncIteratorClass<TMap, TMap, TNext>;
|
183
|
+
|
184
|
+
export { COMMON_ORPC_ERROR_DEFS, Client, ClientContext, ClientLink, ClientOptions, ClientPromiseResult, ClientRest, DynamicLink, FriendlyClientOptions, InferClientContext, NestedClient, ORPCError, createORPCClient, createORPCErrorFromJson, createSafeClient, fallbackORPCErrorMessage, fallbackORPCErrorStatus, isDefinedError, isORPCErrorJson, isORPCErrorStatus, mapEventIterator, resolveFriendlyClientOptions, safe, toORPCError };
|
185
|
+
export type { CommonORPCErrorCode, ORPCErrorCode, ORPCErrorJSON, ORPCErrorOptions, SafeClient, SafeResult, createORPCClientOptions };
|
package/dist/index.mjs
CHANGED
@@ -1,5 +1,6 @@
|
|
1
1
|
import { i as isDefinedError } from './shared/client.DHOfWE0c.mjs';
|
2
2
|
export { C as COMMON_ORPC_ERROR_DEFS, O as ORPCError, d as createORPCErrorFromJson, a as fallbackORPCErrorMessage, f as fallbackORPCErrorStatus, c as isORPCErrorJson, b as isORPCErrorStatus, m as mapEventIterator, t as toORPCError } from './shared/client.DHOfWE0c.mjs';
|
3
|
+
import { isTypescriptObject } from '@orpc/shared';
|
3
4
|
export { EventPublisher, onError, onFinish, onStart, onSuccess } from '@orpc/shared';
|
4
5
|
export { ErrorEvent } from '@orpc/standard-server';
|
5
6
|
|
@@ -32,8 +33,8 @@ function resolveFriendlyClientOptions(options) {
|
|
32
33
|
};
|
33
34
|
}
|
34
35
|
|
35
|
-
function createORPCClient(link, options) {
|
36
|
-
const path = options
|
36
|
+
function createORPCClient(link, options = {}) {
|
37
|
+
const path = options.path ?? [];
|
37
38
|
const procedureClient = async (...[input, options2 = {}]) => {
|
38
39
|
return await link.call(path, input, resolveFriendlyClientOptions(options2));
|
39
40
|
};
|
@@ -51,6 +52,22 @@ function createORPCClient(link, options) {
|
|
51
52
|
return recursive;
|
52
53
|
}
|
53
54
|
|
55
|
+
function createSafeClient(client) {
|
56
|
+
const proxy = new Proxy((...args) => safe(client(...args)), {
|
57
|
+
get(_, prop, receiver) {
|
58
|
+
const value = Reflect.get(client, prop, receiver);
|
59
|
+
if (typeof prop !== "string") {
|
60
|
+
return value;
|
61
|
+
}
|
62
|
+
if (!isTypescriptObject(value)) {
|
63
|
+
return value;
|
64
|
+
}
|
65
|
+
return createSafeClient(value);
|
66
|
+
}
|
67
|
+
});
|
68
|
+
return proxy;
|
69
|
+
}
|
70
|
+
|
54
71
|
class DynamicLink {
|
55
72
|
constructor(linkResolver) {
|
56
73
|
this.linkResolver = linkResolver;
|
@@ -62,4 +79,4 @@ class DynamicLink {
|
|
62
79
|
}
|
63
80
|
}
|
64
81
|
|
65
|
-
export { DynamicLink, createORPCClient, isDefinedError, resolveFriendlyClientOptions, safe };
|
82
|
+
export { DynamicLink, createORPCClient, createSafeClient, isDefinedError, resolveFriendlyClientOptions, safe };
|
package/dist/plugins/index.d.mts
CHANGED
@@ -1,8 +1,8 @@
|
|
1
1
|
import { Value, Promisable } from '@orpc/shared';
|
2
2
|
import { StandardHeaders, StandardRequest } from '@orpc/standard-server';
|
3
3
|
import { BatchResponseMode } from '@orpc/standard-server/batch';
|
4
|
-
import { S as StandardLinkClientInterceptorOptions, a as StandardLinkPlugin, b as StandardLinkOptions, c as StandardLinkInterceptorOptions } from '../shared/client.
|
5
|
-
import {
|
4
|
+
import { S as StandardLinkClientInterceptorOptions, a as StandardLinkPlugin, b as StandardLinkOptions, c as StandardLinkInterceptorOptions } from '../shared/client.C4VxIexA.mjs';
|
5
|
+
import { b as ClientContext } from '../shared/client.BOYsZIRq.mjs';
|
6
6
|
|
7
7
|
interface BatchLinkPluginGroup<T extends ClientContext> {
|
8
8
|
condition(options: StandardLinkClientInterceptorOptions<T>): boolean;
|
package/dist/plugins/index.d.ts
CHANGED
@@ -1,8 +1,8 @@
|
|
1
1
|
import { Value, Promisable } from '@orpc/shared';
|
2
2
|
import { StandardHeaders, StandardRequest } from '@orpc/standard-server';
|
3
3
|
import { BatchResponseMode } from '@orpc/standard-server/batch';
|
4
|
-
import { S as StandardLinkClientInterceptorOptions, a as StandardLinkPlugin, b as StandardLinkOptions, c as StandardLinkInterceptorOptions } from '../shared/client.
|
5
|
-
import {
|
4
|
+
import { S as StandardLinkClientInterceptorOptions, a as StandardLinkPlugin, b as StandardLinkOptions, c as StandardLinkInterceptorOptions } from '../shared/client.CXXEPIbK.js';
|
5
|
+
import { b as ClientContext } from '../shared/client.BOYsZIRq.js';
|
6
6
|
|
7
7
|
interface BatchLinkPluginGroup<T extends ClientContext> {
|
8
8
|
condition(options: StandardLinkClientInterceptorOptions<T>): boolean;
|
@@ -26,4 +26,4 @@ interface ClientLink<TClientContext extends ClientContext> {
|
|
26
26
|
call: (path: readonly string[], input: unknown, options: ClientOptions<TClientContext>) => Promise<unknown>;
|
27
27
|
}
|
28
28
|
|
29
|
-
export type { ClientLink as C, FriendlyClientOptions as F, HTTPPath as H, InferClientContext as I, NestedClient as N,
|
29
|
+
export type { ClientLink as C, FriendlyClientOptions as F, HTTPPath as H, InferClientContext as I, NestedClient as N, ClientPromiseResult as a, ClientContext as b, ClientOptions as c, Client as d, ClientRest as e, HTTPMethod as f };
|
@@ -26,4 +26,4 @@ interface ClientLink<TClientContext extends ClientContext> {
|
|
26
26
|
call: (path: readonly string[], input: unknown, options: ClientOptions<TClientContext>) => Promise<unknown>;
|
27
27
|
}
|
28
28
|
|
29
|
-
export type { ClientLink as C, FriendlyClientOptions as F, HTTPPath as H, InferClientContext as I, NestedClient as N,
|
29
|
+
export type { ClientLink as C, FriendlyClientOptions as F, HTTPPath as H, InferClientContext as I, NestedClient as N, ClientPromiseResult as a, ClientContext as b, ClientOptions as c, Client as d, ClientRest as e, HTTPMethod as f };
|
@@ -1,6 +1,6 @@
|
|
1
1
|
import { Interceptor } from '@orpc/shared';
|
2
2
|
import { StandardRequest, StandardLazyResponse } from '@orpc/standard-server';
|
3
|
-
import {
|
3
|
+
import { b as ClientContext, c as ClientOptions, C as ClientLink } from './client.BOYsZIRq.mjs';
|
4
4
|
|
5
5
|
interface StandardLinkPlugin<T extends ClientContext> {
|
6
6
|
order?: number;
|
@@ -1,6 +1,6 @@
|
|
1
1
|
import { Interceptor } from '@orpc/shared';
|
2
2
|
import { StandardRequest, StandardLazyResponse } from '@orpc/standard-server';
|
3
|
-
import {
|
3
|
+
import { b as ClientContext, c as ClientOptions, C as ClientLink } from './client.BOYsZIRq.js';
|
4
4
|
|
5
5
|
interface StandardLinkPlugin<T extends ClientContext> {
|
6
6
|
order?: number;
|
@@ -1,5 +1,5 @@
|
|
1
|
-
import {
|
2
|
-
import { e as StandardLinkCodec, b as StandardLinkOptions, d as StandardLink, f as StandardLinkClient } from './client.
|
1
|
+
import { b as ClientContext, c as ClientOptions, f as HTTPMethod } from './client.BOYsZIRq.js';
|
2
|
+
import { e as StandardLinkCodec, b as StandardLinkOptions, d as StandardLink, f as StandardLinkClient } from './client.CXXEPIbK.js';
|
3
3
|
import { Segment, Value, Promisable } from '@orpc/shared';
|
4
4
|
import { StandardHeaders, StandardRequest, StandardLazyResponse } from '@orpc/standard-server';
|
5
5
|
|
@@ -1,5 +1,5 @@
|
|
1
|
-
import {
|
2
|
-
import { e as StandardLinkCodec, b as StandardLinkOptions, d as StandardLink, f as StandardLinkClient } from './client.
|
1
|
+
import { b as ClientContext, c as ClientOptions, f as HTTPMethod } from './client.BOYsZIRq.mjs';
|
2
|
+
import { e as StandardLinkCodec, b as StandardLinkOptions, d as StandardLink, f as StandardLinkClient } from './client.C4VxIexA.mjs';
|
3
3
|
import { Segment, Value, Promisable } from '@orpc/shared';
|
4
4
|
import { StandardHeaders, StandardRequest, StandardLazyResponse } from '@orpc/standard-server';
|
5
5
|
|
package/package.json
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
{
|
2
2
|
"name": "@orpc/client",
|
3
3
|
"type": "module",
|
4
|
-
"version": "1.
|
4
|
+
"version": "1.7.1",
|
5
5
|
"license": "MIT",
|
6
6
|
"homepage": "https://orpc.unnoq.com",
|
7
7
|
"repository": {
|
@@ -49,13 +49,13 @@
|
|
49
49
|
"dist"
|
50
50
|
],
|
51
51
|
"dependencies": {
|
52
|
-
"@orpc/
|
53
|
-
"@orpc/standard-server-fetch": "1.
|
54
|
-
"@orpc/standard-server
|
55
|
-
"@orpc/
|
52
|
+
"@orpc/standard-server-peer": "1.7.1",
|
53
|
+
"@orpc/standard-server-fetch": "1.7.1",
|
54
|
+
"@orpc/standard-server": "1.7.1",
|
55
|
+
"@orpc/shared": "1.7.1"
|
56
56
|
},
|
57
57
|
"devDependencies": {
|
58
|
-
"zod": "^
|
58
|
+
"zod": "^4.0.5"
|
59
59
|
},
|
60
60
|
"scripts": {
|
61
61
|
"build": "unbuild",
|