bupkis 0.18.2 → 1.0.0

package/dist/assertion/assertion-sync.cjs

@@ -0,0 +1,281 @@
+"use strict";
+/**
+ * Synchronous assertion subclasses.
+ *
+ * @packageDocumentation
+ * @see {@link AssertionFunctionSync} for function-based assertions
+ * @see {@link AssertionSchemaSync} for schema-based assertions
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.BupkisAssertionSchemaSync = exports.BupkisAssertionFunctionSync = exports.BupkisAssertionSync = void 0;
+const obug_1 = require("obug");
+const util_1 = require("util");
+const zod_1 = require("zod");
+const error_js_1 = require("../error.cjs");
+const guards_js_1 = require("../guards.cjs");
+const internal_schema_js_1 = require("../internal-schema.cjs");
+const assertion_js_1 = require("./assertion.cjs");
+const format_assertion_failure_js_1 = require("./format-assertion-failure.cjs");
+const debug = (0, obug_1.createDebug)('bupkis:assertion:sync');
+/**
+ * Abstract class for synchronous assertions.
+ *
+ * Child classes are expected to implement {@link execute}.
+ */
+class BupkisAssertionSync extends assertion_js_1.BupkisAssertion {
+    /**
+     * Parses raw arguments against the slots of this assertion to determine if
+     * this assertion should be executed against those arguments.
+     *
+     * For example, if an assertion wants the subject to be a `z.string()`, then
+     * this will validate that the first raw arg parses as a string. It will also
+     * validate Phrase Literals as well, such as "to be a string". If all slots
+     * match and none of the slots are "unknown" or "any", then `exactMatch` will
+     * be true.
+     *
+     * If any slot does not match, this returns `success: false`.
+     *
+     * @param args Raw arguments
+     * @returns Result of parsing attempt
+     */
+    parseValues(args) {
+        const { slots } = this;
+        const parsedValues = [];
+        const mismatch = this.maybeParseValuesArgMismatch(args);
+        if (mismatch) {
+            return mismatch;
+        }
+        let exactMatch = true;
+        for (let i = 0; i < slots.length; i++) {
+            const slot = slots[i];
+            const arg = args[i];
+            const parsedLiteralResult = this.parseSlotForLiteral(slot, i, arg);
+            if (parsedLiteralResult === true) {
+                continue;
+            }
+            else if (parsedLiteralResult !== false) {
+                return parsedLiteralResult;
+            }
+            // unknown/any accept anything
+            // IMPORTANT: do not use a type guard here
+            if (slot.def.type === 'unknown' || slot.def.type === 'any') {
+                parsedValues.push(arg);
+                exactMatch = false;
+                continue;
+            }
+            const result = slot.safeParse(arg);
+            if (!result.success) {
+                return {
+                    success: false,
+                };
+            }
+            parsedValues.push(arg);
+        }
+        return {
+            exactMatch,
+            parsedValues: parsedValues,
+            success: true,
+        };
+    }
+}
+exports.BupkisAssertionSync = BupkisAssertionSync;
+class BupkisAssertionFunctionSync extends BupkisAssertionSync {
+    execute(parsedValues, args, stackStartFn, _parseResult) {
+        let result;
+        try {
+            result = this.impl.call(null, 
+            // eslint-disable-next-line @typescript-eslint/no-unsafe-argument
+            ...parsedValues);
+        }
+        catch (err) {
+            if (error_js_1.AssertionError.isAssertionError(err)) {
+                throw err;
+            }
+            if ((0, guards_js_1.isError)(err) && err instanceof zod_1.z.ZodError) {
+                throw this.fromZodError(err, stackStartFn, parsedValues);
+            }
+            throw new error_js_1.AssertionImplementationError(`Unexpected error thrown from assertion ${this}: ${err}`, { cause: err });
+        }
+        if ((0, guards_js_1.isPromiseLike)(result)) {
+            // Avoid unhandled promise rejection
+            Promise.resolve(result).catch((err) => {
+                debug(`⚠️ Ate unhandled rejection from assertion %s: %O`, this, err);
+            });
+            throw new error_js_1.UnexpectedAsyncError(`Assertion ${this} returned a Promise; use expectAsync() instead of expect()`);
+        }
+        if ((0, guards_js_1.isZodType)(result)) {
+            const zodResult = result.safeParse(parsedValues[0]);
+            if (!zodResult.success) {
+                throw this.fromZodError(zodResult.error, stackStartFn, parsedValues);
+            }
+        }
+        else if ((0, guards_js_1.isStandardSchema)(result)) {
+            const validationResult = result['~standard'].validate(parsedValues[0]);
+            if (validationResult instanceof Promise) {
+                validationResult.catch(() => {
+                    /* prevent unhandled rejection */
+                });
+                throw new error_js_1.UnexpectedAsyncError(`Standard Schema returned a Promise; use expectAsync() instead of expect()`);
+            }
+            if (validationResult.issues) {
+                throw this.fromStandardSchemaIssues(validationResult.issues, stackStartFn, parsedValues);
+            }
+        }
+        else if ((0, guards_js_1.isBoolean)(result)) {
+            if (!result) {
+                throw new error_js_1.AssertionError({
+                    id: this.id,
+                    message: `Assertion ${this} failed for arguments: ${(0, util_1.inspect)(args)}`,
+                });
+            }
+        }
+        else if ((0, guards_js_1.isError)(result) && result instanceof zod_1.z.ZodError) {
+            throw this.fromZodError(result, stackStartFn, parsedValues);
+        }
+        else if ((0, internal_schema_js_1.isAssertionParseRequest)(result)) {
+            const { asyncSchema, schema, subject } = result;
+            if (asyncSchema) {
+                throw new error_js_1.AssertionImplementationError(`Sync assertion ${this} returned an async schema in its AssertionParseRequest`);
+            }
+            if (!schema) {
+                throw new error_js_1.AssertionImplementationError(`Sync assertion ${this} returned AssertionParseRequest without schema`);
+            }
+            if ((0, guards_js_1.isZodType)(schema)) {
+                const zodResult = schema.safeParse(subject);
+                if (!zodResult.success) {
+                    throw this.fromZodError(zodResult.error, stackStartFn, subject);
+                }
+            }
+            else if ((0, guards_js_1.isStandardSchema)(schema)) {
+                const validationResult = schema['~standard'].validate(subject);
+                if (validationResult instanceof Promise) {
+                    validationResult.catch(() => {
+                        /* prevent unhandled rejection */
+                    });
+                    throw new error_js_1.AssertionImplementationError(`Sync assertion ${this} returned a schema with async validation in AssertionParseRequest`);
+                }
+                if (validationResult.issues) {
+                    throw this.fromStandardSchemaIssues(validationResult.issues, stackStartFn, subject);
+                }
+            }
+        }
+        else if ((0, internal_schema_js_1.isAssertionFailure)(result)) {
+            const diffOutput = (0, format_assertion_failure_js_1.formatAssertionFailure)(result);
+            const baseMessage = result.message ??
+                `Assertion ${this} failed for arguments: ${(0, util_1.inspect)(args)}`;
+            const message = diffOutput
+                ? `${baseMessage}\n${diffOutput}`
+                : baseMessage;
+            throw new error_js_1.AssertionError({
+                actual: result.actual,
+                expected: result.expected,
+                id: this.id,
+                message,
+            });
+        }
+        else if (result) {
+            throw new error_js_1.AssertionImplementationError(`Invalid return type from assertion ${this}; expected boolean, ZodType, or AssertionFailure`, { result });
+        }
+    }
+}
+exports.BupkisAssertionFunctionSync = BupkisAssertionFunctionSync;
+/**
+ * A class representing an assertion implemented as a function.
+ *
+ * This function may:
+ *
+ * 1. Return a `boolean` indicating pass/fail.
+ * 2. Return a `ZodType` which will be used to validate the subject.
+ * 3. Return a `Promise` resolving to either of the above (when called via
+ *    {@link expectAsync})
+ * 4. Throw a {@link AssertionError}; when called via {@link expectAsync}, reject
+ *    with an {@link AssertionError}
+ */
+class BupkisAssertionSchemaSync extends BupkisAssertionSync {
+    execute(parsedValues, _args, stackStartFn, parseResult) {
+        // Check if we have cached validation result from parseValues
+        const cachedValidation = parseResult?.success
+            ? parseResult.subjectValidationResult
+            : undefined;
+        if (cachedValidation) {
+            if (!cachedValidation.success) {
+                if ('error' in cachedValidation) {
+                    throw this.fromZodError(cachedValidation.error, stackStartFn, parsedValues);
+                }
+                else if ('issues' in cachedValidation) {
+                    throw this.fromStandardSchemaIssues(cachedValidation.issues, stackStartFn, parsedValues);
+                }
+            }
+            // Subject validation passed, nothing more to do
+            return;
+        }
+        // Fall back to standard validation if no cached result
+        const [subject] = parsedValues;
+        const result = this.impl.safeParse(subject);
+        if (!result.success) {
+            throw this.fromZodError(result.error, stackStartFn, parsedValues);
+        }
+    }
+    parseValues(args) {
+        const { slots } = this;
+        const parsedValues = [];
+        const mismatch = this.maybeParseValuesArgMismatch(args);
+        if (mismatch) {
+            return mismatch;
+        }
+        let exactMatch = true;
+        let subjectValidationResult;
+        for (let i = 0; i < slots.length; i++) {
+            const slot = slots[i];
+            const arg = args[i];
+            const parsedLiteralResult = this.parseSlotForLiteral(slot, i, arg);
+            if (parsedLiteralResult === true) {
+                continue;
+            }
+            else if (parsedLiteralResult !== false) {
+                return parsedLiteralResult;
+            }
+            // For the subject slot (first slot if it's unknown/any), try optimized validation
+            if (i === 0 &&
+                (slot.def.type === 'unknown' || slot.def.type === 'any') &&
+                this.isSimpleSchemaAssertion()) {
+                const result = this.impl.safeParse(arg);
+                if (result.success) {
+                    subjectValidationResult = { data: result.data, success: true };
+                    parsedValues.push(result.data); // Use validated data
+                }
+                else {
+                    subjectValidationResult = { error: result.error, success: false };
+                    parsedValues.push(arg); // Keep original for error reporting
+                }
+                exactMatch = false; // Subject was validated, so we know the exact type
+                continue;
+            }
+            // Standard slot processing for non-optimized cases
+            if (slot.def.type === 'unknown' || slot.def.type === 'any') {
+                parsedValues.push(arg);
+                exactMatch = false;
+                continue;
+            }
+            const result = slot.safeParse(arg);
+            if (!result.success) {
+                return {
+                    success: false,
+                };
+            }
+            parsedValues.push(arg);
+        }
+        const result = {
+            exactMatch,
+            parsedValues: parsedValues,
+            success: true,
+        };
+        // Add cached validation result if we performed optimization
+        if (subjectValidationResult) {
+            result.subjectValidationResult = subjectValidationResult;
+        }
+        return result;
+    }
+}
+exports.BupkisAssertionSchemaSync = BupkisAssertionSchemaSync;
+//# sourceMappingURL=assertion-sync.js.map

