@ikonintegration/ikapi 4.0.1 → 5.0.0

package/dist/src/Server/Router.d.ts

@@ -0,0 +1,157 @@
+import { Server as HTTPServer } from 'http';
+import express from 'express';
+import { z } from 'zod';
+import { HttpMethod } from '../API/Request.js';
+import { ResponseErrorType } from '../API/Response.js';
+import Transaction, { TransactionConfig, TransactionExecution, StringMap } from '../BaseEvent/Transaction.js';
+/**
+ * Represents a route in an API.
+ * @template InputType - The type of the input data for the route.
+ * @template OutputType - The type of the output data for the route.
+ * @property {string} path - The path of the route.
+ * @property {string} method - The HTTP method of the route.
+ * @property {TransactionExecution<Transaction<InputType, OutputType | ResponseErrorType>, OutputType | ResponseErrorType>} handler - The handler function for the route.
+ * @property {?z.ZodObject<any> | z.ZodUnion<any> | z.ZodIntersection<any, any>}[inputSchema] - The input schema for validating the input data.
+ * @property {?z.ZodObject<any> | z.ZodUnion<any> | z.ZodIntersection<any, any>}[pathSchema] - The path schema for validating the path data.
+ * @property {?z.ZodObject<any> | z.ZodUnion<any> | z.ZodIntersection<any, any>}[querySchema] - The query schema for validating the query data.
+ */
+export interface Route<InputType = never, OutputType = never, PathParamsType = StringMap, QueryParamsType = StringMap> {
+    /**
+     * Represents a file path as a string.
+     * @param {string} path - The file path.
+     * @returns None
+     */
+    path: string | string[];
+    /**
+     * Represents the method used in an API request.
+     * @type {string}
+     */
+    method: HttpMethod;
+    /**
+     * Represents a handler for executing a transaction with the given input type and output type.
+     * @param {Transaction<InputType, OutputType | ResponseErrorType, PathParamsType, QueryParamsType>} transaction - The transaction to execute.
+     * @param {OutputType | ResponseErrorType} - The output type or response error type of the transaction.
+     */
+    handler: TransactionExecution<Transaction<InputType, OutputType | ResponseErrorType, never, PathParamsType, QueryParamsType>, OutputType | ResponseErrorType>;
+    /**
+     * An optional input schema for validating the structure of the input data.
+     *
+     * @type {?z.ZodObject<any> | z.ZodUnion<any> | z.ZodIntersection<any, any>}
+     */
+    inputSchema?: z.ZodObject<any> | z.ZodUnion<any> | z.ZodIntersection<any, any>;
+    /**
+     * An optional input schema for validating the structure of the path params.
+     *
+     * @type {?z.ZodObject<any> | z.ZodUnion<any> | z.ZodIntersection<any, any>}
+     */
+    pathSchema?: z.ZodObject<any> | z.ZodUnion<any> | z.ZodIntersection<any, any>;
+    /**
+     * An optional input schema for validating the structure of the query params.
+     *
+     * @type {?z.ZodObject<any> | z.ZodUnion<any> | z.ZodIntersection<any, any>}
+     */
+    querySchema?: z.ZodObject<any> | z.ZodUnion<any> | z.ZodIntersection<any, any>;
+    /**
+     * An optional openApi object with extra metadata for docs generation.
+     */
+    openApi?: {
+        summary: string;
+        description: string;
+        tags?: string[];
+        outputSchema?: z.ZodObject<any> | z.ZodUnion<any> | z.ZodIntersection<any, any> | z.ZodType<any>;
+        successCode?: number;
+        security?: {
+            [key: string]: string[] | never[];
+        }[];
+    };
+}
+/**
+ * Represents a route that can accept any type for its parameters and return values.
+ */
+export type AnyRoute = Route<any | never, any | never, any | never, any | never>;
+/**
+ * Represents the configuration options for a router.
+ * @typedef {TransactionConfig & {
+ *   routes: Route[]
+ *   port?: number
+ *   timeout?: number
+ *   cors?: {
+ *     origin?: string | string[]
+ *     headers?: string[]
+ *     allowCredentials?: boolean
+ *   }
+ *   healthCheckRoute?: string
+ * }} RouterConfig
+ * @property {Route[]} routes - The routes to be configured in the router.
+ * @property {number} [port] - The port number to listen on. If not specified, a default port will be used.
+ * @property {number} [timeout] - The timeout duration for requests in milliseconds. If not specified, a default timeout will be
+ */
+export type RouterConfig = TransactionConfig & {
+    /**
+     * An array of route objects representing the available routes in the application.
+     * @type {Route[]}
+     */
+    routes: AnyRoute[];
+    /**
+     * The port number for the server to listen on.
+     * @type {number | undefined}
+     */
+    port?: number;
+    /**
+     * Optional timeout value in milliseconds.
+     * @type {number | undefined}
+     */
+    timeout?: number;
+    /**
+     * Configuration options for Cross-Origin Resource Sharing (CORS).
+     * @property {string | string[]} [origin] - The allowed origin(s) for CORS requests.
+     * @property {string[]} [headers] - The allowed headers for CORS requests.
+     * @property {boolean} [allowCredentials] - Whether to allow credentials (cookies, HTTP authentication, and client-side SSL certificates) to be sent in CORS requests.
+     */
+    cors?: {
+        origin?: string | string[];
+        headers?: string[];
+        allowCredentials?: boolean;
+    };
+    /**
+     * The route for the health check endpoint.
+     * @type {string | undefined}
+     */
+    healthCheckRoute?: string;
+    /**
+     * Optional hook function that sets up the container with the provided HTTP server and Express app.
+     * @param {HTTPServer} server - The HTTP server instance.
+     * @param {express.Express} app - The Express application instance.
+     * @returns {Promise<void>} A promise that resolves when the setup is complete.
+     */
+    containerSetupHook?: (server: HTTPServer, app: express.Express) => Promise<void>;
+};
+/**
+ * Represents a router that handles routing logic for a web application.
+ */
+export default class Router {
+    /**
+     * The configuration object for the router.
+     */
+    private readonly config;
+    /**
+     * The private readonly server instance.
+     */
+    private readonly server;
+    /**
+     * Constructs a new instance of the Router class.
+     * @param {RouterConfig} config - The configuration object for the router.
+     * @returns None
+     */
+    constructor(config: RouterConfig);
+    /**
+     * Retrieves the export function from the server.
+     * @returns {CallableFunction} The export function from the server.
+     */
+    getExport(): CallableFunction;
+    /**
+     * Checks if the current element is a container.
+     * @returns {boolean} - True if the element is a container, false otherwise.
+     */
+    private isContainer;
+}

