@orpc/server 2.0.0-beta.5 → 2.0.0-beta.50

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.
Files changed (171) hide show
  1. package/README.md +137 -102
  2. package/dist/adapters/aws-lambda/handler.d.ts +27 -0
  3. package/dist/adapters/aws-lambda/handler.js +24 -0
  4. package/dist/adapters/aws-lambda/index.d.ts +4 -0
  5. package/dist/adapters/aws-lambda/index.js +2 -0
  6. package/dist/adapters/aws-lambda/rpc-handler.d.ts +19 -0
  7. package/dist/adapters/aws-lambda/rpc-handler.js +21 -0
  8. package/dist/adapters/crossws/handler.d.ts +47 -0
  9. package/dist/adapters/crossws/handler.js +53 -0
  10. package/dist/adapters/crossws/index.d.ts +3 -54
  11. package/dist/adapters/crossws/index.js +2 -0
  12. package/dist/adapters/crossws/rpc-handler.d.ts +16 -0
  13. package/dist/adapters/crossws/rpc-handler.js +18 -0
  14. package/dist/adapters/fastify/handler.d.ts +23 -0
  15. package/dist/adapters/fastify/handler.js +20 -0
  16. package/dist/adapters/fastify/index.d.ts +3 -0
  17. package/dist/adapters/fastify/index.js +2 -0
  18. package/dist/adapters/fastify/rpc-handler.d.ts +15 -0
  19. package/dist/adapters/fastify/rpc-handler.js +17 -0
  20. package/dist/adapters/fetch/handler.d.ts +25 -0
  21. package/dist/adapters/fetch/handler.js +22 -0
  22. package/dist/adapters/fetch/index.d.ts +4 -140
  23. package/dist/adapters/fetch/index.js +3 -0
  24. package/dist/adapters/fetch/rpc-handler.d.ts +17 -0
  25. package/dist/adapters/fetch/rpc-handler.js +19 -0
  26. package/dist/adapters/message-port/handler.d.ts +62 -0
  27. package/dist/adapters/message-port/handler.js +72 -0
  28. package/dist/adapters/message-port/index.d.ts +3 -74
  29. package/dist/adapters/message-port/index.js +2 -0
  30. package/dist/adapters/message-port/rpc-handler.d.ts +16 -0
  31. package/dist/adapters/message-port/rpc-handler.js +18 -0
  32. package/dist/adapters/node/handler.d.ts +23 -0
  33. package/dist/adapters/node/handler.js +20 -0
  34. package/dist/adapters/node/index.d.ts +4 -121
  35. package/dist/adapters/node/index.js +3 -0
  36. package/dist/adapters/node/rpc-handler.d.ts +16 -0
  37. package/dist/adapters/node/rpc-handler.js +18 -0
  38. package/dist/adapters/standard/codec.d.ts +16 -0
  39. package/dist/adapters/standard/handler.d.ts +68 -0
  40. package/dist/adapters/standard/handler.js +205 -0
  41. package/dist/adapters/standard/index.d.ts +7 -19
  42. package/dist/adapters/standard/index.js +4 -0
  43. package/dist/adapters/standard/plugin.d.ts +26 -0
  44. package/dist/adapters/standard/plugin.js +14 -0
  45. package/dist/adapters/standard/rpc-handler-codec.d.ts +42 -0
  46. package/dist/adapters/standard/rpc-handler-codec.js +50 -0
  47. package/dist/adapters/standard/rpc-matcher.d.ts +53 -0
  48. package/dist/adapters/standard/rpc-matcher.js +106 -0
  49. package/dist/adapters/standard/utils.d.ts +10 -0
  50. package/dist/adapters/standard/utils.js +8 -0
  51. package/dist/adapters/standard-peer/index.d.ts +2 -16
  52. package/dist/adapters/standard-peer/index.js +1 -0
  53. package/dist/adapters/standard-peer/utils.d.ts +6 -0
  54. package/dist/adapters/standard-peer/utils.js +13 -0
  55. package/dist/adapters/websocket/handler.d.ts +61 -0
  56. package/dist/adapters/websocket/handler.js +75 -0
  57. package/dist/adapters/websocket/index.d.ts +3 -61
  58. package/dist/adapters/websocket/index.js +2 -0
  59. package/dist/adapters/websocket/rpc-handler.d.ts +16 -0
  60. package/dist/adapters/websocket/rpc-handler.js +18 -0
  61. package/dist/builder-variants.d.ts +226 -0
  62. package/dist/builder.d.ts +126 -0
  63. package/dist/builder.js +200 -0
  64. package/dist/constants.d.ts +2 -0
  65. package/dist/constants.js +4 -0
  66. package/dist/context.d.ts +6 -0
  67. package/dist/extensions/callable.d.ts +11 -10
  68. package/dist/extensions/callable.js +8 -0
  69. package/dist/helpers/base64url.d.ts +31 -0
  70. package/dist/helpers/base64url.js +48 -0
  71. package/dist/helpers/cookie.d.ts +50 -0
  72. package/dist/helpers/cookie.js +62 -0
  73. package/dist/helpers/encryption.d.ts +28 -0
  74. package/dist/helpers/encryption.js +90 -0
  75. package/dist/helpers/index.d.ts +5 -149
  76. package/dist/helpers/index.js +4 -0
  77. package/dist/helpers/signing.d.ts +50 -0
  78. package/dist/helpers/signing.js +78 -0
  79. package/dist/implementer-procedure.d.ts +15 -0
  80. package/dist/implementer-procedure.js +37 -0
  81. package/dist/implementer-router.d.ts +34 -0
  82. package/dist/implementer-router.js +98 -0
  83. package/dist/implementer.d.ts +16 -0
  84. package/dist/implementer.js +30 -0
  85. package/dist/index.d.ts +22 -196
  86. package/dist/index.js +16 -0
  87. package/dist/lazy.d.ts +20 -0
  88. package/dist/lazy.js +20 -0
  89. package/dist/middleware-decorated.d.ts +9 -0
  90. package/dist/middleware-decorated.js +67 -0
  91. package/dist/middleware.d.ts +54 -0
  92. package/dist/plugins/batch.d.ts +102 -0
  93. package/dist/plugins/batch.js +371 -0
  94. package/dist/plugins/cors.d.ts +69 -0
  95. package/dist/plugins/cors.js +119 -0
  96. package/dist/plugins/get-method-csrf-protection.d.ts +25 -0
  97. package/dist/plugins/get-method-csrf-protection.js +48 -0
  98. package/dist/plugins/head-method.d.ts +25 -0
  99. package/dist/plugins/head-method.js +107 -0
  100. package/dist/plugins/index.d.ts +15 -197
  101. package/dist/plugins/index.js +14 -0
  102. package/dist/plugins/method-override.d.ts +40 -0
  103. package/dist/plugins/method-override.js +54 -0
  104. package/dist/plugins/request-compression.d.ts +18 -0
  105. package/dist/plugins/request-compression.js +55 -0
  106. package/dist/plugins/request-headers.d.ts +24 -0
  107. package/dist/plugins/request-headers.js +28 -0
  108. package/dist/plugins/request-limit.d.ts +32 -0
  109. package/dist/plugins/request-limit.js +61 -0
  110. package/dist/plugins/response-compression.d.ts +62 -0
  111. package/dist/plugins/response-compression.js +157 -0
  112. package/dist/plugins/response-headers.d.ts +32 -0
  113. package/dist/plugins/response-headers.js +44 -0
  114. package/dist/plugins/rethrow.d.ts +35 -0
  115. package/dist/plugins/rethrow.js +47 -0
  116. package/dist/plugins/signal-sync.d.ts +15 -0
  117. package/dist/plugins/signal-sync.js +76 -0
  118. package/dist/plugins/timeout.d.ts +39 -0
  119. package/dist/plugins/timeout.js +62 -0
  120. package/dist/procedure-client.d.ts +18 -0
  121. package/dist/procedure-client.js +158 -0
  122. package/dist/procedure-decorated.d.ts +10 -0
  123. package/dist/procedure-decorated.js +36 -0
  124. package/dist/procedure-utils.d.ts +21 -0
  125. package/dist/procedure-utils.js +48 -0
  126. package/dist/procedure.d.ts +72 -0
  127. package/dist/procedure.js +18 -0
  128. package/dist/router-client.d.ts +21 -0
  129. package/dist/router-client.js +35 -0
  130. package/dist/router-hidden.js +12 -0
  131. package/dist/router-utils.d.ts +31 -0
  132. package/dist/router-utils.js +157 -0
  133. package/dist/router.d.ts +58 -0
  134. package/package.json +95 -63
  135. package/dist/adapters/crossws/index.d.mts +0 -54
  136. package/dist/adapters/crossws/index.mjs +0 -64
  137. package/dist/adapters/fetch/index.d.mts +0 -140
  138. package/dist/adapters/fetch/index.mjs +0 -204
  139. package/dist/adapters/message-port/index.d.mts +0 -74
  140. package/dist/adapters/message-port/index.mjs +0 -90
  141. package/dist/adapters/node/index.d.mts +0 -121
  142. package/dist/adapters/node/index.mjs +0 -179
  143. package/dist/adapters/standard/index.d.mts +0 -19
  144. package/dist/adapters/standard/index.mjs +0 -8
  145. package/dist/adapters/standard-peer/index.d.mts +0 -16
  146. package/dist/adapters/standard-peer/index.mjs +0 -2
  147. package/dist/adapters/websocket/index.d.mts +0 -61
  148. package/dist/adapters/websocket/index.mjs +0 -76
  149. package/dist/extensions/callable.d.mts +0 -10
  150. package/dist/extensions/callable.mjs +0 -11
  151. package/dist/helpers/index.d.mts +0 -149
  152. package/dist/helpers/index.mjs +0 -198
  153. package/dist/index.d.mts +0 -196
  154. package/dist/index.mjs +0 -385
  155. package/dist/plugins/index.d.mts +0 -197
  156. package/dist/plugins/index.mjs +0 -357
  157. package/dist/shared/server.BL22TloH.d.mts +0 -184
  158. package/dist/shared/server.BL22TloH.d.ts +0 -184
  159. package/dist/shared/server.BsNNjG5J.d.mts +0 -61
  160. package/dist/shared/server.BwHnWUuN.mjs +0 -222
  161. package/dist/shared/server.CX4vUnDk.mjs +0 -11
  162. package/dist/shared/server.Cj5lgPuG.d.mts +0 -66
  163. package/dist/shared/server.CjOb6ItT.mjs +0 -41
  164. package/dist/shared/server.CrlKQucM.mjs +0 -233
  165. package/dist/shared/server.DBANIheG.d.ts +0 -104
  166. package/dist/shared/server.DJIkub_t.d.mts +0 -104
  167. package/dist/shared/server.D_QauotT.mjs +0 -30
  168. package/dist/shared/server.GDpX6Df8.mjs +0 -271
  169. package/dist/shared/server.Pa0F03f_.d.ts +0 -61
  170. package/dist/shared/server.W91HSRkE.mjs +0 -9
  171. package/dist/shared/server.d_2NS3g5.d.ts +0 -66
