Major update (TypeScript integration, dependency upgrades, API refactor)

.gitignore

@@ -1,9 +1,7 @@
 node_modules/
-.idea/
-.git
 npm-debug.log
 selenium-debug.log
 config.json
 dist/
 lib/
-.DS_Store
+.*

.nvmrc

@@ -1 +1 @@
-8.1.4
+8.3.0

.travis.yml

@@ -1,19 +1,14 @@
 sudo: false
 language: node_js
-cache:
-  directories:
-  - node_modules
 notifications:
   email:
     on_success: change
     on_failure: always
 before_script:
 - npm prune
 script:
-- npm run build
-- if [ "$TRAVIS_PULL_REQUEST" = "false" ]; then npm run test:ci; fi
-after_success:
-- npm run semantic-release
+- npm run build:prod
+- if [ "$TRAVIS_PULL_REQUEST" = "false" ]; then npm run test; fi
 branches:
   except:
   - "/^v\\d+\\.\\d+\\.\\d+$/"
@@ -23,6 +18,7 @@ addons:
       secure: f/lU4lF3HeFJei8KVsVsN92BXHf9BvKwA2tBqIN/PqdtpunVrETlmpf9gFbxfqe3Vwtig0l7X4eCYU0Qp0cG9cMEpO4TMiKMaSLyoGE2rheyYVeYGAZ7nIdxXKa9MzpvhyYNu16z6oNAtOCt1kxLjVtfGr4xrANUiFKs+/uyQqRBm8eajom5lsLeQkNTvh2hI17tVfBa0oWseKSkKp6yTn9c/CyeW9O6GHFLjBFFYWdqNCnEWFPOR4dR3dyajjqltC4MwHI8ysnX6+4OjbETxfCCiudtd3WCoUus5WlXdRI13SMNzRPntoJvZxowSVEiormH3Sbk3OJImEkYNKAr0eMGiF6PZitJ183fxxKyQro0dPgzR/sIWpk1/nB5HbOXFApH2dm1vnEWyGW5B5WiAE0r8rp8fhXvVhaZ4mvK2v/U+aZfSlvurvUnE8h4iJ6x+GZN883s/3m1f/Z/hJDBepkmYIA6TIpNz8pkdKjtwW7UXCDDxzAFSlXcgYVa+KDPmlhPrpL5EnKc3WDh4AgGm+NRnX8JV3OZyWK7mXCLaBBgXaph38FT+CX2NavYnm35sexYsWaZ2UqPjpvefpfBWfvoAb0RlA2dFtBpliTHLyFKfut6UtuzT6jH2ccMPKk2mlbaHF16zMgskUUYSCD6Fh4oWCMsVqJU2hUsLDiq7NI=
     access_key:
       secure: W7ICrd8F1D4AO/Movdrj5GCGhw/ScJ0jjdAdFcOzucGdNzeKITtQbhGKiNiZ6UWiQ+z3c2fwm0v6YPtZB2Gkjtez/IiReeMZ8e1OOU9NmjcgoOmd5zj6Nj0LaUq2uIo9mqQ9uUKNCCrNd8Muo9l87VKjxg2gfUbZ633eJdfO16psKvMkoiCxREwZ4dVoNBwahEuPV6o3GcAQwJ4GbAPfe0+6PzmmInjdj6BC5rsXlG1uQUVpMyfzDaA5wev44pInZvWEBLhZ4B5lcX6ZIQcUOc2ROEznNJ3Oq6FovdffCVCo36xoRPnUZB+j5tWosyVDvebWV+0Xp6Ppv41h3DWmlu/EwT0RaIra3zjfZ7+5KP9CKSO4kmw8P/4jLiZBIRY5INGWSBAlnCypdJk3bPvAckEz8ABoV5wChDyL+oPwJn9yogpQmlw3MEO40G4nMIJ41nkpmcazh+Hi40FFPuKHSxVEMj992SuCJ4CxKjTWg8eqCdLdgcaz3TRIGBzcWU3MHMIaX8Xm33prYtEOPkQhoyMJNcuwYh4sT/9w/CPu4MlVGv/iFnZ+Rt4c7Xe8jBma3YG8AVEyu0IYYzgW8PzjXr6He3pWHgIkIaB5b5jW2KPWUAOkEDB6vmDx6KHRWNCYW/6L0TfO3+AxiS3bfIIL7WOLCkc+WtUMSjvd01gQJMw=
