@creator.co/wapi 1.2.1-beta6 → 1.2.2

package/src/Crypto/Crypto.ts

@@ -1,35 +1,94 @@
 import { KMSClient, EncryptCommand, DecryptCommand } from "@aws-sdk/client-kms"
 
+/**
+ * ${1:Description placeholder}
+ *
+ * @export
+ * @class Crypto
+ * @typedef {Crypto}
+ */
 export default class Crypto {
+  /**
+   * ${1:Description placeholder}
+   *
+   * @private
+   * @readonly
+   * @type {KMSClient}
+   */
   private readonly client: KMSClient
+  /**
+   * ${1:Description placeholder}
+   *
+   * @private
+   * @readonly
+   * @type {string}
+   */
   private readonly region: string
+  /**
+   * ${1:Description placeholder}
+   *
+   * @private
+   * @readonly
+   * @type {string}
+   */
   private readonly keyId: string
+  /**
+   * Creates an instance of Crypto.
+   *
+   * @constructor
+   * @param {string} region
+   * @param {string} keyId
+   */
   constructor(region: string, keyId: string) {
     this.region = region
     this.keyId = keyId
     this.client = new KMSClient({ region: this.region })
   }
   //
+  /**
+   * ${1:Description placeholder}
+   *
+   * @async
+   * @param {(string | any)} data
+   * @returns {Promise<string>}
+   */
   async encryptData(data: string | any): Promise<string> {
-    const resp = await this.client.send(
-      new EncryptCommand({
-        KeyId: this.keyId,
-        EncryptionAlgorithm: "RSAES_OAEP_SHA_256",
-        Plaintext: new TextEncoder().encode(
-          typeof data === "string" ? data : JSON.stringify(data),
-        ),
-      }),
-    )
-    return Buffer.from(resp.CiphertextBlob as any, "utf8").toString("hex")
+    try {
+      const resp = await this.client.send(
+        new EncryptCommand({
+          KeyId: this.keyId,
+          EncryptionAlgorithm: "RSAES_OAEP_SHA_256",
+          Plaintext: new TextEncoder().encode(
+            typeof data === "string" ? data : JSON.stringify(data),
+          ),
+        }),
+      )
+      return Buffer.from(resp.CiphertextBlob as any, "utf8").toString("hex")
+    } catch (e) {
+      console.error("Encryption failure", e)
+      return null
+    }
   }
+  /**
+   * ${1:Description placeholder}
+   *
+   * @async
+   * @param {string} data
+   * @returns {Promise<string>}
+   */
   async decryptData(data: string): Promise<string> {
-    const resp = await this.client.send(
-      new DecryptCommand({
-        KeyId: this.keyId,
-        CiphertextBlob: Buffer.from(data, "hex"),
-        EncryptionAlgorithm: "RSAES_OAEP_SHA_256",
-      }),
-    )
-    return new TextDecoder().decode(resp.Plaintext)
+    try {
+      const resp = await this.client.send(
+        new DecryptCommand({
+          KeyId: this.keyId,
+          CiphertextBlob: Buffer.from(data, "hex"),
+          EncryptionAlgorithm: "RSAES_OAEP_SHA_256",
+        }),
+      )
+      return new TextDecoder().decode(resp.Plaintext)
+    } catch (e) {
+      console.error("Decryption failure", e)
+      return null
+    }
   }
 }

package/src/Crypto/JWT.ts

@@ -1,5 +1,10 @@
 import * as jwt from "jsonwebtoken"
 
+/**
+ * ${1:Description placeholder}
+ *
+ * @typedef {JWTValidationResponse}
+ */
 type JWTValidationResponse =
   | { isValid: true; decodedToken: jwt.JwtPayload }
   | {
@@ -7,14 +12,51 @@ type JWTValidationResponse =
       isExpired?: boolean
     }
 