package/dist/assertion/assertion-sync.cjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"assertion-sync.js","sourceRoot":"","sources":["../../src/assertion/assertion-sync.ts"],"names":[],"mappings":";AAAA;;;;;;GAMG;;;AAEH,+BAAmC;AACnC,+BAA+B;AAC/B,6BAAwB;AAExB,2CAIqB;AACrB,6CAMsB;AACtB,+DAG+B;AAe/B,kDAAiD;AACjD,gFAAuE;AAEvE,MAAM,KAAK,GAAG,IAAA,kBAAW,EAAC,uBAAuB,CAAC,CAAC;AAEnD;;;;GAIG;AACH,MAAsB,mBAKpB,SAAQ,8BAAmC;IAiB3C;;;;;;;;;;;;;;OAcG;IACH,WAAW,CACT,IAAU;QAEV,MAAM,EAAE,KAAK,EAAE,GAAG,IAAI,CAAC;QACvB,MAAM,YAAY,GAAU,EAAE,CAAC;QAE/B,MAAM,QAAQ,GAAG,IAAI,CAAC,2BAA2B,CAAC,IAAI,CAAC,CAAC;QACxD,IAAI,QAAQ,EAAE,CAAC;YACb,OAAO,QAAQ,CAAC;QAClB,CAAC;QAED,IAAI,UAAU,GAAG,IAAI,CAAC;QACtB,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,KAAK,CAAC,MAAM,EAAE,CAAC,EAAE,EAAE,CAAC;YACtC,MAAM,IAAI,GAAG,KAAK,CAAC,CAAC,CAAE,CAAC;YACvB,MAAM,GAAG,GAAG,IAAI,CAAC,CAAC,CAAC,CAAC;YAEpB,MAAM,mBAAmB,GAAG,IAAI,CAAC,mBAAmB,CAAC,IAAI,EAAE,CAAC,EAAE,GAAG,CAAC,CAAC;YACnE,IAAI,mBAAmB,KAAK,IAAI,EAAE,CAAC;gBACjC,SAAS;YACX,CAAC;iBAAM,IAAI,mBAAmB,KAAK,KAAK,EAAE,CAAC;gBACzC,OAAO,mBAAmB,CAAC;YAC7B,CAAC;YAED,8BAA8B;YAC9B,0CAA0C;YAC1C,IAAI,IAAI,CAAC,GAAG,CAAC,IAAI,KAAK,SAAS,IAAI,IAAI,CAAC,GAAG,CAAC,IAAI,KAAK,KAAK,EAAE,CAAC;gBAC3D,YAAY,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;gBACvB,UAAU,GAAG,KAAK,CAAC;gBACnB,SAAS;YACX,CAAC;YAED,MAAM,MAAM,GAAG,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC,CAAC;YACnC,IAAI,CAAC,MAAM,CAAC,OAAO,EAAE,CAAC;gBACpB,OAAO;oBACL,OAAO,EAAE,KAAK;iBACf,CAAC;YACJ,CAAC;YAED,YAAY,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;QACzB,CAAC;QACD,OAAO;YACL,UAAU;YACV,YAAY,EAAE,YAA8C;YAC5D,OAAO,EAAE,IAAI;SACd,CAAC;IACJ,CAAC;CACF;AAnFD,kDAmFC;AAED,MAAa,2BAKX,SAAQ,mBAAuC;IAGtC,OAAO,CACd,YAAiC,EACjC,IAAe,EACf,YAAqC,EACrC,YAAkC;QAElC,IAAI,MAAwC,CAAC;QAC7C,IAAI,CAAC;YACH,MAAM,GAAI,IAAI,CAAC,IAAmC,CAAC,IAAI,CACrD,IAAI;YACJ,iEAAiE;YACjE,GAAI,YAAoB,CACzB,CAAC;QACJ,CAAC;QAAC,OAAO,GAAG,EAAE,CAAC;YACb,IAAI,yBAAc,CAAC,gBAAgB,CAAC,GAAG,CAAC,EAAE,CAAC;gBACzC,MAAM,GAAG,CAAC;YACZ,CAAC;YACD,IAAI,IAAA,mBAAO,EAAC,GAAG,CAAC,IAAI,GAAG,YAAY,OAAC,CAAC,QAAQ,EAAE,CAAC;gBAC9C,MAAM,IAAI,CAAC,YAAY,CAAC,GAAG,EAAE,YAAY,EAAE,YAAY,CAAC,CAAC;YAC3D,CAAC;YACD,MAAM,IAAI,uCAA4B,CACpC,0CAA0C,IAAI,KAAK,GAAG,EAAE,EACxD,EAAE,KAAK,EAAE,GAAG,EAAE,CACf,CAAC;QACJ,CAAC;QACD,IAAI,IAAA,yBAAa,EAAC,MAAM,CAAC,EAAE,CAAC;YAC1B,oCAAoC;YACpC,OAAO,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC,KAAK,CAAC,CAAC,GAAG,EAAE,EAAE;gBACpC,KAAK,CAAC,kDAAkD,EAAE,IAAI,EAAE,GAAG,CAAC,CAAC;YACvE,CAAC,CAAC,CAAC;YAEH,MAAM,IAAI,+BAAoB,CAC5B,aAAa,IAAI,4DAA4D,CAC9E,CAAC;QACJ,CAAC;QACD,IAAI,IAAA,qBAAS,EAAC,MAAM,CAAC,EAAE,CAAC;YACtB,MAAM,SAAS,GAAG,MAAM,CAAC,SAAS,CAAC,YAAY,CAAC,CAAC,CAAC,CAAC,CAAC;YACpD,IAAI,CAAC,SAAS,CAAC,OAAO,EAAE,CAAC;gBACvB,MAAM,IAAI,CAAC,YAAY,CAAC,SAAS,CAAC,KAAK,EAAE,YAAY,EAAE,YAAY,CAAC,CAAC;YACvE,CAAC;QACH,CAAC;aAAM,IAAI,IAAA,4BAAgB,EAAC,MAAM,CAAC,EAAE,CAAC;YACpC,MAAM,gBAAgB,GAAG,MAAM,CAAC,WAAW,CAAC,CAAC,QAAQ,CAAC,YAAY,CAAC,CAAC,CAAC,CAAC,CAAC;YACvE,IAAI,gBAAgB,YAAY,OAAO,EAAE,CAAC;gBACxC,gBAAgB,CAAC,KAAK,CAAC,GAAG,EAAE;oBAC1B,iCAAiC;gBACnC,CAAC,CAAC,CAAC;gBACH,MAAM,IAAI,+BAAoB,CAC5B,2EAA2E,CAC5E,CAAC;YACJ,CAAC;YACD,IAAI,gBAAgB,CAAC,MAAM,EAAE,CAAC;gBAC5B,MAAM,IAAI,CAAC,wBAAwB,CACjC,gBAAgB,CAAC,MAAM,EACvB,YAAY,EACZ,YAAY,CACb,CAAC;YACJ,CAAC;QACH,CAAC;aAAM,IAAI,IAAA,qBAAS,EAAC,MAAM,CAAC,EAAE,CAAC;YAC7B,IAAI,CAAC,MAAM,EAAE,CAAC;gBACZ,MAAM,IAAI,yBAAc,CAAC;oBACvB,EAAE,EAAE,IAAI,CAAC,EAAE;oBACX,OAAO,EAAE,aAAa,IAAI,0BAA0B,IAAA,cAAO,EAAC,IAAI,CAAC,EAAE;iBACpE,CAAC,CAAC;YACL,CAAC;QACH,CAAC;aAAM,IAAI,IAAA,mBAAO,EAAC,MAAM,CAAC,IAAI,MAAM,YAAY,OAAC,CAAC,QAAQ,EAAE,CAAC;YAC3D,MAAM,IAAI,CAAC,YAAY,CAAC,MAAM,EAAE,YAAY,EAAE,YAAY,CAAC,CAAC;QAC9D,CAAC;aAAM,IAAI,IAAA,4CAAuB,EAAC,MAAM,CAAC,EAAE,CAAC;YAC3C,MAAM,EAAE,WAAW,EAAE,MAAM,EAAE,OAAO,EAAE,GAAG,MAAM,CAAC;YAChD,IAAI,WAAW,EAAE,CAAC;gBAChB,MAAM,IAAI,uCAA4B,CACpC,kBAAkB,IAAI,wDAAwD,CAC/E,CAAC;YACJ,CAAC;YACD,IAAI,CAAC,MAAM,EAAE,CAAC;gBACZ,MAAM,IAAI,uCAA4B,CACpC,kBAAkB,IAAI,gDAAgD,CACvE,CAAC;YACJ,CAAC;YAED,IAAI,IAAA,qBAAS,EAAC,MAAM,CAAC,EAAE,CAAC;gBACtB,MAAM,SAAS,GAAG,MAAM,CAAC,SAAS,CAAC,OAAO,CAAC,CAAC;gBAC5C,IAAI,CAAC,SAAS,CAAC,OAAO,EAAE,CAAC;oBACvB,MAAM,IAAI,CAAC,YAAY,CAAC,SAAS,CAAC,KAAK,EAAE,YAAY,EAAE,OAAO,CAAC,CAAC;gBAClE,CAAC;YACH,CAAC;iBAAM,IAAI,IAAA,4BAAgB,EAAC,MAAM,CAAC,EAAE,CAAC;gBACpC,MAAM,gBAAgB,GAAG,MAAM,CAAC,WAAW,CAAC,CAAC,QAAQ,CAAC,OAAO,CAAC,CAAC;gBAC/D,IAAI,gBAAgB,YAAY,OAAO,EAAE,CAAC;oBACxC,gBAAgB,CAAC,KAAK,CAAC,GAAG,EAAE;wBAC1B,iCAAiC;oBACnC,CAAC,CAAC,CAAC;oBACH,MAAM,IAAI,uCAA4B,CACpC,kBAAkB,IAAI,mEAAmE,CAC1F,CAAC;gBACJ,CAAC;gBACD,IAAI,gBAAgB,CAAC,MAAM,EAAE,CAAC;oBAC5B,MAAM,IAAI,CAAC,wBAAwB,CACjC,gBAAgB,CAAC,MAAM,EACvB,YAAY,EACZ,OAAO,CACR,CAAC;gBACJ,CAAC;YACH,CAAC;QACH,CAAC;aAAM,IAAI,IAAA,uCAAkB,EAAC,MAAM,CAAC,EAAE,CAAC;YACtC,MAAM,UAAU,GAAG,IAAA,oDAAsB,EAAC,MAAM,CAAC,CAAC;YAClD,MAAM,WAAW,GACf,MAAM,CAAC,OAAO;gBACd,aAAa,IAAI,0BAA0B,IAAA,cAAO,EAAC,IAAI,CAAC,EAAE,CAAC;YAC7D,MAAM,OAAO,GAAG,UAAU;gBACxB,CAAC,CAAC,GAAG,WAAW,KAAK,UAAU,EAAE;gBACjC,CAAC,CAAC,WAAW,CAAC;YAEhB,MAAM,IAAI,yBAAc,CAAC;gBACvB,MAAM,EAAE,MAAM,CAAC,MAAM;gBACrB,QAAQ,EAAE,MAAM,CAAC,QAAQ;gBACzB,EAAE,EAAE,IAAI,CAAC,EAAE;gBACX,OAAO;aACR,CAAC,CAAC;QACL,CAAC;aAAM,IAAI,MAAiB,EAAE,CAAC;YAC7B,MAAM,IAAI,uCAA4B,CACpC,sCAAsC,IAAI,kDAAkD,EAC5F,EAAE,MAAM,EAAE,CACX,CAAC;QACJ,CAAC;IACH,CAAC;CACF;AApID,kEAoIC;AAED;;;;;;;;;;;GAWG;AAEH,MAAa,yBAKX,SAAQ,mBAAuC;IAGtC,OAAO,CACd,YAAiC,EACjC,KAAgB,EAChB,YAAqC,EACrC,WAAiC;QAEjC,6DAA6D;QAC7D,MAAM,gBAAgB,GAAG,WAAW,EAAE,OAAO;YAC3C,CAAC,CAAC,WAAW,CAAC,uBAAuB;YACrC,CAAC,CAAC,SAAS,CAAC;QAEd,IAAI,gBAAgB,EAAE,CAAC;YACrB,IAAI,CAAC,gBAAgB,CAAC,OAAO,EAAE,CAAC;gBAC9B,IAAI,OAAO,IAAI,gBAAgB,EAAE,CAAC;oBAChC,MAAM,IAAI,CAAC,YAAY,CACrB,gBAAgB,CAAC,KAAK,EACtB,YAAY,EACZ,YAAY,CACb,CAAC;gBACJ,CAAC;qBAAM,IAAI,QAAQ,IAAI,gBAAgB,EAAE,CAAC;oBACxC,MAAM,IAAI,CAAC,wBAAwB,CACjC,gBAAgB,CAAC,MAAM,EACvB,YAAY,EACZ,YAAY,CACb,CAAC;gBACJ,CAAC;YACH,CAAC;YACD,gDAAgD;YAChD,OAAO;QACT,CAAC;QAED,uDAAuD;QACvD,MAAM,CAAC,OAAO,CAAC,GAAG,YAAY,CAAC;QAC/B,MAAM,MAAM,GAAG,IAAI,CAAC,IAAI,CAAC,SAAS,CAAC,OAAO,CAAC,CAAC;QAC5C,IAAI,CAAC,MAAM,CAAC,OAAO,EAAE,CAAC;YACpB,MAAM,IAAI,CAAC,YAAY,CAAC,MAAM,CAAC,KAAK,EAAE,YAAY,EAAE,YAAY,CAAC,CAAC;QACpE,CAAC;IACH,CAAC;IAEQ,WAAW,CAClB,IAAU;QAEV,MAAM,EAAE,KAAK,EAAE,GAAG,IAAI,CAAC;QACvB,MAAM,YAAY,GAAU,EAAE,CAAC;QAC/B,MAAM,QAAQ,GAAG,IAAI,CAAC,2BAA2B,CAAC,IAAI,CAAC,CAAC;QACxD,IAAI,QAAQ,EAAE,CAAC;YACb,OAAO,QAAQ,CAAC;QAClB,CAAC;QAED,IAAI,UAAU,GAAG,IAAI,CAAC;QACtB,IAAI,uBAA8E,CAAC;QAEnF,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,KAAK,CAAC,MAAM,EAAE,CAAC,EAAE,EAAE,CAAC;YACtC,MAAM,IAAI,GAAG,KAAK,CAAC,CAAC,CAAE,CAAC;YACvB,MAAM,GAAG,GAAG,IAAI,CAAC,CAAC,CAAC,CAAC;YACpB,MAAM,mBAAmB,GAAG,IAAI,CAAC,mBAAmB,CAAC,IAAI,EAAE,CAAC,EAAE,GAAG,CAAC,CAAC;YACnE,IAAI,mBAAmB,KAAK,IAAI,EAAE,CAAC;gBACjC,SAAS;YACX,CAAC;iBAAM,IAAI,mBAAmB,KAAK,KAAK,EAAE,CAAC;gBACzC,OAAO,mBAAmB,CAAC;YAC7B,CAAC;YAED,kFAAkF;YAClF,IACE,CAAC,KAAK,CAAC;gBACP,CAAC,IAAI,CAAC,GAAG,CAAC,IAAI,KAAK,SAAS,IAAI,IAAI,CAAC,GAAG,CAAC,IAAI,KAAK,KAAK,CAAC;gBACxD,IAAI,CAAC,uBAAuB,EAAE,EAC9B,CAAC;gBACD,MAAM,MAAM,GAAG,IAAI,CAAC,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC,CAAC;gBACxC,IAAI,MAAM,CAAC,OAAO,EAAE,CAAC;oBACnB,uBAAuB,GAAG,EAAE,IAAI,EAAE,MAAM,CAAC,IAAI,EAAE,OAAO,EAAE,IAAI,EAAE,CAAC;oBAC/D,YAAY,CAAC,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,CAAC,qBAAqB;gBACvD,CAAC;qBAAM,CAAC;oBACN,uBAAuB,GAAG,EAAE,KAAK,EAAE,MAAM,CAAC,KAAK,EAAE,OAAO,EAAE,KAAK,EAAE,CAAC;oBAClE,YAAY,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC,oCAAoC;gBAC9D,CAAC;gBACD,UAAU,GAAG,KAAK,CAAC,CAAC,mDAAmD;gBACvE,SAAS;YACX,CAAC;YAED,mDAAmD;YACnD,IAAI,IAAI,CAAC,GAAG,CAAC,IAAI,KAAK,SAAS,IAAI,IAAI,CAAC,GAAG,CAAC,IAAI,KAAK,KAAK,EAAE,CAAC;gBAC3D,YAAY,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;gBACvB,UAAU,GAAG,KAAK,CAAC;gBACnB,SAAS;YACX,CAAC;YAED,MAAM,MAAM,GAAG,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC,CAAC;YACnC,IAAI,CAAC,MAAM,CAAC,OAAO,EAAE,CAAC;gBACpB,OAAO;oBACL,OAAO,EAAE,KAAK;iBACf,CAAC;YACJ,CAAC;YACD,YAAY,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;QACzB,CAAC;QAED,MAAM,MAAM,GAA+B;YACzC,UAAU;YACV,YAAY,EAAE,YAA8C;YAC5D,OAAO,EAAE,IAAI;SACd,CAAC;QAEF,4DAA4D;QAC5D,IAAI,uBAAuB,EAAE,CAAC;YAC5B,MAAM,CAAC,uBAAuB,GAAG,uBAAuB,CAAC;QAC3D,CAAC;QAED,OAAO,MAAM,CAAC;IAChB,CAAC;CACF;AArHD,8DAqHC"}

