@kensio/smartass 1.0.1 → 1.1.0

package/README.md

@@ -51,6 +51,7 @@ npm install @kensio/smartass
 - [assertNonNullable](src/assert/non-nullable/non-nullable.assert.ts)
 - [assertNumberBetween](src/assert/number-between/number-between.assert.ts)
 - [assertNumberToNearest](src/assert/number-to-nearest/number-to-nearest.assert.ts)
+- [assertObjectEquals](src/assert/object-equals/object-equals.assert.ts)
 - [assertObjectMatches](src/assert/object-matches/object-matches.assert.ts)
 - [assertOneOf](src/assert/one-of/one-of.assert.ts)
 - [assertStringEndsWith](src/assert/string-ends-with/string-ends-with.assert.ts)
@@ -68,4 +69,5 @@ npm install @kensio/smartass
 - [assertTypeObject](src/assert/type-object/type-object.assert.ts)
 - [assertTypeString](src/assert/type-string/type-string.assert.ts)
 - [assertTypeTypedArray](src/assert/type-typed-array/type-typed-array.assert.ts)
+- [assertUndefined](src/assert/undefined/undefined.assert.ts)
 - [assertUuidV4](src/assert/uuid/uuid-v4.assert.ts)

package/dist/assert/object-equals/object-equals.assert.d.ts

@@ -0,0 +1,10 @@
+/**
+ * Assert that two objects have the same own keys and deeply equal values, with
+ * type narrowing.
+ *
+ * Plain objects are compared recursively by value. Arrays are compared by length
+ * and by recursively comparing each element in order. Primitive values and
+ * non-plain objects are compared using Object.is.
+ */
+export declare function assertObjectEquals<const TExpected extends Record<PropertyKey, unknown>>(actual: unknown, expected: TExpected, message?: string): asserts actual is TExpected;
+//# sourceMappingURL=object-equals.assert.d.ts.map

package/dist/assert/object-equals/object-equals.assert.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"object-equals.assert.d.ts","sourceRoot":"","sources":["../../../src/assert/object-equals/object-equals.assert.ts"],"names":[],"mappings":"AAIA;;;;;;;GAOG;AACH,wBAAgB,kBAAkB,CAChC,KAAK,CAAC,SAAS,SAAS,MAAM,CAAC,WAAW,EAAE,OAAO,CAAC,EAEpD,MAAM,EAAE,OAAO,EACf,QAAQ,EAAE,SAAS,EACnB,OAAO,CAAC,EAAE,MAAM,GACf,OAAO,CAAC,MAAM,IAAI,SAAS,CAc7B"}

package/dist/assert/object-equals/object-equals.assert.js

@@ -0,0 +1,22 @@
+import { AssertionError } from "../../assertion-error.js";
+import { desc, repr } from "../../describe/describe.js";
+import { findObjectComparisonMismatch } from "../../compare/object-comparison.js";
+/**
+ * Assert that two objects have the same own keys and deeply equal values, with
+ * type narrowing.
+ *
+ * Plain objects are compared recursively by value. Arrays are compared by length
+ * and by recursively comparing each element in order. Primitive values and
+ * non-plain objects are compared using Object.is.
+ */
+export function assertObjectEquals(actual, expected, message) {
+    const mismatch = findObjectComparisonMismatch(actual, expected, {
+        exactObjectKeys: true,
+        plainActualObjectsOnly: true,
+    });
+    if (mismatch !== undefined) {
+        throw new AssertionError(message ??
+            `Expected ${desc(actual)} to equal ${desc(expected)}. Mismatch at ${mismatch.path}: expected ${repr(mismatch.expected)}, got ${repr(mismatch.actual)}.`, actual, expected);
+    }
+}
+//# sourceMappingURL=object-equals.assert.js.map

package/dist/assert/object-equals/object-equals.assert.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"object-equals.assert.js","sourceRoot":"","sources":["../../../src/assert/object-equals/object-equals.assert.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,cAAc,EAAE,MAAM,0BAA0B,CAAC;AAC1D,OAAO,EAAE,IAAI,EAAE,IAAI,EAAE,MAAM,4BAA4B,CAAC;AACxD,OAAO,EAAE,4BAA4B,EAAE,MAAM,oCAAoC,CAAC;AAElF;;;;;;;GAOG;AACH,MAAM,UAAU,kBAAkB,CAGhC,MAAe,EACf,QAAmB,EACnB,OAAgB;IAEhB,MAAM,QAAQ,GAAG,4BAA4B,CAAC,MAAM,EAAE,QAAQ,EAAE;QAC9D,eAAe,EAAE,IAAI;QACrB,sBAAsB,EAAE,IAAI;KAC7B,CAAC,CAAC;IAEH,IAAI,QAAQ,KAAK,SAAS,EAAE,CAAC;QAC3B,MAAM,IAAI,cAAc,CACtB,OAAO;YACL,YAAY,IAAI,CAAC,MAAM,CAAC,aAAa,IAAI,CAAC,QAAQ,CAAC,iBAAiB,QAAQ,CAAC,IAAI,cAAc,IAAI,CAAC,QAAQ,CAAC,QAAQ,CAAC,SAAS,IAAI,CAAC,QAAQ,CAAC,MAAM,CAAC,GAAG,EACzJ,MAAM,EACN,QAAQ,CACT,CAAC;IACJ,CAAC;AACH,CAAC"}

