feat: add assert/parse/is

README.md

@@ -49,7 +49,7 @@ As a result it has many opinions that might not sit well with some folks.
   ]);
 
   // endpoint
-  await validate(filename);
+  await assert(validate, filename);
   ```
 
   Do this instead:
@@ -62,7 +62,7 @@ As a result it has many opinions that might not sit well with some folks.
   ]);
 
   // endpoint
-  validate(filename);
+  assert(validate, filename);
 
   if(!(await File.exists(filename))) {
     throw Error("File does not exist");
@@ -158,9 +158,9 @@ As a result it has many opinions that might not sit well with some folks.
   <summary><b>How do I validate types?</b></summary>
 
   ```ts
-  string("Hello, World!");
-  number(420);
-  boolean(true);
+  assert(string, "Hello, World!");
+  assert(number, 420);
+  assert(boolean, true);
   ```
 
 </details>
@@ -202,14 +202,20 @@ As a result it has many opinions that might not sit well with some folks.
     friends: array(string)
   });
 
-  register("Oh no this is gonna throw");
-
-  register({
-    email: "[email protected]",
-    password: "Test123456",
-    role: "ADMIN",
-    friends: ["Joe"]
-  });
+  assert(
+    register,
+    "Oh no this is gonna throw"
+  );
+
+  assert(
+    register
+    {
+      email: "[email protected]",
+      password: "Test123456",
+      role: "ADMIN",
+      friends: ["Joe"]
+    }
+  );
   ```
 
 </details>

src/assertions/and/index.test.ts

@@ -2,7 +2,7 @@ import { maxValue } from "@assertions/maxValue";
 import { minValue } from "@assertions/minValue";
 import { number } from "@assertions/number";
 import { fc, test } from "@fast-check/vitest";
-import { assert } from "@utils";
+import { assert } from "@utils/assert";
 import { expect } from "vitest";
 import { and } from "./index";
 

src/assertions/and/index.ts

@@ -1,5 +1,4 @@
-import type { Assertion } from "@the-minimal/types";
-import type { Intersection } from "./types";
+import type { Assertion, Intersection } from "@the-minimal/types";
 
 /**
  * Checks if all the assertions pass.

src/assertions/boolean/index.test.ts

@@ -1,6 +1,6 @@
 import { boolean } from "@assertions/boolean";
 import { fc, test } from "@fast-check/vitest";
-import { assert } from "@utils";
+import { assert } from "@utils/assert";
 import { expect } from "vitest";
 
 test.prop([fc.boolean()])(

src/assertions/endsWith/index.ts

@@ -1,5 +1,5 @@
-import { error } from "@error";
 import type { Assertion } from "@the-minimal/types";
+import { ValidationError } from "@utils/error";
 
 /**
  * Checks if value ends with `searchString`.
@@ -19,4 +19,4 @@ import type { Assertion } from "@the-minimal/types";
 export const endsWith =
 	<$Input extends string>(input: $Input): Assertion<unknown> =>
 	(v: unknown) =>
-		(v as any).endsWith(input) || error(endsWith);
+		(v as any).endsWith(input) || ValidationError(endsWith);

src/assertions/expect/index.ts

@@ -1,5 +1,5 @@
-import { error } from "@error";
 import type { UnknownAssertion } from "@the-minimal/types";
+import { ValidationError } from "@utils/error";
 
 /**
  * Wraps assertion and throws an error with message if assertion fails.
@@ -23,6 +23,6 @@ export const expect = <$Assertion extends UnknownAssertion>(
 		try {
 			assertion(v);
 		} catch (e) {
-			error(assertion, message(e, v));
+			ValidationError(assertion, message(e, v));
 		}
 	}) as $Assertion;

src/assertions/includes/index.ts

@@ -1,5 +1,5 @@
-import { error } from "@error";
 import type { Assertion } from "@the-minimal/types";
+import { ValidationError } from "@utils/error";
 
 /**
  * Checks if value includes with another value.
@@ -17,4 +17,4 @@ import type { Assertion } from "@the-minimal/types";
 export const includes =
 	(input: unknown): Assertion<unknown> =>
 	(v: unknown) =>
-		(v as any).includes(input) || error(includes);
+		(v as any).includes(input) || ValidationError(includes);

src/assertions/integer/index.ts

@@ -1,5 +1,5 @@
-import { error } from "@error";
 import type { Assertion } from "@the-minimal/types";
+import { ValidationError } from "@utils/error";
 
 /**
  * Checks if value is integer.
@@ -11,4 +11,4 @@ import type { Assertion } from "@the-minimal/types";
  * ```
  */
 export const integer: Assertion<unknown> = (v: unknown) =>