package/dist/src/Server/Router.js

@@ -0,0 +1,32 @@
+import ContainerServer from './lib/ContainerServer.js';
+import Server from './lib/Server.js';
+import Utils from '../Util/Utils.js';
+/**
+ * Represents a router that handles routing logic for a web application.
+ */
+export default class Router {
+    /**
+     * Constructs a new instance of the Router class.
+     * @param {RouterConfig} config - The configuration object for the router.
+     * @returns None
+     */
+    constructor(config) {
+        this.config = config;
+        this.server = this.isContainer() ? new ContainerServer(config) : new Server(config);
+    }
+    /**
+     * Retrieves the export function from the server.
+     * @returns {CallableFunction} The export function from the server.
+     */
+    getExport() {
+        return this.server.getExport();
+    }
+    /**
+     * Checks if the current element is a container.
+     * @returns {boolean} - True if the element is a container, false otherwise.
+     */
+    isContainer() {
+        return Utils.isHybridlessContainer();
+    }
+}
+//# sourceMappingURL=Router.js.map

package/dist/src/Server/Router.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"Router.js","sourceRoot":"","sources":["../../../src/Server/Router.ts"],"names":[],"mappings":"AAKA,OAAO,eAAe,MAAM,0BAA0B,CAAA;AACtD,OAAO,MAAM,MAAM,iBAAiB,CAAA;AAQpC,OAAO,KAAK,MAAM,kBAAkB,CAAA;AAmJpC;;GAEG;AACH,MAAM,CAAC,OAAO,OAAO,MAAM;IAUzB;;;;OAIG;IACH,YAAY,MAAoB;QAC9B,IAAI,CAAC,MAAM,GAAG,MAAM,CAAA;QACpB,IAAI,CAAC,MAAM,GAAG,IAAI,CAAC,WAAW,EAAE,CAAC,CAAC,CAAC,IAAI,eAAe,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,IAAI,MAAM,CAAC,MAAM,CAAC,CAAA;IACrF,CAAC;IAED;;;OAGG;IACI,SAAS;QACd,OAAO,IAAI,CAAC,MAAM,CAAC,SAAS,EAAE,CAAA;IAChC,CAAC;IAED;;;OAGG;IACK,WAAW;QACjB,OAAO,KAAK,CAAC,qBAAqB,EAAE,CAAA;IACtC,CAAC;CACF"}

