@orpc/standard-server-fetch 0.0.0-next.d0e429d → 0.0.0-next.d17ef5e

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
@@ -1,5 +1,5 @@
1
1
  <div align="center">
2
- <image align="center" src="https://orpc.unnoq.com/logo.webp" width=280 />
2
+ <image align="center" src="https://orpc.unnoq.com/logo.webp" width=280 alt="oRPC logo" />
3
3
  </div>
4
4
 
5
5
  <h1></h1>
@@ -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.
@@ -55,14 +55,26 @@ You can find the full documentation [here](https://orpc.unnoq.com).
55
55
  - [@orpc/client](https://www.npmjs.com/package/@orpc/client): Consume your API on the client with type-safety.
56
56
  - [@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
57
  - [@orpc/vue-query](https://www.npmjs.com/package/@orpc/vue-query): Integration with [Vue Query](https://tanstack.com/query/latest/docs/framework/vue/overview).
58
+ - [@orpc/solid-query](https://www.npmjs.com/package/@orpc/solid-query): Integration with [Solid Query](https://tanstack.com/query/latest/docs/framework/solid/overview).
59
+ - [@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
60
  - [@orpc/vue-colada](https://www.npmjs.com/package/@orpc/vue-colada): Integration with [Pinia Colada](https://pinia-colada.esm.dev/).
59
61
  - [@orpc/openapi](https://www.npmjs.com/package/@orpc/openapi): Generate OpenAPI specs and handle OpenAPI requests.
60
62
  - [@orpc/zod](https://www.npmjs.com/package/@orpc/zod): More schemas that [Zod](https://zod.dev/) doesn't support yet.
63
+ - [@orpc/valibot](https://www.npmjs.com/package/@orpc/valibot): OpenAPI spec generation from [Valibot](https://valibot.dev/).
64
+ - [@orpc/arktype](https://www.npmjs.com/package/@orpc/arktype): OpenAPI spec generation from [ArkType](https://arktype.io/).
61
65
 
62
66
  ## `@orpc/standard-server-fetch`
63
67
 
64
68
  [Fetch API](https://developer.mozilla.org/en-US/docs/Web/API/Fetch_API) server adapter for oRPC.
65
69
 
70
+ ## Sponsors
71
+
72
+ <p align="center">
73
+ <a href="https://cdn.jsdelivr.net/gh/unnoq/unnoq/sponsors.svg">
74
+ <img src='https://cdn.jsdelivr.net/gh/unnoq/unnoq/sponsors.svg'/>
75
+ </a>
76
+ </p>
77
+
66
78
  ## License
67
79
 
68
80
  Distributed under the MIT License. See [LICENSE](https://github.com/unnoq/orpc/blob/main/LICENSE) for more information.
@@ -0,0 +1,56 @@
1
+ import { StandardBody, StandardHeaders, StandardLazyRequest, StandardRequest, StandardResponse, StandardLazyResponse } from '@orpc/standard-server';
2
+
3
+ declare function toEventIterator(stream: ReadableStream<Uint8Array>): AsyncGenerator<unknown | void, unknown | void, void>;
4
+ interface ToEventStreamOptions {
5
+ /**
6
+ * If true, a ping comment is sent periodically to keep the connection alive.
7
+ *
8
+ * @default true
9
+ */
10
+ eventIteratorKeepAliveEnabled?: boolean;
11
+ /**
12
+ * Interval (in milliseconds) between ping comments sent after the last event.
13
+ *
14
+ * @default 5000
15
+ */
16
+ eventIteratorKeepAliveInterval?: number;
17
+ /**
18
+ * The content of the ping comment. Must not include newline characters.
19
+ *
20
+ * @default ''
21
+ */
22
+ eventIteratorKeepAliveComment?: string;
23
+ }
24
+ declare function toEventStream(iterator: AsyncIterator<unknown | void, unknown | void, void>, options?: ToEventStreamOptions): ReadableStream<Uint8Array>;
25
+
26
+ declare function toStandardBody(re: Request | Response): Promise<StandardBody>;
27
+ interface ToFetchBodyOptions extends ToEventStreamOptions {
28
+ }
29
+ /**
30
+ * @param body
31
+ * @param headers - The headers can be changed by the function and effects on the original headers.
32
+ */
33
+ declare function toFetchBody(body: StandardBody, headers: Headers, options?: ToFetchBodyOptions): string | Blob | FormData | URLSearchParams | undefined | ReadableStream<Uint8Array>;
34
+
35
+ /**
36
+ * @param headers
37
+ * @param standardHeaders - The base headers can be changed by the function and effects on the original headers.
38
+ */
39
+ declare function toStandardHeaders(headers: Headers, standardHeaders?: StandardHeaders): StandardHeaders;
40
+ /**
41
+ * @param headers
42
+ * @param fetchHeaders - The base headers can be changed by the function and effects on the original headers.
43
+ */
44
+ declare function toFetchHeaders(headers: StandardHeaders, fetchHeaders?: Headers): Headers;
45
+
46
+ declare function toStandardLazyRequest(request: Request): StandardLazyRequest;
47
+ interface ToFetchRequestOptions extends ToFetchBodyOptions {
48
+ }
49
+ declare function toFetchRequest(request: StandardRequest, options?: ToFetchRequestOptions): Request;
50
+
51
+ interface ToFetchResponseOptions extends ToFetchBodyOptions {
52
+ }
53
+ declare function toFetchResponse(response: StandardResponse, options?: ToFetchResponseOptions): Response;
54
+ declare function toStandardLazyResponse(response: Response): StandardLazyResponse;
55
+
56
+ export { type ToEventStreamOptions, type ToFetchBodyOptions, type ToFetchRequestOptions, type ToFetchResponseOptions, toEventIterator, toEventStream, toFetchBody, toFetchHeaders, toFetchRequest, toFetchResponse, toStandardBody, toStandardHeaders, toStandardLazyRequest, toStandardLazyResponse };
@@ -0,0 +1,56 @@
1
+ import { StandardBody, StandardHeaders, StandardLazyRequest, StandardRequest, StandardResponse, StandardLazyResponse } from '@orpc/standard-server';
2
+
3
+ declare function toEventIterator(stream: ReadableStream<Uint8Array>): AsyncGenerator<unknown | void, unknown | void, void>;
4
+ interface ToEventStreamOptions {
5
+ /**
6
+ * If true, a ping comment is sent periodically to keep the connection alive.
7
+ *
8
+ * @default true
9
+ */
10
+ eventIteratorKeepAliveEnabled?: boolean;
11
+ /**
12
+ * Interval (in milliseconds) between ping comments sent after the last event.
13
+ *
14
+ * @default 5000
15
+ */
16
+ eventIteratorKeepAliveInterval?: number;
17
+ /**
18
+ * The content of the ping comment. Must not include newline characters.
19
+ *
20
+ * @default ''
21
+ */
22
+ eventIteratorKeepAliveComment?: string;
23
+ }
24
+ declare function toEventStream(iterator: AsyncIterator<unknown | void, unknown | void, void>, options?: ToEventStreamOptions): ReadableStream<Uint8Array>;
25
+
26
+ declare function toStandardBody(re: Request | Response): Promise<StandardBody>;
27
+ interface ToFetchBodyOptions extends ToEventStreamOptions {
28
+ }
29
+ /**
30
+ * @param body
31
+ * @param headers - The headers can be changed by the function and effects on the original headers.
32
+ */
33
+ declare function toFetchBody(body: StandardBody, headers: Headers, options?: ToFetchBodyOptions): string | Blob | FormData | URLSearchParams | undefined | ReadableStream<Uint8Array>;
34
+
35
+ /**
36
+ * @param headers
37
+ * @param standardHeaders - The base headers can be changed by the function and effects on the original headers.
38
+ */
39
+ declare function toStandardHeaders(headers: Headers, standardHeaders?: StandardHeaders): StandardHeaders;
40
+ /**
41
+ * @param headers
42
+ * @param fetchHeaders - The base headers can be changed by the function and effects on the original headers.
43
+ */
44
+ declare function toFetchHeaders(headers: StandardHeaders, fetchHeaders?: Headers): Headers;
45
+
46
+ declare function toStandardLazyRequest(request: Request): StandardLazyRequest;
47
+ interface ToFetchRequestOptions extends ToFetchBodyOptions {
48
+ }
49
+ declare function toFetchRequest(request: StandardRequest, options?: ToFetchRequestOptions): Request;
50
+
51
+ interface ToFetchResponseOptions extends ToFetchBodyOptions {
52
+ }
53
+ declare function toFetchResponse(response: StandardResponse, options?: ToFetchResponseOptions): Response;
54
+ declare function toStandardLazyResponse(response: Response): StandardLazyResponse;
55
+
56
+ export { type ToEventStreamOptions, type ToFetchBodyOptions, type ToFetchRequestOptions, type ToFetchResponseOptions, toEventIterator, toEventStream, toFetchBody, toFetchHeaders, toFetchRequest, toFetchResponse, toStandardBody, toStandardHeaders, toStandardLazyRequest, toStandardLazyResponse };
@@ -1,16 +1,6 @@
1
- // src/body.ts
2
- import { isAsyncIteratorObject, parseEmptyableJSON as parseEmptyableJSON2, stringifyJSON as stringifyJSON2 } from "@orpc/shared";
3
- import { contentDisposition, parseContentDisposition } from "@orpc/standard-server";
1
+ import { stringifyJSON, parseEmptyableJSON, isTypescriptObject, isAsyncIteratorObject, once } from '@orpc/shared';
2
+ import { EventDecoderStream, encodeEventMessage, getEventMeta, ErrorEvent, withEventMeta, parseContentDisposition, contentDisposition } from '@orpc/standard-server';
4
3
 
5
- // src/event-source.ts
6
- import { isTypescriptObject, parseEmptyableJSON, stringifyJSON } from "@orpc/shared";
7
- import {
8
- encodeEventMessage,
9
- ErrorEvent,
10
- EventDecoderStream,
11
- getEventMeta,
12
- withEventMeta
13
- } from "@orpc/standard-server";
14
4
  function toEventIterator(stream) {
15
5
  const eventStream = stream.pipeThrough(new TextDecoderStream()).pipeThrough(new EventDecoderStream());
16
6
  const reader = eventStream.getReader();
@@ -53,19 +43,19 @@ function toEventIterator(stream) {
53
43
  return gen();
54
44
  }
55
45
  function toEventStream(iterator, options = {}) {
56
- const pingEnabled = options.eventSourcePingEnabled ?? true;
57
- const pingInterval = options.eventSourcePingInterval ?? 5e3;
58
- const pingContent = options.eventSourcePingContent ?? "";
46
+ const keepAliveEnabled = options.eventIteratorKeepAliveEnabled ?? true;
47
+ const keepAliveInterval = options.eventIteratorKeepAliveInterval ?? 5e3;
48
+ const keepAliveComment = options.eventIteratorKeepAliveComment ?? "";
59
49
  let timeout;
60
50
  const stream = new ReadableStream({
61
51
  async pull(controller) {
62
52
  try {
63
- if (pingEnabled) {
53
+ if (keepAliveEnabled) {
64
54
  timeout = setInterval(() => {
65
55
  controller.enqueue(encodeEventMessage({
66
- comments: [pingContent]
56
+ comments: [keepAliveComment]
67
57
  }));
68
- }, pingInterval);
58
+ }, keepAliveInterval);
69
59
  }
70
60
  const value = await iterator.next();
71
61
  clearInterval(timeout);
@@ -98,7 +88,6 @@ function toEventStream(iterator, options = {}) {
98
88
  return stream;
99
89
  }
100
90
 
101
- // src/body.ts
102
91
  async function toStandardBody(re) {
103
92
  if (!re.body) {
104
93
  return void 0;
@@ -116,7 +105,7 @@ async function toStandardBody(re) {
116
105
  const contentType = re.headers.get("content-type");
117
106
  if (!contentType || contentType.startsWith("application/json")) {
118
107
  const text = await re.text();
119
- return parseEmptyableJSON2(text);
108
+ return parseEmptyableJSON(text);
120
109
  }
121
110
  if (contentType.startsWith("multipart/form-data")) {
122
111
  return await re.formData();
@@ -164,10 +153,9 @@ function toFetchBody(body, headers, options = {}) {
164
153
  return toEventStream(body, options);
165
154
  }
166
155
  headers.set("content-type", "application/json");
167
- return stringifyJSON2(body);
156
+ return stringifyJSON(body);
168
157
  }
169
158
 
170
- // src/headers.ts
171
159
  function toStandardHeaders(headers, standardHeaders = {}) {
172
160
  for (const [key, value] of headers) {
173
161
  if (Array.isArray(standardHeaders[key])) {
@@ -193,17 +181,16 @@ function toFetchHeaders(headers, fetchHeaders = new Headers()) {
193
181
  return fetchHeaders;
194
182
  }
195
183
 
196
- // src/request.ts
197
- import { once } from "@orpc/shared";
198
- function toStandardRequest(request) {
184
+ function toStandardLazyRequest(request) {
185
+ const raw = { adapter: "fetch", request };
199
186
  return {
200
- raw: { request },
187
+ raw,
201
188
  url: new URL(request.url),
202
189
  signal: request.signal,
203
190
  method: request.method,
204
- body: once(() => toStandardBody(request)),
191
+ body: once(() => toStandardBody(raw.request)),
205
192
  get headers() {
206
- const headers = toStandardHeaders(request.headers);
193
+ const headers = toStandardHeaders(raw.request.headers);
207
194
  Object.defineProperty(this, "headers", { value: headers, writable: true });
208
195
  return headers;
209
196
  },
@@ -212,21 +199,37 @@ function toStandardRequest(request) {
212
199
  }
213
200
  };
214
201
  }
202
+ function toFetchRequest(request, options = {}) {
203
+ const headers = toFetchHeaders(request.headers);
204
+ const body = toFetchBody(request.body, headers, options);
205
+ return new Request(request.url, {
206
+ signal: request.signal,
207
+ method: request.method,
208
+ headers,
209
+ body
210
+ });
211
+ }
215
212
 
216
- // src/response.ts
217
213
  function toFetchResponse(response, options = {}) {
218
214
  const headers = toFetchHeaders(response.headers);
219
215
  const body = toFetchBody(response.body, headers, options);
220
216
  return new Response(body, { headers, status: response.status });
221
217
  }
222
- export {
223
- toEventIterator,
224
- toEventStream,
225
- toFetchBody,
226
- toFetchHeaders,
227
- toFetchResponse,
228
- toStandardBody,
229
- toStandardHeaders,
230
- toStandardRequest
231
- };
232
- //# sourceMappingURL=index.js.map
218
+ function toStandardLazyResponse(response) {
219
+ const raw = { adapter: "fetch", response };
220
+ return {
221
+ raw,
222
+ body: once(() => toStandardBody(raw.response)),
223
+ status: response.status,
224
+ get headers() {
225
+ const headers = toStandardHeaders(raw.response.headers);
226
+ Object.defineProperty(this, "headers", { value: headers, writable: true });
227
+ return headers;
228
+ },
229
+ set headers(value) {
230
+ Object.defineProperty(this, "headers", { value, writable: true });
231
+ }
232
+ };
233
+ }
234
+
235
+ export { toEventIterator, toEventStream, toFetchBody, toFetchHeaders, toFetchRequest, toFetchResponse, toStandardBody, toStandardHeaders, toStandardLazyRequest, toStandardLazyResponse };
package/package.json CHANGED
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "name": "@orpc/standard-server-fetch",
3
3
  "type": "module",
4
- "version": "0.0.0-next.d0e429d",
4
+ "version": "0.0.0-next.d17ef5e",
5
5
  "license": "MIT",
6
6
  "homepage": "https://unnoq.com",
7
7
  "repository": {
@@ -14,28 +14,23 @@
14
14
  ],
15
15
  "exports": {
16
16
  ".": {
17
- "types": "./dist/src/index.d.ts",
18
- "import": "./dist/index.js",
19
- "default": "./dist/index.js"
20
- },
21
- "./🔒/*": {
22
- "types": "./dist/src/*.d.ts"
17
+ "types": "./dist/index.d.mts",
18
+ "import": "./dist/index.mjs",
19
+ "default": "./dist/index.mjs"
23
20
  }
24
21
  },
25
22
  "files": [
26
- "!**/*.map",
27
- "!**/*.tsbuildinfo",
28
23
  "dist"
29
24
  ],
30
25
  "dependencies": {
31
- "@orpc/shared": "0.0.0-next.d0e429d",
32
- "@orpc/standard-server": "0.0.0-next.d0e429d"
26
+ "@orpc/shared": "0.0.0-next.d17ef5e",
27
+ "@orpc/standard-server": "0.0.0-next.d17ef5e"
33
28
  },
34
29
  "devDependencies": {
35
30
  "@hono/node-server": "^1.13.8"
36
31
  },
37
32
  "scripts": {
38
- "build": "tsup --clean --sourcemap --entry.index=src/index.ts --format=esm --onSuccess='tsc -b --noCheck'",
33
+ "build": "unbuild",
39
34
  "build:watch": "pnpm run build --watch",
40
35
  "type:check": "tsc -b"
41
36
  }
@@ -1,11 +0,0 @@
1
- import type { StandardBody } from '@orpc/standard-server';
2
- import type { ToEventStreamOptions } from './event-source';
3
- export declare function toStandardBody(re: Request | Response): Promise<StandardBody>;
4
- export interface ToFetchBodyOptions extends ToEventStreamOptions {
5
- }
6
- /**
7
- * @param body
8
- * @param headers - The headers can be changed by the function and effects on the original headers.
9
- */
10
- export declare function toFetchBody(body: StandardBody, headers: Headers, options?: ToFetchBodyOptions): string | Blob | FormData | URLSearchParams | undefined | ReadableStream<Uint8Array>;
11
- //# sourceMappingURL=body.d.ts.map
@@ -1,23 +0,0 @@
1
- export declare function toEventIterator(stream: ReadableStream<Uint8Array>): AsyncGenerator<unknown | void, unknown | void, void>;
2
- export interface ToEventStreamOptions {
3
- /**
4
- * If true, a ping comment is sent periodically to keep the connection alive.
5
- *
6
- * @default true
7
- */
8
- eventSourcePingEnabled?: boolean;
9
- /**
10
- * Interval (in milliseconds) between ping comments sent after the last event.
11
- *
12
- * @default 5000
13
- */
14
- eventSourcePingInterval?: number;
15
- /**
16
- * The content of the ping comment. Must not include newline characters.
17
- *
18
- * @default ''
19
- */
20
- eventSourcePingContent?: string;
21
- }
22
- export declare function toEventStream(iterator: AsyncIterator<unknown | void, unknown | void, void>, options?: ToEventStreamOptions): ReadableStream<Uint8Array>;
23
- //# sourceMappingURL=event-source.d.ts.map
@@ -1,12 +0,0 @@
1
- import type { StandardHeaders } from '@orpc/standard-server';
2
- /**
3
- * @param headers
4
- * @param standardHeaders - The base headers can be changed by the function and effects on the original headers.
5
- */
6
- export declare function toStandardHeaders(headers: Headers, standardHeaders?: StandardHeaders): StandardHeaders;
7
- /**
8
- * @param headers
9
- * @param fetchHeaders - The base headers can be changed by the function and effects on the original headers.
10
- */
11
- export declare function toFetchHeaders(headers: StandardHeaders, fetchHeaders?: Headers): Headers;
12
- //# sourceMappingURL=headers.d.ts.map
@@ -1,6 +0,0 @@
1
- export * from './body';
2
- export * from './event-source';
3
- export * from './headers';
4
- export * from './request';
5
- export * from './response';
6
- //# sourceMappingURL=index.d.ts.map
@@ -1,3 +0,0 @@
1
- import type { StandardRequest } from '@orpc/standard-server';
2
- export declare function toStandardRequest(request: Request): StandardRequest;
3
- //# sourceMappingURL=request.d.ts.map
@@ -1,6 +0,0 @@
1
- import type { StandardResponse } from '@orpc/standard-server';
2
- import type { ToFetchBodyOptions } from './body';
3
- export interface ToFetchResponseOptions extends ToFetchBodyOptions {
4
- }
5
- export declare function toFetchResponse(response: StandardResponse, options?: ToFetchResponseOptions): Response;
6
- //# sourceMappingURL=response.d.ts.map