bupkis 0.18.2 → 1.0.0

package/dist/diff.js

@@ -0,0 +1,334 @@
+/**
+ * Diff utilities for generating rich assertion failure output.
+ *
+ * This module provides utilities for extracting meaningful actual/expected
+ * values from Zod validation errors and generating high-quality diff output
+ * using `jest-diff` for assertion failures.
+ *
+ * @packageDocumentation
+ * @see {@link https://npm.im/jest-diff | jest-diff}
+ */
+import { diff } from 'jest-diff';
+const { isArray } = Array;
+const { max } = Math;
+const { stringify } = JSON;
+const { entries, getOwnPropertyNames } = Object;
+/**
+ * Extracts actual and expected values from a `ZodError` for meaningful diffs.
+ *
+ * @function
+ * @param zodError The `ZodError` to extract values from
+ * @param subject The original subject that failed validation
+ * @returns Object with actual and expected values for diff
+ */
+export const extractDiffValues = (zodError, subject) => {
+    try {
+        const actual = subject;
+        let expected = subject != null ? deepClone(subject) : subject;
+        for (const issue of zodError.issues) {
+            try {
+                const filteredPath = issue.path.filter((key) => typeof key === 'string' || typeof key === 'number');
+                switch (issue.code) {
+                    case 'custom': {
+                        const params = issue.params;
+                        if (params?.bupkisType === 'missing_key' &&
+                            filteredPath.length > 0) {
+                            const missingKey = filteredPath[0];
+                            if (typeof expected === 'object' && expected !== null) {
+                                expected = {
+                                    ...expected,
+                                    [missingKey]: undefined,
+                                };
+                            }
+                        }
+                        else if (filteredPath.length > 0) {
+                            const actualValue = getValueAtPath(actual, filteredPath);
+                            if (actualValue === undefined) {
+                                expected = setValueAtPath(expected, filteredPath, undefined);
+                            }
+                        }
+                        break;
+                    }
+                    case 'invalid_format': {
+                        const actualValue = getValueAtPath(actual, filteredPath);
+                        let correctedValue = actualValue;
+                        const regexMatch = issue.message.match(/pattern (.+)/);
+                        if (regexMatch) {
+                            correctedValue = `<string matching ${regexMatch[1]}>`;
+                        }
+                        else {
+                            correctedValue = '<string in valid format>';
+                        }
+                        expected = setValueAtPath(expected, filteredPath, correctedValue);
+                        break;
+                    }
+                    case 'invalid_type': {
+                        const correctedValue = createCorrectValueForType(issue.expected, getValueAtPath(actual, filteredPath));
+                        expected = setValueAtPath(expected, filteredPath, correctedValue);
+                        break;
+                    }
+                    case 'invalid_union': {
+                        // Union errors contain multiple sub-errors for each branch.
+                        // We can't determine a single "expected" value, so bail out
+                        // and let Zod's error message show all the union branch errors.
+                        return { actual: undefined, expected: undefined };
+                    }
+                    case 'invalid_value': {
+                        // Only use the corrected value if we have a concrete value from the schema
+                        if (issue.values && issue.values.length > 0) {
+                            const correctedValue = issue.values[0];
+                            expected = setValueAtPath(expected, filteredPath, correctedValue);
+                        }
+                        else {
+                            // No concrete value available, bail out to Zod's error message
+                            return { actual: undefined, expected: undefined };
+                        }
+                        break;
+                    }
+                    case 'too_big': {
+                        const actualValue = getValueAtPath(actual, filteredPath);
+                        let correctedValue;
+                        if (issue.origin === 'string' && typeof actualValue === 'string') {
+                            correctedValue = actualValue.slice(0, Number(issue.maximum));
+                        }
+                        else if (issue.origin === 'array' && isArray(actualValue)) {
+                            correctedValue = actualValue.slice(0, Number(issue.maximum));
+                        }
+                        else {
+                            correctedValue = issue.maximum;
+                        }
+                        expected = setValueAtPath(expected, filteredPath, correctedValue);
+                        break;
+                    }
+                    case 'too_small': {
+                        const actualValue = getValueAtPath(actual, filteredPath);
+                        let correctedValue;
+                        if (issue.origin === 'string' && typeof actualValue === 'string') {
+                            const needed = Number(issue.minimum) - actualValue.length;
+                            correctedValue = actualValue + 'x'.repeat(max(0, needed));
+                        }
+                        else if (issue.origin === 'array' && isArray(actualValue)) {
+                            const needed = Number(issue.minimum) - actualValue.length;
+                            correctedValue = actualValue.concat(new Array(max(0, needed)).fill(null));
+                        }
+                        else {
+                            correctedValue = issue.minimum;
+                        }
+                        expected = setValueAtPath(expected, filteredPath, correctedValue);
+                        break;
+                    }
+                    case 'unrecognized_keys': {
+                        if (filteredPath.length === 0 &&
+                            typeof expected === 'object' &&
+                            expected !== null) {
+                            const expectedCopy = {
+                                ...expected,
+                            };
+                            for (const key of issue.keys) {
+                                delete expectedCopy[key];
+                            }
+                            expected = expectedCopy;
+                        }
+                        break;
+                    }
+                    default: {
+                        break;
+                    }
+                }
+            }
+            catch {
+                continue;
+            }
+        }
+        return { actual, expected };
+    }
+    catch {
+        return { actual: undefined, expected: undefined };
+    }
+};
+/**
+ * Generates a rich diff string using jest-diff for assertion failures.
+ *
+ * @function
+ * @param expected The expected value
+ * @param actual The actual value
+ * @param options Configuration options for diff generation
+ * @returns A formatted diff string, or null if values are identical
+ */
+export const generateDiff = (expected, actual, options = {}) => {
+    if (!shouldGenerateDiff(actual, expected)) {
+        return null;
+    }
+    return diff(expected, actual, {
+        aAnnotation: 'expected',
+        bAnnotation: 'actual',
+        expand: false,
+        includeChangeCounts: true,
+        ...options,
+    });
+};
+/**
+ * Checks if two values should generate a meaningful diff.
+ *
+ * @function
+ * @param actual The actual value
+ * @param expected The expected value
+ * @returns True if a diff should be generated, false otherwise
+ */
+export const shouldGenerateDiff = (actual, expected) => actual !== undefined && expected !== undefined && actual !== expected;
+/**
+ * Creates a corrected value for a given type
+ *
+ * @function
+ */
+const createCorrectValueForType = (expectedType, actualValue) => {
+    switch (expectedType) {
+        case 'array':
+            return isArray(actualValue) ? actualValue : [];
+        case 'boolean':
+            return typeof actualValue === 'boolean'
+                ? actualValue
+                : Boolean(actualValue);
+        case 'null':
+            return null;
+        case 'number':
+            return typeof actualValue === 'number'
+                ? actualValue
+                : Number(actualValue) || 0;
+        case 'object':
+            return typeof actualValue === 'object' && actualValue !== null
+                ? actualValue
+                : {};
+        case 'string':
+            if (typeof actualValue === 'string') {
+                return actualValue;
+            }
+            if (actualValue == null) {
+                return '';
+            }
+            if (typeof actualValue === 'object') {
+                return stringify(actualValue);
+            }
+            // eslint-disable-next-line @typescript-eslint/no-base-to-string
+            return `${actualValue}`;
+        case 'undefined':
+            return undefined;
+        default:
+            return `<${expectedType}>`;
+    }
+};
+/**
+ * Custom deep clone implementation for values that structuredClone can't
+ * handle. Used as fallback when structuredClone fails.
+ *
+ * @function
+ */
+const customDeepClone = (value) => {
+    if (value === null || typeof value !== 'object') {
+        return value;
+    }
+    if (isArray(value)) {
+        return value.map(customDeepClone);
+    }
+    if (value instanceof Error) {
+        const cloned = {};
+        for (const [key, val] of entries(value)) {
+            cloned[key] = customDeepClone(val);
+        }
+        for (const prop of getOwnPropertyNames(value)) {
+            if (!(prop in cloned)) {
+                try {
+                    cloned[prop] = value[prop];
+                }
+                catch {
+                    // Skip properties that can't be accessed
+                }
+            }
+        }
+        return cloned;
+    }
+    const cloned = {};
+    for (const [key, val] of entries(value)) {
+        cloned[key] = customDeepClone(val);
+    }
+    return cloned;
+};
+/**
+ * Deep clone a value to avoid mutating the original. Uses the native
+ * structuredClone API which handles more types and circular references better
+ * than a custom implementation. Falls back to custom implementation for values
+ * containing functions.
+ *
+ * @function
+ */
+const deepClone = (value) => {
+    try {
+        return structuredClone(value);
+    }
+    catch (error) {
+        if (error instanceof Error && error.name === 'DataCloneError') {
+            return customDeepClone(value);
+        }
+        throw error;
+    }
+};
+/**
+ * Gets a value at a specific path in an object
+ *
+ * @function
+ */
+const getValueAtPath = (obj, path) => {
+    if (path.length === 0) {
+        return obj;
+    }
+    let current = obj;
+    for (const key of path) {
+        if (current == null) {
+            return undefined;
+        }
+        current = current[key];
+    }
+    return current;
+};
+/**
+ * Returns a new object with the value at the specified path set to the given
+ * value.
+ *
+ * @function
+ */
+const setValueAtPath = (obj, path, value) => {
+    if (path.length === 0) {
+        return value;
+    }
+    if (obj == null) {
+        obj = typeof path[0] === 'number' ? [] : {};
+    }
+    const [head, ...tail] = path;
+    if (head === undefined) {
+        return obj;
+    }
+    const newValue = tail.length === 0
+        ? value
+        : setValueAtPath(obj[head], tail, value);
+    if (isArray(obj)) {
+        const result = [...obj];
+        result[head] = newValue;
+        return result;
+    }
+    let result;
+    if (obj instanceof Error) {
+        result = {};
+        for (const prop of getOwnPropertyNames(obj)) {
+            if (prop !== 'stack') {
+                // eslint-disable-next-line @typescript-eslint/no-unsafe-member-access
+                result[prop] = obj[prop];
+            }
+        }
+    }
+    else {
+        result = { ...obj };
+    }
+    result[head] = newValue;
+    return result;
+};
+//# sourceMappingURL=diff.js.map

