chai 5.1.1 → 5.1.2

package/chai.js

@@ -37,6 +37,7 @@ __export(utils_exports, {
   hasProperty: () => hasProperty,
   inspect: () => inspect2,
   isNaN: () => isNaN2,
+  isNumeric: () => isNumeric,
   isProxyEnabled: () => isProxyEnabled,
   isRegExp: () => isRegExp2,
   objDisplay: () => objDisplay,
@@ -302,6 +303,10 @@ function normaliseOptions({
   return options;
 }
 __name(normaliseOptions, "normaliseOptions");
+function isHighSurrogate(char) {
+  return char >= "\uD800" && char <= "\uDBFF";
+}
+__name(isHighSurrogate, "isHighSurrogate");
 function truncate(string, length, tail = truncator) {
   string = String(string);
   const tailLength = tail.length;
@@ -310,7 +315,11 @@ function truncate(string, length, tail = truncator) {
     return tail;
   }
   if (stringLength > length && stringLength > tailLength) {
-    return `${string.slice(0, length - tailLength)}${tail}`;
+    let end = length - tailLength;
+    if (end > 0 && isHighSurrogate(string[end - 1])) {
+      end = end - 1;
+    }
+    return `${string.slice(0, end)}${tail}`;
   }
   return string;
 }
@@ -587,7 +596,7 @@ function inspectObject(object, options) {
   }
   options.truncate -= 4;
   options.seen = options.seen || [];
-  if (options.seen.indexOf(object) >= 0) {
+  if (options.seen.includes(object)) {
     return "[Circular]";
   }
   options.seen.push(object);
@@ -638,7 +647,8 @@ var errorKeys = [
   "lineNumber",
   "columnNumber",
   "number",
-  "description"
+  "description",
+  "cause"
 ];
 function inspectObject2(error, options) {
   const properties = Object.getOwnPropertyNames(error).filter((key) => errorKeys.indexOf(key) === -1);
@@ -652,6 +662,11 @@ function inspectObject2(error, options) {
   }
   message = message ? `: ${message}` : "";
   options.truncate -= message.length + 5;
+  options.seen = options.seen || [];
+  if (options.seen.includes(error)) {
+    return "[Circular]";
+  }
+  options.seen.push(error);
   const propertyContents = inspectList(properties.map((key) => [key, error[key]]), options, inspectProperty);
   return `${name}${message}${propertyContents ? ` { ${propertyContents} }` : ""}`;
 }
@@ -1161,12 +1176,16 @@ function regexpEqual(leftHandOperand, rightHandOperand) {
 }
 __name(regexpEqual, "regexpEqual");
 function entriesEqual(leftHandOperand, rightHandOperand, options) {
-  if (leftHandOperand.size !== rightHandOperand.size) {
+  try {
+    if (leftHandOperand.size !== rightHandOperand.size) {
+      return false;
+    }
+    if (leftHandOperand.size === 0) {
+      return true;
+    }
+  } catch (sizeError) {
     return false;
   }
-  if (leftHandOperand.size === 0) {
-    return true;
-  }
   var leftHandItems = [];
   var rightHandItems = [];
   leftHandOperand.forEach(/* @__PURE__ */ __name(function gatherEntries(key, value) {
@@ -1822,6 +1841,10 @@ function isRegExp2(obj) {
   return Object.prototype.toString.call(obj) === "[object RegExp]";
 }
 __name(isRegExp2, "isRegExp");
+function isNumeric(obj) {
+  return ["Number", "BigInt"].includes(type(obj));
+}
+__name(isNumeric, "isNumeric");
 
 // lib/chai/core/assertions.js
 var { flag: flag2 } = utils_exports;
@@ -2008,6 +2031,15 @@ Assertion.addProperty("true", function() {
     flag2(this, "negate") ? false : true
   );
 });
+Assertion.addProperty("numeric", function() {
+  const object = flag2(this, "object");
+  this.assert(
+    ["Number", "BigInt"].includes(type(object)),
+    "expected #{this} to be numeric",
+    "expected #{this} to not be numeric",
+    flag2(this, "negate") ? false : true
+  );
+});
 Assertion.addProperty("callable", function() {
   const val = flag2(this, "object");
   const ssfi = flag2(this, "ssfi");
@@ -2156,22 +2188,17 @@ Assertion.addMethod("eqls", assertEql);
 function assertAbove(n, msg) {
   if (msg)
     flag2(this, "message", msg);
-  var obj = flag2(this, "object"), doLength = flag2(this, "doLength"), flagMsg = flag2(this, "message"), msgPrefix = flagMsg ? flagMsg + ": " : "", ssfi = flag2(this, "ssfi"), objType = type(obj).toLowerCase(), nType = type(n).toLowerCase(), errorMessage, shouldThrow = true;
+  var obj = flag2(this, "object"), doLength = flag2(this, "doLength"), flagMsg = flag2(this, "message"), msgPrefix = flagMsg ? flagMsg + ": " : "", ssfi = flag2(this, "ssfi"), objType = type(obj).toLowerCase(), nType = type(n).toLowerCase();
   if (doLength && objType !== "map" && objType !== "set") {
     new Assertion(obj, flagMsg, ssfi, true).to.have.property("length");
   }
   if (!doLength && (objType === "date" && nType !== "date")) {
-    errorMessage = msgPrefix + "the argument to above must be a date";
-  } else if (nType !== "number" && (doLength || objType === "number")) {
-    errorMessage = msgPrefix + "the argument to above must be a number";
-  } else if (!doLength && (objType !== "date" && objType !== "number")) {
+    throw new AssertionError(msgPrefix + "the argument to above must be a date", void 0, ssfi);
+  } else if (!isNumeric(n) && (doLength || isNumeric(obj))) {
+    throw new AssertionError(msgPrefix + "the argument to above must be a number", void 0, ssfi);
+  } else if (!doLength && (objType !== "date" && !isNumeric(obj))) {
     var printObj = objType === "string" ? "'" + obj + "'" : obj;
-    errorMessage = msgPrefix + "expected " + printObj + " to be a number or a date";
-  } else {
-    shouldThrow = false;
-  }
-  if (shouldThrow) {
-    throw new AssertionError(errorMessage, void 0, ssfi);
+    throw new AssertionError(msgPrefix + "expected " + printObj + " to be a number or a date", void 0, ssfi);
   }
   if (doLength) {
     var descriptor = "length", itemsCount;
@@ -2210,9 +2237,9 @@ function assertLeast(n, msg) {
   }
   if (!doLength && (objType === "date" && nType !== "date")) {
     errorMessage = msgPrefix + "the argument to least must be a date";
-  } else if (nType !== "number" && (doLength || objType === "number")) {
+  } else if (!isNumeric(n) && (doLength || isNumeric(obj))) {
     errorMessage = msgPrefix + "the argument to least must be a number";
-  } else if (!doLength && (objType !== "date" && objType !== "number")) {
+  } else if (!doLength && (objType !== "date" && !isNumeric(obj))) {
     var printObj = objType === "string" ? "'" + obj + "'" : obj;
     errorMessage = msgPrefix + "expected " + printObj + " to be a number or a date";
   } else {
@@ -2258,9 +2285,9 @@ function assertBelow(n, msg) {
   }
   if (!doLength && (objType === "date" && nType !== "date")) {
     errorMessage = msgPrefix + "the argument to below must be a date";
-  } else if (nType !== "number" && (doLength || objType === "number")) {
+  } else if (!isNumeric(n) && (doLength || isNumeric(obj))) {
     errorMessage = msgPrefix + "the argument to below must be a number";
-  } else if (!doLength && (objType !== "date" && objType !== "number")) {
+  } else if (!doLength && (objType !== "date" && !isNumeric(obj))) {
     var printObj = objType === "string" ? "'" + obj + "'" : obj;
     errorMessage = msgPrefix + "expected " + printObj + " to be a number or a date";
   } else {
@@ -2306,9 +2333,9 @@ function assertMost(n, msg) {
   }
   if (!doLength && (objType === "date" && nType !== "date")) {
     errorMessage = msgPrefix + "the argument to most must be a date";
-  } else if (nType !== "number" && (doLength || objType === "number")) {
+  } else if (!isNumeric(n) && (doLength || isNumeric(obj))) {
     errorMessage = msgPrefix + "the argument to most must be a number";
-  } else if (!doLength && (objType !== "date" && objType !== "number")) {
+  } else if (!doLength && (objType !== "date" && !isNumeric(obj))) {
     var printObj = objType === "string" ? "'" + obj + "'" : obj;
     errorMessage = msgPrefix + "expected " + printObj + " to be a number or a date";
   } else {
@@ -2354,9 +2381,9 @@ Assertion.addMethod("within", function(start, finish, msg) {
   }
   if (!doLength && (objType === "date" && (startType !== "date" || finishType !== "date"))) {
     errorMessage = msgPrefix + "the arguments to within must be dates";
-  } else if ((startType !== "number" || finishType !== "number") && (doLength || objType === "number")) {
+  } else if ((!isNumeric(start) || !isNumeric(finish)) && (doLength || isNumeric(obj))) {
     errorMessage = msgPrefix + "the arguments to within must be numbers";
-  } else if (!doLength && (objType !== "date" && objType !== "number")) {
+  } else if (!doLength && (objType !== "date" && !isNumeric(obj))) {
     var printObj = objType === "string" ? "'" + obj + "'" : obj;
     errorMessage = msgPrefix + "expected " + printObj + " to be a number or a date";
   } else {
@@ -2817,18 +2844,18 @@ function closeTo(expected, delta, msg) {
   if (msg)
     flag2(this, "message", msg);
   var obj = flag2(this, "object"), flagMsg = flag2(this, "message"), ssfi = flag2(this, "ssfi");
-  new Assertion(obj, flagMsg, ssfi, true).is.a("number");
-  if (typeof expected !== "number" || typeof delta !== "number") {
-    flagMsg = flagMsg ? flagMsg + ": " : "";
-    var deltaMessage = delta === void 0 ? ", and a delta is required" : "";
-    throw new AssertionError(
-      flagMsg + "the arguments to closeTo or approximately must be numbers" + deltaMessage,
-      void 0,
-      ssfi
-    );
-  }
+  new Assertion(obj, flagMsg, ssfi, true).is.numeric;
+  let message = "A `delta` value is required for `closeTo`";
+  if (delta == void 0)
+    throw new AssertionError(flagMsg ? `${flagMsg}: ${message}` : message, void 0, ssfi);
+  new Assertion(delta, flagMsg, ssfi, true).is.numeric;
+  message = "A `expected` value is required for `closeTo`";
+  if (expected == void 0)
+    throw new AssertionError(flagMsg ? `${flagMsg}: ${message}` : message, void 0, ssfi);
+  new Assertion(expected, flagMsg, ssfi, true).is.numeric;
+  const abs = /* @__PURE__ */ __name((x) => x < 0n ? -x : x, "abs");
   this.assert(
-    Math.abs(obj - expected) <= delta,
+    abs(obj - expected) <= delta,
     "expected #{this} to be close to " + expected + " +/- " + delta,
     "expected #{this} not to be close to " + expected + " +/- " + delta
   );
@@ -3319,6 +3346,12 @@ assert.isNumber = function(val, msg) {
 assert.isNotNumber = function(val, msg) {
   new Assertion(val, msg, assert.isNotNumber, true).to.not.be.a("number");
 };
+assert.isNumeric = function(val, msg) {
+  new Assertion(val, msg, assert.isNumeric, true).is.numeric;
+};
+assert.isNotNumeric = function(val, msg) {
+  new Assertion(val, msg, assert.isNotNumeric, true).is.not.numeric;
+};
 assert.isFinite = function(val, msg) {
   new Assertion(val, msg, assert.isFinite, true).to.be.finite;
 };

package/lib/chai/core/assertions.js

@@ -233,7 +233,6 @@ Assertion.addProperty('any', function () {
  * @namespace BDD
  * @public
  */
-
 Assertion.addProperty('all', function () {
   flag(this, 'all', true);
   flag(this, 'any', false);
@@ -694,6 +693,17 @@ Assertion.addProperty('true', function () {
   );
 });
 
+Assertion.addProperty('numeric', function () {
+  const object = flag(this, 'object');
+
+  this.assert(
+      ['Number', 'BigInt'].includes(_.type(object))
+    , 'expected #{this} to be numeric'
+    , 'expected #{this} to not be numeric'
+    , flag(this, 'negate') ? false : true
+  );
+});
+
 /**
  * ### .callable
  *
@@ -1208,27 +1218,19 @@ function assertAbove (n, msg) {
     , msgPrefix = ((flagMsg) ? flagMsg + ': ' : '')
     , ssfi = flag(this, 'ssfi')
     , objType = _.type(obj).toLowerCase()
-    , nType = _.type(n).toLowerCase()
-    , errorMessage
-    , shouldThrow = true;
+    , nType = _.type(n).toLowerCase();
 
   if (doLength && objType !== 'map' && objType !== 'set') {
     new Assertion(obj, flagMsg, ssfi, true).to.have.property('length');
   }
 
   if (!doLength && (objType === 'date' && nType !== 'date')) {
-    errorMessage = msgPrefix + 'the argument to above must be a date';
-  } else if (nType !== 'number' && (doLength || objType === 'number')) {
-    errorMessage = msgPrefix + 'the argument to above must be a number';
-  } else if (!doLength && (objType !== 'date' && objType !== 'number')) {
+    throw new AssertionError(msgPrefix + 'the argument to above must be a date', undefined, ssfi);
+  } else if (!_.isNumeric(n) && (doLength || _.isNumeric(obj))) {
+    throw new AssertionError(msgPrefix + 'the argument to above must be a number', undefined, ssfi);
+  } else if (!doLength && (objType !== 'date' && !_.isNumeric(obj))) {
     var printObj = (objType === 'string') ? "'" + obj + "'" : obj;
-    errorMessage = msgPrefix + 'expected ' + printObj + ' to be a number or a date';
-  } else {
-    shouldThrow = false;
-  }
-
-  if (shouldThrow) {
-    throw new AssertionError(errorMessage, undefined, ssfi);
+    throw new AssertionError(msgPrefix + 'expected ' + printObj + ' to be a number or a date', undefined, ssfi);
   }
 
   if (doLength) {
@@ -1299,7 +1301,7 @@ Assertion.addMethod('greaterThan', assertAbove);
  * @name least
  * @alias gte
  * @alias greaterThanOrEqual
- * @param {number} n
+ * @param {unknown} n
  * @param {string} msg _optional_
  * @namespace BDD
  * @public
@@ -1322,9 +1324,9 @@ function assertLeast (n, msg) {
 
   if (!doLength && (objType === 'date' && nType !== 'date')) {
     errorMessage = msgPrefix + 'the argument to least must be a date';
-  } else if (nType !== 'number' && (doLength || objType === 'number')) {
+  } else if (!_.isNumeric(n) && (doLength || _.isNumeric(obj))) {
     errorMessage = msgPrefix + 'the argument to least must be a number';
-  } else if (!doLength && (objType !== 'date' && objType !== 'number')) {
+  } else if (!doLength && (objType !== 'date' && !_.isNumeric(obj))) {
     var printObj = (objType === 'string') ? "'" + obj + "'" : obj;
     errorMessage = msgPrefix + 'expected ' + printObj + ' to be a number or a date';
   } else {
@@ -1402,7 +1404,7 @@ Assertion.addMethod('greaterThanOrEqual', assertLeast);
  * @name below
  * @alias lt
  * @alias lessThan
- * @param {number} n
+ * @param {unknown} n
  * @param {string} msg _optional_
  * @namespace BDD
  * @public
@@ -1422,12 +1424,12 @@ function assertBelow (n, msg) {
   if (doLength && objType !== 'map' && objType !== 'set') {
     new Assertion(obj, flagMsg, ssfi, true).to.have.property('length');
   }
-
+  
   if (!doLength && (objType === 'date' && nType !== 'date')) {
     errorMessage = msgPrefix + 'the argument to below must be a date';
-  } else if (nType !== 'number' && (doLength || objType === 'number')) {
+  } else if (!_.isNumeric(n) && (doLength || _.isNumeric(obj))) {
     errorMessage = msgPrefix + 'the argument to below must be a number';
-  } else if (!doLength && (objType !== 'date' && objType !== 'number')) {
+  } else if (!doLength && (objType !== 'date' && !_.isNumeric(obj))) {
     var printObj = (objType === 'string') ? "'" + obj + "'" : obj;
     errorMessage = msgPrefix + 'expected ' + printObj + ' to be a number or a date';
   } else {
@@ -1506,7 +1508,7 @@ Assertion.addMethod('lessThan', assertBelow);
  * @name most
  * @alias lte
  * @alias lessThanOrEqual
- * @param {number} n
+ * @param {unknown} n
  * @param {string} msg _optional_
  * @namespace BDD
  * @public
@@ -1529,9 +1531,9 @@ function assertMost (n, msg) {
 
   if (!doLength && (objType === 'date' && nType !== 'date')) {
     errorMessage = msgPrefix + 'the argument to most must be a date';
-  } else if (nType !== 'number' && (doLength || objType === 'number')) {
+  } else if (!_.isNumeric(n) && (doLength || _.isNumeric(obj))) {
     errorMessage = msgPrefix + 'the argument to most must be a number';
-  } else if (!doLength && (objType !== 'date' && objType !== 'number')) {
+  } else if (!doLength && (objType !== 'date' && !_.isNumeric(obj))) {
     var printObj = (objType === 'string') ? "'" + obj + "'" : obj;
     errorMessage = msgPrefix + 'expected ' + printObj + ' to be a number or a date';
   } else {
@@ -1608,8 +1610,8 @@ Assertion.addMethod('lessThanOrEqual', assertMost);
  *     expect(4, 'nooo why fail??').to.be.within(1, 3);
  *
  * @name within
- * @param {number} start lower bound inclusive
- * @param {number} finish upper bound inclusive
+ * @param {unknown} start lower bound inclusive
+ * @param {unknown} finish upper bound inclusive
  * @param {string} msg _optional_
  * @namespace BDD
  * @public
@@ -1636,9 +1638,9 @@ Assertion.addMethod('within', function (start, finish, msg) {
 
   if (!doLength && (objType === 'date' && (startType !== 'date' || finishType !== 'date'))) {
     errorMessage = msgPrefix + 'the arguments to within must be dates';
-  } else if ((startType !== 'number' || finishType !== 'number') && (doLength || objType === 'number')) {
+  } else if ((!_.isNumeric(start) || !_.isNumeric(finish)) && (doLength || _.isNumeric(obj))) {
     errorMessage = msgPrefix + 'the arguments to within must be numbers';
-  } else if (!doLength && (objType !== 'date' && objType !== 'number')) {
+  } else if (!doLength && (objType !== 'date' && !_.isNumeric(obj))) {
     var printObj = (objType === 'string') ? "'" + obj + "'" : obj;
     errorMessage = msgPrefix + 'expected ' + printObj + ' to be a number or a date';
   } else {
@@ -3013,19 +3015,18 @@ function closeTo(expected, delta, msg) {
     , flagMsg = flag(this, 'message')
     , ssfi = flag(this, 'ssfi');
 
-  new Assertion(obj, flagMsg, ssfi, true).is.a('number');
-  if (typeof expected !== 'number' || typeof delta !== 'number') {
-    flagMsg = flagMsg ? flagMsg + ': ' : '';
-    var deltaMessage = delta === undefined ? ", and a delta is required" : "";
-    throw new AssertionError(
-        flagMsg + 'the arguments to closeTo or approximately must be numbers' + deltaMessage,
-        undefined,
-        ssfi
-    );
-  }
+  new Assertion(obj, flagMsg, ssfi, true).is.numeric;
+  let message =  'A `delta` value is required for `closeTo`';
+  if (delta == undefined) throw new AssertionError(flagMsg ? `${flagMsg}: ${message}` : message, undefined, ssfi);
+  new Assertion(delta, flagMsg, ssfi, true).is.numeric;
+  message =  'A `expected` value is required for `closeTo`';
+  if (expected == undefined) throw new AssertionError(flagMsg ? `${flagMsg}: ${message}` : message, undefined, ssfi);
+  new Assertion(expected, flagMsg, ssfi, true).is.numeric;
+
+  const abs = (x) => x < 0n ? -x : x;
 
   this.assert(
-      Math.abs(obj - expected) <= delta
+      abs(obj - expected) <= delta
     , 'expected #{this} to be close to ' + expected + ' +/- ' + delta
     , 'expected #{this} not to be close to ' + expected + ' +/- ' + delta
   );

package/lib/chai/interface/assert.js

@@ -706,6 +706,45 @@ assert.isNotNumber = function (val, msg) {
   new Assertion(val, msg, assert.isNotNumber, true).to.not.be.a('number');
 };
 
+/**
+ * ### .isNumeric(value, [message])
+ *
+ * Asserts that `value` is a number or BigInt.
+ *
+ *     var cups = 2;
+ *     assert.isNumeric(cups, 'how many cups');
+ * 
+ *     var cups = 10n;
+ *     assert.isNumeric(cups, 'how many cups');
+ *
+ * @name isNumeric
+ * @param {unknown} val
+ * @param {string} msg
+ * @namespace Assert
+ * @public
+ */
+assert.isNumeric = function (val, msg) {
+  new Assertion(val, msg, assert.isNumeric, true).is.numeric;
+};
+
+/**
+ * ### .isNotNumeric(value, [message])
+ *
+ * Asserts that `value` is _not_ a number or BigInt.
+ *
+ *     var cups = '2 cups please';
+ *     assert.isNotNumeric(cups, 'how many cups');
+ *
+ * @name isNotNumeric
+ * @param {unknown} val
+ * @param {string} msg
+ * @namespace Assert
+ * @public
+ */
+assert.isNotNumeric = function (val, msg) {
+  new Assertion(val, msg, assert.isNotNumeric, true).is.not.numeric;
+};
+
  /**
   * ### .isFinite(value, [message])
   *

package/lib/chai/utils/index.js

@@ -11,7 +11,8 @@ import * as checkError from 'check-error';
 export {test} from './test.js';
 
 // type utility
-export {type} from './type-detect.js';
+import {type} from './type-detect.js';
+export {type};
 
 // expectTypes utility
 export {expectTypes} from './expectTypes.js';
@@ -105,3 +106,7 @@ export {getOperator} from './getOperator.js';
 export function isRegExp(obj) {
   return Object.prototype.toString.call(obj) === '[object RegExp]';
 }
+
+export function isNumeric(obj) {
+  return ['Number', 'BigInt'].includes(type(obj))
+}

package/package.json

@@ -18,7 +18,7 @@
     "Veselin Todorov <hi@vesln.com>",
     "John Firebaugh <john.firebaugh@gmail.com>"
   ],
-  "version": "5.1.1",
+  "version": "5.1.2",
   "repository": {
     "type": "git",
     "url": "https://github.com/chaijs/chai"