package/dist/assertion/assertion-sync.d.cts

@@ -0,0 +1,60 @@
+/**
+ * Synchronous assertion subclasses.
+ *
+ * @packageDocumentation
+ * @see {@link AssertionFunctionSync} for function-based assertions
+ * @see {@link AssertionSchemaSync} for schema-based assertions
+ */
+import { type AssertionFunctionSync, type AssertionImplFnSync, type AssertionImplSchemaSync, type AssertionImplSync, type AssertionParts, type AssertionSchemaSync, type AssertionSlots, type AssertionSync, type ParsedResult, type ParsedValues } from "./assertion-types.cjs";
+import { BupkisAssertion } from "./assertion.cjs";
+/**
+ * Abstract class for synchronous assertions.
+ *
+ * Child classes are expected to implement {@link execute}.
+ */
+export declare abstract class BupkisAssertionSync<Parts extends AssertionParts, Impl extends AssertionImplSync<Parts>, Slots extends AssertionSlots<Parts>> extends BupkisAssertion<Parts, Impl, Slots> implements AssertionSync<Parts, Impl, Slots> {
+    /**
+     * Parses raw arguments synchronously against this `Assertion`'s Slots to
+     * determine if they match this `Assertion`.
+     *
+     * @param args Raw arguments provided to `expect()`
+     * @returns Result of parsing attempt
+     */
+    abstract execute(parsedValues: ParsedValues<Parts>, args: unknown[], stackStartFn: (...args: any[]) => any, parseResult?: ParsedResult<Parts>): void;
+    /**
+     * Parses raw arguments against the slots of this assertion to determine if
+     * this assertion should be executed against those arguments.
+     *
+     * For example, if an assertion wants the subject to be a `z.string()`, then
+     * this will validate that the first raw arg parses as a string. It will also
+     * validate Phrase Literals as well, such as "to be a string". If all slots
+     * match and none of the slots are "unknown" or "any", then `exactMatch` will
+     * be true.
+     *
+     * If any slot does not match, this returns `success: false`.
+     *
+     * @param args Raw arguments
+     * @returns Result of parsing attempt
+     */
+    parseValues<Args extends readonly unknown[]>(args: Args): ParsedResult<Parts>;
+}
+export declare class BupkisAssertionFunctionSync<Parts extends AssertionParts, Impl extends AssertionImplFnSync<Parts>, Slots extends AssertionSlots<Parts>> extends BupkisAssertionSync<Parts, Impl, Slots> implements AssertionFunctionSync<Parts, Impl, Slots> {
+    execute(parsedValues: ParsedValues<Parts>, args: unknown[], stackStartFn: (...args: any[]) => any, _parseResult?: ParsedResult<Parts>): void;
+}
+/**
+ * A class representing an assertion implemented as a function.
+ *
+ * This function may:
+ *
+ * 1. Return a `boolean` indicating pass/fail.
+ * 2. Return a `ZodType` which will be used to validate the subject.
+ * 3. Return a `Promise` resolving to either of the above (when called via
+ *    {@link expectAsync})
+ * 4. Throw a {@link AssertionError}; when called via {@link expectAsync}, reject
+ *    with an {@link AssertionError}
+ */
+export declare class BupkisAssertionSchemaSync<Parts extends AssertionParts, Impl extends AssertionImplSchemaSync<Parts>, Slots extends AssertionSlots<Parts>> extends BupkisAssertionSync<Parts, Impl, Slots> implements AssertionSchemaSync<Parts, Impl, Slots> {
+    execute(parsedValues: ParsedValues<Parts>, _args: unknown[], stackStartFn: (...args: any[]) => any, parseResult?: ParsedResult<Parts>): void;
+    parseValues<Args extends readonly unknown[]>(args: Args): ParsedResult<Parts>;
+}
+//# sourceMappingURL=assertion-sync.d.ts.map

