srvx 0.1.3 → 0.2.0

package/dist/types.d.mts

@@ -1,62 +1,7 @@
 import * as NodeHttp from 'node:http';
 import * as NodeNet from 'node:net';
-import * as BunTypes from 'bun';
-import BunTypes__default from 'bun';
-
-declare abstract class Server {
-    #private;
-    /**
-     * Current listening runtime name
-     */
-    abstract readonly runtime: "node" | "deno" | "bun";
-    /**
-     * Node.js listening server instance.
-     */
-    nodeServer?: NodeHttp.Server;
-    /**
-     * Bun listening server instance.
-     */
-    bunServer?: BunTypes__default.Server;
-    /**
-     * Deno listening server instance.
-     */
-    denoServer?: Deno.HttpServer;
-    /**
-     * Server options
-     */
-    options: Omit<ServerOptions, "fetch">;
-    /**
-     * Server fetch handler
-     */
-    fetch: ServerHandler;
-    constructor(options: ServerOptions);
-    protected abstract _listen(): void | Promise<void>;
-    /**
-     * Listening address (hostname or IP).
-     */
-    abstract readonly addr: string | null;
-    /**
-     * Listening port.
-     */
-    abstract readonly port: number | null;
-    /**
-     * Listening URL.
-     */
-    get url(): string | null;
-    /**
-     * Returns a promise that resolves when the server is ready.
-     */
-    ready(): Promise<Server>;
-    /**
-     * Stop listening to prevent new connections from being accepted.
-     *
-     * By default, it does not cancel in-flight requests or websockets. That means it may take some time before all network activity stops.
-     *
-     * @param closeActiveConnections Immediately terminate in-flight requests, websockets, and stop accepting new connections.
-     * @default false
-     */
-    abstract close(closeActiveConnections?: boolean): void | Promise<void>;
-}
+import * as Bun from 'bun';
+import * as CF from '@cloudflare/workers-types';
 
 type MaybePromise<T> = T | Promise<T>;
 /**
@@ -66,7 +11,7 @@ declare function serve(options: ServerOptions): Server;
 /**
  * Web fetch compatible request handler
  */
-type ServerHandler = (request: xRequest) => MaybePromise<Response>;
+type ServerHandler = (request: ServerRequest) => MaybePromise<Response>;
 /**
  * Server options
  */
@@ -76,9 +21,13 @@ interface ServerOptions {
      */
     fetch: ServerHandler;
     /**
-     * Server plugins
+     * Server plugins.
      */
     plugins?: (ServerPlugin | ServerPluginInstance)[];
+    /**
+     * If set to `true`, server will not start listening automatically.
+     */
+    manual?: boolean;
     /**
      * The port server should be listening to.
      *
@@ -102,22 +51,7 @@ interface ServerOptions {
      */
     reusePort?: boolean;
     /**
-     * If this option is enabled, `request.xRemoteAddress` will be available.
-     *  **Example:**
-     *
-     *  ```js
-     *  serve({
-     *   port: 3000,
-     *    xRemoteAddress: true,
-     *    fetch: (request) =>
-     *      new Response(`Your ip address is ${request.xRemoteAddress}`),
-     *  });
-     * ```
-     * **Note:** In order to to provide cross-runtime consistency, a small wrapper function will be enabled for Deno and Bun runtimes if `xRemoteAddress` option is set.
-     */
-    xRemoteAddress?: boolean;
-    /**
-     * Node.js http server options.
+     * Node.js server options.
      */
     node?: NodeHttp.ServerOptions & NodeNet.ListenOptions;
     /**
@@ -125,7 +59,7 @@ interface ServerOptions {
      *
      * @docs https://bun.sh/docs/api/http
      */
-    bun?: Omit<BunTypes.ServeOptions, "fetch">;
+    bun?: Omit<Bun.ServeOptions, "fetch">;
     /**
      * Deno server options
      *
@@ -133,7 +67,57 @@ interface ServerOptions {
      */
     deno?: Deno.ServeOptions;
 }
