@orpc/standard-server 0.0.0-next.dcc6c29 → 0.0.0-next.dd4e882

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 CHANGED
@@ -21,28 +21,24 @@
21
21
 
22
22
  <h3 align="center">Typesafe APIs Made Simple 🪄</h3>
23
23
 
24
- **oRPC is a powerful combination of RPC and OpenAPI**, makes it easy to build APIs that are end-to-end type-safe and adhere to OpenAPI standards, ensuring a smooth and enjoyable developer experience.
24
+ **oRPC is a powerful combination of RPC and OpenAPI**, makes it easy to build APIs that are end-to-end type-safe and adhere to OpenAPI standards
25
25
 
26
26
  ---
27
27
 
28
28
  ## Highlights
29
29
 
30
- - **End-to-End Type Safety 🔒**: Ensure complete type safety from inputs to outputs and errors, bridging server and client seamlessly.
31
- - **First-Class OpenAPI 📄**: Adheres to the OpenAPI standard out of the box, ensuring seamless integration and comprehensive API documentation.
32
- - **Contract-First Development 📜**: (Optional) Define your API contract upfront and implement it with confidence.
33
- - **Exceptional Developer Experience ✨**: Enjoy a streamlined workflow with robust typing and clear, in-code documentation.
34
- - **Multi-Runtime Support 🌍**: Run your code seamlessly on Cloudflare, Deno, Bun, Node.js, and more.
35
- - **Framework Integrations 🧩**: Supports Tanstack Query (React, Vue, Solid, Svelte), Pinia Colada, and more.
36
- - **Server Actions ⚡️**: Fully compatible with React Server Actions on Next.js, TanStack Start, and more.
37
- - **Standard Schema Support 🗂️**: Effortlessly work with Zod, Valibot, ArkType, and others right out of the box.
38
- - **Fast & Lightweight 💨**: Built on native APIs across all runtimes – optimized for speed and efficiency.
39
- - **Native Types 📦**: Enjoy built-in support for Date, File, Blob, BigInt, URL and more with no extra setup.
40
- - **Lazy Router ⏱️**: Improve cold start times with our lazy routing feature.
41
- - **SSE & Streaming 📡**: Provides SSE and streaming features – perfect for real-time notifications and AI-powered streaming responses.
42
- - **Reusability 🔄**: Write once and reuse your code across multiple purposes effortlessly.
43
- - **Extendability 🔌**: Easily enhance oRPC with plugins, middleware, and interceptors.
44
- - **Reliability 🛡️**: Well-tested, fully TypeScript, production-ready, and MIT licensed for peace of mind.
45
- - **Simplicity 💡**: Enjoy straightforward, clean code with no hidden magic.
30
+ - **🔗 End-to-End Type Safety**: Ensure type-safe inputs, outputs, and errors from client to server.
31
+ - **📘 First-Class OpenAPI**: Built-in support that fully adheres to the OpenAPI standard.
32
+ - **📝 Contract-First Development**: Optionally define your API contract before implementation.
33
+ - **⚙️ Framework Integrations**: Seamlessly integrate with TanStack Query (React, Vue, Solid, Svelte), Pinia Colada, and more.
34
+ - **🚀 Server Actions**: Fully compatible with React Server Actions on Next.js, TanStack Start, and other platforms.
35
+ - **🔠 Standard Schema Support**: Works out of the box with Zod, Valibot, ArkType, and other schema validators.
36
+ - **🗃️ Native Types**: Supports native types like Date, File, Blob, BigInt, URL, and more.
37
+ - **⏱️ Lazy Router**: Enhance cold start times with our lazy routing feature.
38
+ - **📡 SSE & Streaming**: Enjoy full type-safe support for SSE and streaming.
39
+ - **🌍 Multi-Runtime Support**: Fast and lightweight on Cloudflare, Deno, Bun, Node.js, and beyond.
40
+ - **🔌 Extendability**: Easily extend functionality with plugins, middleware, and interceptors.
41
+ - **🛡️ Reliability**: Well-tested, TypeScript-based, production-ready, and MIT licensed.
46
42
 
47
43
  ## Documentation
48
44
 
