bupkis 0.18.3 → 1.0.0

package/dist/error.d.cts

@@ -0,0 +1,212 @@
+/**
+ * Error types thrown by _BUPKIS_, including {@link AssertionError}.
+ *
+ * @privateRemarks
+ * Other custom errors should go here.
+ * @packageDocumentation
+ */
+import { AssertionError as NodeAssertionError } from 'node:assert';
+import { type LiteralStringUnion } from 'type-fest/source/literal-union.js';
+import { FAIL, kBupkisAssertionError, kBupkisError, kBupkisFailAssertionError, kBupkisNegatedAssertionError } from "./constant.cjs";
+/**
+ * Options for {@link AssertionError}'s constructor
+ *
+ * @remarks
+ * Based on Node.js' {@link NodeAssertionError}'s constructor options, sans
+ * `operator`.
+ * @group Error Options
+ */
+export type AssertionErrorOptions = Partial<Omit<NonNullable<ConstructorParameters<typeof NodeAssertionError>[0]>, 'operator'>> & {
+    id: string;
+};
+/**
+ * Options for {@link AssertionImplementationError}
+ *
+ * @group Error Options
+ */
+export interface AssertionImplementationErrorOptions extends ErrorOptions {
+    /**
+     * The result returned by an assertion implementation that caused this error.
+     */
+    result?: unknown;
+}
+export type FailAssertionErrorOptions = Omit<AssertionErrorOptions, 'id'>;
+/**
+ * Options for {@link InvalidMetadataError}
+ *
+ * @group Error Options
+ */
+export interface InvalidMetadataErrorOptions extends ErrorOptions {
+    /**
+     * The invalid metadata.
+     */
+    metadata?: unknown;
+}
+/**
+ * Options for {@link InvalidObjectSchemaError}
+ *
+ * @group Error Options
+ */
+export interface InvalidSchemaErrorOptions extends ErrorOptions {
+    /**
+     * The invalid schema
+     */
+    schema?: unknown;
+}
+/**
+ * Options for {@link UnknownAssertionError}
+ *
+ * @group Error Options
+ */
+export interface UnknownAssertionErrorOptions<T extends readonly unknown[]> extends ErrorOptions {
+    /**
+     * The arguments passed to {@link bupkis!expect | expect} or
+     * {@link bupkis!expectAsync | expectAsync} which caused this error.
+     */
+    args: T;
+}
+/**
+ * _BUPKIS_' s custom `AssertionError` class, which is just a thin wrapper
+ * around Node.js' {@link NodeAssertionError AssertionError}.
+ *
+ * @group Core API
+ * @group Errors
+ */
+export declare class AssertionError extends NodeAssertionError {
+    /**
+     * @internal
+     */
+    [kBupkisAssertionError]: boolean;
+    /**
+     * Assertion ID of the assertion that caused this error.
+     */
+    readonly assertionId: LiteralStringUnion<typeof FAIL>;
+    name: string;
+    constructor(options: AssertionErrorOptions);
+    /**
+     * Type guard for an instance of this error.
+     *
+     * @param value Some value
+     * @returns `true` if `value` is an instance of `AssertionError`
+     */
+    static isAssertionError: (value: unknown) => value is AssertionError;
+    toJSON(): {
+        actual: unknown;
+        expected: unknown;
+        message: string;
+        name: string;
+        stack: string | undefined;
+    };
+}
+/**
+ * Base class for all custom errors thrown by <span
+ * class="bupkis">BUPKIS</span>.
+ *
+ * Typically only thrown when it should be impossible to throw.
+ *
+ * @group Errors
+ */
+export declare class BupkisError extends Error {
+    [kBupkisError]: boolean;
+    name: string;
+    static isBupkisError: (err: unknown) => err is BupkisError;
+}
+/**
+ * Error type used when an assertion implementation throws an error (this likely
+ * means there's a bug in the assertion implementation).
+ *
+ * @group Errors
+ */
+export declare class AssertionImplementationError extends BupkisError {
+    readonly code = "ERR_BUPKIS_ASSERTION_IMPL";
+    name: string;
+    readonly result: unknown;
+    constructor(message: string, options?: AssertionImplementationErrorOptions);
+    static isAssertionImplementationError: (err: unknown) => err is AssertionImplementationError;
+}
+/**
+ * Variant of an {@link AssertionError} that is thrown when
+ * {@link bupkis!expect.fail} is called.
+ *
+ * @group Errors
+ */
+export declare class FailAssertionError extends AssertionError {
+    /**
+     * @internal
+     */
+    [kBupkisFailAssertionError]: boolean;
+    name: string;
+    constructor(options?: FailAssertionErrorOptions);
+    static isFailAssertionError: (err: unknown) => err is FailAssertionError;
+}
+/**
+ * Error type used when assertion metadata is invalid.
+ *
+ * @remarks
+ * This should never be thrown unless someone monkeyed with the metadata
+ * registry.
+ * @group Errors
+ */
+export declare class InvalidMetadataError extends BupkisError {
+    readonly code = "ERR_BUPKIS_INVALID_METADATA";
+    readonly metadata?: unknown;
+    name: string;
+    constructor(message: string, options?: InvalidMetadataErrorOptions);
+}
+/**
+ * Thrown from certain assertions when a parameter cannot be used as an "object
+ * schema"
+ *
+ * @group Errors
+ */
+export declare class InvalidObjectSchemaError extends BupkisError {
+    readonly code = "ERR_BUPKIS_INVALID_OBJECT_SCHEMA";
+    name: string;
+    readonly schema?: unknown;
+    constructor(message: string, options?: InvalidSchemaErrorOptions);
+}
+/**
+ * Error type used internally to catch failed negated assertions.
+ *
+ * @group Errors
+ */
+export declare class NegatedAssertionError extends AssertionError {
+    [kBupkisNegatedAssertionError]: boolean;
+    name: string;
+    static isNegatedAssertionError: (err: unknown) => err is NegatedAssertionError;
+}
+/**
+ * Thrown when a value cannot be converted to a schema using `valueToSchema()`.
+ *
+ * @remarks
+ * Currently, this is thrown when encountering an empty object as a value
+ * (because this will match anything; though maybe we should change that).
+ * @group Errors
+ */
+export declare class SatisfactionError extends BupkisError {
+    readonly code = "ERR_BUPKIS_SATISFACTION";
+    name: string;
+    constructor(message: string, options?: ErrorOptions);
+}
+/**
+ * Thrown when `expect()` is called with something async.
+ *
+ * @group Errors
+ */
+export declare class UnexpectedAsyncError extends BupkisError {
+    readonly code = "ERR_BUPKIS_UNEXPECTED_ASYNC";
+    name: string;
+}
+/**
+ * Thrown when we cannot match the parameters to {@link bupkis!expect | expect}
+ * or {@link bupkis!expectAsync | expectAsync} to any known assertion.
+ *
+ * @group Errors
+ */
+export declare class UnknownAssertionError<T extends readonly unknown[]> extends BupkisError {
+    readonly args: T;
+    readonly code = "ERR_BUPKIS_UNKNOWN_ASSERTION";
+    name: string;
+    constructor(message: string, options: UnknownAssertionErrorOptions<T>);
+}
+//# sourceMappingURL=error.d.ts.map

