@forklaunch/core 0.2.37 → 0.3.0

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

@@ -1,32 +0,0 @@
-import { AnySchemaValidator } from '@forklaunch/validator';
-import { HttpContractDetails, Method, PathParamHttpContractDetails } from './contractDetails.types';
-export interface ConstrainedForklaunchRouter<SV extends AnySchemaValidator, RequestHandler> extends ForklaunchRouter<SV> {
-    requestHandler: RequestHandler;
-}
-/**
- * Interface representing a Forklaunch router.
- *
- * @template SV - A type that extends AnySchemaValidator.
- */
-export interface ForklaunchRouter<SV extends AnySchemaValidator> {
-    /** The base path for the router */
-    basePath: `/${string}`;
-    /** The routes associated with the router */
-    routes: ForklaunchRoute<SV>[];
-}
-/**
- * Interface representing a Forklaunch route.
- *
- * @template SV - A type that extends AnySchemaValidator.
- */
-export interface ForklaunchRoute<SV extends AnySchemaValidator> {
-    /** The base path for the route */
-    basePath: string;
-    /** The path for the route, which can be a string, RegExp, or an array of strings or RegExps */
-    path: string | RegExp | (string | RegExp)[];
-    /** The HTTP method for the route */
-    method: Method;
-    /** The contract details for the route */
-    contractDetails: PathParamHttpContractDetails<SV> | HttpContractDetails<SV>;
-}
-//# sourceMappingURL=router.types.d.ts.map

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