@@ -1,19 +0,0 @@
1
- import { b as StandardHandlerHandleOptions } from '../../shared/server.DJIkub_t.mjs';
2
- export { C as CompositeStandardHandlerPlugin, O as OtelHandlerPlugin, S as StandardHandler, c as StandardHandlerCodec, d as StandardHandlerCodecResolvedProcedure, h as StandardHandlerHandleResult, i as StandardHandlerInterceptor, g as StandardHandlerInterceptorOptions, a as StandardHandlerOptions, e as StandardHandlerPlugin, j as StandardHandlerRoutingInterceptor, f as StandardHandlerRoutingInterceptorOptions } from '../../shared/server.DJIkub_t.mjs';
3
- export { a as RPCHandlerCodec, R as RPCHandlerCodecOptions, b as RPCMatcher, c as RPCMatcherOptions } from '../../shared/server.Cj5lgPuG.mjs';
4
- import { C as Context } from '../../shared/server.BL22TloH.mjs';
5
- export { StandardBody, StandardBodyHint, StandardHeaders, StandardLazyRequest, StandardLazyResponse, StandardMethod, StandardRequest, StandardResponse, StandardUrl } from '@standardserver/core';
6
- import '@orpc/client';
7
- import '@orpc/shared';
8
- import '@orpc/contract';
9
- import '../../shared/server.BsNNjG5J.mjs';
10
-
11
- type FriendlyStandardHandlerHandleOptions<T extends Context> = Omit<StandardHandlerHandleOptions<T>, 'context'> & (object extends T ? {
12
- context?: T;
13
- } : {
14
- context: T;
15
- });
16
- declare function resolveFriendlyStandardHandlerHandleOptions<T extends Context>(options: FriendlyStandardHandlerHandleOptions<T>): StandardHandlerHandleOptions<T>;
17
-
18
- export { StandardHandlerHandleOptions, resolveFriendlyStandardHandlerHandleOptions };
19
- export type { FriendlyStandardHandlerHandleOptions };
@@ -1,8 +0,0 @@
1
- export { C as CompositeStandardHandlerPlugin, O as OtelHandlerPlugin, R as RPCHandlerCodec, a as RPCMatcher, S as StandardHandler } from '../../shared/server.GDpX6Df8.mjs';
2
- export { r as resolveFriendlyStandardHandlerHandleOptions } from '../../shared/server.W91HSRkE.mjs';
3
- import '@orpc/client';
4
- import '@orpc/shared';
5
- import '@standardserver/core';
6
- import '../../shared/server.CrlKQucM.mjs';
7
- import '@orpc/contract';
8
- import '../../shared/server.BwHnWUuN.mjs';
@@ -1,16 +0,0 @@
1
- import { Value, Promisable } from '@orpc/shared';
2
- import { StandardLazyRequest, StandardResponse } from '@standardserver/core';
3
- import { C as Context } from '../../shared/server.BL22TloH.mjs';
4
- import { b as StandardHandlerHandleOptions, S as StandardHandler } from '../../shared/server.DJIkub_t.mjs';
5
- import '@orpc/client';
6
- import '@orpc/contract';
7
-
8
- type StandardPeerRequestHandlerOptions<T extends Context> = Omit<StandardHandlerHandleOptions<T>, 'context'> & (Record<never, never> extends T ? {
9
- context?: Value<Promisable<T>, [request: StandardLazyRequest]>;
10
- } : {
11
- context: Value<Promisable<T>, [request: StandardLazyRequest]>;
12
- });
13
- declare function createStandardPeerRequestHandler<T extends Context>(handler: StandardHandler<T>, options: StandardPeerRequestHandlerOptions<T>): (request: StandardLazyRequest) => Promise<StandardResponse>;
14
-
15
- export { createStandardPeerRequestHandler };
16
- export type { StandardPeerRequestHandlerOptions };
@@ -1,2 +0,0 @@
1
- export { c as createStandardPeerRequestHandler } from '../../shared/server.CX4vUnDk.mjs';
2
- import '@orpc/shared';
@@ -1,61 +0,0 @@
1
- import { MaybeOptionalOptions } from '@orpc/shared';
2
- import { EncodePeerMessageOptions, DecodePeerMessageOptions } from '@standardserver/peer';
3
- import { C as Context } from '../../shared/server.BL22TloH.mjs';
4
- import { S as StandardHandler, a as StandardHandlerOptions } from '../../shared/server.DJIkub_t.mjs';
5
- import { StandardPeerRequestHandlerOptions } from '../standard-peer/index.mjs';
6
- import { R as Router } from '../../shared/server.BsNNjG5J.mjs';
7
- import { R as RPCHandlerCodecOptions } from '../../shared/server.Cj5lgPuG.mjs';
8
- import '@orpc/client';
9
- import '@orpc/contract';
10
- import '@standardserver/core';
11
-
12
- type WebsocketLike = Pick<WebSocket, 'addEventListener' | 'removeEventListener' | 'send'>;
13
- interface WebsocketHandlerOptions<_T extends Context> {
14
- /**
15
- * Options for encoding peer messages. such as `prefix` for distinguishing messages on the same channel..
16
- */
17
- encodePeerMessage?: EncodePeerMessageOptions | undefined;
18
- /**
19
- * Options for decoding peer messages. such as `prefix` for distinguishing messages on the same channel..
20
- */
21
- decodePeerMessage?: DecodePeerMessageOptions | undefined;
22
- }
23
- declare class WebsocketHandler<T extends Context> {
24
- private readonly handler;
25
- private readonly peers;
26
- private readonly encodePeerMessageOptions;
27
- private readonly decodePeerMessageOptions;
28
- constructor(handler: StandardHandler<T>, options?: NoInfer<WebsocketHandlerOptions<T>>);
29
- /**
30
- * Attaches necessary event listeners to a WebSocket to handle incoming messages and peer management.
31
- */
32
- upgrade(ws: WebsocketLike, ...rest: MaybeOptionalOptions<StandardPeerRequestHandlerOptions<T>>): void;
33
- /**
34
- * Handles a single message received from a WebSocket.
35
- *
36
- * @warning AVOID calling this method, if `.upgrade()` is used, as `.upgrade()` already sets up necessary event listeners to call this method for incoming messages and manage peer lifecycle.
37
- *
38
- * @param ws The WebSocket instance, require consistent instance across messages for proper peer management
39
- * @param data The message data received from the WebSocket, can be string, ArrayBuffer, Blob, ...
40
- */
41
- message(ws: WebsocketLike, data: string | ArrayBuffer | Blob | Exclude<ConstructorParameters<typeof Blob>[0], undefined>[0][] | Pick<Uint8Array<ArrayBuffer>, 'buffer' | 'byteOffset' | 'byteLength'>, ...rest: MaybeOptionalOptions<StandardPeerRequestHandlerOptions<T>>): Promise<{
42
- matched: boolean;
43
- }>;
44
- /**
45
- * Called when a websocket is closed, to clean up any associated peer state.
46
- *
47
- * @warning AVOID calling this method, if `.upgrade()` is used, as `.upgrade()` already sets up necessary event listeners to call this method for incoming messages and manage peer lifecycle.
48
- *
49
- * @param ws The WebSocket instance to clean up, must be the same instance used in `.message()` calls to properly clean up
50
- */
51
- close(ws: WebsocketLike): Promise<void>;
52
- }
53
-
54
- interface RPCHandlerOptions<T extends Context> extends StandardHandlerOptions<T>, RPCHandlerCodecOptions<T>, WebsocketHandlerOptions<T> {
55
- }
56
- declare class RPCHandler<T extends Context> extends WebsocketHandler<T> {
57
- constructor(router: Router<T>, options?: NoInfer<RPCHandlerOptions<T>>);
58
- }
59
-
60
- export { RPCHandler, WebsocketHandler };
61
- export type { RPCHandlerOptions, WebsocketHandlerOptions, WebsocketLike };
@@ -1,76 +0,0 @@
1
- import { toStringOrBytes, resolveMaybeOptionalOptions } from '@orpc/shared';
2
- import { ServerPeer, encodePeerMessage, decodePeerMessage, isClientPeerSendMessage } from '@standardserver/peer';
3
- import { c as createStandardPeerRequestHandler } from '../../shared/server.CX4vUnDk.mjs';
4
- import { R as RPCHandlerCodec, S as StandardHandler } from '../../shared/server.GDpX6Df8.mjs';
5
- import '@orpc/client';
6
- import '@standardserver/core';
7
- import '../../shared/server.CrlKQucM.mjs';
8
- import '@orpc/contract';
9
- import '../../shared/server.BwHnWUuN.mjs';
10
-
11
- class WebsocketHandler {
12
- constructor(handler, options = {}) {
13
- this.handler = handler;
14
- this.encodePeerMessageOptions = options.encodePeerMessage;
15
- this.decodePeerMessageOptions = options.decodePeerMessage;
16
- }
17
- peers = /* @__PURE__ */ new WeakMap();
18
- encodePeerMessageOptions;
19
- decodePeerMessageOptions;
20
- /**
21
- * Attaches necessary event listeners to a WebSocket to handle incoming messages and peer management.
22
- */
23
- upgrade(ws, ...rest) {
24
- ws.addEventListener("message", (event) => this.message(ws, event.data, ...rest));
25
- ws.addEventListener("close", () => this.close(ws));
26
- }
27
- /**
28
- * Handles a single message received from a WebSocket.
29
- *
30
- * @warning AVOID calling this method, if `.upgrade()` is used, as `.upgrade()` already sets up necessary event listeners to call this method for incoming messages and manage peer lifecycle.
31
- *
32
- * @param ws The WebSocket instance, require consistent instance across messages for proper peer management
33
- * @param data The message data received from the WebSocket, can be string, ArrayBuffer, Blob, ...
34
- */
35
- async message(ws, data, ...rest) {
36
- let peer = this.peers.get(ws);
37
- if (!peer) {
38
- this.peers.set(ws, peer = new ServerPeer(async (message) => {
39
- return ws.send(await encodePeerMessage(message, this.encodePeerMessageOptions));
40
- }));
41
- }
42
- const encoded = await toStringOrBytes(data);
43
- const result = decodePeerMessage(encoded, this.decodePeerMessageOptions);
44
- if (result.matched && isClientPeerSendMessage(result.message)) {
45
- await peer.message(
46
- result.message,
47
- createStandardPeerRequestHandler(this.handler, resolveMaybeOptionalOptions(rest))
48
- );
49
- }
50
- return result;
51
- }
52
- /**
53
- * Called when a websocket is closed, to clean up any associated peer state.
54
- *
55
- * @warning AVOID calling this method, if `.upgrade()` is used, as `.upgrade()` already sets up necessary event listeners to call this method for incoming messages and manage peer lifecycle.
56
- *
57
- * @param ws The WebSocket instance to clean up, must be the same instance used in `.message()` calls to properly clean up
58
- */
59
- async close(ws) {
60
- const peer = this.peers.get(ws);
61
- if (peer) {
62
- await peer.close();
63
- this.peers.delete(ws);
64
- }
65
- }
66
- }
67
-
68
- class RPCHandler extends WebsocketHandler {
69
- constructor(router, options = {}) {
70
- const codec = new RPCHandlerCodec(router, options);
71
- const handler = new StandardHandler(codec, options);
72
- super(handler, options);
73
- }
74
- }
75
-
76
- export { RPCHandler, WebsocketHandler };
@@ -1,10 +0,0 @@
1
- import { AnyORPCError, ClientContext } from '@orpc/client';
2
- import { AnySchema, ErrorMap } from '@orpc/contract';
3
- import { MaybeOptionalOptions } from '@orpc/shared';
4
- import { C as Context, P as ProcedureClientOptions, a as Procedure, b as ProcedureClient } from '../shared/server.BL22TloH.mjs';
5
-
6
- declare module "../index" {
7
- interface DecoratedProcedure<TInitialContext extends Context, TInjectedContext extends Context, TInputSchema extends AnySchema, TOutputSchema extends AnySchema, TErrorMap extends ErrorMap, TReturnedError extends AnyORPCError> {
8
- callable<TClientContext extends ClientContext>(...rest: MaybeOptionalOptions<ProcedureClientOptions<TInitialContext, TOutputSchema, TErrorMap, TReturnedError, TClientContext>>): Procedure<TInitialContext, TInjectedContext, TInputSchema, TOutputSchema, TErrorMap, TReturnedError> & ProcedureClient<TClientContext, TInputSchema, TOutputSchema, TErrorMap, TReturnedError>;
9
- }
10
- }
@@ -1,11 +0,0 @@
1
- import { c as createProcedureClient } from '../shared/server.CrlKQucM.mjs';
2
- import { D as DecoratedProcedure } from '../shared/server.CjOb6ItT.mjs';
3
- import '@orpc/client';
4
- import '@orpc/contract';
5
- import '@orpc/shared';
6
-
7
- DecoratedProcedure.prototype.callable = function callable(...rest) {
8
- const callable2 = createProcedureClient(this, ...rest);
9
- callable2["~orpc"] = this["~orpc"];
10
- return callable2;
11
- };
@@ -1,149 +0,0 @@
1
- import { ParseOptions, SerializeOptions } 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<ArrayBuffer> | 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
- * Deletes a cookie by marking it expired.
73
- */
74
- declare function deleteCookie(headers: Headers | undefined, name: string, options?: Omit<SetCookieOptions, 'maxAge'>): void;
75
-
76
- /**
77
- * Encrypts a string using AES-GCM with a secret key.
78
- * The output is base64url encoded to be URL-safe.
79
- *
80
- * @example
81
- * ```ts
82
- * const encrypted = await encrypt("Hello, World!", "test-secret-key")
83
- * const decrypted = await decrypt(encrypted, "test-secret-key")
84
- * expect(decrypted).toBe("Hello, World!")
85
- * ```
86
- */
87
- declare function encrypt(value: string, secret: string): Promise<string>;
88
- /**
89
- * Decrypts a base64url encoded string using AES-GCM with a secret key.
90
- * Returns the original string if decryption is successful, or undefined if it fails.
91
- *
92
- * @example
93
- * ```ts
94
- * const encrypted = await encrypt("Hello, World!", "test-secret-key")
95
- * const decrypted = await decrypt(encrypted, "test-secret-key")
96
- * expect(decrypted).toBe("Hello, World!")
97
- * ```
98
- */
99
- declare function decrypt(encrypted: string | undefined | null, secret: string): Promise<string | undefined>;
100
-
101
- /**
102
- * Signs a string value using HMAC-SHA256 with a secret key.
103
- *
104
- * This function creates a cryptographic signature that can be used to verify
105
- * the integrity and authenticity of the data. The signature is appended to
106
- * the original value, separated by a dot, using base64url encoding (no padding).
107
- *
108
- *
109
- * @example
110
- * ```ts
111
- * const signedValue = await sign("user123", "my-secret-key")
112
- * expect(signedValue).toEqual("user123.oneQsU0r5dvwQFHFEjjV1uOI_IR3gZfkYHij3TRauVA")
113
- * ```
114
- */
115
- declare function sign(value: string, secret: string): Promise<string>;
116
- /**
117
- * Verifies and extracts the original value from a signed string.
118
- *
119
- * This function validates the signature of a previously signed value using the same
120
- * secret key. If the signature is valid, it returns the original value. If the
121
- * signature is invalid or the format is incorrect, it returns undefined.
122
- *
123
- *
124
- * @example
125
- * ```ts
126
- * const signedValue = "user123.oneQsU0r5dvwQFHFEjjV1uOI_IR3gZfkYHij3TRauVA"
127
- * const originalValue = await unsign(signedValue, "my-secret-key")
128
- * expect(originalValue).toEqual("user123")
129
- * ```
130
- */
131
- declare function unsign(signedValue: string | undefined | null, secret: string): Promise<string | undefined>;
132
- /**
133
- * Extracts the value part from a signed string without verification.
134
- *
135
- * This function simply extracts the original value from a signed string
136
- * without performing any signature verification. It's useful when you need
137
- * to access the value quickly without the overhead of cryptographic verification.
138
- *
139
- * @example
140
- * ```ts
141
- * const signedValue = "user123.oneQsU0r5dvwQFHFEjjV1uOI_IR3gZfkYHij3TRauVA"
142
- * const value = getSignedValue(signedValue)
143
- * expect(value).toEqual("user123")
144
- * ```
145
- */
146
- declare function getSignedValue(signedValue: string | undefined | null): string | undefined;
147
-
148
- export { decodeBase64url, decrypt, deleteCookie, encodeBase64url, encrypt, getCookie, getSignedValue, setCookie, sign, unsign };
149
- export type { GetCookieOptions, SetCookieOptions };
@@ -1,198 +0,0 @@
1
- import { parse, serialize } 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
- function deleteCookie(headers, name, options = {}) {
54
- return setCookie(headers, name, "", {
55
- ...options,
56
- maxAge: 0
57
- });
58
- }
59
-
60
- const PBKDF2_CONFIG = {
61
- name: "PBKDF2",
62
- iterations: 6e4,
63
- // Recommended minimum iterations per current OWASP guidelines
64
- hash: "SHA-256"
65
- };
66
- const AES_GCM_CONFIG = {
67
- name: "AES-GCM",
68
- length: 256
69
- };
70
- const CRYPTO_CONSTANTS = {
71
- SALT_LENGTH: 16,
72
- IV_LENGTH: 12
73
- };
74
- async function encrypt(value, secret) {
75
- const encoder = new TextEncoder();
76
- const data = encoder.encode(value);
77
- const salt = crypto.getRandomValues(new Uint8Array(CRYPTO_CONSTANTS.SALT_LENGTH));
78
- const keyMaterial = await crypto.subtle.importKey(
79
- "raw",
80
- encoder.encode(secret),
81
- PBKDF2_CONFIG.name,
82
- false,
83
- ["deriveKey"]
84
- );
85
- const key = await crypto.subtle.deriveKey(
86
- { ...PBKDF2_CONFIG, salt },
87
- keyMaterial,
88
- AES_GCM_CONFIG,
89
- false,
90
- ["encrypt"]
91
- );
92
- const iv = crypto.getRandomValues(new Uint8Array(CRYPTO_CONSTANTS.IV_LENGTH));
93
- const encrypted = await crypto.subtle.encrypt(
94
- { name: AES_GCM_CONFIG.name, iv },
95
- key,
96
- data
97
- );
98
- const result = new Uint8Array(salt.length + iv.length + encrypted.byteLength);
99
- result.set(salt, 0);
100
- result.set(iv, salt.length);
101
- result.set(new Uint8Array(encrypted), salt.length + iv.length);
102
- return encodeBase64url(result);
103
- }
104
- async function decrypt(encrypted, secret) {
105
- try {
106
- const data = decodeBase64url(encrypted);
107
- if (data === void 0) {
108
- return void 0;
109
- }
110
- const encoder = new TextEncoder();
111
- const decoder = new TextDecoder();
112
- const salt = data.slice(0, CRYPTO_CONSTANTS.SALT_LENGTH);
113
- const iv = data.slice(CRYPTO_CONSTANTS.SALT_LENGTH, CRYPTO_CONSTANTS.SALT_LENGTH + CRYPTO_CONSTANTS.IV_LENGTH);
114
- const encryptedData = data.slice(CRYPTO_CONSTANTS.SALT_LENGTH + CRYPTO_CONSTANTS.IV_LENGTH);
115
- const keyMaterial = await crypto.subtle.importKey(
116
- "raw",
117
- encoder.encode(secret),
118
- PBKDF2_CONFIG.name,
119
- false,
120
- ["deriveKey"]
121
- );
122
- const key = await crypto.subtle.deriveKey(
123
- { ...PBKDF2_CONFIG, salt },
124
- keyMaterial,
125
- AES_GCM_CONFIG,
126
- false,
127
- ["decrypt"]
128
- );
129
- const decrypted = await crypto.subtle.decrypt(
130
- { name: AES_GCM_CONFIG.name, iv },
131
- key,
132
- encryptedData
133
- );
134
- return decoder.decode(decrypted);
135
- } catch {
136
- return void 0;
137
- }
138
- }
139
-
140
- const ALGORITHM = { name: "HMAC", hash: "SHA-256" };
141
- async function sign(value, secret) {
142
- const encoder = new TextEncoder();
143
- const key = await crypto.subtle.importKey(
144
- "raw",
145
- encoder.encode(secret),
146
- ALGORITHM,
147
- false,
148
- ["sign"]
149
- );
150
- const signature = await crypto.subtle.sign(
151
- ALGORITHM,
152
- key,
153
- encoder.encode(value)
154
- );
155
- return `${value}.${encodeBase64url(new Uint8Array(signature))}`;
156
- }
157
- async function unsign(signedValue, secret) {
158
- if (typeof signedValue !== "string") {
159
- return void 0;
160
- }
161
- const lastDotIndex = signedValue.lastIndexOf(".");
162
- if (lastDotIndex === -1) {
163
- return void 0;
164
- }
165
- const value = signedValue.slice(0, lastDotIndex);
166
- const signatureBase64url = signedValue.slice(lastDotIndex + 1);
167
- const signature = decodeBase64url(signatureBase64url);
168
- if (signature === void 0) {
169
- return void 0;
170
- }
171
- const encoder = new TextEncoder();
172
- const key = await crypto.subtle.importKey(
173
- "raw",
174
- encoder.encode(secret),
175
- ALGORITHM,
176
- false,
177
- ["verify"]
178
- );
179
- const isValid = await crypto.subtle.verify(
180
- ALGORITHM,
181
- key,
182
- signature,
183
- encoder.encode(value)
184
- );
185
- return isValid ? value : void 0;
186
- }
187
- function getSignedValue(signedValue) {
188
- if (typeof signedValue !== "string") {
189
- return void 0;
190
- }
191
- const lastDotIndex = signedValue.lastIndexOf(".");
192
- if (lastDotIndex === -1) {
193
- return void 0;
194
- }
195
- return signedValue.slice(0, lastDotIndex);
196
- }
197
-
198
- export { decodeBase64url, decrypt, deleteCookie, encodeBase64url, encrypt, getCookie, getSignedValue, setCookie, sign, unsign };