@contrast/protect 1.2.1 → 1.4.0

package/lib/utils.js

@@ -1,88 +0,0 @@
-'use strict';
-
-/**
- * Get a symbol parameter value on the given object. The function should be
- * used with a `target` for which we are sure that the Symbol property we need is set before
- * any eventual duplicating Symbol properties. In case of duplicating Symbol properties
- * we will always get the one that's set first.
- * @param   {Object} target built outgoing response
- * @param   {String} symbolName full symbol stringified
- * @returns {Object}        value of the requested symbol property
- */
-function getSymbolProperty(target, symbolName) {
-  if (!target) return;
-  for (const sym of Object.getOwnPropertySymbols(target)) {
-    if (sym.toString() === `Symbol(${symbolName})`) {
-      return target[sym];
-    }
-  }
-}
-
-/**
- * simpleTraverse() walks an object and calls a user function for each key
- * and string value. It is a "simple traverse" in that it
- * 1) doesn't make value callbacks unless the value is a non-empty string
- * 2) it only recognizes items that can be expressed in JSON, i.e., POJO
- * and arrays.
- * 3) it doesn't make callbacks for array indexes (though they appear in
- * the path). array indexes are always numeric and are not a threat.
- *
- * N.B. the path array that is passed to the callback is a dynamic path; new
- * keys are pushed and popped onto the path as simpleTraverse() walks the
- * object. in order to capture the path at the time of the callback, the
- * callback must copy the array, e.g., `path.slice()`, in order to "freeze"
- * it at the time of the callback. the reason for this is that most keys/values
- * are not going to be of interest, and there is no reason to create a new array
- * unless the key/value is of interest.
- *
- * @param {Object} obj the object to traverse
- * @param {Function} cb(path, type, value) is called for each non-array-index key
- * and string value. It is not called for non-string or empty-string Values.
- *   path {[String]} the path prior to the 'Key' or 'Value'; includes array indexes.
- *   type {String} 'Key' or 'Value'
- *   value {String} the Key or Leaf string
- *
- */
-function simpleTraverse(obj, cb) {
-  if (typeof obj !== 'object' || obj === null) {
-    return;
-  }
-  const path = [];
-  /* eslint-disable complexity */
-  function traverse(obj) {
-    const isArray = Array.isArray(obj);
-    for (const k in obj) {
-      if (isArray) {
-        // if it is an array, store each index in path but don't call the
-        // callback on the index itself as they are just numeric strings.
-        path.push(k);
-        if (typeof obj[k] === 'object' && obj[k] !== null) {
-          traverse(obj[k]);
-        } else if (typeof obj[k] === 'string' && obj[k]) {
-          cb(path, 'Value', obj[k]);
-        }
-        path.pop();
-      } else if (typeof obj[k] === 'object' && obj[k] !== null) {
-        cb(path, 'Key', k);
-        path.push(k);
-        traverse(obj[k]);
-        path.pop();
-      } else {
-        cb(path, 'Key', k);
-        // only callback if the value is a non-empty string
-        if (typeof obj[k] === 'string' && obj[k]) {
-          path.push(k);
-          cb(path, 'Value', obj[k]);
-          path.pop();
-        }
-      }
-    }
-  }
-
-  traverse(obj);
-}
-
-module.exports = {
-  getSymbolProperty,
-  simpleTraverse,
-};