@@ -53,6 +49,7 @@ You can find the full documentation [here](https://orpc.unnoq.com).
53
49
  - [@orpc/contract](https://www.npmjs.com/package/@orpc/contract): Build your API contract.
54
50
  - [@orpc/server](https://www.npmjs.com/package/@orpc/server): Build your API or implement API contract.
55
51
  - [@orpc/client](https://www.npmjs.com/package/@orpc/client): Consume your API on the client with type-safety.
52
+ - [@orpc/nest](https://www.npmjs.com/package/@orpc/nest): Deeply integrate oRPC with NestJS.
56
53
  - [@orpc/react](https://www.npmjs.com/package/@orpc/react): Utilities for integrating oRPC with React and React Server Actions.
57
54
  - [@orpc/react-query](https://www.npmjs.com/package/@orpc/react-query): Integration with [React Query](https://tanstack.com/query/latest/docs/framework/react/overview).
58
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).
@@ -1,4 +1,5 @@
1
- import { S as StandardHeaders, b as StandardRequest, d as StandardResponse } from '../shared/standard-server.R_NaHlxw.mjs';
1
+ import { S as StandardHeaders, c as StandardRequest, e as StandardResponse } from '../shared/standard-server.BD8Sg1A5.mjs';
2
+ import { Promisable } from '@orpc/shared';
2
3
 
3
4
  interface ToBatchRequestOptions {
4
5
  url: URL;
@@ -9,15 +10,21 @@ interface ToBatchRequestOptions {
9
10
  declare function toBatchRequest(options: ToBatchRequestOptions): StandardRequest;
10
11
  declare function parseBatchRequest(request: StandardRequest): StandardRequest[];
11
12
 
13
+ type BatchResponseMode = 'streaming' | 'buffered';
12
14
  interface BatchResponseBodyItem extends StandardResponse {
13
15
  index: number;
14
16
  }
15
17
  interface ToBatchResponseOptions extends StandardResponse {
16
18
  body: AsyncIteratorObject<BatchResponseBodyItem>;
19
+ /**
20
+ * @default 'streaming'
21
+ */
22
+ mode?: BatchResponseMode;
17
23
  }
18
- declare function toBatchResponse(options: ToBatchResponseOptions): StandardResponse;
24
+ declare function toBatchResponse(options: ToBatchResponseOptions): Promisable<StandardResponse>;
19
25
  declare function parseBatchResponse(response: StandardResponse): AsyncGenerator<BatchResponseBodyItem>;
20
26
 
21
27
  declare function toBatchAbortSignal(signals: readonly (AbortSignal | undefined)[]): AbortSignal | undefined;
22
28
 
23
- export { type BatchResponseBodyItem, type ToBatchRequestOptions, type ToBatchResponseOptions, parseBatchRequest, parseBatchResponse, toBatchAbortSignal, toBatchRequest, toBatchResponse };
29
+ export { parseBatchRequest, parseBatchResponse, toBatchAbortSignal, toBatchRequest, toBatchResponse };
30
+ export type { BatchResponseBodyItem, BatchResponseMode, ToBatchRequestOptions, ToBatchResponseOptions };
@@ -1,4 +1,5 @@
1
- import { S as StandardHeaders, b as StandardRequest, d as StandardResponse } from '../shared/standard-server.R_NaHlxw.js';
1
+ import { S as StandardHeaders, c as StandardRequest, e as StandardResponse } from '../shared/standard-server.BD8Sg1A5.js';
2
+ import { Promisable } from '@orpc/shared';
2
3
 
3
4
  interface ToBatchRequestOptions {
4
5
  url: URL;
@@ -9,15 +10,21 @@ interface ToBatchRequestOptions {
9
10
  declare function toBatchRequest(options: ToBatchRequestOptions): StandardRequest;
10
11
  declare function parseBatchRequest(request: StandardRequest): StandardRequest[];
11
12
 
13
+ type BatchResponseMode = 'streaming' | 'buffered';
12
14
  interface BatchResponseBodyItem extends StandardResponse {
13
15
  index: number;
14
16
  }
15
17
  interface ToBatchResponseOptions extends StandardResponse {
16
18
  body: AsyncIteratorObject<BatchResponseBodyItem>;
19
+ /**
20
+ * @default 'streaming'
21
+ */
22
+ mode?: BatchResponseMode;
17
23
  }
18
- declare function toBatchResponse(options: ToBatchResponseOptions): StandardResponse;
24
+ declare function toBatchResponse(options: ToBatchResponseOptions): Promisable<StandardResponse>;
19
25
  declare function parseBatchResponse(response: StandardResponse): AsyncGenerator<BatchResponseBodyItem>;
20
26
 
21
27
  declare function toBatchAbortSignal(signals: readonly (AbortSignal | undefined)[]): AbortSignal | undefined;
22
28
 
23
- export { type BatchResponseBodyItem, type ToBatchRequestOptions, type ToBatchResponseOptions, parseBatchRequest, parseBatchResponse, toBatchAbortSignal, toBatchRequest, toBatchResponse };
29
+ export { parseBatchRequest, parseBatchResponse, toBatchAbortSignal, toBatchRequest, toBatchResponse };
30
+ export type { BatchResponseBodyItem, BatchResponseMode, ToBatchRequestOptions, ToBatchResponseOptions };
@@ -62,8 +62,35 @@ function parseBatchRequest(request) {
62
62
  }
63
63
 
64
64
  function toBatchResponse(options) {
65
+ const mode = options.mode ?? "streaming";
66
+ const minifyResponseItem = (item) => {
67
+ return {
68
+ index: item.index,
69
+ status: item.status === options.status ? void 0 : item.status,
70
+ headers: Object.keys(item.headers).length ? item.headers : void 0,
71
+ body: item.body
72
+ };
73
+ };
74
+ if (mode === "buffered") {
75
+ return (async () => {
76
+ try {
77
+ const body = [];
78
+ for await (const item of options.body) {
79
+ body.push(minifyResponseItem(item));
80
+ }
81
+ return {
82
+ headers: options.headers,
83
+ status: options.status,
84
+ body
85
+ };
86
+ } finally {
87
+ await options.body.return?.();
88
+ }
89
+ })();
90
+ }
65
91
  return {
66
- ...options,
92
+ headers: options.headers,
93
+ status: options.status,
67
94
  body: async function* () {
68
95
  try {
69
96
  for await (const item of options.body) {
@@ -75,37 +102,39 @@ function toBatchResponse(options) {
75
102
  };
76
103
  }
77
104
  } finally {
78
- options.body.return?.();
105
+ await options.body.return?.();
79
106
  }
80
107
  }()
81
108
  };
82
109
  }
83
110
  function parseBatchResponse(response) {
84
111
  const body = response.body;
85
- if (!isAsyncIteratorObject(body)) {
86
- throw new TypeError("Invalid batch response", {
87
- cause: response
88
- });
89
- }
90
- return async function* () {
91
- try {
92
- for await (const item of body) {
93
- if (!isObject(item) || !("index" in item) || typeof item.index !== "number") {
94
- throw new TypeError("Invalid batch response", {
95
- cause: item
96
- });
112
+ if (isAsyncIteratorObject(body) || Array.isArray(body)) {
113
+ return async function* () {
114
+ try {
115
+ for await (const item of body) {
116
+ if (!isObject(item) || !("index" in item) || typeof item.index !== "number") {
117
+ throw new TypeError("Invalid batch response", {
118
+ cause: item
119
+ });
120
+ }
121
+ yield {
122
+ index: item.index,
123
+ status: item.status ?? response.status,
124
+ headers: item.headers ?? {},
125
+ body: item.body
126
+ };
127
+ }
128
+ } finally {
129
+ if (isAsyncIteratorObject(body)) {
130
+ await body.return?.();
97
131
  }
98
- yield {
99
- index: item.index,
100
- status: item.status ?? response.status,
101
- headers: item.headers ?? {},
102
- body: item.body
103
- };
104
132
  }
105
- } finally {
106
- await body.return?.();
107
- }
108
- }();
133
+ }();
134
+ }
135
+ throw new TypeError("Invalid batch response", {
136
+ cause: response
137
+ });
109
138
  }
110
139
 
111
140
  export { parseBatchRequest, parseBatchResponse, toBatchAbortSignal, toBatchRequest, toBatchResponse };
package/dist/index.d.mts CHANGED
@@ -1,5 +1,5 @@
1
- import { S as StandardHeaders } from './shared/standard-server.R_NaHlxw.mjs';
2
- export { a as StandardBody, c as StandardLazyRequest, e as StandardLazyResponse, b as StandardRequest, d as StandardResponse } from './shared/standard-server.R_NaHlxw.mjs';
1
+ import { S as StandardHeaders, a as StandardLazyResponse } from './shared/standard-server.BD8Sg1A5.mjs';
2
+ export { b as StandardBody, d as StandardLazyRequest, c as StandardRequest, e as StandardResponse } from './shared/standard-server.BD8Sg1A5.mjs';
3
3
 
4
4
  interface EventMessage {
5
5
  event: string | undefined;
@@ -55,5 +55,8 @@ declare function getEventMeta(container: unknown): EventMeta | undefined;
55
55
  declare function generateContentDisposition(filename: string): string;
56
56
  declare function getFilenameFromContentDisposition(contentDisposition: string): string | undefined;
57
57
  declare function mergeStandardHeaders(a: StandardHeaders, b: StandardHeaders): StandardHeaders;
58
+ declare function flattenHeader(header: string | readonly string[] | undefined): string | undefined;
59
+ declare function replicateStandardLazyResponse(response: StandardLazyResponse, count: number): StandardLazyResponse[];
58
60
 
59
- export { ErrorEvent, type ErrorEventOptions, EventDecoder, EventDecoderError, type EventDecoderOptions, EventDecoderStream, EventEncoderError, type EventMessage, type EventMeta, StandardHeaders, assertEventComment, assertEventId, assertEventName, assertEventRetry, decodeEventMessage, encodeEventComments, encodeEventData, encodeEventMessage, generateContentDisposition, getEventMeta, getFilenameFromContentDisposition, mergeStandardHeaders, withEventMeta };
61
+ export { ErrorEvent, EventDecoder, EventDecoderError, EventDecoderStream, EventEncoderError, StandardHeaders, StandardLazyResponse, assertEventComment, assertEventId, assertEventName, assertEventRetry, decodeEventMessage, encodeEventComments, encodeEventData, encodeEventMessage, flattenHeader, generateContentDisposition, getEventMeta, getFilenameFromContentDisposition, mergeStandardHeaders, replicateStandardLazyResponse, withEventMeta };
62
+ export type { ErrorEventOptions, EventDecoderOptions, EventMessage, EventMeta };
package/dist/index.d.ts CHANGED
@@ -1,5 +1,5 @@
1
- import { S as StandardHeaders } from './shared/standard-server.R_NaHlxw.js';
2
- export { a as StandardBody, c as StandardLazyRequest, e as StandardLazyResponse, b as StandardRequest, d as StandardResponse } from './shared/standard-server.R_NaHlxw.js';
1
+ import { S as StandardHeaders, a as StandardLazyResponse } from './shared/standard-server.BD8Sg1A5.js';
2
+ export { b as StandardBody, d as StandardLazyRequest, c as StandardRequest, e as StandardResponse } from './shared/standard-server.BD8Sg1A5.js';
3
3
 
4
4
  interface EventMessage {
5
5
  event: string | undefined;
@@ -55,5 +55,8 @@ declare function getEventMeta(container: unknown): EventMeta | undefined;
55
55
  declare function generateContentDisposition(filename: string): string;
56
56
  declare function getFilenameFromContentDisposition(contentDisposition: string): string | undefined;
57
57
  declare function mergeStandardHeaders(a: StandardHeaders, b: StandardHeaders): StandardHeaders;
58
+ declare function flattenHeader(header: string | readonly string[] | undefined): string | undefined;
59
+ declare function replicateStandardLazyResponse(response: StandardLazyResponse, count: number): StandardLazyResponse[];
58
60
 
59
- export { ErrorEvent, type ErrorEventOptions, EventDecoder, EventDecoderError, type EventDecoderOptions, EventDecoderStream, EventEncoderError, type EventMessage, type EventMeta, StandardHeaders, assertEventComment, assertEventId, assertEventName, assertEventRetry, decodeEventMessage, encodeEventComments, encodeEventData, encodeEventMessage, generateContentDisposition, getEventMeta, getFilenameFromContentDisposition, mergeStandardHeaders, withEventMeta };
61
+ export { ErrorEvent, EventDecoder, EventDecoderError, EventDecoderStream, EventEncoderError, StandardHeaders, StandardLazyResponse, assertEventComment, assertEventId, assertEventName, assertEventRetry, decodeEventMessage, encodeEventComments, encodeEventData, encodeEventMessage, flattenHeader, generateContentDisposition, getEventMeta, getFilenameFromContentDisposition, mergeStandardHeaders, replicateStandardLazyResponse, withEventMeta };
62
+ export type { ErrorEventOptions, EventDecoderOptions, EventMessage, EventMeta };
package/dist/index.mjs CHANGED
@@ -1,4 +1,4 @@
1
- import { isTypescriptObject, toArray } from '@orpc/shared';
1
+ import { isTypescriptObject, toArray, once, isAsyncIteratorObject, replicateAsyncIterator } from '@orpc/shared';
2
2
 
3
3
  class EventEncoderError extends TypeError {
4
4
  }
@@ -214,5 +214,36 @@ function mergeStandardHeaders(a, b) {
214
214
  }
215
215
  return merged;
216
216
  }
217
+ function flattenHeader(header) {
218
+ if (typeof header === "string" || header === void 0) {
219
+ return header;
220
+ }
221
+ if (header.length === 0) {
222
+ return void 0;
223
+ }
224
+ return header.join(", ");
225
+ }
226
+ function replicateStandardLazyResponse(response, count) {
227
+ const replicated = [];
228
+ let bodyPromise;
229
+ let replicatedAsyncIteratorObjects;
230
+ for (let i = 0; i < count; i++) {
231
+ replicated.push({
232
+ ...response,
233
+ body: once(async () => {
234
+ if (replicatedAsyncIteratorObjects) {
235
+ return replicatedAsyncIteratorObjects.shift();
236
+ }
237
+ const body = await (bodyPromise ??= response.body());
238
+ if (!isAsyncIteratorObject(body)) {
239
+ return body;
240
+ }
241
+ replicatedAsyncIteratorObjects = replicateAsyncIterator(body, count);
242
+ return replicatedAsyncIteratorObjects.shift();
243
+ })
244
+ });
245
+ }
246
+ return replicated;
247
+ }
217
248
 
218
- export { ErrorEvent, EventDecoder, EventDecoderError, EventDecoderStream, EventEncoderError, assertEventComment, assertEventId, assertEventName, assertEventRetry, decodeEventMessage, encodeEventComments, encodeEventData, encodeEventMessage, generateContentDisposition, getEventMeta, getFilenameFromContentDisposition, mergeStandardHeaders, withEventMeta };
249
+ export { ErrorEvent, EventDecoder, EventDecoderError, EventDecoderStream, EventEncoderError, assertEventComment, assertEventId, assertEventName, assertEventRetry, decodeEventMessage, encodeEventComments, encodeEventData, encodeEventMessage, flattenHeader, generateContentDisposition, getEventMeta, getFilenameFromContentDisposition, mergeStandardHeaders, replicateStandardLazyResponse, withEventMeta };
@@ -35,4 +35,4 @@ interface StandardLazyResponse extends Omit<StandardResponse, 'body'> {
35
35
  body: () => Promise<StandardBody>;
36
36
  }
37
37
 
38
- export type { StandardHeaders as S, StandardBody as a, StandardRequest as b, StandardLazyRequest as c, StandardResponse as d, StandardLazyResponse as e };
38
+ export type { StandardHeaders as S, StandardLazyResponse as a, StandardBody as b, StandardRequest as c, StandardLazyRequest as d, StandardResponse as e };
@@ -35,4 +35,4 @@ interface StandardLazyResponse extends Omit<StandardResponse, 'body'> {
35
35
  body: () => Promise<StandardBody>;
36
36
  }
37
37
 
38
- export type { StandardHeaders as S, StandardBody as a, StandardRequest as b, StandardLazyRequest as c, StandardResponse as d, StandardLazyResponse as e };
38
+ export type { StandardHeaders as S, StandardLazyResponse as a, StandardBody as b, StandardRequest as c, StandardLazyRequest as d, StandardResponse as e };
package/package.json CHANGED
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "name": "@orpc/standard-server",
3
3
  "type": "module",
4
- "version": "0.0.0-next.dcc6c29",
4
+ "version": "0.0.0-next.dd4e882",
5
5
  "license": "MIT",
6
6
  "homepage": "https://unnoq.com",
7
7
  "repository": {
@@ -28,7 +28,7 @@
28
28
  "dist"
29
29
  ],
30
30
  "dependencies": {
31
- "@orpc/shared": "0.0.0-next.dcc6c29"
31
+ "@orpc/shared": "0.0.0-next.dd4e882"
32
32
  },
33
33
  "scripts": {
34
34
  "build": "unbuild",