client_side_validations 23.1.0 → 25.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6e348526cc932f74b54d932cb5ed6b5eb3523152ab4d0d399eb7d2e9fa3ece69
-  data.tar.gz: 8b35aaca55edd965f6f7d92afe006b759f428a754f038e65135967342c08cf09
+  metadata.gz: 6ab5824b9451df03da349f928c023f781eeaaf4f4fcad4b1f764b5ac1c27c4ad
+  data.tar.gz: c1b76dad75ed9533d4ab10f07899b1b3cfb17323619bc1d4b77acfd38da6817f
 SHA512:
-  metadata.gz: f5057acdbcd6163e60a1ef75ac52a47b32a0afe65f7e9163106941cceb15fdd1640f7d3260daf35e8c7f2f937804ed873223b3ca55098cdecd98e8a6bf94a424
-  data.tar.gz: 98e14bf600b15d4bcfa412a2a5a03daf83d85a4a8d13c572fbf4d1c30a1d4a7225d66ec8a41306cba9855b6a8ecccf893fd580e0033850f553fb4773c4d063e2
+  metadata.gz: 5b71dda7c76df4b2b9a17f22a643da7cb8697c3a61265f39484f9ef86ba5de08afe04ab668dd4764e4ac16b8155036793146484c88e699399b4bbb11074fec39
+  data.tar.gz: 7b022b94f2d08082825437cd2616c641cc22ff20a42c6d0f0e7b3c72400cf948c75fd5482c6384785e0e330f0ebedfb837ab762a71da9c20028f42237a4dc5fd

data/CHANGELOG.md

@@ -1,5 +1,21 @@
 # Changelog
 
+## 25.0.0 / 2026-07-05
+
+* [FEATURE] Breaking change: Remove unused JavaScript source exports
+  - Deep imports of `src/validators/local/*` must use named exports instead of the removed default object exports, for example `import { acceptanceLocalValidator } from '@client-side-validations/client-side-validations/src/validators/local/acceptance'`
+  - Remove the unused `addClass` and `removeClass` exports from `src/utils.js`
+  - Explicitly remove dead \`inputs\` and \`validate_inputs\` entries from \`ClientSideValidations.selectors\`; only \`forms\` is read by the runtime
+* [FEATURE] Breaking change: Replace Rollup with Rolldown v1 for bundling (10–30× faster builds)
+* [FEATURE] Breaking change: Replace ESLint + neostandard with Oxlint v1 for linting (50–100× faster)
+* [FEATURE] Breaking change: Drop Babel — transpilation handled by Rolldown's built-in Oxc transforms (minimum browser targets are unchanged: Chrome 60+, Firefox 60+, iOS 12+, Safari 12+)
+* [ENHANCEMENT] Remove 9 unused npm devDependencies (smaller install footprint)
+
+## 24.0.0 / 2026-04-19
+* [FEATURE] Breaking change: Remove the jQuery runtime dependency and the old jQuery plugin aliases from the published JavaScript assets
+* [FEATURE] Breaking change: Public JavaScript APIs now work with native DOM elements and DOM collections instead of jQuery-wrapped objects
+* [ENHANCEMENT] Use native browser events and event listeners throughout the runtime and test harness
+
 ## 23.1.0 / 2026-01-27
 
 * [FEATURE] Add jQuery 4.0.0 compatibility

data/README.md

@@ -56,12 +56,11 @@ config/initializers/client_side_validations.rb
 
 Instructions depend on your technology stack.
 
-Please note that CSV depends on jQuery >= 3.7.1 (jQuery slim is fine).
+ClientSideValidations no longer depends on jQuery.
+If you previously installed `jquery-rails`, `jquery_ujs`, or custom jQuery startup code only for ClientSideValidations, you can remove that integration when upgrading to 24.x.
 
 ####  When using Webpacker ####
 
-Make sure that you are requiring jQuery.
-
 Add the following package:
 
 ```sh
