@rightcapital/assert 4.0.1-feature-remove-exceptions.2528.1.0 → 4.0.1-feature-assert-capture-stack-trace.2570.1.0

package/lib/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;GAkBG;AAEH;;GAEG;AACH,qBAAa,cAAe,SAAQ,KAAK;IACvC,SAAyB,IAAI,oBAAoB;CAClD;AAoBD;;;;;;;;;;;;;;;;GAgBG;AACH,wBAAgB,MAAM,CAAC,KAAK,EAAE,OAAO,EAAE,OAAO,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC,KAAK,CAItE;AAED;;;;;;;;;;;;;;;;GAgBG;AACH,wBAAgB,iBAAiB,CAAC,CAAC,EACjC,KAAK,EAAE,CAAC,EACR,OAAO,CAAC,EAAE,MAAM,GACf,OAAO,CAAC,KAAK,IAAI,WAAW,CAAC,CAAC,CAAC,CAIjC;AAED;;;;;;;;;;;;;;;;;;;;;;;;GAwBG;AACH,wBAAgB,MAAM,CAAC,CAAC,EAAE,CAAC,SAAS,CAAC,EACnC,KAAK,EAAE,CAAC,EACR,SAAS,EAAE,CAAC,KAAK,EAAE,CAAC,KAAK,KAAK,IAAI,CAAC,EACnC,OAAO,CAAC,EAAE,MAAM,GACf,CAAC,CAGH;AAED;;;;;;;;;;;;;;;;;;;GAmBG;AACH,wBAAgB,iBAAiB,CAAC,CAAC,EACjC,KAAK,EAAE,CAAC,EACR,OAAO,CAAC,EAAE,MAAM,GACf,WAAW,CAAC,CAAC,CAAC,CAKhB;AAED;;;;;;;;;;;;;;;;;;;;;GAqBG;AACH,wBAAgB,iBAAiB,CAAC,OAAO,SAA6B,GAAG,KAAK,CAE7E;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAgCG;AACH,wBAAgB,gBAAgB,CAAC,KAAK,EAAE,KAAK,EAAE,OAAO,CAAC,EAAE,MAAM,GAAG,KAAK,CAEtE;AAED;;;;;;;;;;;;;GAaG;AACH,wBAAgB,aAAa,CAAC,OAAO,SAAoB,GAAG,KAAK,CAEhE"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;GAkBG;AAEH;;GAEG;AACH,qBAAa,cAAe,SAAQ,KAAK;IACvC,SAAyB,IAAI,oBAAoB;CAClD;AA6BD;;;;;;;;;;;;;;;;GAgBG;AACH,wBAAgB,MAAM,CAAC,KAAK,EAAE,OAAO,EAAE,OAAO,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC,KAAK,CAItE;AAED;;;;;;;;;;;;;;;;GAgBG;AACH,wBAAgB,iBAAiB,CAAC,CAAC,EACjC,KAAK,EAAE,CAAC,EACR,OAAO,CAAC,EAAE,MAAM,GACf,OAAO,CAAC,KAAK,IAAI,WAAW,CAAC,CAAC,CAAC,CASjC;AAED;;;;;;;;;;;;;;;;;;;;;;;;GAwBG;AACH,wBAAgB,MAAM,CAAC,CAAC,EAAE,CAAC,SAAS,CAAC,EACnC,KAAK,EAAE,CAAC,EACR,SAAS,EAAE,CAAC,KAAK,EAAE,CAAC,KAAK,KAAK,IAAI,CAAC,EACnC,OAAO,CAAC,EAAE,MAAM,GACf,CAAC,CAKH;AAED;;;;;;;;;;;;;;;;;;;GAmBG;AACH,wBAAgB,iBAAiB,CAAC,CAAC,EACjC,KAAK,EAAE,CAAC,EACR,OAAO,CAAC,EAAE,MAAM,GACf,WAAW,CAAC,CAAC,CAAC,CAUhB;AAED;;;;;;;;;;;;;;;;;;;;;GAqBG;AACH,wBAAgB,iBAAiB,CAAC,OAAO,SAA6B,GAAG,KAAK,CAE7E;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAgCG;AACH,wBAAgB,gBAAgB,CAAC,KAAK,EAAE,KAAK,EAAE,OAAO,CAAC,EAAE,MAAM,GAAG,KAAK,CAOtE;AAED;;;;;;;;;;;;;GAaG;AACH,wBAAgB,aAAa,CAAC,OAAO,SAAoB,GAAG,KAAK,CAEhE"}