package/dist/src/Server/lib/ContainerServer.d.ts

@@ -0,0 +1,42 @@
+import Proxy from './container/Proxy.js';
+import Server from './Server.js';
+import { RouterConfig } from '../Router.js';
+/**
+ * Represents a server container that extends the Server class and handles serverless events.
+ */
+export default class ContainerServer extends Server {
+    /**
+     * The proxy object used for handling requests and responses.
+     * @type {Proxy}
+     * @protected
+     */
+    protected readonly proxy: Proxy;
+    /**
+     * Constructs a new instance of the Router class.
+     * @param {RouterConfig} config - The configuration object for the router.
+     * @returns None
+     */
+    constructor(config: RouterConfig);
+    /**
+     * Returns a callable function that can be used to export data.
+     * @returns {CallableFunction} - A callable function that can be used to export data.
+     */
+    getExport(): CallableFunction;
+    /**
+     * Starts the application by loading the proxy.
+     * @returns {Promise<void>} - A promise that resolves when the proxy is loaded.
+     */
+    start(): Promise<void>;
+    /**
+     * Stops the execution of the program and unloads the proxy.
+     * @param {any} [err] - Optional error object to pass to the unload method.
+     * @returns {Promise<void>} - A promise that resolves once the proxy is unloaded.
+     */
+    stop(err?: any): Promise<void>;
+    /**
+     * Listens for process events and handles them accordingly.
+     * @private
+     * @returns None
+     */
+    private listenProcessEvents;
+}

package/dist/src/Server/lib/ContainerServer.js

@@ -0,0 +1,66 @@
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+import Proxy from './container/Proxy.js';
+import Server from './Server.js';
+/**
+ * Represents a server container that extends the Server class and handles serverless events.
+ */
+export default class ContainerServer extends Server {
+    /**
+     * Constructs a new instance of the Router class.
+     * @param {RouterConfig} config - The configuration object for the router.
+     * @returns None
+     */
+    constructor(config) {
+        super(config);
+        this.proxy = new Proxy(config, this.handleServerlessEvent.bind(this));
+        this.listenProcessEvents();
+    }
+    /**
+     * Returns a callable function that can be used to export data.
+     * @returns {CallableFunction} - A callable function that can be used to export data.
+     */
+    getExport() {
+        // start server socket
+        this.start();
+        // return empty function, we are all done
+        return () => { };
+    }
+    /**
+     * Starts the application by loading the proxy.
+     * @returns {Promise<void>} - A promise that resolves when the proxy is loaded.
+     */
+    start() {
+        return __awaiter(this, void 0, void 0, function* () {
+            yield this.proxy.load();
+        });
+    }
+    /**
+     * Stops the execution of the program and unloads the proxy.
+     * @param {any} [err] - Optional error object to pass to the unload method.
+     * @returns {Promise<void>} - A promise that resolves once the proxy is unloaded.
+     */
+    stop(err) {
+        return __awaiter(this, void 0, void 0, function* () {
+            yield this.proxy.unload(err);
+        });
+    }
+    /**
+     * Listens for process events and handles them accordingly.
+     * @private
+     * @returns None
+     */
+    listenProcessEvents() {
+        // start process listeners
+        process.on('unhandledRejection', this.stop.bind(this)); // listen to exceptions
+        process.on('SIGINT', this.stop.bind(this)); // listen on SIGINT signal and gracefully stop the server
+    }
+}
+//# sourceMappingURL=ContainerServer.js.map

