@forklaunch/core 0.2.6 → 0.2.7

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

@@ -1,210 +0,0 @@
-import cors from 'cors';
-import * as jose from 'jose';
-import { v4 } from 'uuid';
-import { isResponseShape } from '../guards/isResponseShape';
-/**
- * Cors middleware handler
- *
- * @param req - Express-like request object
- * @param res - Express-like response object
- * @param next - Express-like next function
- */
-export function corsMiddleware(req, res, next) {
-    console.debug('[MIDDLEWARE] cors started');
-    if (req.method === 'OPTIONS') {
-        res.cors = true;
-    }
-    cors()(req, res, next ?? (() => { }));
-}
-/**
- * Middleware to create and add a request context.
- *
- * @template SV - A type that extends AnySchemaValidator.
- * @template Request - A type that extends ForklaunchRequest.
- * @template Response - A type that extends ForklaunchResponse.
- * @template NextFunction - A type that extends ForklaunchNextFunction.
- * @param {SV} schemaValidator - The schema validator.
- * @returns {Function} - Middleware function to create request context.
- */
-export function createRequestContext(schemaValidator) {
-    return (req, res, next) => {
-        console.debug('[MIDDLEWARE] createRequestContext started');
-        req.schemaValidator = schemaValidator;
-        let correlationId = v4();
-        if (req.headers['x-correlation-id']) {
-            correlationId = req.headers['x-correlation-id'];
-        }
-        res.setHeader('x-correlation-id', correlationId);
-        req.context = {
-            correlationId: correlationId
-        };
-        next?.();
-    };
-}
-/**
- * Middleware to enrich the request details with contract details.
- *
- * @template SV - A type that extends AnySchemaValidator.
- * @template Request - A type that extends ForklaunchRequest.
- * @template Response - A type that extends ForklaunchResponse.
- * @template NextFunction - A type that extends ForklaunchNextFunction.
- * @param {PathParamHttpContractDetails<SV> | HttpContractDetails<SV>} contractDetails - The contract details.
- * @returns {Function} - Middleware function to enrich request details.
- */
-export function enrichRequestDetails(contractDetails, requestSchema, responseSchemas) {
-    return (req, res, next) => {
-        console.debug('[MIDDLEWARE] enrichRequestDetails started');
-        req.contractDetails = contractDetails;
-        req.requestSchema = requestSchema;
-        res.responseSchemas = responseSchemas;
-        next?.();
-    };
-}
-/**
- * Pre-handler function to parse and validate input.
- *
- * @template SV - A type that extends AnySchemaValidator.
- * @template Request - A type that extends ForklaunchRequest.
- * @template Response - A type that extends ForklaunchResponse.
- * @template NextFunction - A type that extends ForklaunchNextFunction.
- * @param {Request} req - The request object.
- * @param {Response} res - The response object.
- * @param {NextFunction} [next] - The next middleware function.
- */
-export function parseRequest(req, _res, next) {
-    console.debug('[MIDDLEWARE] parseRequest started');
-    const request = {
-        params: req.params,
-        query: req.query,
-        headers: req.headers,
-        body: req.body
-    };
-    const parsedRequest = req.schemaValidator.parse(req.requestSchema, request);
-    if (parsedRequest.ok &&
-        isResponseShape(parsedRequest.value)) {
-        req.body = parsedRequest.value.body;
-        req.params = parsedRequest.value.params;
-        req.query = parsedRequest.value.query;
-        req.headers = parsedRequest.value.headers;
-    }
-    if (!parsedRequest.ok) {
-        switch (req.contractDetails.options?.requestValidation) {
-            default:
-            case 'error':
-                next?.(new Error(`Invalid request: ${parsedRequest.error}`));
-                break;
-            case 'warning':
-                console.warn(`Invalid request: ${parsedRequest.error}`);
-                break;
-            case 'none':
-                break;
-        }
-    }
-    next?.();
-}
-/**
- * Checks the authorization token for validity.
- *
- * @param {AuthMethod} [authorizationMethod] - The method of authorization.
- * @param {string} [authorizationString] - The authorization string.
- * @returns {Promise<[401 | 403, string] | string | undefined>} - The result of the authorization check.
- */
-async function checkAuthorizationToken(authorizationMethod, authorizationString) {
-    if (!authorizationString) {
-        return [401, 'No Authorization token provided.'];
-    }
-    switch (authorizationMethod) {
-        case 'jwt': {
-            if (!authorizationString.startsWith('Bearer ')) {
-                return [401, 'Invalid Authorization token format.'];
-            }
-            try {
-                const decodedJwt = await jose.jwtVerify(authorizationString.split(' ')[1], new TextEncoder().encode(process.env.JWT_SECRET || 'your-256-bit-secret'));
-                return decodedJwt.payload.iss;
-            }
-            catch (error) {
-                console.error(error);
-                return [403, 'Invalid Authorization token.'];
-            }
-        }
-        default:
-            return [401, 'Invalid Authorization method.'];
-    }
-}
-/**
- * Maps roles from authorization.
- *
- * @param {AuthMethod} [authorizationType] - The method of authorization.
- * @param {string} [authorizationToken] - The authorization token.
- * @returns {string[]} - The mapped roles.
- */
-// function mapRoles(
-//   authorizationType?: AuthMethod,
-//   authorizationToken?: string
-// ): string[] {
-//   return [];
-// }
-/**
- * Maps permissions from authorization.
- *
- * @param {AuthMethod} [authorizationType] - The method of authorization.
- * @param {string} [authorizationToken] - The authorization token.
- * @returns {string[]} - The mapped permissions.
- */
-// function mapPermissions(
-//   authorizationType?: AuthMethod,
-//   authorizationToken?: string
-// ): string[] {
-//   return [];
-// }
-/**
- * Middleware to parse request authorization.
- *
- * @template SV - A type that extends AnySchemaValidator.
- * @template Request - A type that extends ForklaunchRequest.
- * @template Response - A type that extends ForklaunchResponse.
- * @template NextFunction - A type that extends ForklaunchNextFunction.
- * @param {Request} req - The request object.
- * @param {Response} res - The response object.
- * @param {NextFunction} [next] - The next middleware function.
- */
-export async function parseRequestAuth(req, res, next) {
-    const auth = req.contractDetails.auth;
-    if (auth) {
-        const errorAndMessage = await checkAuthorizationToken(auth.method, req.headers.authorization);
-        if (Array.isArray(errorAndMessage)) {
-            res.status(errorAndMessage[0]).send(errorAndMessage[1]);
-            next?.(new Error(errorAndMessage[1]));
-        }
-        // TODO: Implement role and permission checking
-        //   const permissionSlugs = mapPermissions(
-        //     auth.method,
-        //     req.headers.authorization
-        //   );
-        //   const roles = mapRoles(auth.method, req.headers.authorization);
-        //   const permissionErrorMessage =
-        //     'User does not have sufficient permissions to perform action.';
-        //   const roleErrorMessage =
-        //     'User does not have correct role to perform action.';
-        //   permissionSlugs.forEach((permissionSlug) => {
-        //     if (
-        //       !req.contractDetails.auth?.allowedSlugs?.has(permissionSlug) ||
-        //       req.contractDetails.auth?.forbiddenSlugs?.has(permissionSlug)
-        //     ) {
-        //       res.status(403).send(permissionErrorMessage);
-        //       next?.(new Error(permissionErrorMessage));
-        //       }
-        //     }
-        //   });
-        //   roles.forEach((role) => {
-        //     if (
-        //       !req.contractDetails.auth?.allowedRoles?.has(role) ||
-        //       req.contractDetails.auth?.forbiddenRoles?.has(role)
-        //     ) {
-        //       res.status(403).send(roleErrorMessage);
-        //       next?.(new Error(roleErrorMessage));
-        //     }
-        //   });
-    }
-    // next?.();
-}

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

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

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

