@creator.co/wapi 1.2.1-beta6 → 1.2.3

package/src/Logger/Logger.ts

@@ -1,46 +1,117 @@
-import * as abind from "abind"
-import * as stringify from "json-stringify-safe"
-import * as stackTrace from "stack-trace"
+import * as abind from 'abind'
+import * as stringify from 'json-stringify-safe'
+import * as stackTrace from 'stack-trace'
 
 //
-import Utils from "../API/Utils"
+import Utils from '../API/Utils'
 //
+/**
+ * ${1:Description placeholder}
+ *
+ * @export
+ * @enum {number}
+ */
 export enum LOG_LEVELS {
-  DEBUG = "DEBUG",
-  INFO = "INFO",
-  WARN = "WARN",
-  ERROR = "ERROR",
+  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'*/,
-  "resetCode",
-  "recaptchaToken",
-  "token",
-  "mfa",
-  "REFRESH_TOKEN",
-  "SECRET_HASH",
-  "SecretHash",
-  "AccessToken",
-  "UserCode",
-  "paymentMethodNonce",
+  'password',
+  'phonenumber' /*,'code'*/,
+  'resetCode',
+  'recaptchaToken',
+  'token',
+  'mfa',
+  'REFRESH_TOKEN',
+  'SECRET_HASH',
+  'SecretHash',
+  'AccessToken',
+  'UserCode',
+  '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)
     //
@@ -58,37 +129,84 @@ export default class Logger {
     //
     this._setupBindings()
     //
-    this.log("Using logger with level: " + this._LOG_LEVEL.toString())
-    this.debug("logger config: ", this._config)
+    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,28 +216,38 @@ 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 */
-  private _formattedLog(
-    level: LOG_LEVELS,
-    msg: Array<string>,
-    caller: string,
-  ): string {
+  /**
+   * ${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>, caller: string): string {
     if (Utils.isHybridlessContainer() && this._transactionID) {
       return (
-        ` ${this._transactionID}` +
-        ` [${level.toString()}] [${caller}] ${msg
-          .map(this._suppressSensitiveInfo)
-          .join(" ")}`
+        `${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]) {
@@ -127,76 +255,87 @@ export default class Logger {
         ? stackTrace.get()[safeIndex].getTypeName()
         : null
       if (!callerName) {
-        callerName = stackTrace?.get()?.[safeIndex]?.getFileName()?.split("/")
-        callerName = callerName?.slice(callerName?.indexOf("src"))?.join("/")
+        callerName = stackTrace?.get()?.[safeIndex]?.getFileName()?.split('/')
+        callerName = callerName?.slice(callerName?.indexOf('src'))?.join('/')
       }
-      return callerName + ":" + stackTrace?.get()?.[safeIndex]?.getLineNumber()
+      return callerName + ':' + stackTrace?.get()?.[safeIndex]?.getLineNumber()
     }
-    return ""
+    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
     const msg: Array<string> = []
     for (const arg of args) {
       const fMsg =
-        typeof arg === "object" && !(arg instanceof Error)
-          ? stringify(arg, null, 2)
-          : arg
+        typeof arg === 'object' && !(arg instanceof Error) ? stringify(arg, null, 2) : arg
       msg.push(fMsg)
     }
     //push into logs stack
     // 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> = []
     //push exeception
-    msg.push(exception.toString() + " -")
+    msg.push(exception.toString() + ' -')
     //get args
     for (const arg of args) if (arg != exception) msg.push(arg)
     if (exception.stack) msg.push(exception.stack) //push Exeception stack at the end
     //push into logs stack
-    this._pushLog(
-      LOG_LEVELS.ERROR,
-      this._formattedLog(LOG_LEVELS.ERROR, msg, this._callerName(3)),
-    )
+    this._pushLog(LOG_LEVELS.ERROR, 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
-    if (typeof value == "string") {
+    if (typeof value == 'string') {
       //content based replacement
       if (this._filterBlacklist) {
         this._filterBlacklist.forEach(() => {
           const match = this._filterBlacklist
-            ? this._filterBlacklist.find((f) =>
-                value.toLowerCase().includes(f.toLowerCase()),
-              )
+            ? this._filterBlacklist.find(f => 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
   }
 }

package/src/Mailer/Mailer.ts

@@ -1,22 +1,59 @@
-import * as SES from "@aws-sdk/client-ses"
-import { defaultProvider } from "@aws-sdk/credential-provider-node"
-import * as Email from "email-templates"
-import * as nodemailer from "nodemailer"
-import type * as SESTransport from "nodemailer/lib/ses-transport"
+import * as SES from '@aws-sdk/client-ses'
+import { defaultProvider } from '@aws-sdk/credential-provider-node'
+import * as Email from 'email-templates'
+import * as nodemailer from 'nodemailer'
+import type * as SESTransport from 'nodemailer/lib/ses-transport'
 
+/**
+ * ${1:Description placeholder}
+ *
+ * @export
+ * @class Mailer
+ * @typedef {Mailer}
+ */
 export default class Mailer {
+  /**
+   * ${1:Description placeholder}
+   *
+   * @private
+   * @readonly
+   * @type {string}
+   */
   private readonly from: string
-  private readonly templateDefaultFile: string = "html"
+  /**
+   * ${1:Description placeholder}
+   *
+   * @private
+   * @readonly
+   * @type {string}
+   */
+  private readonly templateDefaultFile: string = 'html'
+  /**
+   * ${1:Description placeholder}
+   *
+   * @private
+   * @readonly
+   * @type {ReturnType<
+   *     typeof nodemailer.createTransport<SESTransport.SentMessageInfo>
+   *   >}
+   */
   private readonly transporter: ReturnType<
     typeof nodemailer.createTransport<SESTransport.SentMessageInfo>
   >
+  /**
+   * Creates an instance of Mailer.
+   *
+   * @constructor
+   * @param {string} defaultFrom
+   * @param {string} region
+   */
   constructor(defaultFrom: string, region: string) {
     this.from = defaultFrom
     this.transporter = nodemailer.createTransport({
       SES: {
         ses: new SES.SESClient({
           credentials: defaultProvider(),
-          apiVersion: "2010-12-01",
+          apiVersion: '2010-12-01',
           region,
         }),
         aws: SES,
@@ -24,6 +61,21 @@ export default class Mailer {
     })
   }
 
+  /**
+   * ${1:Description placeholder}
+   *
+   * @public
+   * @async
+   * @param {(string | Array<string>)} to
+   * @param {string} htmlMessage
+   * @param {string} subject
+   * @param {?(string | Array<string>)} [optionalCC]
+   * @param {?string} [optionalFrom]
+   * @param {?string} [optionalReplyTo]
+   * @param {?any[]} [optionalAttachments]
+   * @param {?Email.NodeMailerTransportOptions} [optionalTransport]
+   * @returns {unknown}
+   */
   public async sendRawEmail(
     to: string | Array<string>,
     htmlMessage: string,
@@ -33,7 +85,7 @@ export default class Mailer {
     optionalReplyTo?: string,
     // TODO: improve attachment type -> Attachment
     optionalAttachments?: any[],
-    optionalTransport?: Email.NodeMailerTransportOptions,
+    optionalTransport?: Email.NodeMailerTransportOptions
   ) {
     //Generate emails
     const email = new Email({
@@ -53,13 +105,28 @@ export default class Mailer {
     let resp = null
     try {
       resp = await email.send()
-      console.debug("Mailer resp:", resp)
+      console.debug('Mailer resp:', resp)
     } catch (e) {
-      console.error("Mailer error:", e)
+      console.error('Mailer error:', e)
       throw e
     }
     return resp
   }
+  /**
+   * ${1:Description placeholder}
+   *
+   * @public
+   * @async
+   * @param {(string | Array<string>)} to
+   * @param {(string | Array<string>)} templates
+   * @param {object} data
+   * @param {?(string | Array<string>)} [optionalCC]
+   * @param {?string} [optionalFrom]
+   * @param {?string} [optionalReplyTo]
+   * @param {?any[]} [optionalAttachments]
+   * @param {?Email.NodeMailerTransportOptions} [optionalTransport]
+   * @returns {unknown}
+   */
   public async sendTemplatedEmail(
     to: string | Array<string>,
     templates: string | Array<string>,
@@ -69,7 +136,7 @@ export default class Mailer {
     optionalReplyTo?: string,
     // TODO: improve attachment type -> Attachment
     optionalAttachments?: any[],
-    optionalTransport?: Email.NodeMailerTransportOptions,
+    optionalTransport?: Email.NodeMailerTransportOptions
   ) {
     //Generate emails
     const email = new Email({
@@ -88,18 +155,28 @@ export default class Mailer {
     try {
       const chosenTemplate = await this.chooseTemplate(templates, data)
       resp = await email.send({ template: chosenTemplate, locals: data })
-      console.debug("Mailer resp:", resp)
+      console.debug('Mailer resp:', resp)
     } catch (e) {
-      console.error("Mailer error:", e)
+      console.error('Mailer error:', e)
       throw e
     }
     return resp
   }
+  /**
+   * ${1:Description placeholder}
+   *
+   * @public
+   * @param {string} host
+   * @param {number} portNumber
+   * @param {string} user
+   * @param {string} password
+   * @returns {Email.NodeMailerTransportOptions}
+   */
   public newSMTPTransporter(
     host: string,
     portNumber: number,
     user: string,
-    password: string,
+    password: string
   ): Email.NodeMailerTransportOptions {
     const smtpTransporter = nodemailer.createTransport({
       host: host,
@@ -114,10 +191,16 @@ export default class Mailer {
   }
 
   /* private */
-  private async chooseTemplate(
-    templates: string | Array<string>,
-    data: object,
-  ): Promise<string> {
+  /**
+   * ${1:Description placeholder}
+   *
+   * @private
+   * @async
+   * @param {(string | Array<string>)} templates
+   * @param {object} data
+   * @returns {Promise<string>}
+   */
+  private async chooseTemplate(templates: string | Array<string>, data: object): Promise<string> {
     if (Array.isArray(templates)) {
       //For each template check if can render it
       for (const template of templates) {
@@ -128,25 +211,25 @@ export default class Mailer {
     }
     throw new Error(
       `Could not render email with template ${templates} and following data. Please, check logs above! ` +
-        JSON.stringify(data, null, 2),
+        JSON.stringify(data, null, 2)
     )
   }
-  private async canRenderTemplate(
-    template: string,
-    data: object,
-  ): Promise<boolean> {
+  /**
+   * ${1:Description placeholder}
+   *
+   * @private
+   * @async
+   * @param {string} template
+   * @param {object} data
+   * @returns {Promise<boolean>}
+   */
+  private async canRenderTemplate(template: string, data: object): Promise<boolean> {
     let validRenderResp = null
     try {
       const email = new Email()
-      validRenderResp = await email.render(
-        `${template}/${this.templateDefaultFile}`,
-        data,
-      )
+      validRenderResp = await email.render(`${template}/${this.templateDefaultFile}`, data)
     } catch (e) {
-      console.log(
-        `Error while checking renderability of email template ${template}`,
-        e,
-      )
+      console.log(`Error while checking renderability of email template ${template}`, e)
     }
     return validRenderResp != null
   }