package/dist/src/Server/lib/ContainerServer.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"ContainerServer.js","sourceRoot":"","sources":["../../../../src/Server/lib/ContainerServer.ts"],"names":[],"mappings":";;;;;;;;;AAAA,OAAO,KAAK,MAAM,sBAAsB,CAAA;AACxC,OAAO,MAAM,MAAM,aAAa,CAAA;AAGhC;;GAEG;AACH,MAAM,CAAC,OAAO,OAAO,eAAgB,SAAQ,MAAM;IAQjD;;;;OAIG;IACH,YAAY,MAAoB;QAC9B,KAAK,CAAC,MAAM,CAAC,CAAA;QACb,IAAI,CAAC,KAAK,GAAG,IAAI,KAAK,CAAC,MAAM,EAAE,IAAI,CAAC,qBAAqB,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAA;QACrE,IAAI,CAAC,mBAAmB,EAAE,CAAA;IAC5B,CAAC;IAED;;;OAGG;IACI,SAAS;QACd,sBAAsB;QACtB,IAAI,CAAC,KAAK,EAAE,CAAA;QACZ,yCAAyC;QACzC,OAAO,GAAG,EAAE,GAAE,CAAC,CAAA;IACjB,CAAC;IAED;;;OAGG;IACU,KAAK;;YAChB,MAAM,IAAI,CAAC,KAAK,CAAC,IAAI,EAAE,CAAA;QACzB,CAAC;KAAA;IAED;;;;OAIG;IACU,IAAI,CAAC,GAAS;;YACzB,MAAM,IAAI,CAAC,KAAK,CAAC,MAAM,CAAC,GAAG,CAAC,CAAA;QAC9B,CAAC;KAAA;IAED;;;;OAIG;IACK,mBAAmB;QACzB,0BAA0B;QAC1B,OAAO,CAAC,EAAE,CAAC,oBAAoB,EAAE,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAA,CAAC,uBAAuB;QAC9E,OAAO,CAAC,EAAE,CAAC,QAAQ,EAAE,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAA,CAAC,yDAAyD;IACtG,CAAC;CACF"}

package/dist/src/Server/lib/Server.d.ts

@@ -0,0 +1,45 @@
+import { APIGatewayProxyEvent, Context } from 'aws-lambda';
+import { RouterConfig } from '../Router.js';
+import RouteResolver from '../RouteResolver.js';
+/**
+ * Represents a server that handles serverless events and routes them to appropriate handlers.
+ */
+export default class Server {
+    /**
+     * The configuration object for the router.
+     * @readonly
+     * @type {RouterConfig}
+     */
+    protected readonly config: RouterConfig;
+    /**
+     * A protected property that holds a RouteResolver object.
+     * The RouteResolver is responsible for resolving routes and returning the appropriate response.
+     * @type {RouteResolver}
+     */
+    protected readonly routeResolver: RouteResolver;
+    /**
+     * Constructs a new instance of the Router class.
+     * @param {RouterConfig} config - The configuration object for the router.
+     * @returns None
+     */
+    constructor(config: RouterConfig);
+    /**
+     * Returns a callable function that is bound to the `handleServerlessEvent` method of the current object.
+     * @returns {CallableFunction} - A callable function that is bound to the `handleServerlessEvent` method.
+     */
+    getExport(): CallableFunction;
+    /**
+     * Handles a serverless event by executing a transaction and resolving the route based on the event.
+     * @param {APIGatewayProxyEvent} event - The serverless event object.
+     * @param {Context} context - The serverless context object.
+     * @returns None
+     */
+    handleServerlessEvent(event: APIGatewayProxyEvent, context: Context): Promise<void>;
+    /**
+     * Parses the path parameters from the request URL based on the given route path.
+     * @param {Request<any>} req - The request object.
+     * @param {string} routePath - The route path pattern to match against.
+     * @returns None
+     */
+    private parsePathParams;
+}

package/dist/src/Server/lib/Server.js