package/dist/error.d.cts.map

@@ -0,0 +1 @@
+{"version":3,"file":"error.d.ts","sourceRoot":"","sources":["../src/error.ts"],"names":[],"mappings":"AAAA;;;;;;GAMG;AAEH,OAAO,EAAE,cAAc,IAAI,kBAAkB,EAAE,MAAM,aAAa,CAAC;AACnE,OAAO,EAAE,KAAK,kBAAkB,EAAE,MAAM,mCAAmC,CAAC;AAE5E,OAAO,EACL,IAAI,EACJ,qBAAqB,EACrB,YAAY,EACZ,yBAAyB,EACzB,4BAA4B,EAC7B,uBAAsB;AAKvB;;;;;;;GAOG;AACH,MAAM,MAAM,qBAAqB,GAAG,OAAO,CACzC,IAAI,CACF,WAAW,CAAC,qBAAqB,CAAC,OAAO,kBAAkB,CAAC,CAAC,CAAC,CAAC,CAAC,EAChE,UAAU,CACX,CACF,GAAG;IAAE,EAAE,EAAE,MAAM,CAAA;CAAE,CAAC;AAEnB;;;;GAIG;AACH,MAAM,WAAW,mCAAoC,SAAQ,YAAY;IACvE;;OAEG;IACH,MAAM,CAAC,EAAE,OAAO,CAAC;CAClB;AACD,MAAM,MAAM,yBAAyB,GAAG,IAAI,CAAC,qBAAqB,EAAE,IAAI,CAAC,CAAC;AAE1E;;;;GAIG;AACH,MAAM,WAAW,2BAA4B,SAAQ,YAAY;IAC/D;;OAEG;IACH,QAAQ,CAAC,EAAE,OAAO,CAAC;CACpB;AAED;;;;GAIG;AACH,MAAM,WAAW,yBAA0B,SAAQ,YAAY;IAC7D;;OAEG;IACH,MAAM,CAAC,EAAE,OAAO,CAAC;CAClB;AAED;;;;GAIG;AACH,MAAM,WAAW,4BAA4B,CAC3C,CAAC,SAAS,SAAS,OAAO,EAAE,CAC5B,SAAQ,YAAY;IACpB;;;OAGG;IACH,IAAI,EAAE,CAAC,CAAC;CACT;AAED;;;;;;GAMG;AACH,qBAAa,cAAe,SAAQ,kBAAkB;IAMpD;;OAEG;IACH,CAAC,qBAAqB,CAAC;IARvB;;OAEG;IACH,QAAQ,CAAC,WAAW,EAAE,kBAAkB,CAAC,OAAO,IAAI,CAAC,CAAC;IAO7C,IAAI,SAAoB;gBAErB,OAAO,EAAE,qBAAqB;IAK1C;;;;;OAKG;IACH,MAAM,CAAC,gBAAgB,GAAI,OAAO,OAAO,KAAG,KAAK,IAAI,cAAc,CACM;IAEzE,MAAM;;;;;;;CASP;AAED;;;;;;;GAOG;AACH,qBAAa,WAAY,SAAQ,KAAK;IACpC,CAAC,YAAY,CAAC;IAEL,IAAI,SAAiB;IAE9B,MAAM,CAAC,aAAa,GAAI,KAAK,OAAO,KAAG,GAAG,IAAI,WAAW,CACV;CAChD;AAED;;;;;GAKG;AACH,qBAAa,4BAA6B,SAAQ,WAAW;IAC3D,QAAQ,CAAC,IAAI,+BAA+B;IAEnC,IAAI,SAAkC;IAE/C,QAAQ,CAAC,MAAM,EAAE,OAAO,CAAC;gBAGvB,OAAO,EAAE,MAAM,EACf,OAAO,GAAE,mCAAwC;IAOnD,MAAM,CAAC,8BAA8B,GACnC,KAAK,OAAO,KACX,GAAG,IAAI,4BAA4B,CACG;CAC1C;AAED;;;;;GAKG;AACH,qBAAa,kBAAmB,SAAQ,cAAc;IACpD;;OAEG;IACH,CAAC,yBAAyB,CAAC;IAElB,IAAI,SAAwB;gBAEzB,OAAO,CAAC,EAAE,yBAAyB;IAI/C,MAAM,CAAC,oBAAoB,GAAI,KAAK,OAAO,KAAG,GAAG,IAAI,kBAAkB,CACE;CAC1E;AAED;;;;;;;GAOG;AACH,qBAAa,oBAAqB,SAAQ,WAAW;IACnD,QAAQ,CAAC,IAAI,iCAAiC;IAE9C,QAAQ,CAAC,QAAQ,CAAC,EAAE,OAAO,CAAC;IAEnB,IAAI,SAA0B;gBAE3B,OAAO,EAAE,MAAM,EAAE,OAAO,GAAE,2BAAgC;CAKvE;AAED;;;;;GAKG;AACH,qBAAa,wBAAyB,SAAQ,WAAW;IACvD,QAAQ,CAAC,IAAI,sCAAsC;IAE1C,IAAI,SAA8B;IAE3C,QAAQ,CAAC,MAAM,CAAC,EAAE,OAAO,CAAC;gBAEd,OAAO,EAAE,MAAM,EAAE,OAAO,GAAE,yBAA8B;CAKrE;AAED;;;;GAIG;AACH,qBAAa,qBAAsB,SAAQ,cAAc;IACvD,CAAC,4BAA4B,CAAC;IAErB,IAAI,SAA2B;IAExC,MAAM,CAAC,uBAAuB,GAC5B,KAAK,OAAO,KACX,GAAG,IAAI,qBAAqB,CACyC;CACzE;AAED;;;;;;;GAOG;AACH,qBAAa,iBAAkB,SAAQ,WAAW;IAChD,QAAQ,CAAC,IAAI,6BAA6B;IAEjC,IAAI,SAAuB;gBAExB,OAAO,EAAE,MAAM,EAAE,OAAO,GAAE,YAAiB;CAGxD;AAED;;;;GAIG;AACH,qBAAa,oBAAqB,SAAQ,WAAW;IACnD,QAAQ,CAAC,IAAI,iCAAiC;IAErC,IAAI,SAA0B;CACxC;AAED;;;;;GAKG;AACH,qBAAa,qBAAqB,CAChC,CAAC,SAAS,SAAS,OAAO,EAAE,CAC5B,SAAQ,WAAW;IACnB,QAAQ,CAAC,IAAI,EAAE,CAAC,CAAC;IAEjB,QAAQ,CAAC,IAAI,kCAAkC;IAEtC,IAAI,SAA2B;gBAE5B,OAAO,EAAE,MAAM,EAAE,OAAO,EAAE,4BAA4B,CAAC,CAAC,CAAC;CAKtE"}

