@keysdown/form-wrapper 1.0.2 → 2.0.0

package/dist/src/core/Form.d.ts

@@ -1,12 +1,22 @@
 import { Field, Fields, RawFields } from '../types/fields';
 import { Values } from '../types/values';
 import { Validation } from './Validation';
+import { Rules, RuleHandler } from '../types/rules';
+import { FormWrapperPlugin } from '../types/plugin';
+import { Locale, LocaleMessages } from '../types/locale';
 export declare class Form {
     [key: string]: any;
+    static rules: Rules;
+    static defaultMessages: LocaleMessages;
+    private static interpolateMessage;
     awaiting: boolean;
     originalValues: Values;
+    fieldAttributes: Record<string, string>;
     validation: Validation;
     constructor(fields: Fields | RawFields);
+    static extend(plugin: FormWrapperPlugin): typeof Form;
+    static addRule(name: string, handler: RuleHandler): typeof Form;
+    static locale(locale: Locale): typeof Form;
     addField(field: string, value: Field): this;
     addFields(fields: Fields | RawFields): this;
     get errors(): import('./Errors').Errors;
@@ -17,6 +27,8 @@ export declare class Form {
     removeField(field: string): this;
     removeFields(fields: string[]): this;
     reset(): this;
+    wasChanged(field: string | string[]): boolean;
+    filled(field: string | string[]): boolean;
     get rules(): import('./Rules').Rules;
     setAwaiting(awaiting?: boolean): this;
     validate(field?: string | null): Promise<this | void>;

package/dist/src/plugins/formValidation.d.ts

@@ -0,0 +1,3 @@
+import { FormWrapperPlugin } from '../types/plugin';
+declare const formValidation: FormWrapperPlugin;
+export default formValidation;

package/dist/src/plugins/locales/en.d.ts

@@ -0,0 +1,3 @@
+import { Locale } from '../../types/locale';
+declare const en: Locale;
+export default en;

package/dist/src/plugins/locales/es.d.ts

@@ -0,0 +1,3 @@
+import { Locale } from '../../types/locale';
+declare const es: Locale;
+export default es;

package/dist/src/plugins/locales/index.d.ts

@@ -0,0 +1,3 @@
+export { default as en } from './en';
+export { default as pt } from './pt';
+export { default as es } from './es';

package/dist/src/plugins/locales/pt.d.ts

@@ -0,0 +1,3 @@
+import { Locale } from '../../types/locale';
+declare const pt: Locale;
+export default pt;

package/dist/src/plugins/rules/alpha.d.ts

@@ -0,0 +1,2 @@
+declare const _default: import('../../types/rules').RuleFunction;
+export default _default;

package/dist/src/plugins/rules/alphaNumeric.d.ts

@@ -0,0 +1,2 @@
+declare const _default: import('../../types/rules').RuleFunction;
+export default _default;

package/dist/src/plugins/rules/array.d.ts

@@ -0,0 +1,2 @@
+declare const _default: import('../../types/rules').RuleFunction;
+export default _default;

package/dist/src/plugins/rules/between.d.ts

@@ -0,0 +1,2 @@
+declare const _default: import('../../types/rules').RuleFunction;
+export default _default;

package/dist/src/plugins/rules/boolean.d.ts

@@ -0,0 +1,2 @@
+declare const _default: import('../../types/rules').RuleFunction;
+export default _default;

package/dist/src/plugins/rules/confirmed.d.ts

@@ -0,0 +1,2 @@
+declare const _default: import('../../types/rules').RuleFunction;
+export default _default;

package/dist/src/plugins/rules/date.d.ts

@@ -0,0 +1,2 @@
+declare const _default: import('../../types/rules').RuleFunction;
+export default _default;

package/dist/src/plugins/rules/different.d.ts

@@ -0,0 +1,2 @@
+declare const _default: import('../../types/rules').RuleFunction;
+export default _default;

package/dist/src/plugins/rules/digits.d.ts

@@ -0,0 +1,2 @@
+declare const _default: import('../../types/rules').RuleFunction;
+export default _default;

package/dist/src/plugins/rules/digitsBetween.d.ts

@@ -0,0 +1,2 @@
+declare const _default: import('../../types/rules').RuleFunction;
+export default _default;

package/dist/src/plugins/rules/email.d.ts

@@ -0,0 +1,2 @@
+declare const _default: import('../../types/rules').RuleFunction;
+export default _default;

package/dist/src/plugins/rules/endsWith.d.ts

@@ -0,0 +1,2 @@
+declare const _default: import('../../types/rules').RuleFunction;
+export default _default;

package/dist/src/plugins/rules/greaterThan.d.ts

@@ -0,0 +1,2 @@
+declare const _default: import('../../types/rules').RuleFunction;
+export default _default;

package/dist/src/plugins/rules/greaterThanOrEqual.d.ts

@@ -0,0 +1,2 @@
+declare const _default: import('../../types/rules').RuleFunction;
+export default _default;

package/dist/src/plugins/rules/in.d.ts

@@ -0,0 +1,2 @@
+declare const _default: import('../../types/rules').RuleFunction;
+export default _default;

package/dist/src/plugins/rules/index.d.ts

@@ -0,0 +1,35 @@
+import { Rules } from '../../types/rules';
+export { default as required } from './required';
+export { default as email } from './email';
+export { default as url } from './url';
+export { default as min } from './min';
+export { default as max } from './max';
+export { default as between } from './between';
+export { default as size } from './size';
+export { default as alpha } from './alpha';
+export { default as alphaNumeric } from './alphaNumeric';
+export { default as string } from './string';
+export { default as integer } from './integer';
+export { default as numeric } from './numeric';
+export { default as array } from './array';
+export { default as boolean } from './boolean';
+export { default as date } from './date';
+export { default as same } from './same';
+export { default as different } from './different';
+export { default as confirmed } from './confirmed';
+export { default as inRule } from './in';
+export { default as notIn } from './notIn';
+export { default as regex } from './regex';
+export { default as startsWith } from './startsWith';
+export { default as endsWith } from './endsWith';
+export { default as digits } from './digits';
+export { default as digitsBetween } from './digitsBetween';
+export { default as ip } from './ip';
+export { default as json } from './json';
+export { default as uuid } from './uuid';
+export { default as lessThan } from './lessThan';
+export { default as greaterThan } from './greaterThan';
+export { default as lessThanOrEqual } from './lessThanOrEqual';
+export { default as greaterThanOrEqual } from './greaterThanOrEqual';
+export { default as nullable } from './nullable';
+export declare const allRules: Rules;

package/dist/src/plugins/rules/integer.d.ts

@@ -0,0 +1,2 @@
+declare const _default: import('../../types/rules').RuleFunction;
+export default _default;

package/dist/src/plugins/rules/ip.d.ts

@@ -0,0 +1,2 @@
+declare const _default: import('../../types/rules').RuleFunction;
+export default _default;

package/dist/src/plugins/rules/json.d.ts

@@ -0,0 +1,2 @@
+declare const _default: import('../../types/rules').RuleFunction;
+export default _default;

package/dist/src/plugins/rules/lessThan.d.ts

@@ -0,0 +1,2 @@
+declare const _default: import('../../types/rules').RuleFunction;
+export default _default;

package/dist/src/plugins/rules/lessThanOrEqual.d.ts

@@ -0,0 +1,2 @@
+declare const _default: import('../../types/rules').RuleFunction;
+export default _default;

package/dist/src/plugins/rules/max.d.ts

@@ -0,0 +1,2 @@
+declare const _default: import('../../types/rules').RuleFunction;
+export default _default;

package/dist/src/plugins/rules/min.d.ts

@@ -0,0 +1,2 @@
+declare const _default: import('../../types/rules').RuleFunction;
+export default _default;

package/dist/src/plugins/rules/notIn.d.ts

@@ -0,0 +1,2 @@
+declare const _default: import('../../types/rules').RuleFunction;
+export default _default;

package/dist/src/plugins/rules/nullable.d.ts

@@ -0,0 +1,2 @@
+declare const _default: import('../../types/rules').RuleFunction;
+export default _default;

package/dist/src/plugins/rules/numeric.d.ts

@@ -0,0 +1,2 @@
+declare const _default: import('../../types/rules').RuleFunction;
+export default _default;

package/dist/src/plugins/rules/regex.d.ts

@@ -0,0 +1,2 @@
+declare const _default: import('../../types/rules').RuleFunction;
+export default _default;

package/dist/src/plugins/rules/required.d.ts

@@ -0,0 +1,2 @@
+declare const _default: import('../../types/rules').RuleFunction;
+export default _default;

package/dist/src/plugins/rules/same.d.ts

@@ -0,0 +1,2 @@
+declare const _default: import('../../types/rules').RuleFunction;
+export default _default;

package/dist/src/plugins/rules/size.d.ts

@@ -0,0 +1,2 @@
+declare const _default: import('../../types/rules').RuleFunction;
+export default _default;

package/dist/src/plugins/rules/startsWith.d.ts

@@ -0,0 +1,2 @@
+declare const _default: import('../../types/rules').RuleFunction;
+export default _default;

package/dist/src/plugins/rules/string.d.ts

@@ -0,0 +1,2 @@
+declare const _default: import('../../types/rules').RuleFunction;
+export default _default;

package/dist/src/plugins/rules/url.d.ts

@@ -0,0 +1,2 @@
+declare const _default: import('../../types/rules').RuleFunction;
+export default _default;

package/dist/src/plugins/rules/uuid.d.ts

@@ -0,0 +1,2 @@
+declare const _default: import('../../types/rules').RuleFunction;
+export default _default;

package/dist/src/types/fields.d.ts

@@ -2,6 +2,7 @@ import { Validation } from './validations';
 export interface Field {
     validation?: object;
     value: any;
+    attribute?: string;
 }
 export interface FieldDeclaration {
     validation: Validation;

package/dist/src/types/locale.d.ts

@@ -0,0 +1,7 @@
+export interface LocaleMessages {
+    [ruleName: string]: string;
+}
+export interface Locale {
+    name: string;
+    messages: LocaleMessages;
+}

package/dist/src/types/plugin.d.ts

@@ -0,0 +1,2 @@
+import { Rules } from './rules';
+export type FormWrapperPlugin = (FormClass: any, RuleRegistry: Rules) => void;

package/dist/src/types/rules.d.ts

@@ -1,3 +1,9 @@
+export type ValidationRule = 'required' | 'email' | 'url' | 'min' | 'max' | 'between' | 'size' | 'alpha' | 'alphaNumeric' | 'string' | 'integer' | 'numeric' | 'array' | 'boolean' | 'date' | 'same' | 'different' | 'confirmed' | 'in' | 'notIn' | 'regex' | 'startsWith' | 'endsWith' | 'digits' | 'digitsBetween' | 'ip' | 'json' | 'uuid' | 'lessThan' | 'greaterThan' | 'lessThanOrEqual' | 'greaterThanOrEqual' | 'nullable' | (string & {});
+export type RuleString = ValidationRule | `${ValidationRule}:${string}`;
+export type RuleHandler = (value: any, attributes?: string[], form?: any, field?: string) => Promise<any>;
+export interface RuleFunction extends RuleHandler {
+    ruleName: string;
+}
 export interface Rules {
-    [key: string]: (value: any, attributes: string[]) => Promise<any>;
+    [key: string]: RuleHandler;
 }

package/dist/src/types/validations.d.ts

@@ -1,4 +1,5 @@
+import { RuleString, RuleFunction, ValidationRule } from './rules';
 export interface Validation {
-    rules: string[];
-    messages: object;
+    rules: (RuleString | RuleFunction)[] | string;
+    messages: Record<ValidationRule | string, string>;
 }

package/dist/src/utils/collections.d.ts

@@ -6,7 +6,7 @@ export declare class Collection<T> {
     any(): boolean;
     fill(items: Items<T>): this;
     push(key: string, data: any): this;
-    has(key: string): boolean;
+    has(key: string | string[]): boolean;
     get(item: string, defaultValue?: T | null): T | null;
     unset(key: string): this;
     clear(): this;

package/dist/src/utils/rule.d.ts

@@ -0,0 +1,2 @@
+import { RuleFunction } from '../types/rules';
+export declare function defineRule(name: string, handler: (...args: any[]) => Promise<any>): RuleFunction;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@keysdown/form-wrapper",
-  "version": "1.0.2",
+  "version": "2.0.0",
   "repository": {
     "type": "git",
     "url": "https://github.com/keysdown/form-wrapper.git"
@@ -21,11 +21,26 @@
       "import": "./dist/form-wrapper.js",
       "require": "./dist/form-wrapper.umd.cjs",
       "types": "./dist/form-wrapper.d.ts"
+    },
+    "./plugins/formValidation": {
+      "import": "./dist/plugins/formValidation.js",
+      "require": "./dist/plugins/formValidation.cjs",
+      "types": "./dist/plugins/formValidation.d.ts"
+    },
+    "./plugins/rules": {
+      "import": "./dist/plugins/rules.js",
+      "require": "./dist/plugins/rules.cjs",
+      "types": "./dist/plugins/rules.d.ts"
+    },
+    "./plugins/locales": {
+      "import": "./dist/plugins/locales.js",
+      "require": "./dist/plugins/locales.cjs",
+      "types": "./dist/plugins/locales.d.ts"
     }
   },
   "scripts": {
     "dev": "vite",
-    "build": "tsc && vite build",
+    "build": "tsc && vite build && vite build --config vite.config.plugins.ts",
     "preview": "vite preview",
     "test": "vitest run",
     "test:watch": "vitest",

package/dist/form-wrapper.iife.js

@@ -1 +0,0 @@
-var FormWrapper=(function(e){Object.defineProperties(e,{__esModule:{value:!0},[Symbol.toStringTag]:{value:`Module`}});var t=e=>typeof e==`string`?e.split(`|`):e,n=e=>({validation:{rules:e.validation?.rules?t(e.validation.rules):[],messages:e.validation?.messages??{}},value:e.value??null}),r=class{collection={};all(){return this.collection}first(e){let t=this.get(e);if(t){let e=Array.isArray(t)?t[0]:t;if(e)return String(e)}return null}any(){return Object.keys(this.collection).length>0}fill(e){return this.collection=e,this}push(e,t){return this.collection={...this.collection,[e]:t},this}has(e){return this.collection.hasOwnProperty(e)}get(e,t=null){return this.has(e)?this.collection[e]:t}unset(e){return this.has(e)&&delete this.collection[e],this}clear(){return this.collection={},this}},i=class extends r{},a=class extends r{},o=class extends r{push(e,t){let n=this.get(e)||[];return this.collection={...this.collection,[e]:[...n,t]},this}get(e){return super.get(e,[])}},s=class{errors=new o;messages=new i;rules=new a},c={required:e=>new Promise((t,n)=>{if(e==null)return n();String(e).replace(/\s/g,``).length>0?t(e):n()})},l=e=>typeof e==`object`&&!!e&&!Array.isArray(e),u=(e,t,n=null)=>{let r=t||new FormData;return Object.keys(e).forEach(t=>{let i=e[t];if(t=n?`${n}[${t}]`:t,!([void 0,null].indexOf(i)>-1)){if(l(i)&&!(i instanceof File)||Array.isArray(i)){u(i,r,t);return}r.append(t,i)}}),r},d=class{awaiting=!1;originalValues={};validation=new s;constructor(e){this.addFields(e)}addField(e,t){if(typeof t==`object`&&t&&Object.prototype.toString.call(t)===`[object Object]`&&`value`in t){let r=n(t);this[e]=r.value,this.originalValues[e]=r.value,this.validation.messages.push(e,r.validation.messages),this.validation.rules.push(e,r.validation.rules)}else this[e]=t,this.originalValues[e]=t;return this}addFields(e){return Object.keys(e).forEach(t=>{this.addField(t,e[t])}),this}get errors(){return this.validation.errors}fill(e,t=!1){return Object.keys(e).forEach(n=>{let r=e[n];t&&(this.originalValues[n]=r),this[n]=r}),this}get messages(){return this.validation.messages}removeField(e){return delete this[e],delete this.originalValues[e],this.validation.errors.unset(e),this.validation.messages.unset(e),this.validation.rules.unset(e),this}removeFields(e){return e.forEach(e=>{this.removeField(e)}),this}reset(){return this.validation.errors.clear(),Object.keys(this.originalValues).forEach(e=>{this[e]=this.originalValues[e]}),this}get rules(){return this.validation.rules}setAwaiting(e=!0){return this.awaiting=e,this}validate(e=null){return e?this.validateField(e):this.validateForm()}validateField(e){this.validation.errors.unset(e);let t=this.validation.rules.get(e);if(t&&t.length>0){let n=t.map(t=>{let n=t.split(`:`),r=n[0],i=n.length===2?n[1].split(`,`):[];return r in c?c[r](this[e],i).catch(t=>{let n=this.validation.messages.get(e);return n&&r in n&&this.validation.errors.push(e,n[r]),Promise.reject(t)}):Promise.reject(Error(`There is no validation rule called "${r}"`))});return Promise.all(n).then(()=>{})}return Promise.resolve()}validateForm(){let e=Object.keys(this.originalValues).map(e=>this.validateField(e));return Promise.all(e).then(()=>Promise.resolve(this)).catch(()=>Promise.reject(this))}values(e){let t={};return Object.keys(this.originalValues).forEach(n=>{(!e||e.includes(n))&&(t[n]=this[n])}),t}valuesAsFormData(e){return u(this.values(e))}},f=e=>new d(e),p=d;return e.createForm=f,e.default=p,e})({});

package/dist/src/utils/validations.d.ts

@@ -1,3 +0,0 @@
-import { Rules } from '../types/rules';
-export declare const required: (value: any) => Promise<any>;
-export declare const Rule: Rules;