@reldens/utils 0.21.1 → 0.23.0

package/lib/events-manager.js

@@ -5,7 +5,7 @@
  * This extension includes a few new features:
  *
  * - The onWithKey and offWithKey methods will allow you to specify a "group" key for the event listener, the related
- * event will be referenced in a new property called "eventsByRemoveKey" so you can destroy multiple listeners at the
+ * event will be referenced in a new property called "eventsByRemoveKey" so you can detach multiple listeners at the
  * time.
  *
  * - Then the normal "on" and "off" aliases were override to include a debug check with a log. Using the debug property
@@ -28,46 +28,66 @@ class AwaitEventEmitterExtended extends AwaitEventEmitter
         this.debug = false;
     }
 
-    onWithKey(eventName, callback, removeKey, masterKey)
+    onWithKey(eventName, callback, uniqueRemoveKey, masterKey)
     {
         if(
-            (masterKey && sc.hasOwn(this.eventsByRemoveKeys, masterKey) && sc.hasOwn(masterKey, removeKey))
-            || sc.hasOwn(this.eventsByRemoveKeys, removeKey)
+            sc.hasOwn(this.eventsByRemoveKeys, uniqueRemoveKey)
+            || (
+                masterKey
+                && sc.hasOwn(this.eventsByRemoveKeys, masterKey)
+                && sc.hasOwn(this.eventsByRemoveKeys[masterKey], uniqueRemoveKey)
+            )
         ){
-            // event exists, don't register twice:
+            Logger.debug('Event "'+eventName+'" exists with key "'+uniqueRemoveKey+'" and masterKey "'+masterKey+'".');
             return false;
         }
         this.on(eventName, callback);
         let dataArr = this.listeners(eventName);
-        let currentListener = dataArr[dataArr.length -1];
-        if(masterKey){
-            if(!sc.hasOwn(this.eventsByRemoveKeys, masterKey)){
-                this.eventsByRemoveKeys[masterKey] = {};
-            }
-            this.eventsByRemoveKeys[masterKey][removeKey] = eventName;
-        } else {
-            this.eventsByRemoveKeys[removeKey] = eventName;
+        let currentListenerIndex = dataArr.indexOf(callback);
+        let currentListener = dataArr[currentListenerIndex];
+        if(!masterKey){
+            this.eventsByRemoveKeys[uniqueRemoveKey] = {eventName, callback};
+            return currentListener;
+        }
+        if(!sc.hasOwn(this.eventsByRemoveKeys, masterKey)){
+            this.eventsByRemoveKeys[masterKey] = {};
         }
+        this.eventsByRemoveKeys[masterKey][uniqueRemoveKey] = {eventName, callback};
         return currentListener;
     }
 
     /**
-     * This method will remove a SINGLE event using the remove key. If the masterKey was specified, then this will look
-     * into the masterKey property for the proper event name reference to remove it.
+     * This method will remove a SINGLE event using the unique remove key.
+     * If the event listener was assigned using a masterKey then we need to pass it as well to find the event.
      */
-    offWithKey(removeKey, masterKey)
+    offWithKey(uniqueRemoveKey, masterKey)
     {
-        if(
-            (masterKey && !sc.hasOwn(this.eventsByRemoveKeys, masterKey))
-            || (!masterKey && !sc.hasOwn(this.eventsByRemoveKeys, removeKey))
-        ){
-            // event not found:
+        if(masterKey && !sc.hasOwn(this.eventsByRemoveKeys, masterKey)){
+            Logger.debug('Event not found by masterKey "'+masterKey+'".');
             return false;
         }
-        let eventToRemove = masterKey ?
-            this.eventsByRemoveKeys[masterKey][removeKey] : this.eventsByRemoveKeys[removeKey];
-        (sc.hasOwn(this._events, eventToRemove) ? delete this._events[eventToRemove] : false);
-        masterKey ? delete this.eventsByRemoveKeys[masterKey][removeKey] : delete this.eventsByRemoveKeys[removeKey];
+        if(!masterKey && !sc.hasOwn(this.eventsByRemoveKeys, uniqueRemoveKey)){
+            Logger.debug('Event not found by removeKey "'+uniqueRemoveKey+'".');
+            return false;
+        }
+        let eventToRemove = masterKey
+            ? this.eventsByRemoveKeys[masterKey][uniqueRemoveKey]
+            : this.eventsByRemoveKeys[uniqueRemoveKey];
+
+        let dataArr = this.listeners(eventToRemove.eventName);
+        let currentListenerIndex = dataArr.indexOf(eventToRemove.callback);
+        this._events[eventToRemove.eventName].splice(currentListenerIndex, 1);
+        if(0 === this._events[eventToRemove.eventName].length){
+            delete this._events[eventToRemove.eventName];
+        }
+        if(masterKey){
+            delete this.eventsByRemoveKeys[masterKey][uniqueRemoveKey];
+            Logger.debug('Deleted event by removeKey "'+uniqueRemoveKey+'" and masterKey "'+masterKey+'".');
+            return true;
+        }
+        delete this.eventsByRemoveKeys[uniqueRemoveKey];
+        Logger.debug('Deleted event by removeKey "'+uniqueRemoveKey+'".');
+        return true;
     }
 
     /**
@@ -76,16 +96,21 @@ class AwaitEventEmitterExtended extends AwaitEventEmitter
     offByMasterKey(masterKey)
     {
         if(!sc.hasOwn(this.eventsByRemoveKeys, masterKey)){
-            // master key not found:
+            Logger.debug('Events not found by masterKey "'+masterKey+'".');
             return false;
         }
-        // loop all the events related to the masterKey and remove them one by one (because the _events is an object
-        // with all the listeners attached).
-        for(let removeKey of Object.keys(this.eventsByRemoveKeys[masterKey])){
-            let eventToRemove = this.eventsByRemoveKeys[masterKey][removeKey];
-            delete this._events[eventToRemove];
+        // @NOTE: we loop all the events related to the masterKey and remove them one by one since the _events property
+        // is an object with multiple listeners attached.
+        Logger.debug('Removing events by masterKey: '+masterKey, Object.keys(this.eventsByRemoveKeys[masterKey]));
+        for(let uniqueRemoveKey of Object.keys(this.eventsByRemoveKeys[masterKey])){
+            let eventToRemove = this.eventsByRemoveKeys[masterKey][uniqueRemoveKey];
+            let dataArr = this.listeners(eventToRemove.eventName);
+            let currentListenerIndex = dataArr.indexOf(eventToRemove.callback);
+            this._events[eventToRemove.eventName].splice(currentListenerIndex, 1);
+            if(0 === this._events[eventToRemove.eventName].length){
+                delete this._events[eventToRemove.eventName];
+            }
         }
-        // then delete the master key:
         delete this.eventsByRemoveKeys[masterKey];
     }
 
@@ -112,7 +137,7 @@ class AwaitEventEmitterExtended extends AwaitEventEmitter
             || this.debug.indexOf(key) !== -1
             || key.indexOf(this.debug) !== -1
         ){
-            Logger.info(type+' Event:', key);
+            Logger.debug(type+' Event:', key);
         }
     }
 

package/lib/logger.js

@@ -25,8 +25,6 @@ class Logger
         //   - Implement different log systems (console.log, files logs, db log?).
         //   - Implement notifications system (email?), and make it configurable for the different log levels.
         let context = this.context();
-        this.logLevel = context.RELDENS_LOG_LEVEL || 0;
-        this.enableTraceFor = (context.RELDENS_ENABLE_TRACE_FOR || '').split(',');
     }
 
     context()
@@ -40,21 +38,33 @@ class Logger
         return context;
     }
 
+    logLevel()
+    {
+        return this.context().RELDENS_LOG_LEVEL || 0;
+    }
+
+    enableTraceFor()
+    {
+        return (this.context().RELDENS_ENABLE_TRACE_FOR || '').split(',');
+    }
+
     log(levelLabel, ...args)
     {
         console.log(levelLabel.toUpperCase()+' -', ...args);
-        if(-1 !== this.enableTraceFor.indexOf('all') || -1 !== this.enableTraceFor.indexOf(levelLabel)){
-            if('function' === typeof Error.captureStackTrace){
-                let stackHolder = {};
-                Error.captureStackTrace(stackHolder, levelLabel);
-                console.log(stackHolder.stack);
+        if(-1 !== this.enableTraceFor().indexOf('all') || -1 !== this.enableTraceFor().indexOf(levelLabel)){
+            if('function' !== typeof Error?.captureStackTrace){
+                console.log('Error.captureStackTrace is not available.', typeof Error?.captureStackTrace);
+                return;
             }
+            let stackHolder = {};
+            Error.captureStackTrace(stackHolder, levelLabel);
+            console.log(stackHolder.stack);
         }
     }
 
     debug(...args)
     {
-        if(8 > this.logLevel){
+        if(8 > this.logLevel()){
             return;
         }
         this.log('debug', ...args);
@@ -62,7 +72,7 @@ class Logger
 
     info(...args)
     {
-        if(7 > this.logLevel){
+        if(7 > this.logLevel()){
             return;
         }
         this.log('info', ...args);
@@ -70,7 +80,7 @@ class Logger
 
     notice(...args)
     {
-        if(6 > this.logLevel){
+        if(6 > this.logLevel()){
             return;
         }
         this.log('notice', ...args);
@@ -78,7 +88,7 @@ class Logger
 
     warning(...args)
     {
-        if(5 > this.logLevel){
+        if(5 > this.logLevel()){
             return;
         }
         this.log('warning', ...args);
@@ -86,7 +96,7 @@ class Logger
 
     error(...args)
     {
-        if(4 > this.logLevel){
+        if(4 > this.logLevel()){
             return;
         }
         this.log('error', ...args);
@@ -94,7 +104,7 @@ class Logger
 
     critical(...args)
     {
-        if(3 > this.logLevel){
+        if(3 > this.logLevel()){
             return;
         }
         this.log('critical', ...args);
@@ -102,7 +112,7 @@ class Logger
 
     alert(...args)
     {
-        if(2 > this.logLevel){
+        if(2 > this.logLevel()){
             return;
         }
         this.log('alert', ...args);
@@ -110,7 +120,7 @@ class Logger
 
     emergency(...args)
     {
-        if(1 > this.logLevel){
+        if(1 > this.logLevel()){
             return;
         }
         this.log('emergency', ...args);

package/lib/shortcuts.js

@@ -256,10 +256,12 @@ class Shortcuts
 
     getCurrentDate()
     {
-        // get date:
-        let date = new Date();
-        // format:
-        return date.toISOString().slice(0, 19).replace('T', ' ');
+        return (new Date()).toISOString().slice(0, 19).replace('T', ' ');
+    }
+
+    getTime()
+    {
+        return (new Date()).getTime();
     }
 
     randomInteger(min, max)

package/package.json

@@ -1,7 +1,7 @@
 {
     "name": "@reldens/utils",
     "scope": "@reldens",
-    "version": "0.21.1",
+    "version": "0.23.0",
     "description": "Reldens - Utils",
     "author": "Damian A. Pastorini",
     "license": "MIT",