@hellotext/hellotext 2.3.5 → 2.3.7

package/src/hellotext.js

@@ -1,7 +1,7 @@
 import { Configuration, Event } from './core'
 
 import API, { Response } from './api'
-import { Business, FormCollection, Page, Query, Session, User, Webchat } from './models'
+import { Business, Fingerprint, FormCollection, Page, Query, Session, User, Webchat } from './models'
 
 import { NotInitializedError } from './errors'
 
@@ -17,11 +17,12 @@ class Hellotext {
    * @param { Configuration } config
    */
   static async initialize(business, config) {
+    this.business = new Business(business)
+
     Configuration.assign(config)
     Session.initialize()
 
     this.page = new Page()
-    this.business = new Business(business)
     this.forms = new FormCollection()
 
     this.query = new Query()
@@ -82,17 +83,21 @@ class Hellotext {
    * @property { String } [name] - the name of the user
    * @property { String } [source] - the platform specific identifier where this pixel is running on.
    *
-   * Identifies a user and attaches the hello_session to the user ID
+   * Identifies a user and attaches the hello_session to the user ID.
+   * Repeated calls are skipped only when the last successful identify payload
+   * for the current session remains unchanged.
    * @param { String } externalId - the user ID
    * @param { IdentificationOptions } options - the options for the identification
    * @returns {Promise<Response>}
    */
   static async identify(externalId, options = {}) {
-    if (User.id === externalId) {
+    const fingerprint = await Fingerprint.generate(this.session, externalId, options)
+
+    if (Fingerprint.matches(User.fingerprint, fingerprint)) {
       return new Response(true, {
-        json: async () => {
-          already_identified: true
-        },
+        json: async () => ({
+          already_identified: true,
+        }),
       })
     }
 
@@ -102,7 +107,11 @@ class Hellotext {
     })
 
     if (response.succeeded) {
-      User.remember(externalId, options.source)
+      User.remember(
+        externalId,
+        options.source,
+        fingerprint,
+      )
     }
 
     return response
@@ -154,7 +163,7 @@ class Hellotext {
   // private
 
   static get notInitialized() {
-    return this.business.id === undefined
+    return !this.business || this.business.id === undefined
   }
 
   static get headers() {

package/src/models/fingerprint.js

@@ -0,0 +1,98 @@
+function normalizeValue(value) {
+  // Collapse "missing" values so callers can add optional fields incrementally
+  // without changing the fingerprint when the effective payload is the same.
+  if (value === null || value === undefined) {
+    return undefined
+  }
+
+  if (typeof value === 'string') {
+    const trimmedValue = value.trim()
+
+    // Treat blank strings as absent values so "" and an omitted field compare equally.
+    return trimmedValue === '' ? undefined : trimmedValue
+  }
+
+  if (Array.isArray(value)) {
+    // Preserve array order because, unlike object keys, caller-provided sequence can be meaningful.
+    return value
+      .map(item => normalizeValue(item))
+      .filter(item => item !== undefined)
+  }
+
+  if (value instanceof Date) {
+    // Serialize dates into a stable primitive so equivalent timestamps fingerprint the same way.
+    return value.toISOString()
+  }
+
+  if (typeof value === 'object') {
+    // Canonicalize object shape by sorting keys recursively, so key placement never affects equality.
+    const normalizedObject = Object.keys(value)
+      .sort((leftKey, rightKey) => leftKey.localeCompare(rightKey))
+      .reduce((result, key) => {
+        const normalizedChild = normalizeValue(value[key])
+
+        if (normalizedChild !== undefined) {
+          result[key] = normalizedChild
+        }
+
+        return result
+      }, {})
+
+    return Object.keys(normalizedObject).length > 0 ? normalizedObject : undefined
+  }
+
+  if (typeof value === 'number' || typeof value === 'boolean') {
+    return value
+  }
+
+  return undefined
+}
+
+function serializePayload(session, userId, options = {}) {
+  const normalizedPayload = normalizeValue({
+    session,
+    user_id: userId,
+    ...options,
+  }) || {}
+
+  return JSON.stringify(normalizedPayload)
+}
+
+function fallbackHash(value) {
+  let hash = 5381
+
+  for (let index = 0; index < value.length; index += 1) {
+    hash = (hash * 33) ^ value.charCodeAt(index)
+  }
+
+  return `v1:${(hash >>> 0).toString(16)}`
+}
+
+async function sha256(value) {
+  if (!globalThis.crypto?.subtle || typeof TextEncoder === 'undefined') {
+    return fallbackHash(value)
+  }
+
+  const digest = await globalThis.crypto.subtle.digest(
+    'SHA-256',
+    new TextEncoder().encode(value),
+  )
+
+  const hex = Array.from(new Uint8Array(digest))
+    .map(byte => byte.toString(16).padStart(2, '0'))
+    .join('')
+
+  return `v1:${hex}`
+}
+
+class Fingerprint {
+  static matches(storedFingerprint, fingerprint) {
+    return !!storedFingerprint && storedFingerprint === fingerprint
+  }
+
+  static async generate(session, userId, options = {}) {
+    return await sha256(serializePayload(session, userId, options))
+  }
+}
+
+export { Fingerprint }

package/src/models/index.js

@@ -1,5 +1,6 @@
 export { Business } from './business'
 export { Cookies } from './cookies'
+export { Fingerprint } from './fingerprint'
 export { Form } from './form'
 export { FormCollection } from './form_collection'
 export { Page } from './page'

package/src/models/session.js

@@ -1,6 +1,7 @@
 import { Configuration } from '../core'
 import { Cookies } from './cookies'
 import { Query } from './query'
+import API from '../api'
 
 class Session {
   static #session
@@ -11,8 +12,21 @@ class Session {
   }
 
   static set session(value) {
+    const oldSession = Cookies.get('hello_session')
+
     this.#session = value
     Cookies.set('hello_session', value)
+
+    if (oldSession !== value) {
+      Cookies.delete('hello_session_ack_at')
+    }
+
+    if (!Cookies.get('hello_session_ack_at')) {
+      API.acks.send()
+      Cookies.set('hello_session_ack_at', new Date().toISOString())
+    }
+
+    return this.#session
   }
 
   static initialize() {

package/src/models/user.js

@@ -9,17 +9,26 @@ class User {
     return Cookies.get('hello_user_source')
   }
 
-  static remember(id, source) {
+  static get fingerprint() {
+    return Cookies.get('hello_user_identification_hash')
+  }
+
+  static remember(id, source, fingerprint) {
     if (source) {
       Cookies.set('hello_user_source', source)
     }
 
+    if (fingerprint) {
+      Cookies.set('hello_user_identification_hash', fingerprint)
+    }
+
     Cookies.set('hello_user_id', id)
   }
 
   static forget() {
     Cookies.delete('hello_user_id')
     Cookies.delete('hello_user_source')
+    Cookies.delete('hello_user_identification_hash')
   }
 
   static get identificationData() {