package/dist/assert/object-matches/object-matches.assert.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"object-matches.assert.d.ts","sourceRoot":"","sources":["../../../src/assert/object-matches/object-matches.assert.ts"],"names":[],"mappings":"AAGA,KAAK,YAAY,GAAG,CAAC,GAAG,UAAU,EAAE,KAAK,EAAE,KAAK,OAAO,CAAC;AAExD,KAAK,eAAe,GAChB,YAAY,GACZ,IAAI,GACJ,MAAM,GACN,GAAG,CAAC,OAAO,EAAE,OAAO,CAAC,GACrB,GAAG,CAAC,OAAO,CAAC,GACZ,OAAO,CAAC,MAAM,EAAE,OAAO,CAAC,GACxB,OAAO,CAAC,MAAM,CAAC,GACf,OAAO,CAAC,OAAO,CAAC,CAAC;AAErB,KAAK,eAAe,CAAC,CAAC,IAAI,CAAC,SAAS,eAAe,GAC/C,CAAC,GACD,CAAC,SAAS,SAAS,OAAO,EAAE,GAC1B;IAAE,QAAQ,EAAE,CAAC,IAAI,MAAM,CAAC,GAAG,eAAe,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;CAAE,GAClD,CAAC,SAAS,MAAM,GACd;KAAG,CAAC,IAAI,MAAM,CAAC,GAAG,eAAe,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;CAAE,GACzC,CAAC,CAAC;AAEV;;;;;;;GAOG;AACH,wBAAgB,mBAAmB,CACjC,OAAO,EACP,KAAK,CAAC,SAAS,SAAS,MAAM,CAAC,WAAW,EAAE,OAAO,CAAC,EAEpD,MAAM,EAAE,OAAO,EACf,QAAQ,EAAE,SAAS,EACnB,OAAO,CAAC,EAAE,MAAM,GACf,OAAO,CAAC,MAAM,IAAI,OAAO,GAAG,eAAe,CAAC,SAAS,CAAC,CAWxD"}
+{"version":3,"file":"object-matches.assert.d.ts","sourceRoot":"","sources":["../../../src/assert/object-matches/object-matches.assert.ts"],"names":[],"mappings":"AAIA,KAAK,YAAY,GAAG,CAAC,GAAG,UAAU,EAAE,KAAK,EAAE,KAAK,OAAO,CAAC;AAExD,KAAK,eAAe,GAChB,YAAY,GACZ,IAAI,GACJ,MAAM,GACN,GAAG,CAAC,OAAO,EAAE,OAAO,CAAC,GACrB,GAAG,CAAC,OAAO,CAAC,GACZ,OAAO,CAAC,MAAM,EAAE,OAAO,CAAC,GACxB,OAAO,CAAC,MAAM,CAAC,GACf,OAAO,CAAC,OAAO,CAAC,CAAC;AAErB,KAAK,eAAe,CAAC,CAAC,IAAI,CAAC,SAAS,eAAe,GAC/C,CAAC,GACD,CAAC,SAAS,SAAS,OAAO,EAAE,GAC1B;IAAE,QAAQ,EAAE,CAAC,IAAI,MAAM,CAAC,GAAG,eAAe,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;CAAE,GAClD,CAAC,SAAS,MAAM,GACd;KAAG,CAAC,IAAI,MAAM,CAAC,GAAG,eAAe,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;CAAE,GACzC,CAAC,CAAC;AAEV;;;;;;;GAOG;AACH,wBAAgB,mBAAmB,CACjC,OAAO,EACP,KAAK,CAAC,SAAS,SAAS,MAAM,CAAC,WAAW,EAAE,OAAO,CAAC,EAEpD,MAAM,EAAE,OAAO,EACf,QAAQ,EAAE,SAAS,EACnB,OAAO,CAAC,EAAE,MAAM,GACf,OAAO,CAAC,MAAM,IAAI,OAAO,GAAG,eAAe,CAAC,SAAS,CAAC,CAcxD"}

package/dist/assert/object-matches/object-matches.assert.js

@@ -1,5 +1,6 @@
 import { AssertionError } from "../../assertion-error.js";
 import { desc, repr } from "../../describe/describe.js";
+import { findObjectComparisonMismatch } from "../../compare/object-comparison.js";
 /**
  * Assert that an object matches a partial deep object structure, with
  * type-narrowing.
@@ -9,89 +10,13 @@ import { desc, repr } from "../../describe/describe.js";
  * non-plain objects are compared using Object.is.
  */
 export function assertObjectMatches(actual, expected, message) {
-    const mismatch = findMismatch(actual, expected, "$");
+    const mismatch = findObjectComparisonMismatch(actual, expected, {
+        exactObjectKeys: false,
+        plainActualObjectsOnly: false,
+    });
     if (mismatch !== undefined) {
         throw new AssertionError(message ??
             `Expected ${desc(actual)} to match ${desc(expected)}. Mismatch at ${mismatch.path}: expected ${repr(mismatch.expected)}, got ${repr(mismatch.actual)}.`, actual, expected);
     }
 }
-function findMismatch(actual, expected, path) {
-    if (Array.isArray(expected)) {
-        return findArrayMismatch(actual, expected, path);
-    }
-    if (isPlainObject(expected)) {
-        return findObjectMismatch(actual, expected, path);
-    }
-    if (!Object.is(actual, expected)) {
-        return {
-            path,
-            actual,
-            expected,
-        };
-    }
-    return undefined;
-}
-function findArrayMismatch(actual, expected, path) {
-    if (!Array.isArray(actual)) {
-        return {
-            path,
-            actual,
-            expected,
-        };
-    }
-    if (actual.length !== expected.length) {
-        return {
-            path: `${path}.length`,
-            actual: actual.length,
-            expected: expected.length,
-        };
-    }
-    for (const [index, expectedElement] of expected.entries()) {
-        const mismatch = findMismatch(actual[index], expectedElement, `${path}[${String(index)}]`);
-        if (mismatch !== undefined) {
-            return mismatch;
-        }
-    }
-    return undefined;
-}
-function findObjectMismatch(actual, expected, path) {
-    if (actual === null || typeof actual !== "object" || Array.isArray(actual)) {
-        return {
-            path,
-            actual,
-            expected,
-        };
-    }
-    const actualObject = actual;
-    for (const key of Reflect.ownKeys(expected)) {
-        if (!Object.hasOwn(actualObject, key)) {
-            return {
-                path: formatPath(path, key),
-                actual: undefined,
-                expected: expected[key],
-            };
-        }
-        const mismatch = findMismatch(actualObject[key], expected[key], formatPath(path, key));
-        if (mismatch !== undefined) {
-            return mismatch;
-        }
-    }
-    return undefined;
-}
-function isPlainObject(value) {
-    if (value === null || typeof value !== "object") {
-        return false;
-    }
-    const prototype = Object.getPrototypeOf(value);
-    return prototype === Object.prototype || prototype === null;
-}
-function formatPath(parent, key) {
-    if (typeof key === "string" && /^[$A-Z_a-z][\w$]*$/.test(key)) {
-        return `${parent}.${key}`;
-    }
-    if (typeof key === "symbol") {
-        return `${parent}[${key.toString()}]`;
-    }
-    return `${parent}[${repr(key)}]`;
-}
 //# sourceMappingURL=object-matches.assert.js.map

