@ikonintegration/ikapi 4.0.1 → 5.0.0

package/dist/src/Util/Utils.js

@@ -0,0 +1,147 @@
+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 child_process from 'child_process';
+import { convertToAttr, marshall, unmarshall } from '@aws-sdk/util-dynamodb';
+/**
+ * Utility class containing various static methods for common operations.
+ */
+export default class Utils {
+    /**
+     * Checks if the application is running in a hybridless container.
+     * @returns {boolean} - True if the application is running in a hybridless container, false otherwise.
+     */
+    static isHybridlessContainer() {
+        return process.env.HYBRIDLESS_RUNTIME == 'true';
+    }
+    /**
+     * Checks if a given string is valid.
+     * @param {string} string - The string to check.
+     * @returns {boolean} - True if the string is valid, false otherwise.
+     */
+    static isValidString(string) {
+        return (string === null || string === void 0 ? void 0 : string.length) > 0 && !Array.isArray(string);
+    }
+    /**
+     * Parses a string into an integer and returns null if the string is not a valid number.
+     * @param {string} str - The string to parse into an integer.
+     * @returns {number | null} - The parsed integer or null if the string is not a valid number.
+     */
+    static parseIntNullIfNaN(str) {
+        const n = parseInt(str || '');
+        return isNaN(n) ? null : n;
+    }
+    /**
+     * Parses a JSON string and returns the resulting object. If the string is empty or
+     * cannot be parsed, null is returned.
+     * @param {string} string - The JSON string to parse.
+     * @returns {any | null} - The parsed object or null if the string is empty or invalid.
+     */
+    static parseObjectNullIfEmpty(string) {
+        let o = null;
+        try {
+            o = string ? JSON.parse(string) : null;
+            if (o && Object.keys(o).length <= 0)
+                o = null;
+        }
+        catch (e) {
+            /* empty */
+        }
+        return o;
+    }
+    /**
+     * Checks if a given value is a valid number.
+     * @param {string} number - The value to be checked.
+     * @returns {boolean} - True if the value is a valid number, false otherwise.
+     */
+    static isValidNumber(number) {
+        let validNumb = NaN;
+        try {
+            validNumb = parseInt(number + '');
+        }
+        catch (e) {
+            console.error('Error while validating number', e);
+        }
+        return !isNaN(validNumb) && !Array.isArray(number);
+    }
+    /**
+     * Retrieves the value from an object using a case-insensitive key lookup.
+     * @param {any} obj - The object to search for the key.
+     * @param {string} key - The key to search for in the object.
+     * @returns {any | null} The value associated with the key, or null if the key is not found.
+     */
+    static caseInsensitiveObjectForKey(obj, key) {
+        if (!obj)
+            return null;
+        const insensitiveKey = Object.keys(obj).find(k => k.toLowerCase() === key.toLowerCase());
+        if (insensitiveKey && insensitiveKey != '')
+            return obj[insensitiveKey];
+        return null;
+    }
+    /**
+     * Cleans out the /tmp directory asynchronously.
+     */
+    static cleanTemporaryFolder() {
+        return __awaiter(this, void 0, void 0, function* () {
+            return new Promise(resolve => {
+                try {
+                    child_process.execSync('rm -rf /tmp/*');
+                    console.log('Cleaned tmp folder');
+                }
+                catch (err) {
+                    console.error('Error while cleaning tmp folder', err);
+                }
+                finally {
+                    resolve();
+                }
+            });
+        });
+    }
+    /**
+     * Marshalls the given item into a DynamoDB format.
+     * If the item is an array, it maps over each element and marshalls it recursively.
+     * If the item is an object, it marshalls the object using the marshall function with options to remove undefined values and convert class instances to maps.
+     * If the item is neither an array nor an object, it converts the item to an attribute.
+     * @param {any} item - The item to be marshalled.
+     * @returns The marshalled item in DynamoDB format.
+     */
+    static ddbMarshall(item, rec) {
+        if (Array.isArray(item))
+            return { L: item.map(_i => this.ddbMarshall(_i, true)) };
+        else if (typeof item === 'object' && isNaN(parseInt(item))) {
+            const marshalled = marshall(item, {
+                removeUndefinedValues: true,
+                convertClassInstanceToMap: true,
+            });
+            if (rec)
+                return { M: marshalled };
+            else
+                return marshalled;
+        }
+        else
+            return convertToAttr(item, { removeUndefinedValues: true, convertClassInstanceToMap: true });
+    }
+    /**
+     * Recursively unmarshalls a DynamoDB item by converting it into a plain JavaScript object.
+     * @param {any} item - The DynamoDB item to unmarshall.
+     * @returns {any} The unmarshalled JavaScript object.
+     */
+    static ddbUnmarshall(item) {
+        if (!item && item !== false)
+            return null;
+        if (Array.isArray(item)) {
+            return item.map(_item => this.ddbUnmarshall(_item));
+        }
+        else if (typeof item === 'object') {
+            return unmarshall(item);
+        }
+        return item;
+    }
+}
+//# sourceMappingURL=Utils.js.map

