Add typescript definition file and test (#12)

* Add typescript typings

* Add typescript checking script at validate phase

Author: CarlosBonetti

package-scripts.js

@@ -72,10 +72,20 @@ module.exports = {
       description: 'flow check the entire project',
       script: 'flow check'
     },
+    typescript: {
+      description: 'typescript check the entire project',
+      script: 'tsc'
+    },
     validate: {
       description:
         'This runs several scripts to make sure things look good before committing or on clean install',
-      default: concurrent.nps('lint', 'flow', 'build.andTest', 'test')
+      default: concurrent.nps(
+        'lint',
+        'flow',
+        'typescript',
+        'build.andTest',
+        'test'
+      )
     }
   },
   options: {

package.json

@@ -7,6 +7,7 @@
   "jsnext:main": "dist/final-form-calculate.es.js",
   "module": "dist/final-form-calculate.es.js",
   "files": ["dist"],
+  "typings": "dist/index.d.ts",
   "scripts": {
     "start": "nps",
     "test": "nps test",
@@ -56,7 +57,8 @@
     "rollup-plugin-flow": "^1.1.1",
     "rollup-plugin-node-resolve": "^3.3.0",
     "rollup-plugin-replace": "^2.0.0",
-    "rollup-plugin-uglify": "^3.0.0"
+    "rollup-plugin-uglify": "^3.0.0",
+    "typescript": "^2.7.2"
   },
   "peerDependencies": {
     "final-form": ">=1.3.0"

src/index.d.test.ts

@@ -0,0 +1,28 @@
+import createDecorator from './'
+
+createDecorator(
+  {
+    field: 'foo',
+    updates: {
+      bar: (value, allValues) => {
+        return value
+      },
+      baz: (value, allValues) => {
+        return value
+      },
+    },
+  },
+  {
+    field: ['bar', 'baz'],
+    updates: (value, field, allValues) => {
+      return { ...allValues }
+    },
+  },
+  {
+    field: /ba/,
+    isEqual: (a, b) => a === b,
+    updates: (value, field, allValues) => {
+      return { ...allValues }
+    },
+  }
+)

src/index.d.ts

@@ -0,0 +1,27 @@
+import { Decorator } from 'final-form'
+
+export type FieldName = string
+
+export type FieldPattern = FieldName | RegExp | FieldName[]
+
+export type UpdatesByName = {
+  [FieldName: string]: (value: any, allValues?: Object) => any
+}
+
+export type UpdatesForAll = (
+  value: any,
+  field: string,
+  allValues?: Object,
+) => { [FieldName: string]: any }
+
+export type Updates = UpdatesByName | UpdatesForAll
+
+export type Calculation = {
+  field: FieldPattern,
+  updates: Updates,
+  isEqual?: (a: any, b: any) => boolean,
+}
+
+export default function createDecorator(
+  ...calculations: Calculation[]
+): Decorator

tsconfig.json

@@ -0,0 +1,9 @@
+{
+  "compilerOptions": {
+    "baseUrl": ".",
+    "noEmit": true,
+    "strict": true,
+    "lib": ["es6"]
+  },
+  "include": ["./src/**/*"]
+}