@@ -0,0 +1,93 @@
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+import { pathToRegexp } from 'path-to-regexp';
+import Response from '../../API/Response.js';
+import Transaction from '../../BaseEvent/Transaction.js';
+import Validator from '../../Validation/Validator.js';
+import RouteResolver from '../RouteResolver.js';
+/**
+ * Represents a server that handles serverless events and routes them to appropriate handlers.
+ */
+export default class Server {
+    /**
+     * Constructs a new instance of the Router class.
+     * @param {RouterConfig} config - The configuration object for the router.
+     * @returns None
+     */
+    constructor(config) {
+        this.config = config;
+        this.routeResolver = new RouteResolver(config);
+    }
+    /**
+     * Returns a callable function that is bound to the `handleServerlessEvent` method of the current object.
+     * @returns {CallableFunction} - A callable function that is bound to the `handleServerlessEvent` method.
+     */
+    getExport() {
+        return this.handleServerlessEvent.bind(this);
+    }
+    /**
+     * Handles a serverless event by executing a transaction and resolving the route based on the event.
+     * @param {APIGatewayProxyEvent} event - The serverless event object.
+     * @param {Context} context - The serverless context object.
+     * @returns None
+     */
+    handleServerlessEvent(event, context) {
+        return __awaiter(this, void 0, void 0, function* () {
+            // init transaction
+            yield new Transaction(event, context, this.config).execute((transaction) => __awaiter(this, void 0, void 0, function* () {
+                const request = transaction.request;
+                const route = this.routeResolver.resolveRoute(request.getMethod(), request.getPath());
+                if (route) {
+                    transaction.logger.log('Router accepted route:', route.path);
+                    // Validate input
+                    if (route.inputSchema) {
+                        const validationResp = Validator.validateSchema(request.getBody(), route.inputSchema);
+                        if (validationResp && validationResp instanceof Response)
+                            return validationResp;
+                    }
+                    // Validate query
+                    if (route.querySchema) {
+                        const validationResp = Validator.validateSchema(request.getQueryParams(), route.querySchema);
+                        if (validationResp && validationResp instanceof Response)
+                            return validationResp;
+                    }
+                    // parse before validating
+                    for (const path of Array.isArray(route.path) ? route.path : [route.path]) {
+                        this.parsePathParams(request, path);
+                    }
+                    // Validate path
+                    if (route.pathSchema) {
+                        const validationResp = Validator.validateSchema(request.getPathParams(), route.pathSchema);
+                        if (validationResp && validationResp instanceof Response)
+                            return validationResp;
+                    }
+                    // Continue to route handler
+                    return yield route.handler(transaction);
+                }
+                //No route found :/
+                return new Response(404, { err: 'Route not found!' });
+            }));
+        });
+    }
+    /**
+     * Parses the path parameters from the request URL based on the given route path.
+     * @param {Request<any>} req - The request object.
+     * @param {string} routePath - The route path pattern to match against.
+     * @returns None
+     */
+    parsePathParams(req, routePath) {
+        const path = req.getPath();
+        const regex = pathToRegexp(routePath);
+        const result = regex.regexp.exec(path);
+        if (result)
+            req.setFixedPathParams(regex.keys, result);
+    }
+}
+//# sourceMappingURL=Server.js.map

package/dist/src/Server/lib/Server.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"Server.js","sourceRoot":"","sources":["../../../../src/Server/lib/Server.ts"],"names":[],"mappings":";;;;;;;;;AACA,OAAO,EAAE,YAAY,EAAE,MAAM,gBAAgB,CAAA;AAG7C,OAAO,QAA+B,MAAM,uBAAuB,CAAA;AACnE,OAAO,WAA0B,MAAM,gCAAgC,CAAA;AACvE,OAAO,SAAS,MAAM,+BAA+B,CAAA;AAErD,OAAO,aAAa,MAAM,qBAAqB,CAAA;AAE/C;;GAEG;AACH,MAAM,CAAC,OAAO,OAAO,MAAM;IAczB;;;;OAIG;IACH,YAAY,MAAoB;QAC9B,IAAI,CAAC,MAAM,GAAG,MAAM,CAAA;QACpB,IAAI,CAAC,aAAa,GAAG,IAAI,aAAa,CAAC,MAAM,CAAC,CAAA;IAChD,CAAC;IAED;;;OAGG;IACI,SAAS;QACd,OAAO,IAAI,CAAC,qBAAqB,CAAC,IAAI,CAAC,IAAI,CAAC,CAAA;IAC9C,CAAC;IAED;;;;;OAKG;IACU,qBAAqB,CAAC,KAA2B,EAAE,OAAgB;;YAC9E,mBAAmB;YACnB,MAAM,IAAI,WAAW,CACnB,KAAK,EACL,OAAO,EACP,IAAI,CAAC,MAAM,CACZ,CAAC,OAAO,CAAC,CAAM,WAAW,EAAC,EAAE;gBAC5B,MAAM,OAAO,GAAG,WAAW,CAAC,OAAO,CAAA;gBACnC,MAAM,KAAK,GAAG,IAAI,CAAC,aAAa,CAAC,YAAY,CAAC,OAAO,CAAC,SAAS,EAAE,EAAE,OAAO,CAAC,OAAO,EAAE,CAAC,CAAA;gBACrF,IAAI,KAAK,EAAE,CAAC;oBACV,WAAW,CAAC,MAAM,CAAC,GAAG,CAAC,wBAAwB,EAAE,KAAK,CAAC,IAAI,CAAC,CAAA;oBAC5D,iBAAiB;oBACjB,IAAI,KAAK,CAAC,WAAW,EAAE,CAAC;wBACtB,MAAM,cAAc,GAAG,SAAS,CAAC,cAAc,CAAC,OAAO,CAAC,OAAO,EAAE,EAAE,KAAK,CAAC,WAAW,CAAC,CAAA;wBACrF,IAAI,cAAc,IAAI,cAAc,YAAY,QAAQ;4BAAE,OAAO,cAAc,CAAA;oBACjF,CAAC;oBAED,iBAAiB;oBACjB,IAAI,KAAK,CAAC,WAAW,EAAE,CAAC;wBACtB,MAAM,cAAc,GAAG,SAAS,CAAC,cAAc,CAC7C,OAAO,CAAC,cAAc,EAAE,EACxB,KAAK,CAAC,WAAW,CAClB,CAAA;wBACD,IAAI,cAAc,IAAI,cAAc,YAAY,QAAQ;4BAAE,OAAO,cAAc,CAAA;oBACjF,CAAC;oBAED,0BAA0B;oBAC1B,KAAK,MAAM,IAAI,IAAI,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,IAAI,CAAC,EAAE,CAAC;wBACzE,IAAI,CAAC,eAAe,CAAC,OAAO,EAAE,IAAI,CAAC,CAAA;oBACrC,CAAC;oBAED,gBAAgB;oBAChB,IAAI,KAAK,CAAC,UAAU,EAAE,CAAC;wBACrB,MAAM,cAAc,GAAG,SAAS,CAAC,cAAc,CAAC,OAAO,CAAC,aAAa,EAAE,EAAE,KAAK,CAAC,UAAU,CAAC,CAAA;wBAC1F,IAAI,cAAc,IAAI,cAAc,YAAY,QAAQ;4BAAE,OAAO,cAAc,CAAA;oBACjF,CAAC;oBAED,4BAA4B;oBAC5B,OAAO,MAAM,KAAK,CAAC,OAAO,CAAC,WAAW,CAAC,CAAA;gBACzC,CAAC;gBACD,mBAAmB;gBACnB,OAAO,IAAI,QAAQ,CAAC,GAAG,EAAE,EAAE,GAAG,EAAE,kBAAkB,EAAE,CAAC,CAAA;YACvD,CAAC,CAAA,CAAC,CAAA;QACJ,CAAC;KAAA;IAED;;;;;OAKG;IACK,eAAe,CAAC,GAA2B,EAAE,SAAiB;QACpE,MAAM,IAAI,GAAG,GAAG,CAAC,OAAO,EAAE,CAAA;QAC1B,MAAM,KAAK,GAAG,YAAY,CAAC,SAAS,CAAC,CAAA;QACrC,MAAM,MAAM,GAAG,KAAK,CAAC,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,CAAA;QACtC,IAAI,MAAM;YAAE,GAAG,CAAC,kBAAkB,CAAC,KAAK,CAAC,IAAI,EAAE,MAAM,CAAC,CAAA;IACxD,CAAC;CACF"}