package/dist/src/Util/Utils.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"Utils.js","sourceRoot":"","sources":["../../../src/Util/Utils.ts"],"names":[],"mappings":";;;;;;;;;AAAA,OAAO,aAAa,MAAM,eAAe,CAAA;AAEzC,OAAO,EAAE,aAAa,EAAE,QAAQ,EAAE,UAAU,EAAE,MAAM,wBAAwB,CAAA;AAC5E;;GAEG;AACH,MAAM,CAAC,OAAO,OAAO,KAAK;IACxB;;;OAGG;IACI,MAAM,CAAC,qBAAqB;QACjC,OAAO,OAAO,CAAC,GAAG,CAAC,kBAAkB,IAAI,MAAM,CAAA;IACjD,CAAC;IAED;;;;OAIG;IACI,MAAM,CAAC,aAAa,CAAC,MAAc;QACxC,OAAO,CAAA,MAAM,aAAN,MAAM,uBAAN,MAAM,CAAE,MAAM,IAAG,CAAC,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,MAAM,CAAC,CAAA;IACrD,CAAC;IAED;;;;OAIG;IACI,MAAM,CAAC,iBAAiB,CAAC,GAAY;QAC1C,MAAM,CAAC,GAAG,QAAQ,CAAC,GAAG,IAAI,EAAE,CAAC,CAAA;QAC7B,OAAO,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,CAAA;IAC5B,CAAC;IAED;;;;;OAKG;IACI,MAAM,CAAC,sBAAsB,CAAC,MAA0B;QAC7D,IAAI,CAAC,GAAG,IAAI,CAAA;QACZ,IAAI,CAAC;YACH,CAAC,GAAG,MAAM,CAAC,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,IAAI,CAAA;YACtC,IAAI,CAAC,IAAI,MAAM,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,MAAM,IAAI,CAAC;gBAAE,CAAC,GAAG,IAAI,CAAA;QAC/C,CAAC;QAAC,OAAO,CAAC,EAAE,CAAC;YACX,WAAW;QACb,CAAC;QACD,OAAO,CAAC,CAAA;IACV,CAAC;IAED;;;;OAIG;IACI,MAAM,CAAC,aAAa,CAAC,MAAc;QACxC,IAAI,SAAS,GAAG,GAAG,CAAA;QACnB,IAAI,CAAC;YACH,SAAS,GAAG,QAAQ,CAAC,MAAM,GAAG,EAAE,CAAC,CAAA;QACnC,CAAC;QAAC,OAAO,CAAC,EAAE,CAAC;YACX,OAAO,CAAC,KAAK,CAAC,+BAA+B,EAAE,CAAC,CAAC,CAAA;QACnD,CAAC;QACD,OAAO,CAAC,KAAK,CAAC,SAAS,CAAC,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,MAAM,CAAC,CAAA;IACpD,CAAC;IAED;;;;;OAKG;IACI,MAAM,CAAC,2BAA2B,CAAC,GAAQ,EAAE,GAAW;QAC7D,IAAI,CAAC,GAAG;YAAE,OAAO,IAAI,CAAA;QACrB,MAAM,cAAc,GAAG,MAAM,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,WAAW,EAAE,KAAK,GAAG,CAAC,WAAW,EAAE,CAAC,CAAA;QACxF,IAAI,cAAc,IAAI,cAAc,IAAI,EAAE;YAAE,OAAO,GAAG,CAAC,cAAc,CAAC,CAAA;QACtE,OAAO,IAAI,CAAA;IACb,CAAC;IAED;;OAEG;IACI,MAAM,CAAO,oBAAoB;;YACtC,OAAO,IAAI,OAAO,CAAO,OAAO,CAAC,EAAE;gBACjC,IAAI,CAAC;oBACH,aAAa,CAAC,QAAQ,CAAC,eAAe,CAAC,CAAA;oBACvC,OAAO,CAAC,GAAG,CAAC,oBAAoB,CAAC,CAAA;gBACnC,CAAC;gBAAC,OAAO,GAAG,EAAE,CAAC;oBACb,OAAO,CAAC,KAAK,CAAC,iCAAiC,EAAE,GAAG,CAAC,CAAA;gBACvD,CAAC;wBAAS,CAAC;oBACT,OAAO,EAAE,CAAA;gBACX,CAAC;YACH,CAAC,CAAC,CAAA;QACJ,CAAC;KAAA;IAED;;;;;;;OAOG;IACI,MAAM,CAAC,WAAW,CAAI,IAAO,EAAE,GAAa;QACjD,IAAI,KAAK,CAAC,OAAO,CAAC,IAAI,CAAC;YAAE,OAAO,EAAE,CAAC,EAAE,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,EAAE,CAAC,IAAI,CAAC,WAAW,CAAC,EAAE,EAAE,IAAI,CAAC,CAAC,EAAE,CAAA;aAC5E,IAAI,OAAO,IAAI,KAAK,QAAQ,IAAI,KAAK,CAAC,QAAQ,CAAC,IAAW,CAAC,CAAC,EAAE,CAAC;YAClE,MAAM,UAAU,GAAG,QAAQ,CAAC,IAAI,EAAE;gBAChC,qBAAqB,EAAE,IAAI;gBAC3B,yBAAyB,EAAE,IAAI;aAChC,CAAC,CAAA;YACF,IAAI,GAAG;gBAAE,OAAO,EAAE,CAAC,EAAE,UAAU,EAAE,CAAA;;gBAC5B,OAAO,UAAU,CAAA;QACxB,CAAC;;YACC,OAAO,aAAa,CAAC,IAAI,EAAE,EAAE,qBAAqB,EAAE,IAAI,EAAE,yBAAyB,EAAE,IAAI,EAAE,CAAC,CAAA;IAChG,CAAC;IAED;;;;OAIG;IACI,MAAM,CAAC,aAAa,CAAC,IAAI;QAC9B,IAAI,CAAC,IAAI,IAAI,IAAI,KAAK,KAAK;YAAE,OAAO,IAAI,CAAA;QACxC,IAAI,KAAK,CAAC,OAAO,CAAC,IAAI,CAAC,EAAE,CAAC;YACxB,OAAO,IAAI,CAAC,GAAG,CAAC,KAAK,CAAC,EAAE,CAAC,IAAI,CAAC,aAAa,CAAC,KAAK,CAAC,CAAC,CAAA;QACrD,CAAC;aAAM,IAAI,OAAO,IAAI,KAAK,QAAQ,EAAE,CAAC;YACpC,OAAO,UAAU,CAAC,IAAI,CAAC,CAAA;QACzB,CAAC;QACD,OAAO,IAAI,CAAA;IACb,CAAC;CACF"}