package/dist/assertion/assertion-sync.d.cts.map

@@ -0,0 +1 @@
+{"version":3,"file":"assertion-sync.d.ts","sourceRoot":"","sources":["../../src/assertion/assertion-sync.ts"],"names":[],"mappings":"AAAA;;;;;;GAMG;AAsBH,OAAO,EACL,KAAK,qBAAqB,EAE1B,KAAK,mBAAmB,EACxB,KAAK,uBAAuB,EAC5B,KAAK,iBAAiB,EACtB,KAAK,cAAc,EACnB,KAAK,mBAAmB,EACxB,KAAK,cAAc,EACnB,KAAK,aAAa,EAClB,KAAK,YAAY,EAEjB,KAAK,YAAY,EAClB,8BAA6B;AAC9B,OAAO,EAAE,eAAe,EAAE,wBAAuB;AAKjD;;;;GAIG;AACH,8BAAsB,mBAAmB,CACvC,KAAK,SAAS,cAAc,EAC5B,IAAI,SAAS,iBAAiB,CAAC,KAAK,CAAC,EACrC,KAAK,SAAS,cAAc,CAAC,KAAK,CAAC,CAEnC,SAAQ,eAAe,CAAC,KAAK,EAAE,IAAI,EAAE,KAAK,CAC1C,YAAW,aAAa,CAAC,KAAK,EAAE,IAAI,EAAE,KAAK,CAAC;IAE5C;;;;;;OAMG;IACH,QAAQ,CAAC,OAAO,CACd,YAAY,EAAE,YAAY,CAAC,KAAK,CAAC,EACjC,IAAI,EAAE,OAAO,EAAE,EACf,YAAY,EAAE,CAAC,GAAG,IAAI,EAAE,GAAG,EAAE,KAAK,GAAG,EACrC,WAAW,CAAC,EAAE,YAAY,CAAC,KAAK,CAAC,GAChC,IAAI;IAEP;;;;;;;;;;;;;;OAcG;IACH,WAAW,CAAC,IAAI,SAAS,SAAS,OAAO,EAAE,EACzC,IAAI,EAAE,IAAI,GACT,YAAY,CAAC,KAAK,CAAC;CA4CvB;AAED,qBAAa,2BAA2B,CACtC,KAAK,SAAS,cAAc,EAC5B,IAAI,SAAS,mBAAmB,CAAC,KAAK,CAAC,EACvC,KAAK,SAAS,cAAc,CAAC,KAAK,CAAC,CAEnC,SAAQ,mBAAmB,CAAC,KAAK,EAAE,IAAI,EAAE,KAAK,CAC9C,YAAW,qBAAqB,CAAC,KAAK,EAAE,IAAI,EAAE,KAAK,CAAC;IAE3C,OAAO,CACd,YAAY,EAAE,YAAY,CAAC,KAAK,CAAC,EACjC,IAAI,EAAE,OAAO,EAAE,EACf,YAAY,EAAE,CAAC,GAAG,IAAI,EAAE,GAAG,EAAE,KAAK,GAAG,EACrC,YAAY,CAAC,EAAE,YAAY,CAAC,KAAK,CAAC,GACjC,IAAI;CAuHR;AAED;;;;;;;;;;;GAWG;AAEH,qBAAa,yBAAyB,CACpC,KAAK,SAAS,cAAc,EAC5B,IAAI,SAAS,uBAAuB,CAAC,KAAK,CAAC,EAC3C,KAAK,SAAS,cAAc,CAAC,KAAK,CAAC,CAEnC,SAAQ,mBAAmB,CAAC,KAAK,EAAE,IAAI,EAAE,KAAK,CAC9C,YAAW,mBAAmB,CAAC,KAAK,EAAE,IAAI,EAAE,KAAK,CAAC;IAEzC,OAAO,CACd,YAAY,EAAE,YAAY,CAAC,KAAK,CAAC,EACjC,KAAK,EAAE,OAAO,EAAE,EAChB,YAAY,EAAE,CAAC,GAAG,IAAI,EAAE,GAAG,EAAE,KAAK,GAAG,EACrC,WAAW,CAAC,EAAE,YAAY,CAAC,KAAK,CAAC,GAChC,IAAI;IAkCE,WAAW,CAAC,IAAI,SAAS,SAAS,OAAO,EAAE,EAClD,IAAI,EAAE,IAAI,GACT,YAAY,CAAC,KAAK,CAAC;CAoEvB"}

