@ptolemy2002/regex-utils 2.0.1 → 2.2.0

package/README.md

@@ -125,6 +125,16 @@ Checks if a string is a valid set of regular expression flags.
 #### Returns
 `boolean` - `true` if the string is a valid set of regular expression flags, `false` otherwise.
 
+### 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.
+
+#### Parameters
+- `e` (`ZodError`): The zod error to be interpreted.
+
+#### Returns
+`string | string[] | null` - The interpreted error message(s).
+
 ### zodValidate<O>
 #### Description
 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.
@@ -137,7 +147,7 @@ This is a simple function that takes a zod schema, returning a function that tak
 
 ### zodValidateWithErrors<O>
 #### Description
-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 a single error message or an array of error messages if there are multiple errors. `O` refers to the output type of the zod schema, which should be the same as its input type.
+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.
@@ -206,6 +216,15 @@ Uses `zodValidate` to check if a string is a valid Social Security Number (SSN).
 #### Returns
 `boolean` - `true` if the string is a valid SSN, `false` otherwise.
 
+## Schemas
+The following schemas are available in the library:
+
+### ZodCoercedBooleanEnum
+A zod schema that specifies an enum of strings that can be interpreted as booleans. This is used within `ZodCoercedBoolean` to actually perform the coercion.
+
+### ZodCoercedBoolean
+A zod schema that takes in a value accepted by `ZodCoercedBooleanEnum` and coerces it to a boolean. This is useful when you want to accept multiple values that can be interpreted as booleans.
+
 ## Peer Dependencies
 These should be installed in order to use the library, as npm does not automatically add peer dependencies to your project.
 - zod: ^3.23.8

package/dist/index.d.ts

@@ -1,4 +1,4 @@
-import { ZodSchema } from "zod";
+import { z, ZodError, ZodSchema } from "zod";
 export type RegexInput = string | RegExp;
 export declare function combineFlags(...flags: string[]): string;
 export declare function escapeRegex(value: RegexInput, flags?: string): RegExp;
@@ -17,6 +17,7 @@ export declare function isValidRegex(value: string, flags?: string): boolean;
 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 declare function isAlphanumeric(str: string): boolean;
@@ -25,3 +26,5 @@ export declare function isValidEmail(v: string): boolean;
 export declare function isValidURL(v: string): boolean;
 export declare function isValidPhoneNumber(v: string): boolean;
 export declare function isValidSSN(v: string): boolean;
+export declare const ZodCoercedBooleanEnum: z.ZodEnum<["true", "false", "t", "f", "yes", "no", "y", "n", "1", "0", "on", "off"]>;
+export declare const ZodCoercedBoolean: z.ZodEffects<z.ZodEnum<["true", "false", "t", "f", "yes", "no", "y", "n", "1", "0", "on", "off"]>, boolean, "0" | "1" | "true" | "false" | "t" | "f" | "yes" | "no" | "y" | "n" | "on" | "off">;

package/dist/index.js

@@ -1,5 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
+exports.ZodCoercedBoolean = exports.ZodCoercedBooleanEnum = void 0;
 exports.combineFlags = combineFlags;
 exports.escapeRegex = escapeRegex;
 exports.regexAccentInsensitive = regexAccentInsensitive;
@@ -9,6 +10,7 @@ exports.regexMatchWhole = regexMatchWhole;
 exports.transformRegex = transformRegex;
 exports.isValidRegex = isValidRegex;
 exports.isValidRegexFlags = isValidRegexFlags;
+exports.interpretZodError = interpretZodError;
 exports.zodValidate = zodValidate;
 exports.zodValidateWithErrors = zodValidateWithErrors;
 exports.isAlphanumeric = isAlphanumeric;
@@ -109,6 +111,14 @@ function isValidRegex(value, flags = "") {
 function isValidRegexFlags(value) {
     return /^[gimsuy]*$/.test(value);
 }
+function interpretZodError(e) {
+    const { errors } = e;
+    if (errors.length === 0)
+        return null;
+    if (errors.length === 1)
+        return e.errors[0].message;
+    return errors.map((e) => e.message);
+}
 function zodValidate(p) {
     return (v) => {
         const result = p.safeParse(v);
@@ -120,9 +130,7 @@ function zodValidateWithErrors(p) {
         const result = p.safeParse(v);
         if (result.success)
             return true;
-        if (result.error.errors.length === 1)
-            return result.error.errors[0].message;
-        return result.error.errors.map((e) => e.message);
+        return interpretZodError(result.error);
     };
 }
 const alphanumericPattern = /[\w_-]+/i;
@@ -150,3 +158,29 @@ function isValidPhoneNumber(v) {
 function isValidSSN(v) {
     return zodValidate(zod_1.z.coerce.string().regex(/^\d{3}-?\d{2}-?\d{4}$/))(v);
 }
+exports.ZodCoercedBooleanEnum = zod_1.z.enum([
+    "true", "false",
+    "t", "f",
+    "yes", "no",
+    "y", "n",
+    "1", "0",
+    "on", "off"
+]);
+exports.ZodCoercedBoolean = exports.ZodCoercedBooleanEnum.transform((val) => {
+    switch (val) {
+        case "true":
+        case "t":
+        case "yes":
+        case "y":
+        case "1":
+        case "on":
+            return true;
+        case "false":
+        case "f":
+        case "no":
+        case "n":
+        case "0":
+        case "off":
+            return false;
+    }
+});

package/package.json

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