@forklaunch/core 0.2.6 → 0.2.7

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

@@ -1,52 +0,0 @@
-/**
- * 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, 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/dist/lib/src/http/middleware/response.middleware.d.ts

@@ -1,27 +0,0 @@
-/**
- * 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<SV, P, ResBodyMap, ReqBody, ReqQuery, ReqHeaders, ResHeaders, LocalsObj>(req: ForklaunchRequest<SV, P, ReqBody, ReqQuery, ReqHeaders>, res: ForklaunchResponse<ResBodyMap, ForklaunchResHeaders & ResHeaders, LocalsObj>, next?: any): void;
-//# sourceMappingURL=response.middleware.d.ts.map

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

@@ -1 +0,0 @@
-{"version":3,"file":"response.middleware.d.ts","sourceRoot":"","sources":["../../../../../../dist/lib/src/http/middleware/response.middleware.js"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;;;GAwBG;AACH,8BAfa,EAAE,EACF,CAAC,EACD,UAAU,EACV,OAAO,EACP,QAAQ,EACR,UAAU,EACV,UAAU,EACV,SAAS,OAEX,iBAAiB,CAAC,EAAE,EAAE,CAAC,EAAE,OAAO,EAAE,QAAQ,EAAE,UAAU,CAAC,OACvD,kBAAkB,CAAC,UAAU,EAAE,oBAAoB,GAAG,UAAU,EAAE,SAAS,CAAC,eAG1E,IAAI,CA4BhB"}

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

@@ -1,52 +0,0 @@
-/**
- * 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/dist/lib/src/http/openApiV3Generator/index.d.ts

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

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

@@ -1 +0,0 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../../../dist/lib/src/http/openApiV3Generator/index.js"],"names":[],"mappings":""}

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

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

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

@@ -1,11 +0,0 @@
-/**
- * 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<SV>(schemaValidator: SV, port: string | number, routers: ForklaunchRouter<SV>[]): OpenAPIObject;
-//# sourceMappingURL=openApiV3Generator.d.ts.map

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

@@ -1 +0,0 @@
-{"version":3,"file":"openApiV3Generator.d.ts","sourceRoot":"","sources":["../../../../../../dist/lib/src/http/openApiV3Generator/openApiV3Generator.js"],"names":[],"mappings":"AA6EA;;;;;;;;GAQG;AACH,wCANa,EAAE,mBACJ,EAAE,QACF,MAAM,GAAG,MAAM,WACf,gBAAgB,CAAC,EAAE,CAAC,EAAE,GACpB,aAAa,CAkFzB"}

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

@@ -1,167 +0,0 @@
-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() || [])
-                        }
-                    ];
-                }
-            }
-            paths[fullPath][route.method] = pathItemObject;
-        });
-    });
-    return swaggerDocument(port, tags, paths);
-}

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

@@ -1,89 +0,0 @@
-/**
- * A class that represents an Express-like router.
- */
-export class ForklaunchExpressLikeRouter {
-    constructor(basePath: any, schemaValidator: any, internal: any);
-    schemaValidator: any;
-    internal: any;
-    routes: any[];
-    basePath: any;
-    /**
-     * Registers middleware to the router.
-     *
-     * @param {...unknown[]} args - The middleware to register.
-     * @returns {this} - The router instance.
-     */
-    use(...args: unknown[][]): this;
-    /**
-     * Registers a GET route with the specified contract details and handler functions.
-     *
-     * @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 {...SchemaMiddlewareHandler<SV, P, ResBodyMap, ReqBody, ReqQuery, LocalsObj>[]} functions - The handler functions.
-     * @returns {ExpressRouter} - The Express router.
-     */
-    get<P, ResBodyMap, ReqBody, ReqQuery, LocalsObj>(path: string, contractDetailsOrTypedHandler: any, ...functions: SchemaMiddlewareHandler<SV, P, ResBodyMap, ReqBody, ReqQuery, LocalsObj>[][]): ExpressRouter;
-    /**
-     * Registers a POST route with the specified contract details and handler functions.
-     *
-     * @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 {...SchemaMiddlewareHandler<SV, P, ResBodyMap, ReqBody, ReqQuery, LocalsObj>[]} functions - The handler functions.
-     * @returns {ExpressRouter} - The Express router.
-     */
-    post<P, ResBodyMap, ReqBody, ReqQuery, LocalsObj>(path: string, contractDetailsOrTypedHandler: any, ...functions: SchemaMiddlewareHandler<SV, P, ResBodyMap, ReqBody, ReqQuery, LocalsObj>[][]): ExpressRouter;
-    /**
-     * Registers a PUT route with the specified contract details and handler functions.
-     *
-     * @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 {...SchemaMiddlewareHandler<SV, P, ResBodyMap, ReqBody, ReqQuery, LocalsObj>[]} functions - The handler functions.
-     * @returns {ExpressRouter} - The Express router.
-     */
-    put<P, ResBodyMap, ReqBody, ReqQuery, LocalsObj>(path: string, contractDetailsOrTypedHandler: any, ...functions: SchemaMiddlewareHandler<SV, P, ResBodyMap, ReqBody, ReqQuery, LocalsObj>[][]): ExpressRouter;
-    /**
-     * Registers a PATCH route with the specified contract details and handler functions.
-     *
-     * @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 {...SchemaMiddlewareHandler<SV, P, ResBodyMap, ReqBody, ReqQuery, LocalsObj>[]} functions - The handler functions.
-     * @returns {ExpressRouter} - The Express router.
-     */
-    patch<P, ResBodyMap, ReqBody, ReqQuery, LocalsObj>(path: string, contractDetailsOrTypedHandler: any, ...functions: SchemaMiddlewareHandler<SV, P, ResBodyMap, ReqBody, ReqQuery, LocalsObj>[][]): ExpressRouter;
-    /**
-     * Registers a DELETE route with the specified contract details and handler functions.
-     *
-     * @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 {...SchemaMiddlewareHandler<SV, P, ResBodyMap, ReqBody, ReqQuery, LocalsObj>[]} functions - The handler functions.
-     * @returns {ExpressRouter} - The Express router.
-     */
-    delete<P, ResBodyMap, ReqBody, ReqQuery, LocalsObj>(path: string, contractDetailsOrTypedHandler: any, ...functions: SchemaMiddlewareHandler<SV, P, ResBodyMap, ReqBody, ReqQuery, LocalsObj>[][]): ExpressRouter;
-    #private;
-}
-//# sourceMappingURL=expressLikeRouter.d.ts.map

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