package/dist/src/Validation/Validator.d.ts

@@ -0,0 +1,17 @@
+import { z } from 'zod';
+import Response, { ResponseErrorType } from '../API/Response.js';
+/**
+ * Validates the given data against the provided schema.
+ * @param {any} data - The data to be validated.
+ * @param {z.ZodObject<any>} schema - The schema to validate against.
+ * @returns {boolean | Response<ResponseErrorType>} - Returns true if the data is valid, otherwise returns a response object with an error message.
+ */
+export default class Validator {
+    /**
+     * Validates the given data against the provided schema.
+     * @param {any} data - The data to be validated.
+     * @param {z.ZodObject<any> | z.ZodUnion<any>} schema - The schema to validate against.
+     * @returns {boolean | Response<ResponseErrorType>} - Returns either true if the data is valid or a Response object with an error message if validation fails.
+     */
+    static validateSchema(data: any, schema: z.ZodObject<any> | z.ZodUnion<any> | z.ZodIntersection<any, any>): boolean | Response<ResponseErrorType>;
+}

package/dist/src/Validation/Validator.js

@@ -0,0 +1,39 @@
+import { z } from 'zod';
+import Response from '../API/Response.js';
+import Globals from '../Globals.js';
+/**
+ * Validates the given data against the provided schema.
+ * @param {any} data - The data to be validated.
+ * @param {z.ZodObject<any>} schema - The schema to validate against.
+ * @returns {boolean | Response<ResponseErrorType>} - Returns true if the data is valid, otherwise returns a response object with an error message.
+ */
+export default class Validator {
+    /**
+     * Validates the given data against the provided schema.
+     * @param {any} data - The data to be validated.
+     * @param {z.ZodObject<any> | z.ZodUnion<any>} schema - The schema to validate against.
+     * @returns {boolean | Response<ResponseErrorType>} - Returns either true if the data is valid or a Response object with an error message if validation fails.
+     */
+    static validateSchema(data, schema) {
+        let error, validatedInput;
+        // Validate body against known zod schema
+        try {
+            schema.parse(data);
+            validatedInput = true;
+        }
+        catch (err) {
+            if (err instanceof z.ZodError)
+                error = JSON.parse(err.message);
+            else
+                error = 'Unknown validation error!'; //unhandled case, hard to test
+        }
+        // Error validation
+        if (!validatedInput || error) {
+            return Response.BadRequestResponse(Globals.ErrorResponseValidationFail, Globals.ErrorCode_InvalidInput, { validationFailure: error });
+        }
+        else {
+            return true;
+        }
+    }
+}
+//# sourceMappingURL=Validator.js.map