package/dist/assert/object-matches/object-matches.assert.js.map

@@ -1 +1 @@
-{"version":3,"file":"object-matches.assert.js","sourceRoot":"","sources":["../../../src/assert/object-matches/object-matches.assert.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,cAAc,EAAE,MAAM,0BAA0B,CAAC;AAC1D,OAAO,EAAE,IAAI,EAAE,IAAI,EAAE,MAAM,4BAA4B,CAAC;AAsBxD;;;;;;;GAOG;AACH,MAAM,UAAU,mBAAmB,CAIjC,MAAe,EACf,QAAmB,EACnB,OAAgB;IAEhB,MAAM,QAAQ,GAAG,YAAY,CAAC,MAAM,EAAE,QAAQ,EAAE,GAAG,CAAC,CAAC;IAErD,IAAI,QAAQ,KAAK,SAAS,EAAE,CAAC;QAC3B,MAAM,IAAI,cAAc,CACtB,OAAO;YACL,YAAY,IAAI,CAAC,MAAM,CAAC,aAAa,IAAI,CAAC,QAAQ,CAAC,iBAAiB,QAAQ,CAAC,IAAI,cAAc,IAAI,CAAC,QAAQ,CAAC,QAAQ,CAAC,SAAS,IAAI,CAAC,QAAQ,CAAC,MAAM,CAAC,GAAG,EACzJ,MAAM,EACN,QAAQ,CACT,CAAC;IACJ,CAAC;AACH,CAAC;AAQD,SAAS,YAAY,CACnB,MAAe,EACf,QAAiB,EACjB,IAAY;IAEZ,IAAI,KAAK,CAAC,OAAO,CAAC,QAAQ,CAAC,EAAE,CAAC;QAC5B,OAAO,iBAAiB,CAAC,MAAM,EAAE,QAAQ,EAAE,IAAI,CAAC,CAAC;IACnD,CAAC;IAED,IAAI,aAAa,CAAC,QAAQ,CAAC,EAAE,CAAC;QAC5B,OAAO,kBAAkB,CAAC,MAAM,EAAE,QAAQ,EAAE,IAAI,CAAC,CAAC;IACpD,CAAC;IAED,IAAI,CAAC,MAAM,CAAC,EAAE,CAAC,MAAM,EAAE,QAAQ,CAAC,EAAE,CAAC;QACjC,OAAO;YACL,IAAI;YACJ,MAAM;YACN,QAAQ;SACT,CAAC;IACJ,CAAC;IAED,OAAO,SAAS,CAAC;AACnB,CAAC;AAED,SAAS,iBAAiB,CACxB,MAAe,EACf,QAA4B,EAC5B,IAAY;IAEZ,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,MAAM,CAAC,EAAE,CAAC;QAC3B,OAAO;YACL,IAAI;YACJ,MAAM;YACN,QAAQ;SACT,CAAC;IACJ,CAAC;IAED,IAAI,MAAM,CAAC,MAAM,KAAK,QAAQ,CAAC,MAAM,EAAE,CAAC;QACtC,OAAO;YACL,IAAI,EAAE,GAAG,IAAI,SAAS;YACtB,MAAM,EAAE,MAAM,CAAC,MAAM;YACrB,QAAQ,EAAE,QAAQ,CAAC,MAAM;SAC1B,CAAC;IACJ,CAAC;IAED,KAAK,MAAM,CAAC,KAAK,EAAE,eAAe,CAAC,IAAI,QAAQ,CAAC,OAAO,EAAE,EAAE,CAAC;QAC1D,MAAM,QAAQ,GAAG,YAAY,CAC3B,MAAM,CAAC,KAAK,CAAC,EACb,eAAe,EACf,GAAG,IAAI,IAAI,MAAM,CAAC,KAAK,CAAC,GAAG,CAC5B,CAAC;QAEF,IAAI,QAAQ,KAAK,SAAS,EAAE,CAAC;YAC3B,OAAO,QAAQ,CAAC;QAClB,CAAC;IACH,CAAC;IAED,OAAO,SAAS,CAAC;AACnB,CAAC;AAED,SAAS,kBAAkB,CACzB,MAAe,EACf,QAAsC,EACtC,IAAY;IAEZ,IAAI,MAAM,KAAK,IAAI,IAAI,OAAO,MAAM,KAAK,QAAQ,IAAI,KAAK,CAAC,OAAO,CAAC,MAAM,CAAC,EAAE,CAAC;QAC3E,OAAO;YACL,IAAI;YACJ,MAAM;YACN,QAAQ;SACT,CAAC;IACJ,CAAC;IAED,MAAM,YAAY,GAAG,MAAsC,CAAC;IAE5D,KAAK,MAAM,GAAG,IAAI,OAAO,CAAC,OAAO,CAAC,QAAQ,CAAC,EAAE,CAAC;QAC5C,IAAI,CAAC,MAAM,CAAC,MAAM,CAAC,YAAY,EAAE,GAAG,CAAC,EAAE,CAAC;YACtC,OAAO;gBACL,IAAI,EAAE,UAAU,CAAC,IAAI,EAAE,GAAG,CAAC;gBAC3B,MAAM,EAAE,SAAS;gBACjB,QAAQ,EAAE,QAAQ,CAAC,GAAG,CAAC;aACxB,CAAC;QACJ,CAAC;QAED,MAAM,QAAQ,GAAG,YAAY,CAC3B,YAAY,CAAC,GAAG,CAAC,EACjB,QAAQ,CAAC,GAAG,CAAC,EACb,UAAU,CAAC,IAAI,EAAE,GAAG,CAAC,CACtB,CAAC;QAEF,IAAI,QAAQ,KAAK,SAAS,EAAE,CAAC;YAC3B,OAAO,QAAQ,CAAC;QAClB,CAAC;IACH,CAAC;IAED,OAAO,SAAS,CAAC;AACnB,CAAC;AAED,SAAS,aAAa,CAAC,KAAc;IACnC,IAAI,KAAK,KAAK,IAAI,IAAI,OAAO,KAAK,KAAK,QAAQ,EAAE,CAAC;QAChD,OAAO,KAAK,CAAC;IACf,CAAC;IAED,MAAM,SAAS,GAAkB,MAAM,CAAC,cAAc,CAAC,KAAK,CAEpD,CAAC;IAET,OAAO,SAAS,KAAK,MAAM,CAAC,SAAS,IAAI,SAAS,KAAK,IAAI,CAAC;AAC9D,CAAC;AAED,SAAS,UAAU,CAAC,MAAc,EAAE,GAAgB;IAClD,IAAI,OAAO,GAAG,KAAK,QAAQ,IAAI,oBAAoB,CAAC,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC;QAC9D,OAAO,GAAG,MAAM,IAAI,GAAG,EAAE,CAAC;IAC5B,CAAC;IAED,IAAI,OAAO,GAAG,KAAK,QAAQ,EAAE,CAAC;QAC5B,OAAO,GAAG,MAAM,IAAI,GAAG,CAAC,QAAQ,EAAE,GAAG,CAAC;IACxC,CAAC;IAED,OAAO,GAAG,MAAM,IAAI,IAAI,CAAC,GAAG,CAAC,GAAG,CAAC;AACnC,CAAC"}
+{"version":3,"file":"object-matches.assert.js","sourceRoot":"","sources":["../../../src/assert/object-matches/object-matches.assert.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,cAAc,EAAE,MAAM,0BAA0B,CAAC;AAC1D,OAAO,EAAE,IAAI,EAAE,IAAI,EAAE,MAAM,4BAA4B,CAAC;AACxD,OAAO,EAAE,4BAA4B,EAAE,MAAM,oCAAoC,CAAC;AAsBlF;;;;;;;GAOG;AACH,MAAM,UAAU,mBAAmB,CAIjC,MAAe,EACf,QAAmB,EACnB,OAAgB;IAEhB,MAAM,QAAQ,GAAG,4BAA4B,CAAC,MAAM,EAAE,QAAQ,EAAE;QAC9D,eAAe,EAAE,KAAK;QACtB,sBAAsB,EAAE,KAAK;KAC9B,CAAC,CAAC;IAEH,IAAI,QAAQ,KAAK,SAAS,EAAE,CAAC;QAC3B,MAAM,IAAI,cAAc,CACtB,OAAO;YACL,YAAY,IAAI,CAAC,MAAM,CAAC,aAAa,IAAI,CAAC,QAAQ,CAAC,iBAAiB,QAAQ,CAAC,IAAI,cAAc,IAAI,CAAC,QAAQ,CAAC,QAAQ,CAAC,SAAS,IAAI,CAAC,QAAQ,CAAC,MAAM,CAAC,GAAG,EACzJ,MAAM,EACN,QAAQ,CACT,CAAC;IACJ,CAAC;AACH,CAAC"}

package/dist/assert/undefined/undefined.assert.d.ts

@@ -0,0 +1,6 @@
+/**
+ * Assert that a value is strictly undefined, with type-narrowing to the
+ * `undefined` type.
+ */
+export declare function assertUndefined(value: unknown, message?: string): asserts value is undefined;
+//# sourceMappingURL=undefined.assert.d.ts.map

package/dist/assert/undefined/undefined.assert.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"undefined.assert.d.ts","sourceRoot":"","sources":["../../../src/assert/undefined/undefined.assert.ts"],"names":[],"mappings":"AAGA;;;GAGG;AACH,wBAAgB,eAAe,CAC7B,KAAK,EAAE,OAAO,EACd,OAAO,SAA6C,GACnD,OAAO,CAAC,KAAK,IAAI,SAAS,CAI5B"}

package/dist/assert/undefined/undefined.assert.js

@@ -0,0 +1,12 @@
+import { AssertionError } from "../../assertion-error.js";
+import { desc } from "../../describe/describe.js";
+/**
+ * Assert that a value is strictly undefined, with type-narrowing to the
+ * `undefined` type.
+ */
+export function assertUndefined(value, message = `Expected ${desc(value)} to be undefined.`) {
+    if (value !== undefined) {
+        throw new AssertionError(message, value, undefined);
+    }
+}
+//# sourceMappingURL=undefined.assert.js.map

package/dist/assert/undefined/undefined.assert.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"undefined.assert.js","sourceRoot":"","sources":["../../../src/assert/undefined/undefined.assert.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,cAAc,EAAE,MAAM,0BAA0B,CAAC;AAC1D,OAAO,EAAE,IAAI,EAAE,MAAM,4BAA4B,CAAC;AAElD;;;GAGG;AACH,MAAM,UAAU,eAAe,CAC7B,KAAc,EACd,OAAO,GAAG,YAAY,IAAI,CAAC,KAAK,CAAC,mBAAmB;IAEpD,IAAI,KAAK,KAAK,SAAS,EAAE,CAAC;QACxB,MAAM,IAAI,cAAc,CAAC,OAAO,EAAE,KAAK,EAAE,SAAS,CAAC,CAAC;IACtD,CAAC;AACH,CAAC"}

package/dist/compare/object-comparison.d.ts

@@ -0,0 +1,15 @@
+export interface ObjectComparisonMismatch {
+    path: string;
+    actual: unknown;
+    expected: unknown;
+}
+interface ObjectComparisonOptions {
+    exactObjectKeys: boolean;
+    plainActualObjectsOnly: boolean;
+}
+/**
+ * Find a mismatch between two objects, if any.
+ */
+export declare function findObjectComparisonMismatch(actual: unknown, expected: unknown, options: ObjectComparisonOptions, path?: string): ObjectComparisonMismatch | undefined;
+export {};
+//# sourceMappingURL=object-comparison.d.ts.map

package/dist/compare/object-comparison.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"object-comparison.d.ts","sourceRoot":"","sources":["../../src/compare/object-comparison.ts"],"names":[],"mappings":"AAEA,MAAM,WAAW,wBAAwB;IACvC,IAAI,EAAE,MAAM,CAAC;IACb,MAAM,EAAE,OAAO,CAAC;IAChB,QAAQ,EAAE,OAAO,CAAC;CACnB;AAED,UAAU,uBAAuB;IAC/B,eAAe,EAAE,OAAO,CAAC;IACzB,sBAAsB,EAAE,OAAO,CAAC;CACjC;AAED;;GAEG;AACH,wBAAgB,4BAA4B,CAC1C,MAAM,EAAE,OAAO,EACf,QAAQ,EAAE,OAAO,EACjB,OAAO,EAAE,uBAAuB,EAChC,IAAI,SAAM,GACT,wBAAwB,GAAG,SAAS,CAkBtC"}

