Merge pull request #22 from nullgr/feature/type-definitons

Feature/type definitons

Author: Kazimirkas

README.md

@@ -165,7 +165,7 @@ When you are creating the component state, you can use this method to prevalidat
 If you want, you can set `showErrorsOnStart` to true, so fields will be validated and you will get all the errors in the first component render.
 When you are adding a Validator with `Validator.addValidation` method, all the fields will be prevalidated.
 Prevalidation means, that you will get no error message, if the field has not passed a validation rule  (`'prevalidation-failed'`).
-Vэlidation means, that you will get an error message, if the field has not passed a validation rule (`'validation-failed'`).
+Validation means, that you will get an error message, if the field has not passed a validation rule (`'validation-failed'`).
 
 ### validate({stateChange} | updater | null, showErrors = true)
 You should use it inside the this.setState method like it was already described [here](#validation).
@@ -235,4 +235,4 @@ Use this method to check, if particular field is valid. Returns true if it is va
 
 
 ## Compatibility 
-This package id fully compatible with the React v.16, because it uses state updater functions inside.
+This package is fully compatible with the React v.16, because it uses state updater functions inside.

build/index.d.ts

@@ -0,0 +1,42 @@
+type Rule = (val: string | boolean, state: object) => boolean;
+
+type RuleData = {
+  rule: Rule;
+  message: string;
+  id?: string;
+};
+
+type FieldsDescription = {
+  [key: string]: RuleData | RuleData[];
+};
+
+export default class Validator<State> {
+  constructor(fields: FieldsDescription, validationStorageName?: string);
+
+  // 'State' type in methods below is right only in argument of addValidation method
+  //
+  // In all another methods 'State' type is incorrect,
+  // in real scenario it contains one more field [validationStorageName]
+  //
+  // In most cases user of library shouldn't care about [validationStorageName] field
+  // in component state, so this inaccuracy isn't very serious, but at the same time
+  // it simplifies the use of library
+
+  addValidation(state: State, showErrorsOnStart?: boolean): Readonly<State>;
+
+  validate(
+    stateUpdates: (prevState: Readonly<State>) => State,
+    showErrors?: boolean
+  ): ((prevState: Readonly<State>) => State);
+
+  validate(
+    stateUpdates?: { [key in keyof State]: string } | null,
+    showErrors?: boolean
+  ): Readonly<State>;
+
+  getErrors(state: State): { [key in keyof State]: string };
+
+  isFormValid(state: State): boolean;
+
+  isFieldValid(state: State, fieldName: string): boolean;
+}

build/rules/index.d.ts

@@ -0,0 +1,2 @@
+export function requiredRule(value: string | boolean): boolean;
+export function lengthRule(l: number): (v: string) => boolean;

package.json

@@ -5,7 +5,7 @@
   "main": "build/index.js",
   "scripts": {
     "dev": "watch 'npm run build' src",
-    "build": "babel src -d build",
+    "build": "babel src -d build && babel types -d build --copy-files",
     "test": "jest",
     "prepush": "npm test",
     "prepublish": "npm run build",

types/index.d.ts

@@ -0,0 +1,42 @@
+type Rule = (val: string | boolean, state: object) => boolean;
+
+type RuleData = {
+  rule: Rule;
+  message: string;
+  id?: string;
+};
+
+type FieldsDescription = {
+  [key: string]: RuleData | RuleData[];
+};
+
+export default class Validator<State> {
+  constructor(fields: FieldsDescription, validationStorageName?: string);
+
+  // 'State' type in methods below is right only in argument of addValidation method
+  //
+  // In all another methods 'State' type is incorrect,
+  // in real scenario it contains one more field [validationStorageName]
+  //
+  // In most cases user of library shouldn't care about [validationStorageName] field
+  // in component state, so this inaccuracy isn't very serious, but at the same time
+  // it simplifies the use of library
+
+  addValidation(state: State, showErrorsOnStart?: boolean): Readonly<State>;
+
+  validate(
+    stateUpdates: (prevState: Readonly<State>) => State,
+    showErrors?: boolean
+  ): ((prevState: Readonly<State>) => State);
+
+  validate(
+    stateUpdates?: { [key in keyof State]: string } | null,
+    showErrors?: boolean
+  ): Readonly<State>;
+
+  getErrors(state: State): { [key in keyof State]: string };
+
+  isFormValid(state: State): boolean;
+
+  isFieldValid(state: State, fieldName: string): boolean;
+}

types/rules/index.d.ts

@@ -0,0 +1,2 @@
+export function requiredRule(value: string | boolean): boolean;
+export function lengthRule(l: number): (v: string) => boolean;