@@ -1 +0,0 @@
-{"version":3,"file":"router.types.d.ts","sourceRoot":"","sources":["../../../../src/http/types/router.types.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,kBAAkB,EAAE,MAAM,uBAAuB,CAAC;AAC3D,OAAO,EACL,mBAAmB,EACnB,MAAM,EACN,4BAA4B,EAC7B,MAAM,yBAAyB,CAAC;AAEjC,MAAM,WAAW,2BAA2B,CAC1C,EAAE,SAAS,kBAAkB,EAC7B,cAAc,CACd,SAAQ,gBAAgB,CAAC,EAAE,CAAC;IAC5B,cAAc,EAAE,cAAc,CAAC;CAChC;AAED;;;;GAIG;AACH,MAAM,WAAW,gBAAgB,CAAC,EAAE,SAAS,kBAAkB;IAC7D,mCAAmC;IACnC,QAAQ,EAAE,IAAI,MAAM,EAAE,CAAC;IACvB,4CAA4C;IAC5C,MAAM,EAAE,eAAe,CAAC,EAAE,CAAC,EAAE,CAAC;CAC/B;AAED;;;;GAIG;AACH,MAAM,WAAW,eAAe,CAAC,EAAE,SAAS,kBAAkB;IAC5D,kCAAkC;IAClC,QAAQ,EAAE,MAAM,CAAC;IACjB,+FAA+F;IAC/F,IAAI,EAAE,MAAM,GAAG,MAAM,GAAG,CAAC,MAAM,GAAG,MAAM,CAAC,EAAE,CAAC;IAC5C,oCAAoC;IACpC,MAAM,EAAE,MAAM,CAAC;IACf,yCAAyC;IACzC,eAAe,EAAE,4BAA4B,CAAC,EAAE,CAAC,GAAG,mBAAmB,CAAC,EAAE,CAAC,CAAC;CAC7E"}

package/lib/src/http/types/router.types.js

@@ -1 +0,0 @@
-export {};

package/lib/src/http/types/typedHandler.types.d.ts

@@ -1,10 +0,0 @@
-import { AnySchemaValidator } from '@forklaunch/validator';
-import { ExpressLikeSchemaHandler } from '../types/apiDefinition.types';
-import { Body, ContractDetails, HeadersObject, Method, ParamsObject, QueryObject, ResponsesObject } from '../types/contractDetails.types';
-export type ContractDetailsExpressLikeSchemaHandler<SV extends AnySchemaValidator, 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>> = ExpressLikeSchemaHandler<SV, P, ResBodyMap, ReqBody, ReqQuery, ReqHeaders, ResHeaders, LocalsObj>;
-export type TypedHandler<SV extends AnySchemaValidator, 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>> = {
-    _typedHandler: true;
-    contractDetails: ContractDetails<SV, ContractMethod, Path, P, ResBodyMap, ReqBody, ReqQuery, ReqHeaders, ResHeaders>;
-    handlers: ContractDetailsExpressLikeSchemaHandler<SV, P, ResBodyMap, ReqBody, ReqQuery, ReqHeaders, ResHeaders, LocalsObj>[];
-};
-//# sourceMappingURL=typedHandler.types.d.ts.map

package/lib/src/http/types/typedHandler.types.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"typedHandler.types.d.ts","sourceRoot":"","sources":["../../../../src/http/types/typedHandler.types.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,kBAAkB,EAAE,MAAM,uBAAuB,CAAC;AAC3D,OAAO,EAAE,wBAAwB,EAAE,MAAM,8BAA8B,CAAC;AACxE,OAAO,EACL,IAAI,EACJ,eAAe,EACf,aAAa,EACb,MAAM,EACN,YAAY,EACZ,WAAW,EACX,eAAe,EAChB,MAAM,gCAAgC,CAAC;AAGxC,MAAM,MAAM,uCAAuC,CACjD,EAAE,SAAS,kBAAkB,EAC7B,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,IACvC,wBAAwB,CAC1B,EAAE,EACF,CAAC,EACD,UAAU,EACV,OAAO,EACP,QAAQ,EACR,UAAU,EACV,UAAU,EACV,SAAS,CACV,CAAC;AAEF,MAAM,MAAM,YAAY,CACtB,EAAE,SAAS,kBAAkB,EAC7B,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,IACvC;IACF,aAAa,EAAE,IAAI,CAAC;IACpB,eAAe,EAAE,eAAe,CAC9B,EAAE,EACF,cAAc,EACd,IAAI,EACJ,CAAC,EACD,UAAU,EACV,OAAO,EACP,QAAQ,EACR,UAAU,EACV,UAAU,CACX,CAAC;IAEF,QAAQ,EAAE,uCAAuC,CAC/C,EAAE,EACF,CAAC,EACD,UAAU,EACV,OAAO,EACP,QAAQ,EACR,UAAU,EACV,UAAU,EACV,SAAS,CACV,EAAE,CAAC;CACL,CAAC"}

package/lib/src/http/types/typedHandler.types.js

@@ -1 +0,0 @@
-export {};

package/lib/src/http/utils/enrichExpressLikeSend.d.ts

@@ -1,32 +0,0 @@
-import { AnySchemaValidator } from '@forklaunch/validator';
-import { ParsedQs } from 'qs';
-import { ForklaunchRequest, ForklaunchResHeaders, ForklaunchResponse, ForklaunchSendableData, ForklaunchStatusResponse } from '../types/apiDefinition.types';
-import { ParamsDictionary } from '../types/contractDetails.types';
-/**
- * Enhances the Express-like `send` method with additional logic for response handling and validation.
- *
- * This function intercepts the `send` method to provide custom behavior, including response validation
- * through the `parseResponse` middleware. If the response status is 404, it sends a "Not Found" message.
- * If the response validation fails, it sends a parsing error message. Otherwise, it calls the original `send`
- * method with the provided data.
- *
- * @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 {unknown} instance - The context (typically `this`) in which the original `send` method is called.
- * @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 {Function} originalSend - The original `send` method from the response object, to be called after custom logic.
- * @param {string | ArrayBuffer | ArrayBufferView | NodeJS.ReadableStream | null | undefined} data - The data to be sent as the response body.
- * @param {boolean} shouldEnrich - A flag indicating whether the response should be sent immediately.
- *
- * @returns {unknown} The return value of the original `send` method, typically the response itself.
- */
-export declare function enrichExpressLikeSend<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>>(instance: unknown, req: ForklaunchRequest<SV, P, ReqBody, ReqQuery, ReqHeaders>, res: ForklaunchResponse<ResBodyMap, ForklaunchResHeaders & ResHeaders, LocalsObj>, originalSend: ForklaunchStatusResponse<ForklaunchSendableData>['send'], data: ForklaunchSendableData, shouldEnrich: boolean): void;
-//# sourceMappingURL=enrichExpressLikeSend.d.ts.map

package/lib/src/http/utils/enrichExpressLikeSend.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"enrichExpressLikeSend.d.ts","sourceRoot":"","sources":["../../../../src/http/utils/enrichExpressLikeSend.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,kBAAkB,EAAE,MAAM,uBAAuB,CAAC;AAC3D,OAAO,EAAE,QAAQ,EAAE,MAAM,IAAI,CAAC;AAE9B,OAAO,EACL,iBAAiB,EACjB,oBAAoB,EACpB,kBAAkB,EAClB,sBAAsB,EACtB,wBAAwB,EACzB,MAAM,8BAA8B,CAAC;AACtC,OAAO,EAAE,gBAAgB,EAAE,MAAM,gCAAgC,CAAC;AAElE;;;;;;;;;;;;;;;;;;;;;;;;;GAyBG;AACH,wBAAgB,qBAAqB,CACnC,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,QAAQ,EAAE,OAAO,EACjB,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,YAAY,EAAE,wBAAwB,CAAC,sBAAsB,CAAC,CAAC,MAAM,CAAC,EACtE,IAAI,EAAE,sBAAsB,EAC5B,YAAY,EAAE,OAAO,QAyBtB"}

package/lib/src/http/utils/enrichExpressLikeSend.js

@@ -1,50 +0,0 @@
-import { parse } from '../middleware/response/parse.middleware';
-/**
- * Enhances the Express-like `send` method with additional logic for response handling and validation.
- *
- * This function intercepts the `send` method to provide custom behavior, including response validation
- * through the `parseResponse` middleware. If the response status is 404, it sends a "Not Found" message.
- * If the response validation fails, it sends a parsing error message. Otherwise, it calls the original `send`
- * method with the provided data.
- *
- * @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 {unknown} instance - The context (typically `this`) in which the original `send` method is called.
- * @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 {Function} originalSend - The original `send` method from the response object, to be called after custom logic.
- * @param {string | ArrayBuffer | ArrayBufferView | NodeJS.ReadableStream | null | undefined} data - The data to be sent as the response body.
- * @param {boolean} shouldEnrich - A flag indicating whether the response should be sent immediately.
- *
- * @returns {unknown} The return value of the original `send` method, typically the response itself.
- */
-export function enrichExpressLikeSend(instance, req, res, originalSend, data, shouldEnrich) {
-    let parseErrorSent;
-    if (shouldEnrich) {
-        if (res.statusCode === 404) {
-            res.status(404);
-            originalSend.call(instance, 'Not Found');
-        }
-        parse(req, res, (err) => {
-            if (err) {
-                let errorString = err.message;
-                if (res.locals.errorMessage) {
-                    errorString += `\n------------------\n${res.locals.errorMessage}`;
-                }
-                res.status(500);
-                originalSend.call(instance, errorString);
-                parseErrorSent = true;
-            }
-        });
-    }
-    if (!parseErrorSent) {
-        originalSend.call(instance, data);
-    }
-}

package/lib/src/http/utils/httpStatusCodes.d.ts

@@ -1,75 +0,0 @@
-/**
- * Object-map of the HTTP Status Codes. Maps from the status code, to the
- * textual name. The key is the HTTP Status Code number, and the resulting
- * value will be the textual name for that Status Code.
- *
- * The comments for each item are taken from httpstatuses.com and the RFC-7231
- * document.
- *
- * @see https://httpstatuses.com
- * @see https://datatracker.ietf.org/doc/html/rfc7231
- */
-export declare const HTTPStatuses: Readonly<{
-    [key: number]: string;
-}>;
-/**
- * Numerical HTTP status code.
- */
-export type StatusCode = keyof typeof HTTPStatuses;
-/**
- * Checks if the given numerical status code is in the known HTTP status codes
- * list.
- *
- * @param code HTTP Status code
- * @returns True if the code is a valid HTTP status code
- */
-export declare const isValidStatusCode: (code: number) => boolean;
-/**
- * Checks if the given status code is in the informational range (1XX).
- *
- * @param code HTTP Status code
- * @returns True if the code is in the "informational" range.
- */
-export declare const isInformational: (code: StatusCode) => boolean;
-/**
- * Checks if the given status code is in the successful range (2XX).
- *
- * @param code HTTP Status code
- * @returns True if the code is in the "success" range.
- */
-export declare const isSuccessful: (code: StatusCode) => boolean;
-/**
- * Checks if the given status code is in the redirection range (3XX).
- *
- * @param code HTTP Status code
- * @returns True if the code is in the "redirection" range.
- */
-export declare const isRedirection: (code: StatusCode) => boolean;
-/**
- * Checks if the given status code is in the client error range (4XX).
- *
- * @param code HTTP Status code
- * @returns True if the code is in the "client error" range.
- */
-export declare const isClientError: (code: StatusCode) => boolean;
-/**
- * Checks if the given status code is in the server error range (5XX).
- *
- * @param code HTTP Status code
- * @returns True if the code is in the "server error" range.
- */
-export declare const isServerError: (code: StatusCode) => boolean;
-/**
- * Searches the list of HTTP statuses for a matching textual name to the one
- * provided. If a match is found, then the numerical status code is returned,
- * otherwise `null`.
- *
- * Internally, the parameter and the status names are normalized by lower-casing
- * the strings and trimming space.
- *
- * @param status HTTP Status textual name
- * @returns The numerical status code, or null if not found
- */
-export declare const getCodeForStatus: (status: string) => null | StatusCode;
-export default HTTPStatuses;
-//# sourceMappingURL=httpStatusCodes.d.ts.map

package/lib/src/http/utils/httpStatusCodes.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"httpStatusCodes.d.ts","sourceRoot":"","sources":["../../../../src/http/utils/httpStatusCodes.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;GAUG;AACH,eAAO,MAAM,YAAY,EAAE,QAAQ,CAAC;IAAE,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAAA;CAAE,CAmgCnD,CAAC;AAEX;;GAEG;AACH,MAAM,MAAM,UAAU,GAAG,MAAM,OAAO,YAAY,CAAC;AAEnD;;;;;;GAMG;AACH,eAAO,MAAM,iBAAiB,SAAU,MAAM,KAAG,OAC3B,CAAC;AAEvB;;;;;GAKG;AACH,eAAO,MAAM,eAAe,SAAU,UAAU,KAAG,OACxB,CAAC;AAE5B;;;;;GAKG;AACH,eAAO,MAAM,YAAY,SAAU,UAAU,KAAG,OACrB,CAAC;AAE5B;;;;;GAKG;AACH,eAAO,MAAM,aAAa,SAAU,UAAU,KAAG,OACtB,CAAC;AAE5B;;;;;GAKG;AACH,eAAO,MAAM,aAAa,SAAU,UAAU,KAAG,OACtB,CAAC;AAE5B;;;;;GAKG;AACH,eAAO,MAAM,aAAa,SAAU,UAAU,KAAG,OAAsB,CAAC;AAExE;;;;;;;;;;GAUG;AACH,eAAO,MAAM,gBAAgB,WAAY,MAAM,KAAG,IAAI,GAAG,UAOxD,CAAC;AAEF,eAAe,YAAY,CAAC"}