package/dist/compare/object-comparison.js

@@ -0,0 +1,99 @@
+import { repr } from "../describe/describe.js";
+/**
+ * Find a mismatch between two objects, if any.
+ */
+export function findObjectComparisonMismatch(actual, expected, options, path = "$") {
+    if (Array.isArray(expected)) {
+        return findArrayMismatch(actual, expected, options, path);
+    }
+    if (isPlainObject(expected)) {
+        return findObjectMismatch(actual, expected, options, path);
+    }
+    if (!Object.is(actual, expected)) {
+        return {
+            path,
+            actual,
+            expected,
+        };
+    }
+    return undefined;
+}
+function findArrayMismatch(actual, expected, options, path) {
+    if (!Array.isArray(actual)) {
+        return {
+            path,
+            actual,
+            expected,
+        };
+    }
+    if (actual.length !== expected.length) {
+        return {
+            path: `${path}.length`,
+            actual: actual.length,
+            expected: expected.length,
+        };
+    }
+    for (const [index, expectedElement] of expected.entries()) {
+        const mismatch = findObjectComparisonMismatch(actual[index], expectedElement, options, `${path}[${String(index)}]`);
+        if (mismatch !== undefined) {
+            return mismatch;
+        }
+    }
+    return undefined;
+}
+function findObjectMismatch(actual, expected, options, path) {
+    if (!isComparableObject(actual, options)) {
+        return {
+            path,
+            actual,
+            expected,
+        };
+    }
+    const actualObject = actual;
+    const expectedKeys = Reflect.ownKeys(expected);
+    if (options.exactObjectKeys &&
+        Reflect.ownKeys(actualObject).length !== expectedKeys.length) {
+        return {
+            path,
+            actual,
+            expected,
+        };
+    }
+    for (const key of expectedKeys) {
+        if (!Object.hasOwn(actualObject, key)) {
+            return {
+                path: formatPath(path, key),
+                actual: undefined,
+                expected: expected[key],
+            };
+        }
+        const mismatch = findObjectComparisonMismatch(actualObject[key], expected[key], options, formatPath(path, key));
+        if (mismatch !== undefined) {
+            return mismatch;
+        }
+    }
+    return undefined;
+}
+function isComparableObject(value, options) {
+    if (value === null || typeof value !== "object" || Array.isArray(value)) {
+        return false;
+    }
+    return !options.plainActualObjectsOnly || isPlainObject(value);
+}
+function isPlainObject(value) {
+    if (value === null || typeof value !== "object") {
+        return false;
+    }
+    const prototype = Object.getPrototypeOf(value);
+    return prototype === Object.prototype || prototype === null;
+}
+function formatPath(parent, key) {
+    if (typeof key === "string" && /^[$A-Z_a-z][\w$]*$/.test(key)) {
+        return `${parent}.${key}`;
+    }
+    if (typeof key === "symbol") {
+        return `${parent}[${key.toString()}]`;
+    }
+    return `${parent}[${repr(key)}]`;
+}
+//# sourceMappingURL=object-comparison.js.map