package/dist/src/Server/lib/container/GenericHandler.d.ts

@@ -0,0 +1,9 @@
+import { Request, Response } from 'express';
+import Server from '../Server.js';
+/**
+ * Creates an async function that handles serverless events and sends a response.
+ * @param {Server['handleServerlessEvent']} serverlessHandler - The serverless handler function.
+ * @returns {Function} - An async function that handles the request and sends a response.
+ */
+declare const _default: (serverlessHandler: Server["handleServerlessEvent"]) => (request: Request, res: Response) => Promise<void>;
+export default _default;

package/dist/src/Server/lib/container/GenericHandler.js

@@ -0,0 +1,82 @@
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+import GenericHandlerEvent from './GenericHandlerEvent.js';
+import Globals from '../../../Globals.js';
+import Utils from '../../../Util/Utils.js';
+/**
+ * Creates an async function that handles serverless events and sends a response.
+ * @param {Server['handleServerlessEvent']} serverlessHandler - The serverless handler function.
+ * @returns {Function} - An async function that handles the request and sends a response.
+ */
+export default (serverlessHandler) => {
+    /**
+     * Handles an HTTP request by invoking a serverless function and processing the response.
+     * @param {Request} request - The HTTP request object.
+     * @param {Response} res - The HTTP response object.
+     * @returns None
+     */
+    return (request, res) => __awaiter(void 0, void 0, void 0, function* () {
+        const startTime = Date.now();
+        try {
+            // Generate event with request stuff (http to serverless translation)
+            const event = new GenericHandlerEvent(request, serverlessHandler);
+            // Invoke
+            const invokationResp = yield event.invoke();
+            // Respond
+            processServerlessResponse(invokationResp, res);
+        }
+        catch (e) {
+            console.error('[Proxy] - Exception during execution!', e);
+            console.error(e.stack);
+            res.status(Globals.Resp_STATUSCODE_EXCEPTION).json(Object.assign(Object.assign({}, e), { err: Globals.Resp_MSG_EXCEPTION, errCode: Globals.Resp_CODE_EXCEPTION }));
+        }
+        console.debug(`[Proxy] - Request took ${Date.now() - startTime}ms`);
+    });
+};
+/**
+ * Processes the response received from a serverless function invocation and sends the appropriate response back to the client.
+ * @param {GenericHandlerEventResponse} invokation - The response object received from the serverless function invocation.
+ * @param {Response} res - The response object to send back to the client.
+ * @returns The response object to send back to the client.
+ */
+const processServerlessResponse = (invokation, res) => {
+    var _a, _b;
+    // translate answer to http layer
+    if (invokation && invokation.err) {
+        // err came
+        return res.json({ err: invokation.err }).status(400);
+    }
+    else if (!invokation || !invokation.data) {
+        // invalid response came
+        return res.status(Globals.Resp_STATUSCODE_INVALIDRESP).json({
+            err: Globals.Resp_MSG_INVALIDRESP,
+            errCode: Globals.Resp_CODE_INVALIDRESP,
+        });
+    }
+    else {
+        // Check for headers
+        if (invokation.data.headers) {
+            for (const hKey of Object.keys(invokation.data.headers)) {
+                res.header(hKey, invokation.data.headers[hKey]);
+            }
+        }
+        //
+        let response = res.status(invokation.data.statusCode);
+        // check for stream
+        if ((_b = (_a = invokation.data) === null || _a === void 0 ? void 0 : _a.body) === null || _b === void 0 ? void 0 : _b.pipe) {
+            invokation.data.body.pipe(response);
+        }
+        else {
+            response = response.json(Utils.parseObjectNullIfEmpty(invokation.data.body) || {});
+        }
+        return response;
+    }
+};
+//# sourceMappingURL=GenericHandler.js.map

