[typescript] test and fixes for index.d.ts

Author: rosskevin

.gitignore

@@ -9,3 +9,5 @@ lib
 es
 npm-debug.log
 .DS_Store
+.idea
+yarn.lock

package-scripts.js

@@ -64,10 +64,14 @@ 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

@@ -6,14 +6,15 @@
   "jsnext:main": "dist/final-form-arrays.es.js",
   "module": "dist/final-form-arrays.es.js",
   "typings": "dist/index.d.js",
-  "files": ["dist"],
+  "files": [
+    "dist"
+  ],
   "scripts": {
     "start": "nps",
     "test": "nps test",
     "precommit": "lint-staged && npm start validate"
   },
-  "author":
-    "Erik Rasmussen <[email protected]> (http://github.com/erikras)",
+  "author": "Erik Rasmussen <[email protected]> (http://github.com/erikras)",
   "license": "MIT",
   "repository": {
     "type": "git",
@@ -39,7 +40,7 @@
     "eslint-plugin-import": "^2.8.0",
     "eslint-plugin-jsx-a11y": "^6.0.3",
     "eslint-plugin-react": "^7.5.1",
-    "final-form": "^1.3.5",
+    "final-form": "^4.0.3",
     "flow": "^0.2.3",
     "flow-bin": "^0.61.0",
     "husky": "^0.14.3",
@@ -55,13 +56,17 @@
     "rollup-plugin-flow": "^1.1.1",
     "rollup-plugin-node-resolve": "^3.0.0",
     "rollup-plugin-replace": "^2.0.0",
-    "rollup-plugin-uglify": "^2.0.1"
+    "rollup-plugin-uglify": "^2.0.1",
+    "typescript": "^2.6.2"
   },
   "peerDependencies": {
     "final-form": ">=1.2.0"
   },
   "lint-staged": {
-    "*.{js*,ts,json,md,css}": ["prettier --write", "git add"]
+    "*.{js*,ts*,json,md,css}": [
+      "prettier --write",
+      "git add"
+    ]
   },
   "bundlesize": [
     {

src/index.d.test.ts

@@ -0,0 +1,24 @@
+// tslint:disable no-console
+
+import { Config, createForm, AnyObject } from 'final-form'
+import * as arrayMutators from './index'
+import { Mutators } from './index'
+
+const onSubmit: Config['onSubmit'] = (values, callback) => {}
+
+const form = createForm({
+  mutators: { ...arrayMutators },
+  onSubmit
+})
+
+// Get form.mutators (default as object) and cast to Mutators
+const mutators: Mutators = ((form.mutators || {}) as any) as Mutators
+
+mutators.insert('customers', 0, { firstName: '', lastName: '' })
+mutators.move('customers', 0, 1)
+const customer = mutators.pop('customers')
+mutators.push('customers', { firstName: '', lastName: '' })
+const removed = mutators.remove('customers', 0)
+const shifted = mutators.shift('customers')
+mutators.swap('customers', 0, 1)
+mutators.unshift('customers', { firstName: '', lastName: '' })

src/index.d.ts

@@ -1,11 +1,16 @@
 import { Mutator } from 'final-form'
 
-type DefaultType = { [key: string]: Mutator }
-
-export default DefaultType
+export const insert: Mutator
+export const move: Mutator
+export const pop: Mutator
+export const push: Mutator
+export const remove: Mutator
+export const shift: Mutator
+export const swap: Mutator
+export const unshift: Mutator
 
 /** The shape of the mutators once final-form has bound them to state */
-export type Mutators = {
+export interface Mutators {
   insert: (name: string, index: number, value: any) => void
   move: (name: string, from: number, to: number) => void
   pop: (name: string) => any

tsconfig.json

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