package/dist/src/Validation/Validator.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"Validator.js","sourceRoot":"","sources":["../../../src/Validation/Validator.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAA;AAEvB,OAAO,QAA+B,MAAM,oBAAoB,CAAA;AAChE,OAAO,OAAO,MAAM,eAAe,CAAA;AAEnC;;;;;GAKG;AACH,MAAM,CAAC,OAAO,OAAO,SAAS;IAC5B;;;;;OAKG;IACI,MAAM,CAAC,cAAc,CAC1B,IAAS,EACT,MAAwE;QAExE,IAAI,KAAK,EAAE,cAAc,CAAA;QAEzB,yCAAyC;QACzC,IAAI,CAAC;YACH,MAAM,CAAC,KAAK,CAAC,IAAI,CAAC,CAAA;YAClB,cAAc,GAAG,IAAI,CAAA;QACvB,CAAC;QAAC,OAAO,GAAqB,EAAE,CAAC;YAC/B,IAAI,GAAG,YAAY,CAAC,CAAC,QAAQ;gBAAE,KAAK,GAAG,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,OAAO,CAAC,CAAA;;gBACzD,KAAK,GAAG,2BAA2B,CAAA,CAAC,8BAA8B;QACzE,CAAC;QAED,mBAAmB;QACnB,IAAI,CAAC,cAAc,IAAI,KAAK,EAAE,CAAC;YAC7B,OAAO,QAAQ,CAAC,kBAAkB,CAChC,OAAO,CAAC,2BAA2B,EACnC,OAAO,CAAC,sBAAsB,EAC9B,EAAE,iBAAiB,EAAE,KAAK,EAAE,CAC7B,CAAA;QACH,CAAC;aAAM,CAAC;YACN,OAAO,IAAI,CAAA;QACb,CAAC;IACH,CAAC;CACF"}

package/dist/tsconfig.tsbuildinfo

@@ -0,0 +1 @@
+{"root":["../index.ts","../src/globals.ts","../src/api/request.ts","../src/api/response.ts","../src/baseevent/dynamotransaction.ts","../src/baseevent/eventprocessor.ts","../src/baseevent/process.ts","../src/baseevent/steptransaction.ts","../src/baseevent/transaction.ts","../src/cache/redis.ts","../src/cache/types.ts","../src/config/configuration.ts","../src/config/environmentvar.ts","../src/crypto/crypto.ts","../src/database/database.ts","../src/database/databasemanager.ts","../src/database/databasetransaction.ts","../src/database/index.ts","../src/database/types.ts","../src/database/integrations/dynamo/dynamodatabase.ts","../src/database/integrations/kysely/kyselydatabase.ts","../src/database/integrations/kysely/kyselytransaction.ts","../src/database/integrations/pgsql/postgresdatabase.ts","../src/database/integrations/pgsql/postgrestransaction.ts","../src/logger/logger.ts","../src/mailer/mailer.ts","../src/publisher/publisher.ts","../src/server/routeresolver.ts","../src/server/router.ts","../src/server/lib/containerserver.ts","../src/server/lib/server.ts","../src/server/lib/container/generichandler.ts","../src/server/lib/container/generichandlerevent.ts","../src/server/lib/container/healthhandler.ts","../src/server/lib/container/proxy.ts","../src/server/lib/container/utils.ts","../src/util/asyncsingleton.ts","../src/util/utils.ts","../src/validation/validator.ts","../package-lock.json","../package.json"],"version":"5.6.2"}

