Added case sensitive support for getTypingPattern function. Optional usage.

Author: raulpopa

README.md

@@ -1,17 +1,17 @@
-# TypingDNA JavaScript recorder 
+# TypingDNA JavaScript recorder
 ##### A simple way to capture user’s typing patterns
 Full documentation at [api.typingdna.com](https://api.typingdna.com)*
 
 ### Usage and description
-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. 
+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: 
+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.
+Once you create an instance of the TypingDNA class, the user typing starts being recorded (as a history of keystroke events). 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 +28,7 @@ Here are the functions available in the TypingDNA class:
 * .start()  *Automatically called by default*
 * .stop()
 * .reset()
-* .getQuality(typingPattern) ⇒ `Number` 
+* .getQuality(typingPattern) ⇒ `Number`
 
 
 ### TypingDNA.getTypingPattern(optionsObject)
@@ -38,14 +38,15 @@ This is the main function that outputs the user's typing pattern as a `String`
 
 **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 | 
+| Param | Type | Description |
 | --- | --- | --- |
-| **type** | `Number` | `0 for anytext pattern` (when you compare random typed texts of usually 120-180 chars long) <br> `1 for diagram pattern` (recommended in most cases, for emails, passwords, phone numbers, credit cards, short texts) | 
+| **type** | `Number` | `0 for anytext pattern` (when you compare random typed texts of usually 120-180 chars long) <br> `1 for diagram pattern` (recommended in most cases, for emails, passwords, phone numbers, credit cards, short texts) |
 | **text** | `String` | (Only for type 1) a typed string that you want the typing pattern for |
-| **textId** | `Number` | (Optional, only for type 1) a personalized id for the typed text | 
+| **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 |
+| **caseSensitive** | `Boolean` | (Optional, default: false, Only for type 1) Used if you pass a text for type 1 |
 
 **Examples**  
 ```js
@@ -55,7 +56,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). 
+(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 recorded for the entire typing session.
 
@@ -72,14 +73,14 @@ Remove a target from the targetIds array.
 Resets the history stack of recorded typing events.
 
 ### TypingDNA.start()
-Automatically called at initilization. It starts the recording of typing events. You only have to call .start() to resume recording after a .stop() 
+Automatically called at initilization. It starts the recording of typing events. You only have to call .start() to resume recording after a .stop()
 
 ### TypingDNA.stop()
-Ends the recording of further typing events. 
+Ends the recording of further typing events.
 
 ### TypingDNA.getQuality(typingPattern)
 Checks the quality of a general typing pattern (type 0), how well it is revelated, how useful the
-information will be for matching applications. 
+information will be for matching applications.
 
 **Returns**: `Number` - A real number between `0` and `1`. Values over `0.3` are acceptable, however a value over `0.7` shows good pattern strength.
 

typingdna.js

@@ -3,7 +3,7 @@
  * https://api.typingdna.com/scripts/typingdna.js
  * https://typingdna.com/scripts/typingdna.js (alternative)
  *
- * @version 2.11
+ * @version 2.12
  * @author Raul Popa
  * @copyright SC TypingDNA SRL, http://typingdna.com
  * @license http://www.apache.org/licenses/LICENSE-2.0
@@ -102,7 +102,7 @@ function TypingDNA() {
     TypingDNA.prototype.defaultHistoryLength = TypingDNA.defaultHistoryLength;
     TypingDNA.prototype.maxSeekTime = TypingDNA.maxSeekTime;
     TypingDNA.prototype.maxPressTime = TypingDNA.maxPressTime;
-    TypingDNA.version = 2.11;
+    TypingDNA.version = 2.12;
     TypingDNA.flags = 0;
     TypingDNA.instance = this;
     TypingDNA.document = document;
@@ -631,6 +631,7 @@ function TypingDNA() {
      * * * @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
+     * * * @param {Boolean} caseSensitive (Optional, default: false, Only for type 1) Used if you pass a text for type 1
      * @return {String} A typing pattern in string form
      * @example var typingPattern = tdna.getTypingPattern({type=1, length=160, extended=true});
      * @example var typingPattern = tdna.getTypingPattern({type=1, text="Hello5g21?*", extedend=false});
@@ -644,9 +645,9 @@ function TypingDNA() {
             break;
           case 1:
             if (obj.text != undefined) {
-              return TypingDNA.history.getDiagram(obj.extended, obj.text, obj.textId, obj.targetId);
+              return TypingDNA.history.getDiagram(obj.extended, obj.text, obj.textId, obj.targetId, obj.caseSensitive);
             } else {
-              return TypingDNA.history.getDiagram(obj.extended, obj.length, obj.textId, obj.targetId);
+              return TypingDNA.history.getDiagram(obj.extended, obj.length, obj.textId, obj.targetId, obj.caseSensitive);
             }
             break;
           default:
@@ -659,11 +660,11 @@ function TypingDNA() {
     }
 
     TypingDNA.getDiagram = function(str, textId) {
-      return TypingDNA.history.getDiagram(false, str, textId);
+      return TypingDNA.history.getDiagram(false, str, textId, undefined, false);
     }
 
     TypingDNA.getExtendedDiagram = function(str, textId) {
-      return TypingDNA.history.getDiagram(true, str, textId);
+      return TypingDNA.history.getDiagram(true, str, textId, undefined, false);
     }
 
     TypingDNA.getMouseDiagram = function() {
@@ -878,7 +879,8 @@ function TypingDNA() {
       this.stackDiagram.push(arr);
     }
 
-    TypingDNA.history.getDiagram = function(extended, str, textId, targetId) {
+    TypingDNA.history.getDiagram = function(extended, str, textId, targetId, caseSensitive) {
+      var caseSensitive = (caseSensitive != undefined) ? caseSensitive : (str == undefined || str == "");
       var returnArr = [];
       var diagramType = (extended == true) ? 1 : 0;
       var stackDiagram = this.stackDiagram;
@@ -908,7 +910,6 @@ function TypingDNA() {
           }
         }
       }
-
       var missingCount = 0;
       var diagramHistoryLength = stackDiagram.length;
       var strLength = diagramHistoryLength;
@@ -917,7 +918,6 @@ function TypingDNA() {
       } else if (typeof str === 'number' && str < diagramHistoryLength) {
           strLength = str;
       }
-
       var returnTextId = 0;
       if (textId != undefined) {
         if (isNaN(parseInt(textId))) {
@@ -930,21 +930,28 @@ function TypingDNA() {
           returnTextId = TypingDNA.math.fnv1aHash(str);
         }
       }
-
       returnArr.push([TypingDNA.isMobile(), TypingDNA.version, TypingDNA.flags, diagramType, strLength, returnTextId, TypingDNA.history.getSpecialKeys()]);
       if (str != undefined && str.length > 0 && typeof str === 'string') {
+        var strLower = str.toLowerCase();
+        var strUpper = str.toUpperCase();
         var lastFoundPos = [];
         var lastPos = 0;
+        var strUpperCharCode;
+        var currentSensitiveCharCode;
         for (var i = 0; i < str.length; i++) {
           var currentCharCode = str.charCodeAt(i);
+          if (!caseSensitive) {
+            strUpperCharCode = strUpper.charCodeAt(i);
+            currentSensitiveCharCode = (strUpperCharCode != currentCharCode) ? strUpperCharCode : strLower.charCodeAt(i);
+          }
           var startPos = lastPos;
           var finishPos = diagramHistoryLength;
-          var found = false
-          while (found == false){
+          var found = false;
+          while (found == false) {
             for (var j = startPos; j < finishPos; j++) {
               var arr = stackDiagram[j];
               var charCode = arr[3];
-              if (charCode == currentCharCode) {
+              if (charCode == currentCharCode || (!caseSensitive && charCode == currentSensitiveCharCode)) {
                 found = true;
                 if (j == lastPos) {
                   lastPos++;