package/dist/assertion/assertion-sync.d.ts

@@ -0,0 +1,60 @@
+/**
+ * Synchronous assertion subclasses.
+ *
+ * @packageDocumentation
+ * @see {@link AssertionFunctionSync} for function-based assertions
+ * @see {@link AssertionSchemaSync} for schema-based assertions
+ */
+import { type AssertionFunctionSync, type AssertionImplFnSync, type AssertionImplSchemaSync, type AssertionImplSync, type AssertionParts, type AssertionSchemaSync, type AssertionSlots, type AssertionSync, type ParsedResult, type ParsedValues } from "./assertion-types.js";
+import { BupkisAssertion } from "./assertion.js";
+/**
+ * Abstract class for synchronous assertions.
+ *
+ * Child classes are expected to implement {@link execute}.
+ */
+export declare abstract class BupkisAssertionSync<Parts extends AssertionParts, Impl extends AssertionImplSync<Parts>, Slots extends AssertionSlots<Parts>> extends BupkisAssertion<Parts, Impl, Slots> implements AssertionSync<Parts, Impl, Slots> {
+    /**
+     * Parses raw arguments synchronously against this `Assertion`'s Slots to
+     * determine if they match this `Assertion`.
+     *
+     * @param args Raw arguments provided to `expect()`
+     * @returns Result of parsing attempt
+     */
+    abstract execute(parsedValues: ParsedValues<Parts>, args: unknown[], stackStartFn: (...args: any[]) => any, parseResult?: ParsedResult<Parts>): void;
+    /**
+     * Parses raw arguments against the slots of this assertion to determine if
+     * this assertion should be executed against those arguments.
+     *
+     * For example, if an assertion wants the subject to be a `z.string()`, then
+     * this will validate that the first raw arg parses as a string. It will also
+     * validate Phrase Literals as well, such as "to be a string". If all slots
+     * match and none of the slots are "unknown" or "any", then `exactMatch` will
+     * be true.
+     *
+     * If any slot does not match, this returns `success: false`.
+     *
+     * @param args Raw arguments
+     * @returns Result of parsing attempt
+     */
+    parseValues<Args extends readonly unknown[]>(args: Args): ParsedResult<Parts>;
+}
+export declare class BupkisAssertionFunctionSync<Parts extends AssertionParts, Impl extends AssertionImplFnSync<Parts>, Slots extends AssertionSlots<Parts>> extends BupkisAssertionSync<Parts, Impl, Slots> implements AssertionFunctionSync<Parts, Impl, Slots> {
+    execute(parsedValues: ParsedValues<Parts>, args: unknown[], stackStartFn: (...args: any[]) => any, _parseResult?: ParsedResult<Parts>): void;
+}
+/**
+ * A class representing an assertion implemented as a function.
+ *
+ * This function may:
+ *
+ * 1. Return a `boolean` indicating pass/fail.
+ * 2. Return a `ZodType` which will be used to validate the subject.
+ * 3. Return a `Promise` resolving to either of the above (when called via
+ *    {@link expectAsync})
+ * 4. Throw a {@link AssertionError}; when called via {@link expectAsync}, reject
+ *    with an {@link AssertionError}
+ */
+export declare class BupkisAssertionSchemaSync<Parts extends AssertionParts, Impl extends AssertionImplSchemaSync<Parts>, Slots extends AssertionSlots<Parts>> extends BupkisAssertionSync<Parts, Impl, Slots> implements AssertionSchemaSync<Parts, Impl, Slots> {
+    execute(parsedValues: ParsedValues<Parts>, _args: unknown[], stackStartFn: (...args: any[]) => any, parseResult?: ParsedResult<Parts>): void;
+    parseValues<Args extends readonly unknown[]>(args: Args): ParsedResult<Parts>;
+}
+//# sourceMappingURL=assertion-sync.d.ts.map