package/dist/diff.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"diff.js","sourceRoot":"","sources":["../src/diff.ts"],"names":[],"mappings":"AAAA;;;;;;;;;GASG;AAKH,OAAO,EAAE,IAAI,EAAE,MAAM,WAAW,CAAC;AAGjC,MAAM,EAAE,OAAO,EAAE,GAAG,KAAK,CAAC;AAC1B,MAAM,EAAE,GAAG,EAAE,GAAG,IAAI,CAAC;AACrB,MAAM,EAAE,SAAS,EAAE,GAAG,IAAI,CAAC;AAC3B,MAAM,EAAE,OAAO,EAAE,mBAAmB,EAAE,GAAG,MAAM,CAAC;AAYhD;;;;;;;GAOG;AACH,MAAM,CAAC,MAAM,iBAAiB,GAAG,CAC/B,QAAoB,EACpB,OAAgB,EACJ,EAAE;IACd,IAAI,CAAC;QACH,MAAM,MAAM,GAAG,OAAO,CAAC;QAEvB,IAAI,QAAQ,GAAG,OAAO,IAAI,IAAI,CAAC,CAAC,CAAC,SAAS,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC;QAE9D,KAAK,MAAM,KAAK,IAAI,QAAQ,CAAC,MAAM,EAAE,CAAC;YACpC,IAAI,CAAC;gBACH,MAAM,YAAY,GAAG,KAAK,CAAC,IAAI,CAAC,MAAM,CACpC,CAAC,GAAG,EAA0B,EAAE,CAC9B,OAAO,GAAG,KAAK,QAAQ,IAAI,OAAO,GAAG,KAAK,QAAQ,CACrD,CAAC;gBAEF,QAAQ,KAAK,CAAC,IAAI,EAAE,CAAC;oBACnB,KAAK,QAAQ,CAAC,CAAC,CAAC;wBACd,MAAM,MAAM,GAAG,KAAK,CAAC,MAA6C,CAAC;wBAEnE,IACE,MAAM,EAAE,UAAU,KAAK,aAAa;4BACpC,YAAY,CAAC,MAAM,GAAG,CAAC,EACvB,CAAC;4BACD,MAAM,UAAU,GAAG,YAAY,CAAC,CAAC,CAAC,CAAC;4BACnC,IAAI,OAAO,QAAQ,KAAK,QAAQ,IAAI,QAAQ,KAAK,IAAI,EAAE,CAAC;gCACtD,QAAQ,GAAG;oCACT,GAAI,QAAoC;oCACxC,CAAC,UAAoB,CAAC,EAAE,SAAS;iCAClC,CAAC;4BACJ,CAAC;wBACH,CAAC;6BAAM,IAAI,YAAY,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;4BACnC,MAAM,WAAW,GAAG,cAAc,CAAC,MAAM,EAAE,YAAY,CAAC,CAAC;4BACzD,IAAI,WAAW,KAAK,SAAS,EAAE,CAAC;gCAC9B,QAAQ,GAAG,cAAc,CAAC,QAAQ,EAAE,YAAY,EAAE,SAAS,CAAC,CAAC;4BAC/D,CAAC;wBACH,CAAC;wBACD,MAAM;oBACR,CAAC;oBAED,KAAK,gBAAgB,CAAC,CAAC,CAAC;wBACtB,MAAM,WAAW,GAAG,cAAc,CAAC,MAAM,EAAE,YAAY,CAAC,CAAC;wBACzD,IAAI,cAAc,GAAG,WAAW,CAAC;wBAEjC,MAAM,UAAU,GAAG,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,cAAc,CAAC,CAAC;wBACvD,IAAI,UAAU,EAAE,CAAC;4BACf,cAAc,GAAG,oBAAoB,UAAU,CAAC,CAAC,CAAC,GAAG,CAAC;wBACxD,CAAC;6BAAM,CAAC;4BACN,cAAc,GAAG,0BAA0B,CAAC;wBAC9C,CAAC;wBAED,QAAQ,GAAG,cAAc,CAAC,QAAQ,EAAE,YAAY,EAAE,cAAc,CAAC,CAAC;wBAClE,MAAM;oBACR,CAAC;oBAED,KAAK,cAAc,CAAC,CAAC,CAAC;wBACpB,MAAM,cAAc,GAAG,yBAAyB,CAC9C,KAAK,CAAC,QAAQ,EACd,cAAc,CAAC,MAAM,EAAE,YAAY,CAAC,CACrC,CAAC;wBACF,QAAQ,GAAG,cAAc,CAAC,QAAQ,EAAE,YAAY,EAAE,cAAc,CAAC,CAAC;wBAClE,MAAM;oBACR,CAAC;oBAED,KAAK,eAAe,CAAC,CAAC,CAAC;wBACrB,4DAA4D;wBAC5D,4DAA4D;wBAC5D,gEAAgE;wBAChE,OAAO,EAAE,MAAM,EAAE,SAAS,EAAE,QAAQ,EAAE,SAAS,EAAE,CAAC;oBACpD,CAAC;oBAED,KAAK,eAAe,CAAC,CAAC,CAAC;wBACrB,2EAA2E;wBAC3E,IAAI,KAAK,CAAC,MAAM,IAAI,KAAK,CAAC,MAAM,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;4BAC5C,MAAM,cAAc,GAAG,KAAK,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC;4BACvC,QAAQ,GAAG,cAAc,CAAC,QAAQ,EAAE,YAAY,EAAE,cAAc,CAAC,CAAC;wBACpE,CAAC;6BAAM,CAAC;4BACN,+DAA+D;4BAC/D,OAAO,EAAE,MAAM,EAAE,SAAS,EAAE,QAAQ,EAAE,SAAS,EAAE,CAAC;wBACpD,CAAC;wBACD,MAAM;oBACR,CAAC;oBAED,KAAK,SAAS,CAAC,CAAC,CAAC;wBACf,MAAM,WAAW,GAAG,cAAc,CAAC,MAAM,EAAE,YAAY,CAAC,CAAC;wBACzD,IAAI,cAAc,CAAC;wBAEnB,IAAI,KAAK,CAAC,MAAM,KAAK,QAAQ,IAAI,OAAO,WAAW,KAAK,QAAQ,EAAE,CAAC;4BACjE,cAAc,GAAG,WAAW,CAAC,KAAK,CAAC,CAAC,EAAE,MAAM,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC;wBAC/D,CAAC;6BAAM,IAAI,KAAK,CAAC,MAAM,KAAK,OAAO,IAAI,OAAO,CAAC,WAAW,CAAC,EAAE,CAAC;4BAC5D,cAAc,GAAG,WAAW,CAAC,KAAK,CAAC,CAAC,EAAE,MAAM,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC;wBAC/D,CAAC;6BAAM,CAAC;4BACN,cAAc,GAAG,KAAK,CAAC,OAAO,CAAC;wBACjC,CAAC;wBAED,QAAQ,GAAG,cAAc,CAAC,QAAQ,EAAE,YAAY,EAAE,cAAc,CAAC,CAAC;wBAClE,MAAM;oBACR,CAAC;oBAED,KAAK,WAAW,CAAC,CAAC,CAAC;wBACjB,MAAM,WAAW,GAAG,cAAc,CAAC,MAAM,EAAE,YAAY,CAAC,CAAC;wBACzD,IAAI,cAAc,CAAC;wBAEnB,IAAI,KAAK,CAAC,MAAM,KAAK,QAAQ,IAAI,OAAO,WAAW,KAAK,QAAQ,EAAE,CAAC;4BACjE,MAAM,MAAM,GAAG,MAAM,CAAC,KAAK,CAAC,OAAO,CAAC,GAAG,WAAW,CAAC,MAAM,CAAC;4BAC1D,cAAc,GAAG,WAAW,GAAG,GAAG,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,EAAE,MAAM,CAAC,CAAC,CAAC;wBAC5D,CAAC;6BAAM,IAAI,KAAK,CAAC,MAAM,KAAK,OAAO,IAAI,OAAO,CAAC,WAAW,CAAC,EAAE,CAAC;4BAC5D,MAAM,MAAM,GAAG,MAAM,CAAC,KAAK,CAAC,OAAO,CAAC,GAAG,WAAW,CAAC,MAAM,CAAC;4BAC1D,cAAc,GAAG,WAAW,CAAC,MAAM,CACjC,IAAI,KAAK,CAAC,GAAG,CAAC,CAAC,EAAE,MAAM,CAAC,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,CACrC,CAAC;wBACJ,CAAC;6BAAM,CAAC;4BACN,cAAc,GAAG,KAAK,CAAC,OAAO,CAAC;wBACjC,CAAC;wBAED,QAAQ,GAAG,cAAc,CAAC,QAAQ,EAAE,YAAY,EAAE,cAAc,CAAC,CAAC;wBAClE,MAAM;oBACR,CAAC;oBAED,KAAK,mBAAmB,CAAC,CAAC,CAAC;wBACzB,IACE,YAAY,CAAC,MAAM,KAAK,CAAC;4BACzB,OAAO,QAAQ,KAAK,QAAQ;4BAC5B,QAAQ,KAAK,IAAI,EACjB,CAAC;4BACD,MAAM,YAAY,GAAG;gCACnB,GAAI,QAAoC;6BACzC,CAAC;4BACF,KAAK,MAAM,GAAG,IAAI,KAAK,CAAC,IAAI,EAAE,CAAC;gCAC7B,OAAO,YAAY,CAAC,GAAG,CAAC,CAAC;4BAC3B,CAAC;4BACD,QAAQ,GAAG,YAAY,CAAC;wBAC1B,CAAC;wBACD,MAAM;oBACR,CAAC;oBAED,OAAO,CAAC,CAAC,CAAC;wBACR,MAAM;oBACR,CAAC;gBACH,CAAC;YACH,CAAC;YAAC,MAAM,CAAC;gBACP,SAAS;YACX,CAAC;QACH,CAAC;QAED,OAAO,EAAE,MAAM,EAAE,QAAQ,EAAE,CAAC;IAC9B,CAAC;IAAC,MAAM,CAAC;QACP,OAAO,EAAE,MAAM,EAAE,SAAS,EAAE,QAAQ,EAAE,SAAS,EAAE,CAAC;IACpD,CAAC;AACH,CAAC,CAAC;AAEF;;;;;;;;GAQG;AACH,MAAM,CAAC,MAAM,YAAY,GAAG,CAC1B,QAAiB,EACjB,MAAe,EACf,UAAuB,EAAE,EACV,EAAE;IACjB,IAAI,CAAC,kBAAkB,CAAC,MAAM,EAAE,QAAQ,CAAC,EAAE,CAAC;QAC1C,OAAO,IAAI,CAAC;IACd,CAAC;IAED,OAAO,IAAI,CAAC,QAAQ,EAAE,MAAM,EAAE;QAC5B,WAAW,EAAE,UAAU;QACvB,WAAW,EAAE,QAAQ;QACrB,MAAM,EAAE,KAAK;QACb,mBAAmB,EAAE,IAAI;QACzB,GAAG,OAAO;KACX,CAAC,CAAC;AACL,CAAC,CAAC;AAEF;;;;;;;GAOG;AACH,MAAM,CAAC,MAAM,kBAAkB,GAAG,CAChC,MAAe,EACf,QAAiB,EACR,EAAE,CACX,MAAM,KAAK,SAAS,IAAI,QAAQ,KAAK,SAAS,IAAI,MAAM,KAAK,QAAQ,CAAC;AAExE;;;;GAIG;AACH,MAAM,yBAAyB,GAAG,CAChC,YAAoB,EACpB,WAAoB,EACX,EAAE;IACX,QAAQ,YAAY,EAAE,CAAC;QACrB,KAAK,OAAO;YACV,OAAO,OAAO,CAAC,WAAW,CAAC,CAAC,CAAC,CAAC,WAAW,CAAC,CAAC,CAAC,EAAE,CAAC;QACjD,KAAK,SAAS;YACZ,OAAO,OAAO,WAAW,KAAK,SAAS;gBACrC,CAAC,CAAC,WAAW;gBACb,CAAC,CAAC,OAAO,CAAC,WAAW,CAAC,CAAC;QAC3B,KAAK,MAAM;YACT,OAAO,IAAI,CAAC;QACd,KAAK,QAAQ;YACX,OAAO,OAAO,WAAW,KAAK,QAAQ;gBACpC,CAAC,CAAC,WAAW;gBACb,CAAC,CAAC,MAAM,CAAC,WAAW,CAAC,IAAI,CAAC,CAAC;QAC/B,KAAK,QAAQ;YACX,OAAO,OAAO,WAAW,KAAK,QAAQ,IAAI,WAAW,KAAK,IAAI;gBAC5D,CAAC,CAAC,WAAW;gBACb,CAAC,CAAC,EAAE,CAAC;QACT,KAAK,QAAQ;YACX,IAAI,OAAO,WAAW,KAAK,QAAQ,EAAE,CAAC;gBACpC,OAAO,WAAW,CAAC;YACrB,CAAC;YACD,IAAI,WAAW,IAAI,IAAI,EAAE,CAAC;gBACxB,OAAO,EAAE,CAAC;YACZ,CAAC;YACD,IAAI,OAAO,WAAW,KAAK,QAAQ,EAAE,CAAC;gBACpC,OAAO,SAAS,CAAC,WAAW,CAAC,CAAC;YAChC,CAAC;YACD,gEAAgE;YAChE,OAAO,GAAG,WAAW,EAAE,CAAC;QAC1B,KAAK,WAAW;YACd,OAAO,SAAS,CAAC;QACnB;YACE,OAAO,IAAI,YAAY,GAAG,CAAC;IAC/B,CAAC;AACH,CAAC,CAAC;AAEF;;;;;GAKG;AACH,MAAM,eAAe,GAAG,CAAC,KAAc,EAAW,EAAE;IAClD,IAAI,KAAK,KAAK,IAAI,IAAI,OAAO,KAAK,KAAK,QAAQ,EAAE,CAAC;QAChD,OAAO,KAAK,CAAC;IACf,CAAC;IACD,IAAI,OAAO,CAAC,KAAK,CAAC,EAAE,CAAC;QACnB,OAAO,KAAK,CAAC,GAAG,CAAC,eAAe,CAAC,CAAC;IACpC,CAAC;IAED,IAAI,KAAK,YAAY,KAAK,EAAE,CAAC;QAC3B,MAAM,MAAM,GAA4B,EAAE,CAAC;QAC3C,KAAK,MAAM,CAAC,GAAG,EAAE,GAAG,CAAC,IAAI,OAAO,CAAC,KAAK,CAAC,EAAE,CAAC;YACxC,MAAM,CAAC,GAAG,CAAC,GAAG,eAAe,CAAC,GAAG,CAAC,CAAC;QACrC,CAAC;QACD,KAAK,MAAM,IAAI,IAAI,mBAAmB,CAAC,KAAK,CAAC,EAAE,CAAC;YAC9C,IAAI,CAAC,CAAC,IAAI,IAAI,MAAM,CAAC,EAAE,CAAC;gBACtB,IAAI,CAAC;oBACH,MAAM,CAAC,IAAI,CAAC,GAAI,KAA4C,CAAC,IAAI,CAAC,CAAC;gBACrE,CAAC;gBAAC,MAAM,CAAC;oBACP,yCAAyC;gBAC3C,CAAC;YACH,CAAC;QACH,CAAC;QACD,OAAO,MAAM,CAAC;IAChB,CAAC;IAED,MAAM,MAAM,GAA4B,EAAE,CAAC;IAC3C,KAAK,MAAM,CAAC,GAAG,EAAE,GAAG,CAAC,IAAI,OAAO,CAAC,KAAK,CAAC,EAAE,CAAC;QACxC,MAAM,CAAC,GAAG,CAAC,GAAG,eAAe,CAAC,GAAG,CAAC,CAAC;IACrC,CAAC;IACD,OAAO,MAAM,CAAC;AAChB,CAAC,CAAC;AAEF;;;;;;;GAOG;AACH,MAAM,SAAS,GAAG,CAAC,KAAc,EAAW,EAAE;IAC5C,IAAI,CAAC;QACH,OAAO,eAAe,CAAC,KAAK,CAAC,CAAC;IAChC,CAAC;IAAC,OAAO,KAAK,EAAE,CAAC;QACf,IAAI,KAAK,YAAY,KAAK,IAAI,KAAK,CAAC,IAAI,KAAK,gBAAgB,EAAE,CAAC;YAC9D,OAAO,eAAe,CAAC,KAAK,CAAC,CAAC;QAChC,CAAC;QACD,MAAM,KAAK,CAAC;IACd,CAAC;AACH,CAAC,CAAC;AAEF;;;;GAIG;AACH,MAAM,cAAc,GAAG,CACrB,GAAY,EACZ,IAAkC,EACzB,EAAE;IACX,IAAI,IAAI,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;QACtB,OAAO,GAAG,CAAC;IACb,CAAC;IAED,IAAI,OAAO,GAAG,GAAG,CAAC;IAClB,KAAK,MAAM,GAAG,IAAI,IAAI,EAAE,CAAC;QACvB,IAAI,OAAO,IAAI,IAAI,EAAE,CAAC;YACpB,OAAO,SAAS,CAAC;QACnB,CAAC;QACD,OAAO,GAAI,OAA4C,CAAC,GAAG,CAAC,CAAC;IAC/D,CAAC;IACD,OAAO,OAAO,CAAC;AACjB,CAAC,CAAC;AAEF;;;;;GAKG;AACH,MAAM,cAAc,GAAG,CACrB,GAAY,EACZ,IAAkC,EAClC,KAAc,EACL,EAAE;IACX,IAAI,IAAI,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;QACtB,OAAO,KAAK,CAAC;IACf,CAAC;IAED,IAAI,GAAG,IAAI,IAAI,EAAE,CAAC;QAChB,GAAG,GAAG,OAAO,IAAI,CAAC,CAAC,CAAC,KAAK,QAAQ,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;IAC9C,CAAC;IAED,MAAM,CAAC,IAAI,EAAE,GAAG,IAAI,CAAC,GAAG,IAAI,CAAC;IAC7B,IAAI,IAAI,KAAK,SAAS,EAAE,CAAC;QACvB,OAAO,GAAG,CAAC;IACb,CAAC;IAED,MAAM,QAAQ,GACZ,IAAI,CAAC,MAAM,KAAK,CAAC;QACf,CAAC,CAAC,KAAK;QACP,CAAC,CAAC,cAAc,CACX,GAAwC,CAAC,IAAI,CAAC,EAC/C,IAAI,EACJ,KAAK,CACN,CAAC;IAER,IAAI,OAAO,CAAC,GAAG,CAAC,EAAE,CAAC;QACjB,MAAM,MAAM,GAAG,CAAC,GAAI,GAAiB,CAAC,CAAC;QACvC,MAAM,CAAC,IAAc,CAAC,GAAG,QAAQ,CAAC;QAClC,OAAO,MAAM,CAAC;IAChB,CAAC;IAED,IAAI,MAAwC,CAAC;IAC7C,IAAI,GAAG,YAAY,KAAK,EAAE,CAAC;QACzB,MAAM,GAAG,EAAE,CAAC;QACZ,KAAK,MAAM,IAAI,IAAI,mBAAmB,CAAC,GAAG,CAAC,EAAE,CAAC;YAC5C,IAAI,IAAI,KAAK,OAAO,EAAE,CAAC;gBACrB,sEAAsE;gBACtE,MAAM,CAAC,IAAI,CAAC,GAAI,GAAW,CAAC,IAAI,CAAC,CAAC;YACpC,CAAC;QACH,CAAC;IACH,CAAC;SAAM,CAAC;QACN,MAAM,GAAG,EAAE,GAAI,GAA+B,EAAE,CAAC;IACnD,CAAC;IAED,MAAM,CAAC,IAAI,CAAC,GAAG,QAAQ,CAAC;IACxB,OAAO,MAAM,CAAC;AAChB,CAAC,CAAC"}

