@forklaunch/core 0.2.3 → 0.2.6

package/lib/src/http/middleware/response/parse.middleware.js

@@ -0,0 +1,52 @@
+/**
+ * Middleware to parse and validate the response according to the provided schema.
+ *
+ * This function validates the response against a schema provided by the request's schema validator.
+ * If the response does not conform to the schema, the behavior is determined by the `responseValidation`
+ * option in `req.contractDetails.options`:
+ * - `'error'` (default): Calls `next` with an error.
+ * - `'warning'`: Logs a warning to the console.
+ * - `'none'`: Silently continues without action.
+ *
+ * @template SV - The type of the schema validator used in the request.
+ * @template P - The type of the parameters dictionary used in the request.
+ * @template ResBodyMap - A record type mapping status codes to response body types.
+ * @template ReqBody - The type of the request body.
+ * @template ReqQuery - The type of the parsed query string.
+ * @template ReqHeaders - The type of the request headers.
+ * @template ResHeaders - The type of the response headers, extended from `ForklaunchResHeaders`.
+ * @template LocalsObj - The type of the locals object in the response.
+ *
+ * @param {ForklaunchRequest<SV, P, ReqBody, ReqQuery, ReqHeaders>} req - The request object, containing the schema validator and other request data.
+ * @param {ForklaunchResponse<ResBodyMap, ForklaunchResHeaders & ResHeaders, LocalsObj>} res - The response object, including headers and body data.
+ * @param {ForklaunchNextFunction} [next] - The next middleware function to be called. If not provided, the function will return after processing.
+ *
+ * @returns {void} This function does not return a value.
+ */
+export function parse(req, res, next) {
+    console.debug('[MIDDLEWARE] parseResponse started');
+    const { headers, responses } = res.responseSchemas;
+    const parsedResponse = req.schemaValidator.parse(responses?.[res.statusCode], res.bodyData);
+    const parsedHeaders = req.schemaValidator.parse(headers ?? req.schemaValidator.unknown, res.getHeaders());
+    const parseErrors = [];
+    if (!parsedHeaders.ok) {
+        parseErrors.push(`${parsedHeaders.error ? `Header ${parsedHeaders.error}` : ''}`);
+    }
+    if (!parsedResponse.ok) {
+        parseErrors.push(`${parsedResponse.error ? `Response ${parsedResponse.error}` : ''}`);
+    }
+    if (parseErrors.length > 0) {
+        switch (req.contractDetails.options?.responseValidation) {
+            default:
+            case 'error':
+                next?.(new Error(`Invalid response:\n${parseErrors.join('\n\n')}`));
+                break;
+            case 'warning':
+                console.warn(`Invalid response:\n${parseErrors.join('\n\n')}`);
+                break;
+            case 'none':
+                break;
+        }
+    }
+    next?.();
+}

package/lib/src/http/middleware/response.middleware.d.ts

@@ -0,0 +1,31 @@
+import { AnySchemaValidator } from '@forklaunch/validator';
+import { ParsedQs } from 'qs';
+import { ForklaunchNextFunction, ForklaunchRequest, ForklaunchResHeaders, ForklaunchResponse } from '../types/apiDefinition.types';
+import { ParamsDictionary } from '../types/contractDetails.types';
+/**
+ * Middleware to parse and validate the response according to the provided schema.
+ *
+ * This function validates the response against a schema provided by the request's schema validator.
+ * If the response does not conform to the schema, the behavior is determined by the `responseValidation`
+ * option in `req.contractDetails.options`:
+ * - `'error'` (default): Calls `next` with an error.
+ * - `'warning'`: Logs a warning to the console.
+ * - `'none'`: Silently continues without action.
+ *
+ * @template SV - The type of the schema validator used in the request.
+ * @template P - The type of the parameters dictionary used in the request.
+ * @template ResBodyMap - A record type mapping status codes to response body types.
+ * @template ReqBody - The type of the request body.
+ * @template ReqQuery - The type of the parsed query string.
+ * @template ReqHeaders - The type of the request headers.
+ * @template ResHeaders - The type of the response headers, extended from `ForklaunchResHeaders`.
+ * @template LocalsObj - The type of the locals object in the response.
+ *
+ * @param {ForklaunchRequest<SV, P, ReqBody, ReqQuery, ReqHeaders>} req - The request object, containing the schema validator and other request data.
+ * @param {ForklaunchResponse<ResBodyMap, ForklaunchResHeaders & ResHeaders, LocalsObj>} res - The response object, including headers and body data.
+ * @param {ForklaunchNextFunction} [next] - The next middleware function to be called. If not provided, the function will return after processing.
+ *
+ * @returns {void} This function does not return a value.
+ */
+export declare function parseResponse<SV extends AnySchemaValidator, P extends ParamsDictionary, ResBodyMap extends Record<number, unknown>, ReqBody extends Record<string, unknown>, ReqQuery extends ParsedQs, ReqHeaders extends Record<string, string>, ResHeaders extends Record<string, string>, LocalsObj extends Record<string, unknown>>(req: ForklaunchRequest<SV, P, ReqBody, ReqQuery, ReqHeaders>, res: ForklaunchResponse<ResBodyMap, ForklaunchResHeaders & ResHeaders, LocalsObj>, next?: ForklaunchNextFunction): void;
+//# sourceMappingURL=response.middleware.d.ts.map