package/dist/src/Server/lib/container/GenericHandler.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"GenericHandler.js","sourceRoot":"","sources":["../../../../../src/Server/lib/container/GenericHandler.ts"],"names":[],"mappings":";;;;;;;;;AAEA,OAAO,mBAAoD,MAAM,0BAA0B,CAAA;AAC3F,OAAO,OAAO,MAAM,qBAAqB,CAAA;AACzC,OAAO,KAAK,MAAM,wBAAwB,CAAA;AAG1C;;;;GAIG;AACH,eAAe,CAAC,iBAAkD,EAAE,EAAE;IACpE;;;;;OAKG;IACH,OAAO,CAAO,OAAgB,EAAE,GAAa,EAAE,EAAE;QAC/C,MAAM,SAAS,GAAG,IAAI,CAAC,GAAG,EAAE,CAAA;QAC5B,IAAI,CAAC;YACH,qEAAqE;YACrE,MAAM,KAAK,GAAG,IAAI,mBAAmB,CAAC,OAAO,EAAE,iBAAiB,CAAC,CAAA;YACjE,SAAS;YACT,MAAM,cAAc,GAAG,MAAM,KAAK,CAAC,MAAM,EAAE,CAAA;YAC3C,UAAU;YACV,yBAAyB,CAAC,cAAc,EAAE,GAAG,CAAC,CAAA;QAChD,CAAC;QAAC,OAAO,CAAC,EAAE,CAAC;YACX,OAAO,CAAC,KAAK,CAAC,uCAAuC,EAAE,CAAC,CAAC,CAAA;YACzD,OAAO,CAAC,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,CAAA;YACtB,GAAG,CAAC,MAAM,CAAC,OAAO,CAAC,yBAAyB,CAAC,CAAC,IAAI,iCAC7C,CAAC,KACJ,GAAG,EAAE,OAAO,CAAC,kBAAkB,EAC/B,OAAO,EAAE,OAAO,CAAC,mBAAmB,IACpC,CAAA;QACJ,CAAC;QACD,OAAO,CAAC,KAAK,CAAC,0BAA0B,IAAI,CAAC,GAAG,EAAE,GAAG,SAAS,IAAI,CAAC,CAAA;IACrE,CAAC,CAAA,CAAA;AACH,CAAC,CAAA;AAED;;;;;GAKG;AACH,MAAM,yBAAyB,GAAG,CAAC,UAAuC,EAAE,GAAa,EAAE,EAAE;;IAC3F,iCAAiC;IACjC,IAAI,UAAU,IAAI,UAAU,CAAC,GAAG,EAAE,CAAC;QACjC,WAAW;QACX,OAAO,GAAG,CAAC,IAAI,CAAC,EAAE,GAAG,EAAE,UAAU,CAAC,GAAG,EAAE,CAAC,CAAC,MAAM,CAAC,GAAG,CAAC,CAAA;IACtD,CAAC;SAAM,IAAI,CAAC,UAAU,IAAI,CAAC,UAAU,CAAC,IAAI,EAAE,CAAC;QAC3C,wBAAwB;QACxB,OAAO,GAAG,CAAC,MAAM,CAAC,OAAO,CAAC,2BAA2B,CAAC,CAAC,IAAI,CAAC;YAC1D,GAAG,EAAE,OAAO,CAAC,oBAAoB;YACjC,OAAO,EAAE,OAAO,CAAC,qBAAqB;SACvC,CAAC,CAAA;IACJ,CAAC;SAAM,CAAC;QACN,oBAAoB;QACpB,IAAI,UAAU,CAAC,IAAI,CAAC,OAAO,EAAE,CAAC;YAC5B,KAAK,MAAM,IAAI,IAAI,MAAM,CAAC,IAAI,CAAC,UAAU,CAAC,IAAI,CAAC,OAAO,CAAC,EAAE,CAAC;gBACxD,GAAG,CAAC,MAAM,CAAC,IAAI,EAAE,UAAU,CAAC,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC,CAAA;YACjD,CAAC;QACH,CAAC;QACD,EAAE;QACF,IAAI,QAAQ,GAAG,GAAG,CAAC,MAAM,CAAC,UAAU,CAAC,IAAI,CAAC,UAAU,CAAC,CAAA;QACrD,mBAAmB;QACnB,IAAI,MAAA,MAAA,UAAU,CAAC,IAAI,0CAAE,IAAI,0CAAE,IAAI,EAAE,CAAC;YAChC,UAAU,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAA;QACrC,CAAC;aAAM,CAAC;YACN,QAAQ,GAAG,QAAQ,CAAC,IAAI,CAAC,KAAK,CAAC,sBAAsB,CAAC,UAAU,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,EAAE,CAAC,CAAA;QACpF,CAAC;QACD,OAAO,QAAQ,CAAA;IACjB,CAAC;AACH,CAAC,CAAA"}