package/dist/compare/object-comparison.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"object-comparison.js","sourceRoot":"","sources":["../../src/compare/object-comparison.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,IAAI,EAAE,MAAM,yBAAyB,CAAC;AAa/C;;GAEG;AACH,MAAM,UAAU,4BAA4B,CAC1C,MAAe,EACf,QAAiB,EACjB,OAAgC,EAChC,IAAI,GAAG,GAAG;IAEV,IAAI,KAAK,CAAC,OAAO,CAAC,QAAQ,CAAC,EAAE,CAAC;QAC5B,OAAO,iBAAiB,CAAC,MAAM,EAAE,QAAQ,EAAE,OAAO,EAAE,IAAI,CAAC,CAAC;IAC5D,CAAC;IAED,IAAI,aAAa,CAAC,QAAQ,CAAC,EAAE,CAAC;QAC5B,OAAO,kBAAkB,CAAC,MAAM,EAAE,QAAQ,EAAE,OAAO,EAAE,IAAI,CAAC,CAAC;IAC7D,CAAC;IAED,IAAI,CAAC,MAAM,CAAC,EAAE,CAAC,MAAM,EAAE,QAAQ,CAAC,EAAE,CAAC;QACjC,OAAO;YACL,IAAI;YACJ,MAAM;YACN,QAAQ;SACT,CAAC;IACJ,CAAC;IAED,OAAO,SAAS,CAAC;AACnB,CAAC;AAED,SAAS,iBAAiB,CACxB,MAAe,EACf,QAA4B,EAC5B,OAAgC,EAChC,IAAY;IAEZ,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,MAAM,CAAC,EAAE,CAAC;QAC3B,OAAO;YACL,IAAI;YACJ,MAAM;YACN,QAAQ;SACT,CAAC;IACJ,CAAC;IAED,IAAI,MAAM,CAAC,MAAM,KAAK,QAAQ,CAAC,MAAM,EAAE,CAAC;QACtC,OAAO;YACL,IAAI,EAAE,GAAG,IAAI,SAAS;YACtB,MAAM,EAAE,MAAM,CAAC,MAAM;YACrB,QAAQ,EAAE,QAAQ,CAAC,MAAM;SAC1B,CAAC;IACJ,CAAC;IAED,KAAK,MAAM,CAAC,KAAK,EAAE,eAAe,CAAC,IAAI,QAAQ,CAAC,OAAO,EAAE,EAAE,CAAC;QAC1D,MAAM,QAAQ,GAAG,4BAA4B,CAC3C,MAAM,CAAC,KAAK,CAAC,EACb,eAAe,EACf,OAAO,EACP,GAAG,IAAI,IAAI,MAAM,CAAC,KAAK,CAAC,GAAG,CAC5B,CAAC;QAEF,IAAI,QAAQ,KAAK,SAAS,EAAE,CAAC;YAC3B,OAAO,QAAQ,CAAC;QAClB,CAAC;IACH,CAAC;IAED,OAAO,SAAS,CAAC;AACnB,CAAC;AAED,SAAS,kBAAkB,CACzB,MAAe,EACf,QAAsC,EACtC,OAAgC,EAChC,IAAY;IAEZ,IAAI,CAAC,kBAAkB,CAAC,MAAM,EAAE,OAAO,CAAC,EAAE,CAAC;QACzC,OAAO;YACL,IAAI;YACJ,MAAM;YACN,QAAQ;SACT,CAAC;IACJ,CAAC;IAED,MAAM,YAAY,GAAG,MAAM,CAAC;IAC5B,MAAM,YAAY,GAAG,OAAO,CAAC,OAAO,CAAC,QAAQ,CAAC,CAAC;IAE/C,IACE,OAAO,CAAC,eAAe;QACvB,OAAO,CAAC,OAAO,CAAC,YAAY,CAAC,CAAC,MAAM,KAAK,YAAY,CAAC,MAAM,EAC5D,CAAC;QACD,OAAO;YACL,IAAI;YACJ,MAAM;YACN,QAAQ;SACT,CAAC;IACJ,CAAC;IAED,KAAK,MAAM,GAAG,IAAI,YAAY,EAAE,CAAC;QAC/B,IAAI,CAAC,MAAM,CAAC,MAAM,CAAC,YAAY,EAAE,GAAG,CAAC,EAAE,CAAC;YACtC,OAAO;gBACL,IAAI,EAAE,UAAU,CAAC,IAAI,EAAE,GAAG,CAAC;gBAC3B,MAAM,EAAE,SAAS;gBACjB,QAAQ,EAAE,QAAQ,CAAC,GAAG,CAAC;aACxB,CAAC;QACJ,CAAC;QAED,MAAM,QAAQ,GAAG,4BAA4B,CAC3C,YAAY,CAAC,GAAG,CAAC,EACjB,QAAQ,CAAC,GAAG,CAAC,EACb,OAAO,EACP,UAAU,CAAC,IAAI,EAAE,GAAG,CAAC,CACtB,CAAC;QAEF,IAAI,QAAQ,KAAK,SAAS,EAAE,CAAC;YAC3B,OAAO,QAAQ,CAAC;QAClB,CAAC;IACH,CAAC;IAED,OAAO,SAAS,CAAC;AACnB,CAAC;AAED,SAAS,kBAAkB,CACzB,KAAc,EACd,OAAgC;IAEhC,IAAI,KAAK,KAAK,IAAI,IAAI,OAAO,KAAK,KAAK,QAAQ,IAAI,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,EAAE,CAAC;QACxE,OAAO,KAAK,CAAC;IACf,CAAC;IAED,OAAO,CAAC,OAAO,CAAC,sBAAsB,IAAI,aAAa,CAAC,KAAK,CAAC,CAAC;AACjE,CAAC;AAED,SAAS,aAAa,CAAC,KAAc;IACnC,IAAI,KAAK,KAAK,IAAI,IAAI,OAAO,KAAK,KAAK,QAAQ,EAAE,CAAC;QAChD,OAAO,KAAK,CAAC;IACf,CAAC;IAED,MAAM,SAAS,GAAkB,MAAM,CAAC,cAAc,CAAC,KAAK,CAEpD,CAAC;IAET,OAAO,SAAS,KAAK,MAAM,CAAC,SAAS,IAAI,SAAS,KAAK,IAAI,CAAC;AAC9D,CAAC;AAED,SAAS,UAAU,CAAC,MAAc,EAAE,GAAgB;IAClD,IAAI,OAAO,GAAG,KAAK,QAAQ,IAAI,oBAAoB,CAAC,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC;QAC9D,OAAO,GAAG,MAAM,IAAI,GAAG,EAAE,CAAC;IAC5B,CAAC;IAED,IAAI,OAAO,GAAG,KAAK,QAAQ,EAAE,CAAC;QAC5B,OAAO,GAAG,MAAM,IAAI,GAAG,CAAC,QAAQ,EAAE,GAAG,CAAC;IACxC,CAAC;IAED,OAAO,GAAG,MAAM,IAAI,IAAI,CAAC,GAAG,CAAC,GAAG,CAAC;AACnC,CAAC"}

