srvx 0.0.0 → 0.1.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) Pooya Parsa <pooya@pi0.io>
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,68 @@
+# 💥 srvx
+
+<!-- automd:badges color=yellow -->
+
+[![npm version](https://img.shields.io/npm/v/srvx?color=yellow)](https://npmjs.com/package/srvx)
+[![npm downloads](https://img.shields.io/npm/dm/srvx?color=yellow)](https://npm.chart.dev/srvx)
+
+<!-- /automd -->
+
+Universal Server API based on web platform standards. Works with [Deno](https://deno.com/), [Bun](https://bun.sh/) and [Node.js](https://nodejs.org/en).
+
+- ✅ Seamless runtime integration with identical usage ([handler](https://srvx.unjs.io/guide/handler) and
+- ✅ Zero overhead [Deno](https://deno.com/) and [Bun](https://bun.sh/) support
+- ✅ [Node.js compatibility](https://srvx.unjs.io/guide/node) with ~native perf and [fast response]https://srvx.unjs.io/guide/node#fast-response) support
+
+## Quick start
+
+```js
+import { serve } from "srvx";
+
+const server = serve({
+  port: 3000,
+  fetch(request) {
+    return new Response("👋 Hello there!");
+  },
+});
+
+await server.ready();
+
+console.log(`🚀 Server ready at ${server.url}`);
+```
+
+👉 **Visit the 📖 [Documentation](https://srvx.unjs.io/) to learn more.**
+
+## Development
+
+<details>
+
+<summary>local development</summary>
+
+- Clone this repository
+- Install the latest LTS version of [Node.js](https://nodejs.org/en/)
+- Enable [Corepack](https://github.com/nodejs/corepack) using `corepack enable`
+- Install dependencies using `pnpm install`
+- Run interactive tests using `pnpm dev`
+
+</details>
+
+## License
+
+<!-- automd:contributors author=pi0 license=MIT -->
+
+Published under the [MIT](https://github.com/unjs/srvx/blob/main/LICENSE) license.
+Made by [@pi0](https://github.com/pi0) and [community](https://github.com/unjs/srvx/graphs/contributors) 💛
+<br><br>
+<a href="https://github.com/unjs/srvx/graphs/contributors">
+<img src="https://contrib.rocks/image?repo=unjs/srvx" />
+</a>
+
+<!-- /automd -->
+
+<!-- automd:with-automd -->
+
+---
+
+_🤖 auto updated with [automd](https://automd.unjs.io)_
+
+<!-- /automd -->

package/dist/bun.d.mts

@@ -0,0 +1,8 @@
+import { ServerOptions, Server } from './types.mjs';
+import 'node:http';
+import 'node:net';
+import 'bun';
+
+declare function serve(options: ServerOptions): Server;
+
+export { serve };

package/dist/bun.d.ts

@@ -0,0 +1,8 @@
+import { ServerOptions, Server } from './types.js';
+import 'node:http';
+import 'node:net';
+import 'bun';
+
+declare function serve(options: ServerOptions): Server;
+
+export { serve };

package/dist/bun.mjs

@@ -0,0 +1,42 @@
+import { S as Server, r as resolvePort } from './shared/srvx.4f681732.mjs';
+
+function serve(options) {
+  return new BunServer(options);
+}
+class BunServer extends Server {
+  constructor() {
+    super(...arguments);
+    this.runtime = "bun";
+  }
+  _listen() {
+    let serverFetch = this.fetch;
+    if (this.options.xRemoteAddress) {
+      const userFetch = this.fetch;
+      serverFetch = (request) => {
+        Object.defineProperty(request, "xRemoteAddress", {
+          get: () => this.bunServer?.requestIP(request)?.address,
+          enumerable: true
+        });
+        return userFetch(request);
+      };
+    }
+    this.bunServer = Bun.serve({
+      port: resolvePort(this.options.port, globalThis.process?.env.PORT),
+      hostname: this.options.hostname,
+      reusePort: this.options.reusePort,
+      ...this.options.bun,
+      fetch: serverFetch
+    });
+  }
+  get port() {
+    return this.bunServer?.port ?? null;
+  }
+  get addr() {
+    return this.bunServer?.hostname ?? null;
+  }
+  close(closeAll) {
+    this.bunServer?.stop(closeAll);
+  }
+}
+
+export { serve };

package/dist/deno.d.mts

@@ -0,0 +1,8 @@
+import { ServerOptions, Server } from './types.mjs';
+import 'node:http';
+import 'node:net';
+import 'bun';
+
+declare function serve(options: ServerOptions): Server;
+
+export { serve };

package/dist/deno.d.ts

@@ -0,0 +1,8 @@
+import { ServerOptions, Server } from './types.js';
+import 'node:http';
+import 'node:net';
+import 'bun';
+
+declare function serve(options: ServerOptions): Server;
+
+export { serve };

package/dist/deno.mjs

@@ -0,0 +1,56 @@
+import { S as Server, r as resolvePort } from './shared/srvx.4f681732.mjs';
+
+function serve(options) {
+  return new DenoServer(options);
+}
+class DenoServer extends Server {
+  constructor() {
+    super(...arguments);
+    this.runtime = "deno";
+  }
+  #listeningInfo;
+  _listen() {
+    const onListenPromise = Promise.withResolvers();
+    let serverFetch = this.fetch;
+    if (this.options.xRemoteAddress) {
+      const userFetch = serverFetch;
+      serverFetch = (request, info) => {
+        Object.defineProperty(request, "xRemoteAddress", {
+          get: () => info?.remoteAddr?.hostname,
+          enumerable: true
+        });
+        return userFetch(request);
+      };
+    }
+    this.denoServer = Deno.serve(
+      {
+        port: resolvePort(
+          this.options.port,
+          globalThis.Deno?.env.get("PORT")
+        ),
+        hostname: this.options.hostname,
+        reusePort: this.options.reusePort,
+        ...this.options.deno,
+        onListen: (info) => {
+          if (this.options.deno?.onListen) {
+            this.options.deno.onListen(info);
+          }
+          this.#listeningInfo = info;
+          onListenPromise.resolve();
+        }
+      },
+      serverFetch
+    );
+  }
+  get port() {
+    return this.#listeningInfo?.port ?? null;
+  }
+  get addr() {
+    return this.#listeningInfo?.hostname ?? null;
+  }
+  close(_closeAll) {
+    this.denoServer?.shutdown();
+  }
+}
+
+export { serve };

package/dist/node-utils/index.d.mts

@@ -0,0 +1,140 @@
+import NodeHttp__default from 'node:http';
+import { xHeaders, xRequest } from '../types.mjs';
+import 'node:net';
+import 'bun';
+
+declare const kNodeReq: unique symbol;
+declare const kNodeRes: unique symbol;
+declare const kNodeInspect: unique symbol;
+
+declare const NodeRequestProxy: {
+    new (nodeReq: NodeHttp__default.IncomingMessage): {
+        cache: RequestCache;
+        credentials: RequestCredentials;
+        destination: RequestDestination;
+        integrity: string;
+        keepalive: boolean;
+        mode: RequestMode;
+        redirect: RequestRedirect;
+        referrer: string;
+        referrerPolicy: ReferrerPolicy;
+        headers: xHeaders;
+        bodyUsed: boolean;
+        xNode: {
+            req: NodeHttp__default.IncomingMessage;
+            res: NodeHttp__default.ServerResponse;
+        } | undefined;
+        "__#444@#url": URL;
+        "__#444@#abortSignal"?: AbortController;
+        "__#444@#hasBody": boolean | undefined;
+        "__#444@#rawBody"?: Promise<Uint8Array>;
+        "__#444@#blobBody"?: Promise<Blob>;
+        "__#444@#formDataBody"?: Promise<FormData>;
+        "__#444@#jsonBody"?: Promise<any>;
+        "__#444@#textBody"?: Promise<string>;
+        "__#444@#bodyStream"?: undefined | ReadableStream<Uint8Array>;
+        readonly xRemoteAddress: string | undefined;
+        clone(): xRequest;
+        readonly url: string;
+        readonly method: string;
+        readonly signal: AbortSignal;
+        readonly _hasBody: boolean;
+        readonly body: ReadableStream<Uint8Array> | null;
+        arrayBuffer(): Promise<ArrayBuffer>;
+        blob(): Promise<Blob>;
+        formData(): Promise<FormData>;
+        json(): Promise<any>;
+        text(): Promise<string>;
+        [kNodeReq]: NodeHttp__default.IncomingMessage;
+        readonly [Symbol.toStringTag]: string;
+        [kNodeInspect](): {
+            method: string;
+            url: string;
+            headers: xHeaders;
+        };
+    };
+};
+
+type NodeFastResponse = InstanceType<typeof NodeFastResponse>;
+declare const NodeFastResponse: {
+    new (body?: BodyInit | null, init?: ResponseInit): {
+        "__#445@#body"?: BodyInit | null;
+        "__#445@#init"?: ResponseInit;
+        /**
+         * Prepare Node.js response object
+         */
+        xNodeResponse(): {
+            status: number;
+            statusText: string;
+            headers: NodeHttp__default.OutgoingHttpHeader[];
+            body: string | Uint8Array | ReadableStream<Uint8Array> | Buffer | DataView | null | undefined;
+        };
+        /** Lazy initialized response instance */
+        "__#445@#responseObj"?: Response;
+        /** Lazy initialized headers instance */
+        "__#445@#headersObj"?: Headers;
+        clone(): Response;
+        readonly "__#445@#response": Response;
+        readonly headers: Headers;
+        readonly ok: boolean;
+        readonly redirected: boolean;
+        readonly status: number;
+        readonly statusText: string;
+        readonly type: ResponseType;
+        readonly url: string;
+        "__#445@#fastBody"<T extends object>(as: new (...args: any[]) => T): T | null | false;
+        readonly body: ReadableStream<Uint8Array> | null;
+        readonly bodyUsed: boolean;
+        arrayBuffer(): Promise<ArrayBuffer>;
+        blob(): Promise<Blob>;
+        formData(): Promise<FormData>;
+        text(): Promise<string>;
+        json(): Promise<any>;
+    };
+};
+
+declare const NodeReqHeadersProxy: {
+    new (req: NodeHttp__default.IncomingMessage): {
+        append(name: string, value: string): void;
+        delete(name: string): void;
+        get(name: string): string | null;
+        getSetCookie(): string[];
+        has(name: string): boolean;
+        set(name: string, value: string): void;
+        toJSON(): Record<string, string>;
+        forEach(cb: (value: string, key: string, parent: Headers) => void, thisArg?: any): void;
+        entries(): HeadersIterator<[string, string]>;
+        keys(): HeadersIterator<string>;
+        values(): HeadersIterator<string>;
+        [kNodeReq]: NodeHttp__default.IncomingMessage;
+        [Symbol.iterator](): HeadersIterator<[string, string]>;
+        readonly [Symbol.toStringTag]: string;
+        [kNodeInspect](): {
+            [k: string]: string;
+        };
+    };
+};
+declare const NodeResHeadersProxy: {
+    new (res: NodeHttp__default.ServerResponse): {
+        append(name: string, value: string): void;
+        delete(name: string): void;
+        get(name: string): string | null;
+        getSetCookie(): string[];
+        has(name: string): boolean;
+        set(name: string, value: string): void;
+        forEach(cb: (value: string, key: string, parent: Headers) => void, thisArg?: any): void;
+        entries(): HeadersIterator<[string, string]>;
+        keys(): HeadersIterator<string>;
+        values(): HeadersIterator<string>;
+        [kNodeRes]: NodeHttp__default.ServerResponse;
+        [Symbol.iterator](): HeadersIterator<[string, string]>;
+        readonly [Symbol.toStringTag]: string;
+        [kNodeInspect](): {
+            [k: string]: string;
+        };
+    };
+};
+
+declare function sendNodeResponse(nodeRes: NodeHttp__default.ServerResponse, webRes: Response | NodeFastResponse): Promise<void>;
+
+export { NodeFastResponse, NodeReqHeadersProxy, NodeRequestProxy, NodeResHeadersProxy, sendNodeResponse };

package/dist/node-utils/index.d.ts

@@ -0,0 +1,140 @@
+import NodeHttp__default from 'node:http';
+import { xHeaders, xRequest } from '../types.js';
+import 'node:net';
+import 'bun';
+
+declare const kNodeReq: unique symbol;
+declare const kNodeRes: unique symbol;
+declare const kNodeInspect: unique symbol;
+
+declare const NodeRequestProxy: {
+    new (nodeReq: NodeHttp__default.IncomingMessage): {
+        cache: RequestCache;
+        credentials: RequestCredentials;
+        destination: RequestDestination;
+        integrity: string;
+        keepalive: boolean;
+        mode: RequestMode;
+        redirect: RequestRedirect;
+        referrer: string;
+        referrerPolicy: ReferrerPolicy;
+        headers: xHeaders;
+        bodyUsed: boolean;
+        xNode: {
+            req: NodeHttp__default.IncomingMessage;
+            res: NodeHttp__default.ServerResponse;
+        } | undefined;
+        "__#444@#url": URL;
+        "__#444@#abortSignal"?: AbortController;
+        "__#444@#hasBody": boolean | undefined;
+        "__#444@#rawBody"?: Promise<Uint8Array>;
+        "__#444@#blobBody"?: Promise<Blob>;
+        "__#444@#formDataBody"?: Promise<FormData>;
+        "__#444@#jsonBody"?: Promise<any>;
+        "__#444@#textBody"?: Promise<string>;
+        "__#444@#bodyStream"?: undefined | ReadableStream<Uint8Array>;
+        readonly xRemoteAddress: string | undefined;
+        clone(): xRequest;
+        readonly url: string;
+        readonly method: string;
+        readonly signal: AbortSignal;
+        readonly _hasBody: boolean;
+        readonly body: ReadableStream<Uint8Array> | null;
+        arrayBuffer(): Promise<ArrayBuffer>;
+        blob(): Promise<Blob>;
+        formData(): Promise<FormData>;
+        json(): Promise<any>;
+        text(): Promise<string>;
+        [kNodeReq]: NodeHttp__default.IncomingMessage;
+        readonly [Symbol.toStringTag]: string;
+        [kNodeInspect](): {
+            method: string;
+            url: string;
+            headers: xHeaders;
+        };
+    };
+};
+
+type NodeFastResponse = InstanceType<typeof NodeFastResponse>;
+declare const NodeFastResponse: {
+    new (body?: BodyInit | null, init?: ResponseInit): {
+        "__#445@#body"?: BodyInit | null;
+        "__#445@#init"?: ResponseInit;
+        /**
+         * Prepare Node.js response object
+         */
+        xNodeResponse(): {
+            status: number;
+            statusText: string;
+            headers: NodeHttp__default.OutgoingHttpHeader[];
+            body: string | Uint8Array | ReadableStream<Uint8Array> | Buffer | DataView | null | undefined;
+        };
+        /** Lazy initialized response instance */
+        "__#445@#responseObj"?: Response;
+        /** Lazy initialized headers instance */
+        "__#445@#headersObj"?: Headers;
+        clone(): Response;
+        readonly "__#445@#response": Response;
+        readonly headers: Headers;
+        readonly ok: boolean;
+        readonly redirected: boolean;
+        readonly status: number;
+        readonly statusText: string;
+        readonly type: ResponseType;
+        readonly url: string;
+        "__#445@#fastBody"<T extends object>(as: new (...args: any[]) => T): T | null | false;
+        readonly body: ReadableStream<Uint8Array> | null;
+        readonly bodyUsed: boolean;
+        arrayBuffer(): Promise<ArrayBuffer>;
+        blob(): Promise<Blob>;
+        formData(): Promise<FormData>;
+        text(): Promise<string>;
+        json(): Promise<any>;
+    };
+};
+
+declare const NodeReqHeadersProxy: {
+    new (req: NodeHttp__default.IncomingMessage): {
+        append(name: string, value: string): void;
+        delete(name: string): void;
+        get(name: string): string | null;
+        getSetCookie(): string[];
+        has(name: string): boolean;
+        set(name: string, value: string): void;
+        toJSON(): Record<string, string>;
+        forEach(cb: (value: string, key: string, parent: Headers) => void, thisArg?: any): void;
+        entries(): HeadersIterator<[string, string]>;
+        keys(): HeadersIterator<string>;
+        values(): HeadersIterator<string>;
+        [kNodeReq]: NodeHttp__default.IncomingMessage;
+        [Symbol.iterator](): HeadersIterator<[string, string]>;
+        readonly [Symbol.toStringTag]: string;
+        [kNodeInspect](): {
+            [k: string]: string;
+        };
+    };
+};
+declare const NodeResHeadersProxy: {
+    new (res: NodeHttp__default.ServerResponse): {
+        append(name: string, value: string): void;
+        delete(name: string): void;
+        get(name: string): string | null;
+        getSetCookie(): string[];
+        has(name: string): boolean;
+        set(name: string, value: string): void;
+        forEach(cb: (value: string, key: string, parent: Headers) => void, thisArg?: any): void;
+        entries(): HeadersIterator<[string, string]>;
+        keys(): HeadersIterator<string>;
+        values(): HeadersIterator<string>;
+        [kNodeRes]: NodeHttp__default.ServerResponse;
+        [Symbol.iterator](): HeadersIterator<[string, string]>;
+        readonly [Symbol.toStringTag]: string;
+        [kNodeInspect](): {
+            [k: string]: string;
+        };
+    };
+};
+
+declare function sendNodeResponse(nodeRes: NodeHttp__default.ServerResponse, webRes: Response | NodeFastResponse): Promise<void>;
+
+export { NodeFastResponse, NodeReqHeadersProxy, NodeRequestProxy, NodeResHeadersProxy, sendNodeResponse };