@orpc/standard-server-node 0.0.0-next.fd6982a → 0.0.0-next.fdd2389
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 +11 -8
- package/dist/index.d.mts +12 -4
- package/dist/index.d.ts +12 -4
- package/dist/index.mjs +39 -35
- package/package.json +6 -6
package/README.md
CHANGED
|
@@ -17,6 +17,9 @@
|
|
|
17
17
|
<a href="https://discord.gg/TXEbwRBvQn">
|
|
18
18
|
<img alt="Discord" src="https://img.shields.io/discord/1308966753044398161?color=7389D8&label&logo=discord&logoColor=ffffff" />
|
|
19
19
|
</a>
|
|
20
|
+
<a href="https://deepwiki.com/unnoq/orpc">
|
|
21
|
+
<img src="https://deepwiki.com/badge.svg" alt="Ask DeepWiki">
|
|
22
|
+
</a>
|
|
20
23
|
</div>
|
|
21
24
|
|
|
22
25
|
<h3 align="center">Typesafe APIs Made Simple 🪄</h3>
|
|
@@ -30,7 +33,8 @@
|
|
|
30
33
|
- **🔗 End-to-End Type Safety**: Ensure type-safe inputs, outputs, and errors from client to server.
|
|
31
34
|
- **📘 First-Class OpenAPI**: Built-in support that fully adheres to the OpenAPI standard.
|
|
32
35
|
- **📝 Contract-First Development**: Optionally define your API contract before implementation.
|
|
33
|
-
-
|
|
36
|
+
- **🔍 First-Class OpenTelemetry**: Seamlessly integrate with OpenTelemetry for observability.
|
|
37
|
+
- **⚙️ Framework Integrations**: Seamlessly integrate with TanStack Query (React, Vue, Solid, Svelte, Angular), SWR, Pinia Colada, and more.
|
|
34
38
|
- **🚀 Server Actions**: Fully compatible with React Server Actions on Next.js, TanStack Start, and other platforms.
|
|
35
39
|
- **🔠 Standard Schema Support**: Works out of the box with Zod, Valibot, ArkType, and other schema validators.
|
|
36
40
|
- **🗃️ Native Types**: Supports native types like Date, File, Blob, BigInt, URL, and more.
|
|
@@ -38,7 +42,6 @@
|
|
|
38
42
|
- **📡 SSE & Streaming**: Enjoy full type-safe support for SSE and streaming.
|
|
39
43
|
- **🌍 Multi-Runtime Support**: Fast and lightweight on Cloudflare, Deno, Bun, Node.js, and beyond.
|
|
40
44
|
- **🔌 Extendability**: Easily extend functionality with plugins, middleware, and interceptors.
|
|
41
|
-
- **🛡️ Reliability**: Well-tested, TypeScript-based, production-ready, and MIT licensed.
|
|
42
45
|
|
|
43
46
|
## Documentation
|
|
44
47
|
|
|
@@ -49,14 +52,14 @@ You can find the full documentation [here](https://orpc.unnoq.com).
|
|
|
49
52
|
- [@orpc/contract](https://www.npmjs.com/package/@orpc/contract): Build your API contract.
|
|
50
53
|
- [@orpc/server](https://www.npmjs.com/package/@orpc/server): Build your API or implement API contract.
|
|
51
54
|
- [@orpc/client](https://www.npmjs.com/package/@orpc/client): Consume your API on the client with type-safety.
|
|
52
|
-
- [@orpc/
|
|
55
|
+
- [@orpc/openapi](https://www.npmjs.com/package/@orpc/openapi): Generate OpenAPI specs and handle OpenAPI requests.
|
|
56
|
+
- [@orpc/otel](https://www.npmjs.com/package/@orpc/otel): [OpenTelemetry](https://opentelemetry.io/) integration for observability.
|
|
57
|
+
- [@orpc/nest](https://www.npmjs.com/package/@orpc/nest): Deeply integrate oRPC with [NestJS](https://nestjs.com/).
|
|
53
58
|
- [@orpc/react](https://www.npmjs.com/package/@orpc/react): Utilities for integrating oRPC with React and React Server Actions.
|
|
54
|
-
- [@orpc/
|
|
55
|
-
- [@orpc/
|
|
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).
|
|
59
|
+
- [@orpc/tanstack-query](https://www.npmjs.com/package/@orpc/tanstack-query): [TanStack Query](https://tanstack.com/query/latest) integration.
|
|
60
|
+
- [@orpc/experimental-react-swr](https://www.npmjs.com/package/@orpc/experimental-react-swr): [SWR](https://swr.vercel.app/) integration.
|
|
58
61
|
- [@orpc/vue-colada](https://www.npmjs.com/package/@orpc/vue-colada): Integration with [Pinia Colada](https://pinia-colada.esm.dev/).
|
|
59
|
-
- [@orpc/
|
|
62
|
+
- [@orpc/hey-api](https://www.npmjs.com/package/@orpc/hey-api): [Hey API](https://heyapi.dev/) integration.
|
|
60
63
|
- [@orpc/zod](https://www.npmjs.com/package/@orpc/zod): More schemas that [Zod](https://zod.dev/) doesn't support yet.
|
|
61
64
|
- [@orpc/valibot](https://www.npmjs.com/package/@orpc/valibot): OpenAPI spec generation from [Valibot](https://valibot.dev/).
|
|
62
65
|
- [@orpc/arktype](https://www.npmjs.com/package/@orpc/arktype): OpenAPI spec generation from [ArkType](https://arktype.io/).
|
package/dist/index.d.mts
CHANGED
|
@@ -1,10 +1,12 @@
|
|
|
1
1
|
import { StandardBody, StandardHeaders, StandardLazyRequest, StandardResponse } from '@orpc/standard-server';
|
|
2
|
-
import { ToEventStreamOptions as ToEventStreamOptions$1 } from '@orpc/standard-server-fetch';
|
|
2
|
+
import { ToEventIteratorOptions as ToEventIteratorOptions$1, ToEventStreamOptions as ToEventStreamOptions$1 } from '@orpc/standard-server-fetch';
|
|
3
3
|
import Stream, { Readable } from 'node:stream';
|
|
4
4
|
import { IncomingMessage, ServerResponse } from 'node:http';
|
|
5
5
|
import { Http2ServerRequest, Http2ServerResponse } from 'node:http2';
|
|
6
6
|
|
|
7
|
-
|
|
7
|
+
interface ToEventIteratorOptions extends ToEventIteratorOptions$1 {
|
|
8
|
+
}
|
|
9
|
+
declare function toEventIterator(stream: Readable, options?: ToEventIteratorOptions): AsyncIteratorObject<unknown | void, unknown | void, void> & AsyncGenerator<unknown | void, unknown | void, void>;
|
|
8
10
|
interface ToEventStreamOptions extends ToEventStreamOptions$1 {
|
|
9
11
|
}
|
|
10
12
|
declare function toEventStream(iterator: AsyncIterator<unknown | void, unknown | void, void>, options?: ToEventStreamOptions): Readable;
|
|
@@ -15,10 +17,16 @@ type NodeHttpRequest = (IncomingMessage | Http2ServerRequest) & {
|
|
|
15
17
|
* This is useful for `express.js` middleware.
|
|
16
18
|
*/
|
|
17
19
|
originalUrl?: string;
|
|
20
|
+
/**
|
|
21
|
+
* Prefer parsed body if it is available.
|
|
22
|
+
*/
|
|
23
|
+
body?: unknown;
|
|
18
24
|
};
|
|
19
25
|
type NodeHttpResponse = ServerResponse | Http2ServerResponse;
|
|
20
26
|
|
|
21
|
-
|
|
27
|
+
interface ToStandardBodyOptions extends ToEventIteratorOptions {
|
|
28
|
+
}
|
|
29
|
+
declare function toStandardBody(req: NodeHttpRequest, options?: ToStandardBodyOptions): Promise<StandardBody>;
|
|
22
30
|
interface ToNodeHttpBodyOptions extends ToEventStreamOptions {
|
|
23
31
|
}
|
|
24
32
|
/**
|
|
@@ -41,4 +49,4 @@ declare function toAbortSignal(stream: Stream.Writable): AbortSignal;
|
|
|
41
49
|
declare function toStandardUrl(req: NodeHttpRequest): URL;
|
|
42
50
|
|
|
43
51
|
export { sendStandardResponse, toAbortSignal, toEventIterator, toEventStream, toNodeHttpBody, toStandardBody, toStandardLazyRequest, toStandardMethod, toStandardUrl };
|
|
44
|
-
export type { NodeHttpRequest, NodeHttpResponse, SendStandardResponseOptions, ToEventStreamOptions, ToNodeHttpBodyOptions };
|
|
52
|
+
export type { NodeHttpRequest, NodeHttpResponse, SendStandardResponseOptions, ToEventIteratorOptions, ToEventStreamOptions, ToNodeHttpBodyOptions, ToStandardBodyOptions };
|
package/dist/index.d.ts
CHANGED
|
@@ -1,10 +1,12 @@
|
|
|
1
1
|
import { StandardBody, StandardHeaders, StandardLazyRequest, StandardResponse } from '@orpc/standard-server';
|
|
2
|
-
import { ToEventStreamOptions as ToEventStreamOptions$1 } from '@orpc/standard-server-fetch';
|
|
2
|
+
import { ToEventIteratorOptions as ToEventIteratorOptions$1, ToEventStreamOptions as ToEventStreamOptions$1 } from '@orpc/standard-server-fetch';
|
|
3
3
|
import Stream, { Readable } from 'node:stream';
|
|
4
4
|
import { IncomingMessage, ServerResponse } from 'node:http';
|
|
5
5
|
import { Http2ServerRequest, Http2ServerResponse } from 'node:http2';
|
|
6
6
|
|
|
7
|
-
|
|
7
|
+
interface ToEventIteratorOptions extends ToEventIteratorOptions$1 {
|
|
8
|
+
}
|
|
9
|
+
declare function toEventIterator(stream: Readable, options?: ToEventIteratorOptions): AsyncIteratorObject<unknown | void, unknown | void, void> & AsyncGenerator<unknown | void, unknown | void, void>;
|
|
8
10
|
interface ToEventStreamOptions extends ToEventStreamOptions$1 {
|
|
9
11
|
}
|
|
10
12
|
declare function toEventStream(iterator: AsyncIterator<unknown | void, unknown | void, void>, options?: ToEventStreamOptions): Readable;
|
|
@@ -15,10 +17,16 @@ type NodeHttpRequest = (IncomingMessage | Http2ServerRequest) & {
|
|
|
15
17
|
* This is useful for `express.js` middleware.
|
|
16
18
|
*/
|
|
17
19
|
originalUrl?: string;
|
|
20
|
+
/**
|
|
21
|
+
* Prefer parsed body if it is available.
|
|
22
|
+
*/
|
|
23
|
+
body?: unknown;
|
|
18
24
|
};
|
|
19
25
|
type NodeHttpResponse = ServerResponse | Http2ServerResponse;
|
|
20
26
|
|
|
21
|
-
|
|
27
|
+
interface ToStandardBodyOptions extends ToEventIteratorOptions {
|
|
28
|
+
}
|
|
29
|
+
declare function toStandardBody(req: NodeHttpRequest, options?: ToStandardBodyOptions): Promise<StandardBody>;
|
|
22
30
|
interface ToNodeHttpBodyOptions extends ToEventStreamOptions {
|
|
23
31
|
}
|
|
24
32
|
/**
|
|
@@ -41,4 +49,4 @@ declare function toAbortSignal(stream: Stream.Writable): AbortSignal;
|
|
|
41
49
|
declare function toStandardUrl(req: NodeHttpRequest): URL;
|
|
42
50
|
|
|
43
51
|
export { sendStandardResponse, toAbortSignal, toEventIterator, toEventStream, toNodeHttpBody, toStandardBody, toStandardLazyRequest, toStandardMethod, toStandardUrl };
|
|
44
|
-
export type { NodeHttpRequest, NodeHttpResponse, SendStandardResponseOptions, ToEventStreamOptions, ToNodeHttpBodyOptions };
|
|
52
|
+
export type { NodeHttpRequest, NodeHttpResponse, SendStandardResponseOptions, ToEventIteratorOptions, ToEventStreamOptions, ToNodeHttpBodyOptions, ToStandardBodyOptions };
|
package/dist/index.mjs
CHANGED
|
@@ -1,40 +1,45 @@
|
|
|
1
1
|
import { Readable } from 'node:stream';
|
|
2
|
-
import { parseEmptyableJSON, isAsyncIteratorObject, stringifyJSON, once } from '@orpc/shared';
|
|
2
|
+
import { runWithSpan, parseEmptyableJSON, isAsyncIteratorObject, stringifyJSON, AbortError, guard, once } from '@orpc/shared';
|
|
3
3
|
import { getFilenameFromContentDisposition, flattenHeader, generateContentDisposition } from '@orpc/standard-server';
|
|
4
4
|
import { toEventIterator as toEventIterator$1, toEventStream as toEventStream$1 } from '@orpc/standard-server-fetch';
|
|
5
5
|
|
|
6
|
-
function toEventIterator(stream) {
|
|
7
|
-
return toEventIterator$1(Readable.toWeb(stream));
|
|
6
|
+
function toEventIterator(stream, options = {}) {
|
|
7
|
+
return toEventIterator$1(Readable.toWeb(stream), options);
|
|
8
8
|
}
|
|
9
9
|
function toEventStream(iterator, options = {}) {
|
|
10
10
|
return Readable.fromWeb(toEventStream$1(iterator, options));
|
|
11
11
|
}
|
|
12
12
|
|
|
13
|
-
|
|
14
|
-
|
|
15
|
-
|
|
16
|
-
if (typeof contentDisposition === "string") {
|
|
17
|
-
const fileName = getFilenameFromContentDisposition(contentDisposition) ?? "blob";
|
|
18
|
-
return _streamToFile(req, fileName, contentType ?? "");
|
|
13
|
+
function toStandardBody(req, options = {}) {
|
|
14
|
+
if (req.body !== void 0) {
|
|
15
|
+
return Promise.resolve(req.body);
|
|
19
16
|
}
|
|
20
|
-
|
|
21
|
-
const
|
|
22
|
-
|
|
23
|
-
|
|
24
|
-
|
|
25
|
-
|
|
26
|
-
|
|
27
|
-
|
|
28
|
-
|
|
29
|
-
|
|
30
|
-
|
|
31
|
-
|
|
32
|
-
|
|
33
|
-
|
|
34
|
-
|
|
35
|
-
|
|
36
|
-
|
|
37
|
-
|
|
17
|
+
return runWithSpan({ name: "parse_standard_body", signal: options.signal }, async () => {
|
|
18
|
+
const contentDisposition = req.headers["content-disposition"];
|
|
19
|
+
const contentType = req.headers["content-type"];
|
|
20
|
+
if (typeof contentDisposition === "string") {
|
|
21
|
+
const fileName = getFilenameFromContentDisposition(contentDisposition) ?? "blob";
|
|
22
|
+
return _streamToFile(req, fileName, contentType ?? "");
|
|
23
|
+
}
|
|
24
|
+
if (!contentType || contentType.startsWith("application/json")) {
|
|
25
|
+
const text = await _streamToString(req);
|
|
26
|
+
return parseEmptyableJSON(text);
|
|
27
|
+
}
|
|
28
|
+
if (contentType.startsWith("multipart/form-data")) {
|
|
29
|
+
return _streamToFormData(req, contentType);
|
|
30
|
+
}
|
|
31
|
+
if (contentType.startsWith("application/x-www-form-urlencoded")) {
|
|
32
|
+
const text = await _streamToString(req);
|
|
33
|
+
return new URLSearchParams(text);
|
|
34
|
+
}
|
|
35
|
+
if (contentType.startsWith("text/event-stream")) {
|
|
36
|
+
return toEventIterator(req, options);
|
|
37
|
+
}
|
|
38
|
+
if (contentType.startsWith("text/plain")) {
|
|
39
|
+
return _streamToString(req);
|
|
40
|
+
}
|
|
41
|
+
return _streamToFile(req, "blob", contentType);
|
|
42
|
+
});
|
|
38
43
|
}
|
|
39
44
|
function toNodeHttpBody(body, headers, options = {}) {
|
|
40
45
|
const currentContentDisposition = flattenHeader(headers["content-disposition"]);
|
|
@@ -60,8 +65,6 @@ function toNodeHttpBody(body, headers, options = {}) {
|
|
|
60
65
|
}
|
|
61
66
|
if (isAsyncIteratorObject(body)) {
|
|
62
67
|
headers["content-type"] = "text/event-stream";
|
|
63
|
-
headers["cache-control"] = "no-cache";
|
|
64
|
-
headers.connection = "keep-alive";
|
|
65
68
|
return toEventStream(body, options);
|
|
66
69
|
}
|
|
67
70
|
headers["content-type"] = "application/json";
|
|
@@ -99,7 +102,7 @@ function toAbortSignal(stream) {
|
|
|
99
102
|
stream.once("error", (error) => controller.abort(error));
|
|
100
103
|
stream.once("close", () => {
|
|
101
104
|
if (!stream.writableFinished) {
|
|
102
|
-
controller.abort(new
|
|
105
|
+
controller.abort(new AbortError("Writable stream closed before it finished writing"));
|
|
103
106
|
}
|
|
104
107
|
});
|
|
105
108
|
return controller.signal;
|
|
@@ -107,18 +110,19 @@ function toAbortSignal(stream) {
|
|
|
107
110
|
|
|
108
111
|
function toStandardUrl(req) {
|
|
109
112
|
const protocol = "encrypted" in req.socket && req.socket.encrypted ? "https:" : "http:";
|
|
110
|
-
const
|
|
111
|
-
const
|
|
112
|
-
return
|
|
113
|
+
const origin = guard(() => new URL(`${protocol}//${req.headers.host ?? "localhost"}`).origin) ?? `${protocol}//localhost`;
|
|
114
|
+
const path = req.originalUrl ?? req.url ?? "/";
|
|
115
|
+
return new URL(`${origin}${path.startsWith("/") ? "" : "/"}${path}`);
|
|
113
116
|
}
|
|
114
117
|
|
|
115
118
|
function toStandardLazyRequest(req, res) {
|
|
119
|
+
const signal = toAbortSignal(res);
|
|
116
120
|
return {
|
|
117
121
|
method: toStandardMethod(req.method),
|
|
118
122
|
url: toStandardUrl(req),
|
|
119
123
|
headers: req.headers,
|
|
120
|
-
body: once(() => toStandardBody(req)),
|
|
121
|
-
signal
|
|
124
|
+
body: once(() => toStandardBody(req, { signal })),
|
|
125
|
+
signal
|
|
122
126
|
};
|
|
123
127
|
}
|
|
124
128
|
|
package/package.json
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@orpc/standard-server-node",
|
|
3
3
|
"type": "module",
|
|
4
|
-
"version": "0.0.0-next.
|
|
4
|
+
"version": "0.0.0-next.fdd2389",
|
|
5
5
|
"license": "MIT",
|
|
6
6
|
"homepage": "https://orpc.unnoq.com",
|
|
7
7
|
"repository": {
|
|
@@ -23,14 +23,14 @@
|
|
|
23
23
|
"dist"
|
|
24
24
|
],
|
|
25
25
|
"dependencies": {
|
|
26
|
-
"@orpc/standard-server": "0.0.0-next.
|
|
27
|
-
"@orpc/
|
|
28
|
-
"@orpc/
|
|
26
|
+
"@orpc/standard-server": "0.0.0-next.fdd2389",
|
|
27
|
+
"@orpc/shared": "0.0.0-next.fdd2389",
|
|
28
|
+
"@orpc/standard-server-fetch": "0.0.0-next.fdd2389"
|
|
29
29
|
},
|
|
30
30
|
"devDependencies": {
|
|
31
|
-
"@types/node": "^22.15.
|
|
31
|
+
"@types/node": "^22.15.30",
|
|
32
32
|
"@types/supertest": "^6.0.3",
|
|
33
|
-
"supertest": "^7.1.
|
|
33
|
+
"supertest": "^7.1.4"
|
|
34
34
|
},
|
|
35
35
|
"scripts": {
|
|
36
36
|
"build": "unbuild",
|