@ikonintegration/ikapi 5.0.2 → 5.0.4

package/dist/package.json

@@ -1,82 +0,0 @@
-{
-    "name": "@ikonintegration/ikapi",
-    "version": "5.0.2",
-    "description": "",
-    "main": "dist/index.js",
-    "types": "dist/index.d.ts",
-    "type": "module",
-    "scripts": {
-        "build": "task build",
-        "clean": "task clean",
-        "lint-fix": "task lint-fix",
-        "lint": "task lint",
-        "docs": "task docs",
-        "test": "task test",
-        "test-ts": "task test-ts",
-        "test-js": "task test-js",
-        "test-dev": "task test-dev"
-    },
-    "author": "",
-    "license": "ISC",
-    "dependencies": {
-        "@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",
-        "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",
-        "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",
-        "zod": "^3.23.4"
-    },
-    "devDependencies": {
-        "@go-task/cli": "^3.39.0",
-        "@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/dist/src/API/Request.d.ts

@@ -1,125 +0,0 @@
-import type { Context, APIGatewayEvent } from 'aws-lambda';
-import Logger from '../Logger/Logger.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;
-    /**
-     * The context object for the current instance.
-     */
-    private 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);
-    /**
-     * 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.
-     */
-    containsQueryParam(paramName: keyof QueryParamsType): boolean;
-    /**
-     * 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.
-     */
-    getQueryParam(paramName: keyof QueryParamsType): string;
-    /**
-     * 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.
-     */
-    getHeader(headerName: string): string | null;
-    /**
-     * 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.
-     */
-    getContextParam(cxtParam: string): any | null;
-    /**
-     * 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.
-     */
-    containsPathParam(paramName: keyof PathParamsType): boolean;
-    /**
-     * 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.
-     */
-    getPathParam(paramName: keyof PathParamsType): string;
-    /**
-     * Retrieves the body of the request event and parses it if it is a string.
-     * @returns {InputType} The parsed body of the request event.
-     */
-    getBody(raw?: boolean): InputType;
-    /**
-     * Retrieves the path from the request event.
-     * @returns {string} The path of the request event.
-     */
-    getPath(): string;
-    /**
-     * Retrieves the HTTP method of the current request.
-     * @returns {string} The HTTP method of the request.
-     */
-    getMethod(): HttpMethod;
-    /**
-     * Retrieves the path parameters from the request event.
-     * @returns {PathParamsType | null} - The path parameters object, or null if not found.
-     */
-    getPathParams(): PathParamsType;
-    /**
-     * Retrieves the query parameters from the request event.
-     * @returns {QueryParamsType | null} - The query parameters object, or null if not found.
-     */
-    getQueryParams(): 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.
-     */
-    getAuthorizationHeader(): string | null;
-    /**
-     * Retrieves the request ID associated with the current execution context.
-     * @returns {string} The request ID.
-     */
-    getRequestID(): string;
-    /**
-     * Retrieves the origin IP address of the request.
-     * @returns {string} The origin IP address. If the IP address is not available, it returns 'unknown'.
-     */
-    getOriginIP(): string;
-    /**
-     * 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
-     */
-    setFixedPathParams(keys: any[], result: any[]): void;
-}
-/**
- * Enum representing the HTTP methods.
- */
-export declare enum HttpMethod {
-    GET = "GET",
-    HEAD = "HEAD",
-    POST = "POST",
-    PUT = "PUT",
-    DELETE = "DELETE",
-    CONNECT = "CONNECT",
-    OPTIONS = "OPTIONS",
-    TRACE = "TRACE",
-    PATCH = "PATCH"
-}

package/dist/src/API/Request.js