package/dist/error.d.ts

@@ -0,0 +1,212 @@
+/**
+ * Error types thrown by _BUPKIS_, including {@link AssertionError}.
+ *
+ * @privateRemarks
+ * Other custom errors should go here.
+ * @packageDocumentation
+ */
+import { AssertionError as NodeAssertionError } from 'node:assert';
+import { type LiteralStringUnion } from 'type-fest/source/literal-union.js';
+import { FAIL, kBupkisAssertionError, kBupkisError, kBupkisFailAssertionError, kBupkisNegatedAssertionError } from "./constant.js";
+/**
+ * Options for {@link AssertionError}'s constructor
+ *
+ * @remarks
+ * Based on Node.js' {@link NodeAssertionError}'s constructor options, sans
+ * `operator`.
+ * @group Error Options
+ */
+export type AssertionErrorOptions = Partial<Omit<NonNullable<ConstructorParameters<typeof NodeAssertionError>[0]>, 'operator'>> & {
+    id: string;
+};
+/**
+ * Options for {@link AssertionImplementationError}
+ *
+ * @group Error Options
+ */
+export interface AssertionImplementationErrorOptions extends ErrorOptions {
+    /**
+     * The result returned by an assertion implementation that caused this error.
+     */
+    result?: unknown;
+}
+export type FailAssertionErrorOptions = Omit<AssertionErrorOptions, 'id'>;
+/**
+ * Options for {@link InvalidMetadataError}
+ *
+ * @group Error Options
+ */
+export interface InvalidMetadataErrorOptions extends ErrorOptions {
+    /**
+     * The invalid metadata.
+     */
+    metadata?: unknown;
+}
+/**
+ * Options for {@link InvalidObjectSchemaError}
+ *
+ * @group Error Options
+ */
+export interface InvalidSchemaErrorOptions extends ErrorOptions {
+    /**
+     * The invalid schema
+     */
+    schema?: unknown;
+}
+/**
+ * Options for {@link UnknownAssertionError}
+ *
+ * @group Error Options
+ */
+export interface UnknownAssertionErrorOptions<T extends readonly unknown[]> extends ErrorOptions {
+    /**
+     * The arguments passed to {@link bupkis!expect | expect} or
+     * {@link bupkis!expectAsync | expectAsync} which caused this error.
+     */
+    args: T;
+}
+/**
+ * _BUPKIS_' s custom `AssertionError` class, which is just a thin wrapper
+ * around Node.js' {@link NodeAssertionError AssertionError}.
+ *
+ * @group Core API
+ * @group Errors
+ */
+export declare class AssertionError extends NodeAssertionError {
+    /**
+     * @internal
+     */
+    [kBupkisAssertionError]: boolean;
+    /**
+     * Assertion ID of the assertion that caused this error.
+     */
+    readonly assertionId: LiteralStringUnion<typeof FAIL>;
+    name: string;
+    constructor(options: AssertionErrorOptions);
+    /**
+     * Type guard for an instance of this error.
+     *
+     * @param value Some value
+     * @returns `true` if `value` is an instance of `AssertionError`
+     */
+    static isAssertionError: (value: unknown) => value is AssertionError;
+    toJSON(): {
+        actual: unknown;
+        expected: unknown;
+        message: string;
+        name: string;
+        stack: string | undefined;
+    };
+}
+/**
+ * Base class for all custom errors thrown by <span
+ * class="bupkis">BUPKIS</span>.
+ *
+ * Typically only thrown when it should be impossible to throw.
+ *
+ * @group Errors
+ */
+export declare class BupkisError extends Error {
+    [kBupkisError]: boolean;
+    name: string;
+    static isBupkisError: (err: unknown) => err is BupkisError;
+}
+/**
+ * Error type used when an assertion implementation throws an error (this likely
+ * means there's a bug in the assertion implementation).
+ *
+ * @group Errors
+ */
+export declare class AssertionImplementationError extends BupkisError {
+    readonly code = "ERR_BUPKIS_ASSERTION_IMPL";
+    name: string;
+    readonly result: unknown;
+    constructor(message: string, options?: AssertionImplementationErrorOptions);
+    static isAssertionImplementationError: (err: unknown) => err is AssertionImplementationError;
+}
+/**
+ * Variant of an {@link AssertionError} that is thrown when
+ * {@link bupkis!expect.fail} is called.
+ *
+ * @group Errors
+ */
+export declare class FailAssertionError extends AssertionError {
+    /**
+     * @internal
+     */
+    [kBupkisFailAssertionError]: boolean;
+    name: string;
+    constructor(options?: FailAssertionErrorOptions);
+    static isFailAssertionError: (err: unknown) => err is FailAssertionError;
+}
+/**
+ * Error type used when assertion metadata is invalid.
+ *
+ * @remarks
+ * This should never be thrown unless someone monkeyed with the metadata
+ * registry.
+ * @group Errors
+ */
+export declare class InvalidMetadataError extends BupkisError {
+    readonly code = "ERR_BUPKIS_INVALID_METADATA";
+    readonly metadata?: unknown;
+    name: string;
+    constructor(message: string, options?: InvalidMetadataErrorOptions);
+}
+/**
+ * Thrown from certain assertions when a parameter cannot be used as an "object
+ * schema"
+ *
+ * @group Errors
+ */
+export declare class InvalidObjectSchemaError extends BupkisError {
+    readonly code = "ERR_BUPKIS_INVALID_OBJECT_SCHEMA";
+    name: string;
+    readonly schema?: unknown;
+    constructor(message: string, options?: InvalidSchemaErrorOptions);
+}
+/**
+ * Error type used internally to catch failed negated assertions.
+ *
+ * @group Errors
+ */
+export declare class NegatedAssertionError extends AssertionError {
+    [kBupkisNegatedAssertionError]: boolean;
+    name: string;
+    static isNegatedAssertionError: (err: unknown) => err is NegatedAssertionError;
+}
+/**
+ * Thrown when a value cannot be converted to a schema using `valueToSchema()`.
+ *
+ * @remarks
+ * Currently, this is thrown when encountering an empty object as a value
+ * (because this will match anything; though maybe we should change that).
+ * @group Errors
+ */
+export declare class SatisfactionError extends BupkisError {
+    readonly code = "ERR_BUPKIS_SATISFACTION";
+    name: string;
+    constructor(message: string, options?: ErrorOptions);
+}
+/**
+ * Thrown when `expect()` is called with something async.
+ *
+ * @group Errors
+ */
+export declare class UnexpectedAsyncError extends BupkisError {
+    readonly code = "ERR_BUPKIS_UNEXPECTED_ASYNC";
+    name: string;
+}
+/**
+ * Thrown when we cannot match the parameters to {@link bupkis!expect | expect}
+ * or {@link bupkis!expectAsync | expectAsync} to any known assertion.
+ *
+ * @group Errors
+ */
+export declare class UnknownAssertionError<T extends readonly unknown[]> extends BupkisError {
+    readonly args: T;
+    readonly code = "ERR_BUPKIS_UNKNOWN_ASSERTION";
+    name: string;
+    constructor(message: string, options: UnknownAssertionErrorOptions<T>);
+}
+//# sourceMappingURL=error.d.ts.map

