quival 0.1.0

package/.editorconfig

@@ -0,0 +1,13 @@
+root = true
+
+[*]
+charset = utf-8
+end_of_line = lf
+insert_final_newline = true
+indent_style = space
+indent_size = 2
+trim_trailing_whitespace = true
+
+[*.md]
+trim_trailing_whitespace = false
+indent_size = 4

package/.eslintrc.cjs

@@ -0,0 +1,13 @@
+module.exports = {
+  env: {
+    browser: true,
+    es2021: true,
+  },
+  extends: 'eslint:recommended',
+  overrides: [],
+  parserOptions: {
+    ecmaVersion: 'latest',
+    sourceType: 'module',
+  },
+  rules: {},
+};

package/.prettierrc.json

@@ -0,0 +1,5 @@
+{
+  "printWidth": 160,
+  "tabWidth": 2,
+  "singleQuote": true
+}

package/LICENSE.md

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) Mohd Hafizuddin M Marzuki <hafizuddin_83@yahoo.com>
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

package/README.md

@@ -0,0 +1,157 @@
+# Quival
+
+![npm](https://img.shields.io/npm/v/quival?style=flat-square)
+![npm](https://img.shields.io/npm/dt/quival?style=flat-square)
+![NPM](https://img.shields.io/npm/l/quival?style=flat-square)
+
+This library provides the ability to perform data validation easily in JavaScript. It is heavily based on [Laravel Validation](https://laravel.com/docs/10.x/validation).
+
+By sharing similar conventions, it is possible to reuse validation rules on both front and back ends. This library can be used for preliminary data validation on the front end, before submitting the data to Laravel-based app, where the data should be validated again. 
+
+Why is there a need to perform validation on the front end? Early data validation allows an app to show errors to users immediately, before the data is even submitted. Live feedback is beneficial and can improve user experience.
+
+This library is intended to be used in the browser environment, and it was not tested in other enviroments such as Node.
+
+## Installation
+
+```bash
+npm install quival
+```
+
+## Features
+
+- Provide similar conventions to Laravel Validation
+- Implement most of the rules listed [here](https://laravel.com/docs/10.x/validation#available-validation-rules)
+
+## Example
+
+The code snippet below demonstrates the usage of `Validator` class.
+
+```js
+import { Validator } from 'quival';
+import enLocale from 'quival/src/locales/en.js';
+
+// Set localization messages
+Validator.setLocale('en');
+Validator.setMessages('en', enLocale);
+
+// Register custom checker
+Validator.addChecker('phone_number', (attribute, value, parameters) => {
+  return !/[^0-9\+\-\s]/.test(value);
+}, 'The :attribute field must be a valid phone number.');
+
+// Prepare arguments
+const data = {
+  username: 'idea💡',
+  name: '',
+  email: 'test',
+  phone_number: 'test',
+  letters: ['a', 'b', 'B', 'a'],
+  items: {
+    x: 'a',
+    y: null,
+    z: 12,
+  },
+  payment_type: 'cc',
+  card_number: '',
+};
+
+const rules = {
+  username: ['required', 'ascii', 'min:3'],
+  name: ['required', 'min:3'],
+  email: ['required', 'email'],
+  phone_number: ['required', 'phone_number'],
+  'letters.*': ['distinct:ignore_case'],
+  items: ['array', 'size:5'],
+  'items.*': ['required', 'string'],
+  payment_type: ['required', 'in:cc,paypal'],
+  cc_number: ['required_if:payment_type,cc'],
+};
+
+const customMessages = {
+  'items.size': 'The size of the array must be equal to :size items only.',
+};
+
+const customAttributes = {
+  cc_number: 'Credit Card Number',
+};
+
+const customValues = {
+  payment_type: {
+    cc: 'credit card',
+  },
+};
+
+// Create Validator instance
+const validator = new Validator(data, rules, customMessages, customAttributes, customValues);
+
+// Perform validation
+validator
+  .validate()
+  .then(() => {
+    console.log('Successful!');
+  })
+  .catch((messages) => {
+    if (messages instanceof Error) {
+      throw messages;
+    }
+
+    console.log(messages);
+  });
+```
+
+The produced error messages for the code snippet above.
+
+```json
+{
+  "username": [
+    "The username field must only contain single-byte alphanumeric characters and symbols."
+  ],
+  "name": [
+    "The name field is required."
+  ],
+  "email": [
+    "The email field must be a valid email address."
+  ],
+  "phone_number": [
+    "The phone number field must be a valid phone number."
+  ],
+  "letters.0": [
+    "The letters.0 field has a duplicate value."
+  ],
+  "letters.1": [
+    "The letters.1 field has a duplicate value."
+  ],
+  "letters.2": [
+    "The letters.2 field has a duplicate value."
+  ],
+  "letters.3": [
+    "The letters.3 field has a duplicate value."
+  ],
+  "items": [
+    "The size of the array must be equal to 5 items only."
+  ],
+  "items.y": [
+    "The items.y field is required."
+  ],
+  "items.z": [
+    "The items.z field must be a string."
+  ],
+  "cc_number": [
+    "The Credit Card Number field is required when payment type is credit card."
+  ]
+}
+```
+
+## Security Vulnerabilities
+
+If you discover any security related issues, please email <hafizuddin_83@yahoo.com> instead of using the issue tracker. Please prefix the subject with `Quival:`.
+
+## Credits
+
+- [Mohd Hafizuddin M Marzuki](https://github.com/apih)
+- [All Contributors](../../contributors)
+
+## License
+
+The MIT License (MIT). Please see [License File](LICENSE.md) for more information.

package/package.json

@@ -0,0 +1,27 @@
+{
+  "name": "quival",
+  "version": "0.1.0",
+  "description": "Data validation à la Laravel Validation",
+  "author": "Mohd Hafizuddin M Marzuki <hafizuddin_83@yahoo.com>",
+  "license": "MIT",
+  "type": "module",
+  "main": "./src/index.js",
+  "keywords": [
+    "data validation",
+    "form",
+    "front end",
+    "laravel",
+    "quick",
+    "validation",
+    "validator"
+  ],
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/apih/quival"
+  },
+  "devDependencies": {
+    "eslint": "^8.39.0",
+    "prettier": "^2.8.8"
+  },
+  "scripts": {}
+}