@orpc/client 0.0.0-next.c7f8b1d → 0.0.0-next.c854c60
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 +17 -22
- package/dist/adapters/fetch/index.d.mts +9 -3
- package/dist/adapters/fetch/index.d.ts +9 -3
- package/dist/adapters/fetch/index.mjs +2 -2
- 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 +44 -0
- package/dist/index.d.mts +18 -5
- package/dist/index.d.ts +18 -5
- package/dist/index.mjs +4 -4
- package/dist/plugins/index.d.mts +74 -16
- package/dist/plugins/index.d.ts +74 -16
- package/dist/plugins/index.mjs +104 -6
- package/dist/shared/{client.CipPQkhk.d.mts → client.4TS_0JaO.d.mts} +1 -1
- package/dist/shared/{client.CipPQkhk.d.ts → client.4TS_0JaO.d.ts} +1 -1
- package/dist/shared/{client.8TjrVhkC.d.ts → client.7UM0t5o-.d.ts} +8 -8
- package/dist/shared/{client.C9U9n1f3.d.ts → client.BMoG_EdN.d.mts} +4 -4
- package/dist/shared/{client.CRWEpqLB.mjs → client.BX0_8bnM.mjs} +13 -16
- package/dist/shared/{client.BjJBZryq.d.mts → client.BdD8cpjs.d.mts} +8 -8
- package/dist/shared/{client.FXep-a3a.d.mts → client.C0KbSWlC.d.ts} +4 -4
- package/dist/shared/{client.DpICn1BD.mjs → client.CQCGVpTM.mjs} +1 -1
- package/package.json +16 -5
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.BMoG_EdN.mjs';
|
5
|
+
import { a as ClientContext } from '../shared/client.4TS_0JaO.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
|
*
|
@@ -51,6 +58,12 @@ interface BatchLinkPluginOptions<T extends ClientContext> {
|
|
51
58
|
*/
|
52
59
|
exclude?: (options: StandardLinkClientInterceptorOptions<T>) => boolean;
|
53
60
|
}
|
61
|
+
/**
|
62
|
+
* The Batch Requests Plugin allows you to combine multiple requests and responses into a single batch,
|
63
|
+
* reducing the overhead of sending each one separately.
|
64
|
+
*
|
65
|
+
* @see {@link https://orpc.unnoq.com/docs/plugins/batch-requests Batch Requests Plugin Docs}
|
66
|
+
*/
|
54
67
|
declare class BatchLinkPlugin<T extends ClientContext> implements StandardLinkPlugin<T> {
|
55
68
|
#private;
|
56
69
|
private readonly groups;
|
@@ -60,9 +73,42 @@ declare class BatchLinkPlugin<T extends ClientContext> implements StandardLinkPl
|
|
60
73
|
private readonly batchHeaders;
|
61
74
|
private readonly mapRequestItem;
|
62
75
|
private readonly exclude;
|
76
|
+
private readonly mode;
|
63
77
|
private pending;
|
64
78
|
order: number;
|
65
|
-
constructor(options: BatchLinkPluginOptions<T
|
79
|
+
constructor(options: NoInfer<BatchLinkPluginOptions<T>>);
|
80
|
+
init(options: StandardLinkOptions<T>): void;
|
81
|
+
}
|
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>>);
|
66
112
|
init(options: StandardLinkOptions<T>): void;
|
67
113
|
}
|
68
114
|
|
@@ -78,19 +124,19 @@ interface ClientRetryPluginContext {
|
|
78
124
|
*
|
79
125
|
* @default 0
|
80
126
|
*/
|
81
|
-
retry?: Value<number
|
127
|
+
retry?: Value<Promisable<number>, [StandardLinkInterceptorOptions<ClientRetryPluginContext>]>;
|
82
128
|
/**
|
83
129
|
* Delay (in ms) before retrying.
|
84
130
|
*
|
85
131
|
* @default (o) => o.lastEventRetry ?? 2000
|
86
132
|
*/
|
87
|
-
retryDelay?: Value<number
|
133
|
+
retryDelay?: Value<Promisable<number>, [ClientRetryPluginAttemptOptions<ClientRetryPluginContext>]>;
|
88
134
|
/**
|
89
135
|
* Determine should retry or not.
|
90
136
|
*
|
91
137
|
* @default true
|
92
138
|
*/
|
93
|
-
shouldRetry?: Value<boolean
|
139
|
+
shouldRetry?: Value<Promisable<boolean>, [ClientRetryPluginAttemptOptions<ClientRetryPluginContext>]>;
|
94
140
|
/**
|
95
141
|
* The hook called when retrying, and return the unsubscribe function.
|
96
142
|
*/
|
@@ -101,6 +147,11 @@ declare class ClientRetryPluginInvalidEventIteratorRetryResponse extends Error {
|
|
101
147
|
interface ClientRetryPluginOptions {
|
102
148
|
default?: ClientRetryPluginContext;
|
103
149
|
}
|
150
|
+
/**
|
151
|
+
* The Client Retry Plugin enables retrying client calls when errors occur.
|
152
|
+
*
|
153
|
+
* @see {@link https://orpc.unnoq.com/docs/plugins/client-retry Client Retry Plugin Docs}
|
154
|
+
*/
|
104
155
|
declare class ClientRetryPlugin<T extends ClientRetryPluginContext> implements StandardLinkPlugin<T> {
|
105
156
|
private readonly defaultRetry;
|
106
157
|
private readonly defaultRetryDelay;
|
@@ -116,21 +167,28 @@ interface SimpleCsrfProtectionLinkPluginOptions<T extends ClientContext> {
|
|
116
167
|
*
|
117
168
|
* @default 'x-csrf-token'
|
118
169
|
*/
|
119
|
-
headerName?: Value<string
|
170
|
+
headerName?: Value<Promisable<string>, [options: StandardLinkClientInterceptorOptions<T>]>;
|
120
171
|
/**
|
121
172
|
* The value of the header to check.
|
122
173
|
*
|
123
174
|
* @default 'orpc'
|
124
175
|
*
|
125
176
|
*/
|
126
|
-
headerValue?: Value<string
|
177
|
+
headerValue?: Value<Promisable<string>, [options: StandardLinkClientInterceptorOptions<T>]>;
|
127
178
|
/**
|
128
179
|
* Exclude a procedure from the plugin.
|
129
180
|
*
|
130
181
|
* @default false
|
131
182
|
*/
|
132
|
-
exclude?: Value<boolean
|
183
|
+
exclude?: Value<Promisable<boolean>, [options: StandardLinkClientInterceptorOptions<T>]>;
|
133
184
|
}
|
185
|
+
/**
|
186
|
+
* This plugin adds basic Cross-Site Request Forgery (CSRF) protection to your oRPC application.
|
187
|
+
* It helps ensure that requests to your procedures originate from JavaScript code,
|
188
|
+
* not from other sources like standard HTML forms or direct browser navigation.
|
189
|
+
*
|
190
|
+
* @see {@link https://orpc.unnoq.com/docs/plugins/simple-csrf-protection Simple CSRF Protection Plugin Docs}
|
191
|
+
*/
|
134
192
|
declare class SimpleCsrfProtectionLinkPlugin<T extends ClientContext> implements StandardLinkPlugin<T> {
|
135
193
|
private readonly headerName;
|
136
194
|
private readonly headerValue;
|
@@ -140,5 +198,5 @@ declare class SimpleCsrfProtectionLinkPlugin<T extends ClientContext> implements
|
|
140
198
|
init(options: StandardLinkOptions<T>): void;
|
141
199
|
}
|
142
200
|
|
143
|
-
export { BatchLinkPlugin, ClientRetryPlugin, ClientRetryPluginInvalidEventIteratorRetryResponse, SimpleCsrfProtectionLinkPlugin };
|
144
|
-
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.C0KbSWlC.js';
|
5
|
+
import { a as ClientContext } from '../shared/client.4TS_0JaO.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
|
*
|
@@ -51,6 +58,12 @@ interface BatchLinkPluginOptions<T extends ClientContext> {
|
|
51
58
|
*/
|
52
59
|
exclude?: (options: StandardLinkClientInterceptorOptions<T>) => boolean;
|
53
60
|
}
|
61
|
+
/**
|
62
|
+
* The Batch Requests Plugin allows you to combine multiple requests and responses into a single batch,
|
63
|
+
* reducing the overhead of sending each one separately.
|
64
|
+
*
|
65
|
+
* @see {@link https://orpc.unnoq.com/docs/plugins/batch-requests Batch Requests Plugin Docs}
|
66
|
+
*/
|
54
67
|
declare class BatchLinkPlugin<T extends ClientContext> implements StandardLinkPlugin<T> {
|
55
68
|
#private;
|
56
69
|
private readonly groups;
|
@@ -60,9 +73,42 @@ declare class BatchLinkPlugin<T extends ClientContext> implements StandardLinkPl
|
|
60
73
|
private readonly batchHeaders;
|
61
74
|
private readonly mapRequestItem;
|
62
75
|
private readonly exclude;
|
76
|
+
private readonly mode;
|
63
77
|
private pending;
|
64
78
|
order: number;
|
65
|
-
constructor(options: BatchLinkPluginOptions<T
|
79
|
+
constructor(options: NoInfer<BatchLinkPluginOptions<T>>);
|
80
|
+
init(options: StandardLinkOptions<T>): void;
|
81
|
+
}
|
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>>);
|
66
112
|
init(options: StandardLinkOptions<T>): void;
|
67
113
|
}
|
68
114
|
|
@@ -78,19 +124,19 @@ interface ClientRetryPluginContext {
|
|
78
124
|
*
|
79
125
|
* @default 0
|
80
126
|
*/
|
81
|
-
retry?: Value<number
|
127
|
+
retry?: Value<Promisable<number>, [StandardLinkInterceptorOptions<ClientRetryPluginContext>]>;
|
82
128
|
/**
|
83
129
|
* Delay (in ms) before retrying.
|
84
130
|
*
|
85
131
|
* @default (o) => o.lastEventRetry ?? 2000
|
86
132
|
*/
|
87
|
-
retryDelay?: Value<number
|
133
|
+
retryDelay?: Value<Promisable<number>, [ClientRetryPluginAttemptOptions<ClientRetryPluginContext>]>;
|
88
134
|
/**
|
89
135
|
* Determine should retry or not.
|
90
136
|
*
|
91
137
|
* @default true
|
92
138
|
*/
|
93
|
-
shouldRetry?: Value<boolean
|
139
|
+
shouldRetry?: Value<Promisable<boolean>, [ClientRetryPluginAttemptOptions<ClientRetryPluginContext>]>;
|
94
140
|
/**
|
95
141
|
* The hook called when retrying, and return the unsubscribe function.
|
96
142
|
*/
|
@@ -101,6 +147,11 @@ declare class ClientRetryPluginInvalidEventIteratorRetryResponse extends Error {
|
|
101
147
|
interface ClientRetryPluginOptions {
|
102
148
|
default?: ClientRetryPluginContext;
|
103
149
|
}
|
150
|
+
/**
|
151
|
+
* The Client Retry Plugin enables retrying client calls when errors occur.
|
152
|
+
*
|
153
|
+
* @see {@link https://orpc.unnoq.com/docs/plugins/client-retry Client Retry Plugin Docs}
|
154
|
+
*/
|
104
155
|
declare class ClientRetryPlugin<T extends ClientRetryPluginContext> implements StandardLinkPlugin<T> {
|
105
156
|
private readonly defaultRetry;
|
106
157
|
private readonly defaultRetryDelay;
|
@@ -116,21 +167,28 @@ interface SimpleCsrfProtectionLinkPluginOptions<T extends ClientContext> {
|
|
116
167
|
*
|
117
168
|
* @default 'x-csrf-token'
|
118
169
|
*/
|
119
|
-
headerName?: Value<string
|
170
|
+
headerName?: Value<Promisable<string>, [options: StandardLinkClientInterceptorOptions<T>]>;
|
120
171
|
/**
|
121
172
|
* The value of the header to check.
|
122
173
|
*
|
123
174
|
* @default 'orpc'
|
124
175
|
*
|
125
176
|
*/
|
126
|
-
headerValue?: Value<string
|
177
|
+
headerValue?: Value<Promisable<string>, [options: StandardLinkClientInterceptorOptions<T>]>;
|
127
178
|
/**
|
128
179
|
* Exclude a procedure from the plugin.
|
129
180
|
*
|
130
181
|
* @default false
|
131
182
|
*/
|
132
|
-
exclude?: Value<boolean
|
183
|
+
exclude?: Value<Promisable<boolean>, [options: StandardLinkClientInterceptorOptions<T>]>;
|
133
184
|
}
|
185
|
+
/**
|
186
|
+
* This plugin adds basic Cross-Site Request Forgery (CSRF) protection to your oRPC application.
|
187
|
+
* It helps ensure that requests to your procedures originate from JavaScript code,
|
188
|
+
* not from other sources like standard HTML forms or direct browser navigation.
|
189
|
+
*
|
190
|
+
* @see {@link https://orpc.unnoq.com/docs/plugins/simple-csrf-protection Simple CSRF Protection Plugin Docs}
|
191
|
+
*/
|
134
192
|
declare class SimpleCsrfProtectionLinkPlugin<T extends ClientContext> implements StandardLinkPlugin<T> {
|
135
193
|
private readonly headerName;
|
136
194
|
private readonly headerValue;
|
@@ -140,5 +198,5 @@ declare class SimpleCsrfProtectionLinkPlugin<T extends ClientContext> implements
|
|
140
198
|
init(options: StandardLinkOptions<T>): void;
|
141
199
|
}
|
142
200
|
|
143
|
-
export { BatchLinkPlugin, ClientRetryPlugin, ClientRetryPluginInvalidEventIteratorRetryResponse, SimpleCsrfProtectionLinkPlugin };
|
144
|
-
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 = {};
|
@@ -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,8 +129,9 @@ class BatchLinkPlugin {
|
|
127
129
|
this.#executeBatch(method, group, second);
|
128
130
|
return;
|
129
131
|
}
|
132
|
+
const mode = value(this.mode, options);
|
130
133
|
const lazyResponse = await options[0].next({
|
131
|
-
request: { ...batchRequest, headers: { ...batchRequest.headers, "x-orpc-batch":
|
134
|
+
request: { ...batchRequest, headers: { ...batchRequest.headers, "x-orpc-batch": mode } },
|
132
135
|
signal: batchRequest.signal,
|
133
136
|
context: group.context,
|
134
137
|
input: group.input,
|
@@ -147,6 +150,101 @@ class BatchLinkPlugin {
|
|
147
150
|
}
|
148
151
|
}
|
149
152
|
|
153
|
+
class DedupeRequestsPlugin {
|
154
|
+
#groups;
|
155
|
+
#filter;
|
156
|
+
order = 4e6;
|
157
|
+
// make sure execute before batch plugin
|
158
|
+
#queue = /* @__PURE__ */ new Map();
|
159
|
+
constructor(options) {
|
160
|
+
this.#groups = options.groups;
|
161
|
+
this.#filter = options.filter ?? (({ request }) => request.method === "GET");
|
162
|
+
}
|
163
|
+
init(options) {
|
164
|
+
options.clientInterceptors ??= [];
|
165
|
+
options.clientInterceptors.push((options2) => {
|
166
|
+
if (options2.request.body instanceof Blob || options2.request.body instanceof FormData || options2.request.body instanceof URLSearchParams || isAsyncIteratorObject(options2.request.body) || !this.#filter(options2)) {
|
167
|
+
return options2.next();
|
168
|
+
}
|
169
|
+
const group = this.#groups.find((group2) => group2.condition(options2));
|
170
|
+
if (!group) {
|
171
|
+
return options2.next();
|
172
|
+
}
|
173
|
+
return new Promise((resolve, reject) => {
|
174
|
+
this.#enqueue(group, options2, resolve, reject);
|
175
|
+
defer(() => this.#dequeue());
|
176
|
+
});
|
177
|
+
});
|
178
|
+
}
|
179
|
+
#enqueue(group, options, resolve, reject) {
|
180
|
+
let queue = this.#queue.get(group);
|
181
|
+
if (!queue) {
|
182
|
+
this.#queue.set(group, queue = []);
|
183
|
+
}
|
184
|
+
const matched = queue.find((item) => {
|
185
|
+
const requestString1 = stringifyJSON({
|
186
|
+
body: item.options.request.body,
|
187
|
+
headers: item.options.request.headers,
|
188
|
+
method: item.options.request.method,
|
189
|
+
url: item.options.request.url
|
190
|
+
});
|
191
|
+
const requestString2 = stringifyJSON({
|
192
|
+
body: options.request.body,
|
193
|
+
headers: options.request.headers,
|
194
|
+
method: options.request.method,
|
195
|
+
url: options.request.url
|
196
|
+
});
|
197
|
+
return requestString1 === requestString2;
|
198
|
+
});
|
199
|
+
if (matched) {
|
200
|
+
matched.signals.push(options.request.signal);
|
201
|
+
matched.resolves.push(resolve);
|
202
|
+
matched.rejects.push(reject);
|
203
|
+
} else {
|
204
|
+
queue.push({
|
205
|
+
options,
|
206
|
+
signals: [options.request.signal],
|
207
|
+
resolves: [resolve],
|
208
|
+
rejects: [reject]
|
209
|
+
});
|
210
|
+
}
|
211
|
+
}
|
212
|
+
async #dequeue() {
|
213
|
+
const promises = [];
|
214
|
+
for (const [group, items] of this.#queue) {
|
215
|
+
for (const { options, signals, resolves, rejects } of items) {
|
216
|
+
promises.push(
|
217
|
+
this.#execute(group, options, signals, resolves, rejects)
|
218
|
+
);
|
219
|
+
}
|
220
|
+
}
|
221
|
+
this.#queue.clear();
|
222
|
+
await Promise.all(promises);
|
223
|
+
}
|
224
|
+
async #execute(group, options, signals, resolves, rejects) {
|
225
|
+
try {
|
226
|
+
const dedupedRequest = {
|
227
|
+
...options.request,
|
228
|
+
signal: toBatchAbortSignal(signals)
|
229
|
+
};
|
230
|
+
const response = await options.next({
|
231
|
+
...options,
|
232
|
+
request: dedupedRequest,
|
233
|
+
signal: dedupedRequest.signal,
|
234
|
+
context: group.context
|
235
|
+
});
|
236
|
+
const replicatedResponses = replicateStandardLazyResponse(response, resolves.length);
|
237
|
+
for (const resolve of resolves) {
|
238
|
+
resolve(replicatedResponses.shift());
|
239
|
+
}
|
240
|
+
} catch (error) {
|
241
|
+
for (const reject of rejects) {
|
242
|
+
reject(error);
|
243
|
+
}
|
244
|
+
}
|
245
|
+
}
|
246
|
+
}
|
247
|
+
|
150
248
|
class ClientRetryPluginInvalidEventIteratorRetryResponse extends Error {
|
151
249
|
}
|
152
250
|
class ClientRetryPlugin {
|
@@ -288,4 +386,4 @@ class SimpleCsrfProtectionLinkPlugin {
|
|
288
386
|
}
|
289
387
|
}
|
290
388
|
|
291
|
-
export { BatchLinkPlugin, ClientRetryPlugin, ClientRetryPluginInvalidEventIteratorRetryResponse, SimpleCsrfProtectionLinkPlugin };
|
389
|
+
export { BatchLinkPlugin, ClientRetryPlugin, ClientRetryPluginInvalidEventIteratorRetryResponse, DedupeRequestsPlugin, SimpleCsrfProtectionLinkPlugin };
|
@@ -1,7 +1,7 @@
|
|
1
1
|
import { PromiseWithError } from '@orpc/shared';
|
2
2
|
|
3
3
|
type HTTPPath = `/${string}`;
|
4
|
-
type HTTPMethod = 'GET' | 'POST' | 'PUT' | 'DELETE' | 'PATCH';
|
4
|
+
type HTTPMethod = 'HEAD' | 'GET' | 'POST' | 'PUT' | 'DELETE' | 'PATCH';
|
5
5
|
type ClientContext = Record<PropertyKey, any>;
|
6
6
|
interface ClientOptions<T extends ClientContext> {
|
7
7
|
signal?: AbortSignal;
|
@@ -1,7 +1,7 @@
|
|
1
1
|
import { PromiseWithError } from '@orpc/shared';
|
2
2
|
|
3
3
|
type HTTPPath = `/${string}`;
|
4
|
-
type HTTPMethod = 'GET' | 'POST' | 'PUT' | 'DELETE' | 'PATCH';
|
4
|
+
type HTTPMethod = 'HEAD' | 'GET' | 'POST' | 'PUT' | 'DELETE' | 'PATCH';
|
5
5
|
type ClientContext = Record<PropertyKey, any>;
|
6
6
|
interface ClientOptions<T extends ClientContext> {
|
7
7
|
signal?: AbortSignal;
|
@@ -1,6 +1,6 @@
|
|
1
|
-
import { a as ClientContext, b as ClientOptions, d as HTTPMethod } from './client.
|
2
|
-
import { e as StandardLinkCodec, b as StandardLinkOptions, d as StandardLink, f as StandardLinkClient } from './client.
|
3
|
-
import { Segment, Value } from '@orpc/shared';
|
1
|
+
import { a as ClientContext, b as ClientOptions, d as HTTPMethod } from './client.4TS_0JaO.js';
|
2
|
+
import { e as StandardLinkCodec, b as StandardLinkOptions, d as StandardLink, f as StandardLinkClient } from './client.C0KbSWlC.js';
|
3
|
+
import { Segment, Value, Promisable } from '@orpc/shared';
|
4
4
|
import { StandardHeaders, StandardRequest, StandardLazyResponse } from '@orpc/standard-server';
|
5
5
|
|
6
6
|
declare const STANDARD_RPC_JSON_SERIALIZER_BUILT_IN_TYPES: {
|
@@ -44,30 +44,30 @@ interface StandardRPCLinkCodecOptions<T extends ClientContext> {
|
|
44
44
|
/**
|
45
45
|
* Base url for all requests.
|
46
46
|
*/
|
47
|
-
url: Value<string | URL
|
47
|
+
url: Value<Promisable<string | URL>, [options: ClientOptions<T>, path: readonly string[], input: unknown]>;
|
48
48
|
/**
|
49
49
|
* The maximum length of the URL.
|
50
50
|
*
|
51
51
|
* @default 2083
|
52
52
|
*/
|
53
|
-
maxUrlLength?: Value<number
|
53
|
+
maxUrlLength?: Value<Promisable<number>, [options: ClientOptions<T>, path: readonly string[], input: unknown]>;
|
54
54
|
/**
|
55
55
|
* The method used to make the request.
|
56
56
|
*
|
57
57
|
* @default 'POST'
|
58
58
|
*/
|
59
|
-
method?: Value<HTTPMethod, [options: ClientOptions<T>, path: readonly string[], input: unknown]>;
|
59
|
+
method?: Value<Promisable<Exclude<HTTPMethod, 'HEAD'>>, [options: ClientOptions<T>, path: readonly string[], input: unknown]>;
|
60
60
|
/**
|
61
61
|
* The method to use when the payload cannot safely pass to the server with method return from method function.
|
62
62
|
* GET is not allowed, it's very dangerous.
|
63
63
|
*
|
64
64
|
* @default 'POST'
|
65
65
|
*/
|
66
|
-
fallbackMethod?: Exclude<HTTPMethod, 'GET'>;
|
66
|
+
fallbackMethod?: Exclude<HTTPMethod, 'HEAD' | 'GET'>;
|
67
67
|
/**
|
68
68
|
* Inject headers to the request.
|
69
69
|
*/
|
70
|
-
headers?: Value<StandardHeaders
|
70
|
+
headers?: Value<Promisable<StandardHeaders>, [options: ClientOptions<T>, path: readonly string[], input: unknown]>;
|
71
71
|
}
|
72
72
|
declare class StandardRPCLinkCodec<T extends ClientContext> implements StandardLinkCodec<T> {
|
73
73
|
private readonly serializer;
|
@@ -1,6 +1,6 @@
|
|
1
|
-
import { Interceptor
|
1
|
+
import { Interceptor } from '@orpc/shared';
|
2
2
|
import { StandardRequest, StandardLazyResponse } from '@orpc/standard-server';
|
3
|
-
import { a as ClientContext, b as ClientOptions, C as ClientLink } from './client.
|
3
|
+
import { a as ClientContext, b as ClientOptions, C as ClientLink } from './client.4TS_0JaO.mjs';
|
4
4
|
|
5
5
|
interface StandardLinkPlugin<T extends ClientContext> {
|
6
6
|
order?: number;
|
@@ -28,8 +28,8 @@ 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> {
|
@@ -1,4 +1,4 @@
|
|
1
|
-
import { isObject, isTypescriptObject } from '@orpc/shared';
|
1
|
+
import { isObject, AsyncIteratorClass, isTypescriptObject } from '@orpc/shared';
|
2
2
|
import { getEventMeta, withEventMeta } from '@orpc/standard-server';
|
3
3
|
|
4
4
|
const COMMON_ORPC_ERROR_DEFS = {
|
@@ -141,22 +141,17 @@ function createORPCErrorFromJson(json, options = {}) {
|
|
141
141
|
}
|
142
142
|
|
143
143
|
function mapEventIterator(iterator, maps) {
|
144
|
-
return async
|
144
|
+
return new AsyncIteratorClass(async () => {
|
145
145
|
try {
|
146
|
-
|
147
|
-
|
148
|
-
|
149
|
-
|
150
|
-
|
151
|
-
|
152
|
-
mappedValue = withEventMeta(mappedValue, meta);
|
153
|
-
}
|
146
|
+
const { done, value } = await iterator.next();
|
147
|
+
let mappedValue = await maps.value(value, done);
|
148
|
+
if (mappedValue !== value) {
|
149
|
+
const meta = getEventMeta(value);
|
150
|
+
if (meta && isTypescriptObject(mappedValue)) {
|
151
|
+
mappedValue = withEventMeta(mappedValue, meta);
|
154
152
|
}
|
155
|
-
if (done) {
|
156
|
-
return mappedValue;
|
157
|
-
}
|
158
|
-
yield mappedValue;
|
159
153
|
}
|
154
|
+
return { done, value: mappedValue };
|
160
155
|
} catch (error) {
|
161
156
|
let mappedError = await maps.error(error);
|
162
157
|
if (mappedError !== error) {
|
@@ -166,10 +161,12 @@ function mapEventIterator(iterator, maps) {
|
|
166
161
|
}
|
167
162
|
}
|
168
163
|
throw mappedError;
|
169
|
-
}
|
164
|
+
}
|
165
|
+
}, async (reason) => {
|
166
|
+
if (reason !== "next") {
|
170
167
|
await iterator.return?.();
|
171
168
|
}
|
172
|
-
}
|
169
|
+
});
|
173
170
|
}
|
174
171
|
|
175
172
|
export { COMMON_ORPC_ERROR_DEFS as C, ORPCError as O, fallbackORPCErrorMessage as a, isORPCErrorStatus as b, isORPCErrorJson as c, createORPCErrorFromJson as d, fallbackORPCErrorStatus as f, isDefinedError as i, mapEventIterator as m, toORPCError as t };
|