@creator.co/wapi 1.2.5 → 1.2.6

package/dist/src/Globals.js

@@ -5,166 +5,97 @@ var Utils_1 = require("./API/Utils");
 // important for dev env to load .env file
 dotenv.config();
 /**
- * Description placeholder
- *
- * @export
- * @class Globals
- * @typedef {Globals}
+ * Class containing global constants and configurations for the application.
  */
 var Globals = /** @class */ (function () {
     function Globals() {
     }
     /**
-     * Description placeholder
-     *
-     * @public
-     * @static
-     * @type {string}
+     * A constant string representing an error message for input validation failure.
      */
     Globals.ErrorResponseValidationFail = 'Input validation failed: '; //400
     /**
-     * Description placeholder
-     *
-     * @public
-     * @static
-     * @type {string}
+     * A constant string representing an error response for an invalid server response.
      */
     Globals.ErrorResponseInvalidServerResponse = 'No valid response, this is a system error.'; //400
     /**
-     * Description placeholder
-     *
-     * @public
-     * @static
-     * @type {string}
+     * The error message for an unhandled error when processing a request.
      */
     Globals.ErrorResponseUnhandledError = 'Unhandled error when processing request.'; //400
     /**
-     * Description placeholder
-     *
-     * @public
-     * @static
-     * @type {string}
+     * A static string representing an error response when there are no records to be processed.
      */
     Globals.ErrorResponseNoRecords = 'No events to be processed.'; //400
     /**
-     * Description placeholder
-     *
-     * @public
-     * @static
+     * Represents an error code for a missing parameter.
      * @type {string}
      */
     Globals.ErrorCode_MissingParam = 'MISSING_PARAM';
     /**
-     * Description placeholder
-     *
-     * @public
-     * @static
+     * Represents an error code for invalid input.
      * @type {string}
      */
     Globals.ErrorCode_InvalidInput = 'INVALID_INPUT';
     /**
-     * Description placeholder
-     *
-     * @public
-     * @static
+     * Represents an error code for an API error.
      * @type {string}
      */
     Globals.ErrorCode_APIError = 'API_ERROR';
     /**
-     * Description placeholder
-     *
-     * @public
-     * @static
+     * Represents the error code for when there are no records found.
      * @type {string}
      */
     Globals.ErrorCode_NoRecords = 'EMPTY_EVENT';
     /**
-     * Description placeholder
-     *
-     * @public
-     * @static
-     * @type {*}
+     * Retrieves the default port number for HTTP listeners.
+     * The port number is obtained from the environment variable "PORT" and parsed as an integer.
+     * If the environment variable is not set or cannot be parsed as an integer, the default port number 9000 is used.
+     * @returns {number} - The default port number for HTTP listeners.
      */
     Globals.Listener_HTTP_DefaultPort = Utils_1.default.parseIntNullIfNaN(process.env.PORT) || 9000;
     /**
-     * Description placeholder
-     *
-     * @public
-     * @static
-     * @type {string}
+     * The default host for the HTTP listener.
      */
     Globals.Listener_HTTP_DefaultHost = 'localhost';
     /**
-     * Description placeholder
-     *
-     * @public
-     * @static
+     * The HTTP proxy route listener for all routes.
      * @type {string}
      */
     Globals.Listener_HTTP_ProxyRoute = '*';
     /**
-     * Description placeholder
-     *
-     * @public
-     * @static
-     * @type {*}
+     * Retrieves the default timeout value for HTTP listeners.
+     * @returns {number} The default timeout value in milliseconds.
      */
     Globals.Listener_HTTP_DefaultTimeout = Utils_1.default.parseIntNullIfNaN(process.env.TIMEOUT) || 30000;
     /**
-     * Description placeholder
-     *
-     * @public
-     * @static
-     * @type {*}
+     * The default health check route for the HTTP listener.
+     * @type {string}
      */
     Globals.Listener_HTTP_DefaultHealthCheckRoute = process.env.HEALTH_ROUTE || '/health';
-    //Resps
     /**
-     * Description placeholder
-     *
-     * @public
-     * @static
-     * @type {string}
+     * The response message for an exception that occurred during request execution in the Proxy.
      */
     Globals.Resp_MSG_EXCEPTION = '[Proxy]: Exception during request execution!';
     /**
-     * Description placeholder
-     *
-     * @public
-     * @static
-     * @type {string}
+     * The response code for an exception that occurred during execution.
      */
     Globals.Resp_CODE_EXCEPTION = 'EXEC_EXCEPTION';
     /**
-     * Description placeholder
-     *
-     * @public
-     * @static
-     * @type {number}
+     * The HTTP response status code for an exception scenario.
      */
     Globals.Resp_STATUSCODE_EXCEPTION = 502;
     /**
-     * Description placeholder
-     *
-     * @public
-     * @static
-     * @type {string}
+     * The error message for an invalid response from the server.
      */
     Globals.Resp_MSG_INVALIDRESP = '[Proxy]: Invalid response from server!';
     /**
-     * Description placeholder
-     *
-     * @public
-     * @static
-     * @type {string}
+     * Represents the response code for an invalid response.
      */
     Globals.Resp_CODE_INVALIDRESP = 'EMPTY_RESPONSE';
     /**
-     * Description placeholder
-     *
-     * @public
-     * @static
+     * The HTTP response status code for an invalid response.
      * @type {number}
+     * @default 400
      */
     Globals.Resp_STATUSCODE_INVALIDRESP = 400;
     return Globals;

package/dist/src/Globals.js.map

@@ -1 +1 @@
-{"version":3,"file":"Globals.js","sourceRoot":"","sources":["../../src/Globals.ts"],"names":[],"mappings":";;AAAA,+BAAgC;AAEhC,qCAA+B;AAE/B,0CAA0C;AAC1C,MAAM,CAAC,MAAM,EAAE,CAAA;AACf;;;;;;GAMG;AACH;IAAA;IA6JA,CAAC;IA5JC;;;;;;OAMG;IACW,mCAA2B,GAAG,2BAA2B,CAAA,CAAC,KAAK;IAC7E;;;;;;OAMG;IACW,0CAAkC,GAAG,4CAA4C,CAAA,CAAC,KAAK;IACrG;;;;;;OAMG;IACW,mCAA2B,GAAG,0CAA0C,CAAA,CAAC,KAAK;IAC5F;;;;;;OAMG;IACW,8BAAsB,GAAG,4BAA4B,CAAA,CAAC,KAAK;IACzE;;;;;;OAMG;IACW,8BAAsB,GAAG,eAAe,CAAA;IACtD;;;;;;OAMG;IACW,8BAAsB,GAAG,eAAe,CAAA;IACtD;;;;;;OAMG;IACW,0BAAkB,GAAG,WAAW,CAAA;IAC9C;;;;;;OAMG;IACW,2BAAmB,GAAG,aAAa,CAAA;IAEjD;;;;;;OAMG;IACW,iCAAyB,GAAG,eAAK,CAAC,iBAAiB,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,CAAC,IAAI,IAAI,CAAA;IAE3F;;;;;;OAMG;IACW,iCAAyB,GAAG,WAAW,CAAA;IACrD;;;;;;OAMG;IACW,gCAAwB,GAAG,GAAG,CAAA;IAC5C;;;;;;OAMG;IACW,oCAA4B,GAAG,eAAK,CAAC,iBAAiB,CAAC,OAAO,CAAC,GAAG,CAAC,OAAO,CAAC,IAAI,KAAK,CAAA;IAClG;;;;;;OAMG;IACW,6CAAqC,GAAG,OAAO,CAAC,GAAG,CAAC,YAAY,IAAI,SAAS,CAAA;IAC3F,OAAO;IACP;;;;;;OAMG;IACW,0BAAkB,GAAG,8CAA8C,CAAA;IACjF;;;;;;OAMG;IACW,2BAAmB,GAAG,gBAAgB,CAAA;IACpD;;;;;;OAMG;IACW,iCAAyB,GAAG,GAAG,CAAA;IAE7C;;;;;;OAMG;IACW,4BAAoB,GAAG,wCAAwC,CAAA;IAC7E;;;;;;OAMG;IACW,6BAAqB,GAAG,gBAAgB,CAAA;IACtD;;;;;;OAMG;IACW,mCAA2B,GAAG,GAAG,CAAA;IACjD,cAAC;CAAA,AA7JD,IA6JC;kBA7JoB,OAAO"}
+{"version":3,"file":"Globals.js","sourceRoot":"","sources":["../../src/Globals.ts"],"names":[],"mappings":";;AAAA,+BAAgC;AAEhC,qCAA+B;AAE/B,0CAA0C;AAC1C,MAAM,CAAC,MAAM,EAAE,CAAA;AAEf;;GAEG;AACH;IAAA;IA4FA,CAAC;IA3FC;;OAEG;IACW,mCAA2B,GAAG,2BAA2B,CAAA,CAAC,KAAK;IAC7E;;OAEG;IACW,0CAAkC,GAAG,4CAA4C,CAAA,CAAC,KAAK;IACrG;;OAEG;IACW,mCAA2B,GAAG,0CAA0C,CAAA,CAAC,KAAK;IAC5F;;OAEG;IACW,8BAAsB,GAAG,4BAA4B,CAAA,CAAC,KAAK;IACzE;;;OAGG;IACW,8BAAsB,GAAG,eAAe,CAAA;IACtD;;;OAGG;IACW,8BAAsB,GAAG,eAAe,CAAA;IACtD;;;OAGG;IACW,0BAAkB,GAAG,WAAW,CAAA;IAC9C;;;OAGG;IACW,2BAAmB,GAAG,aAAa,CAAA;IAEjD;;;;;OAKG;IACW,iCAAyB,GAAG,eAAK,CAAC,iBAAiB,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,CAAC,IAAI,IAAI,CAAA;IAC3F;;OAEG;IACW,iCAAyB,GAAG,WAAW,CAAA;IACrD;;;OAGG;IACW,gCAAwB,GAAG,GAAG,CAAA;IAC5C;;;OAGG;IACW,oCAA4B,GAAG,eAAK,CAAC,iBAAiB,CAAC,OAAO,CAAC,GAAG,CAAC,OAAO,CAAC,IAAI,KAAK,CAAA;IAClG;;;OAGG;IACW,6CAAqC,GAAG,OAAO,CAAC,GAAG,CAAC,YAAY,IAAI,SAAS,CAAA;IAE3F;;OAEG;IACW,0BAAkB,GAAG,8CAA8C,CAAA;IACjF;;OAEG;IACW,2BAAmB,GAAG,gBAAgB,CAAA;IACpD;;OAEG;IACW,iCAAyB,GAAG,GAAG,CAAA;IAE7C;;OAEG;IACW,4BAAoB,GAAG,wCAAwC,CAAA;IAC7E;;OAEG;IACW,6BAAqB,GAAG,gBAAgB,CAAA;IACtD;;;;OAIG;IACW,mCAA2B,GAAG,GAAG,CAAA;IACjD,cAAC;CAAA,AA5FD,IA4FC;kBA5FoB,OAAO"}

package/dist/src/Logger/Logger.d.ts

@@ -1,8 +1,10 @@
 /**
- * ${1:Description placeholder}
- *
- * @export
- * @enum {number}
+ * Enumeration of log levels.
+ * @enum {string}
+ * @property {string} DEBUG - Debug log level.
+ * @property {string} INFO - Info log level.
+ * @property {string} WARN - Warning log level.
+ * @property {string} ERROR - Error log level.
  */
 export declare enum LOG_LEVELS {
     DEBUG = "DEBUG",
@@ -11,170 +13,145 @@ export declare enum LOG_LEVELS {
     ERROR = "ERROR"
 }
 /**
- * ${1:Description placeholder}
- *
- * @export
- * @typedef {LoggerConfig}
+ * Configuration options for the logger.
+ * @typedef {Object} LoggerConfig
+ * @property {boolean | Array<string>} [sensitiveFilteringKeywords] - Specifies whether to filter sensitive keywords in log messages. Can be a boolean value or an array of strings.
+ * @property {LOG_LEVELS | string} [logLevel] - The log level to use for logging. Can be one of the predefined log levels or a custom string value.
  */
 export type LoggerConfig = {
     sensitiveFilteringKeywords?: boolean | Array<string>;
     logLevel?: LOG_LEVELS | string;
 };
 /**
- * ${1:Description placeholder}
- *
- * @export
- * @class Logger
- * @typedef {Logger}
+ * Logger class for logging messages with different log levels.
  */
 export default class Logger {
     /**
-     * ${1:Description placeholder}
-     *
-     * @private
-     * @type {?LoggerConfig}
+     * The optional configuration object for the logger.
      */
-    private _config?;
+    private config?;
     /**
-     * ${1:Description placeholder}
-     *
-     * @private
+     * Private property representing the transaction ID.
      * @type {string}
+     * @private
      */
-    private _transactionID;
+    private transactionID;
     /**
-     * ${1:Description placeholder}
-     *
-     * @private
-     * @type {(Array<string> | false)}
+     * An array of strings representing a blacklist of filters, or false if no blacklist is set.
      */
-    private _filterBlacklist;
+    private filterBlacklist;
     /**
-     * ${1:Description placeholder}
-     *
+     * The current log level for the application.
      * @private
      * @type {LOG_LEVELS}
      */
     private _LOG_LEVEL;
     /**
-     * ${1:Description placeholder}
-     *
+     * The origin of the object.
      * @private
-     * @type {*}
+     * @type {any}
      */
     private origin;
     /**
-     * Creates an instance of Logger.
-     *
-     * @constructor
-     * @param {(LoggerConfig | undefined)} _config
-     * @param {string} transactionID
+     * Constructs a Logger object with the given configuration and transaction ID.
+     * @param {config} config - The configuration object for the logger. Can be undefined.
+     * @param {string} transactionID - The ID of the transaction associated with the logger.
+     * @returns None
      */
-    constructor(_config: LoggerConfig | undefined, transactionID: string);
+    constructor(config: LoggerConfig | undefined, transactionID: string);
     /**
-     * ${1:Description placeholder}
-     *
-     * @public
-     * @returns {boolean}
+     * Returns a boolean value indicating whether the notGlobalLogger function is executed successfully.
+     * @returns {boolean} - true if the function is executed successfully, false otherwise.
      */
     notGlobalLogger(): boolean;
     /**
-     * ${1:Description placeholder}
-     *
-     * @param {...{}\} args
+     * Logs the given arguments with the debug log level.
+     * @param {...any} args - The arguments to be logged.
+     * @returns None
      */
     debug(...args: any[]): void;
     /**
-     * ${1:Description placeholder}
-     *
-     * @param {...{}\} args
+     * Logs the given arguments with the INFO log level.
+     * @param {...any} args - The arguments to be logged.
+     * @returns None
      */
     log(...args: any[]): void;
     /**
-     * ${1:Description placeholder}
-     *
-     * @param {...{}\} args
+     * Logs an informational message.
+     * @param {...any} args - The message(s) to log.
+     * @returns None
      */
     info(...args: any[]): void;
     /**
-     * ${1:Description placeholder}
-     *
-     * @param {...{}\} args
+     * Logs a warning message with the provided arguments.
+     * @param {...any} args - The arguments to be logged as a warning message.
+     * @returns None
      */
     warning(...args: any[]): void;
     /**
-     * ${1:Description placeholder}
-     *
-     * @param {...{}\} args
+     * Logs a warning message to the console.
+     * @param {...any} args - The arguments to be logged.
+     * @returns None
      */
     warn(...args: any[]): void;
     /**
-     * ${1:Description placeholder}
-     *
-     * @param {...{}\} args
+     * Logs an error message with the given arguments.
+     * @param {...any} args - The arguments to log as an error message.
+     * @returns None
      */
     error(...args: any[]): void;
     /**
-     * ${1:Description placeholder}
-     *
-     * @param {*} exception
-     * @param {...{}\} args
+     * Logs an exception with optional additional arguments.
+     * @param {any} exception - The exception to log.
+     * @param {...any} args - Additional arguments to include in the log.
+     * @returns None
      */
     exception(exception: any, ...args: any[]): void;
     /**
-     * ${1:Description placeholder}
-     *
+     * Sets up the console bindings for logging purposes.
      * @private
+     * @returns None
      */
-    private _setupBindings;
+    private setupBindings;
     /**
-     * ${1:Description placeholder}
-     *
-     * @private
-     * @param {LOG_LEVELS} level
-     * @param {Array<string>} msg
-     * @param {string} caller
-     * @returns {string}
+     * Formats a log message with the specified log level, message, and caller.
+     * @param {LOG_LEVELS} level - The log level of the message.
+     * @param {Array<string>} msg - An array of strings representing the message.
+     * @param {string} caller - The name of the caller function.
+     * @returns {string} - The formatted log message.
      */
-    private _formattedLog;
+    private formattedLog;
     /**
-     * ${1:Description placeholder}
-     *
-     * @private
-     * @param {number} index
-     * @returns {string}
+     * Returns the name of the caller at the specified index in the call stack.
+     * @param {number} index - The index of the caller in the call stack.
+     * @returns {string} The name of the caller, including the file name and line number.
      */
-    private _callerName;
+    private callerName;
     /**
-     * ${1:Description placeholder}
-     *
-     * @private
-     * @param {LOG_LEVELS} level
-     * @param {*} args
+     * Processes a log message based on the specified log level and arguments.
+     * @param {LOG_LEVELS} level - The log level of the message.
+     * @param {any[]} args - The arguments to be logged.
+     * @returns None
      */
-    private _processLog;
+    private processLog;
     /**
-     * ${1:Description placeholder}
-     *
-     * @private
-     * @param {Error} exception
-     * @param {...{}\} args
+     * Logs an exception along with additional arguments and the stack trace.
+     * @param {Error} exception - The exception object to log.
+     * @param {...any} args - Additional arguments to include in the log.
+     * @returns None
      */
-    private _exception;
+    private iexception;
     /**
-     * ${1:Description placeholder}
-     *
-     * @private
-     * @param {LOG_LEVELS} level
-     * @param {string} fMsg
+     * Pushes a log message to the console with the specified log level.
+     * @param {LOG_LEVELS} level - The log level of the message.
+     * @param {string} fMsg - The formatted log message.
+     * @returns None
      */
-    private _pushLog;
+    private pushLog;
     /**
-     * ${1:Description placeholder}
-     *
-     * @private
-     * @param {*} value
-     * @returns {string}
+     * Suppresses sensitive information in the given value based on the filter blacklist.
+     * @param {any} value - The value to suppress sensitive information from.
+     * @returns {string} - The value with sensitive information suppressed.
      */
-    private _suppressSensitiveInfo;
+    private suppressSensitiveInfo;
 }