package/dist/error.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"error.d.ts","sourceRoot":"","sources":["../src/error.ts"],"names":[],"mappings":"AAAA;;;;;;GAMG;AAEH,OAAO,EAAE,cAAc,IAAI,kBAAkB,EAAE,MAAM,aAAa,CAAC;AACnE,OAAO,EAAE,KAAK,kBAAkB,EAAE,MAAM,mCAAmC,CAAC;AAE5E,OAAO,EACL,IAAI,EACJ,qBAAqB,EACrB,YAAY,EACZ,yBAAyB,EACzB,4BAA4B,EAC7B,sBAAsB;AAKvB;;;;;;;GAOG;AACH,MAAM,MAAM,qBAAqB,GAAG,OAAO,CACzC,IAAI,CACF,WAAW,CAAC,qBAAqB,CAAC,OAAO,kBAAkB,CAAC,CAAC,CAAC,CAAC,CAAC,EAChE,UAAU,CACX,CACF,GAAG;IAAE,EAAE,EAAE,MAAM,CAAA;CAAE,CAAC;AAEnB;;;;GAIG;AACH,MAAM,WAAW,mCAAoC,SAAQ,YAAY;IACvE;;OAEG;IACH,MAAM,CAAC,EAAE,OAAO,CAAC;CAClB;AACD,MAAM,MAAM,yBAAyB,GAAG,IAAI,CAAC,qBAAqB,EAAE,IAAI,CAAC,CAAC;AAE1E;;;;GAIG;AACH,MAAM,WAAW,2BAA4B,SAAQ,YAAY;IAC/D;;OAEG;IACH,QAAQ,CAAC,EAAE,OAAO,CAAC;CACpB;AAED;;;;GAIG;AACH,MAAM,WAAW,yBAA0B,SAAQ,YAAY;IAC7D;;OAEG;IACH,MAAM,CAAC,EAAE,OAAO,CAAC;CAClB;AAED;;;;GAIG;AACH,MAAM,WAAW,4BAA4B,CAC3C,CAAC,SAAS,SAAS,OAAO,EAAE,CAC5B,SAAQ,YAAY;IACpB;;;OAGG;IACH,IAAI,EAAE,CAAC,CAAC;CACT;AAED;;;;;;GAMG;AACH,qBAAa,cAAe,SAAQ,kBAAkB;IAMpD;;OAEG;IACH,CAAC,qBAAqB,CAAC;IARvB;;OAEG;IACH,QAAQ,CAAC,WAAW,EAAE,kBAAkB,CAAC,OAAO,IAAI,CAAC,CAAC;IAO7C,IAAI,SAAoB;gBAErB,OAAO,EAAE,qBAAqB;IAK1C;;;;;OAKG;IACH,MAAM,CAAC,gBAAgB,GAAI,OAAO,OAAO,KAAG,KAAK,IAAI,cAAc,CACM;IAEzE,MAAM;;;;;;;CASP;AAED;;;;;;;GAOG;AACH,qBAAa,WAAY,SAAQ,KAAK;IACpC,CAAC,YAAY,CAAC;IAEL,IAAI,SAAiB;IAE9B,MAAM,CAAC,aAAa,GAAI,KAAK,OAAO,KAAG,GAAG,IAAI,WAAW,CACV;CAChD;AAED;;;;;GAKG;AACH,qBAAa,4BAA6B,SAAQ,WAAW;IAC3D,QAAQ,CAAC,IAAI,+BAA+B;IAEnC,IAAI,SAAkC;IAE/C,QAAQ,CAAC,MAAM,EAAE,OAAO,CAAC;gBAGvB,OAAO,EAAE,MAAM,EACf,OAAO,GAAE,mCAAwC;IAOnD,MAAM,CAAC,8BAA8B,GACnC,KAAK,OAAO,KACX,GAAG,IAAI,4BAA4B,CACG;CAC1C;AAED;;;;;GAKG;AACH,qBAAa,kBAAmB,SAAQ,cAAc;IACpD;;OAEG;IACH,CAAC,yBAAyB,CAAC;IAElB,IAAI,SAAwB;gBAEzB,OAAO,CAAC,EAAE,yBAAyB;IAI/C,MAAM,CAAC,oBAAoB,GAAI,KAAK,OAAO,KAAG,GAAG,IAAI,kBAAkB,CACE;CAC1E;AAED;;;;;;;GAOG;AACH,qBAAa,oBAAqB,SAAQ,WAAW;IACnD,QAAQ,CAAC,IAAI,iCAAiC;IAE9C,QAAQ,CAAC,QAAQ,CAAC,EAAE,OAAO,CAAC;IAEnB,IAAI,SAA0B;gBAE3B,OAAO,EAAE,MAAM,EAAE,OAAO,GAAE,2BAAgC;CAKvE;AAED;;;;;GAKG;AACH,qBAAa,wBAAyB,SAAQ,WAAW;IACvD,QAAQ,CAAC,IAAI,sCAAsC;IAE1C,IAAI,SAA8B;IAE3C,QAAQ,CAAC,MAAM,CAAC,EAAE,OAAO,CAAC;gBAEd,OAAO,EAAE,MAAM,EAAE,OAAO,GAAE,yBAA8B;CAKrE;AAED;;;;GAIG;AACH,qBAAa,qBAAsB,SAAQ,cAAc;IACvD,CAAC,4BAA4B,CAAC;IAErB,IAAI,SAA2B;IAExC,MAAM,CAAC,uBAAuB,GAC5B,KAAK,OAAO,KACX,GAAG,IAAI,qBAAqB,CACyC;CACzE;AAED;;;;;;;GAOG;AACH,qBAAa,iBAAkB,SAAQ,WAAW;IAChD,QAAQ,CAAC,IAAI,6BAA6B;IAEjC,IAAI,SAAuB;gBAExB,OAAO,EAAE,MAAM,EAAE,OAAO,GAAE,YAAiB;CAGxD;AAED;;;;GAIG;AACH,qBAAa,oBAAqB,SAAQ,WAAW;IACnD,QAAQ,CAAC,IAAI,iCAAiC;IAErC,IAAI,SAA0B;CACxC;AAED;;;;;GAKG;AACH,qBAAa,qBAAqB,CAChC,CAAC,SAAS,SAAS,OAAO,EAAE,CAC5B,SAAQ,WAAW;IACnB,QAAQ,CAAC,IAAI,EAAE,CAAC,CAAC;IAEjB,QAAQ,CAAC,IAAI,kCAAkC;IAEtC,IAAI,SAA2B;gBAE5B,OAAO,EAAE,MAAM,EAAE,OAAO,EAAE,4BAA4B,CAAC,CAAC,CAAC;CAKtE"}

