@orpc/client 0.0.0-next.8caa447 → 0.0.0-next.8dab177
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 +3 -0
- package/dist/adapters/fetch/index.d.mts +3 -3
- package/dist/adapters/fetch/index.d.ts +3 -3
- package/dist/adapters/fetch/index.mjs +3 -2
- package/dist/adapters/message-port/index.d.mts +28 -7
- package/dist/adapters/message-port/index.d.ts +28 -7
- package/dist/adapters/message-port/index.mjs +25 -10
- package/dist/adapters/standard/index.d.mts +3 -3
- package/dist/adapters/standard/index.d.ts +3 -3
- package/dist/adapters/standard/index.mjs +3 -2
- package/dist/adapters/websocket/index.d.mts +3 -3
- package/dist/adapters/websocket/index.d.ts +3 -3
- package/dist/adapters/websocket/index.mjs +4 -3
- package/dist/index.d.mts +51 -6
- package/dist/index.d.ts +51 -6
- package/dist/index.mjs +34 -4
- package/dist/plugins/index.d.mts +52 -5
- package/dist/plugins/index.d.ts +52 -5
- package/dist/plugins/index.mjs +99 -14
- package/dist/shared/client.BH1AYT_p.d.mts +83 -0
- package/dist/shared/client.BH1AYT_p.d.ts +83 -0
- package/dist/shared/client.BLtwTQUg.mjs +40 -0
- package/dist/shared/{client.CVVVqf1Y.d.ts → client.BxV-mzeR.d.ts} +2 -2
- package/dist/shared/{client.Bwgm6dgk.d.mts → client.CPgZaUox.d.mts} +1 -1
- package/dist/shared/{client._Y_enhib.d.mts → client.D8lMmWVC.d.mts} +2 -2
- package/dist/shared/{client.BG98rYdO.d.ts → client.De8SW4Kw.d.ts} +1 -1
- package/dist/shared/{client.txdq_i5V.mjs → client.qjMxHNL-.mjs} +30 -39
- package/dist/shared/{client.Bp1jlnBk.mjs → client.zO0fOJ2v.mjs} +2 -1
- package/package.json +6 -6
- package/dist/shared/client.BOYsZIRq.d.mts +0 -29
- package/dist/shared/client.BOYsZIRq.d.ts +0 -29
package/README.md
CHANGED
|
@@ -17,6 +17,9 @@
|
|
|
17
17
|
<a href="https://discord.gg/TXEbwRBvQn">
|
|
18
18
|
<img alt="Discord" src="https://img.shields.io/discord/1308966753044398161?color=7389D8&label&logo=discord&logoColor=ffffff" />
|
|
19
19
|
</a>
|
|
20
|
+
<a href="https://deepwiki.com/unnoq/orpc">
|
|
21
|
+
<img src="https://deepwiki.com/badge.svg" alt="Ask DeepWiki">
|
|
22
|
+
</a>
|
|
20
23
|
</div>
|
|
21
24
|
|
|
22
25
|
<h3 align="center">Typesafe APIs Made Simple 🪄</h3>
|
|
@@ -1,9 +1,9 @@
|
|
|
1
1
|
import { Interceptor } from '@orpc/shared';
|
|
2
2
|
import { StandardRequest, StandardLazyResponse } from '@orpc/standard-server';
|
|
3
3
|
import { ToFetchRequestOptions } from '@orpc/standard-server-fetch';
|
|
4
|
-
import { b as ClientContext, c as ClientOptions } from '../../shared/client.
|
|
5
|
-
import { a as StandardLinkPlugin, f as StandardLinkClient } from '../../shared/client.
|
|
6
|
-
import { f as StandardRPCLinkOptions, g as StandardRPCLink } from '../../shared/client.
|
|
4
|
+
import { b as ClientContext, c as ClientOptions } from '../../shared/client.BH1AYT_p.mjs';
|
|
5
|
+
import { a as StandardLinkPlugin, f as StandardLinkClient } from '../../shared/client.CPgZaUox.mjs';
|
|
6
|
+
import { f as StandardRPCLinkOptions, g as StandardRPCLink } from '../../shared/client.D8lMmWVC.mjs';
|
|
7
7
|
|
|
8
8
|
interface LinkFetchPlugin<T extends ClientContext> extends StandardLinkPlugin<T> {
|
|
9
9
|
initRuntimeAdapter?(options: LinkFetchClientOptions<T>): void;
|
|
@@ -1,9 +1,9 @@
|
|
|
1
1
|
import { Interceptor } from '@orpc/shared';
|
|
2
2
|
import { StandardRequest, StandardLazyResponse } from '@orpc/standard-server';
|
|
3
3
|
import { ToFetchRequestOptions } from '@orpc/standard-server-fetch';
|
|
4
|
-
import { b as ClientContext, c as ClientOptions } from '../../shared/client.
|
|
5
|
-
import { a as StandardLinkPlugin, f as StandardLinkClient } from '../../shared/client.
|
|
6
|
-
import { f as StandardRPCLinkOptions, g as StandardRPCLink } from '../../shared/client.
|
|
4
|
+
import { b as ClientContext, c as ClientOptions } from '../../shared/client.BH1AYT_p.js';
|
|
5
|
+
import { a as StandardLinkPlugin, f as StandardLinkClient } from '../../shared/client.De8SW4Kw.js';
|
|
6
|
+
import { f as StandardRPCLinkOptions, g as StandardRPCLink } from '../../shared/client.BxV-mzeR.js';
|
|
7
7
|
|
|
8
8
|
interface LinkFetchPlugin<T extends ClientContext> extends StandardLinkPlugin<T> {
|
|
9
9
|
initRuntimeAdapter?(options: LinkFetchClientOptions<T>): void;
|
|
@@ -1,8 +1,9 @@
|
|
|
1
1
|
import { toArray, intercept } from '@orpc/shared';
|
|
2
2
|
import { toFetchRequest, toStandardLazyResponse } from '@orpc/standard-server-fetch';
|
|
3
|
-
import { C as CompositeStandardLinkPlugin, c as StandardRPCLink } from '../../shared/client.
|
|
3
|
+
import { C as CompositeStandardLinkPlugin, c as StandardRPCLink } from '../../shared/client.zO0fOJ2v.mjs';
|
|
4
4
|
import '@orpc/standard-server';
|
|
5
|
-
import '../../shared/client.
|
|
5
|
+
import '../../shared/client.qjMxHNL-.mjs';
|
|
6
|
+
import '../../shared/client.BLtwTQUg.mjs';
|
|
6
7
|
|
|
7
8
|
class CompositeLinkFetchPlugin extends CompositeStandardLinkPlugin {
|
|
8
9
|
initRuntimeAdapter(options) {
|
|
@@ -1,8 +1,9 @@
|
|
|
1
|
+
import { Value, Promisable } from '@orpc/shared';
|
|
1
2
|
import { StandardRequest, StandardLazyResponse } from '@orpc/standard-server';
|
|
2
|
-
import {
|
|
3
|
-
import {
|
|
4
|
-
import { f as
|
|
5
|
-
import '
|
|
3
|
+
import { DecodedRequestMessage } from '@orpc/standard-server-peer';
|
|
4
|
+
import { b as ClientContext, c as ClientOptions } from '../../shared/client.BH1AYT_p.mjs';
|
|
5
|
+
import { f as StandardLinkClient } from '../../shared/client.CPgZaUox.mjs';
|
|
6
|
+
import { f as StandardRPCLinkOptions, g as StandardRPCLink } from '../../shared/client.D8lMmWVC.mjs';
|
|
6
7
|
|
|
7
8
|
/**
|
|
8
9
|
* The message port used by electron in main process
|
|
@@ -11,7 +12,7 @@ interface MessagePortMainLike {
|
|
|
11
12
|
on: <T extends string>(event: T, callback: (event?: {
|
|
12
13
|
data: any;
|
|
13
14
|
}) => void) => void;
|
|
14
|
-
postMessage: (data: any) => void;
|
|
15
|
+
postMessage: (data: any, transfer?: any[]) => void;
|
|
15
16
|
}
|
|
16
17
|
/**
|
|
17
18
|
* The message port used by browser extension
|
|
@@ -29,13 +30,33 @@ type SupportedMessagePort = Pick<MessagePort, 'addEventListener' | 'postMessage'
|
|
|
29
30
|
/**
|
|
30
31
|
* Message port can support [The structured clone algorithm](https://developer.mozilla.org/en-US/docs/Web/API/Web_Workers_API/Structured_clone_algorithm)
|
|
31
32
|
*/
|
|
32
|
-
type SupportedMessagePortData =
|
|
33
|
-
declare function postMessagePortMessage(port: SupportedMessagePort, data: SupportedMessagePortData): void;
|
|
33
|
+
type SupportedMessagePortData = any;
|
|
34
|
+
declare function postMessagePortMessage(port: SupportedMessagePort, data: SupportedMessagePortData, transfer?: any[]): void;
|
|
34
35
|
declare function onMessagePortMessage(port: SupportedMessagePort, callback: (data: SupportedMessagePortData) => void): void;
|
|
35
36
|
declare function onMessagePortClose(port: SupportedMessagePort, callback: () => void): void;
|
|
36
37
|
|
|
37
38
|
interface LinkMessagePortClientOptions {
|
|
38
39
|
port: SupportedMessagePort;
|
|
40
|
+
/**
|
|
41
|
+
* By default, oRPC serializes request/response messages to string/binary data before sending over message port.
|
|
42
|
+
* If needed, you can define the this option to utilize full power of [MessagePort: postMessage() method](https://developer.mozilla.org/en-US/docs/Web/API/MessagePort/postMessage),
|
|
43
|
+
* such as transferring ownership of objects to the other side or support unserializable objects like `OffscreenCanvas`.
|
|
44
|
+
*
|
|
45
|
+
* @remarks
|
|
46
|
+
* - return null | undefined to disable this feature
|
|
47
|
+
*
|
|
48
|
+
* @warning Make sure your message port supports `transfer` before using this feature.
|
|
49
|
+
* @example
|
|
50
|
+
* ```ts
|
|
51
|
+
* experimental_transfer: (message, port) => {
|
|
52
|
+
* const transfer = deepFindTransferableObjects(message) // implement your own logic
|
|
53
|
+
* return transfer.length ? transfer : null // only enable when needed
|
|
54
|
+
* }
|
|
55
|
+
* ```
|
|
56
|
+
*
|
|
57
|
+
* @see {@link https://orpc.unnoq.com/docs/adapters/message-port#transfer Message Port Transfer Docs}
|
|
58
|
+
*/
|
|
59
|
+
experimental_transfer?: Value<Promisable<object[] | null | undefined>, [message: DecodedRequestMessage, port: SupportedMessagePort]>;
|
|
39
60
|
}
|
|
40
61
|
declare class LinkMessagePortClient<T extends ClientContext> implements StandardLinkClient<T> {
|
|
41
62
|
private readonly peer;
|
|
@@ -1,8 +1,9 @@
|
|
|
1
|
+
import { Value, Promisable } from '@orpc/shared';
|
|
1
2
|
import { StandardRequest, StandardLazyResponse } from '@orpc/standard-server';
|
|
2
|
-
import {
|
|
3
|
-
import {
|
|
4
|
-
import { f as
|
|
5
|
-
import '
|
|
3
|
+
import { DecodedRequestMessage } from '@orpc/standard-server-peer';
|
|
4
|
+
import { b as ClientContext, c as ClientOptions } from '../../shared/client.BH1AYT_p.js';
|
|
5
|
+
import { f as StandardLinkClient } from '../../shared/client.De8SW4Kw.js';
|
|
6
|
+
import { f as StandardRPCLinkOptions, g as StandardRPCLink } from '../../shared/client.BxV-mzeR.js';
|
|
6
7
|
|
|
7
8
|
/**
|
|
8
9
|
* The message port used by electron in main process
|
|
@@ -11,7 +12,7 @@ interface MessagePortMainLike {
|
|
|
11
12
|
on: <T extends string>(event: T, callback: (event?: {
|
|
12
13
|
data: any;
|
|
13
14
|
}) => void) => void;
|
|
14
|
-
postMessage: (data: any) => void;
|
|
15
|
+
postMessage: (data: any, transfer?: any[]) => void;
|
|
15
16
|
}
|
|
16
17
|
/**
|
|
17
18
|
* The message port used by browser extension
|
|
@@ -29,13 +30,33 @@ type SupportedMessagePort = Pick<MessagePort, 'addEventListener' | 'postMessage'
|
|
|
29
30
|
/**
|
|
30
31
|
* Message port can support [The structured clone algorithm](https://developer.mozilla.org/en-US/docs/Web/API/Web_Workers_API/Structured_clone_algorithm)
|
|
31
32
|
*/
|
|
32
|
-
type SupportedMessagePortData =
|
|
33
|
-
declare function postMessagePortMessage(port: SupportedMessagePort, data: SupportedMessagePortData): void;
|
|
33
|
+
type SupportedMessagePortData = any;
|
|
34
|
+
declare function postMessagePortMessage(port: SupportedMessagePort, data: SupportedMessagePortData, transfer?: any[]): void;
|
|
34
35
|
declare function onMessagePortMessage(port: SupportedMessagePort, callback: (data: SupportedMessagePortData) => void): void;
|
|
35
36
|
declare function onMessagePortClose(port: SupportedMessagePort, callback: () => void): void;
|
|
36
37
|
|
|
37
38
|
interface LinkMessagePortClientOptions {
|
|
38
39
|
port: SupportedMessagePort;
|
|
40
|
+
/**
|
|
41
|
+
* By default, oRPC serializes request/response messages to string/binary data before sending over message port.
|
|
42
|
+
* If needed, you can define the this option to utilize full power of [MessagePort: postMessage() method](https://developer.mozilla.org/en-US/docs/Web/API/MessagePort/postMessage),
|
|
43
|
+
* such as transferring ownership of objects to the other side or support unserializable objects like `OffscreenCanvas`.
|
|
44
|
+
*
|
|
45
|
+
* @remarks
|
|
46
|
+
* - return null | undefined to disable this feature
|
|
47
|
+
*
|
|
48
|
+
* @warning Make sure your message port supports `transfer` before using this feature.
|
|
49
|
+
* @example
|
|
50
|
+
* ```ts
|
|
51
|
+
* experimental_transfer: (message, port) => {
|
|
52
|
+
* const transfer = deepFindTransferableObjects(message) // implement your own logic
|
|
53
|
+
* return transfer.length ? transfer : null // only enable when needed
|
|
54
|
+
* }
|
|
55
|
+
* ```
|
|
56
|
+
*
|
|
57
|
+
* @see {@link https://orpc.unnoq.com/docs/adapters/message-port#transfer Message Port Transfer Docs}
|
|
58
|
+
*/
|
|
59
|
+
experimental_transfer?: Value<Promisable<object[] | null | undefined>, [message: DecodedRequestMessage, port: SupportedMessagePort]>;
|
|
39
60
|
}
|
|
40
61
|
declare class LinkMessagePortClient<T extends ClientContext> implements StandardLinkClient<T> {
|
|
41
62
|
private readonly peer;
|
|
@@ -1,12 +1,17 @@
|
|
|
1
|
-
import {
|
|
2
|
-
import '@orpc/
|
|
3
|
-
import { c as StandardRPCLink } from '../../shared/client.
|
|
1
|
+
import { value, isObject } from '@orpc/shared';
|
|
2
|
+
import { experimental_ClientPeerWithoutCodec, serializeRequestMessage, encodeRequestMessage, deserializeResponseMessage, decodeResponseMessage } from '@orpc/standard-server-peer';
|
|
3
|
+
import { c as StandardRPCLink } from '../../shared/client.zO0fOJ2v.mjs';
|
|
4
4
|
import '@orpc/standard-server';
|
|
5
|
+
import '../../shared/client.qjMxHNL-.mjs';
|
|
5
6
|
import '@orpc/standard-server-fetch';
|
|
6
|
-
import '../../shared/client.
|
|
7
|
+
import '../../shared/client.BLtwTQUg.mjs';
|
|
7
8
|
|
|
8
|
-
function postMessagePortMessage(port, data) {
|
|
9
|
-
|
|
9
|
+
function postMessagePortMessage(port, data, transfer) {
|
|
10
|
+
if (transfer) {
|
|
11
|
+
port.postMessage(data, transfer);
|
|
12
|
+
} else {
|
|
13
|
+
port.postMessage(data);
|
|
14
|
+
}
|
|
10
15
|
}
|
|
11
16
|
function onMessagePortMessage(port, callback) {
|
|
12
17
|
if ("addEventListener" in port) {
|
|
@@ -46,11 +51,21 @@ function onMessagePortClose(port, callback) {
|
|
|
46
51
|
class LinkMessagePortClient {
|
|
47
52
|
peer;
|
|
48
53
|
constructor(options) {
|
|
49
|
-
this.peer = new
|
|
50
|
-
|
|
54
|
+
this.peer = new experimental_ClientPeerWithoutCodec(async (message) => {
|
|
55
|
+
const [id, type, payload] = message;
|
|
56
|
+
const transfer = await value(options.experimental_transfer, message, options.port);
|
|
57
|
+
if (transfer) {
|
|
58
|
+
postMessagePortMessage(options.port, serializeRequestMessage(id, type, payload), transfer);
|
|
59
|
+
} else {
|
|
60
|
+
postMessagePortMessage(options.port, await encodeRequestMessage(id, type, payload));
|
|
61
|
+
}
|
|
51
62
|
});
|
|
52
63
|
onMessagePortMessage(options.port, async (message) => {
|
|
53
|
-
|
|
64
|
+
if (isObject(message)) {
|
|
65
|
+
await this.peer.message(deserializeResponseMessage(message));
|
|
66
|
+
} else {
|
|
67
|
+
await this.peer.message(await decodeResponseMessage(message));
|
|
68
|
+
}
|
|
54
69
|
});
|
|
55
70
|
onMessagePortClose(options.port, () => {
|
|
56
71
|
this.peer.close();
|
|
@@ -65,7 +80,7 @@ class LinkMessagePortClient {
|
|
|
65
80
|
class RPCLink extends StandardRPCLink {
|
|
66
81
|
constructor(options) {
|
|
67
82
|
const linkClient = new LinkMessagePortClient(options);
|
|
68
|
-
super(linkClient, { ...options, url: "orpc
|
|
83
|
+
super(linkClient, { ...options, url: "orpc://localhost" });
|
|
69
84
|
}
|
|
70
85
|
}
|
|
71
86
|
|
|
@@ -1,7 +1,7 @@
|
|
|
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.
|
|
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.CPgZaUox.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.D8lMmWVC.mjs';
|
|
3
3
|
import { StandardHeaders } from '@orpc/standard-server';
|
|
4
|
-
import { H as HTTPPath } from '../../shared/client.
|
|
4
|
+
import { H as HTTPPath } from '../../shared/client.BH1AYT_p.mjs';
|
|
5
5
|
import '@orpc/shared';
|
|
6
6
|
|
|
7
7
|
declare function toHttpPath(path: readonly string[]): HTTPPath;
|
|
@@ -1,7 +1,7 @@
|
|
|
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.
|
|
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.De8SW4Kw.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.BxV-mzeR.js';
|
|
3
3
|
import { StandardHeaders } from '@orpc/standard-server';
|
|
4
|
-
import { H as HTTPPath } from '../../shared/client.
|
|
4
|
+
import { H as HTTPPath } from '../../shared/client.BH1AYT_p.js';
|
|
5
5
|
import '@orpc/shared';
|
|
6
6
|
|
|
7
7
|
declare function toHttpPath(path: readonly string[]): HTTPPath;
|
|
@@ -1,5 +1,6 @@
|
|
|
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, f as toStandardHeaders } from '../../shared/client.
|
|
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, f as toStandardHeaders } from '../../shared/client.zO0fOJ2v.mjs';
|
|
2
2
|
import '@orpc/shared';
|
|
3
3
|
import '@orpc/standard-server';
|
|
4
|
-
import '../../shared/client.
|
|
4
|
+
import '../../shared/client.qjMxHNL-.mjs';
|
|
5
5
|
import '@orpc/standard-server-fetch';
|
|
6
|
+
import '../../shared/client.BLtwTQUg.mjs';
|
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
import { StandardRequest, StandardLazyResponse } from '@orpc/standard-server';
|
|
2
|
-
import { b as ClientContext, c as ClientOptions } from '../../shared/client.
|
|
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.BH1AYT_p.mjs';
|
|
3
|
+
import { f as StandardLinkClient } from '../../shared/client.CPgZaUox.mjs';
|
|
4
|
+
import { f as StandardRPCLinkOptions, g as StandardRPCLink } from '../../shared/client.D8lMmWVC.mjs';
|
|
5
5
|
import '@orpc/shared';
|
|
6
6
|
|
|
7
7
|
interface LinkWebsocketClientOptions {
|
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
import { StandardRequest, StandardLazyResponse } from '@orpc/standard-server';
|
|
2
|
-
import { b as ClientContext, c as ClientOptions } from '../../shared/client.
|
|
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.BH1AYT_p.js';
|
|
3
|
+
import { f as StandardLinkClient } from '../../shared/client.De8SW4Kw.js';
|
|
4
|
+
import { f as StandardRPCLinkOptions, g as StandardRPCLink } from '../../shared/client.BxV-mzeR.js';
|
|
5
5
|
import '@orpc/shared';
|
|
6
6
|
|
|
7
7
|
interface LinkWebsocketClientOptions {
|
|
@@ -1,9 +1,10 @@
|
|
|
1
1
|
import { readAsBuffer } from '@orpc/shared';
|
|
2
2
|
import { ClientPeer } from '@orpc/standard-server-peer';
|
|
3
|
-
import { c as StandardRPCLink } from '../../shared/client.
|
|
3
|
+
import { c as StandardRPCLink } from '../../shared/client.zO0fOJ2v.mjs';
|
|
4
4
|
import '@orpc/standard-server';
|
|
5
|
+
import '../../shared/client.qjMxHNL-.mjs';
|
|
5
6
|
import '@orpc/standard-server-fetch';
|
|
6
|
-
import '../../shared/client.
|
|
7
|
+
import '../../shared/client.BLtwTQUg.mjs';
|
|
7
8
|
|
|
8
9
|
const WEBSOCKET_CONNECTING = 0;
|
|
9
10
|
class LinkWebsocketClient {
|
|
@@ -39,7 +40,7 @@ class LinkWebsocketClient {
|
|
|
39
40
|
class RPCLink extends StandardRPCLink {
|
|
40
41
|
constructor(options) {
|
|
41
42
|
const linkClient = new LinkWebsocketClient(options);
|
|
42
|
-
super(linkClient, { ...options, url: "orpc
|
|
43
|
+
super(linkClient, { ...options, url: "orpc://localhost" });
|
|
43
44
|
}
|
|
44
45
|
}
|
|
45
46
|
|
package/dist/index.d.mts
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
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.
|
|
2
|
-
export { f as HTTPMethod, H as HTTPPath } from './shared/client.
|
|
3
|
-
import { MaybeOptionalOptions, ThrowableError, Promisable, AsyncIteratorClass } from '@orpc/shared';
|
|
4
|
-
export { AsyncIteratorClass, EventPublisher, EventPublisherOptions, EventPublisherSubscribeIteratorOptions, Registry, ThrowableError, asyncIteratorToStream as eventIteratorToStream, onError, onFinish, onStart, onSuccess, streamToAsyncIteratorClass as streamToEventIterator } from '@orpc/shared';
|
|
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.BH1AYT_p.mjs';
|
|
2
|
+
export { f as HTTPMethod, H as HTTPPath, h as InferClientBodyInputs, j as InferClientBodyOutputs, l as InferClientErrorUnion, k as InferClientErrors, g as InferClientInputs, i as InferClientOutputs } from './shared/client.BH1AYT_p.mjs';
|
|
3
|
+
import { MaybeOptionalOptions, ThrowableError, OnFinishState, Promisable, AsyncIteratorClass } from '@orpc/shared';
|
|
4
|
+
export { AsyncIteratorClass, EventPublisher, EventPublisherOptions, EventPublisherSubscribeIteratorOptions, Registry, ThrowableError, asyncIteratorToStream as eventIteratorToStream, asyncIteratorToUnproxiedDataStream as eventIteratorToUnproxiedDataStream, onError, onFinish, onStart, onSuccess, streamToAsyncIteratorClass as streamToEventIterator } from '@orpc/shared';
|
|
5
5
|
export { ErrorEvent } from '@orpc/standard-server';
|
|
6
6
|
|
|
7
7
|
interface createORPCClientOptions {
|
|
@@ -115,6 +115,19 @@ declare class ORPCError<TCode extends ORPCErrorCode, TData> extends Error {
|
|
|
115
115
|
readonly data: TData;
|
|
116
116
|
constructor(code: TCode, ...rest: MaybeOptionalOptions<ORPCErrorOptions<TData>>);
|
|
117
117
|
toJSON(): ORPCErrorJSON<TCode, TData>;
|
|
118
|
+
/**
|
|
119
|
+
* Workaround for Next.js where different contexts use separate
|
|
120
|
+
* dependency graphs, causing multiple ORPCError constructors existing and breaking
|
|
121
|
+
* `instanceof` checks across contexts.
|
|
122
|
+
*
|
|
123
|
+
* This is particularly problematic with "Optimized SSR", where orpc-client
|
|
124
|
+
* executes in one context but is invoked from another. When an error is thrown
|
|
125
|
+
* in the execution context, `instanceof ORPCError` checks fail in the
|
|
126
|
+
* invocation context due to separate class constructors.
|
|
127
|
+
*
|
|
128
|
+
* @todo Remove this and related code if Next.js resolves the multiple dependency graph issue.
|
|
129
|
+
*/
|
|
130
|
+
static [Symbol.hasInstance](instance: unknown): boolean;
|
|
118
131
|
}
|
|
119
132
|
type ORPCErrorJSON<TCode extends string, TData> = Pick<ORPCError<TCode, TData>, 'defined' | 'code' | 'status' | 'message' | 'data'>;
|
|
120
133
|
declare function isDefinedError<T>(error: T): error is Extract<T, ORPCError<any, any>>;
|
|
@@ -147,6 +160,35 @@ type SafeResult<TOutput, TError> = [error: null, data: TOutput, isDefined: false
|
|
|
147
160
|
*/
|
|
148
161
|
declare function safe<TOutput, TError = ThrowableError>(promise: ClientPromiseResult<TOutput, TError>): Promise<SafeResult<TOutput, TError>>;
|
|
149
162
|
declare function resolveFriendlyClientOptions<T extends ClientContext>(options: FriendlyClientOptions<T>): ClientOptions<T>;
|
|
163
|
+
interface ConsumeEventIteratorOptions<T, TReturn, TError> {
|
|
164
|
+
/**
|
|
165
|
+
* Called on each event
|
|
166
|
+
*/
|
|
167
|
+
onEvent: (event: T) => void;
|
|
168
|
+
/**
|
|
169
|
+
* Called once error happens
|
|
170
|
+
*/
|
|
171
|
+
onError?: (error: TError) => void;
|
|
172
|
+
/**
|
|
173
|
+
* Called once event iterator is done
|
|
174
|
+
*
|
|
175
|
+
* @info If iterator is canceled, `undefined` can be passed on success
|
|
176
|
+
*/
|
|
177
|
+
onSuccess?: (value: TReturn | undefined) => void;
|
|
178
|
+
/**
|
|
179
|
+
* Called once after onError or onSuccess
|
|
180
|
+
*
|
|
181
|
+
* @info If iterator is canceled, `undefined` can be passed on success
|
|
182
|
+
*/
|
|
183
|
+
onFinish?: (state: OnFinishState<TReturn | undefined, TError>) => void;
|
|
184
|
+
}
|
|
185
|
+
/**
|
|
186
|
+
* Consumes an event iterator with lifecycle callbacks
|
|
187
|
+
*
|
|
188
|
+
* @warning If no `onError` or `onFinish` is provided, unhandled rejections will be thrown
|
|
189
|
+
* @return unsubscribe callback
|
|
190
|
+
*/
|
|
191
|
+
declare function consumeEventIterator<T, TReturn, TError = ThrowableError>(iterator: AsyncIterator<T, TReturn> | ClientPromiseResult<AsyncIterator<T, TReturn>, TError>, options: ConsumeEventIteratorOptions<T, TReturn, TError>): () => Promise<void>;
|
|
150
192
|
|
|
151
193
|
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
194
|
[K in keyof T]: T[K] extends NestedClient<any> ? SafeClient<T[K]> : never;
|
|
@@ -164,6 +206,9 @@ type SafeClient<T extends NestedClient<any>> = T extends Client<infer UContext,
|
|
|
164
206
|
*/
|
|
165
207
|
declare function createSafeClient<T extends NestedClient<any>>(client: T): SafeClient<T>;
|
|
166
208
|
|
|
209
|
+
declare const ORPC_CLIENT_PACKAGE_NAME = "@orpc/client";
|
|
210
|
+
declare const ORPC_CLIENT_PACKAGE_VERSION = "0.0.0-next.8dab177";
|
|
211
|
+
|
|
167
212
|
/**
|
|
168
213
|
* DynamicLink provides a way to dynamically resolve and delegate calls to other ClientLinks
|
|
169
214
|
* based on the request path, input, and context.
|
|
@@ -181,5 +226,5 @@ declare function mapEventIterator<TYield, TReturn, TNext, TMap = TYield | TRetur
|
|
|
181
226
|
error: (error: unknown) => Promise<unknown>;
|
|
182
227
|
}): AsyncIteratorClass<TMap, TMap, TNext>;
|
|
183
228
|
|
|
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 };
|
|
229
|
+
export { COMMON_ORPC_ERROR_DEFS, Client, ClientContext, ClientLink, ClientOptions, ClientPromiseResult, ClientRest, DynamicLink, FriendlyClientOptions, InferClientContext, NestedClient, ORPCError, ORPC_CLIENT_PACKAGE_NAME, ORPC_CLIENT_PACKAGE_VERSION, consumeEventIterator, createORPCClient, createORPCErrorFromJson, createSafeClient, fallbackORPCErrorMessage, fallbackORPCErrorStatus, isDefinedError, isORPCErrorJson, isORPCErrorStatus, mapEventIterator, resolveFriendlyClientOptions, safe, toORPCError };
|
|
230
|
+
export type { CommonORPCErrorCode, ConsumeEventIteratorOptions, ORPCErrorCode, ORPCErrorJSON, ORPCErrorOptions, SafeClient, SafeResult, createORPCClientOptions };
|
package/dist/index.d.ts
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
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.
|
|
2
|
-
export { f as HTTPMethod, H as HTTPPath } from './shared/client.
|
|
3
|
-
import { MaybeOptionalOptions, ThrowableError, Promisable, AsyncIteratorClass } from '@orpc/shared';
|
|
4
|
-
export { AsyncIteratorClass, EventPublisher, EventPublisherOptions, EventPublisherSubscribeIteratorOptions, Registry, ThrowableError, asyncIteratorToStream as eventIteratorToStream, onError, onFinish, onStart, onSuccess, streamToAsyncIteratorClass as streamToEventIterator } from '@orpc/shared';
|
|
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.BH1AYT_p.js';
|
|
2
|
+
export { f as HTTPMethod, H as HTTPPath, h as InferClientBodyInputs, j as InferClientBodyOutputs, l as InferClientErrorUnion, k as InferClientErrors, g as InferClientInputs, i as InferClientOutputs } from './shared/client.BH1AYT_p.js';
|
|
3
|
+
import { MaybeOptionalOptions, ThrowableError, OnFinishState, Promisable, AsyncIteratorClass } from '@orpc/shared';
|
|
4
|
+
export { AsyncIteratorClass, EventPublisher, EventPublisherOptions, EventPublisherSubscribeIteratorOptions, Registry, ThrowableError, asyncIteratorToStream as eventIteratorToStream, asyncIteratorToUnproxiedDataStream as eventIteratorToUnproxiedDataStream, onError, onFinish, onStart, onSuccess, streamToAsyncIteratorClass as streamToEventIterator } from '@orpc/shared';
|
|
5
5
|
export { ErrorEvent } from '@orpc/standard-server';
|
|
6
6
|
|
|
7
7
|
interface createORPCClientOptions {
|
|
@@ -115,6 +115,19 @@ declare class ORPCError<TCode extends ORPCErrorCode, TData> extends Error {
|
|
|
115
115
|
readonly data: TData;
|
|
116
116
|
constructor(code: TCode, ...rest: MaybeOptionalOptions<ORPCErrorOptions<TData>>);
|
|
117
117
|
toJSON(): ORPCErrorJSON<TCode, TData>;
|
|
118
|
+
/**
|
|
119
|
+
* Workaround for Next.js where different contexts use separate
|
|
120
|
+
* dependency graphs, causing multiple ORPCError constructors existing and breaking
|
|
121
|
+
* `instanceof` checks across contexts.
|
|
122
|
+
*
|
|
123
|
+
* This is particularly problematic with "Optimized SSR", where orpc-client
|
|
124
|
+
* executes in one context but is invoked from another. When an error is thrown
|
|
125
|
+
* in the execution context, `instanceof ORPCError` checks fail in the
|
|
126
|
+
* invocation context due to separate class constructors.
|
|
127
|
+
*
|
|
128
|
+
* @todo Remove this and related code if Next.js resolves the multiple dependency graph issue.
|
|
129
|
+
*/
|
|
130
|
+
static [Symbol.hasInstance](instance: unknown): boolean;
|
|
118
131
|
}
|
|
119
132
|
type ORPCErrorJSON<TCode extends string, TData> = Pick<ORPCError<TCode, TData>, 'defined' | 'code' | 'status' | 'message' | 'data'>;
|
|
120
133
|
declare function isDefinedError<T>(error: T): error is Extract<T, ORPCError<any, any>>;
|
|
@@ -147,6 +160,35 @@ type SafeResult<TOutput, TError> = [error: null, data: TOutput, isDefined: false
|
|
|
147
160
|
*/
|
|
148
161
|
declare function safe<TOutput, TError = ThrowableError>(promise: ClientPromiseResult<TOutput, TError>): Promise<SafeResult<TOutput, TError>>;
|
|
149
162
|
declare function resolveFriendlyClientOptions<T extends ClientContext>(options: FriendlyClientOptions<T>): ClientOptions<T>;
|
|
163
|
+
interface ConsumeEventIteratorOptions<T, TReturn, TError> {
|
|
164
|
+
/**
|
|
165
|
+
* Called on each event
|
|
166
|
+
*/
|
|
167
|
+
onEvent: (event: T) => void;
|
|
168
|
+
/**
|
|
169
|
+
* Called once error happens
|
|
170
|
+
*/
|
|
171
|
+
onError?: (error: TError) => void;
|
|
172
|
+
/**
|
|
173
|
+
* Called once event iterator is done
|
|
174
|
+
*
|
|
175
|
+
* @info If iterator is canceled, `undefined` can be passed on success
|
|
176
|
+
*/
|
|
177
|
+
onSuccess?: (value: TReturn | undefined) => void;
|
|
178
|
+
/**
|
|
179
|
+
* Called once after onError or onSuccess
|
|
180
|
+
*
|
|
181
|
+
* @info If iterator is canceled, `undefined` can be passed on success
|
|
182
|
+
*/
|
|
183
|
+
onFinish?: (state: OnFinishState<TReturn | undefined, TError>) => void;
|
|
184
|
+
}
|
|
185
|
+
/**
|
|
186
|
+
* Consumes an event iterator with lifecycle callbacks
|
|
187
|
+
*
|
|
188
|
+
* @warning If no `onError` or `onFinish` is provided, unhandled rejections will be thrown
|
|
189
|
+
* @return unsubscribe callback
|
|
190
|
+
*/
|
|
191
|
+
declare function consumeEventIterator<T, TReturn, TError = ThrowableError>(iterator: AsyncIterator<T, TReturn> | ClientPromiseResult<AsyncIterator<T, TReturn>, TError>, options: ConsumeEventIteratorOptions<T, TReturn, TError>): () => Promise<void>;
|
|
150
192
|
|
|
151
193
|
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
194
|
[K in keyof T]: T[K] extends NestedClient<any> ? SafeClient<T[K]> : never;
|
|
@@ -164,6 +206,9 @@ type SafeClient<T extends NestedClient<any>> = T extends Client<infer UContext,
|
|
|
164
206
|
*/
|
|
165
207
|
declare function createSafeClient<T extends NestedClient<any>>(client: T): SafeClient<T>;
|
|
166
208
|
|
|
209
|
+
declare const ORPC_CLIENT_PACKAGE_NAME = "@orpc/client";
|
|
210
|
+
declare const ORPC_CLIENT_PACKAGE_VERSION = "0.0.0-next.8dab177";
|
|
211
|
+
|
|
167
212
|
/**
|
|
168
213
|
* DynamicLink provides a way to dynamically resolve and delegate calls to other ClientLinks
|
|
169
214
|
* based on the request path, input, and context.
|
|
@@ -181,5 +226,5 @@ declare function mapEventIterator<TYield, TReturn, TNext, TMap = TYield | TRetur
|
|
|
181
226
|
error: (error: unknown) => Promise<unknown>;
|
|
182
227
|
}): AsyncIteratorClass<TMap, TMap, TNext>;
|
|
183
228
|
|
|
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 };
|
|
229
|
+
export { COMMON_ORPC_ERROR_DEFS, Client, ClientContext, ClientLink, ClientOptions, ClientPromiseResult, ClientRest, DynamicLink, FriendlyClientOptions, InferClientContext, NestedClient, ORPCError, ORPC_CLIENT_PACKAGE_NAME, ORPC_CLIENT_PACKAGE_VERSION, consumeEventIterator, createORPCClient, createORPCErrorFromJson, createSafeClient, fallbackORPCErrorMessage, fallbackORPCErrorStatus, isDefinedError, isORPCErrorJson, isORPCErrorStatus, mapEventIterator, resolveFriendlyClientOptions, safe, toORPCError };
|
|
230
|
+
export type { CommonORPCErrorCode, ConsumeEventIteratorOptions, ORPCErrorCode, ORPCErrorJSON, ORPCErrorOptions, SafeClient, SafeResult, createORPCClientOptions };
|
package/dist/index.mjs
CHANGED
|
@@ -1,7 +1,8 @@
|
|
|
1
1
|
import { preventNativeAwait, isTypescriptObject } from '@orpc/shared';
|
|
2
|
-
export { AsyncIteratorClass, EventPublisher, asyncIteratorToStream as eventIteratorToStream, onError, onFinish, onStart, onSuccess, streamToAsyncIteratorClass as streamToEventIterator } from '@orpc/shared';
|
|
3
|
-
import { i as isDefinedError } from './shared/client.
|
|
4
|
-
export { C as COMMON_ORPC_ERROR_DEFS,
|
|
2
|
+
export { AsyncIteratorClass, EventPublisher, asyncIteratorToStream as eventIteratorToStream, asyncIteratorToUnproxiedDataStream as eventIteratorToUnproxiedDataStream, onError, onFinish, onStart, onSuccess, streamToAsyncIteratorClass as streamToEventIterator } from '@orpc/shared';
|
|
3
|
+
import { i as isDefinedError } from './shared/client.qjMxHNL-.mjs';
|
|
4
|
+
export { C as COMMON_ORPC_ERROR_DEFS, c as ORPCError, O as ORPC_CLIENT_PACKAGE_NAME, a as ORPC_CLIENT_PACKAGE_VERSION, g as createORPCErrorFromJson, b as fallbackORPCErrorMessage, f as fallbackORPCErrorStatus, e as isORPCErrorJson, d as isORPCErrorStatus, t as toORPCError } from './shared/client.qjMxHNL-.mjs';
|
|
5
|
+
export { m as mapEventIterator } from './shared/client.BLtwTQUg.mjs';
|
|
5
6
|
export { ErrorEvent } from '@orpc/standard-server';
|
|
6
7
|
|
|
7
8
|
async function safe(promise) {
|
|
@@ -32,6 +33,35 @@ function resolveFriendlyClientOptions(options) {
|
|
|
32
33
|
// Context only optional if all fields are optional
|
|
33
34
|
};
|
|
34
35
|
}
|
|
36
|
+
function consumeEventIterator(iterator, options) {
|
|
37
|
+
void (async () => {
|
|
38
|
+
let onFinishState;
|
|
39
|
+
try {
|
|
40
|
+
const resolvedIterator = await iterator;
|
|
41
|
+
while (true) {
|
|
42
|
+
const { done, value } = await resolvedIterator.next();
|
|
43
|
+
if (done) {
|
|
44
|
+
const realValue = value;
|
|
45
|
+
onFinishState = [null, realValue, true];
|
|
46
|
+
options.onSuccess?.(realValue);
|
|
47
|
+
break;
|
|
48
|
+
}
|
|
49
|
+
options.onEvent(value);
|
|
50
|
+
}
|
|
51
|
+
} catch (error) {
|
|
52
|
+
onFinishState = [error, void 0, false];
|
|
53
|
+
if (!options.onError && !options.onFinish) {
|
|
54
|
+
throw error;
|
|
55
|
+
}
|
|
56
|
+
options.onError?.(error);
|
|
57
|
+
} finally {
|
|
58
|
+
options.onFinish?.(onFinishState);
|
|
59
|
+
}
|
|
60
|
+
})();
|
|
61
|
+
return async () => {
|
|
62
|
+
await (await iterator)?.return?.();
|
|
63
|
+
};
|
|
64
|
+
}
|
|
35
65
|
|
|
36
66
|
function createORPCClient(link, options = {}) {
|
|
37
67
|
const path = options.path ?? [];
|
|
@@ -79,4 +109,4 @@ class DynamicLink {
|
|
|
79
109
|
}
|
|
80
110
|
}
|
|
81
111
|
|
|
82
|
-
export { DynamicLink, createORPCClient, createSafeClient, isDefinedError, resolveFriendlyClientOptions, safe };
|
|
112
|
+
export { DynamicLink, consumeEventIterator, 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
|
-
import { StandardHeaders, StandardRequest } from '@orpc/standard-server';
|
|
2
|
+
import { StandardHeaders, StandardRequest, StandardLazyResponse } 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 { b as ClientContext } from '../shared/client.
|
|
4
|
+
import { S as StandardLinkClientInterceptorOptions, a as StandardLinkPlugin, b as StandardLinkOptions, c as StandardLinkInterceptorOptions } from '../shared/client.CPgZaUox.mjs';
|
|
5
|
+
import { b as ClientContext } from '../shared/client.BH1AYT_p.mjs';
|
|
6
6
|
|
|
7
7
|
interface BatchLinkPluginGroup<T extends ClientContext> {
|
|
8
8
|
condition(options: StandardLinkClientInterceptorOptions<T>): boolean;
|
|
@@ -157,10 +157,57 @@ declare class ClientRetryPlugin<T extends ClientRetryPluginContext> implements S
|
|
|
157
157
|
private readonly defaultRetryDelay;
|
|
158
158
|
private readonly defaultShouldRetry;
|
|
159
159
|
private readonly defaultOnRetry;
|
|
160
|
+
order: number;
|
|
160
161
|
constructor(options?: ClientRetryPluginOptions);
|
|
161
162
|
init(options: StandardLinkOptions<T>): void;
|
|
162
163
|
}
|
|
163
164
|
|
|
165
|
+
interface RetryAfterPluginOptions<T extends ClientContext> {
|
|
166
|
+
/**
|
|
167
|
+
* Override condition to determine whether to retry or not.
|
|
168
|
+
*
|
|
169
|
+
* @default ((response) => response.status === 429 || response.status === 503)
|
|
170
|
+
*/
|
|
171
|
+
condition?: Value<boolean, [
|
|
172
|
+
response: StandardLazyResponse,
|
|
173
|
+
options: StandardLinkClientInterceptorOptions<T>
|
|
174
|
+
]>;
|
|
175
|
+
/**
|
|
176
|
+
* Maximum attempts before giving up retries.
|
|
177
|
+
*
|
|
178
|
+
* @default 3
|
|
179
|
+
*/
|
|
180
|
+
maxAttempts?: Value<number, [
|
|
181
|
+
response: StandardLazyResponse,
|
|
182
|
+
options: StandardLinkClientInterceptorOptions<T>
|
|
183
|
+
]>;
|
|
184
|
+
/**
|
|
185
|
+
* Maximum timeout in milliseconds to wait before giving up retries.
|
|
186
|
+
*
|
|
187
|
+
* @default 5 * 60 * 1000 (5 minutes)
|
|
188
|
+
*/
|
|
189
|
+
timeout?: Value<number, [
|
|
190
|
+
response: StandardLazyResponse,
|
|
191
|
+
options: StandardLinkClientInterceptorOptions<T>
|
|
192
|
+
]>;
|
|
193
|
+
}
|
|
194
|
+
/**
|
|
195
|
+
* The Retry After Plugin automatically retries requests based on server `Retry-After` headers.
|
|
196
|
+
* This is particularly useful for handling rate limiting and temporary server unavailability.
|
|
197
|
+
*
|
|
198
|
+
* @see {@link https://orpc.unnoq.com/docs/plugins/retry-after Retry After Plugin Docs}
|
|
199
|
+
*/
|
|
200
|
+
declare class RetryAfterPlugin<T extends ClientContext> implements StandardLinkPlugin<T> {
|
|
201
|
+
private readonly condition;
|
|
202
|
+
private readonly maxAttempts;
|
|
203
|
+
private readonly timeout;
|
|
204
|
+
order: number;
|
|
205
|
+
constructor(options?: RetryAfterPluginOptions<T>);
|
|
206
|
+
init(options: StandardLinkOptions<T>): void;
|
|
207
|
+
private parseRetryAfterHeader;
|
|
208
|
+
private delayExecution;
|
|
209
|
+
}
|
|
210
|
+
|
|
164
211
|
interface SimpleCsrfProtectionLinkPluginOptions<T extends ClientContext> {
|
|
165
212
|
/**
|
|
166
213
|
* The name of the header to check.
|
|
@@ -198,5 +245,5 @@ declare class SimpleCsrfProtectionLinkPlugin<T extends ClientContext> implements
|
|
|
198
245
|
init(options: StandardLinkOptions<T>): void;
|
|
199
246
|
}
|
|
200
247
|
|
|
201
|
-
export { BatchLinkPlugin, ClientRetryPlugin, ClientRetryPluginInvalidEventIteratorRetryResponse, DedupeRequestsPlugin, SimpleCsrfProtectionLinkPlugin };
|
|
202
|
-
export type { BatchLinkPluginGroup, BatchLinkPluginOptions, ClientRetryPluginAttemptOptions, ClientRetryPluginContext, ClientRetryPluginOptions, DedupeRequestsPluginGroup, DedupeRequestsPluginOptions, SimpleCsrfProtectionLinkPluginOptions };
|
|
248
|
+
export { BatchLinkPlugin, ClientRetryPlugin, ClientRetryPluginInvalidEventIteratorRetryResponse, DedupeRequestsPlugin, RetryAfterPlugin, SimpleCsrfProtectionLinkPlugin };
|
|
249
|
+
export type { BatchLinkPluginGroup, BatchLinkPluginOptions, ClientRetryPluginAttemptOptions, ClientRetryPluginContext, ClientRetryPluginOptions, DedupeRequestsPluginGroup, DedupeRequestsPluginOptions, RetryAfterPluginOptions, SimpleCsrfProtectionLinkPluginOptions };
|