package/dist/error.cjs

@@ -0,0 +1,194 @@
+"use strict";
+/**
+ * Error types thrown by _BUPKIS_, including {@link AssertionError}.
+ *
+ * @privateRemarks
+ * Other custom errors should go here.
+ * @packageDocumentation
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.UnknownAssertionError = exports.UnexpectedAsyncError = exports.SatisfactionError = exports.NegatedAssertionError = exports.InvalidObjectSchemaError = exports.InvalidMetadataError = exports.FailAssertionError = exports.AssertionImplementationError = exports.BupkisError = exports.AssertionError = void 0;
+const node_assert_1 = require("node:assert");
+const constant_js_1 = require("./constant.cjs");
+const guards_js_1 = require("./guards.cjs");
+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
+ */
+class AssertionError extends node_assert_1.AssertionError {
+    /**
+     * Assertion ID of the assertion that caused this error.
+     */
+    assertionId;
+    /**
+     * @internal
+     */
+    [constant_js_1.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) => (0, guards_js_1.isA)(value, node_assert_1.AssertionError) && hasOwn(value, constant_js_1.kBupkisAssertionError);
+    toJSON() {
+        return {
+            actual: this.actual,
+            expected: this.expected,
+            message: this.message,
+            name: this.name,
+            stack: this.stack,
+        };
+    }
+}
+exports.AssertionError = AssertionError;
+/**
+ * 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
+ */
+class BupkisError extends Error {
+    [constant_js_1.kBupkisError] = true;
+    name = 'BupkisError';
+    static isBupkisError = (err) => (0, guards_js_1.isA)(err, Error) && hasOwn(err, constant_js_1.kBupkisError);
+}
+exports.BupkisError = BupkisError;
+/**
+ * Error type used when an assertion implementation throws an error (this likely
+ * means there's a bug in the assertion implementation).
+ *
+ * @group Errors
+ */
+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) => (0, guards_js_1.isA)(err, AssertionImplementationError);
+}
+exports.AssertionImplementationError = AssertionImplementationError;
+/**
+ * Variant of an {@link AssertionError} that is thrown when
+ * {@link bupkis!expect.fail} is called.
+ *
+ * @group Errors
+ */
+class FailAssertionError extends AssertionError {
+    /**
+     * @internal
+     */
+    [constant_js_1.kBupkisFailAssertionError] = true;
+    name = 'FailAssertionError';
+    constructor(options) {
+        super({ ...options, id: constant_js_1.FAIL });
+    }
+    static isFailAssertionError = (err) => (0, guards_js_1.isA)(err, FailAssertionError) && hasOwn(err, constant_js_1.kBupkisFailAssertionError);
+}
+exports.FailAssertionError = FailAssertionError;
+/**
+ * Error type used when assertion metadata is invalid.
+ *
+ * @remarks
+ * This should never be thrown unless someone monkeyed with the metadata
+ * registry.
+ * @group Errors
+ */
+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;
+    }
+}
+exports.InvalidMetadataError = InvalidMetadataError;
+/**
+ * Thrown from certain assertions when a parameter cannot be used as an "object
+ * schema"
+ *
+ * @group Errors
+ */
+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;
+    }
+}
+exports.InvalidObjectSchemaError = InvalidObjectSchemaError;
+/**
+ * Error type used internally to catch failed negated assertions.
+ *
+ * @group Errors
+ */
+class NegatedAssertionError extends AssertionError {
+    [constant_js_1.kBupkisNegatedAssertionError] = true;
+    name = 'NegatedAssertionError';
+    static isNegatedAssertionError = (err) => (0, guards_js_1.isA)(err, AssertionError) && hasOwn(err, constant_js_1.kBupkisNegatedAssertionError);
+}
+exports.NegatedAssertionError = 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
+ */
+class SatisfactionError extends BupkisError {
+    code = 'ERR_BUPKIS_SATISFACTION';
+    name = 'SatisfactionError';
+    constructor(message, options = {}) {
+        super(message, options);
+    }
+}
+exports.SatisfactionError = SatisfactionError;
+/**
+ * Thrown when `expect()` is called with something async.
+ *
+ * @group Errors
+ */
+class UnexpectedAsyncError extends BupkisError {
+    code = 'ERR_BUPKIS_UNEXPECTED_ASYNC';
+    name = 'UnexpectedAsyncError';
+}
+exports.UnexpectedAsyncError = UnexpectedAsyncError;
+/**
+ * Thrown when we cannot match the parameters to {@link bupkis!expect | expect}
+ * or {@link bupkis!expectAsync | expectAsync} to any known assertion.
+ *
+ * @group Errors
+ */
+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;
+    }
+}
+exports.UnknownAssertionError = UnknownAssertionError;
+//# sourceMappingURL=error.js.map

