@sera4/essentia 1.1.52 → 1.1.53

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@sera4/essentia",
-  "version": "1.1.52",
+  "version": "1.1.53",
   "description": "A library of utilities for Teleporte Web Services",
   "main": "index.js",
   "type": "module",

package/serializer/index.js

@@ -8,23 +8,53 @@ export default {
    * @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
+   *  • remove - an array of fields ot be REMOVED so they cannot be unhidden
    *  • decorators - an array of special decorators to run during serialization
+   *    • handler - a handler for transforming data using only the values
+   *    • advhandler - an advanced handler for transforming data using the value, object or options
+   *  • includeAllFields - show fields that are normally hidden
+   *  • includeFields[..] - show specific fields that are normally hidden
    */
   serialize : (Model, options) => {
     Model.prototype.toJSON = function(eachOptions={}) {
       const hide = options && options.hide ? options.hide : [];
+      const remove = options && options.remove ? options.remove : [];
+      // ignore hide principles; but still do NOT show null
+      const includeAllFields = eachOptions["includeAllFields"];
+
+      // optionally force a normally hidden fields to be seen (by name)
+      const includeFields = eachOptions["includeFields"] || []
+      const handlerOptions = eachOptions["handlerOptions"] || {}
+
       const values = this.get();
 
+      // for security reasons, some fields may need to be removed, such as
+      //   password salts and mfa tokens
+      remove.forEach((field) => {
+        delete values[field];
+      });
+
       if (options && options.decorators) {
         options.decorators.forEach(dec => {
           const k = dec.name;
           const v = values[k];
-          values[k] = dec.handler(v);
+          // the advanced handler takes more parameters
+          if (dec.advHandler) {
+            values[k] = dec.advHandler(v, this, handlerOptions);
+          } else {
+            values[k] = dec.handler(v);
+          }
         });
       }
 
+      // hidden fields CAN be resurrected if NOT null, and forced to be
+      //  included
       let omitted = _.omitBy(values, (v, k) => {
-        return hide.includes(k) || v === null;
+        if (v === null) return true;
+
+        let omitted = (includeAllFields ? false : hide.includes(k));
+        if (omitted && includeFields[k]) omitted = true ;
+        return omitted;
       });
 
       const s = eachOptions["serializer"];