@orpc/client 0.0.0-next.e565b64 → 0.0.0-next.e6490f2
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 +4 -6
- package/dist/adapters/fetch/index.mjs +2 -2
- package/dist/adapters/message-port/index.mjs +4 -4
- package/dist/adapters/standard/index.mjs +2 -2
- package/dist/adapters/websocket/index.d.mts +1 -1
- package/dist/adapters/websocket/index.d.ts +1 -1
- package/dist/adapters/websocket/index.mjs +18 -5
- package/dist/index.d.mts +3 -3
- package/dist/index.d.ts +3 -3
- package/dist/index.mjs +4 -4
- package/dist/plugins/index.d.mts +44 -4
- package/dist/plugins/index.d.ts +44 -4
- package/dist/plugins/index.mjs +104 -6
- package/dist/shared/{client.CRWEpqLB.mjs → client.BX0_8bnM.mjs} +13 -16
- package/dist/shared/{client.DpICn1BD.mjs → client.CQCGVpTM.mjs} +1 -1
- package/package.json +6 -6
package/README.md
CHANGED
@@ -49,14 +49,12 @@ You can find the full documentation [here](https://orpc.unnoq.com).
|
|
49
49
|
- [@orpc/contract](https://www.npmjs.com/package/@orpc/contract): Build your API contract.
|
50
50
|
- [@orpc/server](https://www.npmjs.com/package/@orpc/server): Build your API or implement API contract.
|
51
51
|
- [@orpc/client](https://www.npmjs.com/package/@orpc/client): Consume your API on the client with type-safety.
|
52
|
-
- [@orpc/
|
52
|
+
- [@orpc/openapi](https://www.npmjs.com/package/@orpc/openapi): Generate OpenAPI specs and handle OpenAPI requests.
|
53
|
+
- [@orpc/nest](https://www.npmjs.com/package/@orpc/nest): Deeply integrate oRPC with [NestJS](https://nestjs.com/).
|
53
54
|
- [@orpc/react](https://www.npmjs.com/package/@orpc/react): Utilities for integrating oRPC with React and React Server Actions.
|
54
|
-
- [@orpc/
|
55
|
-
- [@orpc/vue-query](https://www.npmjs.com/package/@orpc/vue-query): Integration with [Vue Query](https://tanstack.com/query/latest/docs/framework/vue/overview).
|
56
|
-
- [@orpc/solid-query](https://www.npmjs.com/package/@orpc/solid-query): Integration with [Solid Query](https://tanstack.com/query/latest/docs/framework/solid/overview).
|
57
|
-
- [@orpc/svelte-query](https://www.npmjs.com/package/@orpc/svelte-query): Integration with [Svelte Query](https://tanstack.com/query/latest/docs/framework/svelte/overview).
|
55
|
+
- [@orpc/tanstack-query](https://www.npmjs.com/package/@orpc/tanstack-query): [TanStack Query](https://tanstack.com/query/latest) integration.
|
58
56
|
- [@orpc/vue-colada](https://www.npmjs.com/package/@orpc/vue-colada): Integration with [Pinia Colada](https://pinia-colada.esm.dev/).
|
59
|
-
- [@orpc/
|
57
|
+
- [@orpc/hey-api](https://www.npmjs.com/package/@orpc/hey-api): [Hey API](https://heyapi.dev/) integration.
|
60
58
|
- [@orpc/zod](https://www.npmjs.com/package/@orpc/zod): More schemas that [Zod](https://zod.dev/) doesn't support yet.
|
61
59
|
- [@orpc/valibot](https://www.npmjs.com/package/@orpc/valibot): OpenAPI spec generation from [Valibot](https://valibot.dev/).
|
62
60
|
- [@orpc/arktype](https://www.npmjs.com/package/@orpc/arktype): OpenAPI spec generation from [ArkType](https://arktype.io/).
|
@@ -1,8 +1,8 @@
|
|
1
1
|
import { toFetchRequest, toStandardLazyResponse } from '@orpc/standard-server-fetch';
|
2
2
|
import '@orpc/shared';
|
3
|
-
import { c as StandardRPCLink } from '../../shared/client.
|
3
|
+
import { c as StandardRPCLink } from '../../shared/client.CQCGVpTM.mjs';
|
4
4
|
import '@orpc/standard-server';
|
5
|
-
import '../../shared/client.
|
5
|
+
import '../../shared/client.BX0_8bnM.mjs';
|
6
6
|
|
7
7
|
class LinkFetchClient {
|
8
8
|
fetch;
|
@@ -1,8 +1,8 @@
|
|
1
1
|
import { ClientPeer } from '@orpc/standard-server-peer';
|
2
2
|
import '@orpc/shared';
|
3
|
-
import { c as StandardRPCLink } from '../../shared/client.
|
3
|
+
import { c as StandardRPCLink } from '../../shared/client.CQCGVpTM.mjs';
|
4
4
|
import '@orpc/standard-server';
|
5
|
-
import '../../shared/client.
|
5
|
+
import '../../shared/client.BX0_8bnM.mjs';
|
6
6
|
|
7
7
|
function postMessagePortMessage(port, data) {
|
8
8
|
port.postMessage(data);
|
@@ -45,8 +45,8 @@ function onMessagePortClose(port, callback) {
|
|
45
45
|
class experimental_LinkMessagePortClient {
|
46
46
|
peer;
|
47
47
|
constructor(options) {
|
48
|
-
this.peer = new ClientPeer(
|
49
|
-
postMessagePortMessage(options.port, message
|
48
|
+
this.peer = new ClientPeer((message) => {
|
49
|
+
return postMessagePortMessage(options.port, message);
|
50
50
|
});
|
51
51
|
onMessagePortMessage(options.port, async (message) => {
|
52
52
|
await this.peer.message(message);
|
@@ -1,4 +1,4 @@
|
|
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 } 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 } from '../../shared/client.CQCGVpTM.mjs';
|
2
2
|
import '@orpc/shared';
|
3
3
|
import '@orpc/standard-server';
|
4
|
-
import '../../shared/client.
|
4
|
+
import '../../shared/client.BX0_8bnM.mjs';
|
@@ -5,7 +5,7 @@ import { f as StandardRPCLinkOptions, g as StandardRPCLink } from '../../shared/
|
|
5
5
|
import '@orpc/shared';
|
6
6
|
|
7
7
|
interface experimental_LinkWebsocketClientOptions {
|
8
|
-
websocket: Pick<WebSocket, 'addEventListener' | 'send'>;
|
8
|
+
websocket: Pick<WebSocket, 'addEventListener' | 'send' | 'readyState'>;
|
9
9
|
}
|
10
10
|
declare class experimental_LinkWebsocketClient<T extends ClientContext> implements StandardLinkClient<T> {
|
11
11
|
private readonly peer;
|
@@ -5,7 +5,7 @@ import { f as StandardRPCLinkOptions, g as StandardRPCLink } from '../../shared/
|
|
5
5
|
import '@orpc/shared';
|
6
6
|
|
7
7
|
interface experimental_LinkWebsocketClientOptions {
|
8
|
-
websocket: Pick<WebSocket, 'addEventListener' | 'send'>;
|
8
|
+
websocket: Pick<WebSocket, 'addEventListener' | 'send' | 'readyState'>;
|
9
9
|
}
|
10
10
|
declare class experimental_LinkWebsocketClient<T extends ClientContext> implements StandardLinkClient<T> {
|
11
11
|
private readonly peer;
|
@@ -1,15 +1,28 @@
|
|
1
1
|
import { ClientPeer } from '@orpc/standard-server-peer';
|
2
2
|
import '@orpc/shared';
|
3
|
-
import { c as StandardRPCLink } from '../../shared/client.
|
3
|
+
import { c as StandardRPCLink } from '../../shared/client.CQCGVpTM.mjs';
|
4
4
|
import '@orpc/standard-server';
|
5
|
-
import '../../shared/client.
|
5
|
+
import '../../shared/client.BX0_8bnM.mjs';
|
6
6
|
|
7
7
|
class experimental_LinkWebsocketClient {
|
8
8
|
peer;
|
9
9
|
constructor(options) {
|
10
|
-
|
11
|
-
|
12
|
-
|
10
|
+
const untilOpen = new Promise((resolve) => {
|
11
|
+
if (options.websocket.readyState === 0) {
|
12
|
+
options.websocket.addEventListener("open", () => {
|
13
|
+
resolve();
|
14
|
+
}, { once: true });
|
15
|
+
} else {
|
16
|
+
resolve();
|
17
|
+
}
|
18
|
+
});
|
19
|
+
this.peer = new ClientPeer(async (message) => {
|
20
|
+
await untilOpen;
|
21
|
+
return options.websocket.send(message);
|
22
|
+
});
|
23
|
+
options.websocket.addEventListener("message", async (event) => {
|
24
|
+
const message = event.data instanceof Blob ? await event.data.arrayBuffer() : event.data;
|
25
|
+
this.peer.message(message);
|
13
26
|
});
|
14
27
|
options.websocket.addEventListener("close", () => {
|
15
28
|
this.peer.close();
|
package/dist/index.d.mts
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
import { N as NestedClient, C as ClientLink, I as InferClientContext, a as ClientContext, b as ClientOptions, c as ClientPromiseResult, F as FriendlyClientOptions } from './shared/client.4TS_0JaO.mjs';
|
2
2
|
export { f as Client, e as ClientRest, d as HTTPMethod, H as HTTPPath } from './shared/client.4TS_0JaO.mjs';
|
3
|
-
import { Promisable, MaybeOptionalOptions, ThrowableError } from '@orpc/shared';
|
4
|
-
export { Registry, ThrowableError, onError, onFinish, onStart, onSuccess } from '@orpc/shared';
|
3
|
+
import { Promisable, MaybeOptionalOptions, AsyncIteratorClass, ThrowableError } from '@orpc/shared';
|
4
|
+
export { EventPublisher, EventPublisherOptions, EventPublisherSubscribeIteratorOptions, Registry, ThrowableError, onError, onFinish, onStart, onSuccess } from '@orpc/shared';
|
5
5
|
export { ErrorEvent } from '@orpc/standard-server';
|
6
6
|
|
7
7
|
interface createORPCClientOptions {
|
@@ -138,7 +138,7 @@ declare function createORPCErrorFromJson<TCode extends ORPCErrorCode, TData>(jso
|
|
138
138
|
declare function mapEventIterator<TYield, TReturn, TNext, TMap = TYield | TReturn>(iterator: AsyncIterator<TYield, TReturn, TNext>, maps: {
|
139
139
|
value: (value: NoInfer<TYield | TReturn>, done: boolean | undefined) => Promise<TMap>;
|
140
140
|
error: (error: unknown) => Promise<unknown>;
|
141
|
-
}):
|
141
|
+
}): AsyncIteratorClass<TMap, TMap, TNext>;
|
142
142
|
|
143
143
|
type SafeResult<TOutput, TError> = [error: null, data: TOutput, isDefined: false, isSuccess: true] & {
|
144
144
|
error: null;
|
package/dist/index.d.ts
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
import { N as NestedClient, C as ClientLink, I as InferClientContext, a as ClientContext, b as ClientOptions, c as ClientPromiseResult, F as FriendlyClientOptions } from './shared/client.4TS_0JaO.js';
|
2
2
|
export { f as Client, e as ClientRest, d as HTTPMethod, H as HTTPPath } from './shared/client.4TS_0JaO.js';
|
3
|
-
import { Promisable, MaybeOptionalOptions, ThrowableError } from '@orpc/shared';
|
4
|
-
export { Registry, ThrowableError, onError, onFinish, onStart, onSuccess } from '@orpc/shared';
|
3
|
+
import { Promisable, MaybeOptionalOptions, AsyncIteratorClass, ThrowableError } from '@orpc/shared';
|
4
|
+
export { EventPublisher, EventPublisherOptions, EventPublisherSubscribeIteratorOptions, Registry, ThrowableError, onError, onFinish, onStart, onSuccess } from '@orpc/shared';
|
5
5
|
export { ErrorEvent } from '@orpc/standard-server';
|
6
6
|
|
7
7
|
interface createORPCClientOptions {
|
@@ -138,7 +138,7 @@ declare function createORPCErrorFromJson<TCode extends ORPCErrorCode, TData>(jso
|
|
138
138
|
declare function mapEventIterator<TYield, TReturn, TNext, TMap = TYield | TReturn>(iterator: AsyncIterator<TYield, TReturn, TNext>, maps: {
|
139
139
|
value: (value: NoInfer<TYield | TReturn>, done: boolean | undefined) => Promise<TMap>;
|
140
140
|
error: (error: unknown) => Promise<unknown>;
|
141
|
-
}):
|
141
|
+
}): AsyncIteratorClass<TMap, TMap, TNext>;
|
142
142
|
|
143
143
|
type SafeResult<TOutput, TError> = [error: null, data: TOutput, isDefined: false, isSuccess: true] & {
|
144
144
|
error: null;
|
package/dist/index.mjs
CHANGED
@@ -1,6 +1,6 @@
|
|
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
|
-
export { onError, onFinish, onStart, onSuccess } from '@orpc/shared';
|
1
|
+
import { i as isDefinedError } from './shared/client.BX0_8bnM.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.BX0_8bnM.mjs';
|
3
|
+
export { EventPublisher, onError, onFinish, onStart, onSuccess } from '@orpc/shared';
|
4
4
|
export { ErrorEvent } from '@orpc/standard-server';
|
5
5
|
|
6
6
|
async function safe(promise) {
|
@@ -27,7 +27,7 @@ async function safe(promise) {
|
|
27
27
|
function resolveFriendlyClientOptions(options) {
|
28
28
|
return {
|
29
29
|
...options,
|
30
|
-
context: options
|
30
|
+
context: options.context ?? {}
|
31
31
|
// Context only optional if all fields are optional
|
32
32
|
};
|
33
33
|
}
|
package/dist/plugins/index.d.mts
CHANGED
@@ -1,5 +1,6 @@
|
|
1
1
|
import { Value, Promisable } from '@orpc/shared';
|
2
2
|
import { StandardHeaders, StandardRequest } from '@orpc/standard-server';
|
3
|
+
import { BatchResponseMode } from '@orpc/standard-server/batch';
|
3
4
|
import { S as StandardLinkClientInterceptorOptions, a as StandardLinkPlugin, b as StandardLinkOptions, c as StandardLinkInterceptorOptions } from '../shared/client.BMoG_EdN.mjs';
|
4
5
|
import { a as ClientContext } from '../shared/client.4TS_0JaO.mjs';
|
5
6
|
|
@@ -17,6 +18,12 @@ interface BatchLinkPluginOptions<T extends ClientContext> {
|
|
17
18
|
* @default 10
|
18
19
|
*/
|
19
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
|
*
|
@@ -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;
|
@@ -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,5 +1,6 @@
|
|
1
1
|
import { Value, Promisable } from '@orpc/shared';
|
2
2
|
import { StandardHeaders, StandardRequest } from '@orpc/standard-server';
|
3
|
+
import { BatchResponseMode } from '@orpc/standard-server/batch';
|
3
4
|
import { S as StandardLinkClientInterceptorOptions, a as StandardLinkPlugin, b as StandardLinkOptions, c as StandardLinkInterceptorOptions } from '../shared/client.C0KbSWlC.js';
|
4
5
|
import { a as ClientContext } from '../shared/client.4TS_0JaO.js';
|
5
6
|
|
@@ -17,6 +18,12 @@ interface BatchLinkPluginOptions<T extends ClientContext> {
|
|
17
18
|
* @default 10
|
18
19
|
*/
|
19
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
|
*
|
@@ -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;
|
@@ -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 = {};
|
@@ -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,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 };
|
@@ -1,6 +1,6 @@
|
|
1
1
|
import { toArray, intercept, isObject, value, isAsyncIteratorObject, 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.BX0_8bnM.mjs';
|
4
4
|
|
5
5
|
class CompositeStandardLinkPlugin {
|
6
6
|
plugins;
|
package/package.json
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
{
|
2
2
|
"name": "@orpc/client",
|
3
3
|
"type": "module",
|
4
|
-
"version": "0.0.0-next.
|
4
|
+
"version": "0.0.0-next.e6490f2",
|
5
5
|
"license": "MIT",
|
6
6
|
"homepage": "https://orpc.unnoq.com",
|
7
7
|
"repository": {
|
@@ -49,13 +49,13 @@
|
|
49
49
|
"dist"
|
50
50
|
],
|
51
51
|
"dependencies": {
|
52
|
-
"@orpc/shared": "0.0.0-next.
|
53
|
-
"@orpc/standard-server
|
54
|
-
"@orpc/standard-server": "0.0.0-next.
|
55
|
-
"@orpc/standard-server-
|
52
|
+
"@orpc/shared": "0.0.0-next.e6490f2",
|
53
|
+
"@orpc/standard-server": "0.0.0-next.e6490f2",
|
54
|
+
"@orpc/standard-server-peer": "0.0.0-next.e6490f2",
|
55
|
+
"@orpc/standard-server-fetch": "0.0.0-next.e6490f2"
|
56
56
|
},
|
57
57
|
"devDependencies": {
|
58
|
-
"zod": "^3.25.
|
58
|
+
"zod": "^3.25.49"
|
59
59
|
},
|
60
60
|
"scripts": {
|
61
61
|
"build": "unbuild",
|