@orpc/client 0.0.0-next.7a6598d → 0.0.0-next.7b151dd
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 +7 -7
- 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 -3
- package/dist/adapters/message-port/index.d.mts +59 -0
- package/dist/adapters/message-port/index.d.ts +59 -0
- package/dist/adapters/message-port/index.mjs +71 -0
- package/dist/adapters/standard/index.d.mts +3 -3
- package/dist/adapters/standard/index.d.ts +3 -3
- package/dist/adapters/standard/index.mjs +2 -2
- package/dist/adapters/websocket/index.d.mts +29 -0
- package/dist/adapters/websocket/index.d.ts +29 -0
- package/dist/adapters/websocket/index.mjs +45 -0
- package/dist/index.d.mts +41 -25
- package/dist/index.d.ts +41 -25
- package/dist/index.mjs +24 -7
- package/dist/plugins/index.d.mts +57 -17
- package/dist/plugins/index.d.ts +57 -17
- package/dist/plugins/index.mjs +125 -16
- package/dist/shared/{client.DpICn1BD.mjs → client.B7Wgunl_.mjs} +47 -15
- package/dist/shared/{client.C9U9n1f3.d.ts → client.BG98rYdO.d.ts} +4 -5
- package/dist/shared/{client.CipPQkhk.d.mts → client.BOYsZIRq.d.mts} +2 -2
- package/dist/shared/{client.CipPQkhk.d.ts → client.BOYsZIRq.d.ts} +2 -2
- package/dist/shared/{client.CRWEpqLB.mjs → client.BngOL3Ai.mjs} +29 -31
- package/dist/shared/{client.FXep-a3a.d.mts → client.Bwgm6dgk.d.mts} +4 -5
- package/dist/shared/{client.8TjrVhkC.d.ts → client.C176log5.d.ts} +8 -8
- package/dist/shared/{client.BjJBZryq.d.mts → client.Ycwr4Tuo.d.mts} +8 -8
- package/package.json +16 -5
package/dist/index.mjs
CHANGED
|
@@ -1,6 +1,7 @@
|
|
|
1
|
-
import { i as isDefinedError } from './shared/client.
|
|
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.
|
|
3
|
-
|
|
1
|
+
import { i as isDefinedError } from './shared/client.BngOL3Ai.mjs';
|
|
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.BngOL3Ai.mjs';
|
|
3
|
+
import { isTypescriptObject } from '@orpc/shared';
|
|
4
|
+
export { AsyncIteratorClass, EventPublisher, asyncIteratorToStream as eventIteratorToStream, onError, onFinish, onStart, onSuccess, streamToAsyncIteratorClass as streamToEventIterator } from '@orpc/shared';
|
|
4
5
|
export { ErrorEvent } from '@orpc/standard-server';
|
|
5
6
|
|
|
6
7
|
async function safe(promise) {
|
|
@@ -27,13 +28,13 @@ async function safe(promise) {
|
|
|
27
28
|
function resolveFriendlyClientOptions(options) {
|
|
28
29
|
return {
|
|
29
30
|
...options,
|
|
30
|
-
context: options
|
|
31
|
+
context: options.context ?? {}
|
|
31
32
|
// Context only optional if all fields are optional
|
|
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,7 +1,8 @@
|
|
|
1
|
-
import { Value } from '@orpc/shared';
|
|
1
|
+
import { Value, Promisable } from '@orpc/shared';
|
|
2
2
|
import { StandardHeaders, StandardRequest } from '@orpc/standard-server';
|
|
3
|
-
import {
|
|
4
|
-
import { a as
|
|
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.Bwgm6dgk.mjs';
|
|
5
|
+
import { b as ClientContext } from '../shared/client.BOYsZIRq.mjs';
|
|
5
6
|
|
|
6
7
|
interface BatchLinkPluginGroup<T extends ClientContext> {
|
|
7
8
|
condition(options: StandardLinkClientInterceptorOptions<T>): boolean;
|
|
@@ -16,25 +17,31 @@ interface BatchLinkPluginOptions<T extends ClientContext> {
|
|
|
16
17
|
*
|
|
17
18
|
* @default 10
|
|
18
19
|
*/
|
|
19
|
-
maxSize?: Value<number
|
|
20
|
+
maxSize?: Value<Promisable<number>, [readonly [StandardLinkClientInterceptorOptions<T>, ...StandardLinkClientInterceptorOptions<T>[]]]>;
|
|
21
|
+
/**
|
|
22
|
+
* The batch response mode.
|
|
23
|
+
*
|
|
24
|
+
* @default 'streaming'
|
|
25
|
+
*/
|
|
26
|
+
mode?: Value<BatchResponseMode, [readonly [StandardLinkClientInterceptorOptions<T>, ...StandardLinkClientInterceptorOptions<T>[]]]>;
|
|
20
27
|
/**
|
|
21
28
|
* Defines the URL to use for the batch request.
|
|
22
29
|
*
|
|
23
30
|
* @default the URL of the first request in the batch + '/__batch__'
|
|
24
31
|
*/
|
|
25
|
-
url?: Value<string | URL
|
|
32
|
+
url?: Value<Promisable<string | URL>, [readonly [StandardLinkClientInterceptorOptions<T>, ...StandardLinkClientInterceptorOptions<T>[]]]>;
|
|
26
33
|
/**
|
|
27
34
|
* The maximum length of the URL.
|
|
28
35
|
*
|
|
29
36
|
* @default 2083
|
|
30
37
|
*/
|
|
31
|
-
maxUrlLength?: Value<number
|
|
38
|
+
maxUrlLength?: Value<Promisable<number>, [readonly [StandardLinkClientInterceptorOptions<T>, ...StandardLinkClientInterceptorOptions<T>[]]]>;
|
|
32
39
|
/**
|
|
33
40
|
* Defines the HTTP headers to use for the batch request.
|
|
34
41
|
*
|
|
35
42
|
* @default The same headers of all requests in the batch
|
|
36
43
|
*/
|
|
37
|
-
headers?: Value<StandardHeaders
|
|
44
|
+
headers?: Value<Promisable<StandardHeaders>, [readonly [StandardLinkClientInterceptorOptions<T>, ...StandardLinkClientInterceptorOptions<T>[]]]>;
|
|
38
45
|
/**
|
|
39
46
|
* Map the batch request items before sending them.
|
|
40
47
|
*
|
|
@@ -52,10 +59,10 @@ interface BatchLinkPluginOptions<T extends ClientContext> {
|
|
|
52
59
|
exclude?: (options: StandardLinkClientInterceptorOptions<T>) => boolean;
|
|
53
60
|
}
|
|
54
61
|
/**
|
|
55
|
-
* The Batch
|
|
62
|
+
* The Batch Requests Plugin allows you to combine multiple requests and responses into a single batch,
|
|
56
63
|
* reducing the overhead of sending each one separately.
|
|
57
64
|
*
|
|
58
|
-
* @see {@link https://orpc.unnoq.com/docs/plugins/batch-
|
|
65
|
+
* @see {@link https://orpc.unnoq.com/docs/plugins/batch-requests Batch Requests Plugin Docs}
|
|
59
66
|
*/
|
|
60
67
|
declare class BatchLinkPlugin<T extends ClientContext> implements StandardLinkPlugin<T> {
|
|
61
68
|
#private;
|
|
@@ -66,12 +73,45 @@ declare class BatchLinkPlugin<T extends ClientContext> implements StandardLinkPl
|
|
|
66
73
|
private readonly batchHeaders;
|
|
67
74
|
private readonly mapRequestItem;
|
|
68
75
|
private readonly exclude;
|
|
76
|
+
private readonly mode;
|
|
69
77
|
private pending;
|
|
70
78
|
order: number;
|
|
71
79
|
constructor(options: NoInfer<BatchLinkPluginOptions<T>>);
|
|
72
80
|
init(options: StandardLinkOptions<T>): void;
|
|
73
81
|
}
|
|
74
82
|
|
|
83
|
+
interface DedupeRequestsPluginGroup<T extends ClientContext> {
|
|
84
|
+
condition(options: StandardLinkClientInterceptorOptions<T>): boolean;
|
|
85
|
+
/**
|
|
86
|
+
* The context used for the rest of the request lifecycle.
|
|
87
|
+
*/
|
|
88
|
+
context: T;
|
|
89
|
+
}
|
|
90
|
+
interface DedupeRequestsPluginOptions<T extends ClientContext> {
|
|
91
|
+
/**
|
|
92
|
+
* To enable deduplication, a request must match at least one defined group.
|
|
93
|
+
* Requests that fall into the same group are considered for deduplication together.
|
|
94
|
+
*/
|
|
95
|
+
groups: readonly [DedupeRequestsPluginGroup<T>, ...DedupeRequestsPluginGroup<T>[]];
|
|
96
|
+
/**
|
|
97
|
+
* Filters requests to dedupe
|
|
98
|
+
*
|
|
99
|
+
* @default (({ request }) => request.method === 'GET')
|
|
100
|
+
*/
|
|
101
|
+
filter?: (options: StandardLinkClientInterceptorOptions<T>) => boolean;
|
|
102
|
+
}
|
|
103
|
+
/**
|
|
104
|
+
* Prevents duplicate requests by deduplicating similar ones to reduce server load.
|
|
105
|
+
*
|
|
106
|
+
* @see {@link https://orpc.unnoq.com/docs/plugins/dedupe-requests Dedupe Requests Plugin}
|
|
107
|
+
*/
|
|
108
|
+
declare class DedupeRequestsPlugin<T extends ClientContext> implements StandardLinkPlugin<T> {
|
|
109
|
+
#private;
|
|
110
|
+
order: number;
|
|
111
|
+
constructor(options: NoInfer<DedupeRequestsPluginOptions<T>>);
|
|
112
|
+
init(options: StandardLinkOptions<T>): void;
|
|
113
|
+
}
|
|
114
|
+
|
|
75
115
|
interface ClientRetryPluginAttemptOptions<T extends ClientContext> extends StandardLinkInterceptorOptions<T> {
|
|
76
116
|
lastEventRetry: number | undefined;
|
|
77
117
|
attemptIndex: number;
|
|
@@ -84,19 +124,19 @@ interface ClientRetryPluginContext {
|
|
|
84
124
|
*
|
|
85
125
|
* @default 0
|
|
86
126
|
*/
|
|
87
|
-
retry?: Value<number
|
|
127
|
+
retry?: Value<Promisable<number>, [StandardLinkInterceptorOptions<ClientRetryPluginContext>]>;
|
|
88
128
|
/**
|
|
89
129
|
* Delay (in ms) before retrying.
|
|
90
130
|
*
|
|
91
131
|
* @default (o) => o.lastEventRetry ?? 2000
|
|
92
132
|
*/
|
|
93
|
-
retryDelay?: Value<number
|
|
133
|
+
retryDelay?: Value<Promisable<number>, [ClientRetryPluginAttemptOptions<ClientRetryPluginContext>]>;
|
|
94
134
|
/**
|
|
95
135
|
* Determine should retry or not.
|
|
96
136
|
*
|
|
97
137
|
* @default true
|
|
98
138
|
*/
|
|
99
|
-
shouldRetry?: Value<boolean
|
|
139
|
+
shouldRetry?: Value<Promisable<boolean>, [ClientRetryPluginAttemptOptions<ClientRetryPluginContext>]>;
|
|
100
140
|
/**
|
|
101
141
|
* The hook called when retrying, and return the unsubscribe function.
|
|
102
142
|
*/
|
|
@@ -127,20 +167,20 @@ interface SimpleCsrfProtectionLinkPluginOptions<T extends ClientContext> {
|
|
|
127
167
|
*
|
|
128
168
|
* @default 'x-csrf-token'
|
|
129
169
|
*/
|
|
130
|
-
headerName?: Value<string
|
|
170
|
+
headerName?: Value<Promisable<string>, [options: StandardLinkClientInterceptorOptions<T>]>;
|
|
131
171
|
/**
|
|
132
172
|
* The value of the header to check.
|
|
133
173
|
*
|
|
134
174
|
* @default 'orpc'
|
|
135
175
|
*
|
|
136
176
|
*/
|
|
137
|
-
headerValue?: Value<string
|
|
177
|
+
headerValue?: Value<Promisable<string>, [options: StandardLinkClientInterceptorOptions<T>]>;
|
|
138
178
|
/**
|
|
139
179
|
* Exclude a procedure from the plugin.
|
|
140
180
|
*
|
|
141
181
|
* @default false
|
|
142
182
|
*/
|
|
143
|
-
exclude?: Value<boolean
|
|
183
|
+
exclude?: Value<Promisable<boolean>, [options: StandardLinkClientInterceptorOptions<T>]>;
|
|
144
184
|
}
|
|
145
185
|
/**
|
|
146
186
|
* This plugin adds basic Cross-Site Request Forgery (CSRF) protection to your oRPC application.
|
|
@@ -158,5 +198,5 @@ declare class SimpleCsrfProtectionLinkPlugin<T extends ClientContext> implements
|
|
|
158
198
|
init(options: StandardLinkOptions<T>): void;
|
|
159
199
|
}
|
|
160
200
|
|
|
161
|
-
export { BatchLinkPlugin, ClientRetryPlugin, ClientRetryPluginInvalidEventIteratorRetryResponse, SimpleCsrfProtectionLinkPlugin };
|
|
162
|
-
export type { BatchLinkPluginGroup, BatchLinkPluginOptions, ClientRetryPluginAttemptOptions, ClientRetryPluginContext, ClientRetryPluginOptions, SimpleCsrfProtectionLinkPluginOptions };
|
|
201
|
+
export { BatchLinkPlugin, ClientRetryPlugin, ClientRetryPluginInvalidEventIteratorRetryResponse, DedupeRequestsPlugin, SimpleCsrfProtectionLinkPlugin };
|
|
202
|
+
export type { BatchLinkPluginGroup, BatchLinkPluginOptions, ClientRetryPluginAttemptOptions, ClientRetryPluginContext, ClientRetryPluginOptions, DedupeRequestsPluginGroup, DedupeRequestsPluginOptions, SimpleCsrfProtectionLinkPluginOptions };
|
package/dist/plugins/index.d.ts
CHANGED
|
@@ -1,7 +1,8 @@
|
|
|
1
|
-
import { Value } from '@orpc/shared';
|
|
1
|
+
import { Value, Promisable } from '@orpc/shared';
|
|
2
2
|
import { StandardHeaders, StandardRequest } from '@orpc/standard-server';
|
|
3
|
-
import {
|
|
4
|
-
import { a as
|
|
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.BG98rYdO.js';
|
|
5
|
+
import { b as ClientContext } from '../shared/client.BOYsZIRq.js';
|
|
5
6
|
|
|
6
7
|
interface BatchLinkPluginGroup<T extends ClientContext> {
|
|
7
8
|
condition(options: StandardLinkClientInterceptorOptions<T>): boolean;
|
|
@@ -16,25 +17,31 @@ interface BatchLinkPluginOptions<T extends ClientContext> {
|
|
|
16
17
|
*
|
|
17
18
|
* @default 10
|
|
18
19
|
*/
|
|
19
|
-
maxSize?: Value<number
|
|
20
|
+
maxSize?: Value<Promisable<number>, [readonly [StandardLinkClientInterceptorOptions<T>, ...StandardLinkClientInterceptorOptions<T>[]]]>;
|
|
21
|
+
/**
|
|
22
|
+
* The batch response mode.
|
|
23
|
+
*
|
|
24
|
+
* @default 'streaming'
|
|
25
|
+
*/
|
|
26
|
+
mode?: Value<BatchResponseMode, [readonly [StandardLinkClientInterceptorOptions<T>, ...StandardLinkClientInterceptorOptions<T>[]]]>;
|
|
20
27
|
/**
|
|
21
28
|
* Defines the URL to use for the batch request.
|
|
22
29
|
*
|
|
23
30
|
* @default the URL of the first request in the batch + '/__batch__'
|
|
24
31
|
*/
|
|
25
|
-
url?: Value<string | URL
|
|
32
|
+
url?: Value<Promisable<string | URL>, [readonly [StandardLinkClientInterceptorOptions<T>, ...StandardLinkClientInterceptorOptions<T>[]]]>;
|
|
26
33
|
/**
|
|
27
34
|
* The maximum length of the URL.
|
|
28
35
|
*
|
|
29
36
|
* @default 2083
|
|
30
37
|
*/
|
|
31
|
-
maxUrlLength?: Value<number
|
|
38
|
+
maxUrlLength?: Value<Promisable<number>, [readonly [StandardLinkClientInterceptorOptions<T>, ...StandardLinkClientInterceptorOptions<T>[]]]>;
|
|
32
39
|
/**
|
|
33
40
|
* Defines the HTTP headers to use for the batch request.
|
|
34
41
|
*
|
|
35
42
|
* @default The same headers of all requests in the batch
|
|
36
43
|
*/
|
|
37
|
-
headers?: Value<StandardHeaders
|
|
44
|
+
headers?: Value<Promisable<StandardHeaders>, [readonly [StandardLinkClientInterceptorOptions<T>, ...StandardLinkClientInterceptorOptions<T>[]]]>;
|
|
38
45
|
/**
|
|
39
46
|
* Map the batch request items before sending them.
|
|
40
47
|
*
|
|
@@ -52,10 +59,10 @@ interface BatchLinkPluginOptions<T extends ClientContext> {
|
|
|
52
59
|
exclude?: (options: StandardLinkClientInterceptorOptions<T>) => boolean;
|
|
53
60
|
}
|
|
54
61
|
/**
|
|
55
|
-
* The Batch
|
|
62
|
+
* The Batch Requests Plugin allows you to combine multiple requests and responses into a single batch,
|
|
56
63
|
* reducing the overhead of sending each one separately.
|
|
57
64
|
*
|
|
58
|
-
* @see {@link https://orpc.unnoq.com/docs/plugins/batch-
|
|
65
|
+
* @see {@link https://orpc.unnoq.com/docs/plugins/batch-requests Batch Requests Plugin Docs}
|
|
59
66
|
*/
|
|
60
67
|
declare class BatchLinkPlugin<T extends ClientContext> implements StandardLinkPlugin<T> {
|
|
61
68
|
#private;
|
|
@@ -66,12 +73,45 @@ declare class BatchLinkPlugin<T extends ClientContext> implements StandardLinkPl
|
|
|
66
73
|
private readonly batchHeaders;
|
|
67
74
|
private readonly mapRequestItem;
|
|
68
75
|
private readonly exclude;
|
|
76
|
+
private readonly mode;
|
|
69
77
|
private pending;
|
|
70
78
|
order: number;
|
|
71
79
|
constructor(options: NoInfer<BatchLinkPluginOptions<T>>);
|
|
72
80
|
init(options: StandardLinkOptions<T>): void;
|
|
73
81
|
}
|
|
74
82
|
|
|
83
|
+
interface DedupeRequestsPluginGroup<T extends ClientContext> {
|
|
84
|
+
condition(options: StandardLinkClientInterceptorOptions<T>): boolean;
|
|
85
|
+
/**
|
|
86
|
+
* The context used for the rest of the request lifecycle.
|
|
87
|
+
*/
|
|
88
|
+
context: T;
|
|
89
|
+
}
|
|
90
|
+
interface DedupeRequestsPluginOptions<T extends ClientContext> {
|
|
91
|
+
/**
|
|
92
|
+
* To enable deduplication, a request must match at least one defined group.
|
|
93
|
+
* Requests that fall into the same group are considered for deduplication together.
|
|
94
|
+
*/
|
|
95
|
+
groups: readonly [DedupeRequestsPluginGroup<T>, ...DedupeRequestsPluginGroup<T>[]];
|
|
96
|
+
/**
|
|
97
|
+
* Filters requests to dedupe
|
|
98
|
+
*
|
|
99
|
+
* @default (({ request }) => request.method === 'GET')
|
|
100
|
+
*/
|
|
101
|
+
filter?: (options: StandardLinkClientInterceptorOptions<T>) => boolean;
|
|
102
|
+
}
|
|
103
|
+
/**
|
|
104
|
+
* Prevents duplicate requests by deduplicating similar ones to reduce server load.
|
|
105
|
+
*
|
|
106
|
+
* @see {@link https://orpc.unnoq.com/docs/plugins/dedupe-requests Dedupe Requests Plugin}
|
|
107
|
+
*/
|
|
108
|
+
declare class DedupeRequestsPlugin<T extends ClientContext> implements StandardLinkPlugin<T> {
|
|
109
|
+
#private;
|
|
110
|
+
order: number;
|
|
111
|
+
constructor(options: NoInfer<DedupeRequestsPluginOptions<T>>);
|
|
112
|
+
init(options: StandardLinkOptions<T>): void;
|
|
113
|
+
}
|
|
114
|
+
|
|
75
115
|
interface ClientRetryPluginAttemptOptions<T extends ClientContext> extends StandardLinkInterceptorOptions<T> {
|
|
76
116
|
lastEventRetry: number | undefined;
|
|
77
117
|
attemptIndex: number;
|
|
@@ -84,19 +124,19 @@ interface ClientRetryPluginContext {
|
|
|
84
124
|
*
|
|
85
125
|
* @default 0
|
|
86
126
|
*/
|
|
87
|
-
retry?: Value<number
|
|
127
|
+
retry?: Value<Promisable<number>, [StandardLinkInterceptorOptions<ClientRetryPluginContext>]>;
|
|
88
128
|
/**
|
|
89
129
|
* Delay (in ms) before retrying.
|
|
90
130
|
*
|
|
91
131
|
* @default (o) => o.lastEventRetry ?? 2000
|
|
92
132
|
*/
|
|
93
|
-
retryDelay?: Value<number
|
|
133
|
+
retryDelay?: Value<Promisable<number>, [ClientRetryPluginAttemptOptions<ClientRetryPluginContext>]>;
|
|
94
134
|
/**
|
|
95
135
|
* Determine should retry or not.
|
|
96
136
|
*
|
|
97
137
|
* @default true
|
|
98
138
|
*/
|
|
99
|
-
shouldRetry?: Value<boolean
|
|
139
|
+
shouldRetry?: Value<Promisable<boolean>, [ClientRetryPluginAttemptOptions<ClientRetryPluginContext>]>;
|
|
100
140
|
/**
|
|
101
141
|
* The hook called when retrying, and return the unsubscribe function.
|
|
102
142
|
*/
|
|
@@ -127,20 +167,20 @@ interface SimpleCsrfProtectionLinkPluginOptions<T extends ClientContext> {
|
|
|
127
167
|
*
|
|
128
168
|
* @default 'x-csrf-token'
|
|
129
169
|
*/
|
|
130
|
-
headerName?: Value<string
|
|
170
|
+
headerName?: Value<Promisable<string>, [options: StandardLinkClientInterceptorOptions<T>]>;
|
|
131
171
|
/**
|
|
132
172
|
* The value of the header to check.
|
|
133
173
|
*
|
|
134
174
|
* @default 'orpc'
|
|
135
175
|
*
|
|
136
176
|
*/
|
|
137
|
-
headerValue?: Value<string
|
|
177
|
+
headerValue?: Value<Promisable<string>, [options: StandardLinkClientInterceptorOptions<T>]>;
|
|
138
178
|
/**
|
|
139
179
|
* Exclude a procedure from the plugin.
|
|
140
180
|
*
|
|
141
181
|
* @default false
|
|
142
182
|
*/
|
|
143
|
-
exclude?: Value<boolean
|
|
183
|
+
exclude?: Value<Promisable<boolean>, [options: StandardLinkClientInterceptorOptions<T>]>;
|
|
144
184
|
}
|
|
145
185
|
/**
|
|
146
186
|
* This plugin adds basic Cross-Site Request Forgery (CSRF) protection to your oRPC application.
|
|
@@ -158,5 +198,5 @@ declare class SimpleCsrfProtectionLinkPlugin<T extends ClientContext> implements
|
|
|
158
198
|
init(options: StandardLinkOptions<T>): void;
|
|
159
199
|
}
|
|
160
200
|
|
|
161
|
-
export { BatchLinkPlugin, ClientRetryPlugin, ClientRetryPluginInvalidEventIteratorRetryResponse, SimpleCsrfProtectionLinkPlugin };
|
|
162
|
-
export type { BatchLinkPluginGroup, BatchLinkPluginOptions, ClientRetryPluginAttemptOptions, ClientRetryPluginContext, ClientRetryPluginOptions, SimpleCsrfProtectionLinkPluginOptions };
|
|
201
|
+
export { BatchLinkPlugin, ClientRetryPlugin, ClientRetryPluginInvalidEventIteratorRetryResponse, DedupeRequestsPlugin, SimpleCsrfProtectionLinkPlugin };
|
|
202
|
+
export type { BatchLinkPluginGroup, BatchLinkPluginOptions, ClientRetryPluginAttemptOptions, ClientRetryPluginContext, ClientRetryPluginOptions, DedupeRequestsPluginGroup, DedupeRequestsPluginOptions, SimpleCsrfProtectionLinkPluginOptions };
|
package/dist/plugins/index.mjs
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
|
-
import { isAsyncIteratorObject, value, splitInHalf, toArray } from '@orpc/shared';
|
|
2
|
-
import { toBatchRequest, parseBatchResponse } from '@orpc/standard-server/batch';
|
|
3
|
-
import { getEventMeta } from '@orpc/standard-server';
|
|
1
|
+
import { isAsyncIteratorObject, defer, value, splitInHalf, toArray, stringifyJSON } from '@orpc/shared';
|
|
2
|
+
import { toBatchRequest, parseBatchResponse, toBatchAbortSignal } from '@orpc/standard-server/batch';
|
|
3
|
+
import { replicateStandardLazyResponse, getEventMeta } from '@orpc/standard-server';
|
|
4
4
|
|
|
5
5
|
class BatchLinkPlugin {
|
|
6
6
|
groups;
|
|
@@ -10,6 +10,7 @@ class BatchLinkPlugin {
|
|
|
10
10
|
batchHeaders;
|
|
11
11
|
mapRequestItem;
|
|
12
12
|
exclude;
|
|
13
|
+
mode;
|
|
13
14
|
pending;
|
|
14
15
|
order = 5e6;
|
|
15
16
|
constructor(options) {
|
|
@@ -17,6 +18,7 @@ class BatchLinkPlugin {
|
|
|
17
18
|
this.pending = /* @__PURE__ */ new Map();
|
|
18
19
|
this.maxSize = options.maxSize ?? 10;
|
|
19
20
|
this.maxUrlLength = options.maxUrlLength ?? 2083;
|
|
21
|
+
this.mode = options.mode ?? "streaming";
|
|
20
22
|
this.batchUrl = options.url ?? (([options2]) => `${options2.request.url.origin}${options2.request.url.pathname}/__batch__`);
|
|
21
23
|
this.batchHeaders = options.headers ?? (([options2, ...rest]) => {
|
|
22
24
|
const headers = {};
|
|
@@ -62,7 +64,7 @@ class BatchLinkPlugin {
|
|
|
62
64
|
});
|
|
63
65
|
});
|
|
64
66
|
options.clientInterceptors.push((options2) => {
|
|
65
|
-
if (this.exclude(options2) || options2.request.body instanceof Blob || options2.request.body instanceof FormData || isAsyncIteratorObject(options2.request.body)) {
|
|
67
|
+
if (this.exclude(options2) || options2.request.body instanceof Blob || options2.request.body instanceof FormData || isAsyncIteratorObject(options2.request.body) || options2.request.signal?.aborted) {
|
|
66
68
|
return options2.next();
|
|
67
69
|
}
|
|
68
70
|
const group = this.groups.find((group2) => group2.condition(options2));
|
|
@@ -71,7 +73,7 @@ class BatchLinkPlugin {
|
|
|
71
73
|
}
|
|
72
74
|
return new Promise((resolve, reject) => {
|
|
73
75
|
this.#enqueueRequest(group, options2, resolve, reject);
|
|
74
|
-
|
|
76
|
+
defer(() => this.#processPendingBatches());
|
|
75
77
|
});
|
|
76
78
|
});
|
|
77
79
|
}
|
|
@@ -127,16 +129,28 @@ class BatchLinkPlugin {
|
|
|
127
129
|
this.#executeBatch(method, group, second);
|
|
128
130
|
return;
|
|
129
131
|
}
|
|
130
|
-
const
|
|
131
|
-
|
|
132
|
-
|
|
133
|
-
|
|
134
|
-
|
|
135
|
-
|
|
136
|
-
|
|
137
|
-
|
|
138
|
-
|
|
139
|
-
|
|
132
|
+
const mode = value(this.mode, options);
|
|
133
|
+
try {
|
|
134
|
+
const lazyResponse = await options[0].next({
|
|
135
|
+
request: { ...batchRequest, headers: { ...batchRequest.headers, "x-orpc-batch": mode } },
|
|
136
|
+
signal: batchRequest.signal,
|
|
137
|
+
context: group.context,
|
|
138
|
+
input: group.input,
|
|
139
|
+
path: toArray(group.path)
|
|
140
|
+
});
|
|
141
|
+
const parsed = parseBatchResponse({ ...lazyResponse, body: await lazyResponse.body() });
|
|
142
|
+
for await (const item of parsed) {
|
|
143
|
+
batchItems[item.index]?.[1]({ ...item, body: () => Promise.resolve(item.body) });
|
|
144
|
+
}
|
|
145
|
+
} catch (err) {
|
|
146
|
+
if (batchRequest.signal?.aborted && batchRequest.signal.reason === err) {
|
|
147
|
+
for (const [{ signal }, , reject] of batchItems) {
|
|
148
|
+
if (signal?.aborted) {
|
|
149
|
+
reject(signal.reason);
|
|
150
|
+
}
|
|
151
|
+
}
|
|
152
|
+
}
|
|
153
|
+
throw err;
|
|
140
154
|
}
|
|
141
155
|
throw new Error("Something went wrong make batch response not contains enough responses. This can be a bug please report it.");
|
|
142
156
|
} catch (error) {
|
|
@@ -147,6 +161,101 @@ class BatchLinkPlugin {
|
|
|
147
161
|
}
|
|
148
162
|
}
|
|
149
163
|
|
|
164
|
+
class DedupeRequestsPlugin {
|
|
165
|
+
#groups;
|
|
166
|
+
#filter;
|
|
167
|
+
order = 4e6;
|
|
168
|
+
// make sure execute before batch plugin
|
|
169
|
+
#queue = /* @__PURE__ */ new Map();
|
|
170
|
+
constructor(options) {
|
|
171
|
+
this.#groups = options.groups;
|
|
172
|
+
this.#filter = options.filter ?? (({ request }) => request.method === "GET");
|
|
173
|
+
}
|
|
174
|
+
init(options) {
|
|
175
|
+
options.clientInterceptors ??= [];
|
|
176
|
+
options.clientInterceptors.push((options2) => {
|
|
177
|
+
if (options2.request.body instanceof Blob || options2.request.body instanceof FormData || options2.request.body instanceof URLSearchParams || isAsyncIteratorObject(options2.request.body) || !this.#filter(options2)) {
|
|
178
|
+
return options2.next();
|
|
179
|
+
}
|
|
180
|
+
const group = this.#groups.find((group2) => group2.condition(options2));
|
|
181
|
+
if (!group) {
|
|
182
|
+
return options2.next();
|
|
183
|
+
}
|
|
184
|
+
return new Promise((resolve, reject) => {
|
|
185
|
+
this.#enqueue(group, options2, resolve, reject);
|
|
186
|
+
defer(() => this.#dequeue());
|
|
187
|
+
});
|
|
188
|
+
});
|
|
189
|
+
}
|
|
190
|
+
#enqueue(group, options, resolve, reject) {
|
|
191
|
+
let queue = this.#queue.get(group);
|
|
192
|
+
if (!queue) {
|
|
193
|
+
this.#queue.set(group, queue = []);
|
|
194
|
+
}
|
|
195
|
+
const matched = queue.find((item) => {
|
|
196
|
+
const requestString1 = stringifyJSON({
|
|
197
|
+
body: item.options.request.body,
|
|
198
|
+
headers: item.options.request.headers,
|
|
199
|
+
method: item.options.request.method,
|
|
200
|
+
url: item.options.request.url
|
|
201
|
+
});
|
|
202
|
+
const requestString2 = stringifyJSON({
|
|
203
|
+
body: options.request.body,
|
|
204
|
+
headers: options.request.headers,
|
|
205
|
+
method: options.request.method,
|
|
206
|
+
url: options.request.url
|
|
207
|
+
});
|
|
208
|
+
return requestString1 === requestString2;
|
|
209
|
+
});
|
|
210
|
+
if (matched) {
|
|
211
|
+
matched.signals.push(options.request.signal);
|
|
212
|
+
matched.resolves.push(resolve);
|
|
213
|
+
matched.rejects.push(reject);
|
|
214
|
+
} else {
|
|
215
|
+
queue.push({
|
|
216
|
+
options,
|
|
217
|
+
signals: [options.request.signal],
|
|
218
|
+
resolves: [resolve],
|
|
219
|
+
rejects: [reject]
|
|
220
|
+
});
|
|
221
|
+
}
|
|
222
|
+
}
|
|
223
|
+
async #dequeue() {
|
|
224
|
+
const promises = [];
|
|
225
|
+
for (const [group, items] of this.#queue) {
|
|
226
|
+
for (const { options, signals, resolves, rejects } of items) {
|
|
227
|
+
promises.push(
|
|
228
|
+
this.#execute(group, options, signals, resolves, rejects)
|
|
229
|
+
);
|
|
230
|
+
}
|
|
231
|
+
}
|
|
232
|
+
this.#queue.clear();
|
|
233
|
+
await Promise.all(promises);
|
|
234
|
+
}
|
|
235
|
+
async #execute(group, options, signals, resolves, rejects) {
|
|
236
|
+
try {
|
|
237
|
+
const dedupedRequest = {
|
|
238
|
+
...options.request,
|
|
239
|
+
signal: toBatchAbortSignal(signals)
|
|
240
|
+
};
|
|
241
|
+
const response = await options.next({
|
|
242
|
+
...options,
|
|
243
|
+
request: dedupedRequest,
|
|
244
|
+
signal: dedupedRequest.signal,
|
|
245
|
+
context: group.context
|
|
246
|
+
});
|
|
247
|
+
const replicatedResponses = replicateStandardLazyResponse(response, resolves.length);
|
|
248
|
+
for (const resolve of resolves) {
|
|
249
|
+
resolve(replicatedResponses.shift());
|
|
250
|
+
}
|
|
251
|
+
} catch (error) {
|
|
252
|
+
for (const reject of rejects) {
|
|
253
|
+
reject(error);
|
|
254
|
+
}
|
|
255
|
+
}
|
|
256
|
+
}
|
|
257
|
+
}
|
|
258
|
+
|
|
150
259
|
class ClientRetryPluginInvalidEventIteratorRetryResponse extends Error {
|
|
151
260
|
}
|
|
152
261
|
class ClientRetryPlugin {
|
|
@@ -288,4 +397,4 @@ class SimpleCsrfProtectionLinkPlugin {
|
|
|
288
397
|
}
|
|
289
398
|
}
|
|
290
399
|
|
|
291
|
-
export { BatchLinkPlugin, ClientRetryPlugin, ClientRetryPluginInvalidEventIteratorRetryResponse, SimpleCsrfProtectionLinkPlugin };
|
|
400
|
+
export { BatchLinkPlugin, ClientRetryPlugin, ClientRetryPluginInvalidEventIteratorRetryResponse, DedupeRequestsPlugin, SimpleCsrfProtectionLinkPlugin };
|
|
@@ -1,6 +1,6 @@
|
|
|
1
|
-
import { toArray, intercept, isObject, value,
|
|
1
|
+
import { toArray, runWithSpan, ORPC_NAME, isAsyncIteratorObject, asyncIteratorWithSpan, intercept, getGlobalOtelConfig, isObject, value, stringifyJSON } from '@orpc/shared';
|
|
2
2
|
import { mergeStandardHeaders, ErrorEvent } from '@orpc/standard-server';
|
|
3
|
-
import { C as COMMON_ORPC_ERROR_DEFS, b as isORPCErrorStatus, c as isORPCErrorJson, d as createORPCErrorFromJson, O as ORPCError, m as mapEventIterator, t as toORPCError } from './client.
|
|
3
|
+
import { C as COMMON_ORPC_ERROR_DEFS, b as isORPCErrorStatus, c as isORPCErrorJson, d as createORPCErrorFromJson, O as ORPCError, m as mapEventIterator, t as toORPCError } from './client.BngOL3Ai.mjs';
|
|
4
4
|
|
|
5
5
|
class CompositeStandardLinkPlugin {
|
|
6
6
|
plugins;
|
|
@@ -26,20 +26,52 @@ class StandardLink {
|
|
|
26
26
|
interceptors;
|
|
27
27
|
clientInterceptors;
|
|
28
28
|
call(path, input, options) {
|
|
29
|
-
return
|
|
30
|
-
|
|
31
|
-
|
|
32
|
-
|
|
33
|
-
|
|
34
|
-
|
|
35
|
-
|
|
36
|
-
|
|
37
|
-
|
|
38
|
-
|
|
39
|
-
|
|
29
|
+
return runWithSpan(
|
|
30
|
+
{ name: `${ORPC_NAME}.${path.join("/")}`, signal: options.signal },
|
|
31
|
+
(span) => {
|
|
32
|
+
span?.setAttribute("rpc.system", ORPC_NAME);
|
|
33
|
+
span?.setAttribute("rpc.method", path.join("."));
|
|
34
|
+
if (isAsyncIteratorObject(input)) {
|
|
35
|
+
input = asyncIteratorWithSpan(
|
|
36
|
+
{ name: "consume_event_iterator_input", signal: options.signal },
|
|
37
|
+
input
|
|
38
|
+
);
|
|
39
|
+
}
|
|
40
|
+
return intercept(this.interceptors, { ...options, path, input }, async ({ path: path2, input: input2, ...options2 }) => {
|
|
41
|
+
const otelConfig = getGlobalOtelConfig();
|
|
42
|
+
let otelContext;
|
|
43
|
+
const currentSpan = otelConfig?.trace.getActiveSpan() ?? span;
|
|
44
|
+
if (currentSpan && otelConfig) {
|
|
45
|
+
otelContext = otelConfig?.trace.setSpan(otelConfig.context.active(), currentSpan);
|
|
46
|
+
}
|
|
47
|
+
const request = await runWithSpan(
|
|
48
|
+
{ name: "encode_request", context: otelContext },
|
|
49
|
+
() => this.codec.encode(path2, input2, options2)
|
|
50
|
+
);
|
|
51
|
+
const response = await intercept(
|
|
52
|
+
this.clientInterceptors,
|
|
53
|
+
{ ...options2, input: input2, path: path2, request },
|
|
54
|
+
({ input: input3, path: path3, request: request2, ...options3 }) => {
|
|
55
|
+
return runWithSpan(
|
|
56
|
+
{ name: "send_request", signal: options3.signal, context: otelContext },
|
|
57
|
+
() => this.sender.call(request2, options3, path3, input3)
|
|
58
|
+
);
|
|
59
|
+
}
|
|
60
|
+
);
|
|
61
|
+
const output = await runWithSpan(
|
|
62
|
+
{ name: "decode_response", context: otelContext },
|
|
63
|
+
() => this.codec.decode(response, options2, path2, input2)
|
|
64
|
+
);
|
|
65
|
+
if (isAsyncIteratorObject(output)) {
|
|
66
|
+
return asyncIteratorWithSpan(
|
|
67
|
+
{ name: "consume_event_iterator_output", signal: options2.signal },
|
|
68
|
+
output
|
|
69
|
+
);
|
|
70
|
+
}
|
|
71
|
+
return output;
|
|
72
|
+
});
|
|
73
|
+
}
|
|
40
74
|
);
|
|
41
|
-
const output = await this.codec.decode(response, options, path, input);
|
|
42
|
-
return output;
|
|
43
75
|
}
|
|
44
76
|
}
|
|
45
77
|
|
|
@@ -1,6 +1,6 @@
|
|
|
1
|
-
import { Interceptor
|
|
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;
|
|
@@ -28,12 +28,11 @@ interface StandardLinkClientInterceptorOptions<T extends ClientContext> extends
|
|
|
28
28
|
request: StandardRequest;
|
|
29
29
|
}
|
|
30
30
|
interface StandardLinkOptions<T extends ClientContext> {
|
|
31
|
-
interceptors?: Interceptor<StandardLinkInterceptorOptions<T>, unknown
|
|
32
|
-
clientInterceptors?: Interceptor<StandardLinkClientInterceptorOptions<T>, StandardLazyResponse
|
|
31
|
+
interceptors?: Interceptor<StandardLinkInterceptorOptions<T>, Promise<unknown>>[];
|
|
32
|
+
clientInterceptors?: Interceptor<StandardLinkClientInterceptorOptions<T>, Promise<StandardLazyResponse>>[];
|
|
33
33
|
plugins?: StandardLinkPlugin<T>[];
|
|
34
34
|
}
|
|
35
35
|
declare class StandardLink<T extends ClientContext> implements ClientLink<T> {
|
|
36
|
-
#private;
|
|
37
36
|
readonly codec: StandardLinkCodec<T>;
|
|
38
37
|
readonly sender: StandardLinkClient<T>;
|
|
39
38
|
private readonly interceptors;
|