package/index.ts

@@ -0,0 +1,41 @@
+import { HttpMethod } from './src/API/Request.js'
+import Response, { ResponseErrorType } from './src/API/Response.js'
+import DynamoTransaction from './src/BaseEvent/DynamoTransaction.js'
+import EventProcessor from './src/BaseEvent/EventProcessor.js'
+import Process from './src/BaseEvent/Process.js'
+import StepTransaction from './src/BaseEvent/StepTransaction.js'
+import Transaction, { TransactionConfig } from './src/BaseEvent/Transaction.js'
+import Redis from './src/Cache/Redis.js'
+import Configuration from './src/Config/Configuration.js'
+import Crypto from './src/Crypto/Crypto.js'
+import * as Database from './src/Database/index.js'
+import Mailer from './src/Mailer/Mailer.js'
+import Router, { Route } from './src/Server/Router.js'
+import AsyncSingleton from './src/Util/AsyncSingleton.js'
+import Utils from './src/Util/Utils.js'
+
+export {
+  // Base Events
+  Transaction,
+  Process,
+  EventProcessor,
+  DynamoTransaction,
+  StepTransaction,
+  // Http
+  Router,
+  Route,
+  HttpMethod,
+  // Modules
+  Mailer,
+  Crypto,
+  Configuration,
+  Redis,
+  Database,
+  // API
+  Response,
+  ResponseErrorType,
+  // Helpers
+  Utils,
+  AsyncSingleton,
+  TransactionConfig,
+}

package/jest.config.ts

@@ -0,0 +1,37 @@
+import type { Config } from '@jest/types'
+/* eslint-env node */
+const config: Config.InitialOptions = {
+  preset: 'ts-jest/presets/default-esm',
+  testEnvironment: 'node',
+  modulePathIgnorePatterns: ['smoke-tests'],
+  reporters: [
+    'default',
+    [
+      'jest-junit',
+      {
+        outputDirectory: 'coverage',
+        outputName: 'jest-junit.xml',
+        ancestorSeparator: ' › ',
+        uniqueOutputName: 'false',
+        suiteNameTemplate: '{filepath}',
+        classNameTemplate: '{classname}',
+        titleTemplate: '{title}',
+      },
+    ],
+  ],
+  coverageReporters: ['clover', 'json', 'lcov', ['text', { file: 'coverage.txt' }], 'json-summary'],
+  collectCoverageFrom: ['src/**/*.(t|j)s', '!src/**/*.d.(t|j)s'],
+  coverageThreshold: {
+    global: {
+      branches: 80,
+      functions: 80,
+      lines: 80,
+      statements: 80,
+    },
+  },
+  // .js imports support
+  moduleNameMapper: {
+    '^(\\.\\.?\\/.+)\\.jsx?$': '$1',
+  },
+}
+export default config

package/jest.smoke.config.ts

@@ -0,0 +1,34 @@
+import type { Config } from '@jest/types'
+/* eslint-env node */
+const config: Config.InitialOptions = {
+  testEnvironment: 'node',
+  // ECMA suppport https://jestjs.io/docs/ecmascript-modules
+  transform: {},
+  //
+  reporters: [
+    'default',
+    [
+      'jest-junit',
+      {
+        outputDirectory: 'coverage',
+        outputName: 'jest-junit.xml',
+        ancestorSeparator: ' › ',
+        uniqueOutputName: 'false',
+        suiteNameTemplate: '{filepath}',
+        classNameTemplate: '{classname}',
+        titleTemplate: '{title}',
+      },
+    ],
+  ],
+  coverageReporters: ['clover', 'json', 'lcov', ['text', { file: 'coverage.txt' }], 'json-summary'],
+  collectCoverageFrom: ['src/**/*.(t|j)s', '!src/**/*.d.(t|j)s'],
+  coverageThreshold: {
+    global: {
+      branches: 70,
+      functions: 70,
+      lines: 70,
+      statements: 70,
+    },
+  },
+}
+export default config

package/package.json