@@ -72,7 +71,7 @@ Then add the following line to your `app/javascript/packs/application.js` pack:
 
 ```js
 // If you are using `import` syntax
-import '@client-side-validations/client-side-validations/src'
+import '@client-side-validations/client-side-validations'
 
 // If you are using `require` syntax
 require('@client-side-validations/client-side-validations')
@@ -81,7 +80,7 @@ require('@client-side-validations/client-side-validations')
 ##### Heads-up for Turbo and Turbolinks users #####
 
 If you are using [Turbo](https://github.com/hotwired/turbo-rails), use the
-`import` syntax and make sure that `@client-side-validations/client-side-validations/src`
+`import` syntax and make sure that `@client-side-validations/client-side-validations`
 is imported **after** `@hotwired/turbo-rails`, so ClientSideValidations can properly detect
 `window.Turbo` and attach its event handlers.
 
@@ -92,42 +91,77 @@ detect `window.Turbolinks` and attach its event handlers.
 
 ####  When using Sprockets ####
 
-Since ClientSideValidations can also be used via webpacker, it does not require
-by default `jquery-rails` gem.
+Add the following to your `app/assets/javascripts/application.js` file:
 
-Make sure that `jquery-rails` is part of your bundled gems and `application.js`,
-otherwise add:
+```js
+//= require rails.validations
+```
 
-```ruby
-gem 'jquery-rails'
+If you are using [Turbolinks](https://github.com/turbolinks/turbolinks),
+make sure that `rails.validations` is required **after** `turbolinks`, so
+ClientSideValidations can properly attach its event handlers.
+
+If you need to copy the asset files from the gem into your project, run:
+
+```
+rails g client_side_validations:copy_assets
 ```
 
-to your `Gemfile`, run `bundle`, and add
+Note: If you run `copy_assets`, you will need to run it again each time you update this project.
+
+## Migration Guide ##
+
+### 24.x Breaking Changes ###
+
+If you are upgrading to 24.x, update your integration code to use the `ClientSideValidations` object directly.
+
+The old jQuery plugin methods are removed. Use the DOM-first public API instead:
 
 ```js
-//= require jquery
+ClientSideValidations.enable(form)
+ClientSideValidations.validate(form)
+ClientSideValidations.isValid(form, validators)
+ClientSideValidations.disable(form)
+ClientSideValidations.reset(form)
 ```
 
-to your `app/assets/javascripts/application.js` file.
+These methods accept native DOM elements and DOM collections. They do not accept jQuery objects or CSS selector strings.
 
-Then, add the following to your `app/assets/javascripts/application.js` file
-after `//= require jquery`.
+Custom validators, form builders, and callbacks now receive native DOM nodes instead of jQuery wrappers. Update any custom code to use DOM APIs such as `.value`, `.form`, `.closest()`, and `querySelector()`.
+Local validators are called as `(element, options)`. Form callbacks receive `(form, eventData)`, and element callbacks receive either `(element, message, callback)` or `(element, callback)` depending on the event.
 
-```js
-//= require rails.validations
+All runtime-owned validation state attributes are now namespaced under `csv`. If you read or write these attributes in custom selectors, callbacks, or validators, update them to the scoped names:
+
+```text
+data-changed => data-csv-changed
+data-valid => data-csv-valid
+data-validate => data-csv-validate
+data-not-locally-unique => data-csv-not-locally-unique
 ```
 
-If you are using [Turbolinks](https://github.com/turbolinks/turbolinks),
-make sure that `rails.validations` is required **after** `turbolinks`, so
-ClientSideValidations can properly attach its event handlers.
+The matching dataset properties are `element.dataset.csvChanged`, `element.dataset.csvValid`, `element.dataset.csvValidate`, and `element.dataset.csvNotLocallyUnique`. `csvChanged` is stored as the string values `'true'` and `'false'`.
 
-If you need to copy the asset files from the gem into your project, run:
+**jQuery namespaced events are removed.** Events are now plain native DOM custom events. If your application listens to or unbinds events using jQuery-style namespacing, you must update those calls.
+
+Before:
 
+```js
+$(form).on('form:validate:before.ClientSideValidations', handler)
+$(input).off('.ClientSideValidations')
 ```
-rails g client_side_validations:copy_assets
+
+After:
+
+```js
+form.addEventListener('form:validate:before', handler)
+// store and pass the handler reference to removeEventListener when unbinding
 ```
 
-Note: If you run `copy_assets`, you will need to run it again each time you update this project.
+The full list of native events dispatched by ClientSideValidations: `form:validate:before`, `form:validate:after`, `form:validate:pass`, `form:validate:fail`, `element:validate:before`, `element:validate:after`, `element:validate:pass`, `element:validate:fail`.
+
+If you are upgrading from a version older than 23.0.0, the `data-csv-*` renaming above is required for any custom code that still reads or writes the old attribute names. If you are already on 23.x, the new 24.x upgrade step is to update any local uniqueness integrations that still reference `data-not-locally-unique` or `element.dataset.notLocallyUnique`.
+
+If your application vendors the compiled asset with `rails g client_side_validations:copy_assets`, run that generator again after upgrading so your copied asset matches the current jQuery-free bundle.
 
 ## Initializer ##
 
@@ -324,11 +358,11 @@ If you need to change the markup of how the errors are rendered you can modify t
 
 ```js
 window.ClientSideValidations.formBuilders['ActionView::Helpers::FormBuilder'] = {
-  add: function($element, settings, message) {
+  add: function(element, settings, message) {
     // custom add code here
   },
 
-  remove: function($element, settings) {
+  remove: function(element, settings) {
     // custom remove code here
   }
 }
@@ -376,14 +410,14 @@ en:
 Finally we need to add a client side validator. This can be done by hooking into the `ClientSideValidations.validator` object. Create a new file `app/assets/javascripts/rails.validations.customValidators.js`
 
 ```js
-// The validator variable is a JSON Object
-// The selector variable is a jQuery Object
-window.ClientSideValidations.validators.local['email'] = function($element, options) {
+// The options variable is a JSON Object
+// The element variable is a DOM element
+window.ClientSideValidations.validators.local.email = function (element, options) {
   // Your validator code goes in here
-  if (!/^([^@\s]+)@((?:[-a-z0-9]+\.)+[a-z]{2,})$/i.test($element.val())) {
+  if (!/^([^@\s]+)@((?:[-a-z0-9]+\.)+[a-z]{2,})$/i.test(element.value)) {
     // When the value fails to pass validation you need to return the error message.
     // It can be derived from validator.message
-    return options.message;
+    return options.message
   }
 }
 ```
@@ -408,7 +442,7 @@ There are many reasons why you might want to enable, disable, or even completely
 If you have rendered a new form via AJAX into your page you will need to enable that form for validation:
 
 ```js
-$(new_form).enableClientSideValidations();
+ClientSideValidations.enable(newForm)
 ```
 
 You should attach this to an event that is fired when the new HTML renders.
@@ -416,7 +450,7 @@ You should attach this to an event that is fired when the new HTML renders.
 You can use the same function if you introduce new inputs to an existing form:
 
 ```js
-$(new_input).enableClientSideValidations();
+ClientSideValidations.enable(newInput)
 ```
 
 ### Disabling ###
@@ -424,7 +458,7 @@ $(new_input).enableClientSideValidations();
 If you wish to turn off validations entirely on a form:
 
 ```js
-$(form).disableClientSideValidations();
+ClientSideValidations.disable(form)
 ```
 
 ### Resetting ###
@@ -432,44 +466,54 @@ $(form).disableClientSideValidations();
 You can reset the current state of the validations, clear all error messages, and reattach clean event handlers:
 
 ```js
-$(form).resetClientSideValidations();
+ClientSideValidations.reset(form)
 ```
 
 ## Callbacks ##
 
 `ClientSideValidations` will run callbacks based upon the state of the element or form. The following callbacks are supported:
 
-* `ClientSideValidations.callbacks.element.after($element, eventData)`
-* `ClientSideValidations.callbacks.element.before($element, eventData)`
-* `ClientSideValidations.callbacks.element.fail($element, message, callback, eventData)`
-* `ClientSideValidations.callbacks.element.pass($element, callback, eventData)`
-* `ClientSideValidations.callbacks.form.after($form, eventData)`
-* `ClientSideValidations.callbacks.form.before($form, eventData)`
-* `ClientSideValidations.callbacks.form.fail($form, eventData)`
-* `ClientSideValidations.callbacks.form.pass($form, eventData)`
+* `ClientSideValidations.callbacks.element.after(element, eventData)`
+* `ClientSideValidations.callbacks.element.before(element, eventData)`
+* `ClientSideValidations.callbacks.element.fail(element, message, callback, eventData)`
+* `ClientSideValidations.callbacks.element.pass(element, callback, eventData)`
+* `ClientSideValidations.callbacks.form.after(form, eventData)`
+* `ClientSideValidations.callbacks.form.before(form, eventData)`
+* `ClientSideValidations.callbacks.form.fail(form, eventData)`
+* `ClientSideValidations.callbacks.form.pass(form, eventData)`
 
 The names of the callbacks should be pretty straight forward. For example, `ClientSideValidations.callbacks.form.fail` will be called if a form failed to validate. And `ClientSideValidations.callbacks.element.before` will be called before that particular element's validations are run.
 
-All element callbacks will receive the element in a jQuery object as the first parameter and the eventData object as the second parameter. `ClientSideValidations.callbacks.element.fail()` will receive the message of the failed validation as the second parameter, the callback for adding the error fields as the third and the eventData object as the third. `ClientSideValidations.elementValidatePass()` will receive the callback for removing the error fields. The error field callbacks must be run in your custom callback in some fashion. (either after a blocking event or as a callback for another event, such as an animation)
+All element callbacks receive the DOM element as the first parameter and the native event object as the second parameter. `ClientSideValidations.callbacks.element.fail()` receives the failed message as the second parameter, the callback for adding error fields as the third parameter, and the eventData object as the fourth parameter. `ClientSideValidations.callbacks.element.pass()` receives the callback for removing the error fields as the second parameter. The error field callbacks must still be invoked by your custom callback.
 
-All form callbacks will receive the form in a jQuery object as the first parameter and the eventData object as the second parameter.
+All form callbacks receive the DOM form element as the first parameter and the native event object as the second parameter.
 
-Here is an example callback for sliding out the error message when the validation fails then sliding it back in when the validation passes:
+Here is an example callback that animates the error message when validation fails:
 
 ``` javascript
-// You will need to require 'jquery-ui' for this to work
-window.ClientSideValidations.callbacks.element.fail = function($element, message, callback) {
+window.ClientSideValidations.callbacks.element.fail = function (element, message, callback) {
   callback()
 
-  if ($element.data('csvValid') !== false) {
-    $element.parent().find('.message').hide().show('slide', { direction: 'left', easing: 'easeOutBounce' }, 500)
+  var messageElement = element.parentElement.querySelector('.message')
+
+  if (messageElement) {
+    if (typeof messageElement.animate === 'function') {
+      messageElement.animate(
+        [
+          { opacity: 0, transform: 'translateX(-8px)' },
+          { opacity: 1, transform: 'translateX(0)' }
+        ],
+        { duration: 250, easing: 'ease-out', fill: 'both' }
+      )
+    } else {
+      messageElement.style.opacity = '1'
+      messageElement.style.transform = 'translateX(0)'
+    }
   }
 }
 
-window.ClientSideValidations.callbacks.element.pass = function($element, callback) {
-  // Take note how we're passing the callback to the hide()
-  // method so it is run after the animation is complete.
-  $element.parent().find('.message').hide('slide', { direction: 'left' }, 500, callback)
+window.ClientSideValidations.callbacks.element.pass = function (element, callback) {
+  callback()
 }
 ```
 
@@ -478,12 +522,9 @@ window.ClientSideValidations.callbacks.element.pass = function($element, callbac
   background-color: red;
   border-bottom-right-radius: 5px 5px;
   border-top-right-radius: 5px 5px;
+  display: inline-block;
   padding: 2px 5px;
 }
-
-div.field_with_errors div.ui-effects-wrapper {
-  display: inline-block !important;
-}
 ```
 
 Finally uncomment the `ActionView::Base.field_error_proc` override in `config/initializers/client_side_validations.rb`
@@ -506,22 +547,21 @@ By default, ClientSideValidations will automatically validate the form.
 If for some reason you would like to manually validate the form (for example you're working with a multi-step form), you can use the following approach:
 
 ```js
-$input     = $('#myInputField');
-$form      = $($input[0].form);
-validators = $form[0].ClientSideValidations.settings.validators;
+const input = document.getElementById('myInputField')
+const form = input.form
+const validators = form.ClientSideValidations.settings.validators
 
 // Validate a single field
-// It might not work for multiple inputs selected at once by `$input`
-$input.isValid(validators);
+ClientSideValidations.isValid(input, validators)
 
 // Validate the whole form
-$form.isValid(validators);
+ClientSideValidations.isValid(form, validators)
 ```
 
 To manually validate a single field, you may also trigger a focusout event:
 
 ```js
-$('#myInputField').trigger('focusout');
+input.dispatchEvent(new Event('focusout', { bubbles: true }))
 ```
 
 ## Authors ##

data/lib/client_side_validations/action_view/form_helper.rb

@@ -86,7 +86,7 @@ module ClientSideValidations
           @validators.each_with_object({}) do |object_opts, validator_hash|
             next unless object_opts[0].respond_to?(:client_side_validation_hash)
 
-            option_hash = object_opts[1].each_with_object({}) do |attr, result|
+            option_hash = object_opts[1].each_with_object({}) do |attr, result| # rubocop:disable Style/ReduceToHash -- False positive
               result[attr[0]] = attr[1][:options]
             end
 

data/lib/client_side_validations/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module ClientSideValidations
-  VERSION = '23.1.0'
+  VERSION = '25.0.0'
 end