package/lib/index.js

@@ -26,14 +26,16 @@ export class AssertionError extends Error {
 /**
  * Throws an AssertionError with a message prefixed by the assertion name.
  */
-function throwError(name, message) {
-    throw new AssertionError(`${name}: ${message}`);
+function throwError(name, message, caller) {
+    const error = new AssertionError(`${name}: ${message}`);
+    Error.captureStackTrace?.(error, caller);
+    throw error;
 }
 /**
  * Throws an AssertionError for an unexpected value.
  */
-function throwUnexpectedValueError(name, value, message = `Unexpected ${String(value)}`) {
-    throwError(name, message);
+function throwUnexpectedValueError(name, value, message, caller) {
+    throwError(name, message ?? `Unexpected ${String(value)}`, caller);
 }
 /**
  * Basic assertion: verifies that a value or expression is `true`, otherwise throws an exception.
@@ -54,7 +56,7 @@ function throwUnexpectedValueError(name, value, message = `Unexpected ${String(v
  */
 export function assert(value, message) {
     if (value !== true) {
-        throwUnexpectedValueError('assert', value, message);
+        throwUnexpectedValueError('assert', value, message, assert);
     }
 }
 /**
@@ -76,7 +78,7 @@ export function assert(value, message) {
  */
 export function assertNonNullable(value, message) {
     if (value === null || value === undefined) {
-        throwUnexpectedValueError('assertNonNullable', value, message);
+        throwUnexpectedValueError('assertNonNullable', value, message, assertNonNullable);
     }
 }
 /**
@@ -105,7 +107,9 @@ export function assertNonNullable(value, message) {
  * ```
  */
 export function ensure(value, predicate, message) {
-    assert(predicate(value), message);
+    if (!predicate(value)) {
+        throwUnexpectedValueError('ensure', value, message, ensure);
+    }
     return value;
 }
 /**
@@ -130,7 +134,7 @@ export function ensure(value, predicate, message) {
  */
 export function ensureNonNullable(value, message) {
     if (value === null || value === undefined) {
-        throwUnexpectedValueError('ensureNonNullable', value, message);
+        throwUnexpectedValueError('ensureNonNullable', value, message, ensureNonNullable);
     }
     return value;
 }
@@ -157,7 +161,7 @@ export function ensureNonNullable(value, message) {
  * ```
  */
 export function assertUnreachable(message = 'Reached unreachable code') {
-    throwError('assertUnreachable', message);
+    throwError('assertUnreachable', message, assertUnreachable);
 }
 /**
  * Used for exhaustiveness checking of union types. Ensures switch or if-else statements cover all possible types.
@@ -193,7 +197,7 @@ export function assertUnreachable(message = 'Reached unreachable code') {
  * ```
  */
 export function assertExhaustive(value, message) {
-    throwUnexpectedValueError('assertExhaustive', value, message);
+    throwUnexpectedValueError('assertExhaustive', value, message, assertExhaustive);
 }
 /**
  * Marks methods or code paths that are intentionally not implemented yet.
@@ -210,6 +214,6 @@ export function assertExhaustive(value, message) {
  * ```
  */
 export function unimplemented(message = 'Not implemented') {
-    throwError('unimplemented', message);
+    throwError('unimplemented', message, unimplemented);
 }
 //# sourceMappingURL=index.js.map

package/lib/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;GAkBG;AAEH;;GAEG;AACH,MAAM,OAAO,cAAe,SAAQ,KAAK;IACd,IAAI,GAAG,gBAAgB,CAAC;CAClD;AAED;;GAEG;AACH,SAAS,UAAU,CAAC,IAAY,EAAE,OAAe;IAC/C,MAAM,IAAI,cAAc,CAAC,GAAG,IAAI,KAAK,OAAO,EAAE,CAAC,CAAC;AAClD,CAAC;AAED;;GAEG;AACH,SAAS,yBAAyB,CAChC,IAAY,EACZ,KAAc,EACd,OAAO,GAAG,cAAc,MAAM,CAAC,KAAK,CAAC,EAAE;IAEvC,UAAU,CAAC,IAAI,EAAE,OAAO,CAAC,CAAC;AAC5B,CAAC;AAED;;;;;;;;;;;;;;;;GAgBG;AACH,MAAM,UAAU,MAAM,CAAC,KAAc,EAAE,OAAgB;IACrD,IAAI,KAAK,KAAK,IAAI,EAAE,CAAC;QACnB,yBAAyB,CAAC,QAAQ,EAAE,KAAK,EAAE,OAAO,CAAC,CAAC;IACtD,CAAC;AACH,CAAC;AAED;;;;;;;;;;;;;;;;GAgBG;AACH,MAAM,UAAU,iBAAiB,CAC/B,KAAQ,EACR,OAAgB;IAEhB,IAAI,KAAK,KAAK,IAAI,IAAI,KAAK,KAAK,SAAS,EAAE,CAAC;QAC1C,yBAAyB,CAAC,mBAAmB,EAAE,KAAK,EAAE,OAAO,CAAC,CAAC;IACjE,CAAC;AACH,CAAC;AAED;;;;;;;;;;;;;;;;;;;;;;;;GAwBG;AACH,MAAM,UAAU,MAAM,CACpB,KAAQ,EACR,SAAmC,EACnC,OAAgB;IAEhB,MAAM,CAAC,SAAS,CAAC,KAAK,CAAC,EAAE,OAAO,CAAC,CAAC;IAClC,OAAO,KAAK,CAAC;AACf,CAAC;AAED;;;;;;;;;;;;;;;;;;;GAmBG;AACH,MAAM,UAAU,iBAAiB,CAC/B,KAAQ,EACR,OAAgB;IAEhB,IAAI,KAAK,KAAK,IAAI,IAAI,KAAK,KAAK,SAAS,EAAE,CAAC;QAC1C,yBAAyB,CAAC,mBAAmB,EAAE,KAAK,EAAE,OAAO,CAAC,CAAC;IACjE,CAAC;IACD,OAAO,KAAK,CAAC;AACf,CAAC;AAED;;;;;;;;;;;;;;;;;;;;;GAqBG;AACH,MAAM,UAAU,iBAAiB,CAAC,OAAO,GAAG,0BAA0B;IACpE,UAAU,CAAC,mBAAmB,EAAE,OAAO,CAAC,CAAC;AAC3C,CAAC;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAgCG;AACH,MAAM,UAAU,gBAAgB,CAAC,KAAY,EAAE,OAAgB;IAC7D,yBAAyB,CAAC,kBAAkB,EAAE,KAAK,EAAE,OAAO,CAAC,CAAC;AAChE,CAAC;AAED;;;;;;;;;;;;;GAaG;AACH,MAAM,UAAU,aAAa,CAAC,OAAO,GAAG,iBAAiB;IACvD,UAAU,CAAC,eAAe,EAAE,OAAO,CAAC,CAAC;AACvC,CAAC"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;GAkBG;AAEH;;GAEG;AACH,MAAM,OAAO,cAAe,SAAQ,KAAK;IACd,IAAI,GAAG,gBAAgB,CAAC;CAClD;AAQD;;GAEG;AACH,SAAS,UAAU,CAAC,IAAY,EAAE,OAAe,EAAE,MAAc;IAC/D,MAAM,KAAK,GAAG,IAAI,cAAc,CAAC,GAAG,IAAI,KAAK,OAAO,EAAE,CAAC,CAAC;IACvD,KAAoC,CAAC,iBAAiB,EAAE,CAAC,KAAK,EAAE,MAAM,CAAC,CAAC;IACzE,MAAM,KAAK,CAAC;AACd,CAAC;AAED;;GAEG;AACH,SAAS,yBAAyB,CAChC,IAAY,EACZ,KAAc,EACd,OAA2B,EAC3B,MAAc;IAEd,UAAU,CAAC,IAAI,EAAE,OAAO,IAAI,cAAc,MAAM,CAAC,KAAK,CAAC,EAAE,EAAE,MAAM,CAAC,CAAC;AACrE,CAAC;AAED;;;;;;;;;;;;;;;;GAgBG;AACH,MAAM,UAAU,MAAM,CAAC,KAAc,EAAE,OAAgB;IACrD,IAAI,KAAK,KAAK,IAAI,EAAE,CAAC;QACnB,yBAAyB,CAAC,QAAQ,EAAE,KAAK,EAAE,OAAO,EAAE,MAAM,CAAC,CAAC;IAC9D,CAAC;AACH,CAAC;AAED;;;;;;;;;;;;;;;;GAgBG;AACH,MAAM,UAAU,iBAAiB,CAC/B,KAAQ,EACR,OAAgB;IAEhB,IAAI,KAAK,KAAK,IAAI,IAAI,KAAK,KAAK,SAAS,EAAE,CAAC;QAC1C,yBAAyB,CACvB,mBAAmB,EACnB,KAAK,EACL,OAAO,EACP,iBAAiB,CAClB,CAAC;IACJ,CAAC;AACH,CAAC;AAED;;;;;;;;;;;;;;;;;;;;;;;;GAwBG;AACH,MAAM,UAAU,MAAM,CACpB,KAAQ,EACR,SAAmC,EACnC,OAAgB;IAEhB,IAAI,CAAC,SAAS,CAAC,KAAK,CAAC,EAAE,CAAC;QACtB,yBAAyB,CAAC,QAAQ,EAAE,KAAK,EAAE,OAAO,EAAE,MAAM,CAAC,CAAC;IAC9D,CAAC;IACD,OAAO,KAAK,CAAC;AACf,CAAC;AAED;;;;;;;;;;;;;;;;;;;GAmBG;AACH,MAAM,UAAU,iBAAiB,CAC/B,KAAQ,EACR,OAAgB;IAEhB,IAAI,KAAK,KAAK,IAAI,IAAI,KAAK,KAAK,SAAS,EAAE,CAAC;QAC1C,yBAAyB,CACvB,mBAAmB,EACnB,KAAK,EACL,OAAO,EACP,iBAAiB,CAClB,CAAC;IACJ,CAAC;IACD,OAAO,KAAK,CAAC;AACf,CAAC;AAED;;;;;;;;;;;;;;;;;;;;;GAqBG;AACH,MAAM,UAAU,iBAAiB,CAAC,OAAO,GAAG,0BAA0B;IACpE,UAAU,CAAC,mBAAmB,EAAE,OAAO,EAAE,iBAAiB,CAAC,CAAC;AAC9D,CAAC;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAgCG;AACH,MAAM,UAAU,gBAAgB,CAAC,KAAY,EAAE,OAAgB;IAC7D,yBAAyB,CACvB,kBAAkB,EAClB,KAAK,EACL,OAAO,EACP,gBAAgB,CACjB,CAAC;AACJ,CAAC;AAED;;;;;;;;;;;;;GAaG;AACH,MAAM,UAAU,aAAa,CAAC,OAAO,GAAG,iBAAiB;IACvD,UAAU,CAAC,eAAe,EAAE,OAAO,EAAE,aAAa,CAAC,CAAC;AACtD,CAAC"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@rightcapital/assert",
-  "version": "4.0.1-feature-remove-exceptions.2528.1.0",
+  "version": "4.0.1-feature-assert-capture-stack-trace.2570.1.0",
   "description": "Type-safe assertion utilities for defensive programming.",
   "keywords": [
     "assertion",

package/src/index.ts

@@ -25,11 +25,19 @@ export class AssertionError extends Error {
   public override readonly name = 'AssertionError';
 }
 
+type Caller = (...args: never[]) => unknown;
+
+interface ErrorWithCaptureStackTrace {
+  captureStackTrace?(object: object, constructor?: Caller): void;
+}
+
 /**
  * Throws an AssertionError with a message prefixed by the assertion name.
  */
-function throwError(name: string, message: string): never {
-  throw new AssertionError(`${name}: ${message}`);
+function throwError(name: string, message: string, caller: Caller): never {
+  const error = new AssertionError(`${name}: ${message}`);
+  (Error as ErrorWithCaptureStackTrace).captureStackTrace?.(error, caller);
+  throw error;
 }
 
 /**
@@ -38,9 +46,10 @@ function throwError(name: string, message: string): never {
 function throwUnexpectedValueError(
   name: string,
   value: unknown,
-  message = `Unexpected ${String(value)}`,
+  message: string | undefined,
+  caller: Caller,
 ): never {
-  throwError(name, message);
+  throwError(name, message ?? `Unexpected ${String(value)}`, caller);
 }
 
 /**
@@ -62,7 +71,7 @@ function throwUnexpectedValueError(
  */
 export function assert(value: boolean, message?: string): asserts value {
   if (value !== true) {
-    throwUnexpectedValueError('assert', value, message);
+    throwUnexpectedValueError('assert', value, message, assert);
   }
 }
 
@@ -88,7 +97,12 @@ export function assertNonNullable<T>(
   message?: string,
 ): asserts value is NonNullable<T> {
   if (value === null || value === undefined) {
-    throwUnexpectedValueError('assertNonNullable', value, message);
+    throwUnexpectedValueError(
+      'assertNonNullable',
+      value,
+      message,
+      assertNonNullable,
+    );
   }
 }
 
@@ -122,7 +136,9 @@ export function ensure<T, S extends T>(
   predicate: (value: T) => value is S,
   message?: string,
 ): S {
-  assert(predicate(value), message);
+  if (!predicate(value)) {
+    throwUnexpectedValueError('ensure', value, message, ensure);
+  }
   return value;
 }
 
@@ -151,7 +167,12 @@ export function ensureNonNullable<T>(
   message?: string,
 ): NonNullable<T> {
   if (value === null || value === undefined) {
-    throwUnexpectedValueError('ensureNonNullable', value, message);
+    throwUnexpectedValueError(
+      'ensureNonNullable',
+      value,
+      message,
+      ensureNonNullable,
+    );
   }
   return value;
 }
@@ -179,7 +200,7 @@ export function ensureNonNullable<T>(
  * ```
  */
 export function assertUnreachable(message = 'Reached unreachable code'): never {
-  throwError('assertUnreachable', message);
+  throwError('assertUnreachable', message, assertUnreachable);
 }
 
 /**
@@ -216,7 +237,12 @@ export function assertUnreachable(message = 'Reached unreachable code'): never {
  * ```
  */
 export function assertExhaustive(value: never, message?: string): never {
-  throwUnexpectedValueError('assertExhaustive', value, message);
+  throwUnexpectedValueError(
+    'assertExhaustive',
+    value,
+    message,
+    assertExhaustive,
+  );
 }
 
 /**
@@ -234,5 +260,5 @@ export function assertExhaustive(value: never, message?: string): never {
  * ```
  */
 export function unimplemented(message = 'Not implemented'): never {
-  throwError('unimplemented', message);
+  throwError('unimplemented', message, unimplemented);
 }