@ptolemy2002/regex-utils 1.0.4 → 1.2.0

package/README.md

@@ -109,9 +109,23 @@ 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.
 
+### zodValidate
+#### 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 whatever error message the zod schema provides by default, or `false` if the `returnError` flag is disabled.
+
+#### Parameters
+- `p` (`ZodSchema`): The zod schema to be used for validation.
+- `returnError` (`Boolean`): Whether to return the error message if the value does not match the schema. Default is `true`. If `false`, the function will return `false` on failure instead.
+
+#### Returns
+`Function` - A function that takes a value and returns `true` if the value matches the schema, an error message if the value does not match the schema and `returnError` is `true`, or `false` if the value does not match the schema and `returnError` is `false`.
+
+#### Returns
+`Function` - A function that takes a value and returns `true` if the value matches the schema, or an error message otherwise.
+
 ### isAlphanumeric
 #### Description
-Checks if a string is alphanumeric, that is, if it only contains letters, numbers, dashes, and underscores. Empty strings are not considered alphanumeric.
+Uses `zodValidate` to check if a string is alphanumeric, that is, if it only contains letters, numbers, dashes, and underscores. Empty strings are not considered alphanumeric.
 
 #### Parameters
 - `str` (`String`): The value to be checked.
@@ -132,7 +146,7 @@ Transforms a string to be alphanumeric by removing accents, separating it by non
 
 ### isValidEmail
 #### Description
-Attempts to check if a string is a valid email address. Note that this is a simple check and may not cover all cases, but it should be good enough for most purposes.
+Uses `zodValidate` to check if a string is a valid email address. Note that this is a simple check and may not cover all cases, but it should be good enough for most purposes.
 
 #### Parameters
 - `value` (`String`): The value to be checked.
@@ -142,7 +156,7 @@ Attempts to check if a string is a valid email address. Note that this is a simp
 
 ### isValidPhoneNumber
 #### Description
-Attempts to check if a string is a valid phone number. Note that this is a simple check and may not cover all cases, but it should be good enough for most purposes.
+Uses `zodValidate` to check if a string is a valid phone number. Note that this is a simple check and may not cover all cases, but it should be good enough for most purposes.
 
 #### Parameters
 - `value` (`String`): The value to be checked.
@@ -152,7 +166,7 @@ Attempts to check if a string is a valid phone number. Note that this is a simpl
 
 ### isValidURL
 #### Description
-Attempts to check if a string is a valid URL. Note that this is a simple check and may not cover all cases, but it should be good enough for most purposes.
+Uses `zodValidate` to check if a string is a valid URL. Note that this is a simple check and may not cover all cases, but it should be good enough for most purposes.
 
 #### Parameters
 - `value` (`String`): The value to be checked.
@@ -162,7 +176,7 @@ Attempts to check if a string is a valid URL. Note that this is a simple check a
 
 ### isValidSSN
 #### Description
-Attempts to check if a string is a valid Social Security Number (SSN). Note that this is a simple check and may not cover all cases, but it should be good enough for most purposes.
+Uses `zodValidate` to check if a string is a valid Social Security Number (SSN). Note that this is a simple check and may not cover all cases, but it should be good enough for most purposes.
 
 #### Parameters
 - `value` (`String`): The value to be checked.
@@ -174,7 +188,8 @@ Attempts to check if a string is a valid Social Security Number (SSN). Note that
 This is a React Library Created by Ptolemy2002's [cra-template-react-library](https://www.npmjs.com/package/@ptolemy2002/cra-template-react-library) template in combination with [create-react-app](https://www.npmjs.com/package/create-react-app). However, it does not actually depend on React - it has been modified to work out of the box. It contains methods of building and publishing your library to npm.
 
 ## Peer Dependencies
-This project does not have any peer dependencies, so it should work out of the box.
+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
 
 ## Commands
 The following commands exist in the project:

package/index.js

