chore: add fromZodError runtime check to throw TypeError on bad usage (…

…#296)

* chore: handles and throws TypeError on fromZodError invalid use

* chore: add changeset

* chore: better TypeError message

.changeset/itchy-elephants-judge.md

@@ -0,0 +1,5 @@
+---
+'zod-validation-error': minor
+---
+
+Add runtime check in `fromZodError` and throw dev-friendly `TypeError` suggesting usage of `fromError` instead

lib/fromZodError.test.ts

@@ -454,4 +454,19 @@ describe('fromZodError()', () => {
       }
     }
   });
+
+  test('throws a dev-friendly TypeError on invalid input', () => {
+    const input = new Error("I wish I was a ZodError, but I'm not");
+
+    try {
+      // @ts-expect-error
+      fromZodError(input);
+    } catch (err) {
+      expect(err).toBeInstanceOf(TypeError);
+      // @ts-expect-error
+      expect(err.message).toMatchInlineSnapshot(
+        `"Invalid zodError param; expected instance of ZodError. Did you mean to use the "fromError" method instead?"`
+      );
+    }
+  });
 });

lib/fromZodError.ts

@@ -1,3 +1,4 @@
+import * as zod from 'zod';
 import {
   ISSUE_SEPARATOR,
   MAX_ISSUES_IN_MESSAGE,
@@ -8,8 +9,8 @@ import {
 import { getMessageFromZodIssue } from './fromZodIssue.ts';
 import { prefixMessage } from './prefixMessage.ts';
 import { ValidationError } from './ValidationError.ts';
+import { fromError } from './fromError.ts';
 import type { FromZodIssueOptions } from './fromZodIssue.ts';
-import type * as zod from 'zod';
 
 export type ZodError = zod.ZodError;
 
@@ -21,6 +22,12 @@ export function fromZodError(
   zodError: ZodError,
   options: FromZodErrorOptions = {}
 ): ValidationError {
+  if (!(zodError instanceof zod.ZodError)) {
+    throw new TypeError(
+      `Invalid zodError param; expected instance of ZodError. Did you mean to use the "${fromError.name}" method instead?`
+    );
+  }
+
   const {
     maxIssuesInMessage = MAX_ISSUES_IN_MESSAGE,
     issueSeparator = ISSUE_SEPARATOR,