package/dist/error.cjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"error.js","sourceRoot":"","sources":["../src/error.ts"],"names":[],"mappings":";AAAA;;;;;;GAMG;;;AAEH,6CAAmE;AAGnE,gDAMuB;AACvB,4CAAkC;AAElC,MAAM,EAAE,MAAM,EAAE,GAAG,MAAM,CAAC;AAqE1B;;;;;;GAMG;AACH,MAAa,cAAe,SAAQ,4BAAkB;IACpD;;OAEG;IACM,WAAW,CAAkC;IAEtD;;OAEG;IACH,CAAC,mCAAqB,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,IAAA,eAAG,EAAC,KAAK,EAAE,4BAAkB,CAAC,IAAI,MAAM,CAAC,KAAK,EAAE,mCAAqB,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;;AAnCH,wCAoCC;AAED;;;;;;;GAOG;AACH,MAAa,WAAY,SAAQ,KAAK;IACpC,CAAC,0BAAY,CAAC,GAAG,IAAI,CAAC;IAEb,IAAI,GAAG,aAAa,CAAC;IAE9B,MAAM,CAAC,aAAa,GAAG,CAAC,GAAY,EAAsB,EAAE,CAC1D,IAAA,eAAG,EAAC,GAAG,EAAE,KAAK,CAAC,IAAI,MAAM,CAAC,GAAG,EAAE,0BAAY,CAAC,CAAC;;AANjD,kCAOC;AAED;;;;;GAKG;AACH,MAAa,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,IAAA,eAAG,EAAC,GAAG,EAAE,4BAA4B,CAAC,CAAC;;AAnB3C,oEAoBC;AAED;;;;;GAKG;AACH,MAAa,kBAAmB,SAAQ,cAAc;IACpD;;OAEG;IACH,CAAC,uCAAyB,CAAC,GAAG,IAAI,CAAC;IAE1B,IAAI,GAAG,oBAAoB,CAAC;IAErC,YAAY,OAAmC;QAC7C,KAAK,CAAC,EAAE,GAAG,OAAO,EAAE,EAAE,EAAE,kBAAI,EAAE,CAAC,CAAC;IAClC,CAAC;IAED,MAAM,CAAC,oBAAoB,GAAG,CAAC,GAAY,EAA6B,EAAE,CACxE,IAAA,eAAG,EAAC,GAAG,EAAE,kBAAkB,CAAC,IAAI,MAAM,CAAC,GAAG,EAAE,uCAAyB,CAAC,CAAC;;AAb3E,gDAcC;AAED;;;;;;;GAOG;AACH,MAAa,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;AAZD,oDAYC;AAED;;;;;GAKG;AACH,MAAa,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;AAZD,4DAYC;AAED;;;;GAIG;AACH,MAAa,qBAAsB,SAAQ,cAAc;IACvD,CAAC,0CAA4B,CAAC,GAAG,IAAI,CAAC;IAE7B,IAAI,GAAG,uBAAuB,CAAC;IAExC,MAAM,CAAC,uBAAuB,GAAG,CAC/B,GAAY,EACkB,EAAE,CAChC,IAAA,eAAG,EAAC,GAAG,EAAE,cAAc,CAAC,IAAI,MAAM,CAAC,GAAG,EAAE,0CAA4B,CAAC,CAAC;;AAR1E,sDASC;AAED;;;;;;;GAOG;AACH,MAAa,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;AARD,8CAQC;AAED;;;;GAIG;AACH,MAAa,oBAAqB,SAAQ,WAAW;IAC1C,IAAI,GAAG,6BAA6B,CAAC;IAErC,IAAI,GAAG,sBAAsB,CAAC;CACxC;AAJD,oDAIC;AAED;;;;;GAKG;AACH,MAAa,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;AAdD,sDAcC"}