package/lib/src/http/middleware/response.middleware.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"response.middleware.d.ts","sourceRoot":"","sources":["../../../../src/http/middleware/response.middleware.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,kBAAkB,EAAE,MAAM,uBAAuB,CAAC;AAC3D,OAAO,EAAE,QAAQ,EAAE,MAAM,IAAI,CAAC;AAC9B,OAAO,EACL,sBAAsB,EACtB,iBAAiB,EACjB,oBAAoB,EACpB,kBAAkB,EACnB,MAAM,8BAA8B,CAAC;AACtC,OAAO,EAAE,gBAAgB,EAAE,MAAM,gCAAgC,CAAC;AAElE;;;;;;;;;;;;;;;;;;;;;;;;GAwBG;AACH,wBAAgB,aAAa,CAC3B,EAAE,SAAS,kBAAkB,EAC7B,CAAC,SAAS,gBAAgB,EAC1B,UAAU,SAAS,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,EAC1C,OAAO,SAAS,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,EACvC,QAAQ,SAAS,QAAQ,EACzB,UAAU,SAAS,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,EACzC,UAAU,SAAS,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,EACzC,SAAS,SAAS,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,EAEzC,GAAG,EAAE,iBAAiB,CAAC,EAAE,EAAE,CAAC,EAAE,OAAO,EAAE,QAAQ,EAAE,UAAU,CAAC,EAC5D,GAAG,EAAE,kBAAkB,CACrB,UAAU,EACV,oBAAoB,GAAG,UAAU,EACjC,SAAS,CACV,EACD,IAAI,CAAC,EAAE,sBAAsB,QAsC9B"}

package/lib/src/http/middleware/response.middleware.js

@@ -0,0 +1,52 @@
+/**
+ * Middleware to parse and validate the response according to the provided schema.
+ *
+ * This function validates the response against a schema provided by the request's schema validator.
+ * If the response does not conform to the schema, the behavior is determined by the `responseValidation`
+ * option in `req.contractDetails.options`:
+ * - `'error'` (default): Calls `next` with an error.
+ * - `'warning'`: Logs a warning to the console.
+ * - `'none'`: Silently continues without action.
+ *
+ * @template SV - The type of the schema validator used in the request.
+ * @template P - The type of the parameters dictionary used in the request.
+ * @template ResBodyMap - A record type mapping status codes to response body types.
+ * @template ReqBody - The type of the request body.
+ * @template ReqQuery - The type of the parsed query string.
+ * @template ReqHeaders - The type of the request headers.
+ * @template ResHeaders - The type of the response headers, extended from `ForklaunchResHeaders`.
+ * @template LocalsObj - The type of the locals object in the response.
+ *
+ * @param {ForklaunchRequest<SV, P, ReqBody, ReqQuery, ReqHeaders>} req - The request object, containing the schema validator and other request data.
+ * @param {ForklaunchResponse<ResBodyMap, ForklaunchResHeaders & ResHeaders, LocalsObj>} res - The response object, including headers and body data.
+ * @param {ForklaunchNextFunction} [next] - The next middleware function to be called. If not provided, the function will return after processing.
+ *
+ * @returns {void} This function does not return a value.
+ */
+export function parseResponse(req, res, next) {
+    console.debug('[MIDDLEWARE] parseResponse started');
+    const { headers, responses } = res.responseSchemas;
+    const parsedResponse = req.schemaValidator.parse(responses?.[res.statusCode], res.bodyData);
+    const parsedHeaders = req.schemaValidator.parse(headers, res.getHeaders());
+    const parseErrors = [];
+    if (!parsedHeaders.ok) {
+        parseErrors.push(`${parsedHeaders.error ? `Header ${parsedHeaders.error}` : ''}`);
+    }
+    if (!parsedResponse.ok) {
+        parseErrors.push(`${parsedResponse.error ? `Response ${parsedResponse.error}` : ''}`);
+    }
+    if (parseErrors.length > 0) {
+        switch (req.contractDetails.options?.responseValidation) {
+            default:
+            case 'error':
+                next?.(new Error(`Invalid response:\n${parseErrors.join('\n\n')}`));
+                break;
+            case 'warning':
+                console.warn(`Invalid response:\n${parseErrors.join('\n\n')}`);
+                break;
+            case 'none':
+                break;
+        }
+    }
+    next?.();
+}