-	Number.isInteger(v) || error(integer);
+	Number.isInteger(v) || ValidationError(integer);

src/assertions/isArray/index.ts

@@ -1,5 +1,5 @@
-import { error } from "@error";
 import type { Assertion } from "@the-minimal/types";
+import { ValidationError } from "@utils/error";
 
 /**
  * Checks that the value is an array.
@@ -11,4 +11,4 @@ import type { Assertion } from "@the-minimal/types";
  * ```
  */
 export const isArray: Assertion<unknown[]> = (v: unknown) =>
-	Array.isArray(v) || error(isArray);
+	Array.isArray(v) || ValidationError(isArray);

src/assertions/isObject/index.ts

@@ -1,5 +1,5 @@
-import { error } from "@error";
 import type { Assertion } from "@the-minimal/types";
+import { ValidationError } from "@utils/error";
 
 /**
  * Checks that the value is of type object and is not null.
@@ -12,4 +12,4 @@ import type { Assertion } from "@the-minimal/types";
  * ```
  */
 export const isObject: Assertion<Record<string, unknown>> = (v: unknown) =>
-	(v !== null && typeof v === "object") || error(isObject);
+	(v !== null && typeof v === "object") || ValidationError(isObject);

src/assertions/length/index.ts

@@ -1,5 +1,5 @@
-import { error } from "@error";
 import type { Assertion } from "@the-minimal/types";
+import { ValidationError } from "@utils/error";
 
 /**
  * Checks if length of value is equal to the provided length.
@@ -17,4 +17,4 @@ import type { Assertion } from "@the-minimal/types";
 export const length =
 	(input: number): Assertion<unknown> =>
 	(v: unknown) =>
-		(v as any).length === input || error(length);
+		(v as any).length === input || ValidationError(length);

src/assertions/maxLength/index.ts

@@ -1,5 +1,5 @@
-import { error } from "@error";
 import type { Assertion } from "@the-minimal/types";
+import { ValidationError } from "@utils/error";
 
 /**
  * Checks if length of value is less than or equal to the provided length.
@@ -17,4 +17,4 @@ import type { Assertion } from "@the-minimal/types";
 export const maxLength =
 	(length: number): Assertion<unknown> =>
 	(v: unknown) =>
-		(v as any).length <= length || error(maxLength);
+		(v as any).length <= length || ValidationError(maxLength);

src/assertions/maxValue/index.ts

@@ -1,4 +1,4 @@
-import { error } from "@error";
+import { ValidationError } from "@utils/error";
 
 /**
  * Checks if value is less than or equal to the provided length.
@@ -14,4 +14,4 @@ import { error } from "@error";
  * ```
  */
 export const maxValue = (input: unknown) => (v: unknown) =>
-	<any>v <= <any>input || error(maxValue);
+	<any>v <= <any>input || ValidationError(maxValue);

src/assertions/minLength/index.ts

@@ -1,5 +1,5 @@
-import { error } from "@error";
 import type { Assertion } from "@the-minimal/types";
+import { ValidationError } from "@utils/error";
 
 /**
  * Checks if length of value is greater than or equal to the provided length.
@@ -17,4 +17,4 @@ import type { Assertion } from "@the-minimal/types";
 export const minLength =
 	(length: number): Assertion<unknown> =>
 	(v: unknown) =>
-		(v as any).length >= length || error(minLength);
+		(v as any).length >= length || ValidationError(minLength);

src/assertions/minValue/index.ts

@@ -1,5 +1,5 @@
-import { error } from "@error";
 import type { Assertion } from "@the-minimal/types";
+import { ValidationError } from "@utils/error";
 
 /**
  * Checks if value is greater than or equal to the provided length.
@@ -17,4 +17,4 @@ import type { Assertion } from "@the-minimal/types";
 export const minValue =
 	(input: unknown): Assertion<unknown> =>
 	(v: unknown) =>
-		<any>v >= <any>input || error(minValue);
+		<any>v >= <any>input || ValidationError(minValue);

src/assertions/modulo/index.ts

@@ -1,5 +1,5 @@
-import { error } from "@error";
 import type { Assertion } from "@the-minimal/types";
+import { ValidationError } from "@utils/error";
 
 /**
  * Checks if the remainer is equal to the specified value when the input is divided by the divider.
@@ -18,4 +18,4 @@ import type { Assertion } from "@the-minimal/types";
 export const modulo =
 	(divider: number, remainder: number): Assertion<unknown> =>
 	(v: unknown) =>
-		<number>v % divider === remainder || error(modulo);
+		<number>v % divider === remainder || ValidationError(modulo);