@ptolemy2002/regex-utils 2.5.0 → 2.6.0

package/README.md

@@ -153,7 +153,7 @@ Checks if a string is a valid set of regular expression flags.
 
 ### interpretZodError
 #### Description
-Given a zod error, interprets it to `null` if no error is found, a single error message if there is a single error, or an array of error messages if there are multiple errors. The error messages will be in the format `<path>: <message>`.
+Given a zod error, interprets it to `null` if no error is found, a single error message if there is a single error, or an array of error messages if there are multiple errors. The error messages will be in the format `<path>: <message>`. If the error is with function arguments, "arguments.<index>" will be appended to the end of the path. Similarly, if the error is with a function return value, "returnValue" will be appended to the end of the path. Note that for function arguments, only the first seen error will be reported.
 
 #### Parameters
 - `e` (`ZodError`): The zod error to be interpreted.

package/dist/index.d.ts

@@ -21,7 +21,7 @@ export type InterpretZodErrorOptions = {
     prefix?: string | string[];
     separator?: string;
 };
-export declare function interpretZodError(e: ZodError, { prefix, separator }: InterpretZodErrorOptions): string | string[] | null;
+export declare function interpretZodError(e: ZodError, { prefix, separator }?: InterpretZodErrorOptions): string | string[] | null;
 export type ZodSafeParseable<O> = {
     safeParse: (v: unknown) => z.SafeParseReturnType<unknown, O>;
 };

package/dist/index.js

@@ -111,10 +111,10 @@ function isValidRegex(value, flags = "") {
 function isValidRegexFlags(value) {
     return /^[gimsuy]*$/.test(value);
 }
-function interpretZodError(e, { prefix, separator = "." }) {
+function interpretZodError(e, { prefix, separator = "." } = {}) {
     const { errors } = e;
     function formatIssue(issue) {
-        const { path: _path, message } = issue;
+        const { code, path: _path, message } = issue;
         let path = _path;
         if (typeof prefix === "string") {
             path = [prefix, ...path];
@@ -122,6 +122,16 @@ function interpretZodError(e, { prefix, separator = "." }) {
         else if (Array.isArray(prefix)) {
             path = [...prefix, ...path];
         }
+        if (code === "invalid_return_type") {
+            const returnTypeIssue = issue.returnTypeError.errors[0];
+            path = [...path, "returnType", ...returnTypeIssue.path];
+            return `${path.join(separator)}: ${returnTypeIssue.message}`;
+        }
+        else if (code === "invalid_arguments") {
+            const argumentsIssue = issue.argumentsError.errors[0];
+            path = [...path, "arguments", ...argumentsIssue.path];
+            return `${path.join(separator)}: ${argumentsIssue.message}`;
+        }
         if (path.length === 0)
             return message;
         return `${path.join(separator)}: ${message}`;

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@ptolemy2002/regex-utils",
-    "version": "2.5.0",
+    "version": "2.6.0",
     "private": false,
     "main": "dist/index.js",
     "types": "dist/index.d.ts",