package/lib/src/http/openApiV3Generator/index.d.ts

@@ -0,0 +1,2 @@
+export * from './openApiV3Generator';
+//# sourceMappingURL=index.d.ts.map

package/lib/src/http/openApiV3Generator/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../src/http/openApiV3Generator/index.ts"],"names":[],"mappings":"AAAA,cAAc,sBAAsB,CAAC"}

package/lib/src/http/openApiV3Generator/index.js

@@ -0,0 +1 @@
+export * from './openApiV3Generator';

package/{dist/http → lib/src/http/openApiV3Generator}/openApiV3Generator.d.ts

@@ -1,6 +1,6 @@
 import { AnySchemaValidator } from '@forklaunch/validator';
 import { OpenAPIObject } from 'openapi3-ts/oas31';
-import { ForklaunchRouter } from './types/forklaunch.types';
+import { ForklaunchRouter } from '../types/router.types';
 /**
  * Generates a Swagger document from given routers.
  *

package/lib/src/http/openApiV3Generator/openApiV3Generator.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"openApiV3Generator.d.ts","sourceRoot":"","sources":["../../../../src/http/openApiV3Generator/openApiV3Generator.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,kBAAkB,EAGnB,MAAM,uBAAuB,CAAC;AAC/B,OAAO,EAEL,aAAa,EAKd,MAAM,mBAAmB,CAAC;AAE3B,OAAO,EAAE,gBAAgB,EAAE,MAAM,uBAAuB,CAAC;AA0FzD;;;;;;;;GAQG;AACH,wBAAgB,uBAAuB,CAAC,EAAE,SAAS,kBAAkB,EACnE,eAAe,EAAE,EAAE,EACnB,IAAI,EAAE,MAAM,GAAG,MAAM,EACrB,OAAO,EAAE,gBAAgB,CAAC,EAAE,CAAC,EAAE,GAC9B,aAAa,CAuGf"}

package/lib/src/http/openApiV3Generator/openApiV3Generator.js

@@ -0,0 +1,169 @@
+import HTTPStatuses from '../utils/httpStatusCodes';
+/**
+ * Capitalizes the first letter of a string.
+ *
+ * @param {string} str - The string to transform.
+ * @returns {string} - The transformed string with the first letter capitalized.
+ */
+function toUpperCase(str) {
+    return str.charAt(0).toUpperCase() + str.slice(1);
+}
+/**
+ * Transforms a base path by ensuring it starts with a slash and capitalizing the first letter.
+ *
+ * @param {string} basePath - The base path to transform.
+ * @returns {string} - The transformed base path.
+ */
+function transformBasePath(basePath) {
+    if (basePath.startsWith('/')) {
+        return toUpperCase(basePath.slice(1));
+    }
+    return `/${basePath}`;
+}
+/**
+ * Creates a Swagger document.
+ *
+ * @param {string | number} port - The port on which the server is running.
+ * @param {TagObject[]} tags - The tags for the Swagger document.
+ * @param {PathObject} paths - The paths for the Swagger document.
+ * @returns {OpenAPIObject} - The Swagger document.
+ */
+function swaggerDocument(port, tags, paths) {
+    return {
+        openapi: '3.1.0',
+        info: {
+            title: process.env.API_TITLE || '',
+            version: process.env.VERSION || '1.0.0'
+        },
+        components: {
+            securitySchemes: {
+                bearer: {
+                    type: 'http',
+                    scheme: 'bearer',
+                    bearerFormat: 'JWT'
+                }
+            }
+        },
+        tags,
+        servers: [
+            {
+                url: `http://localhost:${port}`
+            }
+        ],
+        paths
+    };
+}
+/**
+ * Resolves the content object for a given schema.
+ *
+ * @template SV - A type that extends AnySchemaValidator.
+ * @param {SV} schemaValidator - The schema validator.
+ * @param {IdiomaticSchema<SV>} body - The schema body.
+ * @returns {ContentObject} - The resolved content object.
+ */
+function contentResolver(schemaValidator, body) {
+    const bodySpec = schemaValidator.openapi(body);
+    return body === schemaValidator.string
+        ? {
+            'plain/text': {
+                schema: bodySpec
+            }
+        }
+        : {
+            'application/json': {
+                schema: bodySpec
+            }
+        };
+}
+/**
+ * Generates a Swagger document from given routers.
+ *
+ * @template SV - A type that extends AnySchemaValidator.
+ * @param {SV} schemaValidator - The schema validator.
+ * @param {string | number} port - The port on which the server is running.
+ * @param {ForklaunchRouter<SV>[]} routers - The routers to include in the Swagger document.
+ * @returns {OpenAPIObject} - The generated Swagger document.
+ */
+export function generateSwaggerDocument(schemaValidator, port, routers) {
+    const tags = [];
+    const paths = {};
+    routers.forEach((router) => {
+        const controllerName = transformBasePath(router.basePath);
+        tags.push({
+            name: controllerName,
+            description: `${controllerName} Operations`
+        });
+        router.routes.forEach((route) => {
+            const fullPath = `${router.basePath}${route.path === '/' ? '' : route.path}`.replace(/:(\w+)/g, '{$1}');
+            if (!paths[fullPath]) {
+                paths[fullPath] = {};
+            }
+            const { name, summary, query, requestHeaders } = route.contractDetails;
+            const responses = {};
+            for (const key in route.contractDetails.responses) {
+                responses[key] = {
+                    description: HTTPStatuses[key],
+                    content: contentResolver(schemaValidator, route.contractDetails.responses[key])
+                };
+            }
+            const pathItemObject = {
+                tags: [controllerName],
+                summary: `${name}: ${summary}`,
+                parameters: [],
+                responses
+            };
+            if (route.contractDetails.params) {
+                for (const key in route.contractDetails.params) {
+                    pathItemObject.parameters?.push({
+                        name: key,
+                        in: 'path'
+                    });
+                }
+            }
+            const body = route.contractDetails.body;
+            if (body) {
+                pathItemObject.requestBody = {
+                    required: true,
+                    content: contentResolver(schemaValidator, body)
+                };
+            }
+            if (requestHeaders) {
+                for (const key in requestHeaders) {
+                    pathItemObject.parameters?.push({
+                        name: key,
+                        in: 'header'
+                    });
+                }
+            }
+            if (query) {
+                for (const key in query) {
+                    pathItemObject.parameters?.push({
+                        name: key,
+                        in: 'query'
+                    });
+                }
+            }
+            if (route.contractDetails.auth) {
+                responses[401] = {
+                    description: HTTPStatuses[401],
+                    content: contentResolver(schemaValidator, schemaValidator.string)
+                };
+                responses[403] = {
+                    description: HTTPStatuses[403],
+                    content: contentResolver(schemaValidator, schemaValidator.string)
+                };
+                if (route.contractDetails.auth.method === 'jwt') {
+                    pathItemObject.security = [
+                        {
+                            bearer: Array.from(route.contractDetails.auth.allowedSlugs?.values() || [])
+                        }
+                    ];
+                }
+            }
+            if (route.method !== 'middleware') {
+                paths[fullPath][route.method] = pathItemObject;
+            }
+        });
+    });
+    return swaggerDocument(port, tags, paths);
+}

