Support for targetId added in getTypingPattern()

raulpopa · raulpopa · commit 174a701bfd3f · 2017-11-10T14:52:36.000+02:00
diff --git a/README.md b/README.md
@@ -1,9 +1,17 @@
 # TypingDNA JavaScript recorder 
-##### A simple way to record typing patterns
+##### A simple way to capture user’s typing patterns
 Full documentation at [api.typingdna.com](https://api.typingdna.com)*
 
 ### Usage and description
-First create an instance of the TypingDNA class. Once it's done, the user typing starts being recorded (as a history of strokes). Whenever you want to get the user's typing pattern you have to invoke .getTypingPattern method described in detail below.
+First you need to import the [typingdna.js](https://typingdna.com/scripts/typingdna.js) file in the page that wants to record a typing pattern. You will need to record typing patterns when a user first creates his account and again whenever you want to authenticate that user on your platform. You can host the .js file yourself. 
+
+Alternative locations from where you can include the last class: 
+* https://typingdna.com/scripts/typingdna.js
+* https://api.typingdna.com/scripts/typingdna.js
+
+### TypingDNA class
+
+Once you create an instance of the TypingDNA class, the user typing starts being recorded (as a history of strokes). Whenever you want to get the user's typing pattern you have to invoke .getTypingPattern method described in detail below.
 
 **Returns**: Returns the instance of the TypingDNA class (singleton)
 
@@ -28,7 +36,7 @@ This is the main function that outputs the user's typing pattern as a `String`
 
 **Returns**: A typing pattern in `String` form  
 
-**optionsObject**: An object of the following form {type:Number, text:String, textId:Number, length: Number, extended:Boolean}. Detail table below.
+**optionsObject**: An object of the following form {type:Number, text:String, textId:Number, length: Number, extended:Boolean, targetId:String}. Detail table below.
 
 | Param | Type | Description | 
 | --- | --- | --- |
@@ -37,6 +45,7 @@ This is the main function that outputs the user's typing pattern as a `String`
 | **textId** | `Number` | (Optional, only for type 1) a personalized id for the typed text | 
 | **length** | `Number` | (Optional) the length of the text in the history for which you want the typing pattern, for type 0 is usually 140 or more |
 | **extended** | `Boolean` | (Only for type 1) specifies if full information about what was typed is produced, including the actual key pressed, if false, only the order of pressed keys is kept (no actual content) |
+| **targetId** | `String` | (Optional) specifies if pattern is obtain only from text typed in a certain target |
 
 **Examples**  
 ```js
@@ -48,7 +57,7 @@ var generalPattern = tdna.getTypingPattern({type=0, length=160});
 ### TypingDNA.addTarget(element_id)
 (Optional) Adds a target to the targetIds array. It has to be a text input or text area or any other HTML DOM element that has the .value property. You can add multiple targets (such as username and password fields). 
 
-If you omit adding targets the typing patterns will be outputed for the entire typing session.
+If you omit adding targets the typing patterns will be recorded for the entire typing session.
 
 **Example**  
 ```js
diff --git a/typingdna.js b/typingdna.js
@@ -3,7 +3,7 @@
  * https://api.typingdna.com/scripts/typingdna.js
  * https://typingdna.com/scripts/typingdna.js (alternative)
  *
- * @version 2.9
+ * @version 2.11
  * @author Raul Popa
  * @copyright SC TypingDNA SRL, http://typingdna.com
  * @license http://www.apache.org/licenses/LICENSE-2.0
@@ -20,8 +20,8 @@
  *
  * Typical usage:
  * var tdna = new TypingDNA(); // creates a new TypingDNA object and starts recording
- * var typingPattern = tdna.get(); // returns a typing pattern (and continues recording afterwards),
- * optionally you can pass a length, tdna.get(200) will return the pattern based on the last 200 key events.
+ * var typingPattern = tdna.getTypingPattern({type=1, text="Hello5g21?*", extedend=false});
+ * returns a type 1 typing pattern (and continues recording afterwards)
  *
  * Optional:
  * tdna.stop(); // ends recording and clears history stack (returns recording flag: false)
@@ -97,7 +97,7 @@ function TypingDNA() {
     TypingDNA.prototype.defaultHistoryLength = TypingDNA.defaultHistoryLength;
     TypingDNA.prototype.maxSeekTime = TypingDNA.maxSeekTime;
     TypingDNA.prototype.maxPressTime = TypingDNA.maxPressTime;
-    TypingDNA.version = 2.9;
+    TypingDNA.version = 2.11;
     TypingDNA.flags = 0;
     TypingDNA.instance = this;
     TypingDNA.document = document;
@@ -159,6 +159,9 @@ function TypingDNA() {
         return;
       }
       var keyCode = e.keyCode;
+      if (TypingDNA.wfk[keyCode] == 1 || TypingDNA.dwfk[keyCode] == 1) {
+        //return;
+      }
       if (keyCode == 229 && TypingDNA.isMobile() && !TypingDNA.isAndroidChrome) {
         TypingDNA.isAndroidChrome = true;
 
@@ -222,7 +225,7 @@ function TypingDNA() {
           if (TypingDNA.wfk[keyCode] == 1) {
             var pressTime = ut - TypingDNA.sti[keyCode];
             var seekTime = TypingDNA.skt[keyCode];
-            var arr = [keyCode, seekTime, pressTime, TypingDNA.prevKeyCode, ut];
+            var arr = [keyCode, seekTime, pressTime, TypingDNA.prevKeyCode, ut, e.target.id];
             TypingDNA.history.add(arr);
             TypingDNA.prevKeyCode = keyCode;
           }
@@ -235,7 +238,7 @@ function TypingDNA() {
             var pressTime = ut - TypingDNA.dsti[keyCode];
             var seekTime = TypingDNA.dskt[keyCode];
             var realKeyCode = TypingDNA.drkc[keyCode];
-            var arrD = [keyCode, seekTime, pressTime, realKeyCode];
+            var arrD = [keyCode, seekTime, pressTime, realKeyCode, ut, e.target.id];
             TypingDNA.history.addDiagram(arrD);
           }
         }
@@ -584,6 +587,7 @@ function TypingDNA() {
      * Automatically called at initilization. It starts the recording of keystrokes.
      */
     TypingDNA.start = function() {
+      TypingDNA.diagramRecording = true;
       return TypingDNA.recording = true;
     }
 
@@ -592,6 +596,7 @@ function TypingDNA() {
      * either call TypingDNA.start() or create a new TypingDNA object again, not recommended.
      */
     TypingDNA.stop = function() {
+      TypingDNA.diagramRecording = false;
       return TypingDNA.recording = false;
     }
 
@@ -609,45 +614,34 @@ function TypingDNA() {
       return TypingDNA.mouseRecording = TypingDNA.mouseMoveRecording = false;
     }
 
-    /**
-     * Starts the recording of a non-fixed diagram typing pattern.
-     */
-    TypingDNA.startDiagram = function() {
-      return TypingDNA.diagramRecording = true;
-    }
-
-    /**
-     * Ends the recording of a non-fixed diagram typing pattern.
-     */
-    TypingDNA.stopDiagram = function() {
-      return TypingDNA.diagramRecording = false;
-    }
-
     /**
      * This is the main function that outputs the typing pattern as a String
-     * {type:Number, text:String, textId:Number, length: Number, extended:Boolean}
+     * {type:Number, text:String, textId:Number, length: Number, extended:Boolean, targetId:String}
      * @param {Object} obj an object with the following properties
      * * * @param {String} type 0 for standard pattern, 1 for diagram pattern
-     * * * @param {Number} length (Optional) the length of the text in the history for which you want the typing pattern
+     * * * @param {Number} length (Optional) the length of the text in the history for which you want
+     * * * the typing pattern. length is ignored when text or targetId is set (or both).
      * * * @param {String} text  (Only for type 1) a typed string that you want the typing pattern for
      * * * @param {Number} textId (Optional, only for type 1) a personalized id for the typed text
      * * * @param {Boolean} extended (Only for type 1) specifies if full information about what was typed is produced,
      * * * including the actual key pressed, if false, only the order of pressed keys is kept (no actual content)
+     * * * @param {String} targetId (Optional) specifies if pattern is obtain only from text typed in a certain target
      * @return {String} A typing pattern in string form
-     * @example var typingPattern = tdna.getDiagram();
-     * @example var typingPattern = tdna.getDiagram("Hello5g21?*");
+     * @example var typingPattern = tdna.getTypingPattern({type=1, length=160, extended=true});
+     * @example var typingPattern = tdna.getTypingPattern({type=1, text="Hello5g21?*", extedend=false});
+     * @example var typingPattern = tdna.getTypingPattern({type=0, length=180});
      */
     TypingDNA.getTypingPattern = function(obj) {
       if (typeof obj === 'object') {
         switch (obj.type) {
           case 0:
-            return TypingDNA.get(obj.length);
+            return TypingDNA.get(obj.length, obj.targetId);
             break;
           case 1:
             if (obj.text != undefined) {
-              return TypingDNA.history.getDiagram(obj.extended, obj.text, obj.textId);
+              return TypingDNA.history.getDiagram(obj.extended, obj.text, obj.textId, obj.targetId);
             } else {
-              return TypingDNA.history.getDiagram(obj.extended, obj.length, obj.textId);
+              return TypingDNA.history.getDiagram(obj.extended, obj.length, obj.textId, obj.targetId);
             }
             break;
           default:
@@ -659,33 +653,10 @@ function TypingDNA() {
       }
     }
 
-    /**
-     * This function outputs the linear diagram typing pattern as a String
-     * @param  {String} str Optional: The string represented by the diagram
-     * The function checks for the exact string (with minor typos) in the recorded
-     * history. Any letters that are not included in the string will be ommited from
-     * the output diagram typing pattern.
-     * @return {String} The TypingDNA linear diagram typing pattern, comma separated.
-     * A non-fixed vector of only numeric values separated by commas.
-     * @example var typingPattern = tdna.getDiagram();
-     * @example var typingPattern = tdna.getDiagram("Hello5g21?*");
-     */
     TypingDNA.getDiagram = function(str, textId) {
       return TypingDNA.history.getDiagram(false, str, textId);
     }
 
-    /**
-     * This function outputs the extended linear diagram typing pattern as a String
-     * Compared to getDiagram, it includes char codes (not safe for storage)
-     * @param  {String} str Optional: The string represented by the diagram
-     * The function checks for the exact string (with minor typos) in the recorded
-     * history. Any letters that are not included in the string will be ommited from
-     * the output diagram typing pattern.
-     * @return {String} The TypingDNA linear diagram typing pattern, comma separated.
-     * A non-fixed vector of only numeric values separated by commas.
-     * @example var typingPattern = tdna.getExtendedDiagram();
-     * @example var typingPattern = tdna.getExtendedDiagram("Hello5g21?*");
-     */
     TypingDNA.getExtendedDiagram = function(str, textId) {
       return TypingDNA.history.getDiagram(true, str, textId);
     }
@@ -694,32 +665,23 @@ function TypingDNA() {
       return TypingDNA.mouse.history.getDiagram();
     }
 
-    /**
-     * This function outputs the typing pattern as a String, in a new basic structure for
-     * easy storage and usage in any kind of keystroke dynamics applications (e.g. typing
-     * pattern matching, user recognition)
-     * @param  {Number} length Optional: The amount of history keystrokes to use for the
-     * typing pattern. By default it will use the last 500 recorded keystrokes (or as many
-     * available if less than 500).
-     * @return {String}        The TypingDNA typing pattern, comma separated.
-     * A fixed vector of only numeric values separated by commas.
-     * @example var typingPattern = tdna.get();
-     * @example var typingPattern = tdna.get(200);
-     */
-    TypingDNA.get = function(length) {
+    TypingDNA.get = function(length, targetId) {
       var historyTotalLength = TypingDNA.history.stack.length;
-      if (length == undefined) {
+      if (length == undefined || length == 0) {
         length = TypingDNA.defaultHistoryLength;
       }
       if (length > historyTotalLength) {
         length = historyTotalLength;
       }
       var obj = {};
-      obj.arr = TypingDNA.history.get(length);
+      [obj.arr, targetLength] = TypingDNA.history.get(length, "", targetId);
+      if (targetId != undefined && targetId != "") {
+        length = targetLength;
+      }
       var zl = TypingDNA.zl;
       var histRev = length;
-      var histSktF = TypingDNA.math.fo(TypingDNA.history.get(length, "seek"));
-      var histPrtF = TypingDNA.math.fo(TypingDNA.history.get(length, "press"));
+      var histSktF = TypingDNA.math.fo(TypingDNA.history.get(length, "seek", targetId));
+      var histPrtF = TypingDNA.math.fo(TypingDNA.history.get(length, "press", targetId));
       var pressHistMean = Math.round(TypingDNA.math.avg(histPrtF));
       var seekHistMean = Math.round(TypingDNA.math.avg(histSktF));
       var pressHistSD = Math.round(TypingDNA.math.sd(histPrtF));
@@ -911,27 +873,39 @@ function TypingDNA() {
       this.stackDiagram.push(arr);
     }
 
-    TypingDNA.history.getDiagram = function(extended, str, textId) {
+    TypingDNA.history.getDiagram = function(extended, str, textId, targetId) {
       var returnArr = [];
       var diagramType = (extended == true) ? 1 : 0;
-      var diagramHistoryLength = this.stackDiagram.length;
-      var targetLength = TypingDNA.targetIds.length;
-      var missingCount = 0;
-      if (str == undefined){
-        if(targetLength > 0) {
-          str = "";
-          for (var i = 0; i < targetLength; i++) {
-            var element = TypingDNA.document.getElementById(TypingDNA.targetIds[i]);
-            if (element != null) {
-              str += element.value;
-            }
+      var stackDiagram = this.stackDiagram;
+      if (targetId != undefined && targetId != "" && stackDiagram.length > 0) {
+        stackDiagram = TypingDNA.sliceStackByTargetId(stackDiagram, targetId);
+        if (str == undefined || str == ""){
+          var element = TypingDNA.document.getElementById(targetId);
+          if (element != null) {
+            str = element.value;
           }
-        } else {
-          if (!extended) {
-            console.log("Please use extended diagram OR provide a fixed string param OR use the addTarget method.");
+        }
+      } else {
+        var targetLength = TypingDNA.targetIds.length;
+        if (str == undefined || str == ""){
+          if(targetLength > 0) {
+            str = "";
+            for (var i = 0; i < targetLength; i++) {
+              var element = TypingDNA.document.getElementById(TypingDNA.targetIds[i]);
+              if (element != null) {
+                str += element.value;
+              }
+            }
+          } else {
+            if (!extended) {
+              console.log("Please use extended diagram OR provide a fixed string param OR use the addTarget method.");
+            }
           }
         }
       }
+
+      var missingCount = 0;
+      var diagramHistoryLength = stackDiagram.length;
       var strLength = diagramHistoryLength;
       if (typeof str === 'string') {
           strLength = str.length;
@@ -963,7 +937,7 @@ function TypingDNA() {
           var found = false
           while (found == false){
             for (var j = startPos; j < finishPos; j++) {
-              var arr = this.stackDiagram[j];
+              var arr = stackDiagram[j];
               var charCode = arr[3];
               if (charCode == currentCharCode) {
                 found = true;
@@ -1032,7 +1006,7 @@ function TypingDNA() {
           startCount = 0;
         }
         for (var i = startCount; i < diagramHistoryLength; i++) {
-          var arr = this.stackDiagram[i];
+          var arr = stackDiagram[i];
           var keyCode = arr[0];
           var seekTime = arr[1];
           var pressTime = arr[2];
@@ -1047,8 +1021,24 @@ function TypingDNA() {
       return returnArr.join("|");
     }
 
-    TypingDNA.history.get = function(length, type) {
-      var historyTotalLength = this.stack.length;
+    TypingDNA.sliceStackByTargetId = function(stack, targetId){
+      var length = stack.length;
+      var newStack = [];
+      for (i = 0; i < length; i++) {
+        var arr = stack[i];
+        if (arr[5] == targetId){
+          newStack.push(arr);
+        }
+      }
+      return newStack;
+    }
+
+    TypingDNA.history.get = function(length, type, targetId) {
+      var stack = this.stack;
+      if (targetId != undefined && targetId != "" && stack.length > 0) {
+        stack = TypingDNA.sliceStackByTargetId(stack, targetId);
+      }
+      var historyTotalLength = stack.length;
       if (length == 0 || length == undefined) {
         length = TypingDNA.defaultHistoryLength;
       }
@@ -1059,7 +1049,7 @@ function TypingDNA() {
         case "seek":
           var seekArr = [];
           for (i = 1; i <= length; i++) {
-            var seekTime = this.stack[historyTotalLength - i][1];
+            var seekTime = stack[historyTotalLength - i][1];
             if (seekTime <= TypingDNA.maxSeekTime) {
               seekArr.push(seekTime);
             }
@@ -1069,7 +1059,7 @@ function TypingDNA() {
         case "press":
           var pressArr = [];
           for (i = 1; i <= length; i++) {
-            var pressTime = this.stack[historyTotalLength - i][2];
+            var pressTime = stack[historyTotalLength - i][2];
             if (pressTime <= TypingDNA.maxPressTime) {
               pressArr.push(pressTime);
             }
@@ -1086,7 +1076,7 @@ function TypingDNA() {
             ];
           }
           for (i = 1; i <= length; i++) {
-            var arr = this.stack[historyTotalLength - i];
+            var arr = stack[historyTotalLength - i];
             var keyCode = arr[0];
             var seekTime = arr[1];
             var pressTime = arr[2];
@@ -1103,7 +1093,7 @@ function TypingDNA() {
               }
             }
           };
-          return historyStackObj;
+          return [historyStackObj, length];
       }
     }
 
diff --git a/versions/typingdna_2.11.js b/versions/typingdna_2.11.js
