@orpc/server 0.0.0-next.e7896e2 → 0.0.0-next.e7c0280
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 +2 -2
- package/dist/adapters/aws-lambda/index.d.mts +7 -6
- package/dist/adapters/aws-lambda/index.d.ts +7 -6
- package/dist/adapters/aws-lambda/index.mjs +5 -4
- package/dist/adapters/bun-ws/index.d.mts +12 -11
- package/dist/adapters/bun-ws/index.d.ts +12 -11
- package/dist/adapters/bun-ws/index.mjs +16 -20
- package/dist/adapters/crossws/index.d.mts +8 -5
- package/dist/adapters/crossws/index.d.ts +8 -5
- package/dist/adapters/crossws/index.mjs +13 -17
- package/dist/adapters/fetch/index.d.mts +5 -4
- package/dist/adapters/fetch/index.d.ts +5 -4
- package/dist/adapters/fetch/index.mjs +2 -2
- package/dist/adapters/message-port/index.d.mts +11 -8
- package/dist/adapters/message-port/index.d.ts +11 -8
- package/dist/adapters/message-port/index.mjs +16 -16
- package/dist/adapters/node/index.d.mts +5 -4
- package/dist/adapters/node/index.d.ts +5 -4
- package/dist/adapters/node/index.mjs +3 -2
- package/dist/adapters/standard/index.d.mts +8 -13
- package/dist/adapters/standard/index.d.ts +8 -13
- package/dist/adapters/standard/index.mjs +3 -2
- package/dist/adapters/standard-peer/index.d.mts +14 -0
- package/dist/adapters/standard-peer/index.d.ts +14 -0
- package/dist/adapters/standard-peer/index.mjs +7 -0
- package/dist/adapters/websocket/index.d.mts +36 -9
- package/dist/adapters/websocket/index.d.ts +36 -9
- package/dist/adapters/websocket/index.mjs +51 -20
- package/dist/adapters/ws/index.d.mts +11 -8
- package/dist/adapters/ws/index.d.ts +11 -8
- package/dist/adapters/ws/index.mjs +15 -14
- package/dist/helpers/index.d.mts +130 -0
- package/dist/helpers/index.d.ts +130 -0
- package/dist/helpers/index.mjs +182 -0
- package/dist/hibernation/index.d.mts +44 -0
- package/dist/hibernation/index.d.ts +44 -0
- package/dist/hibernation/index.mjs +65 -0
- package/dist/index.d.mts +16 -47
- package/dist/index.d.ts +16 -47
- package/dist/index.mjs +7 -6
- package/dist/plugins/index.d.mts +17 -4
- package/dist/plugins/index.d.ts +17 -4
- package/dist/plugins/index.mjs +27 -4
- package/dist/shared/server.B7b2w3_i.d.ts +12 -0
- package/dist/shared/server.BEFBl-Cb.d.mts +12 -0
- package/dist/shared/server.BU4WI18A.d.mts +32 -0
- package/dist/shared/{server.-ACo36I0.d.ts → server.Bmh5xd4n.d.ts} +3 -3
- package/dist/shared/server.C6Q5sqYw.mjs +20 -0
- package/dist/shared/{server.CHvOkcM3.mjs → server.CIL9uKTN.mjs} +12 -4
- package/dist/shared/{server.DD2C4ujN.d.mts → server.CYNGeoCm.d.mts} +6 -4
- package/dist/shared/{server.DD2C4ujN.d.ts → server.CYNGeoCm.d.ts} +6 -4
- package/dist/shared/server.D0H-iaY3.d.ts +32 -0
- package/dist/shared/server.DhJj-1X9.d.mts +42 -0
- package/dist/shared/{server.DG7Tamti.mjs → server.NeumLVdS.mjs} +13 -10
- package/dist/shared/{server.Dq8xr7PQ.d.mts → server.gqRxT-yN.d.mts} +3 -3
- package/dist/shared/server.jMTkVNIb.d.ts +42 -0
- package/package.json +28 -12
- package/dist/shared/server.BPAWobQg.d.ts +0 -12
- package/dist/shared/server.Bd52nNaH.d.mts +0 -12
- package/dist/shared/server.BliFSTnG.d.mts +0 -10
- package/dist/shared/server.IG2MjhrD.d.ts +0 -10
@@ -0,0 +1,130 @@
|
|
1
|
+
import { SerializeOptions, ParseOptions } from 'cookie';
|
2
|
+
|
3
|
+
/**
|
4
|
+
* Encodes a Uint8Array to base64url format
|
5
|
+
* Base64url is URL-safe and doesn't use padding
|
6
|
+
*
|
7
|
+
* @example
|
8
|
+
* ```ts
|
9
|
+
* const text = "Hello World"
|
10
|
+
* const encoded = encodeBase64url(new TextEncoder().encode(text))
|
11
|
+
* const decoded = decodeBase64url(encoded)
|
12
|
+
* expect(new TextDecoder().decode(decoded)).toEqual(text)
|
13
|
+
* ```
|
14
|
+
*/
|
15
|
+
declare function encodeBase64url(data: Uint8Array): string;
|
16
|
+
/**
|
17
|
+
* Decodes a base64url string to Uint8Array
|
18
|
+
* Returns undefined if the input is invalid
|
19
|
+
*
|
20
|
+
* @example
|
21
|
+
* ```ts
|
22
|
+
* const text = "Hello World"
|
23
|
+
* const encoded = encodeBase64url(new TextEncoder().encode(text))
|
24
|
+
* const decoded = decodeBase64url(encoded)
|
25
|
+
* expect(new TextDecoder().decode(decoded)).toEqual(text)
|
26
|
+
* ```
|
27
|
+
*/
|
28
|
+
declare function decodeBase64url(base64url: string | undefined | null): Uint8Array | undefined;
|
29
|
+
|
30
|
+
interface SetCookieOptions extends SerializeOptions {
|
31
|
+
/**
|
32
|
+
* Specifies the value for the [`Path` `Set-Cookie` attribute](https://tools.ietf.org/html/rfc6265#section-5.2.4).
|
33
|
+
*
|
34
|
+
* @default '/'
|
35
|
+
*/
|
36
|
+
path?: string;
|
37
|
+
}
|
38
|
+
/**
|
39
|
+
* Sets a cookie in the response headers,
|
40
|
+
*
|
41
|
+
* Does nothing if `headers` is `undefined`.
|
42
|
+
*
|
43
|
+
* @example
|
44
|
+
* ```ts
|
45
|
+
* const headers = new Headers()
|
46
|
+
*
|
47
|
+
* setCookie(headers, 'sessionId', 'abc123', { httpOnly: true, maxAge: 3600 })
|
48
|
+
*
|
49
|
+
* expect(headers.get('Set-Cookie')).toBe('sessionId=abc123; HttpOnly; Max-Age=3600')
|
50
|
+
* ```
|
51
|
+
*
|
52
|
+
*/
|
53
|
+
declare function setCookie(headers: Headers | undefined, name: string, value: string, options?: SetCookieOptions): void;
|
54
|
+
interface GetCookieOptions extends ParseOptions {
|
55
|
+
}
|
56
|
+
/**
|
57
|
+
* Gets a cookie value from request headers
|
58
|
+
*
|
59
|
+
* Returns `undefined` if the cookie is not found or headers are `undefined`.
|
60
|
+
*
|
61
|
+
* @example
|
62
|
+
* ```ts
|
63
|
+
* const headers = new Headers({ 'Cookie': 'sessionId=abc123; theme=dark' })
|
64
|
+
*
|
65
|
+
* const sessionId = getCookie(headers, 'sessionId')
|
66
|
+
*
|
67
|
+
* expect(sessionId).toEqual('abc123')
|
68
|
+
* ```
|
69
|
+
*/
|
70
|
+
declare function getCookie(headers: Headers | undefined, name: string, options?: GetCookieOptions): string | undefined;
|
71
|
+
|
72
|
+
/**
|
73
|
+
* Encrypts a string using AES-GCM with a secret key.
|
74
|
+
* The output is base64url encoded to be URL-safe.
|
75
|
+
*
|
76
|
+
* @example
|
77
|
+
* ```ts
|
78
|
+
* const encrypted = await encrypt("Hello, World!", "test-secret-key")
|
79
|
+
* const decrypted = await decrypt(encrypted, "test-secret-key")
|
80
|
+
* expect(decrypted).toBe("Hello, World!")
|
81
|
+
* ```
|
82
|
+
*/
|
83
|
+
declare function encrypt(value: string, secret: string): Promise<string>;
|
84
|
+
/**
|
85
|
+
* Decrypts a base64url encoded string using AES-GCM with a secret key.
|
86
|
+
* Returns the original string if decryption is successful, or undefined if it fails.
|
87
|
+
*
|
88
|
+
* @example
|
89
|
+
* ```ts
|
90
|
+
* const encrypted = await encrypt("Hello, World!", "test-secret-key")
|
91
|
+
* const decrypted = await decrypt(encrypted, "test-secret-key")
|
92
|
+
* expect(decrypted).toBe("Hello, World!")
|
93
|
+
* ```
|
94
|
+
*/
|
95
|
+
declare function decrypt(encrypted: string | undefined | null, secret: string): Promise<string | undefined>;
|
96
|
+
|
97
|
+
/**
|
98
|
+
* Signs a string value using HMAC-SHA256 with a secret key.
|
99
|
+
*
|
100
|
+
* This function creates a cryptographic signature that can be used to verify
|
101
|
+
* the integrity and authenticity of the data. The signature is appended to
|
102
|
+
* the original value, separated by a dot, using base64url encoding (no padding).
|
103
|
+
*
|
104
|
+
*
|
105
|
+
* @example
|
106
|
+
* ```ts
|
107
|
+
* const signedValue = await sign("user123", "my-secret-key")
|
108
|
+
* expect(signedValue).toEqual("user123.oneQsU0r5dvwQFHFEjjV1uOI_IR3gZfkYHij3TRauVA")
|
109
|
+
* ```
|
110
|
+
*/
|
111
|
+
declare function sign(value: string, secret: string): Promise<string>;
|
112
|
+
/**
|
113
|
+
* Verifies and extracts the original value from a signed string.
|
114
|
+
*
|
115
|
+
* This function validates the signature of a previously signed value using the same
|
116
|
+
* secret key. If the signature is valid, it returns the original value. If the
|
117
|
+
* signature is invalid or the format is incorrect, it returns undefined.
|
118
|
+
*
|
119
|
+
*
|
120
|
+
* @example
|
121
|
+
* ```ts
|
122
|
+
* const signedValue = "user123.oneQsU0r5dvwQFHFEjjV1uOI_IR3gZfkYHij3TRauVA"
|
123
|
+
* const originalValue = await unsign(signedValue, "my-secret-key")
|
124
|
+
* expect(originalValue).toEqual("user123")
|
125
|
+
* ```
|
126
|
+
*/
|
127
|
+
declare function unsign(signedValue: string | undefined | null, secret: string): Promise<string | undefined>;
|
128
|
+
|
129
|
+
export { decodeBase64url, decrypt, encodeBase64url, encrypt, getCookie, setCookie, sign, unsign };
|
130
|
+
export type { GetCookieOptions, SetCookieOptions };
|
@@ -0,0 +1,182 @@
|
|
1
|
+
import { serialize, parse } from 'cookie';
|
2
|
+
|
3
|
+
function encodeBase64url(data) {
|
4
|
+
const chunkSize = 8192;
|
5
|
+
let binaryString = "";
|
6
|
+
for (let i = 0; i < data.length; i += chunkSize) {
|
7
|
+
const chunk = data.subarray(i, i + chunkSize);
|
8
|
+
binaryString += String.fromCharCode(...chunk);
|
9
|
+
}
|
10
|
+
const base64 = btoa(binaryString);
|
11
|
+
return base64.replace(/\+/g, "-").replace(/\//g, "_").replace(/=/g, "");
|
12
|
+
}
|
13
|
+
function decodeBase64url(base64url) {
|
14
|
+
try {
|
15
|
+
if (typeof base64url !== "string") {
|
16
|
+
return void 0;
|
17
|
+
}
|
18
|
+
let base64 = base64url.replace(/-/g, "+").replace(/_/g, "/");
|
19
|
+
while (base64.length % 4) {
|
20
|
+
base64 += "=";
|
21
|
+
}
|
22
|
+
const binaryString = atob(base64);
|
23
|
+
const bytes = new Uint8Array(binaryString.length);
|
24
|
+
for (let i = 0; i < binaryString.length; i++) {
|
25
|
+
bytes[i] = binaryString.charCodeAt(i);
|
26
|
+
}
|
27
|
+
return bytes;
|
28
|
+
} catch {
|
29
|
+
return void 0;
|
30
|
+
}
|
31
|
+
}
|
32
|
+
|
33
|
+
function setCookie(headers, name, value, options = {}) {
|
34
|
+
if (headers === void 0) {
|
35
|
+
return;
|
36
|
+
}
|
37
|
+
const cookieString = serialize(name, value, {
|
38
|
+
path: "/",
|
39
|
+
...options
|
40
|
+
});
|
41
|
+
headers.append("Set-Cookie", cookieString);
|
42
|
+
}
|
43
|
+
function getCookie(headers, name, options = {}) {
|
44
|
+
if (headers === void 0) {
|
45
|
+
return void 0;
|
46
|
+
}
|
47
|
+
const cookieHeader = headers.get("cookie");
|
48
|
+
if (cookieHeader === null) {
|
49
|
+
return void 0;
|
50
|
+
}
|
51
|
+
return parse(cookieHeader, options)[name];
|
52
|
+
}
|
53
|
+
|
54
|
+
const PBKDF2_CONFIG = {
|
55
|
+
name: "PBKDF2",
|
56
|
+
iterations: 6e4,
|
57
|
+
// Recommended minimum iterations per current OWASP guidelines
|
58
|
+
hash: "SHA-256"
|
59
|
+
};
|
60
|
+
const AES_GCM_CONFIG = {
|
61
|
+
name: "AES-GCM",
|
62
|
+
length: 256
|
63
|
+
};
|
64
|
+
const CRYPTO_CONSTANTS = {
|
65
|
+
SALT_LENGTH: 16,
|
66
|
+
IV_LENGTH: 12
|
67
|
+
};
|
68
|
+
async function encrypt(value, secret) {
|
69
|
+
const encoder = new TextEncoder();
|
70
|
+
const data = encoder.encode(value);
|
71
|
+
const salt = crypto.getRandomValues(new Uint8Array(CRYPTO_CONSTANTS.SALT_LENGTH));
|
72
|
+
const keyMaterial = await crypto.subtle.importKey(
|
73
|
+
"raw",
|
74
|
+
encoder.encode(secret),
|
75
|
+
PBKDF2_CONFIG.name,
|
76
|
+
false,
|
77
|
+
["deriveKey"]
|
78
|
+
);
|
79
|
+
const key = await crypto.subtle.deriveKey(
|
80
|
+
{ ...PBKDF2_CONFIG, salt },
|
81
|
+
keyMaterial,
|
82
|
+
AES_GCM_CONFIG,
|
83
|
+
false,
|
84
|
+
["encrypt"]
|
85
|
+
);
|
86
|
+
const iv = crypto.getRandomValues(new Uint8Array(CRYPTO_CONSTANTS.IV_LENGTH));
|
87
|
+
const encrypted = await crypto.subtle.encrypt(
|
88
|
+
{ name: AES_GCM_CONFIG.name, iv },
|
89
|
+
key,
|
90
|
+
data
|
91
|
+
);
|
92
|
+
const result = new Uint8Array(salt.length + iv.length + encrypted.byteLength);
|
93
|
+
result.set(salt, 0);
|
94
|
+
result.set(iv, salt.length);
|
95
|
+
result.set(new Uint8Array(encrypted), salt.length + iv.length);
|
96
|
+
return encodeBase64url(result);
|
97
|
+
}
|
98
|
+
async function decrypt(encrypted, secret) {
|
99
|
+
try {
|
100
|
+
const data = decodeBase64url(encrypted);
|
101
|
+
if (data === void 0) {
|
102
|
+
return void 0;
|
103
|
+
}
|
104
|
+
const encoder = new TextEncoder();
|
105
|
+
const decoder = new TextDecoder();
|
106
|
+
const salt = data.slice(0, CRYPTO_CONSTANTS.SALT_LENGTH);
|
107
|
+
const iv = data.slice(CRYPTO_CONSTANTS.SALT_LENGTH, CRYPTO_CONSTANTS.SALT_LENGTH + CRYPTO_CONSTANTS.IV_LENGTH);
|
108
|
+
const encryptedData = data.slice(CRYPTO_CONSTANTS.SALT_LENGTH + CRYPTO_CONSTANTS.IV_LENGTH);
|
109
|
+
const keyMaterial = await crypto.subtle.importKey(
|
110
|
+
"raw",
|
111
|
+
encoder.encode(secret),
|
112
|
+
PBKDF2_CONFIG.name,
|
113
|
+
false,
|
114
|
+
["deriveKey"]
|
115
|
+
);
|
116
|
+
const key = await crypto.subtle.deriveKey(
|
117
|
+
{ ...PBKDF2_CONFIG, salt },
|
118
|
+
keyMaterial,
|
119
|
+
AES_GCM_CONFIG,
|
120
|
+
false,
|
121
|
+
["decrypt"]
|
122
|
+
);
|
123
|
+
const decrypted = await crypto.subtle.decrypt(
|
124
|
+
{ name: AES_GCM_CONFIG.name, iv },
|
125
|
+
key,
|
126
|
+
encryptedData
|
127
|
+
);
|
128
|
+
return decoder.decode(decrypted);
|
129
|
+
} catch {
|
130
|
+
return void 0;
|
131
|
+
}
|
132
|
+
}
|
133
|
+
|
134
|
+
const ALGORITHM = { name: "HMAC", hash: "SHA-256" };
|
135
|
+
async function sign(value, secret) {
|
136
|
+
const encoder = new TextEncoder();
|
137
|
+
const key = await crypto.subtle.importKey(
|
138
|
+
"raw",
|
139
|
+
encoder.encode(secret),
|
140
|
+
ALGORITHM,
|
141
|
+
false,
|
142
|
+
["sign"]
|
143
|
+
);
|
144
|
+
const signature = await crypto.subtle.sign(
|
145
|
+
ALGORITHM,
|
146
|
+
key,
|
147
|
+
encoder.encode(value)
|
148
|
+
);
|
149
|
+
return `${value}.${encodeBase64url(new Uint8Array(signature))}`;
|
150
|
+
}
|
151
|
+
async function unsign(signedValue, secret) {
|
152
|
+
if (typeof signedValue !== "string") {
|
153
|
+
return void 0;
|
154
|
+
}
|
155
|
+
const lastDotIndex = signedValue.lastIndexOf(".");
|
156
|
+
if (lastDotIndex === -1) {
|
157
|
+
return void 0;
|
158
|
+
}
|
159
|
+
const value = signedValue.slice(0, lastDotIndex);
|
160
|
+
const signatureBase64url = signedValue.slice(lastDotIndex + 1);
|
161
|
+
const signature = decodeBase64url(signatureBase64url);
|
162
|
+
if (signature === void 0) {
|
163
|
+
return void 0;
|
164
|
+
}
|
165
|
+
const encoder = new TextEncoder();
|
166
|
+
const key = await crypto.subtle.importKey(
|
167
|
+
"raw",
|
168
|
+
encoder.encode(secret),
|
169
|
+
ALGORITHM,
|
170
|
+
false,
|
171
|
+
["verify"]
|
172
|
+
);
|
173
|
+
const isValid = await crypto.subtle.verify(
|
174
|
+
ALGORITHM,
|
175
|
+
key,
|
176
|
+
signature,
|
177
|
+
encoder.encode(value)
|
178
|
+
);
|
179
|
+
return isValid ? value : void 0;
|
180
|
+
}
|
181
|
+
|
182
|
+
export { decodeBase64url, decrypt, encodeBase64url, encrypt, getCookie, setCookie, sign, unsign };
|
@@ -0,0 +1,44 @@
|
|
1
|
+
import { StandardRPCJsonSerializerOptions } from '@orpc/client/standard';
|
2
|
+
import { g as StandardHandlerPlugin, e as StandardHandlerOptions } from '../shared/server.gqRxT-yN.mjs';
|
3
|
+
import { experimental_HibernationEventIterator } from '@orpc/standard-server';
|
4
|
+
export { experimental_HibernationEventIterator, experimental_HibernationEventIteratorCallback } from '@orpc/standard-server';
|
5
|
+
import { C as Context, R as Router } from '../shared/server.CYNGeoCm.mjs';
|
6
|
+
import '@orpc/client';
|
7
|
+
import '@orpc/contract';
|
8
|
+
import '@orpc/shared';
|
9
|
+
|
10
|
+
interface experimental_EncodeHibernationRPCEventOptions extends StandardRPCJsonSerializerOptions {
|
11
|
+
/**
|
12
|
+
* The type of event, each type corresponds a different operation
|
13
|
+
*
|
14
|
+
* - 'message' = 'yield'
|
15
|
+
* - 'error' = 'throw'
|
16
|
+
* - 'done' = 'return'
|
17
|
+
*
|
18
|
+
* @default 'message'
|
19
|
+
*/
|
20
|
+
event?: 'message' | 'error' | 'done';
|
21
|
+
}
|
22
|
+
/**
|
23
|
+
* Encodes a Hibernation RPC Event
|
24
|
+
*
|
25
|
+
* @see {@link https://orpc.unnoq.com/docs/plugins/hibernation Hibernation Plugin}
|
26
|
+
*/
|
27
|
+
declare function experimental_encodeHibernationRPCEvent(id: string, payload: unknown, options?: experimental_EncodeHibernationRPCEventOptions): string;
|
28
|
+
|
29
|
+
interface experimental_HibernationPluginContext {
|
30
|
+
iterator?: experimental_HibernationEventIterator<any>;
|
31
|
+
}
|
32
|
+
/**
|
33
|
+
* Enable Hibernation APIs
|
34
|
+
*
|
35
|
+
* @see {@link https://orpc.unnoq.com/docs/plugins/hibernation Hibernation Plugin}
|
36
|
+
*/
|
37
|
+
declare class experimental_HibernationPlugin<T extends Context> implements StandardHandlerPlugin<T> {
|
38
|
+
readonly CONTEXT_SYMBOL: symbol;
|
39
|
+
order: number;
|
40
|
+
init(options: StandardHandlerOptions<T>, _router: Router<any, T>): void;
|
41
|
+
}
|
42
|
+
|
43
|
+
export { experimental_HibernationPlugin, experimental_encodeHibernationRPCEvent };
|
44
|
+
export type { experimental_EncodeHibernationRPCEventOptions, experimental_HibernationPluginContext };
|
@@ -0,0 +1,44 @@
|
|
1
|
+
import { StandardRPCJsonSerializerOptions } from '@orpc/client/standard';
|
2
|
+
import { g as StandardHandlerPlugin, e as StandardHandlerOptions } from '../shared/server.Bmh5xd4n.js';
|
3
|
+
import { experimental_HibernationEventIterator } from '@orpc/standard-server';
|
4
|
+
export { experimental_HibernationEventIterator, experimental_HibernationEventIteratorCallback } from '@orpc/standard-server';
|
5
|
+
import { C as Context, R as Router } from '../shared/server.CYNGeoCm.js';
|
6
|
+
import '@orpc/client';
|
7
|
+
import '@orpc/contract';
|
8
|
+
import '@orpc/shared';
|
9
|
+
|
10
|
+
interface experimental_EncodeHibernationRPCEventOptions extends StandardRPCJsonSerializerOptions {
|
11
|
+
/**
|
12
|
+
* The type of event, each type corresponds a different operation
|
13
|
+
*
|
14
|
+
* - 'message' = 'yield'
|
15
|
+
* - 'error' = 'throw'
|
16
|
+
* - 'done' = 'return'
|
17
|
+
*
|
18
|
+
* @default 'message'
|
19
|
+
*/
|
20
|
+
event?: 'message' | 'error' | 'done';
|
21
|
+
}
|
22
|
+
/**
|
23
|
+
* Encodes a Hibernation RPC Event
|
24
|
+
*
|
25
|
+
* @see {@link https://orpc.unnoq.com/docs/plugins/hibernation Hibernation Plugin}
|
26
|
+
*/
|
27
|
+
declare function experimental_encodeHibernationRPCEvent(id: string, payload: unknown, options?: experimental_EncodeHibernationRPCEventOptions): string;
|
28
|
+
|
29
|
+
interface experimental_HibernationPluginContext {
|
30
|
+
iterator?: experimental_HibernationEventIterator<any>;
|
31
|
+
}
|
32
|
+
/**
|
33
|
+
* Enable Hibernation APIs
|
34
|
+
*
|
35
|
+
* @see {@link https://orpc.unnoq.com/docs/plugins/hibernation Hibernation Plugin}
|
36
|
+
*/
|
37
|
+
declare class experimental_HibernationPlugin<T extends Context> implements StandardHandlerPlugin<T> {
|
38
|
+
readonly CONTEXT_SYMBOL: symbol;
|
39
|
+
order: number;
|
40
|
+
init(options: StandardHandlerOptions<T>, _router: Router<any, T>): void;
|
41
|
+
}
|
42
|
+
|
43
|
+
export { experimental_HibernationPlugin, experimental_encodeHibernationRPCEvent };
|
44
|
+
export type { experimental_EncodeHibernationRPCEventOptions, experimental_HibernationPluginContext };
|
@@ -0,0 +1,65 @@
|
|
1
|
+
import { toORPCError } from '@orpc/client';
|
2
|
+
import { StandardRPCJsonSerializer } from '@orpc/client/standard';
|
3
|
+
import { stringifyJSON } from '@orpc/shared';
|
4
|
+
import { getEventMeta, experimental_HibernationEventIterator } from '@orpc/standard-server';
|
5
|
+
export { experimental_HibernationEventIterator } from '@orpc/standard-server';
|
6
|
+
import { MessageType } from '@orpc/standard-server-peer';
|
7
|
+
|
8
|
+
function experimental_encodeHibernationRPCEvent(id, payload, options = {}) {
|
9
|
+
const { event = "message", ...rest } = options;
|
10
|
+
const serializer = new StandardRPCJsonSerializer(rest);
|
11
|
+
const data = event === "error" ? toORPCError(payload).toJSON() : payload;
|
12
|
+
const [json, meta] = serializer.serialize(data);
|
13
|
+
return stringifyJSON({
|
14
|
+
i: id,
|
15
|
+
t: MessageType.EVENT_ITERATOR,
|
16
|
+
p: {
|
17
|
+
e: event,
|
18
|
+
d: { json, meta: meta.length > 0 ? meta : void 0 },
|
19
|
+
m: getEventMeta(payload)
|
20
|
+
}
|
21
|
+
});
|
22
|
+
}
|
23
|
+
|
24
|
+
class experimental_HibernationPlugin {
|
25
|
+
CONTEXT_SYMBOL = Symbol("ORPC_HIBERNATION_CONTEXT");
|
26
|
+
order = 2e6;
|
27
|
+
// make sure execute after the batch plugin
|
28
|
+
init(options, _router) {
|
29
|
+
options.interceptors ??= [];
|
30
|
+
options.clientInterceptors ??= [];
|
31
|
+
options.interceptors.unshift(async (options2) => {
|
32
|
+
const hibernationContext = {};
|
33
|
+
const result = await options2.next({
|
34
|
+
...options2,
|
35
|
+
context: {
|
36
|
+
[this.CONTEXT_SYMBOL]: hibernationContext,
|
37
|
+
...options2.context
|
38
|
+
}
|
39
|
+
});
|
40
|
+
if (!result.matched || !hibernationContext.iterator) {
|
41
|
+
return result;
|
42
|
+
}
|
43
|
+
return {
|
44
|
+
...result,
|
45
|
+
response: {
|
46
|
+
...result.response,
|
47
|
+
body: hibernationContext.iterator
|
48
|
+
}
|
49
|
+
};
|
50
|
+
});
|
51
|
+
options.clientInterceptors.unshift(async (options2) => {
|
52
|
+
const hibernationContext = options2.context[this.CONTEXT_SYMBOL];
|
53
|
+
if (!hibernationContext) {
|
54
|
+
throw new TypeError("[HibernationPlugin] Hibernation context has been corrupted or modified by another plugin or interceptor");
|
55
|
+
}
|
56
|
+
const output = await options2.next();
|
57
|
+
if (output instanceof experimental_HibernationEventIterator) {
|
58
|
+
hibernationContext.iterator = output;
|
59
|
+
}
|
60
|
+
return output;
|
61
|
+
});
|
62
|
+
}
|
63
|
+
}
|
64
|
+
|
65
|
+
export { experimental_HibernationPlugin, experimental_encodeHibernationRPCEvent };
|
package/dist/index.d.mts
CHANGED
@@ -1,11 +1,13 @@
|
|
1
|
-
import { ORPCErrorJSON, ORPCError, Client, ClientContext, HTTPPath, HTTPMethod, ClientPromiseResult } from '@orpc/client';
|
1
|
+
import { ORPCErrorJSON, ORPCError, Client, ClientContext, HTTPPath, HTTPMethod, ClientOptions, ClientPromiseResult } from '@orpc/client';
|
2
2
|
export { ClientContext, HTTPMethod, HTTPPath, ORPCError, isDefinedError, safe } from '@orpc/client';
|
3
|
-
import { AnySchema, ErrorMap, InferSchemaInput, InferSchemaOutput, ErrorFromErrorMap, Meta, MergedErrorMap, Route,
|
3
|
+
import { AnySchema, ErrorMap, InferSchemaInput, InferSchemaOutput, ErrorFromErrorMap, Meta, MergedErrorMap, Route, Schema, ContractRouter, ContractProcedureDef, AnyContractRouter, ContractProcedure, InferContractRouterErrorMap, InferContractRouterMeta, AnyContractProcedure } from '@orpc/contract';
|
4
4
|
export { ContractProcedure, ContractProcedureDef, ContractRouter, ErrorMap, ErrorMapItem, InferSchemaInput, InferSchemaOutput, InputStructure, MergedErrorMap, Meta, OutputStructure, Route, Schema, ValidationError, eventIterator, type } from '@orpc/contract';
|
5
5
|
import { ThrowableError, IntersectPick, MaybeOptionalOptions } from '@orpc/shared';
|
6
|
-
export { EventPublisher, EventPublisherOptions, EventPublisherSubscribeIteratorOptions, IntersectPick, Registry, ThrowableError, onError, onFinish, onStart, onSuccess } from '@orpc/shared';
|
7
|
-
import { C as Context, P as Procedure,
|
8
|
-
export { J as InferRouterCurrentContexts, H as InferRouterInitialContexts, K as InferRouterInputs, N as InferRouterOutputs,
|
6
|
+
export { EventPublisher, EventPublisherOptions, EventPublisherSubscribeIteratorOptions, IntersectPick, Registry, ThrowableError, asyncIteratorToStream as eventIteratorToStream, onError, onFinish, onStart, onSuccess, streamToAsyncIteratorClass as streamToEventIterator } from '@orpc/shared';
|
7
|
+
import { C as Context, P as Procedure, e as Middleware, O as ORPCErrorConstructorMap, M as MergedInitialContext, f as MergedCurrentContext, g as MapInputMiddleware, h as CreateProcedureClientOptions, i as ProcedureClient, j as ProcedureHandler, R as Router, c as Lazy, a as AnyMiddleware, b as AnyRouter, A as AnyProcedure, L as Lazyable, I as InferRouterInitialContext } from './shared/server.CYNGeoCm.mjs';
|
8
|
+
export { J as InferRouterCurrentContexts, H as InferRouterInitialContexts, K as InferRouterInputs, N as InferRouterOutputs, o as LAZY_SYMBOL, p as LazyMeta, x as MiddlewareNextFn, w as MiddlewareNextFnOptions, z as MiddlewareOptions, y as MiddlewareOutputFn, t as MiddlewareResult, l as ORPCErrorConstructorMapItem, k as ORPCErrorConstructorMapItemOptions, d as ProcedureClientInterceptorOptions, E as ProcedureDef, D as ProcedureHandlerOptions, n as createORPCErrorConstructorMap, G as createProcedureClient, s as getLazyMeta, r as isLazy, F as isProcedure, q as lazy, m as mergeCurrentContext, B as middlewareOutputFn, u as unlazy, v as validateORPCError } from './shared/server.CYNGeoCm.mjs';
|
9
|
+
import { E as EnhanceRouterOptions, a as EnhancedRouter } from './shared/server.DhJj-1X9.mjs';
|
10
|
+
export { A as AccessibleLazyRouter, C as ContractProcedureCallbackOptions, L as LazyTraverseContractProceduresOptions, T as TraverseContractProcedureCallbackOptions, b as TraverseContractProceduresOptions, U as UnlaziedRouter, c as createAccessibleLazyRouter, e as enhanceRouter, g as getRouter, r as resolveContractProcedures, t as traverseContractProcedures, u as unlazyRouter } from './shared/server.DhJj-1X9.mjs';
|
9
11
|
export { getEventMeta, withEventMeta } from '@orpc/standard-server';
|
10
12
|
|
11
13
|
type ActionableError<T> = T extends ORPCError<infer U, infer V> ? ORPCErrorJSON<U, V> & {
|
@@ -80,39 +82,6 @@ declare class DecoratedProcedure<TInitialContext extends Context, TCurrentContex
|
|
80
82
|
actionable(...rest: MaybeOptionalOptions<CreateProcedureClientOptions<TInitialContext, TOutputSchema, TErrorMap, TMeta, Record<never, never>>>): DecoratedProcedure<TInitialContext, TCurrentContext, TInputSchema, TOutputSchema, TErrorMap, TMeta> & ProcedureActionableClient<TInputSchema, TOutputSchema, TErrorMap>;
|
81
83
|
}
|
82
84
|
|
83
|
-
declare function getRouter<T extends Lazyable<AnyRouter | undefined>>(router: T, path: readonly string[]): T extends Lazy<any> ? Lazy<AnyRouter | undefined> : Lazyable<AnyRouter | undefined>;
|
84
|
-
type AccessibleLazyRouter<T extends Lazyable<AnyRouter | undefined>> = T extends Lazy<infer U extends AnyRouter | undefined | Lazy<AnyRouter | undefined>> ? AccessibleLazyRouter<U> : T extends AnyProcedure | undefined ? Lazy<T> : Lazy<T> & {
|
85
|
-
[K in keyof T]: T[K] extends Lazyable<AnyRouter> ? AccessibleLazyRouter<T[K]> : never;
|
86
|
-
};
|
87
|
-
declare function createAccessibleLazyRouter<T extends Lazy<AnyRouter | undefined>>(lazied: T): AccessibleLazyRouter<T>;
|
88
|
-
type EnhancedRouter<T extends Lazyable<AnyRouter>, TInitialContext extends Context, TCurrentContext extends Context, TErrorMap extends ErrorMap> = T extends Lazy<infer U extends AnyRouter> ? AccessibleLazyRouter<EnhancedRouter<U, TInitialContext, TCurrentContext, TErrorMap>> : T extends Procedure<infer UInitialContext, infer UCurrentContext, infer UInputSchema, infer UOutputSchema, infer UErrorMap, infer UMeta> ? Procedure<MergedInitialContext<TInitialContext, UInitialContext, TCurrentContext>, UCurrentContext, UInputSchema, UOutputSchema, MergedErrorMap<TErrorMap, UErrorMap>, UMeta> : {
|
89
|
-
[K in keyof T]: T[K] extends Lazyable<AnyRouter> ? EnhancedRouter<T[K], TInitialContext, TCurrentContext, TErrorMap> : never;
|
90
|
-
};
|
91
|
-
interface EnhanceRouterOptions<TErrorMap extends ErrorMap> extends EnhanceRouteOptions {
|
92
|
-
middlewares: readonly AnyMiddleware[];
|
93
|
-
errorMap: TErrorMap;
|
94
|
-
dedupeLeadingMiddlewares: boolean;
|
95
|
-
}
|
96
|
-
declare function enhanceRouter<T extends Lazyable<AnyRouter>, TInitialContext extends Context, TCurrentContext extends Context, TErrorMap extends ErrorMap>(router: T, options: EnhanceRouterOptions<TErrorMap>): EnhancedRouter<T, TInitialContext, TCurrentContext, TErrorMap>;
|
97
|
-
interface TraverseContractProceduresOptions {
|
98
|
-
router: AnyContractRouter | AnyRouter;
|
99
|
-
path: readonly string[];
|
100
|
-
}
|
101
|
-
interface ContractProcedureCallbackOptions {
|
102
|
-
contract: AnyContractProcedure;
|
103
|
-
path: readonly string[];
|
104
|
-
}
|
105
|
-
interface LazyTraverseContractProceduresOptions {
|
106
|
-
router: Lazy<AnyRouter>;
|
107
|
-
path: readonly string[];
|
108
|
-
}
|
109
|
-
declare function traverseContractProcedures(options: TraverseContractProceduresOptions, callback: (options: ContractProcedureCallbackOptions) => void, lazyOptions?: LazyTraverseContractProceduresOptions[]): LazyTraverseContractProceduresOptions[];
|
110
|
-
declare function resolveContractProcedures(options: TraverseContractProceduresOptions, callback: (options: ContractProcedureCallbackOptions) => void): Promise<void>;
|
111
|
-
type UnlaziedRouter<T extends AnyRouter> = T extends AnyProcedure ? T : {
|
112
|
-
[K in keyof T]: T[K] extends Lazyable<infer U extends AnyRouter> ? UnlaziedRouter<U> : never;
|
113
|
-
};
|
114
|
-
declare function unlazyRouter<T extends AnyRouter>(router: T): Promise<UnlaziedRouter<T>>;
|
115
|
-
|
116
85
|
interface BuilderWithMiddlewares<TInitialContext extends Context, TCurrentContext extends Context, TInputSchema extends AnySchema, TOutputSchema extends AnySchema, TErrorMap extends ErrorMap, TMeta extends Meta> {
|
117
86
|
/**
|
118
87
|
* This property holds the defined options.
|
@@ -510,7 +479,7 @@ declare class Builder<TInitialContext extends Context, TCurrentContext extends C
|
|
510
479
|
/**
|
511
480
|
* Sets or overrides the config.
|
512
481
|
*
|
513
|
-
* @see {@link https://orpc.unnoq.com/docs/
|
482
|
+
* @see {@link https://orpc.unnoq.com/docs/client/server-side#middlewares-order Middlewares Order Docs}
|
514
483
|
* @see {@link https://orpc.unnoq.com/docs/best-practices/dedupe-middleware#configuration Dedupe Middleware Docs}
|
515
484
|
*/
|
516
485
|
$config(config: BuilderConfig): Builder<TInitialContext, TCurrentContext, TInputSchema, TOutputSchema, TErrorMap, TMeta>;
|
@@ -730,9 +699,9 @@ interface RouterImplementerWithMiddlewares<T extends AnyContractRouter, TInitial
|
|
730
699
|
default: U;
|
731
700
|
}>): EnhancedRouter<Lazy<U>, TInitialContext, TCurrentContext, Record<never, never>>;
|
732
701
|
}
|
733
|
-
type ImplementerInternalWithMiddlewares<TContract extends AnyContractRouter, TInitialContext extends Context, TCurrentContext extends Context> =
|
702
|
+
type ImplementerInternalWithMiddlewares<TContract extends AnyContractRouter, TInitialContext extends Context, TCurrentContext extends Context> = TContract extends ContractProcedure<infer UInputSchema, infer UOutputSchema, infer UErrorMap, infer UMeta> ? ProcedureImplementer<TInitialContext, TCurrentContext, UInputSchema, UOutputSchema, UErrorMap, UMeta> : RouterImplementerWithMiddlewares<TContract, TInitialContext, TCurrentContext> & {
|
734
703
|
[K in keyof TContract]: TContract[K] extends AnyContractRouter ? ImplementerInternalWithMiddlewares<TContract[K], TInitialContext, TCurrentContext> : never;
|
735
|
-
}
|
704
|
+
};
|
736
705
|
|
737
706
|
interface RouterImplementer<T extends AnyContractRouter, TInitialContext extends Context, TCurrentContext extends Context> {
|
738
707
|
/**
|
@@ -768,9 +737,9 @@ interface RouterImplementer<T extends AnyContractRouter, TInitialContext extends
|
|
768
737
|
default: U;
|
769
738
|
}>): EnhancedRouter<Lazy<U>, TInitialContext, TCurrentContext, Record<never, never>>;
|
770
739
|
}
|
771
|
-
type ImplementerInternal<TContract extends AnyContractRouter, TInitialContext extends Context, TCurrentContext extends Context> =
|
740
|
+
type ImplementerInternal<TContract extends AnyContractRouter, TInitialContext extends Context, TCurrentContext extends Context> = TContract extends ContractProcedure<infer UInputSchema, infer UOutputSchema, infer UErrorMap, infer UMeta> ? ProcedureImplementer<TInitialContext, TCurrentContext, UInputSchema, UOutputSchema, UErrorMap, UMeta> : RouterImplementer<TContract, TInitialContext, TCurrentContext> & {
|
772
741
|
[K in keyof TContract]: TContract[K] extends AnyContractRouter ? ImplementerInternal<TContract[K], TInitialContext, TCurrentContext> : never;
|
773
|
-
}
|
742
|
+
};
|
774
743
|
declare function implementerInternal<T extends AnyContractRouter, TInitialContext extends Context, TCurrentContext extends Context>(contract: T, config: BuilderConfig, middlewares: AnyMiddleware[]): ImplementerInternal<T, TInitialContext, TCurrentContext>;
|
775
744
|
type Implementer<TContract extends AnyContractRouter, TInitialContext extends Context, TCurrentContext extends Context> = {
|
776
745
|
/**
|
@@ -782,7 +751,7 @@ type Implementer<TContract extends AnyContractRouter, TInitialContext extends Co
|
|
782
751
|
/**
|
783
752
|
* Sets or overrides the config.
|
784
753
|
*
|
785
|
-
* @see {@link https://orpc.unnoq.com/docs/
|
754
|
+
* @see {@link https://orpc.unnoq.com/docs/client/server-side#middlewares-order Middlewares Order Docs}
|
786
755
|
* @see {@link https://orpc.unnoq.com/docs/best-practices/dedupe-middleware#configuration Dedupe Middleware Docs}
|
787
756
|
*/
|
788
757
|
$config(config: BuilderConfig): Implementer<TContract, TInitialContext, TCurrentContext>;
|
@@ -815,7 +784,7 @@ declare function createContractedProcedure(procedure: AnyProcedure, contract: An
|
|
815
784
|
* ```
|
816
785
|
*
|
817
786
|
*/
|
818
|
-
declare function call<TInitialContext extends Context, TInputSchema extends AnySchema, TOutputSchema extends AnySchema, TErrorMap extends ErrorMap, TMeta extends Meta>(procedure: Lazyable<Procedure<TInitialContext, any, TInputSchema, TOutputSchema, TErrorMap, TMeta>>, input: InferSchemaInput<TInputSchema>, ...rest: MaybeOptionalOptions<CreateProcedureClientOptions<TInitialContext, TOutputSchema, TErrorMap, TMeta, Record<never, never
|
787
|
+
declare function call<TInitialContext extends Context, TInputSchema extends AnySchema, TOutputSchema extends AnySchema, TErrorMap extends ErrorMap, TMeta extends Meta>(procedure: Lazyable<Procedure<TInitialContext, any, TInputSchema, TOutputSchema, TErrorMap, TMeta>>, input: InferSchemaInput<TInputSchema>, ...rest: MaybeOptionalOptions<CreateProcedureClientOptions<TInitialContext, TOutputSchema, TErrorMap, TMeta, Record<never, never>> & Omit<ClientOptions<Record<never, never>>, 'context'>>): ClientPromiseResult<InferSchemaOutput<TOutputSchema>, ErrorFromErrorMap<TErrorMap>>;
|
819
788
|
|
820
789
|
type RouterClient<TRouter extends AnyRouter, TClientContext extends ClientContext = Record<never, never>> = TRouter extends Procedure<any, any, infer UInputSchema, infer UOutputSchema, infer UErrorMap, any> ? ProcedureClient<TClientContext, UInputSchema, UOutputSchema, UErrorMap> : {
|
821
790
|
[K in keyof TRouter]: TRouter[K] extends Lazyable<infer U extends AnyRouter> ? RouterClient<U, TClientContext> : never;
|
@@ -830,5 +799,5 @@ declare function createRouterClient<T extends AnyRouter, TClientContext extends
|
|
830
799
|
declare function setHiddenRouterContract<T extends Lazyable<AnyRouter>>(router: T, contract: AnyContractRouter): T;
|
831
800
|
declare function getHiddenRouterContract(router: Lazyable<AnyRouter | AnyContractRouter>): AnyContractRouter | undefined;
|
832
801
|
|
833
|
-
export { AnyMiddleware, AnyProcedure, AnyRouter, Builder, Context, CreateProcedureClientOptions, DecoratedProcedure, InferRouterInitialContext, Lazy, Lazyable, MapInputMiddleware, MergedCurrentContext, MergedInitialContext, Middleware, ORPCErrorConstructorMap, Procedure, ProcedureClient, ProcedureHandler, Router, addMiddleware, call,
|
834
|
-
export type {
|
802
|
+
export { AnyMiddleware, AnyProcedure, AnyRouter, Builder, Context, CreateProcedureClientOptions, DecoratedProcedure, EnhanceRouterOptions, EnhancedRouter, InferRouterInitialContext, Lazy, Lazyable, MapInputMiddleware, MergedCurrentContext, MergedInitialContext, Middleware, ORPCErrorConstructorMap, Procedure, ProcedureClient, ProcedureHandler, Router, addMiddleware, call, createActionableClient, createAssertedLazyProcedure, createContractedProcedure, createRouterClient, decorateMiddleware, fallbackConfig, getHiddenRouterContract, implement, implementerInternal, inferRPCMethodFromRouter, isStartWithMiddlewares, mergeMiddlewares, os, setHiddenRouterContract };
|
803
|
+
export type { ActionableClient, ActionableClientRest, ActionableClientResult, ActionableError, BuilderConfig, BuilderDef, BuilderWithMiddlewares, Config, DecoratedMiddleware, ImplementedProcedure, Implementer, ImplementerInternal, ImplementerInternalWithMiddlewares, ProcedureActionableClient, ProcedureBuilder, ProcedureBuilderWithInput, ProcedureBuilderWithInputOutput, ProcedureBuilderWithOutput, ProcedureImplementer, RouterBuilder, RouterClient, RouterImplementer, RouterImplementerWithMiddlewares, UnactionableError };
|