package/lib/src/http/router/expressLikeRouter.d.ts

@@ -0,0 +1,135 @@
+import { AnySchemaValidator } from '@forklaunch/validator';
+import { ExpressLikeRouter, PathBasedHandler, PathOrMiddlewareBasedHandler } from '../interfaces/expressLikeRouter.interface';
+import { LiveTypeFunction } from '../types/apiDefinition.types';
+import { Body, HeadersObject, Method, ParamsObject, QueryObject, ResponsesObject } from '../types/contractDetails.types';
+import { ContractDetailsOrMiddlewareOrTypedHandler, LiveTypeRouteDefinition, MiddlewareOrMiddlewareWithTypedHandler, TypedMiddlewareDefinition } from '../types/expressLikeRouter.types';
+import { ForklaunchRoute } from '../types/router.types';
+/**
+ * A class that represents an Express-like router.
+ */
+export declare class ForklaunchExpressLikeRouter<SV extends AnySchemaValidator, BasePath extends `/${string}`, RouterHandler, Internal extends ExpressLikeRouter<RouterHandler, Internal>> {
+    #private;
+    readonly schemaValidator: SV;
+    readonly internal: Internal;
+    readonly routes: ForklaunchRoute<SV>[];
+    readonly basePath: BasePath;
+    constructor(basePath: BasePath, schemaValidator: SV, internal: Internal);
+    registerRoute<ContractMethod extends Method, Path extends `/${string}`, P extends ParamsObject<SV>, ResBodyMap extends ResponsesObject<SV>, ReqBody extends Body<SV>, ReqQuery extends QueryObject<SV>, ReqHeaders extends HeadersObject<SV>, ResHeaders extends HeadersObject<SV>, LocalsObj extends Record<string, unknown>>(method: ContractMethod, path: Path, registrationMethod: PathBasedHandler<RouterHandler>, contractDetailsOrMiddlewareOrTypedHandler: ContractDetailsOrMiddlewareOrTypedHandler<SV, ContractMethod, Path, P, ResBodyMap, ReqBody, ReqQuery, ReqHeaders, ResHeaders, LocalsObj>, ...middlewareOrMiddlewareAndTypedHandler: MiddlewareOrMiddlewareWithTypedHandler<SV, ContractMethod, Path, P, ResBodyMap, ReqBody, ReqQuery, ReqHeaders, ResHeaders, LocalsObj>[]): LiveTypeFunction<SV, `${BasePath}${Path}`, P, ResBodyMap, ReqBody, ReqQuery, ReqHeaders, ResHeaders>;
+    registerMiddlewareHandler<Path extends `/${string}`, P extends ParamsObject<SV>, ResBodyMap extends ResponsesObject<SV>, ReqBody extends Body<SV>, ReqQuery extends QueryObject<SV>, ReqHeaders extends HeadersObject<SV>, ResHeaders extends HeadersObject<SV>, LocalsObj extends Record<string, unknown>>(registrationMethod: PathOrMiddlewareBasedHandler<RouterHandler>, pathOrContractDetailsOrMiddlewareOrTypedHandler: Path | ContractDetailsOrMiddlewareOrTypedHandler<SV, 'middleware', Path, P, ResBodyMap, ReqBody, ReqQuery, ReqHeaders, ResHeaders, LocalsObj>, contractDetailsOrMiddlewareOrTypedHandler?: ContractDetailsOrMiddlewareOrTypedHandler<SV, 'middleware', Path, P, ResBodyMap, ReqBody, ReqQuery, ReqHeaders, ResHeaders, LocalsObj>, ...middlewareOrMiddlewareWithTypedHandler: MiddlewareOrMiddlewareWithTypedHandler<SV, 'middleware', Path, P, ResBodyMap, ReqBody, ReqQuery, ReqHeaders, ResHeaders, LocalsObj>[]): this;
+    use: TypedMiddlewareDefinition<this, SV>;
+    all: TypedMiddlewareDefinition<this, SV>;
+    connect: TypedMiddlewareDefinition<this, SV>;
+    /**
+     * Registers a GET route with the specified contract details and handler handlers.
+     *
+     * @template P - The type of request parameters.
+     * @template ResBodyMap - The type of response body.
+     * @template ReqBody - The type of request body.
+     * @template ReqQuery - The type of request query.
+     * @template LocalsObj - The type of local variables.
+     * @param {string} path - The path for the route.
+     * @param {PathParamHttpContractDetails<SV, P, ResBodyMap, ReqQuery>} contractDetails - The contract details.
+     * @param {...SchemaHandler<SV, P, ResBodyMap, ReqBody, ReqQuery, LocalsObj>[]} handlers - The handler handlers.
+     * @returns {ExpressRouter} - The Express router.
+     */
+    get: LiveTypeRouteDefinition<SV, BasePath, 'get'>;
+    /**
+     * Registers a POST route with the specified contract details and handler handlers.
+     *
+     * @template P - The type of request parameters.
+     * @template ResBodyMap - The type of response body.
+     * @template ReqBody - The type of request body.
+     * @template ReqQuery - The type of request query.
+     * @template LocalsObj - The type of local variables.
+     * @param {string} path - The path for the route.
+     * @param {HttpContractDetails<SV, P, ResBodyMap, ReqBody, ReqQuery>} contractDetails - The contract details.
+     * @param {...SchemaHandler<SV, P, ResBodyMap, ReqBody, ReqQuery, LocalsObj>[]} handlers - The handler handlers.
+     * @returns {ExpressRouter} - The Expxwress router.
+     */
+    post: LiveTypeRouteDefinition<SV, BasePath, 'post'>;
+    /**
+     * Registers a PUT route with the specified contract details and handler handlers.
+     *
+     * @template P - The type of request parameters.
+     * @template ResBodyMap - The type of response body.
+     * @template ReqBody - The type of request body.
+     * @template ReqQuery - The type of request query.
+     * @template LocalsObj - The type of local variables.
+     * @param {string} path - The path for the route.
+     * @param {HttpContractDetails<SV, P, ResBodyMap, ReqBody, ReqQuery>} contractDetails - The contract details.
+     * @param {...SchemaHandler<SV, P, ResBodyMap, ReqBody, ReqQuery, LocalsObj>[]} handlers - The handler handlers.
+     * @returns {ExpressRouter} - The Express router.
+     */
+    put: LiveTypeRouteDefinition<SV, BasePath, 'put'>;
+    /**
+     * Registers a PATCH route with the specified contract details and handler handlers.
+     *
+     * @template P - The type of request parameters.
+     * @template ResBodyMap - The type of response body.
+     * @template ReqBody - The type of request body.
+     * @template ReqQuery - The type of request query.
+     * @template LocalsObj - The type of local variables.
+     * @param {string} path - The path for the route.
+     * @param {HttpContractDetails<SV, P, ResBodyMap, ReqBody, ReqQuery>} contractDetails - The contract details.
+     * @param {...SchemaHandler<SV, P, ResBodyMap, ReqBody, ReqQuery, LocalsObj>[]} handlers - The handler handlers.
+     * @returns {ExpressRouter} - The Express router.
+     */
+    patch: LiveTypeRouteDefinition<SV, BasePath, 'patch'>;
+    /**
+     * Registers a DELETE route with the specified contract details and handler handlers.
+     *
+     * @template P - The type of request parameters.
+     * @template ResBodyMap - The type of response body.
+     * @template ReqBody - The type of request body.
+     * @template ReqQuery - The type of request query.
+     * @template LocalsObj - The type of local variables.
+     * @param {string} path - The path for the route.
+     * @param {PathParamHttpContractDetails<SV, P, ResBodyMap, ReqQuery>} contractDetails - The contract details.
+     * @param {...SchemaHandler<SV, P, ResBodyMap, ReqBody, ReqQuery, LocalsObj>[]} handlers - The handler handlers.
+     * @returns {ExpressRouter} - The Express router.
+     */
+    delete: LiveTypeRouteDefinition<SV, BasePath, 'delete'>;
+    /**
+     * Registers a OPTIONS route with the specified contract details and handler handlers.
+     *
+     * @template P - The type of request parameters.
+     * @template ResBodyMap - The type of response body.
+     * @template ReqBody - The type of request body.
+     * @template ReqQuery - The type of request query.
+     * @template LocalsObj - The type of local variables.
+     * @param {string} path - The path for the route.
+     * @param {PathParamHttpContractDetails<SV, P, ResBodyMap, ReqQuery>} contractDetails - The contract details.
+     * @param {...SchemaHandler<SV, P, ResBodyMap, ReqBody, ReqQuery, LocalsObj>[]} handlers - The handler handlers.
+     * @returns {ExpressRouter} - The Express router.
+     */
+    options: LiveTypeRouteDefinition<SV, BasePath, 'options'>;
+    /**
+     * Registers a HEAD route with the specified contract details and handler handlers.
+     *
+     * @template P - The type of request parameters.
+     * @template ResBodyMap - The type of response body.
+     * @template ReqBody - The type of request body.
+     * @template ReqQuery - The type of request query.
+     * @template LocalsObj - The type of local variables.
+     * @param {string} path - The path for the route.
+     * @param {PathParamHttpContractDetails<SV, P, ResBodyMap, ReqQuery>} contractDetails - The contract details.
+     * @param {...SchemaHandler<SV, P, ResBodyMap, ReqBody, ReqQuery, LocalsObj>[]} handlers - The handler handlers.
+     * @returns {ExpressRouter} - The Express router.
+     */
+    head: LiveTypeRouteDefinition<SV, BasePath, 'head'>;
+    /**
+     * Registers a TRACE route with the specified contract details and handler handlers.
+     *
+     * @template P - The type of request parameters.
+     * @template ResBodyMap - The type of response body.
+     * @template ReqBody - The type of request body.
+     * @template ReqQuery - The type of request query.
+     * @template LocalsObj - The type of local variables.
+     * @param {string} path - The path for the route.
+     * @param {PathParamHttpContractDetails<SV, P, ResBodyMap, ReqQuery>} contractDetails - The contract details.
+     * @param {...SchemaHandler<SV, P, ResBodyMap, ReqBody, ReqQuery, LocalsObj>[]} handlers - The handler handlers.
+     * @returns {ExpressRouter} - The Express router.
+     */
+    trace: LiveTypeRouteDefinition<SV, BasePath, 'trace'>;
+}
+//# sourceMappingURL=expressLikeRouter.d.ts.map

