@cocreate/validation 1.19.0 → 2.0.0

package/CONTRIBUTING.md

@@ -1,19 +1,19 @@
 # Contributing to CoCreate-validation
 
-This project is work of [many contributors](https://github.com/CoCreate-app/CoCreate-validation/graphs/contributors).
-You're encouraged to submit [pull requests](https://github.com/CoCreate-app/CoCreate-validation/pulls),
-[propose features and discuss issues](https://github.com/CoCreate-app/CoCreate-validation/issues).
+This project is work of [many contributors](https://github.com/CoCreateJS/validation/graphs/contributors).
+You're encouraged to submit [pull requests](https://github.com/CoCreateJS/validation/pulls),
+[propose features and discuss issues](https://github.com/CoCreateJS/validation/issues).
 
 In the examples below, substitute your Github username for `contributor` in URLs.
 
 ## Fork the Project
 
-Fork the [project on Github](https://github.com/CoCreate-app/CoCreate-validation) and check out your copy.
+Fork the [project on Github](https://github.com/CoCreateJS/validation) and check out your copy.
 
 ```
 git clone https://github.com/contributor/CoCreate-validation.git
 cd CoCreate-validation
-git remote add upstream https://github.com/CoCreate-app/CoCreate-validation.git
+git remote add upstream https://github.com/CoCreateJS/validation.git
 ```
 
 ## Create a Topic Branch
@@ -75,7 +75,7 @@ git push origin my-feature-branch
 
 ## Make a Pull Request
 
-Go to [https://github.com/CoCreate-app/CoCreate-validation](https://github.com/CoCreate-app/CoCreate-validation) and select your feature branch.
+Go to [https://github.com/CoCreateJS/validation](https://github.com/CoCreateJS/validation) and select your feature branch.
 Click the 'Pull Request' button and fill out the form. Pull requests are usually reviewed within a few days.
 
 ## Rebase

package/README.md

@@ -1,91 +1,142 @@
-# CoCreate-validation
-
-A simple validation component in vanilla javascript. Easily configured using HTML5 attributes and/or JavaScript API. Take it for a spin in our [playground!](https://cocreate.app/docs/validation)
-
-![min file size in bytes](https://img.badgesize.io/https://cdn.cocreate.app/validation/latest/CoCreate-validation.min.js?style=flat-square&label=minified&color=orange)
-![gzip file size in bytes](https://img.badgesize.io/https://cdn.cocreate.app/validation/latest/CoCreate-validation.min.js?compression=gzip&style=flat-square&label=gzip&color=yellow)
-![brotlifile size in bytes](https://img.badgesize.io/https://cdn.cocreate.app/validation/latest/CoCreate-validation.min.js?compression=brotli&style=flat-square&label=brotli)
-![GitHub latest release](https://img.shields.io/github/v/release/CoCreate-app/CoCreate-validation?style=flat-square)
-![GitHub](https://img.shields.io/github/license/CoCreate-app/CoCreate-validation?style=flat-square)
-![GitHub](https://img.shields.io/static/v1?style=flat-square&label=&message=Hiring&color=blueviolet)
-
-![CoCreate-validation](https://cdn.cocreate.app/docs/CoCreate-validation.gif)
-
-## [Docs & Demo](https://cocreate.app/docs/validation)
-
-For a complete guide and working demo refer to the [doumentation](https://cocreate.app/docs/validation)
-
-## CDN
-
-```html
-<script src="https://cdn.cocreate.app/validation/latest/CoCreate-validation.min.js"></script>
-```
-
-```html
-<script src="https://cdn.cocreate.app/validation/latest/CoCreate-validation.min.css"></script>
-```
-
-## NPM
-
-```shell
-$ npm i @cocreate/validation
-```
-
-## yarn
-
-```shell
-$ yarn install @cocreate/validation
-```
-
-# Table of Contents
-
--   [Table of Contents](#table-of-contents)
--   [Announcements](#announcements)
--   [Roadmap](#roadmap)
--   [How to Contribute](#how-to-contribute)
--   [About](#about)
--   [License](#license)
-
-<a name="announcements"></a>
-
-# Announcements
-
-All updates to this library are documented in our [CHANGELOG](https://github.com/CoCreate-app/CoCreate-validation/blob/master/CHANGELOG.md) and [releases](https://github.com/CoCreate-app/CoCreate-validation/releases). You may also subscribe to email for releases and breaking changes.
-
-<a name="roadmap"></a>
-
-# Roadmap
-
-If you are interested in the future direction of this project, please take a look at our open [issues](https://github.com/CoCreate-app/CoCreate-validation/issues) and [pull requests](https://github.com/CoCreate-app/CoCreate-validation/pulls). We would love to hear your feedback.
-
-<a name="about"></a>
-
-# About
-
-CoCreate-validation is guided and supported by the CoCreate Developer Experience Team.
-
-Please Email the Developer Experience Team [here](mailto:develop@cocreate.app) in case of any queries.
-
-CoCreate-validation is maintained and funded by CoCreate. The names and logos for CoCreate are trademarks of CoCreate, LLC.
-
-<a name="contribute"></a>
-
-# How to Contribute
-
-We encourage contribution to our libraries (you might even score some nifty swag), please see our [CONTRIBUTING](https://github.com/CoCreate-app/CoCreate-validation/blob/master/CONTRIBUTING.md) guide for details.
-
-We want this library to be community-driven, and CoCreate led. We need your help to realize this goal. To help make sure we are building the right things in the right order, we ask that you create [issues](https://github.com/CoCreate-app/CoCreate-validation/issues) and [pull requests](https://github.com/CoCreate-app/CoCreate-validation/pulls) or merely upvote or comment on existing issues or pull requests.
-
-We appreciate your continued support, thank you!
-
-<a name="license"></a>
-
-# License
-
-This software is dual-licensed under the GNU Affero General Public License version 3 (AGPLv3) and a commercial license.
-
--   **Open Source Use**: For open-source projects and non-commercial use, this software is available under the AGPLv3. The AGPLv3 allows you to freely use, modify, and distribute this software, provided that all modifications and derivative works are also licensed under the AGPLv3. For the full license text, see the [LICENSE file](https://github.com/CoCreate-app/CoCreate-validation/blob/master/LICENSE).
-
--   **Commercial Use**: For-profit companies and individuals intending to use this software for commercial purposes must obtain a commercial license. The commercial license is available when you sign up for an API key on our [website](https://cocreate.app). This license permits proprietary use and modification of the software without the copyleft requirements of the AGPLv3. It is ideal for integrating this software into proprietary commercial products and applications.
-
-If you have not purchased a commercial license and intend to use this software for commercial purposes, you are required to sign up for an API key on our website.
+# CoCreate-validation
+
+A simple validation component in vanilla javascript. Easily configured using HTML5 attributes and/or JavaScript API. Take it for a spin in our [playground!](https://CoCreateJS.com/docs/validation)
+
+![min file size in bytes](https://img.badgesize.io/https://cdn.CoCreateJS.com/validation/latest/CoCreate-validation.min.js?style=flat-square&label=minified&color=orange)
+![gzip file size in bytes](https://img.badgesize.io/https://cdn.CoCreateJS.com/validation/latest/CoCreate-validation.min.js?compression=gzip&style=flat-square&label=gzip&color=yellow)
+![brotlifile size in bytes](https://img.badgesize.io/https://cdn.CoCreateJS.com/validation/latest/CoCreate-validation.min.js?compression=brotli&style=flat-square&label=brotli)
+![GitHub latest release](https://img.shields.io/github/v/release/CoCreateJS/validation?style=flat-square)
+![GitHub](https://img.shields.io/github/license/CoCreateJS/validation?style=flat-square)
+![GitHub](https://img.shields.io/static/v1?style=flat-square&label=&message=Hiring&color=blueviolet)
+
+![CoCreate-validation](https://cdn.CoCreateJS.com/docs/CoCreate-validation.gif)
+
+## [Docs & Demo](https://CoCreateJS.com/docs/validation)
+
+For a complete guide and working demo refer to the [doumentation](https://CoCreateJS.com/docs/validation)
+
+## CDN
+
+```html
+<script src="https://cdn.CoCreateJS.com/validation/latest/CoCreate-validation.min.js"></script>
+```
+
+```html
+<script src="https://cdn.CoCreateJS.com/validation/latest/CoCreate-validation.min.css"></script>
+```
+
+## NPM
+
+```shell
+$ npm i @cocreate/validation
+```
+
+## yarn
+
+```shell
+$ yarn install @cocreate/validation
+```
+
+# Table of Contents
+
+-   [Table of Contents](#table-of-contents)
+-   [Announcements](#announcements)
+-   [Roadmap](#roadmap)
+-   [How to Contribute](#how-to-contribute)
+-   [About](#about)
+-   [License](#license)
+
+<a name="announcements"></a>
+
+# Announcements
+
+All updates to this library are documented in our [CHANGELOG](https://github.com/CoCreateJS/validation/blob/master/CHANGELOG.md) and [releases](https://github.com/CoCreateJS/validation/releases). You may also subscribe to email for releases and breaking changes.
+
+<a name="roadmap"></a>
+
+# Roadmap
+
+If you are interested in the future direction of this project, please take a look at our open [issues](https://github.com/CoCreateJS/validation/issues) and [pull requests](https://github.com/CoCreateJS/validation/pulls). We would love to hear your feedback.
+
+<a name="about"></a>
+
+# About
+
+CoCreate-validation is guided and supported by the CoCreate Developer Experience Team.
+
+Please Email the Developer Experience Team [here](mailto:develop@CoCreateJS.com) in case of any queries.
+
+CoCreate-validation is maintained and funded by CoCreate. The names and logos for CoCreate are trademarks of CoCreate, LLC.
+
+<a name="contribute"></a>
+
+# How to Contribute
+
+We encourage contribution to our libraries (you might even score some nifty swag), please see our [CONTRIBUTING](https://github.com/CoCreateJS/validation/blob/master/CONTRIBUTING.md) guide for details.
+
+We want this library to be community-driven, and CoCreate led. We need your help to realize this goal. To help make sure we are building the right things in the right order, we ask that you create [issues](https://github.com/CoCreateJS/validation/issues) and [pull requests](https://github.com/CoCreateJS/validation/pulls) or merely upvote or comment on existing issues or pull requests.
+
+We appreciate your continued support, thank you!
+
+<a name="license"></a>
+
+# License
+
+This software is dual-licensed under the GNU Affero General Public License version 3 (AGPLv3) and a commercial license.
+
+-   **Open Source Use**: For open-source projects and non-commercial use, this software is available under the AGPLv3. The AGPLv3 allows you to freely use, modify, and distribute this software, provided that all modifications and derivative works are also licensed under the AGPLv3. For the full license text, see the [LICENSE file](https://github.com/CoCreateJS/validation/blob/master/LICENSE).
+
+-   **Commercial Use**: For-profit companies and individuals intending to use this software for commercial purposes must obtain a commercial license. The commercial license is available when you sign up for an API key on our [website](https://CoCreateJS.com). This license permits proprietary use and modification of the software without the copyleft requirements of the AGPLv3. It is ideal for integrating this software into proprietary commercial products and applications.
+
+If you have not purchased a commercial license and intend to use this software for commercial purposes, you are required to sign up for an API key on our website.
+
+
+### Action lifecycle and native constraints
+
+Use `actions="disabled, validate, save, disabled"` to disable the button while
+validating and saving, then explicitly enable it on success. Validation failure
+or an exception calls `action.abort()`, which releases a button disabled by that
+chain. Validation success calls `action.end()` and continues the chain.
+
+Native controls use the browser constraint validation API for `required`, input
+types, `pattern`, ranges, and other supported constraints. Custom messages set
+with `element.setCustomValidity(message)` are preserved; clear them with
+`element.setCustomValidity("")` when resolved. Fields with `aria-errormessage` display errors in their referenced elements.
+Without a valid target, errors render into `template="notification"` and the first
+invalid native field reports its browser message.
+Disabled controls and controls barred from native validation are skipped.
+`novalidate` on the form or `formnovalidate` on the action element skips the native
+checks; explicitly configured CoCreate rules still run.
+
+Custom `matches` validators are awaited. A `valid="false"` value marks the
+element invalid; `valid="true"` passes this rule. Validation writes its
+combined result to `validation` and `aria-invalid`. Use native `required`,
+`type="email"`, `pattern`, and `minlength`/`maxlength` attributes for browser
+constraints; the custom `email`, `subdomain`, and `length` attributes have been
+removed. Non-native elements need their own custom validation.
+Each validator registered in `validations` receives its matching elements and
+returns an array of failed elements (or nothing on success). Results are combined
+so one passing rule cannot erase another rule's failure. `validation` and
+`aria-invalid` reflect the combined result. Non-native elements can still use
+CoCreate attributes and `getValue()`. `validate(selector)` scopes validation to
+the matching elements and their descendants.
+
+### Inline field errors
+
+```html
+<label for="email">Email</label>
+<input id="email" type="email" required aria-errormessage="email-error" />
+<span id="email-error" hidden></span>
+```
+
+Native and CoCreate validation messages use this same explicit relationship.
+Validation reveals the target and updates `aria-invalid`; successful revalidation
+clears and hides the message. `aria-describedby` help text is left intact.
+Messages are inserted as text, not HTML. Linked errors do not also generate a
+notification. Missing targets fall back to notifications.
+
+Custom validators may accept a second `report` callback and call
+`report({ data: [{ type: "rule", status: "error", success: false,
+message: "Explain the error", elements: failedElements }] })` before returning
+`failedElements`. The action collects these reports and presents the first
+reported error per field after all rules finish.

package/demo/index.html

@@ -14,7 +14,7 @@
     </head>
 
     <body>
-        <!--<script src="https://cdn.cocreate.app/validation/latest/CoCreate-validation.min.js"></script>-->
-        <script src="https://CoCreate.app/dist/CoCreate.js"></script>
+        <!--<script src="https://cdn.CoCreateJS.com/validation/latest/CoCreate-validation.min.js"></script>-->
+        <script src="https://CoCreateJS.com/dist/CoCreate.js"></script>
     </body>
 </html>

package/docs/index.html

@@ -9,7 +9,7 @@
 			rel="icon"
 			type="image/png"
 			sizes="32x32"
-			href="https://cocreate.app/images/favicon.ico" />
+			href="https://CoCreateJS.com/images/favicon.ico" />
 		<meta
 			name="description"
 			content="A simple HTML5 and pure javascript component. Easy configuration using HTML5 attributes or Javscript api and highly styleable." />
@@ -68,7 +68,7 @@
 					share-width="500"
 					share-media="https://via.placeholder.com/300/09f/fff.png">
 					<a
-						href="https://github.com/CoCreate-app/CoCreate-validation"
+						href="https://github.com/CoCreateJS/CoCreate-validation"
 						target="_blank"
 						class="margin-right:15px"
 						><i src="/assets/svg/github.svg"></i
@@ -112,7 +112,7 @@
 					<pre
 						class="margin-top:15px"><code class="language-javascript">npm install cocreate-validation</code></pre>
 					<p class="padding:10px_0px">Or you can use cdn link:</p>
-					<pre><code class="language-javascript">https://cdn.cocreate.app/js/CoCreate-validation.min.js</code></pre>
+					<pre><code class="language-javascript">https://cdn.CoCreateJS.com/js/CoCreate-validation.min.js</code></pre>
 
 					<h2
 						class="border-bottom:1px_solid_lightgrey margin-top:20px padding:5px_0px">
@@ -258,6 +258,6 @@
 				</div>
 			</div>
 		</main>
-		<script src="https://CoCreate.app/dist/CoCreate.js"></script>
+		<script src="https://CoCreateJS.com/dist/CoCreate.js"></script>
 	</body>
 </html>

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@cocreate/validation",
-  "version": "1.19.0",
+  "version": "2.0.0",
   "description": "A simple validation component in vanilla javascript. Easily configured using HTML5 attributes and/or JavaScript API.",
   "keywords": [
     "validation",
@@ -22,25 +22,26 @@
   },
   "repository": {
     "type": "git",
-    "url": "git+https://github.com/CoCreate-app/CoCreate-validation.git"
+    "url": "git+https://github.com/CoCreateJS/validation.git"
   },
   "author": "CoCreate LLC",
   "license": "AGPL-3.0",
   "bugs": {
-    "url": "https://github.com/CoCreate-app/CoCreate-validation/issues"
+    "url": "https://github.com/CoCreateJS/validation/issues"
   },
-  "homepage": "https://cocreate.app/docs/validation",
+  "homepage": "https://CoCreateJS.com/docs/validation",
   "funding": {
     "type": "GitHub Sponsors ❤",
-    "url": "https://github.com/sponsors/CoCreate-app"
+    "url": "https://github.com/sponsors/CoCreateJS"
   },
   "main": "./src/index.js",
   "dependencies": {
-    "@cocreate/actions": "^1.23.0",
-    "@cocreate/render": "^1.49.2"
+    "@cocreate/actions": "^1.24.0",
+    "@cocreate/element-prototype": "^1.35.0",
+    "@cocreate/render": "^1.51.0"
   },
   "devDependencies": {
-    "@cocreate/webpack": "^1.7.0"
+    "@cocreate/webpack": "^1.9.0"
   },
   "allowScripts": {
     "@cocreate/actions@1.21.4": true,

package/src/index.js

@@ -5,83 +5,198 @@
  * SPDX-License-Identifier: MIT
  ********************************************************************************/
 
-/*globals CustomEvent*/
-import actions from "@cocreate/actions";
-// import render from '@cocreate/render';
-import { matches } from "./validations/matches";
-import { required } from "./validations/required";
-import { unique } from "./validations/unique";
-import { subdomain } from "./validations/subdomain";
-import { length } from "./validations/length";
-import { email } from "./validations/email";
+import actions from "@cocreate/actions";
+import "@cocreate/element-prototype";
+import { render } from "@cocreate/render";
+import { clearError, errorTargets, renderErrors } from "./messages.js";
+import { matches } from "./validations/matches.js";
+import { value } from "./validations/value.js";
+
+/**
+ *
+ * @public
+ * @environment client
+ */
+const validations = new Map();
+validations.set("matches", matches);
+validations.set("valid", validState);
+validations.set("validate", value);
 
-const validations = new Map();
-validations.set("matches", matches);
-validations.set("required", required);
-validations.set("subdomain", subdomain);
-validations.set("unique", unique);
-validations.set("length", length);
-validations.set("email", email);
+function validState(elements, report = renderErrors) {
+    const failedElements = elements.filter(element => element.getAttribute("valid") === "false");
 
-const selectors =
-	"[matches], [required], [unique], [subdomain], [length], [email]";
+    if (failedElements.length) {
+        report({
+            data: failedElements.map(element => ({
+                type: "valid",
+                status: "error",
+                success: false,
+                message: element.validationMessage || "This value is not valid.",
+                elements: [element]
+            }))
+        });
+        return failedElements;
+    }
+}
 
 async function validate(action) {
-	let btn = action.element;
-	let params = action.params;
-	let validateElements;
-	let validateSelectors = [];
-	let failedElements = [];
+    try {
+        const selectors = [...validations.keys()].map(name => `[${name}]`).concat("[component][required]").join(", ");
+        const candidates = new Set();
+        const form = action.element.form || action.form || action.element.closest("form");
+        const roots = action.params ? document.querySelectorAll(action.params) : [form];
+        if (!roots.length || !roots[0]) throw new Error("No validation target found");
 
-	if (params) {
-		let selector = params;
-		for (let [validation] of validations) {
-			let vSelctor = `${selector}[${validation}]`;
-			validateSelectors.push(vSelctor);
-		}
-		let validSelectors = validateSelectors.join(", ");
-		validateElements = document.querySelectorAll(validSelectors);
-		if (!validateElements.length) {
-			let element = document.querySelector(selector);
-			if (element) validateElements = element.querySelectorAll(selectors);
-		}
-	} else {
-		let element = btn.closest("form");
-		validateElements = element.querySelectorAll(selectors);
-	}
+        for (const root of roots) {
+            if (root.matches(selectors) || root.willValidate) candidates.add(root);
+            for (const element of root.querySelectorAll(selectors)) candidates.add(element);
+            for (const element of root.elements || root.querySelectorAll("input, select, textarea, button")) {
+                candidates.add(element);
+            }
+        }
+        const elements = [...candidates].filter(element =>
+            !element.closest("[template]") &&
+            !element.matches(":disabled") && element.willValidate !== false
+        );
+        const failed = new Set();
+        const nativeEnabled = !form?.noValidate && !action.element.formNoValidate;
+        if (nativeEnabled) {
+            for (const element of elements) {
+                if (element.willValidate && !element.checkValidity()) failed.add(element);
+                if (element.hasAttribute("required")) {
+                    const value = await element.getValue();
+                    if (value == null || value === "" || Array.isArray(value) && !value.length)
+                        failed.add(element);
+                }
+            }
+            if (failed.size) {
+                for (const element of elements) markValidity(element, !failed.has(element));
+                action.abort();
+                const first = failed.values().next().value;
+                renderErrors({
+                    data: [...failed].map(element => ({
+                        type: "validate", status: "error", success: false,
+                        message: element.validationMessage || "A value is required.", elements: [element]
+                    }))
+                });
+                if (errorTargets(first).length) first.focus();
+                else first.reportValidity?.();
+                return;
+            }
+        }
 
-	for (let [validation, func] of validations) {
-		let elements = [];
-		for (let element of validateElements) {
-			// let validationSelectors = element.getAttribute('validate').replace(/ /g, '').split(',');
-			if (element.hasAttribute(validation)) {
-				elements.push(element);
-			}
-		}
-		if (elements.length) {
-			let failedEls = await func(elements);
-			if (failedEls) failedElements.push(failedEls);
-		}
-	}
-	for (let element of validateElements) {
-		let isValid = element.getAttribute("validation");
-		if (isValid == "false") failedElements.push(element);
-	}
+        const errors = [];
+        for (const [name, validator] of validations) {
+            const targets = elements.filter(element => element.hasAttribute(name));
+            if (!targets.length) continue;
+            const failures = await validator(targets, ({ data }) => errors.push(...data));
+            if (failures) for (const element of failures) failed.add(element);
+        }
+        for (const element of elements) markValidity(element, !failed.has(element));
+        if (failed.size) {
+            action.abort();
+            renderErrors({ data: errors });
+            failed.values().next().value.focus?.();
+        } else {
+            action.end();
+        }
+    } catch (error) {
+        action.abort();
+        render({
+            selector: '[template~="notification"]',
+            data: [{ type: "validate", status: "error", success: false,
+                message: error.message || "Unable to validate the form. Please try again." }]
+        });
+    }
+}
 
-	if (failedElements.length == 0) {
-		btn.dispatchEvent(
-			new CustomEvent("validate", {
-				detail: {}
-			})
-		);
-	}
+function markValidity(element, valid) {
+    const state = String(valid);
+    element.setAttribute("validation", state);
+    element.setAttribute("aria-invalid", String(!valid));
+    if (valid) clearError(element);
 }
 
-actions.init({
-	name: "validate",
-	callback: (action) => {
-		validate(action);
-	}
-});
+actions.init({ name: "validate", callback: validate });
 
 export default { validations };
+
+/**
+ *
+ * @name aria-errormessage
+ * @kind member
+ * @attribute
+ * @environment client
+ */
+
+/**
+ *
+ * @name aria-invalid
+ * @kind member
+ * @attribute
+ * @environment client
+ */
+
+/**
+ *
+ * @name match
+ * @kind member
+ * @attribute
+ * @environment client
+ */
+
+/**
+ *
+ * @name match-query
+ * @kind member
+ * @attribute
+ * @environment client
+ */
+
+/**
+ *
+ * @name required
+ * @kind member
+ * @attribute
+ * @environment client
+ */
+
+/**
+ *
+ * @name valid
+ * @kind member
+ * @attribute
+ * @environment client
+ */
+
+/**
+ *
+ * @name validation
+ * @kind member
+ * @attribute
+ * @environment client
+ */
+
+/**
+ * A simple validation component in vanilla javascript. Easily configured using HTML5 attributes and/or JavaScript API.
+ *
+ * @module validation
+ * @environment client
+ */
+
+/**
+ * Declarative selectors recognized by this module.
+ *
+ * @name declarative-selectors
+ * @kind member
+ * @selectors
+ * @environment client
+ * @example
+ * ```json
+ * [
+ *   "[template~=\"notification\"]",
+ *   "[match-query][match=\"false\"]",
+ *   "[valid=\"false\"]"
+ * ]
+ * ```
+ */