package/dist/src/Server/lib/container/GenericHandlerEvent.d.ts

@@ -0,0 +1,52 @@
+import { Request } from 'express';
+import Server from '../Server.js';
+/**
+ * Represents the response object returned by a generic event handler.
+ * @typedef {Object} GenericHandlerEventResponse
+ * @property {Error | string} [err] - An optional error object or error message.
+ * @property {*} [data] - An optional data object.
+ */
+export type GenericHandlerEventResponse = {
+    err?: Error | string;
+    data?: any;
+};
+/**
+ * Represents a generic handler event for serverless functions.
+ */
+export default class GenericHandlerEvent {
+    /**
+     * Represents an HTTP request.
+     * @property {Request} request - The HTTP request object.
+     */
+    request: Request;
+    /**
+     * The handler function for serverless events in a server.
+     * @param {Server['handleServerlessEvent']} serverlessHandler - The function that handles serverless events.
+     * @returns None
+     */
+    serverlessHandler: Server['handleServerlessEvent'];
+    /**
+     * Constructs a new instance of the class.
+     * @param {Request} request - The request object.
+     * @param {Server['handleServerlessEvent']} serverlessHandler - The serverless handler function.
+     * @returns None
+     */
+    constructor(request: Request, serverlessHandler: Server['handleServerlessEvent']);
+    /**
+     * Invokes the handler function asynchronously and returns a promise that resolves to a GenericHandlerEventResponse.
+     * @returns {Promise<GenericHandlerEventResponse>} A promise that resolves to a GenericHandlerEventResponse.
+     */
+    invoke(): Promise<GenericHandlerEventResponse>;
+    /**
+     * Builds and returns an APIGatewayProxyEvent object based on the current request.
+     * @returns {APIGatewayProxyEvent} - The constructed APIGatewayProxyEvent object.
+     */
+    private buildEvent;
+    /**
+     * Builds and returns a context object for an AWS Lambda function.
+     * @param {APIGatewayProxyEvent} event - The event object passed to the Lambda function.
+     * @param {(err?: Error | string, data?: any) => void} callback - The callback function to be called when the Lambda function completes.
+     * @returns {Context} - The context object for the Lambda function.
+     */
+    private buildContext;
+}