@sera4/essentia 1.0.9 → 1.0.10

package/formatter/index.js

@@ -0,0 +1,80 @@
+"use strict"
+
+class FormatError extends Error {
+  constructor(m) {
+    super(m);
+  }
+}
+
+// helps to clean up response formats for services responding to rest requests
+class S4Formatter {
+  constructor() { 
+    this.defaults = {
+      status: 422,
+      errors: {}
+    };
+  }
+
+  _isArray (value) {
+    return value && typeof value === 'object' && value.constructor === Array;
+  }
+
+  _fromHash(error) {
+    let response = Object.assign({}, this.defaults);
+
+    if (error.status) {
+      let errorStatus = parseInt(error.status);
+
+      if ((errorStatus >= 200) && (errorStatus < 522)) {
+        response.status = errorStatus
+      }
+    }
+
+    if (error.error && (typeof(error.error) === "string")) {
+      response.errors["generic"] = { msg: error.error }
+    } else if (error.errors) {
+      if (this._isArray(error.errors)) {
+        // many legacy responses which are errors: ["error_name"]
+        error.errors.forEach(function(el, index) {
+          response.errors[`generic_${index}`] = { msg: el }
+        })
+      } else if (typeof(error.errors) === "object") {
+        response.errors = error.errors
+      }
+    } 
+
+    return response;
+  }
+  
+  /**
+  * Desired Response format 
+  *{
+  *    "error": {
+  *        "status": 422,
+  *        "errors": {
+  *            "password": {
+  *                "location": "body",
+  *                "param": "password",
+  *                "value": "mypassword",
+  *                "msg": "weak"
+  *            }
+  *        }
+  *    },
+  *    "error_id": "a2ddf895-2aaf-4189-88a2-8e11f6843f91"
+  *}
+  */
+  formatError(error) {
+    let response;
+    if (error === null) {
+      response = this.defaults;
+    } else if (typeof(error) === "object")  {
+      response = this._fromHash(error);
+    } else { 
+      return new FormatError("invalid_error_format");
+    }
+
+    return response;
+  }
+}
+
+module.exports = new S4Formatter();

package/index.js

@@ -3,5 +3,7 @@ module.exports = {
   sqlPaginator : require("./paginator/sql-pagination"),
   logger : require("./logger/s4-logger"),
   lastCommit : require("./last_commit"),
-  halDecorator : require("./hal")
-}
+  halDecorator : require("./hal"),
+  formatter : require("./formatter")
+}
+//console.log(module.exports.formatter.formatError({ status: 200, error: ["error1"] }));

package/logger/s4-logger.js

@@ -11,7 +11,7 @@ logger.add(winston.transports.Console, {
 
 class S4Logger {
   setLevel(level) {
-    if (level && ["debug", "info", "error"].indexOf(level.toLowerCase())) {
+    if (level && ["debug", "info", "error", "warn"].indexOf(level.toLowerCase())) {
       logger.transports[loggerName].level = level;  
     }
   }
@@ -24,6 +24,9 @@ class S4Logger {
   debug(str, args) {
     logger.log("debug", str, args);
   }
+  warn(str, args) {
+    logger.log("warn", str, args);
+  }
   info(str, args) {
     logger.log("info", str, args);
   }
@@ -32,4 +35,4 @@ class S4Logger {
   }
 }
 
-module.exports = new S4Logger();
+module.exports = new S4Logger();

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@sera4/essentia",
-  "version": "1.0.9",
+  "version": "1.0.10",
   "description": "A library of utilities for Teleporte Web Services",
   "main": "index.js",
   "scripts": {