@reldens/utils 0.40.0 → 0.42.0

package/lib/error-manager.js

@@ -2,8 +2,6 @@
  *
  * Reldens - ErrorManager
  *
- * This module handle all the game errors.
- *
  */
 
 class ErrorManager
@@ -12,14 +10,18 @@ class ErrorManager
     constructor()
     {
         this.enableTrace = false;
+        this.callback = false;
     }
 
     error(message)
     {
-        // @TODO - BETA.17: evaluate better ways to handle errors, implement email notifications, etc.
         if(this.enableTrace){
             console.trace();
         }
+        if('function' === typeof this.callback){
+            // use the callback to implement any customization here:
+            return this.callback(message);
+        }
         throw new Error(message);
     }
 

package/lib/events-manager.js

@@ -8,7 +8,7 @@
  * 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
+ * - We override the "on" and "off" aliases override to include a debug check with a log. Using the debug property,
  * you can specify to log "all" the fire and listeners, or just by key. Note the key search will be applied in both
  * directions, it will check if the debug value exists in the event key or if the event key exists in the debug value.
  *
@@ -133,9 +133,9 @@ class AwaitEventEmitterExtended extends AwaitEventEmitter
     logDebugEvent(key, type)
     {
         if(
-            this.debug.indexOf('all') !== -1
-            || this.debug.indexOf(key) !== -1
-            || key.indexOf(this.debug) !== -1
+            -1 !== this.debug.indexOf('all')
+            || -1 !== this.debug.indexOf(key)
+            || -1 !== key.indexOf(this.debug)
         ){
             Logger.debug(type+' Event:', key);
         }

package/lib/interaction-area.js

@@ -2,8 +2,8 @@
  *
  * Reldens - InteractionArea
  *
- * This class is used to validate the area for a specific object or action, for example if player A target player B
- * by clicking on it and then run an action (by pressing space bar or using the action button), the action will
+ * This class is used to validate the area for a specific object or action. For example, if player A targets player B
+ * by clicking on it and then runs an action (by pressing space bar or using the action button), the action will
  * be only valid and executed if player A is inside the interactive area of player B.
  *
  */
@@ -21,11 +21,11 @@ class InteractionArea
 
     setupInteractionArea(margin = false, x = false, y = false)
     {
-        // interaction area can be forced by parameter:
+        // the margin parameter can force the interaction area:
         if(margin){
             this.interactionArea = margin;
         }
-        // if there's none interaction area just do nothing:
+        // if there's none interaction area, just do nothing:
         if(!this.interactionArea){
             return;
         }
@@ -51,10 +51,7 @@ class InteractionArea
 
     getPosition()
     {
-        return {
-            x: this.x,
-            y: this.y
-        }
+        return {x: this.x, y: this.y}
     }
 
 }

package/lib/logger.js

@@ -9,7 +9,7 @@ class Logger
 
     logLevels = {
         none: 0,
-        emergency: 1, // system is unusable
+        emergency: 1, // the system is unusable
         alert: 2, // action must be taken immediately
         critical: 3, // critical conditions
         error: 4, // error conditions
@@ -29,6 +29,7 @@ class Logger
         this.logLevelBack = 3;
         this.forcedDisabled = Boolean(context.RELDENS_FORCED_DISABLED_LOGS || false);
         this.addTimeStamp = Boolean(context.RELDENS_INCLUDE_LOGS_TIMESTAMP || true);
+        this.callback = false;
     }
 
     context()
@@ -93,19 +94,27 @@ class Logger
     log(levelLabel, ...args)
     {
         let date = !this.addTimeStamp ? '' : (new Date()).toISOString().slice(0, 19).replace('T', ' ')+' - ';
-        console.log(date+levelLabel.toUpperCase()+' -', ...args);
+        this.logWithCallback(date+levelLabel.toUpperCase()+' -', ...args);
         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);
+                this.logWithCallback('Error.captureStackTrace is not available.', typeof Error?.captureStackTrace);
                 return this;
             }
             let stackHolder = {};
             Error.captureStackTrace(stackHolder, levelLabel);
-            console.log(stackHolder.stack);
+            this.logWithCallback(stackHolder.stack);
         }
         return this;
     }
 
+    logWithCallback(...args)
+    {
+        if('function' === typeof this.callback){
+            this.callback(...args);
+        }
+        console.log(...args);
+    }
+
     debug(...args)
     {
         if(this.forcedDisabled){

package/lib/schema-validator.js

@@ -2,18 +2,20 @@
  *
  * Reldens - SchemaValidator
  *
- * This module is to validate objects properties at runtime.
+ * This module is to validate the object properties at runtime.
  *
  */
 
+const ValidatorInterface = require('./validator-interface');
 const sc = require('./shortcuts');
 const Logger = require('./logger');
 
-class SchemaValidator
+class SchemaValidator extends ValidatorInterface
 {
 
     constructor(schema)
     {
+        super(schema);
         this.schema = schema;
     }
 

package/lib/shortcuts.js

@@ -49,7 +49,7 @@ class Shortcuts
 
     isFunction(callback)
     {
-        return callback && 'function' === typeof callback;
+        return (callback && 'function' === typeof callback);
     }
 
     isObjectFunction(obj, property)
@@ -427,6 +427,37 @@ class Shortcuts
         return isoLanguageCodeRegex.test(isoCode);
     }
 
+    sanitize(input)
+    {
+        if(!input){
+            return '';
+        }
+        return input
+            .replace(/&(?![a-zA-Z0-9#]+;)/g, '&')
+            .replace(/</g, '&lt;')
+            .replace(/>/g, '&gt;')
+            .replace(/"/g, '&quot;')
+            .replace(/'/g, '&#x27;')
+            .replace(/\//g, '&#x2F;')
+            .replace(/`/g, '&#x60;');
+    }
+
+    sanitizeUrl(url)
+    {
+        if(!url){
+            return '';
+        }
+        let sanitized = url.trim();
+        let urlPattern = /^(?:https?:\/\/|mailto:|tel:|#|\/|\.\/|\.\.\/)/i;
+        if(!urlPattern.test(sanitized)){
+            return '';
+        }
+        return sanitized
+            .replace(/javascript:/gi, '')
+            .replace(/data:/gi, '')
+            .replace(/vbscript:/gi, '');
+    }
+
 }
 
 module.exports = new Shortcuts();

package/lib/validator-interface.js

@@ -0,0 +1,17 @@
+/**
+ *
+ * Reldens - ValidatorInterface
+ *
+ */
+
+class ValidatorInterface
+{
+
+    validate()
+    {
+        return true;
+    }
+
+}
+
+module.exports.ValidatorInterface = ValidatorInterface;

package/package.json

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