bupkis 0.2.0 → 0.4.0

package/src/assertion/impl/async.ts

@@ -14,12 +14,16 @@ import { z } from 'zod/v4';
 
 import { isA, isNonNullObject, isString } from '../../guards.js';
 import {
-  ClassSchema,
+  ConstructibleSchema,
   FunctionSchema,
   WrappedPromiseLikeSchema,
 } from '../../schema.js';
-import { valueToSchema } from '../../util.js';
+import {
+  valueToSchema,
+  valueToSchemaOptionsForSatisfies,
+} from '../../value-to-schema.js';
 import { createAsyncAssertion } from '../create.js';
+import { CallbackAsyncAssertions } from './callback.js';
 
 const trapAsyncFnError = async (fn: () => unknown) => {
   try {
@@ -37,15 +41,18 @@ const trapPromiseError = async (promise: PromiseLike<unknown>) => {
   }
 };
 
-export const AsyncAssertions = [
+export const PromiseAssertions = [
   createAsyncAssertion(
     [FunctionSchema, ['to resolve', 'to fulfill']],
     async (subject) => {
       try {
         await subject();
-        return true;
       } catch {
-        return false;
+        return {
+          actual: 'function rejected',
+          expected: 'function to fulfill',
+          message: 'Expected function to fulfill, but it rejected instead',
+        };
       }
     },
   ),
@@ -54,38 +61,47 @@ export const AsyncAssertions = [
     async (subject) => {
       try {
         await subject;
-        return true;
       } catch {
-        return false;
+        return {
+          actual: 'promise rejected',
+          expected: 'promise to not reject',
+          message: 'Expected promise to fulfill, but it rejected instead',
+        };
       }
     },
   ),
 
   // Non-parameterized "to reject" assertions
   createAsyncAssertion([FunctionSchema, 'to reject'], async (subject) => {
-    let rejected = false;
     try {
       await subject();
-    } catch {
-      rejected = true;
-    }
-    return rejected;
+      return {
+        actual: 'function fulfilled',
+        expected: 'function to reject',
+        message: 'Expected function to reject, but it fulfilled instead',
+      };
+    } catch {}
   }),
   createAsyncAssertion(
     [WrappedPromiseLikeSchema, 'to reject'],
     async (subject) => {
-      let rejected = false;
       try {
         await subject;
-      } catch {
-        rejected = true;
-      }
-      return rejected;
+        return {
+          actual: 'function fulfilled',
+          expected: 'function to reject',
+          message: 'Expected function to reject, but it fulfilled instead',
+        };
+      } catch {}
     },
   ),
   // Parameterized "to reject" with class constructor
   createAsyncAssertion(
-    [FunctionSchema, ['to reject with a', 'to reject with an'], ClassSchema],
+    [
+      FunctionSchema,
+      ['to reject with a', 'to reject with an'],
+      ConstructibleSchema,
+    ],
     async (subject, ctor) => {
       const error = await trapAsyncFnError(subject);
       if (!error) {
@@ -98,7 +114,7 @@ export const AsyncAssertions = [
     [
       WrappedPromiseLikeSchema,
       ['to reject with a', 'to reject with an'],
-      ClassSchema,
+      ConstructibleSchema,
     ],
     async (subject, ctor) => {
       const error = await trapPromiseError(subject);
@@ -113,66 +129,91 @@ export const AsyncAssertions = [
   createAsyncAssertion(
     [
       FunctionSchema,
-      ['to reject with'],
+      ['to reject with error satisfying'],
       z.union([z.string(), z.instanceof(RegExp), z.looseObject({})]),
     ],
     async (subject, param) => {
       const error = await trapAsyncFnError(subject);
       if (!error) {
-        return false;
+        return {
+          actual: 'function fulfilled',
+          expect: 'function to reject',
+          message: 'Expected function to reject, but it fulfilled instead',
+        };
       }
 
+      let schema: undefined | z.ZodType;
+      // TODO: can valueToSchema handle the first two conditional branches?
       if (isString(param)) {
-        return z
-          .object({
+        schema = z
+          .looseObject({
             message: z.coerce.string().pipe(z.literal(param)),
           })
-          .or(z.coerce.string().pipe(z.literal(param)))
-          .safeParse(error).success;
+          .or(z.coerce.string().pipe(z.literal(param)));
       } else if (isA(param, RegExp)) {
-        return z
-          .object({
+        schema = z
+          .looseObject({
             message: z.coerce.string().regex(param),
           })
-          .or(z.coerce.string().regex(param))
-          .safeParse(error).success;
+          .or(z.coerce.string().regex(param));
       } else if (isNonNullObject(param)) {
-        return valueToSchema(param, { strict: false }).safeParse(error).success;
-      } else {
-        throw new TypeError(`Invalid parameter schema: ${inspect(param)}`);
+        schema = valueToSchema(param, valueToSchemaOptionsForSatisfies);
+      }
+      /* c8 ignore next 5 */
+      if (!schema) {
+        throw new TypeError(
+          `Invalid parameter schema: ${inspect(param, { depth: 2 })}`,
+        );
+      }
+
+      const result = schema.safeParse(error);
+      if (!result.success) {
+        return result.error;
       }
     },
   ),
   createAsyncAssertion(
     [
       WrappedPromiseLikeSchema,
-      ['to reject with'],
+      ['to reject with error satisfying'],
       z.union([z.string(), z.instanceof(RegExp), z.looseObject({})]),
     ],
     async (subject, param) => {
       const error = await trapPromiseError(subject);
       if (!error) {
-        return false;
+        return {
+          actual: 'promise fulfilled',
+          expect: 'promise to reject',
+          message: 'Expected promise to reject, but it fulfilled instead',
+        };
       }
-
+      let schema: undefined | z.ZodType;
+      // TODO: can valueToSchema handle the first two conditional branches?
       if (isString(param)) {
-        return z
-          .object({
+        schema = z
+          .looseObject({
             message: z.coerce.string().pipe(z.literal(param)),
           })
-          .or(z.coerce.string().pipe(z.literal(param)))
-          .safeParse(error).success;
+          .or(z.coerce.string().pipe(z.literal(param)));
       } else if (isA(param, RegExp)) {
-        return z
-          .object({
+        schema = z
+          .looseObject({
             message: z.coerce.string().regex(param),
           })
-          .or(z.coerce.string().regex(param))
-          .safeParse(error).success;
+          .or(z.coerce.string().regex(param));
       } else if (isNonNullObject(param)) {
-        return valueToSchema(param, { strict: false }).safeParse(error).success;
-      } else {
-        throw new TypeError(`Invalid parameter schema: ${inspect(param)}`);
+        schema = valueToSchema(param, valueToSchemaOptionsForSatisfies);
+      }
+      /* c8 ignore next 5 */
+      if (!schema) {
+        throw new TypeError(
+          `Invalid parameter schema: ${inspect(param, { depth: 2 })}`,
+        );
+      }
+
+      const result = schema.safeParse(error);
+      if (!result.success) {
+        return result.error;
       }
     },
   ),
@@ -196,35 +237,33 @@ export const AsyncAssertions = [
           )}`,
         };
       }
+      let schema: undefined | z.ZodType;
+      // TODO: can valueToSchema handle the first two conditional branches?
       if (isString(param)) {
-        return z
-          .object({
+        schema = z
+          .looseObject({
             message: z.coerce.string().pipe(z.literal(param)),
           })
-          .or(z.coerce.string().pipe(z.literal(param)))
-          .safeParse(value).success;
+          .or(z.coerce.string().pipe(z.literal(param)));
       } else if (isA(param, RegExp)) {
-        return z
-          .object({
+        schema = z
+          .looseObject({
             message: z.coerce.string().regex(param),
           })
-          .or(z.coerce.string().regex(param))
-          .safeParse(value).success;
+          .or(z.coerce.string().regex(param));
       } else if (isNonNullObject(param)) {
-        const schema = valueToSchema(param);
-        const result = schema.safeParse(value);
-        if (!result.success) {
-          return {
-            actual: value,
-            expected: param,
-            message: `Expected resolved value to satisfy schema ${inspect(
-              param,
-            )}, but it does not`,
-          };
-        }
-        return true;
-      } else {
-        throw new TypeError(`Invalid parameter schema: ${inspect(param)}`);
+        schema = valueToSchema(param, valueToSchemaOptionsForSatisfies);
+      }
+      /* c8 ignore next 5 */
+      if (!schema) {
+        throw new TypeError(
+          `Invalid parameter schema: ${inspect(param, { depth: 2 })}`,
+        );
+      }
+
+      const result = schema.safeParse(value);
+      if (!result.success) {
+        return result.error;
       }
     },
   ),
@@ -241,44 +280,49 @@ export const AsyncAssertions = [
         value = await subject();
       } catch (err) {
         return {
-          actual: err,
-          expect: 'function to not throw',
-          message: `Expected function to not throw, but it threw ${inspect(
+          actual: 'function rejected',
+          expect: 'function to fulfill',
+          message: `Expected function to fulfill, but it rejected with ${inspect(
             err,
           )}`,
         };
       }
 
+      let schema: undefined | z.ZodType;
+      // TODO: can valueToSchema handle the first two conditional branches?
       if (isString(param)) {
-        return z
-          .object({
+        schema = z
+          .looseObject({
             message: z.coerce.string().pipe(z.literal(param)),
           })
-          .or(z.coerce.string().pipe(z.literal(param)))
-          .safeParse(value).success;
+          .or(z.coerce.string().pipe(z.literal(param)));
       } else if (isA(param, RegExp)) {
-        return z
-          .object({
+        schema = z
+          .looseObject({
             message: z.coerce.string().regex(param),
           })
-          .or(z.coerce.string().regex(param))
-          .safeParse(value).success;
+          .or(z.coerce.string().regex(param));
       } else if (isNonNullObject(param)) {
-        const schema = valueToSchema(param);
-        const result = schema.safeParse(value);
-        if (!result.success) {
-          return {
-            actual: value,
-            expected: param,
-            message: `Expected resolved value to satisfy schema ${inspect(
-              param,
-            )}, but it does not`,
-          };
-        }
-        return true;
-      } else {
-        throw new TypeError(`Invalid parameter schema: ${inspect(param)}`);
+        schema = valueToSchema(param, valueToSchemaOptionsForSatisfies);
+      }
+      /* c8 ignore next 5 */
+      if (!schema) {
+        throw new TypeError(
+          `Invalid parameter schema: ${inspect(param, { depth: 2 })}`,
+        );
+      }
+
+      const result = schema.safeParse(value);
+      if (!result.success) {
+        return result.error;
       }
     },
   ),
 ] as const;
+
+export const AsyncAssertions = [
+  ...PromiseAssertions,
+  ...CallbackAsyncAssertions,
+] as const;
+
+export { CallbackAsyncAssertions };