@orpc/standard-server 0.0.0-next.cd121e3 → 0.0.0-next.ce2f84d
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 +14 -1
- package/dist/index.d.mts +24 -10
- package/dist/index.d.ts +24 -10
- package/dist/index.mjs +40 -8
- package/package.json +2 -3
package/README.md
CHANGED
|
@@ -32,7 +32,7 @@
|
|
|
32
32
|
- **Contract-First Development 📜**: (Optional) Define your API contract upfront and implement it with confidence.
|
|
33
33
|
- **Exceptional Developer Experience ✨**: Enjoy a streamlined workflow with robust typing and clear, in-code documentation.
|
|
34
34
|
- **Multi-Runtime Support 🌍**: Run your code seamlessly on Cloudflare, Deno, Bun, Node.js, and more.
|
|
35
|
-
- **Framework Integrations 🧩**: Supports Tanstack Query (React, Vue), Pinia Colada, and more.
|
|
35
|
+
- **Framework Integrations 🧩**: Supports Tanstack Query (React, Vue, Solid, Svelte), Pinia Colada, and more.
|
|
36
36
|
- **Server Actions ⚡️**: Fully compatible with React Server Actions on Next.js, TanStack Start, and more.
|
|
37
37
|
- **Standard Schema Support 🗂️**: Effortlessly work with Zod, Valibot, ArkType, and others right out of the box.
|
|
38
38
|
- **Fast & Lightweight 💨**: Built on native APIs across all runtimes – optimized for speed and efficiency.
|
|
@@ -53,16 +53,29 @@ You can find the full documentation [here](https://orpc.unnoq.com).
|
|
|
53
53
|
- [@orpc/contract](https://www.npmjs.com/package/@orpc/contract): Build your API contract.
|
|
54
54
|
- [@orpc/server](https://www.npmjs.com/package/@orpc/server): Build your API or implement API contract.
|
|
55
55
|
- [@orpc/client](https://www.npmjs.com/package/@orpc/client): Consume your API on the client with type-safety.
|
|
56
|
+
- [@orpc/react](https://www.npmjs.com/package/@orpc/react): Utilities for integrating oRPC with React and React Server Actions.
|
|
56
57
|
- [@orpc/react-query](https://www.npmjs.com/package/@orpc/react-query): Integration with [React Query](https://tanstack.com/query/latest/docs/framework/react/overview).
|
|
57
58
|
- [@orpc/vue-query](https://www.npmjs.com/package/@orpc/vue-query): Integration with [Vue Query](https://tanstack.com/query/latest/docs/framework/vue/overview).
|
|
59
|
+
- [@orpc/solid-query](https://www.npmjs.com/package/@orpc/solid-query): Integration with [Solid Query](https://tanstack.com/query/latest/docs/framework/solid/overview).
|
|
60
|
+
- [@orpc/svelte-query](https://www.npmjs.com/package/@orpc/svelte-query): Integration with [Svelte Query](https://tanstack.com/query/latest/docs/framework/svelte/overview).
|
|
58
61
|
- [@orpc/vue-colada](https://www.npmjs.com/package/@orpc/vue-colada): Integration with [Pinia Colada](https://pinia-colada.esm.dev/).
|
|
59
62
|
- [@orpc/openapi](https://www.npmjs.com/package/@orpc/openapi): Generate OpenAPI specs and handle OpenAPI requests.
|
|
60
63
|
- [@orpc/zod](https://www.npmjs.com/package/@orpc/zod): More schemas that [Zod](https://zod.dev/) doesn't support yet.
|
|
64
|
+
- [@orpc/valibot](https://www.npmjs.com/package/@orpc/valibot): OpenAPI spec generation from [Valibot](https://valibot.dev/).
|
|
65
|
+
- [@orpc/arktype](https://www.npmjs.com/package/@orpc/arktype): OpenAPI spec generation from [ArkType](https://arktype.io/).
|
|
61
66
|
|
|
62
67
|
## `@orpc/standard-server`
|
|
63
68
|
|
|
64
69
|
This package is designed to be used as a base for other server implementations.
|
|
65
70
|
|
|
71
|
+
## Sponsors
|
|
72
|
+
|
|
73
|
+
<p align="center">
|
|
74
|
+
<a href="https://cdn.jsdelivr.net/gh/unnoq/unnoq/sponsors.svg">
|
|
75
|
+
<img src='https://cdn.jsdelivr.net/gh/unnoq/unnoq/sponsors.svg'/>
|
|
76
|
+
</a>
|
|
77
|
+
</p>
|
|
78
|
+
|
|
66
79
|
## License
|
|
67
80
|
|
|
68
81
|
Distributed under the MIT License. See [LICENSE](https://github.com/unnoq/orpc/blob/main/LICENSE) for more information.
|
package/dist/index.d.mts
CHANGED
|
@@ -1,11 +1,9 @@
|
|
|
1
|
-
export { contentDisposition, parse as parseContentDisposition } from '@tinyhttp/content-disposition';
|
|
2
|
-
|
|
3
1
|
interface EventMessage {
|
|
4
2
|
event: string | undefined;
|
|
5
3
|
id: string | undefined;
|
|
6
4
|
data: string | undefined;
|
|
7
5
|
/**
|
|
8
|
-
* The number of milliseconds to wait before retrying the event
|
|
6
|
+
* The number of milliseconds to wait before retrying the event iterator if error occurs.
|
|
9
7
|
*/
|
|
10
8
|
retry: number | undefined;
|
|
11
9
|
comments: string[];
|
|
@@ -56,24 +54,40 @@ interface StandardHeaders {
|
|
|
56
54
|
}
|
|
57
55
|
type StandardBody = undefined | unknown | Blob | URLSearchParams | FormData | AsyncIterator<unknown | void, unknown | void, undefined>;
|
|
58
56
|
interface StandardRequest {
|
|
59
|
-
/**
|
|
60
|
-
* Can be { request: Request } or { request: IncomingMessage, response: ServerResponse } based on the adapter.
|
|
61
|
-
*/
|
|
62
|
-
raw: Record<string, unknown>;
|
|
63
57
|
method: string;
|
|
64
58
|
url: URL;
|
|
65
59
|
headers: StandardHeaders;
|
|
66
60
|
/**
|
|
67
|
-
* The body has been parsed
|
|
61
|
+
* The body has been parsed based on the content-type header.
|
|
62
|
+
*/
|
|
63
|
+
body: StandardBody;
|
|
64
|
+
signal: AbortSignal | undefined;
|
|
65
|
+
}
|
|
66
|
+
interface StandardLazyRequest extends Omit<StandardRequest, 'body'> {
|
|
67
|
+
/**
|
|
68
|
+
* The body has been parsed based on the content-type header.
|
|
68
69
|
* This method can safely call multiple times (cached).
|
|
69
70
|
*/
|
|
70
71
|
body: () => Promise<StandardBody>;
|
|
71
|
-
signal: AbortSignal | undefined;
|
|
72
72
|
}
|
|
73
73
|
interface StandardResponse {
|
|
74
74
|
status: number;
|
|
75
75
|
headers: StandardHeaders;
|
|
76
|
+
/**
|
|
77
|
+
* The body has been parsed based on the content-type header.
|
|
78
|
+
*/
|
|
76
79
|
body: StandardBody;
|
|
77
80
|
}
|
|
81
|
+
interface StandardLazyResponse extends Omit<StandardResponse, 'body'> {
|
|
82
|
+
/**
|
|
83
|
+
* The body has been parsed based on the content-type header.
|
|
84
|
+
* This method can safely call multiple times (cached).
|
|
85
|
+
*/
|
|
86
|
+
body: () => Promise<StandardBody>;
|
|
87
|
+
}
|
|
88
|
+
|
|
89
|
+
declare function generateContentDisposition(filename: string): string;
|
|
90
|
+
declare function getFilenameFromContentDisposition(contentDisposition: string): string | undefined;
|
|
91
|
+
declare function mergeStandardHeaders(a: StandardHeaders, b: StandardHeaders): StandardHeaders;
|
|
78
92
|
|
|
79
|
-
export { ErrorEvent, type ErrorEventOptions, EventDecoder, EventDecoderError, type EventDecoderOptions, EventDecoderStream, EventEncoderError, type EventMessage, type EventMeta, type StandardBody, type StandardHeaders, type StandardRequest, type StandardResponse, assertEventComment, assertEventId, assertEventName, assertEventRetry, decodeEventMessage, encodeEventComments, encodeEventData, encodeEventMessage, getEventMeta, withEventMeta };
|
|
93
|
+
export { ErrorEvent, type ErrorEventOptions, EventDecoder, EventDecoderError, type EventDecoderOptions, EventDecoderStream, EventEncoderError, type EventMessage, type EventMeta, type StandardBody, type StandardHeaders, type StandardLazyRequest, type StandardLazyResponse, type StandardRequest, type StandardResponse, assertEventComment, assertEventId, assertEventName, assertEventRetry, decodeEventMessage, encodeEventComments, encodeEventData, encodeEventMessage, generateContentDisposition, getEventMeta, getFilenameFromContentDisposition, mergeStandardHeaders, withEventMeta };
|
package/dist/index.d.ts
CHANGED
|
@@ -1,11 +1,9 @@
|
|
|
1
|
-
export { contentDisposition, parse as parseContentDisposition } from '@tinyhttp/content-disposition';
|
|
2
|
-
|
|
3
1
|
interface EventMessage {
|
|
4
2
|
event: string | undefined;
|
|
5
3
|
id: string | undefined;
|
|
6
4
|
data: string | undefined;
|
|
7
5
|
/**
|
|
8
|
-
* The number of milliseconds to wait before retrying the event
|
|
6
|
+
* The number of milliseconds to wait before retrying the event iterator if error occurs.
|
|
9
7
|
*/
|
|
10
8
|
retry: number | undefined;
|
|
11
9
|
comments: string[];
|
|
@@ -56,24 +54,40 @@ interface StandardHeaders {
|
|
|
56
54
|
}
|
|
57
55
|
type StandardBody = undefined | unknown | Blob | URLSearchParams | FormData | AsyncIterator<unknown | void, unknown | void, undefined>;
|
|
58
56
|
interface StandardRequest {
|
|
59
|
-
/**
|
|
60
|
-
* Can be { request: Request } or { request: IncomingMessage, response: ServerResponse } based on the adapter.
|
|
61
|
-
*/
|
|
62
|
-
raw: Record<string, unknown>;
|
|
63
57
|
method: string;
|
|
64
58
|
url: URL;
|
|
65
59
|
headers: StandardHeaders;
|
|
66
60
|
/**
|
|
67
|
-
* The body has been parsed
|
|
61
|
+
* The body has been parsed based on the content-type header.
|
|
62
|
+
*/
|
|
63
|
+
body: StandardBody;
|
|
64
|
+
signal: AbortSignal | undefined;
|
|
65
|
+
}
|
|
66
|
+
interface StandardLazyRequest extends Omit<StandardRequest, 'body'> {
|
|
67
|
+
/**
|
|
68
|
+
* The body has been parsed based on the content-type header.
|
|
68
69
|
* This method can safely call multiple times (cached).
|
|
69
70
|
*/
|
|
70
71
|
body: () => Promise<StandardBody>;
|
|
71
|
-
signal: AbortSignal | undefined;
|
|
72
72
|
}
|
|
73
73
|
interface StandardResponse {
|
|
74
74
|
status: number;
|
|
75
75
|
headers: StandardHeaders;
|
|
76
|
+
/**
|
|
77
|
+
* The body has been parsed based on the content-type header.
|
|
78
|
+
*/
|
|
76
79
|
body: StandardBody;
|
|
77
80
|
}
|
|
81
|
+
interface StandardLazyResponse extends Omit<StandardResponse, 'body'> {
|
|
82
|
+
/**
|
|
83
|
+
* The body has been parsed based on the content-type header.
|
|
84
|
+
* This method can safely call multiple times (cached).
|
|
85
|
+
*/
|
|
86
|
+
body: () => Promise<StandardBody>;
|
|
87
|
+
}
|
|
88
|
+
|
|
89
|
+
declare function generateContentDisposition(filename: string): string;
|
|
90
|
+
declare function getFilenameFromContentDisposition(contentDisposition: string): string | undefined;
|
|
91
|
+
declare function mergeStandardHeaders(a: StandardHeaders, b: StandardHeaders): StandardHeaders;
|
|
78
92
|
|
|
79
|
-
export { ErrorEvent, type ErrorEventOptions, EventDecoder, EventDecoderError, type EventDecoderOptions, EventDecoderStream, EventEncoderError, type EventMessage, type EventMeta, type StandardBody, type StandardHeaders, type StandardRequest, type StandardResponse, assertEventComment, assertEventId, assertEventName, assertEventRetry, decodeEventMessage, encodeEventComments, encodeEventData, encodeEventMessage, getEventMeta, withEventMeta };
|
|
93
|
+
export { ErrorEvent, type ErrorEventOptions, EventDecoder, EventDecoderError, type EventDecoderOptions, EventDecoderStream, EventEncoderError, type EventMessage, type EventMeta, type StandardBody, type StandardHeaders, type StandardLazyRequest, type StandardLazyResponse, type StandardRequest, type StandardResponse, assertEventComment, assertEventId, assertEventName, assertEventRetry, decodeEventMessage, encodeEventComments, encodeEventData, encodeEventMessage, generateContentDisposition, getEventMeta, getFilenameFromContentDisposition, mergeStandardHeaders, withEventMeta };
|
package/dist/index.mjs
CHANGED
|
@@ -1,5 +1,4 @@
|
|
|
1
|
-
import { isTypescriptObject } from '@orpc/shared';
|
|
2
|
-
export { contentDisposition, parse as parseContentDisposition } from '@tinyhttp/content-disposition';
|
|
1
|
+
import { isTypescriptObject, toArray } from '@orpc/shared';
|
|
3
2
|
|
|
4
3
|
class EventEncoderError extends TypeError {
|
|
5
4
|
}
|
|
@@ -71,7 +70,7 @@ class EventDecoder {
|
|
|
71
70
|
}
|
|
72
71
|
end() {
|
|
73
72
|
if (this.incomplete) {
|
|
74
|
-
throw new EventDecoderError("
|
|
73
|
+
throw new EventDecoderError("Event Iterator ended before complete");
|
|
75
74
|
}
|
|
76
75
|
}
|
|
77
76
|
}
|
|
@@ -98,22 +97,22 @@ class EventDecoderStream extends TransformStream {
|
|
|
98
97
|
|
|
99
98
|
function assertEventId(id) {
|
|
100
99
|
if (id.includes("\n")) {
|
|
101
|
-
throw new EventEncoderError("Event
|
|
100
|
+
throw new EventEncoderError("Event's id must not contain a newline character");
|
|
102
101
|
}
|
|
103
102
|
}
|
|
104
103
|
function assertEventName(event) {
|
|
105
104
|
if (event.includes("\n")) {
|
|
106
|
-
throw new EventEncoderError("Event
|
|
105
|
+
throw new EventEncoderError("Event's event must not contain a newline character");
|
|
107
106
|
}
|
|
108
107
|
}
|
|
109
108
|
function assertEventRetry(retry) {
|
|
110
109
|
if (!Number.isInteger(retry) || retry < 0) {
|
|
111
|
-
throw new EventEncoderError("Event
|
|
110
|
+
throw new EventEncoderError("Event's retry must be a integer and >= 0");
|
|
112
111
|
}
|
|
113
112
|
}
|
|
114
113
|
function assertEventComment(comment) {
|
|
115
114
|
if (comment.includes("\n")) {
|
|
116
|
-
throw new EventEncoderError("Event
|
|
115
|
+
throw new EventEncoderError("Event's comment must not contain a newline character");
|
|
117
116
|
}
|
|
118
117
|
}
|
|
119
118
|
function encodeEventData(data) {
|
|
@@ -183,4 +182,37 @@ function getEventMeta(container) {
|
|
|
183
182
|
return isTypescriptObject(container) ? Reflect.get(container, EVENT_SOURCE_META_SYMBOL) : void 0;
|
|
184
183
|
}
|
|
185
184
|
|
|
186
|
-
|
|
185
|
+
function generateContentDisposition(filename) {
|
|
186
|
+
const escapedFileName = filename.replace(/"/g, '\\"');
|
|
187
|
+
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)));
|
|
188
|
+
return `inline; filename="${escapedFileName}"; filename*=utf-8''${encodedFilenameStar}`;
|
|
189
|
+
}
|
|
190
|
+
function getFilenameFromContentDisposition(contentDisposition) {
|
|
191
|
+
const encodedFilenameStarMatch = contentDisposition.match(/filename\*=(UTF-8'')?([^;]*)/i);
|
|
192
|
+
if (encodedFilenameStarMatch && typeof encodedFilenameStarMatch[2] === "string") {
|
|
193
|
+
return decodeURIComponent(encodedFilenameStarMatch[2]);
|
|
194
|
+
}
|
|
195
|
+
const encodedFilenameMatch = contentDisposition.match(/filename="((?:\\"|[^"])*)"/i);
|
|
196
|
+
if (encodedFilenameMatch && typeof encodedFilenameMatch[1] === "string") {
|
|
197
|
+
return encodedFilenameMatch[1].replace(/\\"/g, '"');
|
|
198
|
+
}
|
|
199
|
+
}
|
|
200
|
+
function mergeStandardHeaders(a, b) {
|
|
201
|
+
const merged = { ...a };
|
|
202
|
+
for (const key in b) {
|
|
203
|
+
if (Array.isArray(b[key])) {
|
|
204
|
+
merged[key] = [...toArray(merged[key]), ...b[key]];
|
|
205
|
+
} else if (b[key] !== void 0) {
|
|
206
|
+
if (Array.isArray(merged[key])) {
|
|
207
|
+
merged[key] = [...merged[key], b[key]];
|
|
208
|
+
} else if (merged[key] !== void 0) {
|
|
209
|
+
merged[key] = [merged[key], b[key]];
|
|
210
|
+
} else {
|
|
211
|
+
merged[key] = b[key];
|
|
212
|
+
}
|
|
213
|
+
}
|
|
214
|
+
}
|
|
215
|
+
return merged;
|
|
216
|
+
}
|
|
217
|
+
|
|
218
|
+
export { ErrorEvent, EventDecoder, EventDecoderError, EventDecoderStream, EventEncoderError, assertEventComment, assertEventId, assertEventName, assertEventRetry, decodeEventMessage, encodeEventComments, encodeEventData, encodeEventMessage, generateContentDisposition, getEventMeta, getFilenameFromContentDisposition, mergeStandardHeaders, 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.ce2f84d",
|
|
5
5
|
"license": "MIT",
|
|
6
6
|
"homepage": "https://unnoq.com",
|
|
7
7
|
"repository": {
|
|
@@ -23,8 +23,7 @@
|
|
|
23
23
|
"dist"
|
|
24
24
|
],
|
|
25
25
|
"dependencies": {
|
|
26
|
-
"@
|
|
27
|
-
"@orpc/shared": "0.0.0-next.cd121e3"
|
|
26
|
+
"@orpc/shared": "0.0.0-next.ce2f84d"
|
|
28
27
|
},
|
|
29
28
|
"scripts": {
|
|
30
29
|
"build": "unbuild",
|