@@ -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/src/http/openApiV3Generator/index.d.ts

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

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

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

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

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

@@ -1,4 +0,0 @@
-export * from './apiDefinition.types';
-export * from './contractDetails.types';
-export * from './router.types';
-//# sourceMappingURL=index.d.ts.map

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

@@ -1 +0,0 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../src/http/types/index.ts"],"names":[],"mappings":"AAAA,cAAc,uBAAuB,CAAC;AACtC,cAAc,yBAAyB,CAAC;AACxC,cAAc,gBAAgB,CAAC"}

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

@@ -1,3 +0,0 @@
-export * from './apiDefinition.types';
-export * from './contractDetails.types';
-export * from './router.types';

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

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

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

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

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

@@ -1,2 +0,0 @@
-export * from './enrichExpressLikeSend';
-export * from './httpStatusCodes';

package/lib/tests/entityMapper.test.d.ts

@@ -1,2 +0,0 @@
-export {};
-//# sourceMappingURL=entityMapper.test.d.ts.map

package/lib/tests/entityMapper.test.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"entityMapper.test.d.ts","sourceRoot":"","sources":["../../tests/entityMapper.test.ts"],"names":[],"mappings":""}

package/lib/tests/entityMapper.test.js

@@ -1,168 +0,0 @@
-var __decorate = (this && this.__decorate) || function (decorators, target, key, desc) {
-    var c = arguments.length, r = c < 3 ? target : desc === null ? desc = Object.getOwnPropertyDescriptor(target, key) : desc, d;
-    if (typeof Reflect === "object" && typeof Reflect.decorate === "function") r = Reflect.decorate(decorators, target, key, desc);
-    else for (var i = decorators.length - 1; i >= 0; i--) if (d = decorators[i]) r = (c < 3 ? d(r) : c > 3 ? d(target, key, r) : d(target, key)) || r;
-    return c > 3 && r && Object.defineProperty(target, key, r), r;
-};
-import { SchemaValidator, number, string } from '@forklaunch/validator/typebox';
-import { Property } from '@mikro-orm/core';
-import { BaseEntity } from '../src/database/mikro/models/entities/base.entity';
-import { RequestDtoMapper } from '../src/dtoMapper/models/requestDtoMapper.model';
-import { ResponseDtoMapper } from '../src/dtoMapper/models/responseDtoMapper.model';
-const SV = SchemaValidator();
-class TestEntity extends BaseEntity {
-    name;
-    age;
-}
-__decorate([
-    Property()
-], TestEntity.prototype, "name", void 0);
-__decorate([
-    Property()
-], TestEntity.prototype, "age", void 0);
-class TestRequestDtoMapper extends RequestDtoMapper {
-    schema = {
-        id: string,
-        name: string,
-        age: number
-    };
-    toEntity(...additionalArgs) {
-        const entity = new TestEntity();
-        entity.id = this.dto.id;
-        entity.name = this.dto.name;
-        entity.age = this.dto.age;
-        return entity;
-    }
-}
-class TestResponseDtoMapper extends ResponseDtoMapper {
-    schema = {
-        id: string,
-        name: string,
-        age: number
-    };
-    fromEntity(entity) {
-        this.dto = {
-            id: entity.id,
-            name: entity.name,
-            age: entity.age
-        };
-        return this;
-    }
-}
-function extractNonTimeBasedEntityFields(entity) {
-    entity.createdAt = new Date(0);
-    entity.updatedAt = new Date(0);
-    return entity;
-}
-describe('Request Entity Mapper Test', () => {
-    let TestRequestEM;
-    beforeAll(() => {
-        TestRequestEM = new TestRequestDtoMapper(SchemaValidator());
-    });
-    test('Schema Equality', async () => {
-        expect(TestRequestEM.schema).toEqual(TestRequestDtoMapper.schema());
-    });
-    test('From JSON', async () => {
-        const json = {
-            id: '123',
-            name: 'test',
-            age: 1
-        };
-        const responseEM = TestRequestEM.fromJson(json);
-        const staticEM = TestRequestDtoMapper.fromJson(SchemaValidator(), json);
-        const expectedDto = {
-            id: '123',
-            name: 'test',
-            age: 1
-        };
-        expect(staticEM.dto).toEqual(expectedDto);
-        expect(responseEM.dto).toEqual(expectedDto);
-        expect(responseEM.dto).toEqual(staticEM.dto);
-    });
-    test('Deserialization Equality', async () => {
-        const json = {
-            id: '123',
-            name: 'test',
-            age: 1
-        };
-        const entity = extractNonTimeBasedEntityFields(TestRequestEM.deserializeJsonToEntity(json));
-        const objectEntity = extractNonTimeBasedEntityFields(TestRequestEM.fromJson(json).toEntity());
-        const staticEntity = extractNonTimeBasedEntityFields(TestRequestDtoMapper.deserializeJsonToEntity(SchemaValidator(), json));
-        let expectedEntity = new TestEntity();
-        expectedEntity.id = '123';
-        expectedEntity.name = 'test';
-        expectedEntity.age = 1;
-        expectedEntity = extractNonTimeBasedEntityFields(expectedEntity);
-        expect(entity).toEqual(expectedEntity);
-        expect(objectEntity).toEqual(expectedEntity);
-        expect(staticEntity).toEqual(expectedEntity);
-        expect(entity).toEqual(objectEntity);
-        expect(entity).toEqual(staticEntity);
-        expect(staticEntity).toEqual(expectedEntity);
-        expect(staticEntity).toEqual(objectEntity);
-    });
-    test('Serialization Failure', async () => {
-        const json = {
-            id: '123',
-            name: 'test'
-        };
-        // @ts-expect-error
-        expect(() => TestRequestEM.fromJson(json)).toThrow();
-        expect(() => 
-        // @ts-expect-error
-        TestRequestDtoMapper.fromJson(new TypeboxSchemaValidator(), json)).toThrow();
-    });
-});
-describe('Response Entity Mapper Test', () => {
-    let TestResponseEM;
-    beforeAll(() => {
-        TestResponseEM = new TestResponseDtoMapper(SchemaValidator());
-    });
-    test('Schema Equality', async () => {
-        expect(TestResponseEM.schema).toEqual(TestResponseDtoMapper.schema());
-    });
-    test('From Entity', async () => {
-        const entity = new TestEntity();
-        entity.id = '123';
-        entity.name = 'test';
-        entity.age = 1;
-        const responseEM = TestResponseEM.fromEntity(entity);
-        const staticEM = TestResponseDtoMapper.fromEntity(SchemaValidator(), entity);
-        const expectedDto = {
-            id: '123',
-            name: 'test',
-            age: 1
-        };
-        expect(staticEM.dto).toEqual(expectedDto);
-        expect(responseEM.dto).toEqual(expectedDto);
-        expect(responseEM.dto).toEqual(staticEM.dto);
-    });
-    test('Serialization Equality', async () => {
-        const entity = new TestEntity();
-        entity.id = '123';
-        entity.name = 'test';
-        entity.age = 1;
-        const json = TestResponseEM.serializeEntityToJson(entity);
-        const objectJson = TestResponseEM.fromEntity(entity).toJson();
-        const staticJson = TestResponseDtoMapper.serializeEntityToJson(SchemaValidator(), entity);
-        const expectedJson = {
-            id: '123',
-            name: 'test',
-            age: 1
-        };
-        expect(json).toEqual(expectedJson);
-        expect(objectJson).toEqual(expectedJson);
-        expect(staticJson).toEqual(expectedJson);
-        expect(json).toEqual(objectJson);
-        expect(json).toEqual(staticJson);
-        expect(staticJson).toEqual(expectedJson);
-        expect(staticJson).toEqual(objectJson);
-    });
-    test('Serialization Failure', async () => {
-        const entity = new TestEntity();
-        entity.id = '123';
-        entity.name = 'test';
-        expect(() => TestResponseEM.fromEntity(entity).toJson()).toThrow();
-        expect(() => TestResponseDtoMapper.fromEntity(SchemaValidator(), entity).toJson()).toThrow();
-    });
-});

package/lib/tests/expressLikeRouter.test.d.ts

@@ -1,2 +0,0 @@
-export {};
-//# sourceMappingURL=expressLikeRouter.test.d.ts.map

package/lib/tests/expressLikeRouter.test.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"expressLikeRouter.test.d.ts","sourceRoot":"","sources":["../../tests/expressLikeRouter.test.ts"],"names":[],"mappings":""}

package/lib/tests/expressLikeRouter.test.js

@@ -1,3 +0,0 @@
-// TODO: implement tests
-describe('express-like router tests', () => { });
-export {};