+  chrome: stable
 env:
   global:
     - secure: gZkLEExtLiDXbkZ6a2kKl6BdFYzTztpnF/TMse0dVPZgC46dOZ3i0KClGo6Q5OhAVu2+97qbW8ye9iWmShF23nyJUqItqfi5wqn5ytzEoN10eEE/jcxn2BwBtpAB4VuiIh2RtPjWK4q4ji7r18O8jub3H64pofTr6tX1b069a/N4huw9xebGjcAcb8CP9hv184QDKEVT/ksr8F9f1/3n2uB7dofeERZTw6fmxTsHcGJ9y1irI/A9xp4HVXOshQWE6A/h5kJHuRdjyd6y/yNts2hC6vpbcWDr1eWKwYUALkQoYciB7RZaJOHKLMKWeDqfMEm5gx92Q1hLENfu4HQBWZglR7qhpZVWhk6Tfaj3p2OfM1IolQNG8mhk7GUslqsGo5YX6gQttls4OieXFPft0qMZnFReTcasXgIlBmhYQn7CqgxTtSqhP8vmIB90zHwb8Ou8FnsF1oae5vl93+UuhUjJsT62Zlw5f8VmUQODu7wkQYtb39tfzgX7KKtuTI5D+RmI73CpZaTrQMeQVl22Dpp0N1+7MKBxj4unCpi3J1xPoNWfXlgP+uld9L6bYUgfxXustPTSfZ6RuJpI4wahzBY6SksLwBtGLo47xrKi3W22BhP0oi+jPQmqacOH627HD62mD8PFfLB00TlqwtLP/vjAgPGOR8af7vYVzkN0lRA=

LICENSE.txt

@@ -1,6 +1,6 @@
 The MIT License (MIT)
 
-Copyright (c) 2017 Scott Logic
+Copyright (c) 2019 Scott Logic
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

readme.md → README.md