package/dist/index.d.ts

@@ -11,6 +11,7 @@ export * from "./assert/instance-of/instance-of.assert.js";
 export * from "./assert/non-nullable/non-nullable.assert.js";
 export * from "./assert/number-between/number-between.assert.js";
 export * from "./assert/number-to-nearest/number-to-nearest.assert.js";
+export * from "./assert/object-equals/object-equals.assert.js";
 export * from "./assert/object-matches/object-matches.assert.js";
 export * from "./assert/one-of/one-of.assert.js";
 export * from "./assert/string-ends-with/string-ends-with.assert.js";
@@ -28,5 +29,6 @@ export * from "./assert/type-numeric/type-numeric.assert.js";
 export * from "./assert/type-object/type-object.assert.js";
 export * from "./assert/type-string/type-string.assert.js";
 export * from "./assert/type-typed-array/type-typed-array.assert.js";
+export * from "./assert/undefined/undefined.assert.js";
 export * from "./assert/uuid/uuid-v4.assert.js";
 //# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,cAAc,8CAA8C,CAAC;AAC7D,cAAc,0DAA0D,CAAC;AACzE,cAAc,kDAAkD,CAAC;AACjE,cAAc,8CAA8C,CAAC;AAC7D,cAAc,sDAAsD,CAAC;AACrE,cAAc,oDAAoD,CAAC;AACnE,cAAc,8CAA8C,CAAC;AAC7D,cAAc,gCAAgC,CAAC;AAC/C,cAAc,wCAAwC,CAAC;AACvD,cAAc,4CAA4C,CAAC;AAC3D,cAAc,8CAA8C,CAAC;AAC7D,cAAc,kDAAkD,CAAC;AACjE,cAAc,wDAAwD,CAAC;AACvE,cAAc,kDAAkD,CAAC;AACjE,cAAc,kCAAkC,CAAC;AACjD,cAAc,sDAAsD,CAAC;AACrE,cAAc,oDAAoD,CAAC;AACnE,cAAc,4DAA4D,CAAC;AAC3E,cAAc,0DAA0D,CAAC;AACzE,cAAc,0DAA0D,CAAC;AACzE,cAAc,8CAA8C,CAAC;AAC7D,cAAc,8BAA8B,CAAC;AAC7C,cAAc,4CAA4C,CAAC;AAC3D,cAAc,8CAA8C,CAAC;AAC7D,cAAc,gDAAgD,CAAC;AAC/D,cAAc,4CAA4C,CAAC;AAC3D,cAAc,8CAA8C,CAAC;AAC7D,cAAc,4CAA4C,CAAC;AAC3D,cAAc,4CAA4C,CAAC;AAC3D,cAAc,sDAAsD,CAAC;AACrE,cAAc,iCAAiC,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,cAAc,8CAA8C,CAAC;AAC7D,cAAc,0DAA0D,CAAC;AACzE,cAAc,kDAAkD,CAAC;AACjE,cAAc,8CAA8C,CAAC;AAC7D,cAAc,sDAAsD,CAAC;AACrE,cAAc,oDAAoD,CAAC;AACnE,cAAc,8CAA8C,CAAC;AAC7D,cAAc,gCAAgC,CAAC;AAC/C,cAAc,wCAAwC,CAAC;AACvD,cAAc,4CAA4C,CAAC;AAC3D,cAAc,8CAA8C,CAAC;AAC7D,cAAc,kDAAkD,CAAC;AACjE,cAAc,wDAAwD,CAAC;AACvE,cAAc,gDAAgD,CAAC;AAC/D,cAAc,kDAAkD,CAAC;AACjE,cAAc,kCAAkC,CAAC;AACjD,cAAc,sDAAsD,CAAC;AACrE,cAAc,oDAAoD,CAAC;AACnE,cAAc,4DAA4D,CAAC;AAC3E,cAAc,0DAA0D,CAAC;AACzE,cAAc,0DAA0D,CAAC;AACzE,cAAc,8CAA8C,CAAC;AAC7D,cAAc,8BAA8B,CAAC;AAC7C,cAAc,4CAA4C,CAAC;AAC3D,cAAc,8CAA8C,CAAC;AAC7D,cAAc,gDAAgD,CAAC;AAC/D,cAAc,4CAA4C,CAAC;AAC3D,cAAc,8CAA8C,CAAC;AAC7D,cAAc,4CAA4C,CAAC;AAC3D,cAAc,4CAA4C,CAAC;AAC3D,cAAc,sDAAsD,CAAC;AACrE,cAAc,wCAAwC,CAAC;AACvD,cAAc,iCAAiC,CAAC"}

