check-types-mini 6.1.0 → 7.0.3

package/dist/check-types-mini.cjs.js

@@ -1,203 +0,0 @@
-/**
- * @name check-types-mini
- * @fileoverview Validate options object
- * @version 6.1.0
- * @author Roy Revelt, Codsen Ltd
- * @license MIT
- * {@link https://codsen.com/os/check-types-mini/}
- */
-
-'use strict';
-
-Object.defineProperty(exports, '__esModule', { value: true });
-
-var _typeof = require('@babel/runtime/helpers/typeof');
-var _objectSpread = require('@babel/runtime/helpers/objectSpread2');
-var typ = require('type-detect');
-var pullAll = require('lodash.pullall');
-var astMonkeyTraverse = require('ast-monkey-traverse');
-var intersection = require('lodash.intersection');
-var arrayiffyIfString = require('arrayiffy-if-string');
-var objectPath = require('object-path');
-var matcher = require('matcher');
-
-function _interopDefaultLegacy (e) { return e && typeof e === 'object' && 'default' in e ? e : { 'default': e }; }
-
-var _typeof__default = /*#__PURE__*/_interopDefaultLegacy(_typeof);
-var _objectSpread__default = /*#__PURE__*/_interopDefaultLegacy(_objectSpread);
-var typ__default = /*#__PURE__*/_interopDefaultLegacy(typ);
-var pullAll__default = /*#__PURE__*/_interopDefaultLegacy(pullAll);
-var intersection__default = /*#__PURE__*/_interopDefaultLegacy(intersection);
-var objectPath__default = /*#__PURE__*/_interopDefaultLegacy(objectPath);
-var matcher__default = /*#__PURE__*/_interopDefaultLegacy(matcher);
-
-var defaults = {
-  ignoreKeys: [],
-  ignorePaths: [],
-  acceptArrays: false,
-  acceptArraysIgnore: [],
-  enforceStrictKeyset: true,
-  schema: {},
-  msg: "check-types-mini",
-  optsVarName: "opts"
-};
-function internalApi(obj, ref, originalOptions) {
-  function existy(something) {
-    return something != null;
-  }
-  function isObj(something) {
-    return typ__default['default'](something) === "Object";
-  }
-  function pullAllWithGlob(originalInput, toBeRemoved) {
-    if (typeof toBeRemoved === "string") {
-      toBeRemoved = arrayiffyIfString.arrayiffy(toBeRemoved);
-    }
-    return Array.from(originalInput).filter(function (originalVal) {
-      return !toBeRemoved.some(function (remVal) {
-        return matcher__default['default'].isMatch(originalVal, remVal, {
-          caseSensitive: true
-        });
-      });
-    });
-  }
-  var hasKey = Object.prototype.hasOwnProperty;
-  var NAMESFORANYTYPE = ["any", "anything", "every", "everything", "all", "whatever", "whatevs"];
-  if (!existy(obj)) {
-    throw new Error("check-types-mini: [THROW_ID_01] First argument is missing!");
-  }
-  var opts = _objectSpread__default['default'](_objectSpread__default['default']({}, defaults), originalOptions);
-  if (typeof opts.ignoreKeys === "string") {
-    opts.ignoreKeys = [opts.ignoreKeys];
-  }
-  if (typeof opts.ignorePaths === "string") {
-    opts.ignorePaths = [opts.ignorePaths];
-  }
-  if (typeof opts.acceptArraysIgnore === "string") {
-    opts.acceptArraysIgnore = [opts.acceptArraysIgnore];
-  }
-  opts.msg = "".concat(opts.msg).trim();
-  if (opts.msg[opts.msg.length - 1] === ":") {
-    opts.msg = opts.msg.slice(0, opts.msg.length - 1).trim();
-  }
-  if (isObj(opts.schema)) {
-    Object.keys(opts.schema).forEach(function (oneKey) {
-      if (isObj(opts.schema[oneKey])) {
-        var tempObj = {};
-        astMonkeyTraverse.traverse(opts.schema[oneKey], function (key, val, innerObj) {
-          var current = val !== undefined ? val : key;
-          if (!Array.isArray(current) && !isObj(current)) {
-            tempObj["".concat(oneKey, ".").concat(innerObj.path)] = current;
-          }
-          return current;
-        });
-        delete opts.schema[oneKey];
-        opts.schema = _objectSpread__default['default'](_objectSpread__default['default']({}, opts.schema), tempObj);
-      }
-    });
-    Object.keys(opts.schema).forEach(function (oneKey) {
-      if (!Array.isArray(opts.schema[oneKey])) {
-        opts.schema[oneKey] = [opts.schema[oneKey]];
-      }
-      opts.schema[oneKey] = opts.schema[oneKey].map(function (el) {
-        return "".concat(el).toLowerCase().trim();
-      });
-    });
-  } else if (opts.schema != null) {
-    throw new Error("check-types-mini: opts.schema was customised to ".concat(JSON.stringify(opts.schema, null, 0), " which is not object but ").concat(_typeof__default['default'](opts.schema)));
-  }
-  if (!existy(ref)) {
-    ref = {};
-  }
-  if (opts.enforceStrictKeyset) {
-    if (existy(opts.schema) && Object.keys(opts.schema).length > 0) {
-      if (ref && pullAllWithGlob(pullAll__default['default'](Object.keys(obj), Object.keys(ref).concat(Object.keys(opts.schema))), opts.ignoreKeys).length) {
-        var keys = pullAll__default['default'](Object.keys(obj), Object.keys(ref).concat(Object.keys(opts.schema)));
-        throw new TypeError("".concat(opts.msg, ": ").concat(opts.optsVarName, ".enforceStrictKeyset is on and the following key").concat(keys.length > 1 ? "s" : "", " ").concat(keys.length > 1 ? "are" : "is", " not covered by schema and/or reference objects: ").concat(keys.join(", ")));
-      }
-    } else if (isObj(ref) && Object.keys(ref).length > 0) {
-      if (pullAllWithGlob(pullAll__default['default'](Object.keys(obj), Object.keys(ref)), opts.ignoreKeys).length !== 0) {
-        var _keys = pullAll__default['default'](Object.keys(obj), Object.keys(ref));
-        throw new TypeError("".concat(opts.msg, ": The input object has key").concat(_keys.length > 1 ? "s" : "", " which ").concat(_keys.length > 1 ? "are" : "is", " not covered by the reference object: ").concat(_keys.join(", ")));
-      } else if (pullAllWithGlob(pullAll__default['default'](Object.keys(ref), Object.keys(obj)), opts.ignoreKeys).length !== 0) {
-        var _keys2 = pullAll__default['default'](Object.keys(ref), Object.keys(obj));
-        throw new TypeError("".concat(opts.msg, ": The reference object has key").concat(_keys2.length > 1 ? "s" : "", " which ").concat(_keys2.length > 1 ? "are" : "is", " not present in the input object: ").concat(_keys2.join(", ")));
-      }
-    } else {
-      throw new TypeError("".concat(opts.msg, ": Both ").concat(opts.optsVarName, ".schema and reference objects are missing! We don't have anything to match the keys as you requested via opts.enforceStrictKeyset!"));
-    }
-  }
-  var ignoredPathsArr = [];
-  astMonkeyTraverse.traverse(obj, function (key, val, innerObj) {
-    var current = val;
-    var objKey = key;
-    if (innerObj.parentType === "array") {
-      objKey = undefined;
-      current = key;
-    }
-    if (Array.isArray(ignoredPathsArr) && ignoredPathsArr.length && ignoredPathsArr.some(function (path) {
-      return innerObj.path.startsWith(path);
-    })) {
-      return current;
-    }
-    if (objKey && opts.ignoreKeys.some(function (oneOfKeysToIgnore) {
-      return matcher__default['default'].isMatch(objKey, oneOfKeysToIgnore);
-    })) {
-      return current;
-    }
-    if (opts.ignorePaths.some(function (oneOfPathsToIgnore) {
-      return matcher__default['default'].isMatch(innerObj.path, oneOfPathsToIgnore);
-    })) {
-      return current;
-    }
-    var isNotAnArrayChild = !(!isObj(current) && !Array.isArray(current) && Array.isArray(innerObj.parent));
-    var optsSchemaHasThisPathDefined = false;
-    if (isObj(opts.schema) && hasKey.call(opts.schema, innerObj.path)) {
-      optsSchemaHasThisPathDefined = true;
-    }
-    var refHasThisPathDefined = false;
-    if (isObj(ref) && objectPath__default['default'].has(ref, innerObj.path)) {
-      refHasThisPathDefined = true;
-    }
-    if (opts.enforceStrictKeyset && isNotAnArrayChild && !optsSchemaHasThisPathDefined && !refHasThisPathDefined) {
-      throw new TypeError("".concat(opts.msg, ": ").concat(opts.optsVarName, ".").concat(innerObj.path, " is neither covered by reference object (second input argument), nor ").concat(opts.optsVarName, ".schema! To stop this error, turn off ").concat(opts.optsVarName, ".enforceStrictKeyset or provide some type reference (2nd argument or ").concat(opts.optsVarName, ".schema).\n\nDebug info:\n\nobj = ").concat(JSON.stringify(obj, null, 4), "\n\nref = ").concat(JSON.stringify(ref, null, 4), "\n\ninnerObj = ").concat(JSON.stringify(innerObj, null, 4), "\n\nopts = ").concat(JSON.stringify(opts, null, 4), "\n\ncurrent = ").concat(JSON.stringify(current, null, 4), "\n\n"));
-    } else if (optsSchemaHasThisPathDefined) {
-      var currentKeysSchema = arrayiffyIfString.arrayiffy(opts.schema[innerObj.path]).map(function (el) {
-        return "".concat(el).toLowerCase();
-      });
-      objectPath__default['default'].set(opts.schema, innerObj.path, currentKeysSchema);
-      if (!intersection__default['default'](currentKeysSchema, NAMESFORANYTYPE).length) {
-        if (current !== true && current !== false && !currentKeysSchema.includes(typ__default['default'](current).toLowerCase()) || (current === true || current === false) && !currentKeysSchema.includes(String(current)) && !currentKeysSchema.includes("boolean")) {
-          if (Array.isArray(current) && opts.acceptArrays) {
-            for (var i = 0, len = current.length; i < len; i++) {
-              if (!currentKeysSchema.includes(typ__default['default'](current[i]).toLowerCase())) {
-                throw new TypeError("".concat(opts.msg, ": ").concat(opts.optsVarName, ".").concat(innerObj.path, ".").concat(i, ", the ").concat(i, "th element (equal to ").concat(JSON.stringify(current[i], null, 0), ") is of a type ").concat(typ__default['default'](current[i]).toLowerCase(), ", but only the following are allowed by the ").concat(opts.optsVarName, ".schema: ").concat(currentKeysSchema.join(", ")));
-              }
-            }
-          } else {
-            throw new TypeError("".concat(opts.msg, ": ").concat(opts.optsVarName, ".").concat(innerObj.path, " was customised to ").concat(typ__default['default'](current) !== "string" ? '"' : "").concat(JSON.stringify(current, null, 0)).concat(typ__default['default'](current) !== "string" ? '"' : "", " (type: ").concat(typ__default['default'](current).toLowerCase(), ") which is not among the allowed types in schema (which is equal to ").concat(JSON.stringify(currentKeysSchema, null, 0), ")"));
-          }
-        }
-      } else {
-        ignoredPathsArr.push(innerObj.path);
-      }
-    } else if (ref && isObj(ref) && refHasThisPathDefined) {
-      var compareTo = objectPath__default['default'].get(ref, innerObj.path);
-      if (opts.acceptArrays && Array.isArray(current) && !opts.acceptArraysIgnore.includes(key)) {
-        var allMatch = current.every(function (el) {
-          return typ__default['default'](el).toLowerCase() === typ__default['default'](ref[key]).toLowerCase();
-        });
-        if (!allMatch) {
-          throw new TypeError("".concat(opts.msg, ": ").concat(opts.optsVarName, ".").concat(innerObj.path, " was customised to be array, but not all of its elements are ").concat(typ__default['default'](ref[key]).toLowerCase(), "-type"));
-        }
-      } else if (typ__default['default'](current) !== typ__default['default'](compareTo)) {
-        throw new TypeError("".concat(opts.msg, ": ").concat(opts.optsVarName, ".").concat(innerObj.path, " was customised to ").concat(typ__default['default'](current).toLowerCase() === "string" ? "" : '"').concat(JSON.stringify(current, null, 0)).concat(typ__default['default'](current).toLowerCase() === "string" ? "" : '"', " which is not ").concat(typ__default['default'](compareTo).toLowerCase(), " but ").concat(typ__default['default'](current).toLowerCase()));
-      }
-    } else ;
-    return current;
-  });
-}
-function checkTypesMini(obj, ref, originalOptions) {
-  return internalApi(obj, ref, originalOptions);
-}
-
-exports.checkTypesMini = checkTypesMini;