@sera4/essentia 1.1.28 → 1.1.30

package/index.js

@@ -9,5 +9,6 @@ export { default as formatter } from "./formatter/index.js";
 export { HealthCheck as healthCheck } from "./health/index.js";
 export { default as queue } from "./queue/index.js";
 export { default as paperTrail } from "./paper-trail/index.js";
+export { default as serializer } from "./serializer/index.js";
 export * from "./utils/index.js";
 export * from "./safe_proxy/index.js";

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@sera4/essentia",
-  "version": "1.1.28",
+  "version": "1.1.30",
   "description": "A library of utilities for Teleporte Web Services",
   "main": "index.js",
   "type": "module",
@@ -20,7 +20,7 @@
   "devDependencies": {
     "chai": "^4.3.4",
     "express": "^4.17.1",
-    "mocha": "^8.3.2",
+    "mocha": "^9.2.2",
     "mocha-junit-reporter": "^1.23.3",
     "node-mocks-http": "^1.10.1",
     "nodemon": "^2.0.7",
@@ -29,14 +29,14 @@
   },
   "dependencies": {
     "amqplib": "^0.8.0",
-    "async": "^2.6.3",
+    "async": "^3.2.2",
     "axios": "^0.21.4",
     "deep-diff": "^1.0.2",
     "diff": "^5.0.0",
     "fast-safe-stringify": "^2.0.7",
     "git-rev": "^0.2.1",
     "lodash": "^4.17.21",
-    "url-parse": "^1.5.3",
+    "url-parse": "^1.5.10",
     "uuid": "^3.4.0",
     "winston": "^3.3.3",
     "winston-logstash": "^0.4.0"

package/serializer/index.js

@@ -0,0 +1,60 @@
+import _ from "lodash";
+
+const customSerializers = {};
+
+export default {
+  /**
+   * Seralizes a Sequelize Model.
+   * @param {Object} Model the squelize model to add this plugin to
+   * @param {Object} options various options for serialization. These can be:
+   *  • hide - an array of fields to be omitted
+   *  • decorators - an array of special decorators to run during serialization
+   */
+  serialize : (Model, options) => {
+    Model.prototype.toJSON = function(eachOptions={}) {
+      const hide = options && options.hide ? options.hide : [];
+      const values = this.get();
+
+      if (options && options.decorators) {
+        options.decorators.forEach(dec => {
+          const k = dec.name;
+          const v = values[k];
+          values[k] = dec.handler(v);
+        });
+      }
+
+      let omitted = _.omitBy(values, (v, k) => {
+        return hide.includes(k) || v === null;
+      });
+
+      const s = eachOptions["serializer"];
+      if (s && customSerializers[s]) {
+        omitted = customSerializers[s](omitted);
+      }
+
+      if (Array.isArray(eachOptions.includes)) {
+        // Attach any included options that are
+        // not null or undefined
+        eachOptions.includes.forEach(include => {
+          if (include) {
+            const key = Object.keys(include);
+            const value = include[key];
+            if (value) {
+              omitted[key] = value;
+            }
+          }
+        });
+      }
+      return omitted;
+    }
+  },
+
+  /**
+   * Registers a custom serializer.
+   * @param {String} name the name of the custom serializer
+   * @param {Function} serializer a custom serializer function associated with the name
+   */
+  register : (name, serializer) => {
+    customSerializers[name] = serializer;
+  }
+}