@orpc/standard-server 0.0.0-next.f16d90e → 0.0.0-next.f437dcb

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
@@ -30,7 +30,8 @@
30
30
  - **🔗 End-to-End Type Safety**: Ensure type-safe inputs, outputs, and errors from client to server.
31
31
  - **📘 First-Class OpenAPI**: Built-in support that fully adheres to the OpenAPI standard.
32
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.
33
+ - **🔍 First-Class OpenTelemetry**: Seamlessly integrate with OpenTelemetry for observability.
34
+ - **⚙️ Framework Integrations**: Seamlessly integrate with TanStack Query (React, Vue, Solid, Svelte, Angular), SWR, Pinia Colada, and more.
34
35
  - **🚀 Server Actions**: Fully compatible with React Server Actions on Next.js, TanStack Start, and other platforms.
35
36
  - **🔠 Standard Schema Support**: Works out of the box with Zod, Valibot, ArkType, and other schema validators.
36
37
  - **🗃️ Native Types**: Supports native types like Date, File, Blob, BigInt, URL, and more.
@@ -38,7 +39,6 @@
38
39
  - **📡 SSE & Streaming**: Enjoy full type-safe support for SSE and streaming.
39
40
  - **🌍 Multi-Runtime Support**: Fast and lightweight on Cloudflare, Deno, Bun, Node.js, and beyond.
40
41
  - **🔌 Extendability**: Easily extend functionality with plugins, middleware, and interceptors.
41
- - **🛡️ Reliability**: Well-tested, TypeScript-based, production-ready, and MIT licensed.
42
42
 
43
43
  ## Documentation
44
44
 