@@ -27,14 +27,8 @@ See an example finput [here](http://scottlogic.github.io/finput)
 `npm install finput`
 
 #### Initialise input
-To initialise the finput, simply pass the element and any options into the finput constructor.  
-The function returned is the cleanup function which removes all the added finput listeners from the input,
-making it act like the default browser input once again.
-
-```javascript
-var destroy = finput(element, options);
-destroy();  // Stops finput behaviour
-```
+To initialise the finput, simply pass the element and any options into the finput constructor.
+An object is returned which allows you to interact with the finput API.
 
 Options
 -----
@@ -81,16 +75,16 @@ Default: `{
 An object mapping of shortcuts that the user can use to quickly enter common values.
 E.g. with the default shortcuts, typing `k` will multiply the number value by 1000
 
-##### invalidKeyCallback
+##### onInvalidKey
 Type: `Function(e)`  
 Default: `() => {}`  
-A callback function that is fired everytime a invalid key is pressed.
+A callback function that is fired each time a invalid key is pressed.
 the callback is called with the [KeyboardEvent](https://developer.mozilla.org/en-US/docs/Web/API/KeyboardEvent) object that was raised on keydown.
 
-##### onFocusinCallback
+##### onFocus
 Type: `Function(e)`  
 Default: `undefined`  
-A callback function that is fired everytime the input is brought into focus.
+A callback function that is fired each time the input is focussed.
 the callback is called with the `Event` object.
 
 the function used needs to return an object with a start and end value, a numerical
@@ -103,21 +97,21 @@ representation of the postions to select.
 
 setting both values to 0 or failing to return both values will disable selecting functionality
 
-Accessing input value
----------------------
-
-The formatted value (the inputs value) and raw numeric value can be access directly on the dom element
-as follows:  
-**Formatted value** - `element.value` _(the normal input value)_  
-**Raw numeric value** - `element.rawValue`
-
 API
 --------------------
 
-The following functions are exposed on the `element`:
+The following properties are exposed on the returned finput instance:
+
+##### options
+Retrieves the options on the input
+
+##### rawValue
+Retrieves the raw value of the input (numerical)
+
+#### value
+Retrieves the formatted value of the input (string)
 
-##### getOptions
-Gets a copy of the options from the input
+The following functions are exposed on the returned finput instance:
 
 ##### setOptions
 Sets the options on the input
@@ -143,6 +137,9 @@ Sets the value, fully formatted, for the input
 ##### setRawValue
 Sets and formats the value for the input
  * `val` New value to set
+
+##### removeListeners
+Removes finputs listeners from the provided element, returning it to a standard native control
 
 Developing
 ----------
@@ -159,7 +156,9 @@ Run dev server:
 
 Building Library
 ----------------
-- `npm run build`
+- `npm run build:dev` - Builds a development friendly version of the application
+- `npm run build:prod` - Builds a minified version of the application
+- `npm run compile` - Compiles typescript dependency-free version of library
 
 Running tests
 -------------

index.d.ts

@@ -0,0 +1,38 @@
+import { ActionType, Key, Range } from "./src/constants";
+import ValueHistory from "./src/valueHistory";
+
+interface IState {
+    value: string;
+    caretStart: number;
+    caretEnd: number;
+    valid: boolean;
+}
+
+interface IKeyInfo {
+    name: string;
+    modifiers: string[];
+}
+
+interface IOptions {
+    thousands: string;
+    decimal: string;
+    fixed: boolean;
+    range: Range;
+    scale: number;
+    shortcuts: { [shortcut: string]: number };
+    onInvalidKey: (event: KeyboardEvent) => void;
+    onFocus: (event: FocusEvent) => ISelection | void;
+}
+
+interface IAction {
+    type: ActionType;
+    names: string[];
+    modifiers?: Key[];
+}
+
+interface ISelection {
+    start: number;
+    end: number;
+}
+
+type ActionHandler = (currentState: IState, keyInfo: IKeyInfo, options: IOptions, history: ValueHistory) => IState;

index.html

@@ -69,29 +69,30 @@ <h2>Native Controls</h2>
   finput(finputDefault, {});
 
   finput(finputCustomFocus, {
-    onFocusinCallback: function () { return { start: 0, end: 1 }; }
+    onFocus: function () { return { start: 0, end: 1 }; }
   });
 
   finput(finputInvalidKeyCallback, {
-    invalidKeyCallback: function (info) { console.log('invalid keypress', info); }
+    onInvalidKey: function (info) { console.log('invalid keypress', info); }
   });
 
   finput(finputReversedDelimiters, {
     thousands: '.',
     decimal: ','
   });
 
-  finput(finputSwitchOptions, {});
+  var finputSwitchOptionsInstance = finput(finputSwitchOptions, {});
 
   finputSwitchOptionsButton.onclick = function () {
-    var options = finputSwitchOptions.getOptions();
-    var tempThousands = options.thousands;
-    options.thousands = options.decimal;
-    options.decimal = tempThousands;
+    var tempThousands = finputSwitchOptionsInstance.options.thousands;
+    var tempRawValue = finputSwitchOptionsInstance.rawValue;
 
-    finputSwitchOptions.setOptions(options);
-    // redraw
-    finputSwitchOptions.setRawValue(finputSwitchOptions.rawValue);
+
+    finputSwitchOptionsInstance.setOptions({
+        thousands: finputSwitchOptionsInstance.options.decimal,
+        decimal: tempThousands
+    });
+    finputSwitchOptionsInstance.setRawValue(tempRawValue);
   }
 </script>