@creator.co/wapi 1.2.4 → 1.2.6

package/dist/src/API/Request.js

@@ -2,21 +2,16 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 var Utils_1 = require("./Utils");
 /**
- * ${1:Description placeholder}
- *
- * @export
- * @class Request
- * @typedef {Request}
- * @template InputType
+ * Represents a request object with utility methods for accessing request information.
+ * @template InputType - The type of the request body.
  */
 var Request = /** @class */ (function () {
     /**
-     * Creates an instance of Request.
-     *
-     * @constructor
-     * @param {APIGatewayEvent} requestEvent
-     * @param {Context} context
-     * @param {Logger} logger
+     * 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
      */
     function Request(requestEvent, context, logger) {
         this.requestEvent = requestEvent;
@@ -25,73 +20,58 @@ var Request = /** @class */ (function () {
         logger.debug('Request context:', JSON.stringify(context));
     }
     /**
-     * ${1:Description placeholder}
-     *
-     * @public
-     * @param {string} paramName
-     * @returns {boolean}
+     * Checks if the given query parameter exists and has a valid value.
+     * @param {string} paramName - The name of the query parameter to check.
+     * @returns {boolean} - True if the query parameter exists and has a valid value, false otherwise.
      */
     Request.prototype.containsQueryParam = function (paramName) {
         var val = this.getQueryParam(paramName);
         return !!val && (Utils_1.default.isValidString(val) || Utils_1.default.isValidNumber(val));
     };
     /**
-     * ${1:Description placeholder}
-     *
-     * @public
-     * @param {string} paramName
-     * @returns {(string | null)}
+     * Retrieves the value of a query parameter from the request event's query string parameters.
+     * @param {string} 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.
      */
     Request.prototype.getQueryParam = function (paramName) {
         return Utils_1.default.caseInsensitiveObjectForKey(this.requestEvent.queryStringParameters, paramName);
     };
     /**
-     * ${1:Description placeholder}
-     *
-     * @public
-     * @param {string} headerName
-     * @returns {(string | null)}
+     * 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.
      */
     Request.prototype.getHeader = function (headerName) {
         return Utils_1.default.caseInsensitiveObjectForKey(this.requestEvent.headers, headerName);
     };
-    //context params
     /**
-     * ${1:Description placeholder}
-     *
-     * @public
-     * @param {string} cxtParam
-     * @returns {(any | 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.
      */
     Request.prototype.getContextParam = function (cxtParam) {
         return Utils_1.default.caseInsensitiveObjectForKey(this.requestEvent.requestContext, cxtParam);
     };
     /**
-     * ${1:Description placeholder}
-     *
-     * @public
-     * @param {string} paramName
-     * @returns {boolean}
+     * Checks if the given parameter name exists in the path parameters and if its value is a valid string or number.
+     * @param {string} paramName - The name of the parameter to check.
+     * @returns {boolean} - True if the parameter exists and its value is a valid string or number, false otherwise.
      */
     Request.prototype.containsPathParam = function (paramName) {
         var val = this.getPathParam(paramName);
         return !!val && (Utils_1.default.isValidString(val) || Utils_1.default.isValidNumber(val));
     };
     /**
-     * ${1:Description placeholder}
-     *
-     * @public
-     * @param {string} paramName
-     * @returns {(string | null)}
+     * Retrieves the value of a path parameter from the request event.
+     * @param {string} paramName - The name of the path parameter to retrieve.
+     * @returns {string | null} The value of the path parameter, or null if it does not exist.
      */
     Request.prototype.getPathParam = function (paramName) {
         return Utils_1.default.caseInsensitiveObjectForKey(this.requestEvent.pathParameters, paramName);
     };
     /**
-     * ${1:Description placeholder}
-     *
-     * @public
-     * @returns {InputType}
+     * Retrieves the body of the request event and parses it if it is a string.
+     * @returns {InputType} The parsed body of the request event.
      */
     Request.prototype.getBody = function () {
         var b = null;
@@ -106,46 +86,36 @@ var Request = /** @class */ (function () {
         return b;
     };
     /**
-     * ${1:Description placeholder}
-     *
-     * @public
-     * @returns {string}
+     * Retrieves the path from the request event.
+     * @returns {string} The path of the request event.
      */
     Request.prototype.getPath = function () {
         return this.requestEvent.path;
     };
     /**
-     * ${1:Description placeholder}
-     *
-     * @public
-     * @returns {string}
+     * Retrieves the HTTP method of the current request.
+     * @returns {string} The HTTP method of the request.
      */
     Request.prototype.getMethod = function () {
         return this.requestEvent.httpMethod;
     };
     /**
-     * ${1:Description placeholder}
-     *
-     * @public
-     * @returns {(object | null)}
+     * Retrieves the path parameters from the request event.
+     * @returns {object | null} - The path parameters object, or null if not found.
      */
     Request.prototype.getPathParams = function () {
         return this.requestEvent.pathParameters;
     };
     /**
-     * ${1:Description placeholder}
-     *
-     * @public
-     * @returns {(string | null)}
+     * Retrieves the value of the 'Authorization' header from the request.
+     * @returns The value of the 'Authorization' header, or null if it is not present.
      */
     Request.prototype.getAuthorizationHeader = function () {
         return this.getHeader('Authorization');
     };
     /**
-     * ${1:Description placeholder}
-     *
-     * @public
-     * @returns {string}
+     * Retrieves the request ID associated with the current execution context.
+     * @returns {string} The request ID.
      */
     Request.prototype.getRequestID = function () {
         if (this.context.awsRequestId)
@@ -153,10 +123,8 @@ var Request = /** @class */ (function () {
         return this.requestEvent.requestContext ? this.requestEvent.requestContext.requestId : 'unknown';
     };
     /**
-     * ${1:Description placeholder}
-     *
-     * @public
-     * @returns {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'.
      */
     Request.prototype.getOriginIP = function () {
         var _a;
@@ -165,16 +133,20 @@ var Request = /** @class */ (function () {
         return origin ? origin : hOrigin ? hOrigin : 'unknown';
     };
     /**
-     * ${1:Description placeholder}
-     *
-     * @public
-     * @param {any[]} keys
-     * @param {any[]} result
+     * 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
      */
     Request.prototype.setFixedPathParams = function (keys, result) {
         var _this = this;
         this.requestEvent.pathParameters = {};
-        keys.forEach(function (key, index) { return (_this.requestEvent.pathParameters[key.name] = result[index + 1]); });
+        keys.forEach(function (key, index) {
+            var _a;
+            if ((_a = _this.requestEvent) === null || _a === void 0 ? void 0 : _a.pathParameters) {
+                _this.requestEvent.pathParameters[key.name] = result[index + 1];
+            }
+        });
     };
     return Request;
 }());

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

@@ -1 +1 @@
-{"version":3,"file":"Request.js","sourceRoot":"","sources":["../../../src/API/Request.ts"],"names":[],"mappings":";;AAEA,iCAA2B;AAE3B;;;;;;;GAOG;AACH;IAeE;;;;;;;OAOG;IACH,iBAAY,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,IAAI,CAAC,SAAS,CAAC,YAAY,CAAC,CAAC,CAAA;QAC3D,MAAM,CAAC,KAAK,CAAC,kBAAkB,EAAE,IAAI,CAAC,SAAS,CAAC,OAAO,CAAC,CAAC,CAAA;IAC3D,CAAC;IACD;;;;;;OAMG;IACI,oCAAkB,GAAzB,UAA0B,SAAiB;QACzC,IAAM,GAAG,GAAG,IAAI,CAAC,aAAa,CAAC,SAAS,CAAC,CAAA;QACzC,OAAO,CAAC,CAAC,GAAG,IAAI,CAAC,eAAK,CAAC,aAAa,CAAC,GAAG,CAAC,IAAI,eAAK,CAAC,aAAa,CAAC,GAAG,CAAC,CAAC,CAAA;IACxE,CAAC;IACD;;;;;;OAMG;IACI,+BAAa,GAApB,UAAqB,SAAiB;QACpC,OAAO,eAAK,CAAC,2BAA2B,CAAC,IAAI,CAAC,YAAY,CAAC,qBAAqB,EAAE,SAAS,CAAC,CAAA;IAC9F,CAAC;IACD;;;;;;OAMG;IACI,2BAAS,GAAhB,UAAiB,UAAkB;QACjC,OAAO,eAAK,CAAC,2BAA2B,CAAC,IAAI,CAAC,YAAY,CAAC,OAAO,EAAE,UAAU,CAAC,CAAA;IACjF,CAAC;IACD,gBAAgB;IAChB;;;;;;OAMG;IACI,iCAAe,GAAtB,UAAuB,QAAgB;QACrC,OAAO,eAAK,CAAC,2BAA2B,CAAC,IAAI,CAAC,YAAY,CAAC,cAAc,EAAE,QAAQ,CAAC,CAAA;IACtF,CAAC;IACD;;;;;;OAMG;IACI,mCAAiB,GAAxB,UAAyB,SAAiB;QACxC,IAAM,GAAG,GAAG,IAAI,CAAC,YAAY,CAAC,SAAS,CAAC,CAAA;QACxC,OAAO,CAAC,CAAC,GAAG,IAAI,CAAC,eAAK,CAAC,aAAa,CAAC,GAAG,CAAC,IAAI,eAAK,CAAC,aAAa,CAAC,GAAG,CAAC,CAAC,CAAA;IACxE,CAAC;IACD;;;;;;OAMG;IACI,8BAAY,GAAnB,UAAoB,SAAiB;QACnC,OAAO,eAAK,CAAC,2BAA2B,CAAC,IAAI,CAAC,YAAY,CAAC,cAAc,EAAE,SAAS,CAAC,CAAA;IACvF,CAAC;IACD;;;;;OAKG;IACI,yBAAO,GAAd;QACE,IAAI,CAAC,GAAQ,IAAI,CAAA;QACjB,IAAI;YACF,CAAC,GAAG,IAAI,CAAC,YAAY,CAAC,IAAI,CAAA;YAC1B,IAAI,OAAO,CAAC,KAAK,QAAQ,IAAI,CAAC,YAAY,MAAM;gBAAE,CAAC,GAAG,IAAI,CAAC,KAAK,CAAC,CAAW,CAAC,CAAA;SAC9E;QAAC,OAAO,CAAC,EAAE;YACV,OAAO,CAAC,KAAK,CAAC,mCAAmC,EAAE,CAAC,CAAC,CAAA;SACtD;QACD,OAAO,CAAC,CAAA;IACV,CAAC;IACD;;;;;OAKG;IACI,yBAAO,GAAd;QACE,OAAO,IAAI,CAAC,YAAY,CAAC,IAAI,CAAA;IAC/B,CAAC;IACD;;;;;OAKG;IACI,2BAAS,GAAhB;QACE,OAAO,IAAI,CAAC,YAAY,CAAC,UAAU,CAAA;IACrC,CAAC;IACD;;;;;OAKG;IACI,+BAAa,GAApB;QACE,OAAO,IAAI,CAAC,YAAY,CAAC,cAAc,CAAA;IACzC,CAAC;IACD;;;;;OAKG;IACI,wCAAsB,GAA7B;QACE,OAAO,IAAI,CAAC,SAAS,CAAC,eAAe,CAAC,CAAA;IACxC,CAAC;IACD;;;;;OAKG;IACI,8BAAY,GAAnB;QACE,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;IACD;;;;;OAKG;IACI,6BAAW,GAAlB;;QACE,IAAM,MAAM,GAAG,MAAA,IAAI,CAAC,eAAe,CAAC,UAAU,CAAC,0CAAE,QAAQ,CAAA;QACzD,IAAM,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;IACD;;;;;;OAMG;IACI,oCAAkB,GAAzB,UAA0B,IAAW,EAAE,MAAa;QAApD,iBAGC;QAFC,IAAI,CAAC,YAAY,CAAC,cAAc,GAAG,EAAE,CAAA;QACrC,IAAI,CAAC,OAAO,CAAC,UAAC,GAAG,EAAE,KAAK,IAAK,OAAA,CAAC,KAAI,CAAC,YAAY,CAAC,cAAc,CAAC,GAAG,CAAC,IAAI,CAAC,GAAG,MAAM,CAAC,KAAK,GAAG,CAAC,CAAC,CAAC,EAAhE,CAAgE,CAAC,CAAA;IAChG,CAAC;IACH,cAAC;AAAD,CAAC,AAhLD,IAgLC"}
+{"version":3,"file":"Request.js","sourceRoot":"","sources":["../../../src/API/Request.ts"],"names":[],"mappings":";;AAEA,iCAA2B;AAG3B;;;GAGG;AACH;IAWE;;;;;;OAMG;IACH,iBAAY,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,IAAI,CAAC,SAAS,CAAC,YAAY,CAAC,CAAC,CAAA;QAC3D,MAAM,CAAC,KAAK,CAAC,kBAAkB,EAAE,IAAI,CAAC,SAAS,CAAC,OAAO,CAAC,CAAC,CAAA;IAC3D,CAAC;IAED;;;;OAIG;IACI,oCAAkB,GAAzB,UAA0B,SAAiB;QACzC,IAAM,GAAG,GAAG,IAAI,CAAC,aAAa,CAAC,SAAS,CAAC,CAAA;QACzC,OAAO,CAAC,CAAC,GAAG,IAAI,CAAC,eAAK,CAAC,aAAa,CAAC,GAAG,CAAC,IAAI,eAAK,CAAC,aAAa,CAAC,GAAG,CAAC,CAAC,CAAA;IACxE,CAAC;IAED;;;;OAIG;IACI,+BAAa,GAApB,UAAqB,SAAiB;QACpC,OAAO,eAAK,CAAC,2BAA2B,CAAC,IAAI,CAAC,YAAY,CAAC,qBAAqB,EAAE,SAAS,CAAC,CAAA;IAC9F,CAAC;IAED;;;;OAIG;IACI,2BAAS,GAAhB,UAAiB,UAAkB;QACjC,OAAO,eAAK,CAAC,2BAA2B,CAAC,IAAI,CAAC,YAAY,CAAC,OAAO,EAAE,UAAU,CAAC,CAAA;IACjF,CAAC;IAED;;;;OAIG;IACI,iCAAe,GAAtB,UAAuB,QAAgB;QACrC,OAAO,eAAK,CAAC,2BAA2B,CAAC,IAAI,CAAC,YAAY,CAAC,cAAc,EAAE,QAAQ,CAAC,CAAA;IACtF,CAAC;IAED;;;;OAIG;IACI,mCAAiB,GAAxB,UAAyB,SAAiB;QACxC,IAAM,GAAG,GAAG,IAAI,CAAC,YAAY,CAAC,SAAS,CAAC,CAAA;QACxC,OAAO,CAAC,CAAC,GAAG,IAAI,CAAC,eAAK,CAAC,aAAa,CAAC,GAAG,CAAC,IAAI,eAAK,CAAC,aAAa,CAAC,GAAG,CAAC,CAAC,CAAA;IACxE,CAAC;IAED;;;;OAIG;IACI,8BAAY,GAAnB,UAAoB,SAAiB;QACnC,OAAO,eAAK,CAAC,2BAA2B,CAAC,IAAI,CAAC,YAAY,CAAC,cAAc,EAAE,SAAS,CAAC,CAAA;IACvF,CAAC;IAED;;;OAGG;IACI,yBAAO,GAAd;QACE,IAAI,CAAC,GAAQ,IAAI,CAAA;QACjB,IAAI;YACF,CAAC,GAAG,IAAI,CAAC,YAAY,CAAC,IAAI,CAAA;YAC1B,IAAI,OAAO,CAAC,KAAK,QAAQ,IAAI,CAAC,YAAY,MAAM;gBAAE,CAAC,GAAG,IAAI,CAAC,KAAK,CAAC,CAAW,CAAC,CAAA;SAC9E;QAAC,OAAO,CAAC,EAAE;YACV,OAAO,CAAC,KAAK,CAAC,mCAAmC,EAAE,CAAC,CAAC,CAAA;SACtD;QACD,OAAO,CAAC,CAAA;IACV,CAAC;IAED;;;OAGG;IACI,yBAAO,GAAd;QACE,OAAO,IAAI,CAAC,YAAY,CAAC,IAAI,CAAA;IAC/B,CAAC;IAED;;;OAGG;IACI,2BAAS,GAAhB;QACE,OAAO,IAAI,CAAC,YAAY,CAAC,UAAU,CAAA;IACrC,CAAC;IAED;;;OAGG;IACI,+BAAa,GAApB;QACE,OAAO,IAAI,CAAC,YAAY,CAAC,cAAc,CAAA;IACzC,CAAC;IAED;;;OAGG;IACI,wCAAsB,GAA7B;QACE,OAAO,IAAI,CAAC,SAAS,CAAC,eAAe,CAAC,CAAA;IACxC,CAAC;IAED;;;OAGG;IACI,8BAAY,GAAnB;QACE,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,6BAAW,GAAlB;;QACE,IAAM,MAAM,GAAG,MAAA,IAAI,CAAC,eAAe,CAAC,UAAU,CAAC,0CAAE,QAAQ,CAAA;QACzD,IAAM,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,oCAAkB,GAAzB,UAA0B,IAAW,EAAE,MAAa;QAApD,iBAOC;QANC,IAAI,CAAC,YAAY,CAAC,cAAc,GAAG,EAAE,CAAA;QACrC,IAAI,CAAC,OAAO,CAAC,UAAC,GAAG,EAAE,KAAK;;YACtB,IAAI,MAAA,KAAI,CAAC,YAAY,0CAAE,cAAc,EAAE;gBACrC,KAAI,CAAC,YAAY,CAAC,cAAc,CAAC,GAAG,CAAC,IAAI,CAAC,GAAG,MAAM,CAAC,KAAK,GAAG,CAAC,CAAC,CAAA;aAC/D;QACH,CAAC,CAAC,CAAA;IACJ,CAAC;IACH,cAAC;AAAD,CAAC,AAjKD,IAiKC"}

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

@@ -1,97 +1,71 @@
 import type { Context } from 'aws-lambda';
 import Transaction from '../BaseEvent/Transaction';
 /**
- * ${1:Description placeholder}
- *
- * @export
- * @typedef {ResponseErrorType}
+ * 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;
 };
 /**
- * ${1:Description placeholder}
- *
- * @export
- * @class Response
- * @typedef {Response}
- * @template [BodyType=null]
+ * 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> {
     /**
-     * ${1:Description placeholder}
-     *
-     * @private
+     * The private property that stores the status code.
      * @type {number}
+     * @private
      */
-    private _statusCode;
+    private statusCode;
     /**
-     * ${1:Description placeholder}
-     *
+     * Private property representing the body of an object.
+     * @type {any}
      * @private
-     * @type {*}
      */
-    private _body;
+    private body;
     /**
-     * ${1:Description placeholder}
-     *
-     * @private
+     * Indicates whether the object is currently piping out.
      * @type {boolean}
      */
-    private _isPipingOut;
+    private isPipingOut;
     /**
-     * ${1:Description placeholder}
-     *
-     * @private
-     * @type {object}
+     * Private property that stores the headers as an object.
      */
-    private _headers;
+    private headers;
     /**
-     * ${1:Description placeholder}
-     *
-     * @public
-     * @readonly
-     * @type {boolean}
+     * Determines whether streaming is enabled or not.
+     * @returns {boolean} - True if streaming is enabled, false otherwise.
      */
     readonly shouldStream: boolean;
     /**
-     * ${1:Description placeholder}
-     *
-     * @public
-     * @readonly
+     * Indicates whether the request body should be treated as raw data.
      * @type {boolean}
      */
     readonly rawBody: boolean;
     /**
-     * ${1:Description placeholder}
-     *
-     * @public
-     * @readonly
-     * @type {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;
     /**
-     * ${1:Description placeholder}
-     *
-     * @public
-     * @readonly
+     * Indicates whether the transaction ID is disabled.
      * @type {boolean}
      */
     readonly disableTransactionID: boolean;
     /**
-     * Creates an instance of Response.
-     *
-     * @constructor
-     * @param {number} statusCode
-     * @param {BodyType} body
-     * @param {?(| {
-     *           shouldStream?: boolean
-     *           rawBody?: boolean
-     *           throwOnErrors?: boolean
-     *           disableTransactionID?: boolean
-     *         }
-     *       | undefined)\} [optBehaviour]
+     * 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;
@@ -100,157 +74,114 @@ export default class Response<BodyType = null> {
         disableTransactionID?: boolean;
     } | undefined);
     /**
-     * ${1:Description placeholder}
-     *
-     * @public
-     * @returns {number}
+     * Get the status code of the response.
+     * @returns {number} The status code.
      */
     getCode(): number;
     /**
-     * ${1:Description placeholder}
-     *
-     * @public
-     * @returns {BodyType}
+     * Get the body of the object.
+     * @returns {BodyType} The body of the object.
      */
     getBody(): BodyType;
     /**
-     * ${1:Description placeholder}
-     *
-     * @public
-     * @param {string} key
-     * @param {*} value
+     * 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;
     /**
-     * ${1:Description placeholder}
-     *
-     * @public
-     * @param {string} key
-     * @param {*} value
+     * 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;
     /**
-     * ${1:Description placeholder}
-     *
-     * @public
-     * @async
-     * @param {Context} context
-     * @param {Transaction<any, any, any>} transaction
-     * @param {boolean} _optDoNotCallContext
-     * @returns {Promise<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>, _optDoNotCallContext: boolean): Promise<void>;
+    build(context: Context, transaction: Transaction<any, any, any>, optDoNotCallContext: boolean): Promise<void>;
     /**
-     * ${1:Description placeholder}
-     *
-     * @private
-     * @param {Context} context
+     * 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 pipe;
     /**
-     * ${1:Description placeholder}
-     *
-     * @private
-     * @param {Context} context
-     * @param {Transaction<null, BodyType>} transaction
+     * 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;
+    private rawContext;
     /**
-     * ${1:Description placeholder}
-     *
-     * @public
-     * @static
-     * @param {string} paramName
-     * @returns {Response<ResponseErrorType>}
+     * 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>;
     /**
-     * ${1:Description placeholder}
-     *
-     * @public
-     * @static
-     * @param {string} paramName
-     * @returns {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>;
     /**
-     * ${1:Description placeholder}
-     *
-     * @public
-     * @static
-     * @param {?string} [msg]
-     * @param {?string} [errCode]
-     * @param {?*} [optBody]
-     * @returns {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>;
     /**
-     * ${1:Description placeholder}
-     *
-     * @public
-     * @static
-     * @param {string} msg
-     * @param {?string} [errCode]
-     * @param {?*} [optBody]
-     * @returns {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>;
     /**
-     * ${1:Description placeholder}
-     *
-     * @public
-     * @static
-     * @param {string} msg
-     * @param {?string} [errCode]
-     * @returns {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>;
     /**
-     * ${1:Description placeholder}
-     *
-     * @public
-     * @static
-     * @template BodyType
-     * @param {BodyType} body
-     * @returns {Response<BodyType>}
+     * 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>;
     /**
-     * ${1:Description placeholder}
-     *
-     * @public
-     * @static
-     * @param {string} url
-     * @returns {Response<null>}
+     * 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>;
     /**
-     * ${1:Description placeholder}
-     *
-     * @public
-     * @static
-     * @returns {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>;
     /**
-     * ${1:Description placeholder}
-     *
-     * @public
-     * @static
-     * @param {*} stream
-     * @param {string} contentType
-     * @returns {Response}
+     * 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;
     /**
-     * ${1:Description placeholder}
-     *
-     * @public
-     * @static
-     * @template BodyType
-     * @param {BodyType} body
-     * @param {?number} [optionalCode]
-     * @returns {Response<BodyType>}
+     * 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>;
 }