@kklab/fortress-validator 1.0.9

package/README.md

@@ -0,0 +1,202 @@
+# Fortress Validator
+
+A powerful and flexible form validation library, built to validate inputs through method chaining, with support for custom plugins.
+
+## Getting Started
+
+### Using with ES Modules
+
+To get started with ES Modules, simply import the module and use it in your code:
+
+```js
+import { FormValidator } from '@kklab/fortress-validator';
+
+const validator = new FormValidator();
+```
+
+### Using with UMD Modules
+
+Alternatively, if you're using UMD modules, include the script in your HTML file and use it in your code:
+
+```html
+<script src="https://unpkg.com/@kklab/fortress-validator/dist/index.umd.js"></script>
+<script>
+const validator = new window.Fortress.FormValidator();
+</script>
+```
+
+## Usage
+
+### Basic Validation
+
+The `defineField` method sets up a field for validation, allowing you to chain validation rules like `required` and others to validate the input.
+
+```js
+document.querySelector('input').addEventListener('input', (e) => {
+  const result = validator
+    .defineField('Input')
+    .required()
+    .alphaDash()
+    .validate(e.target.value);
+
+  console.log(result);
+});
+```
+
+### Conditional Validation
+
+The `when` method allows you to conditionally apply validation rules like `required` and others based on specific conditions.
+
+```js
+const result = validator
+  .defineField('Input')
+  .when({
+    alphaDash: false,
+  })
+  .required()
+  .alphaDash()
+  .validate('@');
+
+// Result:
+// true
+```
+
+## Available Rules
+
+| Name | Description |
+| --- | --- |
+| `accepted` | Passes if the field's value is considered accepted (i.e., "y", "yes", "on", "1", "true"). |
+| `after` | Passes if the field's value is a date that occurs after the specified date. |
+| `alpha` | Passes if the field's value contains only letters. |
+| `alphaDash` | Passes if the field's value contains only letters, numbers, dashes and underscores. |
+| `alphaDashDot` | Passes if the field's value contains only letters, numbers, dashes, underscores and dots. |
+| `alphaNum` | Passes if the field's value contains only letters and numbers. |
+| `array` | Passes if the field's value is an array. |
+| `ascii` | Passes if the field's value contains only ASCII characters and symbols. |
+| `before` | Passes if the field's value is a date that occurs before the specified date. |
+| `between` | Passes if the field's value is between the specified minimum and maximum values. |
+| `betweenLength` | Passes if the field's value is between the specified minimum and maximum lengths. |
+| `boolean` | Passes if the field's value is a boolean. |
+| `containsAll` | Passes if the field's value contains all the specified values. |
+| `containsAny` | Passes if the field's value contains at least one of the specified values. |
+| `date` | Passes if the field's value matches the specified date format. |
+| `declined` | Passes if the field's value is considered declined (i.e., "n", "no", "off", "0", "false"). |
+| `different` | Passes if the field's value is different from the specified value in the given field. |
+| `distinct` | Passes if all the items in the array field's value are unique. |
+| `domain` | Passes if the field's value is a valid domain. |
+| `email` | Passes if the field's value is a valid email address. |
+| `endsWith` | Passes if the field's value ends with the specified value. |
+| `equals` | Passes if the field's value is equal to the specified value. |
+| `file` | Passes if the field's value is a file. |
+| `fileBetweenSize` | Passes if the field's value is between the specified minimum and maximum file sizes. |
+| `fileMaxSize` | Passes if the field's value is not greater than the specified maximum file size. |
+| `fileMinSize` | Passes if the field's value is at least the specified minimum file size. |
+| `fileSize` | Passes if the field's value matches the specified file size. |
+| `http` | Passes if the field's value starts with "http://" or "https://". |
+| `https` | Passes if the field's value starts with "https://". |
+| `in` | Passes if the field's value is one of the specified values. |
+| `integer` | Passes if the field's value is an integer. |
+| `iso8601` | Passes if the field's value is a valid ISO 8601 date. |
+| `json` | Passes if the field's value is a valid JSON string. |
+| `jsonSchema` | Passes if the field's value matches the specified JSON schema. |
+| `length` | Passes if the field's value matches the specified length. |
+| `lowercase` | Passes if the field's value contains only lowercase characters. |
+| `max` | Passes if the field's value is not greater than the specified maximum. |
+| `maxLength` | Passes if the field's value is not greater than the specified maximum length. |
+| `min` | Passes if the field's value is at least the specified minimum. |
+| `minLength` | Passes if the field's value is at least the specified minimum length. |
+| `notEquals` | Passes if the field's value is not equal to the specified value. |
+| `notIn` | Passes if the field's value is not one of the specified values. |
+| `number` | Passes if the field's value is a number. |
+| `numeric` | Passes if the field's value contains only numeric characters. |
+| `regex` | Passes if the field's value matches the specified regular expression. |
+| `required` | Passes if the field's value is not empty. |
+| `requiredWhen` | Passes if the field's value is not empty when the specified condition is true. |
+| `same` | Passes if the field's value is the same as the specified value in the given field. |
+| `size` | Passes if the field's value matches the specified size. |
+| `startsWith` | Passes if the field's value starts with the specified value. |
+| `string` | Passes if the field's value is a string. |
+| `stringBetweenLength` | Passes if the field's value is between the specified minimum and maximum string lengths. |
+| `stringLength` | Passes if the field's value matches the specified string length. |
+| `stringMaxLength` | Passes if the field's value is not greater than the specified maximum string length. |
+| `stringMinLength` | Passes if the field's value is at least the specified minimum string length. |
+| `unique` | Passes if the field's value contains only unique items, with optional ignored values. |
+| `uppercase` | Passes if the field's value contains only uppercase characters. |
+| `url` | Passes if the field's value is a valid URL. |
+
+## Available Methods
+
+| Name | Description |
+| --- | --- |
+| `collect` | Collects the rule functions. |
+| `validate` | Validates the field's value. |
+| `apply` | Applies the specified rule with the given arguments, useful for applying custom rules. |
+| `when` | Determines whether to apply or skip validation based on the provided conditions. |
+
+## Available Plugins
+
+- [fortress-validator/plugin-date](https://github.com/fortress-validator/plugin-date)
+- [fortress-validator/plugin-json-schema](https://github.com/fortress-validator/plugin-json-schema)
+
+## Custom Plugin
+
+A custom plugin is composed of `rules` and `locales`, allowing you to define custom validation logic and locale-specific messages.
+
+```js
+const validator = new FormValidator({
+  plugins: [
+    {
+      rules: {
+        multipleOf: (({ factor }: { factor: number }) => (input: unknown) => Number(input) % factor === 0) as Rule<unknown>,
+      },
+      locales: {
+        en: {
+          multipleOf: (field, args) => {
+            const { factor } = args as { factor: number };
+            return `The ${field} field must be a multiple of ${factor}.`;
+          },
+        },
+      },
+    },
+  ],
+});
+
+const result = validator
+  .defineField('Input')
+  .apply('multipleOf', { factor: 2 })
+  .validate(1);
+
+// Result:
+// The input field must be a multiple of 2.
+```
+
+## Development
+
+To start a local development server, run:
+
+```bash
+npm run dev
+```
+
+## Testing
+
+To run the tests for this package, run:
+
+```bash
+npm run test
+```
+
+## Contributors
+
+<a href="https://github.com/memochou1993">
+  <img src="https://github.com/memochou1993.png" width="60px;" alt="memochou1993" />
+</a>
+<a href="https://github.com/clover180120">
+  <img src="https://github.com/clover180120.png" width="60px;" alt="clover180120" />
+</a>
+<a href="https://github.com/Joyining">
+  <img src="https://github.com/Joyining.png" width="60px;" alt="Joyining" />
+</a>
+<a href="https://github.com/BelleShih">
+  <img src="https://github.com/BelleShih.png" width="60px;" alt="BelleShih" />
+</a>

package/dist/FieldValidator.d.ts

@@ -0,0 +1,272 @@
+import { Message, Messages, Rule, RuleArguments, RuleFunction } from '@kklab/fortress-validator-types';
+import { Conditions, FieldValidatorArguments } from './types';
+declare class FieldValidator {
+    private name;
+    private locale;
+    private fallbackLocale;
+    private locales;
+    private rules;
+    private ruleFunctions;
+    private conditions;
+    private shouldSkip;
+    constructor({ name, locale, fallbackLocale, locales, rules, }: FieldValidatorArguments);
+    get formattedName(): string;
+    get messages(): Messages;
+    get fallbackMessages(): Messages;
+    get mandatoryRules(): string[];
+    getMessage(ruleName: string): Message;
+    getRule(name: string): Rule<unknown>;
+    private buildRuleFunction;
+    private buildRuleFunctionMessage;
+    private pushRuleFunction;
+    getRuleFunctions(): RuleFunction[];
+    /**
+     * Collects the rule functions.
+     */
+    collect(): RuleFunction[];
+    /**
+     * Validates the field's value.
+     */
+    validate(value: unknown): boolean | string;
+    /**
+     * Applies the specified rule with the given arguments.
+     */
+    apply(ruleName: string, args?: RuleArguments): this;
+    /**
+     * Passes if the field's value is considered accepted (i.e., "y", "yes", "on", "1", "true").
+     */
+    accepted(): this;
+    /**
+     * Passes if the field's value is a date that occurs after the specified date.
+     */
+    after(date: string, format: string, displayFormat?: string, strict?: boolean): this;
+    /**
+     * Passes if the field's value contains only letters.
+     */
+    alpha(): this;
+    /**
+     * Passes if the field's value contains only letters, numbers, dashes and underscores.
+     */
+    alphaDash(): this;
+    /**
+     * Passes if the field's value contains only letters, numbers, dashes, underscores and dots.
+     */
+    alphaDashDot(): this;
+    /**
+     * Passes if the field's value contains only letters and numbers.
+     */
+    alphaNum(): this;
+    /**
+     * Passes if the field's value is an array.
+     */
+    array(): this;
+    /**
+     * Passes if the field's value contains only ASCII characters and symbols.
+     */
+    ascii(): this;
+    /**
+     * Passes if the field's value is a date that occurs before the specified date.
+     */
+    before(date: string, format: string, displayFormat?: string, strict?: boolean): this;
+    /**
+     * Passes if the field's value is between the specified minimum and maximum values.
+     */
+    between(min: number, max: number): this;
+    /**
+     * Passes if the field's value is between the specified minimum and maximum lengths.
+     */
+    betweenLength(min: number, max: number): this;
+    /**
+     * Passes if the field's value is a boolean.
+     */
+    boolean(): this;
+    /**
+     * Passes if the field's value contains all the specified values.
+     */
+    containsAll(values: unknown[]): this;
+    /**
+     * Passes if the field's value contains at least one of the specified values.
+     */
+    containsAny(values: unknown[]): this;
+    /**
+     * Passes if the field's value matches the specified date format.
+     */
+    date(format: string, strict?: boolean): this;
+    /**
+     * Passes if the field's value is considered declined (i.e., "n", "no", "off", "0", "false").
+     */
+    declined(): this;
+    /**
+     * Passes if the field's value is different from the specified value in the given field.
+     */
+    different(field: string, value: unknown): this;
+    /**
+     * Passes if all the items in the array field's value are unique.
+     */
+    distinct(): this;
+    /**
+     * Passes if the field's value is a valid domain.
+     */
+    domain(): this;
+    /**
+     * Passes if the field's value is a valid email address.
+     */
+    email(): this;
+    /**
+     * Passes if the field's value ends with the specified value.
+     */
+    endsWith(value: string): this;
+    /**
+     * Passes if the field's value is equal to the specified value.
+     */
+    equals(value: unknown): this;
+    /**
+     * Passes if the field's value is a file.
+     */
+    file(): this;
+    /**
+     * Passes if the field's value is between the specified minimum and maximum file sizes.
+     */
+    fileBetweenSize(min: number, max: number): this;
+    /**
+     * Passes if the field's value is not greater than the specified maximum file size.
+     */
+    fileMaxSize(size: number): this;
+    /**
+     * Passes if the field's value is at least the specified minimum file size.
+     */
+    fileMinSize(size: number): this;
+    /**
+     * Passes if the field's value matches the specified file size.
+     */
+    fileSize(size: number): this;
+    /**
+     * Passes if the field's value starts with "http://" or "https://".
+     */
+    http(): this;
+    /**
+     * Passes if the field's value starts with "https://".
+     */
+    https(): this;
+    /**
+     * Passes if the field's value is one of the specified values.
+     */
+    in(values: unknown[]): this;
+    /**
+     * Passes if the field's value is an integer.
+     */
+    integer(): this;
+    /**
+     * Passes if the field's value is a valid ISO 8601 date.
+     */
+    iso8601(): this;
+    /**
+     * Passes if the field's value is a valid JSON string.
+     */
+    json(): this;
+    /**
+     * Passes if the field's value matches the specified JSON schema.
+     */
+    jsonSchema(schema: Record<string, unknown>): this;
+    /**
+     * Passes if the field's value matches the specified length.
+     */
+    length(length: number): this;
+    /**
+     * Passes if the field's value contains only lowercase characters.
+     */
+    lowercase(): this;
+    /**
+     * Passes if the field's value is not greater than the specified maximum.
+     */
+    max(max: number): this;
+    /**
+     * Passes if the field's value is not greater than the specified maximum length.
+     */
+    maxLength(length: number): this;
+    /**
+     * Passes if the field's value is at least the specified minimum.
+     */
+    min(min: number): this;
+    /**
+     * Passes if the field's value is at least the specified minimum length.
+     */
+    minLength(length: number): this;
+    /**
+     * Passes if the field's value is not equal to the specified value.
+     */
+    notEquals(value: unknown): this;
+    /**
+     * Passes if the field's value is not one of the specified values.
+     */
+    notIn(values: string[]): this;
+    /**
+     * Passes if the field's value is a number.
+     */
+    number(): this;
+    /**
+     * Passes if the field's value contains only numeric characters.
+     */
+    numeric(): this;
+    /**
+     * Passes if the field's value matches the specified regular expression.
+     */
+    regex(expression: RegExp): this;
+    /**
+     * Passes if the field's value is not empty.
+     */
+    required(): this;
+    /**
+     * Passes if the field's value is not empty when the specified condition is true.
+     */
+    requiredWhen(condition: boolean): this;
+    /**
+     * Passes if the field's value is the same as the specified value in the given field.
+     */
+    same(field: string, value: unknown): this;
+    /**
+     * Passes if the field's value matches the specified size.
+     */
+    size(size: number): this;
+    /**
+     * Passes if the field's value starts with the specified value.
+     */
+    startsWith(value: string): this;
+    /**
+     * Passes if the field's value is a string.
+     */
+    string(): this;
+    /**
+     * Passes if the field's value is between the specified minimum and maximum string lengths.
+     */
+    stringBetweenLength(min: number, max: number): this;
+    /**
+     * Passes if the field's value matches the specified string length.
+     */
+    stringLength(length: number): this;
+    /**
+     * Passes if the field's value is not greater than the specified maximum string length.
+     */
+    stringMaxLength(length: number): this;
+    /**
+     * Passes if the field's value is at least the specified minimum string length.
+     */
+    stringMinLength(length: number): this;
+    /**
+     * Passes if the field's value contains only unique items, with optional ignored values.
+     */
+    unique(values: string[], ignored?: unknown[] | unknown): this;
+    /**
+     * Passes if the field's value contains only uppercase characters.
+     */
+    uppercase(): this;
+    /**
+     * Passes if the field's value is a valid URL.
+     */
+    url(): this;
+    /**
+     * Determines whether to apply or skip validation based on the provided conditions.
+     */
+    when(conditions: boolean | Conditions): this;
+}
+export default FieldValidator;

package/dist/FormValidator.d.ts

@@ -0,0 +1,19 @@
+import { Locales, Plugin, Rules } from '@kklab/fortress-validator-types';
+import { default as FieldValidator } from './FieldValidator';
+import { FormValidatorArguments } from './types';
+declare class FormValidator {
+    private locale;
+    private fallbackLocale;
+    private locales;
+    private rules;
+    constructor({ fallbackLocale, locale, plugins, }?: FormValidatorArguments);
+    getLocale(): string;
+    getFallbackLocale(): string;
+    setLocale(locale: string): this;
+    setFallbackLocale(locale: string): this;
+    defineField(name: string): FieldValidator;
+    registerLocales(locales: Locales): this;
+    registerRules(rules: Rules): this;
+    registerPlugin(plugin: Plugin): this;
+}
+export default FormValidator;

package/dist/index.d.ts

@@ -0,0 +1,3 @@
+import { default as FieldValidator } from './FieldValidator';
+import { default as FormValidator } from './FormValidator';
+export { FieldValidator, FormValidator, };