-type ServerPlugin = (server: Server) => MaybePromise<ServerPluginInstance>;
+interface Server<Handler = ServerHandler> {
+    /**
+     * Current runtime name
+     */
+    readonly runtime: "node" | "deno" | "bun" | "cloudflare";
+    /**
+     * Server options
+     */
+    readonly options: ServerOptions;
+    /**
+     * Server URL address.
+     */
+    readonly url?: string;
+    /**
+     * Node.js context.
+     */
+    readonly node?: {
+        server?: NodeHttp.Server;
+        handler: (nodeReq: NodeHttp.IncomingMessage, nodeRes: NodeHttp.ServerResponse) => void | Promise<void>;
+    };
+    /**
+     * Bun context.
+     */
+    readonly bun?: {
+        server?: Bun.Server;
+    };
+    /**
+     * Deno context.
+     */
+    readonly deno?: {
+        server?: Deno.HttpServer;
+    };
+    /**
+     * Server fetch handler
+     */
+    readonly fetch: Handler;
+    /**
+     * Returns a promise that resolves when the server is ready.
+     */
+    ready(): Promise<Server<Handler>>;
+    /**
+     * Stop listening to prevent new connections from being accepted.
+     *
+     * By default, it does not cancel in-flight requests or websockets. That means it may take some time before all network activity stops.
+     *
+     * @param closeActiveConnections Immediately terminate in-flight requests, websockets, and stop accepting new connections.
+     * @default false
+     */
+    close(closeActiveConnections?: boolean): Promise<void>;
+}
+type ServerPlugin = (server: Server) => ServerPluginInstance;
 interface ServerPluginInstance {
     /**
      * Plugin display name
@@ -143,33 +127,44 @@ interface ServerPluginInstance {
      * Hook to allow running logic before user fetch handler
      * If an response value is returned, user fetch handler and the next plugins will be skipped.
      */
-    request?: (request: xRequest) => MaybePromise<Response | void>;
+    request?: (request: ServerRequest) => MaybePromise<Response | void>;
     /**
      * Hook to allow running logic after user fetch handler
      * If a response value is returned, user response and the next plugins will be skipped.
      */
-    response?: (request: xRequest, response: Response) => MaybePromise<void | Response>;
+    response?: (request: ServerRequest, response: Response) => MaybePromise<void | Response>;
 }