@@ -1,37 +1,81 @@
 {
   "name": "@ikonintegration/ikapi",
-  "version": "4.0.1",
+  "version": "5.0.0",
   "description": "",
-  "main": "index.js",
-  "module": "main.js",
+  "main": "dist/index.js",
+  "types": "dist/index.d.ts",
   "type": "module",
   "scripts": {
-    "test": "echo \"Error: no test specified\" && exit 1",
-    "pre-publish": "npm i -production && curl -sf https://gobinaries.com/tj/node-prune | sh && node-prune"
+    "build": "tsc --build",
+    "clean": "tsc --build --clean",
+    "lint-fix": "eslint . --fix",
+    "lint": "eslint .",
+    "docs": "npx typedoc --tsconfig tsconfig.json index.ts src/**/* --includeVersion --entryPointStrategy expand",
+    "test": "npm run test-ts && npm run test-js",
+    "test-ts": "jest --coverage --silent --runInBand --logHeapUsage && cat coverage/coverage.txt",
+    "test-js": "rm -rf ./smoke-tests; tsc -p tsconfig.smoke.json && cd smoke-tests && npm i && NODE_OPTIONS=\"$NODE_OPTIONS --experimental-vm-modules\" jest --config=./jest.smoke.config.js --coverage --silent --runInBand --logHeapUsage && cat coverage/coverage.txt",
+    "test-dev": "jest --coverage --runInBand && cat coverage/coverage.txt"
   },
   "author": "",
   "license": "ISC",
   "dependencies": {
-    "@aws-sdk/client-dynamodb": "^3.363.0",
-    "@aws-sdk/client-ses": "^3.363.0",
-    "@aws-sdk/client-sns": "^3.363.0",
-    "@aws-sdk/credential-provider-node": "^3.363.0",
-    "@aws-sdk/node-http-handler": "^3.360.0",
-    "@aws-sdk/util-dynamodb": "^3.365.0",
-    "@aws-sdk/util-endpoints": "^3.357.0",
-    "@ikonintegration/mod-resources-tracker-client": "0.0.19",
+    "@aws-sdk/client-dynamodb": "^3.650.0",
+    "@aws-sdk/client-kms": "^3.650.0",
+    "@aws-sdk/client-secrets-manager": "^3.650.0",
+    "@aws-sdk/client-ses": "^3.650.0",
+    "@aws-sdk/client-sns": "^3.650.0",
+    "@aws-sdk/client-ssm": "^3.650.0",
+    "@aws-sdk/credential-provider-node": "^3.650.0",
+    "@aws-sdk/util-dynamodb": "^3.650.0",
+    "@smithy/node-http-handler": "^3.2.0",
+    "@types/email-templates": "^10.0.1",
+    "@types/nodemailer": "^6.4.10",
+    "@types/object-hash": "^3.0.4",
     "abind": "^1.0.5",
-    "bluebird": "^3.7.2",
-    "email-templates": "^11.0.5",
-    "is-email": "^1.0.2",
-    "is-uuid": "^1.0.2",
+    "cors": "^2.8.5",
+    "cuid": "^3.0.0",
+    "dotenv": "^16.4.1",
+    "email-templates": "^12.0.1",
+    "express": "^4.21.0",
     "json-stringify-safe": "^5.0.1",
-    "ksuid": "^3.0.0",
-    "nodemailer": "^6.9.3",
-    "path-to-regexp": "^6.3.0",
-    "pg": "^8.11.1",
+    "kysely": "^0.27.2",
+    "node-cache": "^5.1.2",
+    "object-hash": "^3.0.0",
+    "parse-duration": "^1.1.0",
+    "path-to-regexp": "^8.1.0",
+    "pg": "^8.11.3",
+    "redis": "^4.7.0",
     "sha1": "^1.1.1",
     "stack-trace": "0.0.10",
-    "superstruct": "1.0.3"
+    "zod": "^3.23.4"
+  },
+  "devDependencies": {
+    "@jest/globals": "^29.7.0",
+    "@types/aws-lambda": "^8.10.145",
+    "@types/chai": "^4.3.19",
+    "@types/cors": "^2.8.15",
+    "@types/express": "^4.17.19",
+    "@types/jest": "^29.5.13",
+    "@types/node": "^20.12.7",
+    "@types/path-to-regexp": "^1.7.0",
+    "@types/pg": "^8.11.9",
+    "@types/supertest": "^6.0.2",
+    "@typescript-eslint/eslint-plugin": "^7.7.1",
+    "@typescript-eslint/parser": "^7.7.1",
+    "aws-lambda": "^1.0.7",
+    "aws-sdk-client-mock": "^4.0.0",
+    "chai": "^4.4.1",
+    "eslint": "^8.48.0",
+    "eslint-config-prettier": "^9.0.0",
+    "eslint-plugin-import": "^2.30.0",
+    "eslint-plugin-prettier": "^5.0.0",
+    "eslint-plugin-require-extensions": "^0.1.3",
+    "jest": "^29.7.0",
+    "jest-junit": "^16.0.0",
+    "prettier": "^3.2.5",
+    "supertest": "^7.0.0",
+    "ts-jest": "^29.2.5",
+    "ts-node": "^10.9.1",
+    "typescript": "^5.6.2"
   }
 }