package/dist/index.js

@@ -11,6 +11,7 @@ export * from "./assert/instance-of/instance-of.assert.js";
 export * from "./assert/non-nullable/non-nullable.assert.js";
 export * from "./assert/number-between/number-between.assert.js";
 export * from "./assert/number-to-nearest/number-to-nearest.assert.js";
+export * from "./assert/object-equals/object-equals.assert.js";
 export * from "./assert/object-matches/object-matches.assert.js";
 export * from "./assert/one-of/one-of.assert.js";
 export * from "./assert/string-ends-with/string-ends-with.assert.js";
@@ -28,5 +29,6 @@ export * from "./assert/type-numeric/type-numeric.assert.js";
 export * from "./assert/type-object/type-object.assert.js";
 export * from "./assert/type-string/type-string.assert.js";
 export * from "./assert/type-typed-array/type-typed-array.assert.js";
+export * from "./assert/undefined/undefined.assert.js";
 export * from "./assert/uuid/uuid-v4.assert.js";
 //# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,cAAc,8CAA8C,CAAC;AAC7D,cAAc,0DAA0D,CAAC;AACzE,cAAc,kDAAkD,CAAC;AACjE,cAAc,8CAA8C,CAAC;AAC7D,cAAc,sDAAsD,CAAC;AACrE,cAAc,oDAAoD,CAAC;AACnE,cAAc,8CAA8C,CAAC;AAC7D,cAAc,gCAAgC,CAAC;AAC/C,cAAc,wCAAwC,CAAC;AACvD,cAAc,4CAA4C,CAAC;AAC3D,cAAc,8CAA8C,CAAC;AAC7D,cAAc,kDAAkD,CAAC;AACjE,cAAc,wDAAwD,CAAC;AACvE,cAAc,kDAAkD,CAAC;AACjE,cAAc,kCAAkC,CAAC;AACjD,cAAc,sDAAsD,CAAC;AACrE,cAAc,oDAAoD,CAAC;AACnE,cAAc,4DAA4D,CAAC;AAC3E,cAAc,0DAA0D,CAAC;AACzE,cAAc,0DAA0D,CAAC;AACzE,cAAc,8CAA8C,CAAC;AAC7D,cAAc,8BAA8B,CAAC;AAC7C,cAAc,4CAA4C,CAAC;AAC3D,cAAc,8CAA8C,CAAC;AAC7D,cAAc,gDAAgD,CAAC;AAC/D,cAAc,4CAA4C,CAAC;AAC3D,cAAc,8CAA8C,CAAC;AAC7D,cAAc,4CAA4C,CAAC;AAC3D,cAAc,4CAA4C,CAAC;AAC3D,cAAc,sDAAsD,CAAC;AACrE,cAAc,iCAAiC,CAAC"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,cAAc,8CAA8C,CAAC;AAC7D,cAAc,0DAA0D,CAAC;AACzE,cAAc,kDAAkD,CAAC;AACjE,cAAc,8CAA8C,CAAC;AAC7D,cAAc,sDAAsD,CAAC;AACrE,cAAc,oDAAoD,CAAC;AACnE,cAAc,8CAA8C,CAAC;AAC7D,cAAc,gCAAgC,CAAC;AAC/C,cAAc,wCAAwC,CAAC;AACvD,cAAc,4CAA4C,CAAC;AAC3D,cAAc,8CAA8C,CAAC;AAC7D,cAAc,kDAAkD,CAAC;AACjE,cAAc,wDAAwD,CAAC;AACvE,cAAc,gDAAgD,CAAC;AAC/D,cAAc,kDAAkD,CAAC;AACjE,cAAc,kCAAkC,CAAC;AACjD,cAAc,sDAAsD,CAAC;AACrE,cAAc,oDAAoD,CAAC;AACnE,cAAc,4DAA4D,CAAC;AAC3E,cAAc,0DAA0D,CAAC;AACzE,cAAc,0DAA0D,CAAC;AACzE,cAAc,8CAA8C,CAAC;AAC7D,cAAc,8BAA8B,CAAC;AAC7C,cAAc,4CAA4C,CAAC;AAC3D,cAAc,8CAA8C,CAAC;AAC7D,cAAc,gDAAgD,CAAC;AAC/D,cAAc,4CAA4C,CAAC;AAC3D,cAAc,8CAA8C,CAAC;AAC7D,cAAc,4CAA4C,CAAC;AAC3D,cAAc,4CAA4C,CAAC;AAC3D,cAAc,sDAAsD,CAAC;AACrE,cAAc,wCAAwC,CAAC;AACvD,cAAc,iCAAiC,CAAC"}

