@orpc/standard-server 0.0.0-next.f356b86 → 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 +4 -2
- package/dist/batch/index.mjs +4 -4
- package/dist/index.d.mts +6 -6
- package/dist/index.d.ts +6 -6
- package/dist/index.mjs +5 -8
- package/package.json +2 -2
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
|
-
-
|
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
|
|
@@ -50,9 +50,11 @@ You can find the full documentation [here](https://orpc.unnoq.com).
|
|
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
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.
|
53
54
|
- [@orpc/nest](https://www.npmjs.com/package/@orpc/nest): Deeply integrate oRPC with [NestJS](https://nestjs.com/).
|
54
55
|
- [@orpc/react](https://www.npmjs.com/package/@orpc/react): Utilities for integrating oRPC with React and React Server Actions.
|
55
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.
|
56
58
|
- [@orpc/vue-colada](https://www.npmjs.com/package/@orpc/vue-colada): Integration with [Pinia Colada](https://pinia-colada.esm.dev/).
|
57
59
|
- [@orpc/hey-api](https://www.npmjs.com/package/@orpc/hey-api): [Hey API](https://heyapi.dev/) integration.
|
58
60
|
- [@orpc/zod](https://www.npmjs.com/package/@orpc/zod): More schemas that [Zod](https://zod.dev/) doesn't support yet.
|
package/dist/batch/index.mjs
CHANGED
@@ -91,7 +91,7 @@ function toBatchResponse(options) {
|
|
91
91
|
return {
|
92
92
|
headers: options.headers,
|
93
93
|
status: options.status,
|
94
|
-
body: async function* () {
|
94
|
+
body: (async function* () {
|
95
95
|
try {
|
96
96
|
for await (const item of options.body) {
|
97
97
|
yield {
|
@@ -104,13 +104,13 @@ function toBatchResponse(options) {
|
|
104
104
|
} finally {
|
105
105
|
await options.body.return?.();
|
106
106
|
}
|
107
|
-
}()
|
107
|
+
})()
|
108
108
|
};
|
109
109
|
}
|
110
110
|
function parseBatchResponse(response) {
|
111
111
|
const body = response.body;
|
112
112
|
if (isAsyncIteratorObject(body) || Array.isArray(body)) {
|
113
|
-
return async function* () {
|
113
|
+
return (async function* () {
|
114
114
|
try {
|
115
115
|
for await (const item of body) {
|
116
116
|
if (!isObject(item) || !("index" in item) || typeof item.index !== "number") {
|
@@ -130,7 +130,7 @@ function parseBatchResponse(response) {
|
|
130
130
|
await body.return?.();
|
131
131
|
}
|
132
132
|
}
|
133
|
-
}();
|
133
|
+
})();
|
134
134
|
}
|
135
135
|
throw new TypeError("Invalid batch response", {
|
136
136
|
cause: response
|
package/dist/index.d.mts
CHANGED
@@ -53,15 +53,15 @@ type EventMeta = Partial<Pick<EventMessage, 'retry' | 'id' | 'comments'>>;
|
|
53
53
|
declare function withEventMeta<T extends object>(container: T, meta: EventMeta): T;
|
54
54
|
declare function getEventMeta(container: unknown): EventMeta | undefined;
|
55
55
|
|
56
|
-
interface
|
56
|
+
interface HibernationEventIteratorCallback {
|
57
57
|
(id: string): void;
|
58
58
|
}
|
59
|
-
declare class
|
59
|
+
declare class HibernationEventIterator<T, TReturn = unknown, TNext = unknown> extends AsyncIteratorClass<T, TReturn, TNext> {
|
60
60
|
/**
|
61
61
|
* this property is not transferred to the client, so it should be optional for type safety
|
62
62
|
*/
|
63
|
-
readonly hibernationCallback?:
|
64
|
-
constructor(hibernationCallback:
|
63
|
+
readonly hibernationCallback?: HibernationEventIteratorCallback;
|
64
|
+
constructor(hibernationCallback: HibernationEventIteratorCallback);
|
65
65
|
}
|
66
66
|
|
67
67
|
declare function generateContentDisposition(filename: string): string;
|
@@ -71,5 +71,5 @@ declare function flattenHeader(header: string | readonly string[] | undefined):
|
|
71
71
|
declare function replicateStandardLazyResponse(response: StandardLazyResponse, count: number): StandardLazyResponse[];
|
72
72
|
declare function isEventIteratorHeaders(headers: StandardHeaders): boolean;
|
73
73
|
|
74
|
-
export { ErrorEvent, EventDecoder, EventDecoderError, EventDecoderStream, EventEncoderError, StandardHeaders, StandardLazyResponse, assertEventComment, assertEventId, assertEventName, assertEventRetry, decodeEventMessage, encodeEventComments, encodeEventData, encodeEventMessage,
|
75
|
-
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
@@ -53,15 +53,15 @@ type EventMeta = Partial<Pick<EventMessage, 'retry' | 'id' | 'comments'>>;
|
|
53
53
|
declare function withEventMeta<T extends object>(container: T, meta: EventMeta): T;
|
54
54
|
declare function getEventMeta(container: unknown): EventMeta | undefined;
|
55
55
|
|
56
|
-
interface
|
56
|
+
interface HibernationEventIteratorCallback {
|
57
57
|
(id: string): void;
|
58
58
|
}
|
59
|
-
declare class
|
59
|
+
declare class HibernationEventIterator<T, TReturn = unknown, TNext = unknown> extends AsyncIteratorClass<T, TReturn, TNext> {
|
60
60
|
/**
|
61
61
|
* this property is not transferred to the client, so it should be optional for type safety
|
62
62
|
*/
|
63
|
-
readonly hibernationCallback?:
|
64
|
-
constructor(hibernationCallback:
|
63
|
+
readonly hibernationCallback?: HibernationEventIteratorCallback;
|
64
|
+
constructor(hibernationCallback: HibernationEventIteratorCallback);
|
65
65
|
}
|
66
66
|
|
67
67
|
declare function generateContentDisposition(filename: string): string;
|
@@ -71,5 +71,5 @@ declare function flattenHeader(header: string | readonly string[] | undefined):
|
|
71
71
|
declare function replicateStandardLazyResponse(response: StandardLazyResponse, count: number): StandardLazyResponse[];
|
72
72
|
declare function isEventIteratorHeaders(headers: StandardHeaders): boolean;
|
73
73
|
|
74
|
-
export { ErrorEvent, EventDecoder, EventDecoderError, EventDecoderStream, EventEncoderError, StandardHeaders, StandardLazyResponse, assertEventComment, assertEventId, assertEventName, assertEventRetry, decodeEventMessage, encodeEventComments, encodeEventData, encodeEventMessage,
|
75
|
-
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, AsyncIteratorClass, 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,7 +182,7 @@ function getEventMeta(container) {
|
|
182
182
|
return isTypescriptObject(container) ? Reflect.get(container, EVENT_SOURCE_META_SYMBOL) : void 0;
|
183
183
|
}
|
184
184
|
|
185
|
-
class
|
185
|
+
class HibernationEventIterator extends AsyncIteratorClass {
|
186
186
|
/**
|
187
187
|
* this property is not transferred to the client, so it should be optional for type safety
|
188
188
|
*/
|
@@ -207,7 +207,7 @@ function generateContentDisposition(filename) {
|
|
207
207
|
function getFilenameFromContentDisposition(contentDisposition) {
|
208
208
|
const encodedFilenameStarMatch = contentDisposition.match(/filename\*=(UTF-8'')?([^;]*)/i);
|
209
209
|
if (encodedFilenameStarMatch && typeof encodedFilenameStarMatch[2] === "string") {
|
210
|
-
return
|
210
|
+
return tryDecodeURIComponent(encodedFilenameStarMatch[2]);
|
211
211
|
}
|
212
212
|
const encodedFilenameMatch = contentDisposition.match(/filename="((?:\\"|[^"])*)"/i);
|
213
213
|
if (encodedFilenameMatch && typeof encodedFilenameMatch[1] === "string") {
|
@@ -248,14 +248,11 @@ function replicateStandardLazyResponse(response, count) {
|
|
248
248
|
replicated.push({
|
249
249
|
...response,
|
250
250
|
body: once(async () => {
|
251
|
-
if (replicatedAsyncIteratorObjects) {
|
252
|
-
return replicatedAsyncIteratorObjects.shift();
|
253
|
-
}
|
254
251
|
const body = await (bodyPromise ??= response.body());
|
255
252
|
if (!isAsyncIteratorObject(body)) {
|
256
253
|
return body;
|
257
254
|
}
|
258
|
-
replicatedAsyncIteratorObjects
|
255
|
+
replicatedAsyncIteratorObjects ??= replicateAsyncIterator(body, count);
|
259
256
|
return replicatedAsyncIteratorObjects.shift();
|
260
257
|
})
|
261
258
|
});
|
@@ -266,4 +263,4 @@ function isEventIteratorHeaders(headers) {
|
|
266
263
|
return Boolean(flattenHeader(headers["content-type"])?.startsWith("text/event-stream") && flattenHeader(headers["content-disposition"]) === void 0);
|
267
264
|
}
|
268
265
|
|
269
|
-
export { ErrorEvent, EventDecoder, EventDecoderError, EventDecoderStream, EventEncoderError, assertEventComment, assertEventId, assertEventName, assertEventRetry, decodeEventMessage, encodeEventComments, encodeEventData, encodeEventMessage,
|
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.
|
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.
|
31
|
+
"@orpc/shared": "0.0.0-next.f437dcb"
|
32
32
|
},
|
33
33
|
"scripts": {
|
34
34
|
"build": "unbuild",
|