@ptolemy2002/regex-utils 2.2.0 → 2.2.2

package/README.md

@@ -20,6 +20,9 @@ type TransformRegexOptions = {
 };
 export type ZodValidator<O> = (v: O) => boolean;
 export type ZodValidatorWithErrors<O> = (v: O) => true | string | string[];
+export type ZodSafeParseable<O> = {
+    safeParse: (v: unknown) => { success: boolean, data?: O, error?: ZodError };
+};
 ```
 
 ## Functions
@@ -127,7 +130,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.
+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>`.
 
 #### Parameters
 - `e` (`ZodError`): The zod error to be interpreted.
@@ -140,7 +143,7 @@ Given a zod error, interprets it to `null` if no error is found, a single error
 This is a simple function that takes a zod schema, returning a function that takes a value. If the value matches, the function returns `true`. Otherwise, it returns `false`. `O` refers to the output type of the zod schema, which should be the same as its input type.
 
 #### Parameters
-- `p` (`ZodSchema<O>`): The zod schema to be used for validation.
+- `p` (`ZodSafeParseable<O>`): The zod schema to be used for validation.
 
 #### Returns
 `ZodValidator<O>` - A function that takes a value and returns `true` if the value matches the schema, `false` otherwise.
@@ -150,7 +153,7 @@ This is a simple function that takes a zod schema, returning a function that tak
 This is a simple function that takes a zod schema, returning a function that takes a value. If the value matches, the function returns `true`. Otherwise, it returns the result of `interpretZodError` on the error. `O` refers to the output type of the zod schema, which should be the same as its input type.
 
 #### Parameters
-- `p` (`ZodSchema<O>`): The zod schema to be used for validation.
+- `p` (`ZodSafeParseable<O>`): The zod schema to be used for validation.
 
 #### Returns
 `ZodValidatorWithErrors<O>` - A function that takes a value and returns `true` if the value matches the schema, an error message if there is a single error, or an array of error messages if there are multiple errors.

package/dist/index.d.ts

@@ -1,4 +1,4 @@
-import { z, ZodError, ZodSchema } from "zod";
+import { z, ZodError } from "zod";
 export type RegexInput = string | RegExp;
 export declare function combineFlags(...flags: string[]): string;
 export declare function escapeRegex(value: RegexInput, flags?: string): RegExp;
@@ -18,8 +18,15 @@ export declare function isValidRegexFlags(value: string): boolean;
 export type ZodValidator<O> = (v: O) => boolean;
 export type ZodValidatorWithErrors<O> = (v: O) => true | string | string[];
 export declare function interpretZodError(e: ZodError): string | string[] | null;
-export declare function zodValidate<O>(p: ZodSchema<O>): ZodValidator<O>;
-export declare function zodValidateWithErrors<O>(p: ZodSchema<O>): ZodValidatorWithErrors<O>;
+export type ZodSafeParseable<O> = {
+    safeParse: (v: unknown) => {
+        success: boolean;
+        data?: O;
+        error?: ZodError;
+    };
+};
+export declare function zodValidate<O>(p: ZodSafeParseable<O>): ZodValidator<O>;
+export declare function zodValidateWithErrors<O>(p: ZodSafeParseable<O>): ZodValidatorWithErrors<O>;
 export declare function isAlphanumeric(str: string): boolean;
 export declare function toAlphanumeric(str: string, separator?: string): string;
 export declare function isValidEmail(v: string): boolean;

package/dist/index.js

@@ -113,11 +113,17 @@ function isValidRegexFlags(value) {
 }
 function interpretZodError(e) {
     const { errors } = e;
+    function formatIssue(issue) {
+        const { path, message } = issue;
+        if (path.length === 0)
+            return message;
+        return `${path.join(".")}: ${message}`;
+    }
     if (errors.length === 0)
         return null;
     if (errors.length === 1)
-        return e.errors[0].message;
-    return errors.map((e) => e.message);
+        return formatIssue(errors[0]);
+    return errors.map((e) => formatIssue(e));
 }
 function zodValidate(p) {
     return (v) => {

package/package.json

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