package/dist/error.js

@@ -0,0 +1,181 @@
+/**
+ * Error types thrown by _BUPKIS_, including {@link AssertionError}.
+ *
+ * @privateRemarks
+ * Other custom errors should go here.
+ * @packageDocumentation
+ */
+import { AssertionError as NodeAssertionError } from 'node:assert';
+import { FAIL, kBupkisAssertionError, kBupkisError, kBupkisFailAssertionError, kBupkisNegatedAssertionError, } from "./constant.js";
+import { isA } from "./guards.js";
+const { hasOwn } = Object;
+/**
+ * _BUPKIS_' s custom `AssertionError` class, which is just a thin wrapper
+ * around Node.js' {@link NodeAssertionError AssertionError}.
+ *
+ * @group Core API
+ * @group Errors
+ */
+export class AssertionError extends NodeAssertionError {
+    /**
+     * Assertion ID of the assertion that caused this error.
+     */
+    assertionId;
+    /**
+     * @internal
+     */
+    [kBupkisAssertionError] = true;
+    name = 'AssertionError';
+    constructor(options) {
+        super(options);
+        this.assertionId = options.id;
+    }
+    /**
+     * Type guard for an instance of this error.
+     *
+     * @param value Some value
+     * @returns `true` if `value` is an instance of `AssertionError`
+     */
+    static isAssertionError = (value) => isA(value, NodeAssertionError) && hasOwn(value, kBupkisAssertionError);
+    toJSON() {
+        return {
+            actual: this.actual,
+            expected: this.expected,
+            message: this.message,
+            name: this.name,
+            stack: this.stack,
+        };
+    }
+}
+/**
+ * Base class for all custom errors thrown by <span
+ * class="bupkis">BUPKIS</span>.
+ *
+ * Typically only thrown when it should be impossible to throw.
+ *
+ * @group Errors
+ */
+export class BupkisError extends Error {
+    [kBupkisError] = true;
+    name = 'BupkisError';
+    static isBupkisError = (err) => isA(err, Error) && hasOwn(err, kBupkisError);
+}
+/**
+ * Error type used when an assertion implementation throws an error (this likely
+ * means there's a bug in the assertion implementation).
+ *
+ * @group Errors
+ */
+export class AssertionImplementationError extends BupkisError {
+    code = 'ERR_BUPKIS_ASSERTION_IMPL';
+    name = 'AssertionImplementationError';
+    result;
+    constructor(message, options = {}) {
+        const { result, ...rest } = options;
+        super(message, rest);
+        this.result = result;
+    }
+    static isAssertionImplementationError = (err) => isA(err, AssertionImplementationError);
+}
+/**
+ * Variant of an {@link AssertionError} that is thrown when
+ * {@link bupkis!expect.fail} is called.
+ *
+ * @group Errors
+ */
+export class FailAssertionError extends AssertionError {
+    /**
+     * @internal
+     */
+    [kBupkisFailAssertionError] = true;
+    name = 'FailAssertionError';
+    constructor(options) {
+        super({ ...options, id: FAIL });
+    }
+    static isFailAssertionError = (err) => isA(err, FailAssertionError) && hasOwn(err, kBupkisFailAssertionError);
+}
+/**
+ * Error type used when assertion metadata is invalid.
+ *
+ * @remarks
+ * This should never be thrown unless someone monkeyed with the metadata
+ * registry.
+ * @group Errors
+ */
+export class InvalidMetadataError extends BupkisError {
+    code = 'ERR_BUPKIS_INVALID_METADATA';
+    metadata;
+    name = 'InvalidMetadataError';
+    constructor(message, options = {}) {
+        const { metadata, ...rest } = options;
+        super(message, rest);
+        this.metadata = metadata;
+    }
+}
+/**
+ * Thrown from certain assertions when a parameter cannot be used as an "object
+ * schema"
+ *
+ * @group Errors
+ */
+export class InvalidObjectSchemaError extends BupkisError {
+    code = 'ERR_BUPKIS_INVALID_OBJECT_SCHEMA';
+    name = 'InvalidObjectSchemaError';
+    schema;
+    constructor(message, options = {}) {
+        const { schema, ...rest } = options;
+        super(message, rest);
+        this.schema = schema;
+    }
+}
+/**
+ * Error type used internally to catch failed negated assertions.
+ *
+ * @group Errors
+ */
+export class NegatedAssertionError extends AssertionError {
+    [kBupkisNegatedAssertionError] = true;
+    name = 'NegatedAssertionError';
+    static isNegatedAssertionError = (err) => isA(err, AssertionError) && hasOwn(err, kBupkisNegatedAssertionError);
+}
+/**
+ * Thrown when a value cannot be converted to a schema using `valueToSchema()`.
+ *
+ * @remarks
+ * Currently, this is thrown when encountering an empty object as a value
+ * (because this will match anything; though maybe we should change that).
+ * @group Errors
+ */
+export class SatisfactionError extends BupkisError {
+    code = 'ERR_BUPKIS_SATISFACTION';
+    name = 'SatisfactionError';
+    constructor(message, options = {}) {
+        super(message, options);
+    }
+}
+/**
+ * Thrown when `expect()` is called with something async.
+ *
+ * @group Errors
+ */
+export class UnexpectedAsyncError extends BupkisError {
+    code = 'ERR_BUPKIS_UNEXPECTED_ASYNC';
+    name = 'UnexpectedAsyncError';
+}
+/**
+ * Thrown when we cannot match the parameters to {@link bupkis!expect | expect}
+ * or {@link bupkis!expectAsync | expectAsync} to any known assertion.
+ *
+ * @group Errors
+ */
+export class UnknownAssertionError extends BupkisError {
+    args;
+    code = 'ERR_BUPKIS_UNKNOWN_ASSERTION';
+    name = 'UnknownAssertionError';
+    constructor(message, options) {
+        const { args, ...rest } = options;
+        super(message, rest);
+        this.args = args;
+    }
+}
+//# sourceMappingURL=error.js.map