@@ -1 +0,0 @@
-{"version":3,"file":"expressLikeRouter.d.ts","sourceRoot":"","sources":["../../../../../../dist/lib/src/http/router/expressLikeRouter.js"],"names":[],"mappings":"AAMA;;GAEG;AACH;IAKI,gEAMC;IAVD,qBAAgB;IAChB,cAAS;IACT,cAAY;IACZ,cAAS;IAyFT;;;;;OAKG;IACH,aAHc,OAAO,EAAE,EAAA,GACV,IAAI,CAKhB;IAwHD;;;;;;;;;;;;OAYG;IACH,IAVa,CAAC,EACD,UAAU,EACV,OAAO,EACP,QAAQ,EACR,SAAS,QACX,MAAM,oDAEH,uBAAuB,CAAC,EAAE,EAAE,CAAC,EAAE,UAAU,EAAE,OAAO,EAAE,QAAQ,EAAE,SAAS,CAAC,EAAE,EAAA,GAC3E,aAAa,CAMzB;IACD;;;;;;;;;;;;OAYG;IACH,KAVa,CAAC,EACD,UAAU,EACV,OAAO,EACP,QAAQ,EACR,SAAS,QACX,MAAM,oDAEH,uBAAuB,CAAC,EAAE,EAAE,CAAC,EAAE,UAAU,EAAE,OAAO,EAAE,QAAQ,EAAE,SAAS,CAAC,EAAE,EAAA,GAC3E,aAAa,CAMzB;IACD;;;;;;;;;;;;OAYG;IACH,IAVa,CAAC,EACD,UAAU,EACV,OAAO,EACP,QAAQ,EACR,SAAS,QACX,MAAM,oDAEH,uBAAuB,CAAC,EAAE,EAAE,CAAC,EAAE,UAAU,EAAE,OAAO,EAAE,QAAQ,EAAE,SAAS,CAAC,EAAE,EAAA,GAC3E,aAAa,CAMzB;IACD;;;;;;;;;;;;OAYG;IACH,MAVa,CAAC,EACD,UAAU,EACV,OAAO,EACP,QAAQ,EACR,SAAS,QACX,MAAM,oDAEH,uBAAuB,CAAC,EAAE,EAAE,CAAC,EAAE,UAAU,EAAE,OAAO,EAAE,QAAQ,EAAE,SAAS,CAAC,EAAE,EAAA,GAC3E,aAAa,CAMzB;IACD;;;;;;;;;;;;OAYG;IACH,OAVa,CAAC,EACD,UAAU,EACV,OAAO,EACP,QAAQ,EACR,SAAS,QACX,MAAM,oDAEH,uBAAuB,CAAC,EAAE,EAAE,CAAC,EAAE,UAAU,EAAE,OAAO,EAAE,QAAQ,EAAE,SAAS,CAAC,EAAE,EAAA,GAC3E,aAAa,CAMzB;;CACJ"}