clarity-js 0.7.7 → 0.7.8

package/src/data/variable.ts

@@ -1,5 +1,6 @@
-import { Constant, Event, VariableData } from "@clarity-types/data";
+import { Constant, Event, IdentityData, Setting, VariableData } from "@clarity-types/data";
 import * as core from "@src/core";
+import { scrub } from "@src/core/scrub";
 import encode from "./encode";
 
 export let data: VariableData = null;
@@ -13,10 +14,28 @@ export function set(variable: string, value: string | string[]): void {
     log(variable, values);
 }
 
-export function identify(userId: string, sessionId: string = null, pageId: string = null): void {
-    log(Constant.UserId, [userId]);
-    log(Constant.SessionId, [sessionId]);
-    log(Constant.PageId, [pageId]);
+export async function identify(userId: string, sessionId: string = null, pageId: string = null, userHint: string = null): Promise<IdentityData> {
+    let output: IdentityData = { userId: await sha256(userId), userHint: userHint || redact(userId) };
+
+    // By default, hash custom userId using SHA256 algorithm on the client to preserve privacy
+    log(Constant.UserId, [output.userId]);
+    
+    // Optional non-identifying name for the user
+    // If name is not explicitly provided, we automatically generate a redacted version of the userId
+    log(Constant.UserHint, [output.userHint]);
+    log(Constant.UserType, [detect(userId)]);    
+
+    // Log sessionId and pageId if provided
+    if (sessionId) { 
+        log(Constant.SessionId, [sessionId]);
+        output.sessionId = sessionId;
+    }
+    if (pageId) {
+        log(Constant.PageId, [pageId]);
+        output.pageId = pageId;
+    }
+
+    return output;
 }
 
 function log(variable: string, value: string[]): void {
@@ -44,3 +63,22 @@ export function reset(): void {
 export function stop(): void {
     reset();
 }
+
+function redact(input: string): string {
+    return input && input.length >= Setting.WordLength ? 
+        `${input.substring(0,2)}${scrub(input.substring(2), Constant.Asterix, Constant.Asterix)}` : scrub(input, Constant.Asterix, Constant.Asterix);
+}
+
+async function sha256(input: string): Promise<string> {
+    try {
+        if (crypto && input) {
+            // Reference: https://developer.mozilla.org/en-US/docs/Web/API/SubtleCrypto/digest#converting_a_digest_to_a_hex_string
+            const buffer = await crypto.subtle.digest(Constant.SHA256, new TextEncoder().encode(input));
+            return Array.prototype.map.call(new Uint8Array(buffer), (x: any) =>(('00'+x.toString(16)).slice(-2))).join('');
+        } else { return Constant.Empty; }
+    } catch { return Constant.Empty; }
+}
+
+function detect(input: string): string {
+    return input && input.indexOf(Constant.At) > 0 ? Constant.Email : Constant.String;
+}

package/src/interaction/click.ts

@@ -92,10 +92,10 @@ function text(element: Node): string {
         // Grab text using "textContent" for most HTMLElements, however, use "value" for HTMLInputElements and "alt" for HTMLImageElement.
         let t = element.textContent || (element as HTMLInputElement).value || (element as HTMLImageElement).alt;
         if (t) {
-            // Trim any spaces at the beginning or at the end of string
-            // Also, replace multiple occurrence of space characters with a single white space
+            // Replace multiple occurrence of space characters with a single white space
+            // Also, trim any spaces at the beginning or at the end of string
             // Finally, send only first few characters as specified by the Setting
-            output = t.trim().replace(/\s+/g, Constant.Space).substr(0, Setting.ClickText);
+            output = t.replace(/\s+/g, Constant.Space).trim().substr(0, Setting.ClickText);
         }
     }
     return output;

package/src/performance/blank.ts

@@ -0,0 +1,7 @@
+export * from "@src/insight/blank";
+
+export let keys = [];
+
+/* Intentionally blank module with empty code */
+export function hashText(): void {}
+export function trigger(): void {}

package/types/core.d.ts

@@ -39,7 +39,7 @@ export const enum ExtractSource {
 }
 
 export const enum Type {
-    Array = 1, 
+    Array = 1,
     Object = 2,
     Simple = 3
 }
@@ -136,6 +136,7 @@ export interface Config {
     fallback?: string;
     upgrade?: (key: string) => void;
     action?: (key: string) => void;
+    dob?: number;
 }
 
 export const enum Constant {

package/types/data.d.ts

@@ -5,7 +5,7 @@ export type DecodedToken = (any | any[]);
 
 export type MetadataCallback = (data: Metadata, playback: boolean) => void;
 export interface MetadataCallbackOptions {
-    callback: MetadataCallback, 
+    callback: MetadataCallback,
     wait: boolean
 }
 
@@ -105,7 +105,8 @@ export const enum Metric {
     Iframed = 31,
     MaxTouchPoints = 32,
     HardwareConcurrency = 33,
-    DeviceMemory = 34
+    DeviceMemory = 34,
+    Electron = 35
 }
 
 export const enum Dimension {
@@ -136,7 +137,9 @@ export const enum Dimension {
     Brand = 24,
     Model = 25,
     DevicePixelRatio = 26,
-    ConnectionType = 27
+    ConnectionType = 27,
+    Dob = 28,
+    CookieVersion = 29
 }
 
 export const enum Check {
@@ -146,7 +149,8 @@ export const enum Check {
     Retry = 3,
     Bytes = 4,
     Collection = 5,
-    Server = 6
+    Server = 6,
+    Page = 7
 }
 
 export const enum Code {
@@ -190,7 +194,7 @@ export const enum IframeStatus {
 export const enum Setting {
     Expire = 365, // 1 Year
     SessionExpire = 1, // 1 Day
-    CookieVersion = 1, // Increment this version every time there's a cookie schema change
+    CookieVersion = 2, // Increment this version every time there's a cookie schema change
     SessionTimeout = 30 * Time.Minute, // 30 minutes
     CookieInterval = 1, // 1 Day
     PingInterval = 1 * Time.Minute, // 1 Minute
@@ -198,6 +202,7 @@ export const enum Setting {
     SummaryInterval = 100, // Same events within 100ms will be collapsed into single summary
     ClickText = 25, // Maximum number of characters to send as part of Click event's text field
     PayloadLimit = 128, // Do not allow more than specified payloads per page
+    PageLimit = 128, // Do not allow more than 128 pages in a session
     ShutdownLimit = 2 * Time.Hour, // Shutdown instrumentation after specified time
     RetryLimit = 1, // Maximum number of attempts to upload a payload before giving up
     PlaybackBytesLimit = 10 * 1024 * 1024, // 10MB
@@ -218,7 +223,7 @@ export const enum Setting {
     MinUploadDelay = 100, // Minimum time before we are ready to flush events to the server
     MaxUploadDelay = 30 * Time.Second, // Do flush out payload once every 30s,
     ExtractLimit = 10000, // Do not extract more than 10000 characters
-    ChecksumPrecision = 24, // n-bit integer to represent token hash 
+    ChecksumPrecision = 24, // n-bit integer to represent token hash
     UploadTimeout = 15000 // Timeout in ms for XHR requests
 }
 
@@ -249,6 +254,8 @@ export const enum Constant {
     Dropped = "*na*",
     Comma = ",",
     Dot = ".",
+    At = "@",
+    Asterix = "*",
     Semicolon = ";",
     Equals = "=",
     Path = ";path=/",
@@ -258,6 +265,7 @@ export const enum Constant {
     Top = "_top",
     String = "string",
     Number = "number",
+    Email = "email",
     CookieKey = "_clck", // Clarity Cookie Key
     SessionKey = "_clsk", // Clarity Session Key
     TabKey = "_cltk", // Clarity Tab Key
@@ -266,6 +274,8 @@ export const enum Constant {
     Upgrade = "UPGRADE",
     Action = "ACTION",
     Extract = "EXTRACT",
+    UserHint = "userHint",
+    UserType = "userType",
     UserId = "userId",
     SessionId = "sessionId",
     PageId = "pageId",
@@ -290,7 +300,9 @@ export const enum Constant {
     ConditionEnd = "}",
     Seperator = "<SEP>",
     Timeout = "Timeout",
-    Bang = "!"
+    Bang = "!",
+    SHA256 = "SHA-256",
+    Electron = "Electron"
 }
 
 export const enum XMLReadyState {
@@ -332,8 +344,10 @@ export interface Session {
 
 export interface User {
     id: string;
+    version: number;
     expiry: number;
     consent: BooleanFlag;
+    dob: number;
 }
 
 export interface Envelope extends Metadata {
@@ -372,6 +386,13 @@ export interface BaselineData {
     activityTime: number;
 }
 
+export interface IdentityData {
+    userId: string;
+    userHint: string;
+    sessionId?: string;
+    pageId?: string;
+}
+
 export interface DimensionData {
     [key: number]: string[];
 }

package/types/index.d.ts

@@ -14,7 +14,7 @@ interface Clarity {
   consent: () => void;
   event: (name: string, value: string) => void;
   set: (variable: string, value: string | string[]) => void;
-  identify: (userId: string, sessionId?: string, pageId?: string) => void;
+  identify: (userId: string, sessionId?: string, pageId?: string, userHint?: string) => void;
   metadata: (callback: Data.MetadataCallback, wait?: boolean) => void;
 }