package/dist/error.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"error.js","sourceRoot":"","sources":["../src/error.ts"],"names":[],"mappings":"AAAA;;;;;;GAMG;AAEH,OAAO,EAAE,cAAc,IAAI,kBAAkB,EAAE,MAAM,aAAa,CAAC;AAGnE,OAAO,EACL,IAAI,EACJ,qBAAqB,EACrB,YAAY,EACZ,yBAAyB,EACzB,4BAA4B,GAC7B,sBAAsB;AACvB,OAAO,EAAE,GAAG,EAAE,oBAAoB;AAElC,MAAM,EAAE,MAAM,EAAE,GAAG,MAAM,CAAC;AAqE1B;;;;;;GAMG;AACH,MAAM,OAAO,cAAe,SAAQ,kBAAkB;IACpD;;OAEG;IACM,WAAW,CAAkC;IAEtD;;OAEG;IACH,CAAC,qBAAqB,CAAC,GAAG,IAAI,CAAC;IAEtB,IAAI,GAAG,gBAAgB,CAAC;IAEjC,YAAY,OAA8B;QACxC,KAAK,CAAC,OAAO,CAAC,CAAC;QACf,IAAI,CAAC,WAAW,GAAG,OAAO,CAAC,EAAE,CAAC;IAChC,CAAC;IAED;;;;;OAKG;IACH,MAAM,CAAC,gBAAgB,GAAG,CAAC,KAAc,EAA2B,EAAE,CACpE,GAAG,CAAC,KAAK,EAAE,kBAAkB,CAAC,IAAI,MAAM,CAAC,KAAK,EAAE,qBAAqB,CAAC,CAAC;IAEzE,MAAM;QACJ,OAAO;YACL,MAAM,EAAE,IAAI,CAAC,MAAM;YACnB,QAAQ,EAAE,IAAI,CAAC,QAAQ;YACvB,OAAO,EAAE,IAAI,CAAC,OAAO;YACrB,IAAI,EAAE,IAAI,CAAC,IAAI;YACf,KAAK,EAAE,IAAI,CAAC,KAAK;SAClB,CAAC;IACJ,CAAC;;AAGH;;;;;;;GAOG;AACH,MAAM,OAAO,WAAY,SAAQ,KAAK;IACpC,CAAC,YAAY,CAAC,GAAG,IAAI,CAAC;IAEb,IAAI,GAAG,aAAa,CAAC;IAE9B,MAAM,CAAC,aAAa,GAAG,CAAC,GAAY,EAAsB,EAAE,CAC1D,GAAG,CAAC,GAAG,EAAE,KAAK,CAAC,IAAI,MAAM,CAAC,GAAG,EAAE,YAAY,CAAC,CAAC;;AAGjD;;;;;GAKG;AACH,MAAM,OAAO,4BAA6B,SAAQ,WAAW;IAClD,IAAI,GAAG,2BAA2B,CAAC;IAEnC,IAAI,GAAG,8BAA8B,CAAC;IAEtC,MAAM,CAAU;IAEzB,YACE,OAAe,EACf,UAA+C,EAAE;QAEjD,MAAM,EAAE,MAAM,EAAE,GAAG,IAAI,EAAE,GAAG,OAAO,CAAC;QACpC,KAAK,CAAC,OAAO,EAAE,IAAI,CAAC,CAAC;QACrB,IAAI,CAAC,MAAM,GAAG,MAAM,CAAC;IACvB,CAAC;IAED,MAAM,CAAC,8BAA8B,GAAG,CACtC,GAAY,EACyB,EAAE,CACvC,GAAG,CAAC,GAAG,EAAE,4BAA4B,CAAC,CAAC;;AAG3C;;;;;GAKG;AACH,MAAM,OAAO,kBAAmB,SAAQ,cAAc;IACpD;;OAEG;IACH,CAAC,yBAAyB,CAAC,GAAG,IAAI,CAAC;IAE1B,IAAI,GAAG,oBAAoB,CAAC;IAErC,YAAY,OAAmC;QAC7C,KAAK,CAAC,EAAE,GAAG,OAAO,EAAE,EAAE,EAAE,IAAI,EAAE,CAAC,CAAC;IAClC,CAAC;IAED,MAAM,CAAC,oBAAoB,GAAG,CAAC,GAAY,EAA6B,EAAE,CACxE,GAAG,CAAC,GAAG,EAAE,kBAAkB,CAAC,IAAI,MAAM,CAAC,GAAG,EAAE,yBAAyB,CAAC,CAAC;;AAG3E;;;;;;;GAOG;AACH,MAAM,OAAO,oBAAqB,SAAQ,WAAW;IAC1C,IAAI,GAAG,6BAA6B,CAAC;IAErC,QAAQ,CAAW;IAEnB,IAAI,GAAG,sBAAsB,CAAC;IAEvC,YAAY,OAAe,EAAE,UAAuC,EAAE;QACpE,MAAM,EAAE,QAAQ,EAAE,GAAG,IAAI,EAAE,GAAG,OAAO,CAAC;QACtC,KAAK,CAAC,OAAO,EAAE,IAAI,CAAC,CAAC;QACrB,IAAI,CAAC,QAAQ,GAAG,QAAQ,CAAC;IAC3B,CAAC;CACF;AAED;;;;;GAKG;AACH,MAAM,OAAO,wBAAyB,SAAQ,WAAW;IAC9C,IAAI,GAAG,kCAAkC,CAAC;IAE1C,IAAI,GAAG,0BAA0B,CAAC;IAElC,MAAM,CAAW;IAE1B,YAAY,OAAe,EAAE,UAAqC,EAAE;QAClE,MAAM,EAAE,MAAM,EAAE,GAAG,IAAI,EAAE,GAAG,OAAO,CAAC;QACpC,KAAK,CAAC,OAAO,EAAE,IAAI,CAAC,CAAC;QACrB,IAAI,CAAC,MAAM,GAAG,MAAM,CAAC;IACvB,CAAC;CACF;AAED;;;;GAIG;AACH,MAAM,OAAO,qBAAsB,SAAQ,cAAc;IACvD,CAAC,4BAA4B,CAAC,GAAG,IAAI,CAAC;IAE7B,IAAI,GAAG,uBAAuB,CAAC;IAExC,MAAM,CAAC,uBAAuB,GAAG,CAC/B,GAAY,EACkB,EAAE,CAChC,GAAG,CAAC,GAAG,EAAE,cAAc,CAAC,IAAI,MAAM,CAAC,GAAG,EAAE,4BAA4B,CAAC,CAAC;;AAG1E;;;;;;;GAOG;AACH,MAAM,OAAO,iBAAkB,SAAQ,WAAW;IACvC,IAAI,GAAG,yBAAyB,CAAC;IAEjC,IAAI,GAAG,mBAAmB,CAAC;IAEpC,YAAY,OAAe,EAAE,UAAwB,EAAE;QACrD,KAAK,CAAC,OAAO,EAAE,OAAO,CAAC,CAAC;IAC1B,CAAC;CACF;AAED;;;;GAIG;AACH,MAAM,OAAO,oBAAqB,SAAQ,WAAW;IAC1C,IAAI,GAAG,6BAA6B,CAAC;IAErC,IAAI,GAAG,sBAAsB,CAAC;CACxC;AAED;;;;;GAKG;AACH,MAAM,OAAO,qBAEX,SAAQ,WAAW;IACV,IAAI,CAAI;IAER,IAAI,GAAG,8BAA8B,CAAC;IAEtC,IAAI,GAAG,uBAAuB,CAAC;IAExC,YAAY,OAAe,EAAE,OAAwC;QACnE,MAAM,EAAE,IAAI,EAAE,GAAG,IAAI,EAAE,GAAG,OAAO,CAAC;QAClC,KAAK,CAAC,OAAO,EAAE,IAAI,CAAC,CAAC;QACrB,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC;IACnB,CAAC;CACF"}