@rest-vir/run-service 0.0.2

package/LICENSE-CC0

@@ -0,0 +1,121 @@
+CC0 1.0 Universal
+
+Creative Commons Legal Code
+
+    CREATIVE COMMONS CORPORATION IS NOT A LAW FIRM AND DOES NOT PROVIDE
+    LEGAL SERVICES. DISTRIBUTION OF THIS DOCUMENT DOES NOT CREATE AN
+    ATTORNEY-CLIENT RELATIONSHIP. CREATIVE COMMONS PROVIDES THIS
+    INFORMATION ON AN "AS-IS" BASIS. CREATIVE COMMONS MAKES NO WARRANTIES
+    REGARDING THE USE OF THIS DOCUMENT OR THE INFORMATION OR WORKS
+    PROVIDED HEREUNDER, AND DISCLAIMS LIABILITY FOR DAMAGES RESULTING FROM
+    THE USE OF THIS DOCUMENT OR THE INFORMATION OR WORKS PROVIDED
+    HEREUNDER.
+
+Statement of Purpose
+
+The laws of most jurisdictions throughout the world automatically confer
+exclusive Copyright and Related Rights (defined below) upon the creator
+and subsequent owner(s) (each and all, an "owner") of an original work of
+authorship and/or a database (each, a "Work").
+
+Certain owners wish to permanently relinquish those rights to a Work for
+the purpose of contributing to a commons of creative, cultural and
+scientific works ("Commons") that the public can reliably and without fear
+of later claims of infringement build upon, modify, incorporate in other
+works, reuse and redistribute as freely as possible in any form whatsoever
+and for any purposes, including without limitation commercial purposes.
+These owners may contribute to the Commons to promote the ideal of a free
+culture and the further production of creative, cultural and scientific
+works, or to gain reputation or greater distribution for their Work in
+part through the use and efforts of others.
+
+For these and/or other purposes and motivations, and without any
+expectation of additional consideration or compensation, the person
+associating CC0 with a Work (the "Affirmer"), to the extent that he or she
+is an owner of Copyright and Related Rights in the Work, voluntarily
+elects to apply CC0 to the Work and publicly distribute the Work under its
+terms, with knowledge of his or her Copyright and Related Rights in the
+Work and the meaning and intended legal effect of CC0 on those rights.
+
+1. Copyright and Related Rights. A Work made available under CC0 may be
+protected by copyright and related or neighboring rights ("Copyright and
+Related Rights"). Copyright and Related Rights include, but are not
+limited to, the following:
+
+  i. the right to reproduce, adapt, distribute, perform, display,
+     communicate, and translate a Work;
+ ii. moral rights retained by the original author(s) and/or performer(s);
+iii. publicity and privacy rights pertaining to a person's image or
+     likeness depicted in a Work;
+ iv. rights protecting against unfair competition in regards to a Work,
+     subject to the limitations in paragraph 4(a), below;
+  v. rights protecting the extraction, dissemination, use and reuse of data
+     in a Work;
+ vi. database rights (such as those arising under Directive 96/9/EC of the
+     European Parliament and of the Council of 11 March 1996 on the legal
+     protection of databases, and under any national implementation
+     thereof, including any amended or successor version of such
+     directive); and
+vii. other similar, equivalent or corresponding rights throughout the
+     world based on applicable law or treaty, and any national
+     implementations thereof.
+
+2. Waiver. To the greatest extent permitted by, but not in contravention
+of, applicable law, Affirmer hereby overtly, fully, permanently,
+irrevocably and unconditionally waives, abandons, and surrenders all of
+Affirmer's Copyright and Related Rights and associated claims and causes
+of action, whether now known or unknown (including existing as well as
+future claims and causes of action), in the Work (i) in all territories
+worldwide, (ii) for the maximum duration provided by applicable law or
+treaty (including future time extensions), (iii) in any current or future
+medium and for any number of copies, and (iv) for any purpose whatsoever,
+including without limitation commercial, advertising or promotional
+purposes (the "Waiver"). Affirmer makes the Waiver for the benefit of each
+member of the public at large and to the detriment of Affirmer's heirs and
+successors, fully intending that such Waiver shall not be subject to
+revocation, rescission, cancellation, termination, or any other legal or
+equitable action to disrupt the quiet enjoyment of the Work by the public
+as contemplated by Affirmer's express Statement of Purpose.
+
+3. Public License Fallback. Should any part of the Waiver for any reason
+be judged legally invalid or ineffective under applicable law, then the
+Waiver shall be preserved to the maximum extent permitted taking into
+account Affirmer's express Statement of Purpose. In addition, to the
+extent the Waiver is so judged Affirmer hereby grants to each affected
+person a royalty-free, non transferable, non sublicensable, non exclusive,
+irrevocable and unconditional license to exercise Affirmer's Copyright and
+Related Rights in the Work (i) in all territories worldwide, (ii) for the
+maximum duration provided by applicable law or treaty (including future
+time extensions), (iii) in any current or future medium and for any number
+of copies, and (iv) for any purpose whatsoever, including without
+limitation commercial, advertising or promotional purposes (the
+"License"). The License shall be deemed effective as of the date CC0 was
+applied by Affirmer to the Work. Should any part of the License for any
+reason be judged legally invalid or ineffective under applicable law, such
+partial invalidity or ineffectiveness shall not invalidate the remainder
+of the License, and in such case Affirmer hereby affirms that he or she
+will not (i) exercise any of his or her remaining Copyright and Related
+Rights in the Work or (ii) assert any associated claims and causes of
+action with respect to the Work, in either case contrary to Affirmer's
+express Statement of Purpose.
+
+4. Limitations and Disclaimers.
+
+ a. No trademark or patent rights held by Affirmer are waived, abandoned,
+    surrendered, licensed or otherwise affected by this document.
+ b. Affirmer offers the Work as-is and makes no representations or
+    warranties of any kind concerning the Work, express, implied,
+    statutory or otherwise, including without limitation warranties of
+    title, merchantability, fitness for a particular purpose, non
+    infringement, or the absence of latent or other defects, accuracy, or
+    the present or absence of errors, whether or not discoverable, all to
+    the greatest extent permissible under applicable law.
+ c. Affirmer disclaims responsibility for clearing rights of other persons
+    that may apply to the Work or any use thereof, including without
+    limitation any person's Copyright and Related Rights in the Work.
+    Further, Affirmer disclaims responsibility for obtaining any necessary
+    consents, permissions or other rights required for any use of the
+    Work.
+ d. Affirmer understands and acknowledges that Creative Commons is not a
+    party to this document and has no duty or obligation with respect to
+    this CC0 or use of the Work.

package/LICENSE-MIT

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 electrovir
+
+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,23 @@
+# @rest-vir/run-service
+
+Part of the rest-vir suite. This package is used for running a REST service already defined by [`@rest-vir/define-service`](https://www.npmjs.com/package/@rest-vir/define-service) and implemented by [`@rest-vir/implement-service`](https://www.npmjs.com/package/@rest-vir/implement-service).
+
+See the full docs at https://electrovir.github.io/rest-vir
+
+## Installation
+
+```sh
+npm i @rest-vir/run-service
+```
+
+## Usage
+
+Run your service:
+
+```TypeScript
+import {startService} from '@rest-vir/run-service';
+
+await startService(myServiceImplementation, {
+    port: 3000,
+});
+```

package/dist/handle-request/endpoint-handler.d.ts

@@ -0,0 +1,76 @@
+import { type HttpStatus, type MaybePromise, type PartialWithUndefined } from '@augment-vir/common';
+import { ServerRequest, ServerResponse, type ImplementedEndpoint, type ImplementedWebSocket } from '@rest-vir/implement-service';
+import { OutgoingHttpHeaders } from 'node:http';
+/**
+ * Options for `handleRoute`.
+ *
+ * @category Internal
+ * @category Package : @rest-vir/run-service
+ * @package [`@rest-vir/run-service`](https://www.npmjs.com/package/@rest-vir/run-service)
+ */
+export type HandleRouteOptions = PartialWithUndefined<{
+    /**
+     * If set to `true`, all service endpoint handlers will throw their errors, allowing your
+     * existing server setup to catch them and handle them as you wish.
+     *
+     * If set to `false`, all service endpoint handlers will handle the errors internally to prevent
+     * accidentally leaking error messages to the frontend.
+     *
+     * @default false
+     */
+    throwErrorsForExternalHandling: boolean;
+}>;
+/**
+ * Output from {@link EndpointHandler}.
+ *
+ * @category Internal
+ * @category Package : @rest-vir/run-service
+ * @package [`@rest-vir/run-service`](https://www.npmjs.com/package/@rest-vir/run-service)
+ */
+export type HandledOutput = {
+    body?: never;
+    statusCode?: never;
+    headers?: Readonly<OutgoingHttpHeaders> | undefined;
+    error?: Error | undefined;
+} | {
+    body?: unknown;
+    /**
+     * If this is set, then the response is sent with this status code and the given body (if
+     * any).
+     */
+    statusCode: HttpStatus;
+    headers?: Readonly<OutgoingHttpHeaders> | undefined;
+    error?: Error | undefined;
+}
+/** A value of `undefined` indicates that the response should not be sent yet. */
+ | undefined;
+/**
+ * Params for {@link EndpointHandler}.
+ *
+ * @category Internal
+ * @category Package : @rest-vir/run-service
+ * @package [`@rest-vir/run-service`](https://www.npmjs.com/package/@rest-vir/run-service)
+ */
+export type EndpointHandlerParams = {
+    request: ServerRequest;
+    response: ServerResponse;
+    route: Readonly<ImplementedEndpoint | ImplementedWebSocket>;
+};
+/**
+ * An individual endpoint handler. The complete endpoint handler is made up of multiple of these.
+ *
+ * @category Internal
+ * @category Package : @rest-vir/run-service
+ * @package [`@rest-vir/run-service`](https://www.npmjs.com/package/@rest-vir/run-service)
+ */
+export type EndpointHandler = (params: Readonly<EndpointHandlerParams>) => MaybePromise<HandledOutput>;
+/**
+ * Handle the output of a handler. Setting headers, sending the response, etc.
+ *
+ * @category Internal
+ * @category Package : @rest-vir/run-service
+ * @package [`@rest-vir/run-service`](https://www.npmjs.com/package/@rest-vir/run-service)
+ */
+export declare function handleHandlerResult(result: Readonly<HandledOutput>, response: ServerResponse): {
+    responseSent: boolean;
+};

package/dist/handle-request/endpoint-handler.js

@@ -0,0 +1,29 @@
+/* node:coverage disable: this file is just types */
+import { setResponseHeaders } from '../util/headers.js';
+/**
+ * Handle the output of a handler. Setting headers, sending the response, etc.
+ *
+ * @category Internal
+ * @category Package : @rest-vir/run-service
+ * @package [`@rest-vir/run-service`](https://www.npmjs.com/package/@rest-vir/run-service)
+ */
+export function handleHandlerResult(result, response) {
+    if (result?.headers) {
+        setResponseHeaders(response, result.headers);
+    }
+    if (result?.statusCode) {
+        response.statusCode = result.statusCode;
+        if (result.body) {
+            response.send(result.body);
+        }
+        else {
+            response.send();
+        }
+        return {
+            responseSent: true,
+        };
+    }
+    return {
+        responseSent: false,
+    };
+}

package/dist/handle-request/handle-cors.d.ts

@@ -0,0 +1,37 @@
+import { SelectFrom } from '@augment-vir/common';
+import { EndpointHandlerParams, HandledOutput } from './endpoint-handler.js';
+/**
+ * Determines the required origin for the endpoint and compares it with the given request.
+ *
+ * If an OPTIONS request is being handled, a `NoContent` response is always sent, with all CORS
+ * headers set appropriately.
+ *
+ * For other requests:
+ *
+ * - If the request fails the origin checks, a `Forbidden` response is sent.
+ * - If the request passes origin checks, the appropriate CORS headers are set and a response is not
+ *   sent (so further handlers can process it).
+ *
+ * @category Internal
+ * @category Package : @rest-vir/run-service
+ * @package [`@rest-vir/run-service`](https://www.npmjs.com/package/@rest-vir/run-service)
+ */
+export declare function handleCors(this: void, { route, request, }: Readonly<SelectFrom<EndpointHandlerParams, {
+    request: {
+        headers: true;
+        method: true;
+        originalUrl: true;
+    };
+    route: {
+        requiredClientOrigin: true;
+        path: true;
+        service: {
+            serviceName: true;
+            requiredClientOrigin: true;
+            logger: true;
+        };
+        methods: true;
+        isEndpoint: true;
+        isWebSocket: true;
+    };
+}>>): Promise<HandledOutput>;

package/dist/handle-request/handle-cors.js

@@ -0,0 +1,141 @@
+import { check } from '@augment-vir/assert';
+import { HttpMethod } from '@augment-vir/common';
+import { AnyOrigin, getAllowedEndpointMethods, } from '@rest-vir/define-service';
+import { HttpStatus, RestVirHandlerError } from '@rest-vir/implement-service';
+import { convertDuration } from 'date-vir';
+/**
+ * Determines the required origin for the endpoint and compares it with the given request.
+ *
+ * If an OPTIONS request is being handled, a `NoContent` response is always sent, with all CORS
+ * headers set appropriately.
+ *
+ * For other requests:
+ *
+ * - If the request fails the origin checks, a `Forbidden` response is sent.
+ * - If the request passes origin checks, the appropriate CORS headers are set and a response is not
+ *   sent (so further handlers can process it).
+ *
+ * @category Internal
+ * @category Package : @rest-vir/run-service
+ * @package [`@rest-vir/run-service`](https://www.npmjs.com/package/@rest-vir/run-service)
+ */
+export async function handleCors({ route, request, }) {
+    const origin = request.headers.origin;
+    const matchedOrigin = await matchOrigin(route, origin);
+    const allowedMethods = route.isEndpoint ? getAllowedEndpointMethods(route) : [HttpMethod.Get];
+    if (request.method.toUpperCase() === HttpMethod.Options) {
+        return {
+            statusCode: HttpStatus.NoContent,
+            headers: buildOptionsRequestCorsHeaders(matchedOrigin, allowedMethods),
+        };
+    }
+    else if (matchedOrigin) {
+        return {
+            headers: buildStandardCorsHeaders(matchedOrigin),
+        };
+    }
+    else {
+        route.service.logger.error(new RestVirHandlerError(route, `CORS rejected for origin '${origin}'.`));
+        /** The CORS requirements for this request have not been met. */
+        return {
+            statusCode: HttpStatus.Forbidden,
+        };
+    }
+}
+function buildStandardCorsHeaders(matchedOrigin) {
+    if (matchedOrigin === AnyOrigin) {
+        return {
+            'Access-Control-Allow-Origin': '*',
+        };
+    }
+    else {
+        return {
+            'Access-Control-Allow-Origin': matchedOrigin,
+            'Access-Control-Allow-Credentials': 'true',
+            Vary: 'Origin',
+        };
+    }
+}
+const accessControlMaxAgeValue = String(convertDuration({ hours: 1 }, { seconds: true }).seconds);
+const contentLengthHeaders = {
+    /**
+     * Safari (and potentially other browsers) need content-length 0 for 204 or it will hang waiting
+     * for a body.
+     */
+    'Content-Length': '0',
+};
+function buildOptionsRequestCorsHeaders(matchedOrigin, allowedMethods) {
+    if (matchedOrigin == undefined) {
+        return contentLengthHeaders;
+    }
+    return {
+        ...buildStandardCorsHeaders(matchedOrigin),
+        'Access-Control-Allow-Methods': allowedMethods.join(','),
+        'Access-Control-Allow-Headers': [
+            'Cookie',
+            'Authorization',
+            'Content-Type',
+        ].join(','),
+        'Access-Control-Max-Age': accessControlMaxAgeValue,
+        ...contentLengthHeaders,
+    };
+}
+async function matchOrigin(endpoint, origin) {
+    const endpointRequirement = await checkOriginRequirement(endpoint.requiredClientOrigin, origin);
+    if (endpointRequirement === AnyOrigin) {
+        return AnyOrigin;
+    }
+    else if (endpointRequirement === false) {
+        return undefined;
+    }
+    else if (endpointRequirement === true) {
+        return origin;
+    }
+    /** If the endpoint requirement is `undefined`, then we check the service requirement. */
+    const serviceRequirement = await checkOriginRequirement(endpoint.service.requiredClientOrigin, origin);
+    if (serviceRequirement === AnyOrigin) {
+        return AnyOrigin;
+    }
+    else if (serviceRequirement === false) {
+        return undefined;
+    }
+    else if (serviceRequirement === true) {
+        return origin;
+    }
+    /**
+     * If the service requirement is `undefined`, something went wrong because service definitions
+     * are not allowed to have an `undefined` origin requirement.
+     */
+    throw new RestVirHandlerError(endpoint, `Request origin '${origin}' failed to get checked for endpoint '${endpoint.path}' or service '${endpoint.service.serviceName}'`);
+}
+async function checkOriginRequirement(originRequirement, origin) {
+    if (originRequirement === AnyOrigin) {
+        /** Any origin has been explicitly allowed. */
+        return AnyOrigin;
+    }
+    else if (originRequirement === undefined) {
+        /** No checking occurred. */
+        return undefined;
+    }
+    else if (!origin) {
+        /** If there is an origin requirement but no origin then the origin automatically fails. */
+        return false;
+    }
+    else if (check.isString(originRequirement)) {
+        return origin === originRequirement;
+    }
+    else if (check.instanceOf(originRequirement, RegExp)) {
+        return !!originRequirement.exec(origin);
+    }
+    else if (check.isArray(originRequirement)) {
+        for (const requirement of originRequirement) {
+            if (await checkOriginRequirement(requirement, origin)) {
+                return true;
+            }
+        }
+        return false;
+    }
+    else {
+        return await originRequirement(origin);
+    }
+}

package/dist/handle-request/handle-endpoint.d.ts

@@ -0,0 +1,13 @@
+import { ImplementedEndpoint } from '@rest-vir/implement-service';
+import { EndpointHandlerParams, type HandledOutput } from './endpoint-handler.js';
+/**
+ * Handles an endpoint's implementation execution.
+ *
+ * @category Internal
+ * @category Package : @rest-vir/run-service
+ * @package [`@rest-vir/run-service`](https://www.npmjs.com/package/@rest-vir/run-service)
+ */
+export declare function handleEndpointRequest(this: void, { endpoint, request, response, attachId, }: Readonly<Omit<EndpointHandlerParams, 'route'> & {
+    attachId: string;
+    endpoint: Readonly<ImplementedEndpoint>;
+}>): Promise<HandledOutput>;

package/dist/handle-request/handle-endpoint.js

@@ -0,0 +1,62 @@
+import { assert, assertWrap } from '@augment-vir/assert';
+import { ensureErrorAndPrependMessage, HttpStatus, isErrorHttpStatus } from '@augment-vir/common';
+import { createRestVirHandlerErrorPrefix, HttpMethod, RestVirHandlerError, } from '@rest-vir/implement-service';
+import { assertValidShape } from 'object-shape-tester';
+/**
+ * Handles an endpoint's implementation execution.
+ *
+ * @category Internal
+ * @category Package : @rest-vir/run-service
+ * @package [`@rest-vir/run-service`](https://www.npmjs.com/package/@rest-vir/run-service)
+ */
+export async function handleEndpointRequest({ endpoint, request, response, attachId, }) {
+    try {
+        const restVirContext = request.restVirContext?.[attachId];
+        assert.isDefined(restVirContext, 'restVirContext is not defined');
+        const context = restVirContext.context;
+        const requestData = restVirContext.requestData;
+        const searchParams = restVirContext.searchParams;
+        const endpointParams = {
+            pathParams: request.params,
+            method: assertWrap.isEnumValue(request.method.toUpperCase(), HttpMethod),
+            request,
+            requestData,
+            requestHeaders: request.headers,
+            response,
+            service: endpoint.service,
+            endpoint,
+            log: endpoint.service.logger,
+            context,
+            searchParams,
+        };
+        const endpointResult = (await endpoint.implementation(endpointParams));
+        if (isErrorHttpStatus(endpointResult.statusCode)) {
+            endpoint.service.logger.error(new RestVirHandlerError(endpoint, `Endpoint implementation returned error status: ${endpointResult.statusCode}`));
+            return {
+                statusCode: endpointResult.statusCode,
+                body: endpointResult.responseErrorMessage,
+            };
+        }
+        else if (endpointResult.responseData) {
+            if (!endpoint.responseDataShape) {
+                throw new RestVirHandlerError(endpoint, 'Got response data but none was expected.');
+            }
+            assertValidShape(endpointResult.responseData, endpoint.responseDataShape, { allowExtraKeys: true }, 'invalid response data');
+            return {
+                headers: {
+                    'content-type': endpointResult.dataType || 'application/json',
+                },
+                statusCode: HttpStatus.Ok,
+                body: endpointResult.responseData,
+            };
+        }
+        else {
+            return {
+                statusCode: HttpStatus.Ok,
+            };
+        }
+    }
+    catch (error) {
+        throw ensureErrorAndPrependMessage(error, createRestVirHandlerErrorPrefix(endpoint));
+    }
+}

package/dist/handle-request/handle-request-method.d.ts

@@ -0,0 +1,26 @@
+import { SelectFrom } from '@augment-vir/common';
+import { HandledOutput, type EndpointHandlerParams } from './endpoint-handler.js';
+/**
+ * Verifies that a request's method matches the given endpoint's expectations. If it does not, an
+ * error response is sent.
+ *
+ * @category Internal
+ * @category Package : @rest-vir/run-service
+ * @package [`@rest-vir/run-service`](https://www.npmjs.com/package/@rest-vir/run-service)
+ */
+export declare function handleRequestMethod(this: void, { route, request, }: Readonly<SelectFrom<EndpointHandlerParams, {
+    request: {
+        method: true;
+        originalUrl: true;
+    };
+    route: {
+        methods: true;
+        path: true;
+        service: {
+            logger: true;
+            serviceName: true;
+        };
+        isWebSocket: true;
+        isEndpoint: true;
+    };
+}>>): HandledOutput;

package/dist/handle-request/handle-request-method.js

@@ -0,0 +1,33 @@
+import { checkWrap } from '@augment-vir/assert';
+import { HttpMethod, HttpStatus } from '@augment-vir/common';
+import { RestVirHandlerError } from '@rest-vir/implement-service';
+/**
+ * Verifies that a request's method matches the given endpoint's expectations. If it does not, an
+ * error response is sent.
+ *
+ * @category Internal
+ * @category Package : @rest-vir/run-service
+ * @package [`@rest-vir/run-service`](https://www.npmjs.com/package/@rest-vir/run-service)
+ */
+export function handleRequestMethod({ route, request, }) {
+    const requestMethod = checkWrap.isEnumValue(request.method.toUpperCase(), HttpMethod);
+    /** Always allow preflight requests. */
+    if (requestMethod === HttpMethod.Options) {
+        return undefined;
+    }
+    const allowedMethods = 'methods' in route
+        ? route.methods
+        : /** WebSockets only allow get requests. */
+            {
+                [HttpMethod.Get]: true,
+            };
+    if (!requestMethod || !allowedMethods[requestMethod]) {
+        route.service.logger.error(new RestVirHandlerError(route, `Method '${requestMethod}' rejected: '${request.originalUrl}'`));
+        return {
+            statusCode: HttpStatus.MethodNotAllowed,
+        };
+    }
+    else {
+        return undefined;
+    }
+}

package/dist/handle-request/handle-route.d.ts

@@ -0,0 +1,15 @@
+import { ImplementedEndpoint, ServerRequest, ServerResponse, type ImplementedWebSocket } from '@rest-vir/implement-service';
+import { type WebSocket as WsWebSocket } from 'ws';
+import { HandleRouteOptions } from './endpoint-handler.js';
+/**
+ * Handles a WebSocket or Endpoint request.
+ *
+ * @category Internal
+ * @category Package : @rest-vir/run-service
+ * @package [`@rest-vir/run-service`](https://www.npmjs.com/package/@rest-vir/run-service)
+ */
+export declare function handleRoute(
+/** Endpoint requests won't have a `WebSocket`. */
+webSocket: WsWebSocket | undefined, request: ServerRequest, 
+/** `WebSocket` requests won't have a response. */
+response: ServerResponse | undefined, route: Readonly<ImplementedEndpoint | ImplementedWebSocket>, attachId: string, options?: Readonly<Pick<HandleRouteOptions, 'throwErrorsForExternalHandling'>>): Promise<void>;

package/dist/handle-request/handle-route.js

@@ -0,0 +1,65 @@
+import { assert, check } from '@augment-vir/assert';
+import { ensureError, HttpStatus } from '@augment-vir/common';
+import { RestVirHandlerError, } from '@rest-vir/implement-service';
+import cluster from 'node:cluster';
+import { handleHandlerResult } from './endpoint-handler.js';
+import { handleEndpointRequest } from './handle-endpoint.js';
+import { handleWebSocketRequest } from './handle-web-socket.js';
+/**
+ * Handles a WebSocket or Endpoint request.
+ *
+ * @category Internal
+ * @category Package : @rest-vir/run-service
+ * @package [`@rest-vir/run-service`](https://www.npmjs.com/package/@rest-vir/run-service)
+ */
+export async function handleRoute(
+/** Endpoint requests won't have a `WebSocket`. */
+webSocket, request, 
+/** `WebSocket` requests won't have a response. */
+response, route, attachId, options = {}) {
+    try {
+        const workerPid = cluster.isPrimary ? '' : process.pid;
+        const webSocketMarker = route.isWebSocket ? '(ws)' : '';
+        const logParts = [
+            workerPid,
+            request.method,
+            webSocketMarker,
+            request.originalUrl,
+        ].filter(check.isTruthy);
+        route.service.logger.info(logParts.join('\t'));
+        if (route.isEndpoint) {
+            assert.isDefined(response);
+            const result = await handleEndpointRequest({
+                request,
+                response,
+                endpoint: route,
+                attachId,
+            });
+            if (handleHandlerResult(result, response).responseSent) {
+                return;
+            }
+        }
+        else if (route.isWebSocket) {
+            assert.isDefined(webSocket);
+            await handleWebSocketRequest({
+                request,
+                implementedWebSocket: route,
+                webSocket,
+                attachId,
+            });
+            return;
+        }
+        /* node:coverage ignore next: this can't actually be triggered but it should be covered as a potential future edge case. */
+        throw new RestVirHandlerError(route, 'Request was not handled.');
+    }
+    catch (error) {
+        route.service.logger.error(ensureError(error));
+        if (options.throwErrorsForExternalHandling) {
+            throw error;
+        }
+        else if (response && !response.sent) {
+            response.statusCode = HttpStatus.InternalServerError;
+            response.send();
+        }
+    }
+}