package/package.json

@@ -4,7 +4,7 @@
   "author": "Kensio Software",
   "repository": "https://github.com/KensioSoftware/smartass",
   "license": "AGPL-3.0",
-  "version": "1.0.1",
+  "version": "1.1.0",
   "type": "module",
   "main": "./dist/index.js",
   "types": "./dist/index.d.ts",
@@ -24,7 +24,7 @@
   },
   "sideEffects": false,
   "engines": {
-    "node": ">=24.14.0"
+    "node": ">=24.16.0"
   },
   "keywords": [
     "test",
@@ -36,9 +36,9 @@
     "@eslint/js": "^10.0.1",
     "@types/eslint-plugin-security": "^3.0.1",
     "@types/node": "^25.9.1",
-    "@vitest/coverage-v8": "^4.1.7",
-    "@vitest/eslint-plugin": "^1.6.18",
-    "eslint": "^10.4.0",
+    "@vitest/coverage-v8": "^4.1.8",
+    "@vitest/eslint-plugin": "^1.6.19",
+    "eslint": "^10.4.1",
     "eslint-config-prettier": "^10.1.8",
     "eslint-plugin-jsdoc": "^62.9.0",
     "eslint-plugin-no-secrets": "^2.3.3",
@@ -49,7 +49,7 @@
     "prettier": "^3.8.3",
     "typescript": "^5.9.3",
     "typescript-eslint": "^8.60.0",
-    "vitest": "^4.1.7"
+    "vitest": "^4.1.8"
   },
   "scripts": {
     "build": "tsc -p tsconfig.build.json",