package/lib/src/http/router/expressLikeRouter.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"expressLikeRouter.d.ts","sourceRoot":"","sources":["../../../../src/http/router/expressLikeRouter.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,kBAAkB,EAAmB,MAAM,uBAAuB,CAAC;AAM5E,OAAO,EACL,iBAAiB,EACjB,gBAAgB,EAChB,4BAA4B,EAC7B,MAAM,2CAA2C,CAAC;AAKnD,OAAO,EAGL,gBAAgB,EACjB,MAAM,8BAA8B,CAAC;AACtC,OAAO,EACL,IAAI,EAEJ,aAAa,EAEb,MAAM,EAEN,YAAY,EAEZ,WAAW,EAEX,eAAe,EAChB,MAAM,gCAAgC,CAAC;AACxC,OAAO,EACL,yCAAyC,EACzC,uBAAuB,EACvB,sCAAsC,EACtC,yBAAyB,EAC1B,MAAM,kCAAkC,CAAC;AAC1C,OAAO,EAAE,eAAe,EAAE,MAAM,uBAAuB,CAAC;AAExD;;GAEG;AACH,qBAAa,2BAA2B,CACtC,EAAE,SAAS,kBAAkB,EAC7B,QAAQ,SAAS,IAAI,MAAM,EAAE,EAC7B,aAAa,EACb,QAAQ,SAAS,iBAAiB,CAAC,aAAa,EAAE,QAAQ,CAAC;;IAOzD,QAAQ,CAAC,eAAe,EAAE,EAAE;IAC5B,QAAQ,CAAC,QAAQ,EAAE,QAAQ;IAN7B,QAAQ,CAAC,MAAM,EAAE,eAAe,CAAC,EAAE,CAAC,EAAE,CAAM;IAC5C,QAAQ,CAAC,QAAQ,EAAE,QAAQ,CAAC;gBAG1B,QAAQ,EAAE,QAAQ,EACT,eAAe,EAAE,EAAE,EACnB,QAAQ,EAAE,QAAQ;IAmW7B,aAAa,CACX,cAAc,SAAS,MAAM,EAC7B,IAAI,SAAS,IAAI,MAAM,EAAE,EACzB,CAAC,SAAS,YAAY,CAAC,EAAE,CAAC,EAC1B,UAAU,SAAS,eAAe,CAAC,EAAE,CAAC,EACtC,OAAO,SAAS,IAAI,CAAC,EAAE,CAAC,EACxB,QAAQ,SAAS,WAAW,CAAC,EAAE,CAAC,EAChC,UAAU,SAAS,aAAa,CAAC,EAAE,CAAC,EACpC,UAAU,SAAS,aAAa,CAAC,EAAE,CAAC,EACpC,SAAS,SAAS,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,EAEzC,MAAM,EAAE,cAAc,EACtB,IAAI,EAAE,IAAI,EACV,kBAAkB,EAAE,gBAAgB,CAAC,aAAa,CAAC,EACnD,yCAAyC,EAAE,yCAAyC,CAClF,EAAE,EACF,cAAc,EACd,IAAI,EACJ,CAAC,EACD,UAAU,EACV,OAAO,EACP,QAAQ,EACR,UAAU,EACV,UAAU,EACV,SAAS,CACV,EACD,GAAG,qCAAqC,EAAE,sCAAsC,CAC9E,EAAE,EACF,cAAc,EACd,IAAI,EACJ,CAAC,EACD,UAAU,EACV,OAAO,EACP,QAAQ,EACR,UAAU,EACV,UAAU,EACV,SAAS,CACV,EAAE,GACF,gBAAgB,CACjB,EAAE,EACF,GAAG,QAAQ,GAAG,IAAI,EAAE,EACpB,CAAC,EACD,UAAU,EACV,OAAO,EACP,QAAQ,EACR,UAAU,EACV,UAAU,CACX;IA4UD,yBAAyB,CACvB,IAAI,SAAS,IAAI,MAAM,EAAE,EACzB,CAAC,SAAS,YAAY,CAAC,EAAE,CAAC,EAC1B,UAAU,SAAS,eAAe,CAAC,EAAE,CAAC,EACtC,OAAO,SAAS,IAAI,CAAC,EAAE,CAAC,EACxB,QAAQ,SAAS,WAAW,CAAC,EAAE,CAAC,EAChC,UAAU,SAAS,aAAa,CAAC,EAAE,CAAC,EACpC,UAAU,SAAS,aAAa,CAAC,EAAE,CAAC,EACpC,SAAS,SAAS,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,EAEzC,kBAAkB,EAAE,4BAA4B,CAAC,aAAa,CAAC,EAC/D,+CAA+C,EAC3C,IAAI,GACJ,yCAAyC,CACvC,EAAE,EACF,YAAY,EACZ,IAAI,EACJ,CAAC,EACD,UAAU,EACV,OAAO,EACP,QAAQ,EACR,UAAU,EACV,UAAU,EACV,SAAS,CACV,EACL,yCAAyC,CAAC,EAAE,yCAAyC,CACnF,EAAE,EACF,YAAY,EACZ,IAAI,EACJ,CAAC,EACD,UAAU,EACV,OAAO,EACP,QAAQ,EACR,UAAU,EACV,UAAU,EACV,SAAS,CACV,EACD,GAAG,sCAAsC,EAAE,sCAAsC,CAC/E,EAAE,EACF,YAAY,EACZ,IAAI,EACJ,CAAC,EACD,UAAU,EACV,OAAO,EACP,QAAQ,EACR,UAAU,EACV,UAAU,EACV,SAAS,CACV,EAAE,GACF,IAAI;IAkEP,GAAG,EAAE,yBAAyB,CAAC,IAAI,EAAE,EAAE,CAAC,CAgEtC;IAEF,GAAG,EAAE,yBAAyB,CAAC,IAAI,EAAE,EAAE,CAAC,CAgEtC;IAEF,OAAO,EAAE,yBAAyB,CAAC,IAAI,EAAE,EAAE,CAAC,CAgE1C;IAEF;;;;;;;;;;;;OAYG;IACH,GAAG,EAAE,uBAAuB,CAAC,EAAE,EAAE,QAAQ,EAAE,KAAK,CAAC,CAuD/C;IAEF;;;;;;;;;;;;OAYG;IACH,IAAI,EAAE,uBAAuB,CAAC,EAAE,EAAE,QAAQ,EAAE,MAAM,CAAC,CAuDjD;IAEF;;;;;;;;;;;;OAYG;IACH,GAAG,EAAE,uBAAuB,CAAC,EAAE,EAAE,QAAQ,EAAE,KAAK,CAAC,CAuD/C;IAEF;;;;;;;;;;;;OAYG;IACH,KAAK,EAAE,uBAAuB,CAAC,EAAE,EAAE,QAAQ,EAAE,OAAO,CAAC,CAuDnD;IAEF;;;;;;;;;;;;OAYG;IACH,MAAM,EAAE,uBAAuB,CAAC,EAAE,EAAE,QAAQ,EAAE,QAAQ,CAAC,CAuDrD;IAEF;;;;;;;;;;;;OAYG;IACH,OAAO,EAAE,uBAAuB,CAAC,EAAE,EAAE,QAAQ,EAAE,SAAS,CAAC,CAuDvD;IAEF;;;;;;;;;;;;OAYG;IACH,IAAI,EAAE,uBAAuB,CAAC,EAAE,EAAE,QAAQ,EAAE,MAAM,CAAC,CAuDjD;IAEF;;;;;;;;;;;;OAYG;IACH,KAAK,EAAE,uBAAuB,CAAC,EAAE,EAAE,QAAQ,EAAE,OAAO,CAAC,CAuDnD;CACH"}