-/**
- * https://developer.mozilla.org/en-US/docs/Web/API/Headers
- */
-type xHeaders = Omit<Headers, "count" | "toJSON" | "getAll">;
-/**
- * https://developer.mozilla.org/en-US/docs/Web/API/Request
- */
-interface xRequest extends Omit<Request, "headers" | "clone"> {
-    headers: xHeaders;
-    clone(): xRequest;
-    xNode?: {
+interface ServerRequest extends Request {
+    /**
+     * Remote address of the client.
+     */
+    remoteAddress?: string | undefined;
+    /**
+     * Underlying Node.js server request info.
+     */
+    node?: {
         req: NodeHttp.IncomingMessage;
         res: NodeHttp.ServerResponse;
     };
     /**
-     * Remote address of the client.
+     * Underlying Deno server request info.
+     */
+    deno?: {
+        info: Deno.ServeHandlerInfo<Deno.NetAddr>;
+    };
+    /**
+     * Underlying Bun server request context.
      */
-    xRemoteAddress?: string | null;
-    /** Optional user context */
-    xContext?: Record<string, unknown>;
+    bun?: {
+        server: Bun.Server;
+    };
+    /**
+     * Underlying Cloudflare request context.
+     */
+    cloudflare?: {
+        env: unknown;
+        context: CF.ExecutionContext;
+    };
 }
 
-export { Server, type ServerHandler, type ServerOptions, type ServerPlugin, type ServerPluginInstance, serve, type xHeaders, type xRequest };
+export { type Server, type ServerHandler, type ServerOptions, type ServerPlugin, type ServerPluginInstance, type ServerRequest, serve };

package/package.json

@@ -1,28 +1,24 @@
 {
   "name": "srvx",
-  "version": "0.1.3",
+  "version": "0.2.0",
   "description": "Universal Server API based on web platform standards. Works seamlessly with Deno, Bun and Node.js.",
   "repository": "unjs/srvx",
   "license": "MIT",
   "sideEffects": false,
   "type": "module",
   "exports": {
+    "./types": "./dist/types.d.mts",
+    "./deno": "./dist/adapters/deno.mjs",
+    "./bun": "./dist/adapters/bun.mjs",
+    "./node": "./dist/adapters/node.mjs",
+    "./cloudflare": "./dist/adapters/cloudflare.mjs",
     ".": {
-      "types": "./dist/types.d.mts",
-      "bun": "./dist/bun.mjs",
-      "deno": "./dist/deno.mjs",
-      "node": "./dist/node.mjs"
-    },
-    "./node-utils": {
-      "types": "./dist/node-utils/index.d.mts",
-      "import": "./dist/node-utils/index.mjs"
-    },
-    "./types": {
-      "types": "./dist/types.d.mts",
-      "import": "./dist/types.mjs"
+      "deno": "./dist/adapters/deno.mjs",
+      "bun": "./dist/adapters/bun.mjs",
+      "workerd": "./dist/adapters/cloudflare.mjs",
+      "node": "./dist/adapters/node.mjs"
     }
   },
-  "types": "./dist/types.d.mts",
   "files": [
     "dist"
   ],
@@ -32,33 +28,40 @@
     "dev": "vitest dev",
     "lint": "eslint . && prettier -c .",
     "lint:fix": "automd && eslint . --fix && prettier -w .",
+    "play:node": "node playground/app.mjs",
+    "play:deno": "deno run -A playground/app.mjs",
+    "play:bun": "bun playground/app.mjs",
+    "play:cf": "pnpx wrangler dev playground/app.mjs",
     "prepack": "pnpm build",
     "release": "pnpm test && changelogen --release && npm publish && git push --follow-tags",
     "test": "pnpm lint && pnpm test:types && vitest run --coverage",
     "test:types": "tsc --noEmit --skipLibCheck"
   },
+  "resolutions": {
+    "srvx": "link:."
+  },
   "dependencies": {
-    "cookie-es": "^1.2.2"
+    "cookie-es": "^2.0.0"
   },
   "devDependencies": {
-    "@hono/node-server": "^1.13.7",
-    "@mjackson/node-fetch-server": "^0.4.1",
-    "@types/bun": "^1.1.14",
-    "@types/deno": "^2.0.0",
-    "@types/node": "^22.10.1",
-    "@vitest/coverage-v8": "^2.1.8",
-    "automd": "^0.3.12",
-    "changelogen": "^0.5.7",
-    "eslint": "^9.16.0",
+    "@cloudflare/workers-types": "^4.20250303.0",
+    "@hono/node-server": "^1.13.8",
+    "@mjackson/node-fetch-server": "^0.6.1",
+    "@types/bun": "^1.2.4",
+    "@types/deno": "^2.2.0",
+    "@types/node": "^22.13.10",
+    "@vitest/coverage-v8": "^3.0.8",
+    "automd": "^0.4.0",
+    "changelogen": "^0.6.1",
+    "eslint": "^9.22.0",
     "eslint-config-unjs": "^0.4.2",
-    "execa": "^9.5.1",
+    "execa": "^9.5.2",
     "get-port-please": "^3.1.2",
-    "jiti": "^2.4.1",
-    "prettier": "^3.4.1",
-    "srvx": "^0.1.1",
-    "typescript": "^5.7.2",
-    "unbuild": "^2.0.0",
-    "vitest": "^2.1.8"
+    "jiti": "^2.4.2",
+    "prettier": "^3.5.3",
+    "typescript": "^5.8.2",
+    "unbuild": "^3.5.0",
+    "vitest": "^3.0.8"
   },
-  "packageManager": "pnpm@9.14.4"
+  "packageManager": "pnpm@10.6.2"
 }

package/dist/bun.d.mts

@@ -1,8 +0,0 @@
-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

@@ -1,8 +0,0 @@
-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

@@ -1,42 +0,0 @@
-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

@@ -1,8 +0,0 @@
-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

@@ -1,8 +0,0 @@
-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

@@ -1,56 +0,0 @@
-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

@@ -1,138 +0,0 @@
-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;
-        _url: URL;
-        "__#448@#abortSignal"?: AbortController;
-        "__#448@#hasBody": boolean | undefined;
-        "__#448@#bodyBytes"?: Promise<Uint8Array>;
-        "__#448@#blobBody"?: Promise<Blob>;
-        "__#448@#formDataBody"?: Promise<FormData>;
-        "__#448@#jsonBody"?: Promise<any>;
-        "__#448@#textBody"?: Promise<string>;
-        "__#448@#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<ArrayBufferLike>> | null;
-        bytes(): Promise<Uint8Array>;
-        arrayBuffer(): Promise<ArrayBuffer>;
-        blob(): Promise<Blob>;
-        formData(): Promise<FormData>;
-        text(): Promise<string>;
-        json(): Promise<any>;
-        [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): {
-        "__#449@#body"?: BodyInit | null;
-        "__#449@#init"?: ResponseInit;
-        /**
-         * Prepare Node.js response object
-         */
-        xNodeResponse(): {
-            status: number;
-            statusText: string;
-            headers: NodeHttp__default.OutgoingHttpHeader[];
-            body: string | Uint8Array<ArrayBufferLike> | ReadableStream<Uint8Array<ArrayBufferLike>> | Buffer<ArrayBufferLike> | DataView<ArrayBufferLike> | null | undefined;
-        };
-        /** Lazy initialized response instance */
-        "__#449@#responseObj"?: Response;
-        /** Lazy initialized headers instance */
-        "__#449@#headersObj"?: Headers;
-        clone(): Response;
-        readonly "__#449@#response": Response;
-        readonly headers: Headers;
-        readonly ok: boolean;
-        readonly redirected: boolean;
-        readonly status: number;
-        readonly statusText: string;
-        readonly type: ResponseType;
-        readonly url: string;
-        "__#449@#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>;
-        bytes(): Promise<Uint8Array>;
-        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 };