package/dist/assertion/assertion-sync.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"assertion-sync.d.ts","sourceRoot":"","sources":["../../src/assertion/assertion-sync.ts"],"names":[],"mappings":"AAAA;;;;;;GAMG;AAsBH,OAAO,EACL,KAAK,qBAAqB,EAE1B,KAAK,mBAAmB,EACxB,KAAK,uBAAuB,EAC5B,KAAK,iBAAiB,EACtB,KAAK,cAAc,EACnB,KAAK,mBAAmB,EACxB,KAAK,cAAc,EACnB,KAAK,aAAa,EAClB,KAAK,YAAY,EAEjB,KAAK,YAAY,EAClB,6BAA6B;AAC9B,OAAO,EAAE,eAAe,EAAE,uBAAuB;AAKjD;;;;GAIG;AACH,8BAAsB,mBAAmB,CACvC,KAAK,SAAS,cAAc,EAC5B,IAAI,SAAS,iBAAiB,CAAC,KAAK,CAAC,EACrC,KAAK,SAAS,cAAc,CAAC,KAAK,CAAC,CAEnC,SAAQ,eAAe,CAAC,KAAK,EAAE,IAAI,EAAE,KAAK,CAC1C,YAAW,aAAa,CAAC,KAAK,EAAE,IAAI,EAAE,KAAK,CAAC;IAE5C;;;;;;OAMG;IACH,QAAQ,CAAC,OAAO,CACd,YAAY,EAAE,YAAY,CAAC,KAAK,CAAC,EACjC,IAAI,EAAE,OAAO,EAAE,EACf,YAAY,EAAE,CAAC,GAAG,IAAI,EAAE,GAAG,EAAE,KAAK,GAAG,EACrC,WAAW,CAAC,EAAE,YAAY,CAAC,KAAK,CAAC,GAChC,IAAI;IAEP;;;;;;;;;;;;;;OAcG;IACH,WAAW,CAAC,IAAI,SAAS,SAAS,OAAO,EAAE,EACzC,IAAI,EAAE,IAAI,GACT,YAAY,CAAC,KAAK,CAAC;CA4CvB;AAED,qBAAa,2BAA2B,CACtC,KAAK,SAAS,cAAc,EAC5B,IAAI,SAAS,mBAAmB,CAAC,KAAK,CAAC,EACvC,KAAK,SAAS,cAAc,CAAC,KAAK,CAAC,CAEnC,SAAQ,mBAAmB,CAAC,KAAK,EAAE,IAAI,EAAE,KAAK,CAC9C,YAAW,qBAAqB,CAAC,KAAK,EAAE,IAAI,EAAE,KAAK,CAAC;IAE3C,OAAO,CACd,YAAY,EAAE,YAAY,CAAC,KAAK,CAAC,EACjC,IAAI,EAAE,OAAO,EAAE,EACf,YAAY,EAAE,CAAC,GAAG,IAAI,EAAE,GAAG,EAAE,KAAK,GAAG,EACrC,YAAY,CAAC,EAAE,YAAY,CAAC,KAAK,CAAC,GACjC,IAAI;CAuHR;AAED;;;;;;;;;;;GAWG;AAEH,qBAAa,yBAAyB,CACpC,KAAK,SAAS,cAAc,EAC5B,IAAI,SAAS,uBAAuB,CAAC,KAAK,CAAC,EAC3C,KAAK,SAAS,cAAc,CAAC,KAAK,CAAC,CAEnC,SAAQ,mBAAmB,CAAC,KAAK,EAAE,IAAI,EAAE,KAAK,CAC9C,YAAW,mBAAmB,CAAC,KAAK,EAAE,IAAI,EAAE,KAAK,CAAC;IAEzC,OAAO,CACd,YAAY,EAAE,YAAY,CAAC,KAAK,CAAC,EACjC,KAAK,EAAE,OAAO,EAAE,EAChB,YAAY,EAAE,CAAC,GAAG,IAAI,EAAE,GAAG,EAAE,KAAK,GAAG,EACrC,WAAW,CAAC,EAAE,YAAY,CAAC,KAAK,CAAC,GAChC,IAAI;IAkCE,WAAW,CAAC,IAAI,SAAS,SAAS,OAAO,EAAE,EAClD,IAAI,EAAE,IAAI,GACT,YAAY,CAAC,KAAK,CAAC;CAoEvB"}