@jdlien/validator 1.0.3 → 1.0.4

package/README.md

@@ -1,4 +1,4 @@
-# Validator
+# Validator - HTML Form Validation Made Easy
 
 ## Introduction
 
@@ -162,7 +162,7 @@ You can customize the class(es) that Validator uses to hide the error messages b
 
 ## Color Picker Support
 
-If you need to allow a user to pick a color, you can use data-type="color" and the input will be required to be any valid CSS color supported by the browser. This type can also work in conjunction with a native color input. If you do this, you will need to add an input with the name of the data-color input + `-color`, and this should be inside a linked label which will become the color preview swatch. Such a label should have a label of the color input's name + `-color-label`.
+If you need to allow a user to pick a color, you can use data-type="color" and the input will be required to be any valid CSS color supported by the browser. This type can also work in conjunction with a native color input. If you do this, you will need to add an input with `type="color"` and the name of the data-color input + `-color`. This should be inside a linked label which will become the color preview swatch. Such a label should have an ID of the color input's name + `-color-label` so that Validator can change the background to the specified color.
 
 A basic example that would work:
 
@@ -241,6 +241,49 @@ const myValidator = new Validator(myForm, {
 })
 ```
 
+## Utility Functions
+
+Validator includes several utility functions that may be useful in your own code, so they are exported as part of the module.
+If you wish to use these, you may import the functions directly from the module as an object that contains all the functions:
+
+```javascript
+import { validatorUtils } from '@jdlien/validator'
+// you could assign the functions you need to more convenient variables
+const { dateFormat, formatDateTime } = validatorUtils
+```
+
+Here is a list of the utility functions:
+
+- **isFormControl**: Determines if an element is an HTML input, select, or textarea element.
+- **isType**: Checks if an element has a type or data-type attribute matching one of the passed values.
+- **momentToFPFormat**: Converts a moment.js-style format string to the flatpickr format.
+- **monthToNumber**: Converts month string or number to a zero-based month number (January == 0).
+- **yearToFull**: Converts a year string or number to a 4-digit year.
+- **parseDate**: Parses a date string or Date object into a Date object.
+- **parseTime**: Parses a time string into an object with hour, minute, and second properties.
+- **parseTimeToString**: Parses a time string into a formatted string.
+- **formatDateTime**: Formats a date string or Date object into a string with a specified format.
+- **parseDateToString**: Parses a date string or Date object into a formatted string with the specified moment.js-style date format.
+- **isDate**: Determines if a value is a valid date.
+- **isDateInRange**: Determines if a date falls within a specified range (either past or future).
+- **isTime**: Determines if a value is a valid time.
+- **isEmail**: Determines if a value is a valid email address.
+- **parseNANPTel**: Parses a North American phone number string into a standardized format.
+- **isNANPTel**: Determines if a value is a valid North American phone number.
+- **parseInteger**: Parses an integer string into a standardized format.
+- **isNumber**: Determines if a value is a valid number.
+- **parseNumber**: Parses a number string into a standardized format.
+- **isInteger**: Determines if a value is a valid integer.
+- **parseUrl**: Parses a URL string into a standardized format.
+- **isUrl**: Determines if a value is a valid URL.
+- **parseZip**: Parses a zip code string into a standardized format.
+- **isZip**: Determines if a value is a valid zip code.
+- **parsePostalCA**: Parses a Canadian postal code string into a standardized format.
+- **isPostalCA**: Determines if a value is a valid Canadian postal code.
+- **isColor**: Determines if a value is a valid color.
+- **parseColor**: Parses a color string into a standardized format.
+- **normalizeValidationResult**: Normalizes a validation result (like a boolean or string) into an object with a valid property and a messages array of strings.
+
 ## Contributing
 
 Install dev dependencies:
@@ -249,7 +292,7 @@ Install dev dependencies:
 npm install
 ```
 
-You may get an error like
+When running Vite you may get an error like
 
 ```
 Module did not self-register: '...\node_modules\canvas\build\Release\canvas.node'

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@jdlien/validator",
-  "version": "1.0.3",
+  "version": "1.0.4",
   "type": "module",
   "files": [
     "dist"