+/**
+ * ${1:Description placeholder}
+ *
+ * @export
+ * @class JWT
+ * @typedef {JWT}
+ */
 export default class JWT {
+  /**
+   * ${1:Description placeholder}
+   *
+   * @private
+   * @readonly
+   * @type {string}
+   */
   private readonly tokenSecret: string
+  /**
+   * ${1:Description placeholder}
+   *
+   * @private
+   * @readonly
+   * @type {string}
+   */
   private readonly defaultExpiration: string
+  /**
+   * Creates an instance of JWT.
+   *
+   * @constructor
+   * @param {string} tokenSecret
+   * @param {?string} [defaultExpiration]
+   */
   constructor(tokenSecret: string, defaultExpiration?: string) {
     this.tokenSecret = tokenSecret
     this.defaultExpiration = defaultExpiration
   }
   //
+  /**
+   * ${1:Description placeholder}
+   *
+   * @param {object} data
+   * @param {?string} [expiration]
+   * @param {?string} [overrideToken]
+   * @param {?*} [opts]
+   * @returns {string}
+   */
   createToken(
     data: object,
     expiration?: string,
@@ -28,15 +70,19 @@ export default class JWT {
       exp ? { expiresIn: exp, ...(opts || {}) } : opts || {},
     )
   }
+  /**
+   * ${1:Description placeholder}
+   *
+   * @param {string} token
+   * @returns {JWTValidationResponse}
+   */
   validateToken(token: string): JWTValidationResponse {
     try {
       // Check if is valid
       const isValid = jwt.verify(token, this.tokenSecret)
-      if (!isValid) throw new Error("Issue with token validation!")
-      else {
+      if (isValid) {
         const payload = jwt.decode(token, { json: true })
         if (payload) return { isValid: true, decodedToken: payload }
-        else throw new Error("Issue while decoding token!")
       }
     } catch (err) {
       console.error(err)

package/src/Globals.ts

@@ -4,36 +4,174 @@ import Utils from "./API/Utils"
 
 // important for dev env to load .env file
 dotenv.config()
+/**
+ * Description placeholder
+ *
+ * @export
+ * @class Globals
+ * @typedef {Globals}
+ */
 export default class Globals {
-  //Error messages
+  /**
+   * Description placeholder
+   *
+   * @public
+   * @static
+   * @type {string}
+   */
   public static ErrorResponseValidationFail = "Input validation failed: " //400
+  /**
+   * Description placeholder
+   *
+   * @public
+   * @static
+   * @type {string}
+   */
   public static ErrorResponseInvalidServerResponse =
     "No valid response, this is a system error." //400
+  /**
+   * Description placeholder
+   *
+   * @public
+   * @static
+   * @type {string}
+   */
   public static ErrorResponseUnhandledError =
     "Unhandled error when processing request." //400
+  /**
+   * Description placeholder
+   *
+   * @public
+   * @static
+   * @type {string}
+   */
   public static ErrorResponseNoRecords = "No events to be processed." //400
-  //Error Codes
+  /**
+   * Description placeholder
+   *
+   * @public
+   * @static
+   * @type {string}
+   */
   public static ErrorCode_MissingParam = "MISSING_PARAM"
+  /**
+   * Description placeholder
+   *
+   * @public
+   * @static
+   * @type {string}
+   */
   public static ErrorCode_InvalidInput = "INVALID_INPUT"
+  /**
+   * Description placeholder
+   *
+   * @public
+   * @static
+   * @type {string}
+   */
   public static ErrorCode_APIError = "API_ERROR"
+  /**
+   * Description placeholder
+   *
+   * @public
+   * @static
+   * @type {string}
+   */
   public static ErrorCode_NoRecords = "EMPTY_EVENT"
 
+  /**
+   * Description placeholder
+   *
+   * @public
+   * @static
+   * @type {*}
+   */
   public static Listener_HTTP_DefaultPort =
-    Utils.parseIntNullIfNaN(process.env.PORT) || 80
+    Utils.parseIntNullIfNaN(process.env.PORT) || 9000
 
+  /**
+   * Description placeholder
+   *
+   * @public
+   * @static
+   * @type {string}
+   */
   public static Listener_HTTP_DefaultHost = "localhost"
+  /**
+   * Description placeholder
+   *
+   * @public
+   * @static
+   * @type {string}
+   */
   public static Listener_HTTP_ProxyRoute = "*"
+  /**
+   * Description placeholder
+   *
+   * @public
+   * @static
+   * @type {*}
+   */
   public static Listener_HTTP_DefaultTimeout =
     Utils.parseIntNullIfNaN(process.env.TIMEOUT) || 30000
+  /**
+   * Description placeholder
+   *
+   * @public
+   * @static
+   * @type {*}
+   */
   public static Listener_HTTP_DefaultHealthCheckRoute =
     process.env.HEALTH_ROUTE || "/health"
   //Resps
+  /**
+   * Description placeholder
+   *
+   * @public
+   * @static
+   * @type {string}
+   */
   public static Resp_MSG_EXCEPTION =
     "[Proxy]: Exception during request execution!"
+  /**
+   * Description placeholder
+   *
+   * @public
+   * @static
+   * @type {string}
+   */
   public static Resp_CODE_EXCEPTION = "EXEC_EXCEPTION"
+  /**
+   * Description placeholder
+   *
+   * @public
+   * @static
+   * @type {number}
+   */
   public static Resp_STATUSCODE_EXCEPTION = 502
 
+  /**
+   * Description placeholder
+   *
+   * @public
+   * @static
+   * @type {string}
+   */
   public static Resp_MSG_INVALIDRESP = "[Proxy]: Invalid response from server!"
+  /**
+   * Description placeholder
+   *
+   * @public
+   * @static
+   * @type {string}
+   */
   public static Resp_CODE_INVALIDRESP = "EMPTY_RESPONSE"
+  /**
+   * Description placeholder
+   *
+   * @public
+   * @static
+   * @type {number}
+   */
   public static Resp_STATUSCODE_INVALIDRESP = 400
 }

package/src/Logger/Logger.ts

@@ -5,15 +5,36 @@ import * as stackTrace from "stack-trace"
 //
 import Utils from "../API/Utils"
 //
+/**
+ * ${1:Description placeholder}
+ *
+ * @export
+ * @enum {number}
+ */
 export enum LOG_LEVELS {
   DEBUG = "DEBUG",
   INFO = "INFO",
   WARN = "WARN",
   ERROR = "ERROR",
 }
-const PURE_CONSOLE = console["flushLogs"] ? console["origin"] : console
+/**
+ * ${1:Description placeholder}
+ *
+ * @type {*}
+ */
+const PURE_CONSOLE = console["notGlobalLogger"] ? console["origin"] : console
+/**
+ * ${1:Description placeholder}
+ *
+ * @type {*}
+ */
 const DEFAULT_LOG_FUNCTION = PURE_CONSOLE.log.bind(PURE_CONSOLE)
 //
+/**
+ * ${1:Description placeholder}
+ *
+ * @type {{}\}
+ */
 const blacklist = [
   "password",
   "phonenumber" /*,'code'*/,
@@ -29,18 +50,68 @@ const blacklist = [
   "paymentMethodNonce",
 ]
 //
+/**
+ * ${1:Description placeholder}
+ *
+ * @export
+ * @typedef {LoggerConfig}
+ */
 export type LoggerConfig = {
   sensitiveFilteringKeywords?: boolean | Array<string>
   logLevel?: LOG_LEVELS | string
 }
 //
+/**
+ * ${1:Description placeholder}
+ *
+ * @export
+ * @class Logger
+ * @typedef {Logger}
+ */
 export default class Logger {
+  /**
+   * ${1:Description placeholder}
+   *
+   * @private
+   * @type {?LoggerConfig}
+   */
   private _config?: LoggerConfig
+  /**
+   * ${1:Description placeholder}
+   *
+   * @private
+   * @type {string}
+   */
   private _transactionID: string
+  /**
+   * ${1:Description placeholder}
+   *
+   * @private
+   * @type {(Array<string> | false)}
+   */
   private _filterBlacklist: Array<string> | false
+  /**
+   * ${1:Description placeholder}
+   *
+   * @private
+   * @type {LOG_LEVELS}
+   */
   private _LOG_LEVEL: LOG_LEVELS
+  /**
+   * ${1:Description placeholder}
+   *
+   * @private
+   * @type {*}
+   */
   private origin: any
 
+  /**
+   * Creates an instance of Logger.
+   *
+   * @constructor
+   * @param {(LoggerConfig | undefined)} _config
+   * @param {string} transactionID
+   */
   constructor(_config: LoggerConfig | undefined, transactionID: string) {
     abind(this)
     //
@@ -61,34 +132,81 @@ export default class Logger {
     this.log("Using logger with level: " + this._LOG_LEVEL.toString())
     this.debug("logger config: ", this._config)
   }
+  /**
+   * ${1:Description placeholder}
+   *
+   * @public
+   * @returns {boolean}
+   */
+  public notGlobalLogger() {
+    return true
+  }
 
   //Public
+  /**
+   * ${1:Description placeholder}
+   *
+   * @param {...{}\} args
+   */
   debug(...args) {
     this._processLog(LOG_LEVELS.DEBUG, args)
   }
+  /**
+   * ${1:Description placeholder}
+   *
+   * @param {...{}\} args
+   */
   log(...args) {
     this._processLog(LOG_LEVELS.INFO, args)
   }
+  /**
+   * ${1:Description placeholder}
+   *
+   * @param {...{}\} args
+   */
   info(...args) {
     this._processLog(LOG_LEVELS.INFO, args)
   }
+  /**
+   * ${1:Description placeholder}
+   *
+   * @param {...{}\} args
+   */
   warning(...args) {
     this._processLog(LOG_LEVELS.WARN, args)
   }
+  /**
+   * ${1:Description placeholder}
+   *
+   * @param {...{}\} args
+   */
   warn(...args) {
     this._processLog(LOG_LEVELS.WARN, args)
   }
+  /**
+   * ${1:Description placeholder}
+   *
+   * @param {...{}\} args
+   */
   error(...args) {
     this._processLog(LOG_LEVELS.ERROR, args)
   }
+  /**
+   * ${1:Description placeholder}
+   *
+   * @param {*} exception
+   * @param {...{}\} args
+   */
   exception(exception, ...args) {
     this._exception(exception, args)
   }
-  //
-  cleanUp() {}
-  async flushLogs() {}
 
   //initialization
+  /**
+   * ${1:Description placeholder}
+   *
+   * @private
+   */
   private _setupBindings(): void {
     global.console = {
       debug: (...args) => this._processLog(LOG_LEVELS.DEBUG, args),
@@ -98,12 +216,21 @@ export default class Logger {
       error: (...args) => this._processLog(LOG_LEVELS.ERROR, args),
       // eslint-disable-next-line @typescript-eslint/ban-ts-comment
       // @ts-ignore
-      warning: (...args) => this._processLog(false, LOG_LEVELS.WARN, args),
+      warning: (...args) => this._processLog(LOG_LEVELS.WARN, args),
       exception: (exception, ...args) => this._exception(exception, args),
     }
   }
 
   /* Formatters */
+  /**
+   * ${1:Description placeholder}
+   *
+   * @private
+   * @param {LOG_LEVELS} level
+   * @param {Array<string>} msg
+   * @param {string} caller
+   * @returns {string}
+   */
   private _formattedLog(
     level: LOG_LEVELS,
     msg: Array<string>,
@@ -111,15 +238,24 @@ export default class Logger {
   ): string {
     if (Utils.isHybridlessContainer() && this._transactionID) {
       return (
-        ` ${this._transactionID}` +
+        `${this._transactionID}` +
         ` [${level.toString()}] [${caller}] ${msg
           .map(this._suppressSensitiveInfo)
           .join(" ")}`
       )
     } else {
-      return ` [${level.toString()}] [${caller}] ${msg.join(" ")}`
+      return `[${level.toString()}] [${caller}] ${msg
+        .map(this._suppressSensitiveInfo)
+        .join(" ")}`
     }
   }
+  /**
+   * ${1:Description placeholder}
+   *
+   * @private
+   * @param {number} index
+   * @returns {string}
+   */
   private _callerName(index: number): string {
     const safeIndex = Math.min(index, stackTrace.get().length)
     if (stackTrace.get()[safeIndex]) {
@@ -135,6 +271,13 @@ export default class Logger {
     return ""
   }
   /* Helpers (core functionality) */
+  /**
+   * ${1:Description placeholder}
+   *
+   * @private
+   * @param {LOG_LEVELS} level
+   * @param {*} args
+   */
   private _processLog(level: LOG_LEVELS, args: any): void {
     if (level < this._LOG_LEVEL) return
     //get args
@@ -150,6 +293,13 @@ export default class Logger {
     // todo: improve error stack
     this._pushLog(level, this._formattedLog(level, msg, this._callerName(3)))
   }
+  /**
+   * ${1:Description placeholder}
+   *
+   * @private
+   * @param {Error} exception
+   * @param {...{}\} args
+   */
   private _exception(exception: Error, ...args): void {
     //format message
     const msg: Array<string> = []
@@ -164,12 +314,26 @@ export default class Logger {
       this._formattedLog(LOG_LEVELS.ERROR, msg, this._callerName(3)),
     )
   }
+  /**
+   * ${1:Description placeholder}
+   *
+   * @private
+   * @param {LOG_LEVELS} level
+   * @param {string} fMsg
+   */
   private _pushLog(level: LOG_LEVELS, fMsg: string): void {
     // push into logs stack
     // this._logs.push(fMsg);
     DEFAULT_LOG_FUNCTION.apply(PURE_CONSOLE, [fMsg])
   }
   /* Sensitive information handling */
+  /**
+   * ${1:Description placeholder}
+   *
+   * @private
+   * @param {*} value
+   * @returns {string}
+   */
   private _suppressSensitiveInfo(value: any): string {
     //realy false
     if (!this._filterBlacklist) return value
@@ -182,21 +346,11 @@ export default class Logger {
                 value.toLowerCase().includes(f.toLowerCase()),
               )
             : false
-          if (match) value = "**SUPRESSED_SENSITIVE_DATA**"
+          if (match) value = "**SUPPRESSED_SENSITIVE_DATA**"
         })
       }
       return value
-    } else if (typeof value == "object") {
-      //key based replacement
-      Object.keys(value).forEach(function (elt) {
-        const match = this._filterBlacklist.find((f) =>
-          elt.toLowerCase().includes(f.toLowerCase()),
-        )
-        if (match) value[elt] = "**SUPRESSED_SENSITIVE_DATA**"
-      })
-      return value
-    } else if (Array.isArray(value))
-      return value.map((v) => this._suppressSensitiveInfo(v)).join(" ")
+    }
     return value
   }
 }