@@ -1,185 +0,0 @@
-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 {
-    /**
-     * 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, context, 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.
-     */
-    containsQueryParam(paramName) {
-        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.
-     */
-    getQueryParam(paramName) {
-        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.
-     */
-    getHeader(headerName) {
-        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.
-     */
-    getContextParam(cxtParam) {
-        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.
-     */
-    containsPathParam(paramName) {
-        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.
-     */
-    getPathParam(paramName) {
-        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.
-     */
-    getBody(raw) {
-        const body = this.requestEvent.body;
-        if (raw)
-            return Utils.isHybridlessContainer() ? this.requestEvent['rawBody'] : body;
-        if (typeof body === 'string' || body instanceof String) {
-            try {
-                return JSON.parse(body);
-            }
-            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.
-     */
-    getPath() {
-        return this.requestEvent.path;
-    }
-    /**
-     * Retrieves the HTTP method of the current request.
-     * @returns {string} The HTTP method of the request.
-     */
-    getMethod() {
-        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.
-     */
-    getPathParams() {
-        // type conversion guaranteed by validation
-        return this.requestEvent.pathParameters;
-    }
-    /**
-     * Retrieves the query parameters from the request event.
-     * @returns {QueryParamsType | null} - The query parameters object, or null if not found.
-     */
-    getQueryParams() {
-        // type conversion guaranteed by validation
-        return this.requestEvent.queryStringParameters;
-    }
-    /**
-     * Retrieves the value of the 'Authorization' header from the request.
-     * @returns The value of the 'Authorization' header, or null if it is not present.
-     */
-    getAuthorizationHeader() {
-        return this.getHeader('Authorization');
-    }
-    /**
-     * Retrieves the request ID associated with the current execution context.
-     * @returns {string} The request ID.
-     */
-    getRequestID() {
-        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'.
-     */
-    getOriginIP() {
-        var _a;
-        const origin = (_a = this.getContextParam('identity')) === null || _a === void 0 ? void 0 : _a.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
-     */
-    setFixedPathParams(keys, result) {
-        if (!this.requestEvent.pathParameters)
-            this.requestEvent.pathParameters = {};
-        keys.forEach((key, index) => {
-            var _a;
-            if ((_a = this.requestEvent) === null || _a === void 0 ? void 0 : _a.pathParameters) {
-                this.requestEvent.pathParameters[key.name] = result[index + 1];
-            }
-        });
-    }
-}
-/**
- * Enum representing the HTTP methods.
- */
-export var HttpMethod;
-(function (HttpMethod) {
-    HttpMethod["GET"] = "GET";
-    HttpMethod["HEAD"] = "HEAD";
-    HttpMethod["POST"] = "POST";
-    HttpMethod["PUT"] = "PUT";
-    HttpMethod["DELETE"] = "DELETE";
-    HttpMethod["CONNECT"] = "CONNECT";
-    HttpMethod["OPTIONS"] = "OPTIONS";
-    HttpMethod["TRACE"] = "TRACE";
-    HttpMethod["PATCH"] = "PATCH";
-})(HttpMethod || (HttpMethod = {}));
-//# sourceMappingURL=Request.js.map

package/dist/src/API/Request.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"Request.js","sourceRoot":"","sources":["../../../src/API/Request.ts"],"names":[],"mappings":"AAGA,OAAO,KAAK,MAAM,kBAAkB,CAAA;AAEpC;;;;;;GAMG;AACH,MAAM,CAAC,OAAO,OAAO,OAAO;IAW1B;;;;;;OAMG;IACH,YAAY,YAA6B,EAAE,OAAgB,EAAE,MAAc;QACzE,IAAI,CAAC,YAAY,GAAG,YAAY,CAAA;QAChC,IAAI,CAAC,OAAO,GAAG,OAAO,CAAA;QACtB,MAAM,CAAC,KAAK,CAAC,eAAe,EAAE,YAAY,CAAC,CAAA;QAC3C,MAAM,CAAC,KAAK,CAAC,kBAAkB,EAAE,OAAO,CAAC,CAAA;IAC3C,CAAC;IAED;;;;OAIG;IACI,kBAAkB,CAAC,SAAgC;QACxD,MAAM,GAAG,GAAG,IAAI,CAAC,aAAa,CAAC,SAAS,CAAC,CAAA;QACzC,OAAO,CAAC,CAAC,GAAG,IAAI,CAAC,KAAK,CAAC,aAAa,CAAC,GAAG,CAAC,IAAI,KAAK,CAAC,aAAa,CAAC,GAAG,CAAC,CAAC,CAAA;IACxE,CAAC;IAED;;;;OAIG;IACI,aAAa,CAAC,SAAgC;QACnD,OAAO,KAAK,CAAC,2BAA2B,CACtC,IAAI,CAAC,YAAY,CAAC,qBAAqB,EACvC,MAAM,CAAC,SAAS,CAAC,CAClB,CAAA;IACH,CAAC;IAED;;;;OAIG;IACI,SAAS,CAAC,UAAkB;QACjC,OAAO,KAAK,CAAC,2BAA2B,CAAC,IAAI,CAAC,YAAY,CAAC,OAAO,EAAE,UAAU,CAAC,CAAA;IACjF,CAAC;IAED;;;;OAIG;IACI,eAAe,CAAC,QAAgB;QACrC,OAAO,KAAK,CAAC,2BAA2B,CAAC,IAAI,CAAC,YAAY,CAAC,cAAc,EAAE,QAAQ,CAAC,CAAA;IACtF,CAAC;IAED;;;;OAIG;IACI,iBAAiB,CAAC,SAA+B;QACtD,MAAM,GAAG,GAAG,IAAI,CAAC,YAAY,CAAC,SAAS,CAAC,CAAA;QACxC,OAAO,CAAC,CAAC,GAAG,IAAI,CAAC,KAAK,CAAC,aAAa,CAAC,GAAG,CAAC,IAAI,KAAK,CAAC,aAAa,CAAC,GAAG,CAAC,CAAC,CAAA;IACxE,CAAC;IAED;;;;OAIG;IACI,YAAY,CAAC,SAA+B;QACjD,OAAO,KAAK,CAAC,2BAA2B,CAAC,IAAI,CAAC,YAAY,CAAC,cAAc,EAAE,MAAM,CAAC,SAAS,CAAC,CAAC,CAAA;IAC/F,CAAC;IAED;;;OAGG;IACI,OAAO,CAAC,GAAa;QAC1B,MAAM,IAAI,GAAQ,IAAI,CAAC,YAAY,CAAC,IAAI,CAAA;QAExC,IAAI,GAAG;YAAE,OAAO,KAAK,CAAC,qBAAqB,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC,YAAY,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC,IAAI,CAAA;QAEnF,IAAI,OAAO,IAAI,KAAK,QAAQ,IAAI,IAAI,YAAY,MAAM,EAAE,CAAC;YACvD,IAAI,CAAC;gBACH,OAAO,IAAI,CAAC,KAAK,CAAC,IAAc,CAAC,CAAA;YACnC,CAAC;YAAC,OAAO,CAAC,EAAE,CAAC;gBACX,OAAO,CAAC,KAAK,CAAC,mCAAmC,EAAE,CAAC,CAAC,CAAA;YACvD,CAAC;QACH,CAAC;QAED,OAAO,IAAI,CAAA;IACb,CAAC;IAED;;;OAGG;IACI,OAAO;QACZ,OAAO,IAAI,CAAC,YAAY,CAAC,IAAI,CAAA;IAC/B,CAAC;IAED;;;OAGG;IACI,SAAS;QACd,IAAI,IAAI,CAAC,YAAY,CAAC,UAAU,EAAE,CAAC;YACjC,MAAM,UAAU,GAAG,IAAI,CAAC,YAAY,CAAC,UAAU,CAAC,WAAW,EAAE,CAAA;YAC7D,IAAI,UAAU,IAAI,UAAU,EAAE,CAAC;gBAC7B,OAAO,UAAU,CAAC,UAAU,CAAC,CAAA;YAC/B,CAAC;QACH,CAAC;QAED,MAAM,IAAI,KAAK,CAAC,wBAAwB,IAAI,CAAC,YAAY,CAAC,UAAU,EAAE,CAAC,CAAA;IACzE,CAAC;IAED;;;OAGG;IACI,aAAa;QAClB,2CAA2C;QAC3C,OAAO,IAAI,CAAC,YAAY,CAAC,cAAgC,CAAA;IAC3D,CAAC;IAED;;;OAGG;IACI,cAAc;QACnB,2CAA2C;QAC3C,OAAO,IAAI,CAAC,YAAY,CAAC,qBAAwC,CAAA;IACnE,CAAC;IAED;;;OAGG;IACI,sBAAsB;QAC3B,OAAO,IAAI,CAAC,SAAS,CAAC,eAAe,CAAC,CAAA;IACxC,CAAC;IAED;;;OAGG;IACI,YAAY;QACjB,IAAI,IAAI,CAAC,OAAO,CAAC,YAAY;YAAE,OAAO,IAAI,CAAC,OAAO,CAAC,YAAY,CAAA;QAC/D,OAAO,IAAI,CAAC,YAAY,CAAC,cAAc,CAAC,CAAC,CAAC,IAAI,CAAC,YAAY,CAAC,cAAc,CAAC,SAAS,CAAC,CAAC,CAAC,SAAS,CAAA;IAClG,CAAC;IAED;;;OAGG;IACI,WAAW;;QAChB,MAAM,MAAM,GAAG,MAAA,IAAI,CAAC,eAAe,CAAC,UAAU,CAAC,0CAAE,QAAQ,CAAA;QACzD,MAAM,OAAO,GAAG,IAAI,CAAC,SAAS,CAAC,iBAAiB,CAAC,CAAA;QACjD,OAAO,MAAM,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,SAAS,CAAA;IACxD,CAAC;IAED;;;;;OAKG;IACI,kBAAkB,CAAC,IAAW,EAAE,MAAa;QAClD,IAAI,CAAC,IAAI,CAAC,YAAY,CAAC,cAAc;YAAE,IAAI,CAAC,YAAY,CAAC,cAAc,GAAG,EAAE,CAAA;QAC5E,IAAI,CAAC,OAAO,CAAC,CAAC,GAAG,EAAE,KAAK,EAAE,EAAE;;YAC1B,IAAI,MAAA,IAAI,CAAC,YAAY,0CAAE,cAAc,EAAE,CAAC;gBACtC,IAAI,CAAC,YAAY,CAAC,cAAc,CAAC,GAAG,CAAC,IAAI,CAAC,GAAG,MAAM,CAAC,KAAK,GAAG,CAAC,CAAC,CAAA;YAChE,CAAC;QACH,CAAC,CAAC,CAAA;IACJ,CAAC;CACF;AAED;;GAEG;AACH,MAAM,CAAN,IAAY,UAUX;AAVD,WAAY,UAAU;IACpB,yBAAW,CAAA;IACX,2BAAa,CAAA;IACb,2BAAa,CAAA;IACb,yBAAW,CAAA;IACX,+BAAiB,CAAA;IACjB,iCAAmB,CAAA;IACnB,iCAAmB,CAAA;IACnB,6BAAe,CAAA;IACf,6BAAe,CAAA;AACjB,CAAC,EAVW,UAAU,KAAV,UAAU,QAUrB"}

package/dist/src/API/Response.d.ts

@@ -1,188 +0,0 @@
-import type { Context } from 'aws-lambda';
-import Transaction from '../BaseEvent/Transaction.js';
-/**
- * Represents an error response from an API.
- * @typedef {Object} ResponseErrorType
- * @property {string} err - The error message.
- * @property {string} [errCode] - The error code, if available.
- */
-export type ResponseErrorType = {
-    err: string;
-    errCode?: string;
-};
-/**
- * Represents a response object with various methods for building and manipulating the response.
- * @template BodyType - The type of the response body.
- */
-export default class Response<BodyType = null> {
-    /**
-     * The private property that stores the status code.
-     * @type {number}
-     * @private
-     */
-    private statusCode;
-    /**
-     * Private property representing the body of an object.
-     * @type {any}
-     * @private
-     */
-    private body;
-    /**
-     * Indicates whether the object is currently piping out.
-     * @type {boolean}
-     */
-    private isPipingOut;
-    /**
-     * Private property that stores the headers as an object.
-     */
-    private headers;
-    /**
-     * Determines whether streaming is enabled or not.
-     * @returns {boolean} - True if streaming is enabled, false otherwise.
-     */
-    readonly shouldStream: boolean;
-    /**
-     * Indicates whether the request body should be treated as raw data.
-     * @type {boolean}
-     */
-    readonly rawBody: boolean;
-    /**
-     * A boolean flag indicating whether to throw an error when encountering errors.
-     * If set to true, any errors encountered will result in an exception being thrown.
-     * If set to false, errors will be logged but the program will continue execution.
-     */
-    readonly throwOnErrors: boolean;
-    /**
-     * Indicates whether the transaction ID is disabled.
-     * @type {boolean}
-     */
-    readonly disableTransactionID: boolean;
-    /**
-     * Constructs a new Response object with the given status code, body, and optional behavior.
-     * @param {number} statusCode - The HTTP status code of the response.
-     * @param {BodyType} body - The body of the response.
-     * @param {Object} [optBehaviour] - Optional behavior configuration for the response.
-     * @param {boolean} [optBehaviour.shouldStream] - Indicates whether the response should be streamed.
-     * @param {boolean} [optBehaviour.rawBody] - Indicates whether the response body should be treated as raw data.
-     * @param {boolean} [optBehaviour.throwOnErrors] - Indicates whether errors should be thrown for non-successful status codes.
-     * @param {boolean} [optBehaviour
-     */
-    constructor(statusCode: number, body: BodyType, optBehaviour?: {
-        shouldStream?: boolean;
-        rawBody?: boolean;
-        throwOnErrors?: boolean;
-        disableTransactionID?: boolean;
-    } | undefined);
-    /**
-     * Get the status code of the response.
-     * @returns {number} The status code.
-     */
-    getCode(): number;
-    /**
-     * Get the body of the object.
-     * @returns {BodyType} The body of the object.
-     */
-    getBody(): BodyType;
-    /**
-     * Appends a key-value pair into the body object.
-     * @param {string} key - The key to append.
-     * @param {any} value - The value to append.
-     * @returns None
-     */
-    appendIntoBody(key: string, value: any): void;
-    /**
-     * Appends a header to the existing headers object.
-     * @param {string} key - The key of the header.
-     * @param {any} value - The value of the header.
-     * @returns None
-     */
-    appendHeader(key: string, value: any): void;
-    /**
-     * Builds the response for the given context and transaction.
-     * @param {Context} context - The context object.
-     * @param {Transaction<any, any, any>} transaction - The transaction object.
-     * @param {boolean} optDoNotCallContext - Optional flag to indicate whether to call the context or not.
-     * @returns {Promise<void>} - A promise that resolves when the response is built.
-     */
-    build(context: Context, transaction: Transaction<any, any, any, any, any>, optDoNotCallContext: boolean): Promise<void>;
-    /**
-     * Private method that pipes the response to the given context.
-     * @param {Context} context - The context object provided by AWS Lambda.
-     * @returns None
-     */
-    private pipe;
-    /**
-     * Private method that handles the raw context of a transaction.
-     * @param {Context} context - The context object.
-     * @param {Transaction<null, BodyType>} transaction - The transaction object.
-     * @returns None
-     */
-    private rawContext;
-    /**
-     * Generates a response object for a missing path parameter error.
-     * @param {string} paramName - The name of the missing path parameter.
-     * @returns {Response<ResponseErrorType>} - The response object with error details.
-     */
-    static MissingParamResponse(paramName: string): Response<ResponseErrorType>;
-    /**
-     * Creates a response object for a missing query parameter error.
-     * @param {string} paramName - The name of the missing query parameter.
-     * @returns {Response<ResponseErrorType>} - The response object with error details.
-     */
-    static MissingQueryResponse(paramName: string): Response<ResponseErrorType>;
-    /**
-     * Creates a BadRequestResponse object with the given parameters.
-     * @param {string} [msg] - The error message.
-     * @param {string} [errCode] - The error code.
-     * @param {any} [optBody] - Optional additional body data.
-     * @returns {Response<ResponseErrorType>} - The BadRequestResponse object.
-     */
-    static BadRequestResponse(msg?: string, errCode?: string, optBody?: any): Response<ResponseErrorType>;
-    /**
-     * Creates a BadRequestResponse object with rollback option.
-     * @param {string} msg - The error message.
-     * @param {string} [errCode] - The error code.
-     * @param {any} [optBody] - Optional body to include in the response.
-     * @returns {Response<ResponseErrorType>} - The BadRequestResponse object.
-     */
-    static BadRequestResponseWithRollback(msg: string, errCode?: string, optBody?: any): Response<ResponseErrorType>;
-    /**
-     * Creates an unauthorized response with the given error message and error code.
-     * @param {string} msg - The error message.
-     * @param {string} [errCode] - The error code (optional).
-     * @returns {Response<ResponseErrorType>} - The unauthorized response.
-     */
-    static UnauthorizedResponse(msg: string, errCode?: string): Response<ResponseErrorType>;
-    /**
-     * Creates a success response object with the given body.
-     * @param {BodyType} body - The body of the response.
-     * @returns {Response<BodyType>} - The success response object.
-     */
-    static SuccessResponse<BodyType>(body: BodyType): Response<BodyType>;
-    /**
-     * Creates a redirect response with the specified URL.
-     * @param {string} url - The URL to redirect to.
-     * @returns {Response<null>} - The redirect response.
-     */
-    static RedirectResponse(url: string): Response<null>;
-    /**
-     * Creates a success response with no content.
-     * @returns {Response<null>} A response object with a status code of 204 and no content.
-     */
-    static SuccessNoContentResponse(): Response<null>;
-    /**
-     * Creates a success response object with a streaming body and specified content type.
-     * @param {any} stream - The stream object to be used as the response body.
-     * @param {string} contentType - The content type of the response.
-     * @returns {Response} - The success response object.
-     */
-    static SuccessStreamResponse(stream: any, contentType: string): Response;
-    /**
-     * Creates a simple HTTP response with the given body and optional status code.
-     * @param {BodyType} body - The body of the response.
-     * @param {number} [optionalCode] - The optional status code of the response. Defaults to 200.
-     * @returns {Response<BodyType>} - The created response object.
-     */
-    static SimpleResponse<BodyType>(body: BodyType, optionalCode?: number): Response<BodyType>;
-    static StepFunctionResponse<BodyType>(body: BodyType, optionalCode?: number): Response<BodyType>;
-}