package/src/API/Request.ts

@@ -0,0 +1,214 @@
+import type { Context, APIGatewayEvent } from 'aws-lambda'
+
+import Logger from '../Logger/Logger.js'
+import Utils from '../Util/Utils.js'
+
+/**
+ * Represents a request object with generic types for input, query parameters, and path parameters.
+ * @class Request
+ * @template InputType - The type of the input data for the request.
+ * @template PathParamsType - The type of the path parameters for the request.
+ * @template QueryParamsType - The type of the query parameters for the request.
+ */
+export default class Request<InputType, PathParamsType, QueryParamsType> {
+  /**
+   * Represents an API Gateway event for a request.
+   * @type {APIGatewayEvent}
+   */
+  private requestEvent: APIGatewayEvent
+  /**
+   * The context object for the current instance.
+   */
+  private context: Context
+
+  /**
+   * Constructs a new instance of the class.
+   * @param {APIGatewayEvent} requestEvent - The API Gateway event object.
+   * @param {Context} context - The context object.
+   * @param {Logger} logger - The logger object.
+   * @returns None
+   */
+  constructor(requestEvent: APIGatewayEvent, context: Context, logger: Logger) {
+    this.requestEvent = requestEvent
+    this.context = context
+    logger.debug('Request info:', requestEvent)
+    logger.debug('Request context:', context)
+  }
+
+  /**
+   * Checks if the specified query parameter exists and has a valid value.
+   * @param {keyof QueryParamsType} paramName - The name of the query parameter to check.
+   * @returns {boolean} - True if the query parameter exists and has a valid value, false otherwise.
+   */
+  public containsQueryParam(paramName: keyof QueryParamsType): boolean {
+    const val = this.getQueryParam(paramName)
+    return !!val && (Utils.isValidString(val) || Utils.isValidNumber(val))
+  }
+
+  /**
+   * Retrieves the value of a query parameter from the URL.
+   * @param {keyof QueryParamsType} paramName - The name of the query parameter to retrieve.
+   * @returns {string | null} The value of the query parameter, or null if it does not exist.
+   */
+  public getQueryParam(paramName: keyof QueryParamsType): string {
+    return Utils.caseInsensitiveObjectForKey(
+      this.requestEvent.queryStringParameters,
+      String(paramName)
+    )
+  }
+
+  /**
+   * Retrieves the value of the specified header from the request event headers.
+   * @param {string} headerName - The name of the header to retrieve.
+   * @returns {string | null} - The value of the header, or null if the header is not found.
+   */
+  public getHeader(headerName: string): string | null {
+    return Utils.caseInsensitiveObjectForKey(this.requestEvent.headers, headerName)
+  }
+
+  /**
+   * Retrieves the value of a context parameter from the request context object.
+   * @param {string} cxtParam - The name of the context parameter to retrieve.
+   * @returns The value of the context parameter, or null if it does not exist.
+   */
+  public getContextParam(cxtParam: string): any | null {
+    return Utils.caseInsensitiveObjectForKey(this.requestEvent.requestContext, cxtParam)
+  }
+
+  /**
+   * Checks if the given parameter name exists in the PathParamsType object.
+   * @param {keyof PathParamsType} paramName - The name of the parameter to check.
+   * @returns {boolean} - True if the parameter exists, false otherwise.
+   */
+  public containsPathParam(paramName: keyof PathParamsType): boolean {
+    const val = this.getPathParam(paramName)
+    return !!val && (Utils.isValidString(val) || Utils.isValidNumber(val))
+  }
+
+  /**
+   * Retrieves the value of a specific path parameter from the URL.
+   * @param {keyof PathParamsType} paramName - The name of the path parameter to retrieve.
+   * @returns {string} The value of the path parameter, or null if it does not exist.
+   */
+  public getPathParam(paramName: keyof PathParamsType): string {
+    return Utils.caseInsensitiveObjectForKey(this.requestEvent.pathParameters, String(paramName))
+  }
+
+  /**
+   * Retrieves the body of the request event and parses it if it is a string.
+   * @returns {InputType} The parsed body of the request event.
+   */
+  public getBody(raw?: boolean): InputType {
+    const body: any = this.requestEvent.body
+
+    if (raw) return Utils.isHybridlessContainer() ? this.requestEvent['rawBody'] : body
+
+    if (typeof body === 'string' || body instanceof String) {
+      try {
+        return JSON.parse(body as string)
+      } catch (e) {
+        console.error('Error while getting request body!', e)
+      }
+    }
+
+    return body
+  }
+
+  /**
+   * Retrieves the path from the request event.
+   * @returns {string} The path of the request event.
+   */
+  public getPath(): string {
+    return this.requestEvent.path
+  }
+
+  /**
+   * Retrieves the HTTP method of the current request.
+   * @returns {string} The HTTP method of the request.
+   */
+  public getMethod(): HttpMethod {
+    if (this.requestEvent.httpMethod) {
+      const httpMethod = this.requestEvent.httpMethod.toUpperCase()
+      if (httpMethod in HttpMethod) {
+        return HttpMethod[httpMethod]
+      }
+    }
+
+    throw new Error(`Invalid HTTP method: ${this.requestEvent.httpMethod}`)
+  }
+
+  /**
+   * Retrieves the path parameters from the request event.
+   * @returns {PathParamsType | null} - The path parameters object, or null if not found.
+   */
+  public getPathParams(): PathParamsType {
+    // type conversion guaranteed by validation
+    return this.requestEvent.pathParameters as PathParamsType
+  }
+
+  /**
+   * Retrieves the query parameters from the request event.
+   * @returns {QueryParamsType | null} - The query parameters object, or null if not found.
+   */
+  public getQueryParams(): QueryParamsType {
+    // type conversion guaranteed by validation
+    return this.requestEvent.queryStringParameters as QueryParamsType
+  }
+
+  /**
+   * Retrieves the value of the 'Authorization' header from the request.
+   * @returns The value of the 'Authorization' header, or null if it is not present.
+   */
+  public getAuthorizationHeader(): string | null {
+    return this.getHeader('Authorization')
+  }
+
+  /**
+   * Retrieves the request ID associated with the current execution context.
+   * @returns {string} The request ID.
+   */
+  public getRequestID(): string {
+    if (this.context.awsRequestId) return this.context.awsRequestId
+    return this.requestEvent.requestContext ? this.requestEvent.requestContext.requestId : 'unknown'
+  }
+
+  /**
+   * Retrieves the origin IP address of the request.
+   * @returns {string} The origin IP address. If the IP address is not available, it returns 'unknown'.
+   */
+  public getOriginIP(): string {
+    const origin = this.getContextParam('identity')?.sourceIp
+    const hOrigin = this.getHeader('X-Forwarded-For')
+    return origin ? origin : hOrigin ? hOrigin : 'unknown'
+  }
+
+  /**
+   * Sets the fixed path parameters in the request event object.
+   * @param {any[]} keys - An array of keys representing the path parameter names.
+   * @param {any[]} result - An array of values representing the path parameter values.
+   * @returns None
+   */
+  public setFixedPathParams(keys: any[], result: any[]): void {
+    if (!this.requestEvent.pathParameters) this.requestEvent.pathParameters = {}
+    keys.forEach((key, index) => {
+      if (this.requestEvent?.pathParameters) {
+        this.requestEvent.pathParameters[key.name] = result[index + 1]
+      }
+    })
+  }
+}
+
+/**
+ * Enum representing the HTTP methods.
+ */
+export enum HttpMethod {
+  GET = 'GET',
+  HEAD = 'HEAD',
+  POST = 'POST',
+  PUT = 'PUT',
+  DELETE = 'DELETE',
+  CONNECT = 'CONNECT',
+  OPTIONS = 'OPTIONS',
+  TRACE = 'TRACE',
+  PATCH = 'PATCH',
+}