@@ -49,14 +49,14 @@ You can find the full documentation [here](https://orpc.unnoq.com).
49
49
  - [@orpc/contract](https://www.npmjs.com/package/@orpc/contract): Build your API contract.
50
50
  - [@orpc/server](https://www.npmjs.com/package/@orpc/server): Build your API or implement API contract.
51
51
  - [@orpc/client](https://www.npmjs.com/package/@orpc/client): Consume your API on the client with type-safety.
52
- - [@orpc/nest](https://www.npmjs.com/package/@orpc/nest): Deeply integrate oRPC with NestJS.
52
+ - [@orpc/openapi](https://www.npmjs.com/package/@orpc/openapi): Generate OpenAPI specs and handle OpenAPI requests.
53
+ - [@orpc/otel](https://www.npmjs.com/package/@orpc/otel): [OpenTelemetry](https://opentelemetry.io/) integration for observability.
54
+ - [@orpc/nest](https://www.npmjs.com/package/@orpc/nest): Deeply integrate oRPC with [NestJS](https://nestjs.com/).
53
55
  - [@orpc/react](https://www.npmjs.com/package/@orpc/react): Utilities for integrating oRPC with React and React Server Actions.
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).
55
- - [@orpc/vue-query](https://www.npmjs.com/package/@orpc/vue-query): Integration with [Vue Query](https://tanstack.com/query/latest/docs/framework/vue/overview).
56
- - [@orpc/solid-query](https://www.npmjs.com/package/@orpc/solid-query): Integration with [Solid Query](https://tanstack.com/query/latest/docs/framework/solid/overview).
57
- - [@orpc/svelte-query](https://www.npmjs.com/package/@orpc/svelte-query): Integration with [Svelte Query](https://tanstack.com/query/latest/docs/framework/svelte/overview).
56
+ - [@orpc/tanstack-query](https://www.npmjs.com/package/@orpc/tanstack-query): [TanStack Query](https://tanstack.com/query/latest) integration.
57
+ - [@orpc/experimental-react-swr](https://www.npmjs.com/package/@orpc/experimental-react-swr): [SWR](https://swr.vercel.app/) integration.
58
58
  - [@orpc/vue-colada](https://www.npmjs.com/package/@orpc/vue-colada): Integration with [Pinia Colada](https://pinia-colada.esm.dev/).
59
- - [@orpc/openapi](https://www.npmjs.com/package/@orpc/openapi): Generate OpenAPI specs and handle OpenAPI requests.
59
+ - [@orpc/hey-api](https://www.npmjs.com/package/@orpc/hey-api): [Hey API](https://heyapi.dev/) integration.
60
60
  - [@orpc/zod](https://www.npmjs.com/package/@orpc/zod): More schemas that [Zod](https://zod.dev/) doesn't support yet.
61
61
  - [@orpc/valibot](https://www.npmjs.com/package/@orpc/valibot): OpenAPI spec generation from [Valibot](https://valibot.dev/).
62
62
  - [@orpc/arktype](https://www.npmjs.com/package/@orpc/arktype): OpenAPI spec generation from [ArkType](https://arktype.io/).
@@ -1,4 +1,5 @@
1
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,16 +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
29
  export { parseBatchRequest, parseBatchResponse, toBatchAbortSignal, toBatchRequest, toBatchResponse };
24
- export type { BatchResponseBodyItem, ToBatchRequestOptions, ToBatchResponseOptions };
30
+ export type { BatchResponseBodyItem, BatchResponseMode, ToBatchRequestOptions, ToBatchResponseOptions };
@@ -1,4 +1,5 @@
1
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,16 +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
29
  export { parseBatchRequest, parseBatchResponse, toBatchAbortSignal, toBatchRequest, toBatchResponse };
24
- export type { BatchResponseBodyItem, ToBatchRequestOptions, ToBatchResponseOptions };
30
+ export type { BatchResponseBodyItem, BatchResponseMode, ToBatchRequestOptions, ToBatchResponseOptions };
@@ -62,9 +62,36 @@ 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,
67
- body: async function* () {
92
+ headers: options.headers,
93
+ status: options.status,
94
+ body: (async function* () {
68
95
  try {
69
96
  for await (const item of options.body) {
70
97
  yield {
@@ -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,3 +1,4 @@
1
+ import { AsyncIteratorClass } from '@orpc/shared';
1
2
  import { S as StandardHeaders, a as StandardLazyResponse } from './shared/standard-server.BD8Sg1A5.mjs';
2
3
  export { b as StandardBody, d as StandardLazyRequest, c as StandardRequest, e as StandardResponse } from './shared/standard-server.BD8Sg1A5.mjs';
3
4
 
@@ -52,11 +53,23 @@ type EventMeta = Partial<Pick<EventMessage, 'retry' | 'id' | 'comments'>>;
52
53
  declare function withEventMeta<T extends object>(container: T, meta: EventMeta): T;
53
54
  declare function getEventMeta(container: unknown): EventMeta | undefined;
54
55
 
56
+ interface HibernationEventIteratorCallback {
57
+ (id: string): void;
58
+ }
59
+ declare class HibernationEventIterator<T, TReturn = unknown, TNext = unknown> extends AsyncIteratorClass<T, TReturn, TNext> {
60
+ /**
61
+ * this property is not transferred to the client, so it should be optional for type safety
62
+ */
63
+ readonly hibernationCallback?: HibernationEventIteratorCallback;
64
+ constructor(hibernationCallback: HibernationEventIteratorCallback);
65
+ }
66
+
55
67
  declare function generateContentDisposition(filename: string): string;
56
68
  declare function getFilenameFromContentDisposition(contentDisposition: string): string | undefined;
57
69
  declare function mergeStandardHeaders(a: StandardHeaders, b: StandardHeaders): StandardHeaders;
58
70
  declare function flattenHeader(header: string | readonly string[] | undefined): string | undefined;
59
71
  declare function replicateStandardLazyResponse(response: StandardLazyResponse, count: number): StandardLazyResponse[];
72
+ declare function isEventIteratorHeaders(headers: StandardHeaders): boolean;
60
73
 
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 };
74
+ export { ErrorEvent, EventDecoder, EventDecoderError, EventDecoderStream, EventEncoderError, HibernationEventIterator, StandardHeaders, StandardLazyResponse, assertEventComment, assertEventId, assertEventName, assertEventRetry, decodeEventMessage, encodeEventComments, encodeEventData, encodeEventMessage, flattenHeader, generateContentDisposition, getEventMeta, getFilenameFromContentDisposition, isEventIteratorHeaders, mergeStandardHeaders, replicateStandardLazyResponse, withEventMeta };
75
+ export type { ErrorEventOptions, EventDecoderOptions, EventMessage, EventMeta, HibernationEventIteratorCallback };
package/dist/index.d.ts CHANGED
@@ -1,3 +1,4 @@
1
+ import { AsyncIteratorClass } from '@orpc/shared';
1
2
  import { S as StandardHeaders, a as StandardLazyResponse } from './shared/standard-server.BD8Sg1A5.js';
2
3
  export { b as StandardBody, d as StandardLazyRequest, c as StandardRequest, e as StandardResponse } from './shared/standard-server.BD8Sg1A5.js';
3
4
 
@@ -52,11 +53,23 @@ type EventMeta = Partial<Pick<EventMessage, 'retry' | 'id' | 'comments'>>;
52
53
  declare function withEventMeta<T extends object>(container: T, meta: EventMeta): T;
53
54
  declare function getEventMeta(container: unknown): EventMeta | undefined;
54
55
 
56
+ interface HibernationEventIteratorCallback {
57
+ (id: string): void;
58
+ }
59
+ declare class HibernationEventIterator<T, TReturn = unknown, TNext = unknown> extends AsyncIteratorClass<T, TReturn, TNext> {
60
+ /**
61
+ * this property is not transferred to the client, so it should be optional for type safety
62
+ */
63
+ readonly hibernationCallback?: HibernationEventIteratorCallback;
64
+ constructor(hibernationCallback: HibernationEventIteratorCallback);
65
+ }
66
+
55
67
  declare function generateContentDisposition(filename: string): string;
56
68
  declare function getFilenameFromContentDisposition(contentDisposition: string): string | undefined;
57
69
  declare function mergeStandardHeaders(a: StandardHeaders, b: StandardHeaders): StandardHeaders;
58
70
  declare function flattenHeader(header: string | readonly string[] | undefined): string | undefined;
59
71
  declare function replicateStandardLazyResponse(response: StandardLazyResponse, count: number): StandardLazyResponse[];
72
+ declare function isEventIteratorHeaders(headers: StandardHeaders): boolean;
60
73
 
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 };
74
+ export { ErrorEvent, EventDecoder, EventDecoderError, EventDecoderStream, EventEncoderError, HibernationEventIterator, StandardHeaders, StandardLazyResponse, assertEventComment, assertEventId, assertEventName, assertEventRetry, decodeEventMessage, encodeEventComments, encodeEventData, encodeEventMessage, flattenHeader, generateContentDisposition, getEventMeta, getFilenameFromContentDisposition, isEventIteratorHeaders, mergeStandardHeaders, replicateStandardLazyResponse, withEventMeta };
75
+ export type { ErrorEventOptions, EventDecoderOptions, EventMessage, EventMeta, HibernationEventIteratorCallback };
package/dist/index.mjs CHANGED
@@ -1,4 +1,4 @@
1
- import { isTypescriptObject, toArray, once, isAsyncIteratorObject, replicateAsyncIterator } from '@orpc/shared';
1
+ import { isTypescriptObject, AsyncIteratorClass, tryDecodeURIComponent, toArray, once, isAsyncIteratorObject, replicateAsyncIterator } from '@orpc/shared';
2
2
 
3
3
  class EventEncoderError extends TypeError {
4
4
  }
@@ -182,6 +182,23 @@ function getEventMeta(container) {
182
182
  return isTypescriptObject(container) ? Reflect.get(container, EVENT_SOURCE_META_SYMBOL) : void 0;
183
183
  }
184
184
 
185
+ class HibernationEventIterator extends AsyncIteratorClass {
186
+ /**
187
+ * this property is not transferred to the client, so it should be optional for type safety
188
+ */
189
+ hibernationCallback;
190
+ constructor(hibernationCallback) {
191
+ super(async () => {
192
+ throw new Error("Cannot iterate over hibernating iterator directly");
193
+ }, async (reason) => {
194
+ if (reason !== "next") {
195
+ throw new Error("Cannot cleanup hibernating iterator directly");
196
+ }
197
+ });
198
+ this.hibernationCallback = hibernationCallback;
199
+ }
200
+ }
201
+
185
202
  function generateContentDisposition(filename) {
186
203
  const escapedFileName = filename.replace(/"/g, '\\"');
187
204
  const encodedFilenameStar = encodeURIComponent(filename).replace(/['()*]/g, (c) => `%${c.charCodeAt(0).toString(16).toUpperCase()}`).replace(/%(7C|60|5E)/g, (str, hex) => String.fromCharCode(Number.parseInt(hex, 16)));
@@ -190,7 +207,7 @@ function generateContentDisposition(filename) {
190
207
  function getFilenameFromContentDisposition(contentDisposition) {
191
208
  const encodedFilenameStarMatch = contentDisposition.match(/filename\*=(UTF-8'')?([^;]*)/i);
192
209
  if (encodedFilenameStarMatch && typeof encodedFilenameStarMatch[2] === "string") {
193
- return decodeURIComponent(encodedFilenameStarMatch[2]);
210
+ return tryDecodeURIComponent(encodedFilenameStarMatch[2]);
194
211
  }
195
212
  const encodedFilenameMatch = contentDisposition.match(/filename="((?:\\"|[^"])*)"/i);
196
213
  if (encodedFilenameMatch && typeof encodedFilenameMatch[1] === "string") {
@@ -231,19 +248,19 @@ function replicateStandardLazyResponse(response, count) {
231
248
  replicated.push({
232
249
  ...response,
233
250
  body: once(async () => {
234
- if (replicatedAsyncIteratorObjects) {
235
- return replicatedAsyncIteratorObjects.shift();
236
- }
237
251
  const body = await (bodyPromise ??= response.body());
238
252
  if (!isAsyncIteratorObject(body)) {
239
253
  return body;
240
254
  }
241
- replicatedAsyncIteratorObjects = replicateAsyncIterator(body, count);
255
+ replicatedAsyncIteratorObjects ??= replicateAsyncIterator(body, count);
242
256
  return replicatedAsyncIteratorObjects.shift();
243
257
  })
244
258
  });
245
259
  }
246
260
  return replicated;
247
261
  }
262
+ function isEventIteratorHeaders(headers) {
263
+ return Boolean(flattenHeader(headers["content-type"])?.startsWith("text/event-stream") && flattenHeader(headers["content-disposition"]) === void 0);
264
+ }
248
265
 
249
- export { ErrorEvent, EventDecoder, EventDecoderError, EventDecoderStream, EventEncoderError, assertEventComment, assertEventId, assertEventName, assertEventRetry, decodeEventMessage, encodeEventComments, encodeEventData, encodeEventMessage, flattenHeader, generateContentDisposition, getEventMeta, getFilenameFromContentDisposition, mergeStandardHeaders, replicateStandardLazyResponse, withEventMeta };
266
+ export { ErrorEvent, EventDecoder, EventDecoderError, EventDecoderStream, EventEncoderError, HibernationEventIterator, assertEventComment, assertEventId, assertEventName, assertEventRetry, decodeEventMessage, encodeEventComments, encodeEventData, encodeEventMessage, flattenHeader, generateContentDisposition, getEventMeta, getFilenameFromContentDisposition, isEventIteratorHeaders, mergeStandardHeaders, replicateStandardLazyResponse, withEventMeta };
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.f16d90e",
4
+ "version": "0.0.0-next.f437dcb",
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.f16d90e"
31
+ "@orpc/shared": "0.0.0-next.f437dcb"
32
32
  },
33
33
  "scripts": {
34
34
  "build": "unbuild",