@@ -19,7 +19,6 @@ var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: tru
 // src/index.js
 var src_exports = {};
 __export(src_exports, {
-  alphanumericPattern: () => alphanumericPattern,
   combineFlags: () => combineFlags,
   escapeRegex: () => escapeRegex,
   isAlphanumeric: () => isAlphanumeric,
@@ -29,15 +28,16 @@ __export(src_exports, {
   isValidRegexFlags: () => isValidRegexFlags,
   isValidSSN: () => isValidSSN,
   isValidURL: () => isValidURL,
-  nonAlphanumericPattern: () => nonAlphanumericPattern,
   regexAccentInsensitive: () => regexAccentInsensitive,
   regexCaseInsensitive: () => regexCaseInsensitive,
   regexMatchWhole: () => regexMatchWhole,
   removeAccents: () => removeAccents,
   toAlphanumeric: () => toAlphanumeric,
-  transformRegex: () => transformRegex
+  transformRegex: () => transformRegex,
+  zodValidate: () => zodValidate
 });
 module.exports = __toCommonJS(src_exports);
+var import_zod = require("zod");
 var accentPatterns = [
   "(a|\xE1|\xE0|\xE4|\xE2|\xE3)",
   "(A|\xC1|\xC0|\xC4|\xC2|\xC3)",
@@ -135,10 +135,19 @@ function isValidRegex(value, flags = "") {
 function isValidRegexFlags(value) {
   return /^[gimsuy]*$/.test(value);
 }
+function zodValidate(p, returnError = true) {
+  return (v) => {
+    const result = p.safeParse(v);
+    if (result.success) return true;
+    if (!returnError) return false;
+    if (result.error.errors.length === 1) return result.error.errors[0].message;
+    return result.error.errors.map((e) => e.message);
+  };
+}
 var alphanumericPattern = /[\w_-]+/i;
 var nonAlphanumericPattern = /[^\w_-]+/i;
 function isAlphanumeric(str) {
-  return transformRegex(alphanumericPattern, { matchWhole: true }).test(str);
+  return zodValidate(import_zod.z.string().regex(transformRegex(alphanumericPattern, { matchWhole: true })), false)(str);
 }
 function toAlphanumeric(str, separator = "-") {
   const globalNonAlphanumericPattern = transformRegex(nonAlphanumericPattern, { flags: "g" });
@@ -149,14 +158,14 @@ function toAlphanumeric(str, separator = "-") {
   }).filter((word) => word).join(separator);
 }
 function isValidEmail(v) {
-  return /^\S+@\S+\.\S+$/.test(v);
-}
-function isValidPhoneNumber(v) {
-  return /^\+?\d?\s*(\(\d{3}\)|\d{3})(\s*|-)\d{3}(\s*|-)\d{4}$/.test(v);
+  return zodValidate(import_zod.z.string().email(), false)(v);
 }
 function isValidURL(v) {
-  return /^https?:\/\/\S+\.\S+$/.test(v);
+  return zodValidate(import_zod.z.string().url(), false)(v);
+}
+function isValidPhoneNumber(v) {
+  return zodValidate(import_zod.z.coerce.string().regex(/^\+?\d?\s*(\(\d{3}\)|\d{3})(\s*|-)\d{3}(\s*|-)\d{4}$/), false)(v);
 }
 function isValidSSN(v) {
-  return /^\d{3}-?\d{2}-?\d{4}$/.test(v);
+  return zodValidate(import_zod.z.coerce.string().regex(/^\d{3}-?\d{2}-?\d{4}$/), false)(v);
 }

package/package.json

@@ -1,12 +1,12 @@
 {
     "name": "@ptolemy2002/regex-utils",
-    "version": "1.0.4",
+    "version": "1.2.0",
     "main": "index.js",
     "files": [
         "index.js"
     ],
     "scripts": {
-        "build": "esbuild src/index.js --bundle --format=cjs --outfile=index.js --loader:.js=jsx --external:react --external:react-dom --external:@types/react --external:@types/react-dom",
+        "build": "esbuild src/index.js --bundle --format=cjs --outfile=index.js --loader:.js=jsx --external:zod",
         "postinstall": "npx typesync",
         "uninstall": "bash ./scripts/uninstall.sh",
         "reinstall": "bash ./scripts/reinstall.sh",
@@ -26,8 +26,10 @@
     },
     "description": "Utilities for working with regular expressions",
     "license": "ISC",
-    "peerDependencies": {},
     "devDependencies": {
         "esbuild": "^0.23.0"
+    },
+    "peerDependencies": {
+        "zod": "^3.23.8"
     }
 }