@hellotext/hellotext 2.3.6 → 2.3.7

package/index.d.ts

@@ -70,7 +70,8 @@ declare class Hellotext {
 export declare class User {
   static get id(): string | undefined
   static get source(): string | undefined
-  static remember(id: string, source?: string): void
+  static get fingerprint(): string | undefined
+  static remember(id: string, source?: string, fingerprint?: string): void
   static forget(): void
   static get identificationData(): IdentificationData | Record<string, never>
 }

package/lib/hellotext.cjs

@@ -85,7 +85,9 @@ let Hellotext = /*#__PURE__*/function () {
      * @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>}
@@ -93,11 +95,12 @@ let Hellotext = /*#__PURE__*/function () {
   }, {
     key: "identify",
     value: async function identify(externalId, options = {}) {
-      if (_models.User.id === externalId) {
+      const fingerprint = await _models.Fingerprint.generate(this.session, externalId, options);
+      if (_models.Fingerprint.matches(_models.User.fingerprint, fingerprint)) {
         return new _api.Response(true, {
-          json: async () => {
-            already_identified: true;
-          }
+          json: async () => ({
+            already_identified: true
+          })
         });
       }
       const response = await _api.default.identifications.create({
@@ -105,7 +108,7 @@ let Hellotext = /*#__PURE__*/function () {
         ...options
       });
       if (response.succeeded) {
-        _models.User.remember(externalId, options.source);
+        _models.User.remember(externalId, options.source, fingerprint);
       }
       return response;
     }

package/lib/hellotext.js

@@ -10,7 +10,7 @@ function _toPropertyKey(arg) { var key = _toPrimitive(arg, "string"); return typ
 function _toPrimitive(input, hint) { if (typeof input !== "object" || input === null) return input; var prim = input[Symbol.toPrimitive]; if (prim !== undefined) { var res = prim.call(input, hint || "default"); if (typeof res !== "object") return res; throw new TypeError("@@toPrimitive must return a primitive value."); } return (hint === "string" ? String : Number)(input); }
 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';
 var Hellotext = /*#__PURE__*/function () {
   function Hellotext() {
@@ -85,7 +85,9 @@ var Hellotext = /*#__PURE__*/function () {
      * @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>}
@@ -95,11 +97,14 @@ var Hellotext = /*#__PURE__*/function () {
     value: function () {
       var _identify = _asyncToGenerator(function* (externalId) {
         var options = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : {};
-        if (User.id === externalId) {
+        var fingerprint = yield Fingerprint.generate(this.session, externalId, options);
+        if (Fingerprint.matches(User.fingerprint, fingerprint)) {
           return new Response(true, {
             json: function () {
               var _json = _asyncToGenerator(function* () {
-                already_identified: true;
+                return {
+                  already_identified: true
+                };
               });
               function json() {
                 return _json.apply(this, arguments);
@@ -112,7 +117,7 @@ var Hellotext = /*#__PURE__*/function () {
           user_id: externalId
         }, options));
         if (response.succeeded) {
-          User.remember(externalId, options.source);
+          User.remember(externalId, options.source, fingerprint);
         }
         return response;
       });

package/lib/models/fingerprint.cjs

@@ -0,0 +1,89 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.Fingerprint = void 0;
+function _classCallCheck(instance, Constructor) { if (!(instance instanceof Constructor)) { throw new TypeError("Cannot call a class as a function"); } }
+function _defineProperties(target, props) { for (var i = 0; i < props.length; i++) { var descriptor = props[i]; descriptor.enumerable = descriptor.enumerable || false; descriptor.configurable = true; if ("value" in descriptor) descriptor.writable = true; Object.defineProperty(target, _toPropertyKey(descriptor.key), descriptor); } }
+function _createClass(Constructor, protoProps, staticProps) { if (protoProps) _defineProperties(Constructor.prototype, protoProps); if (staticProps) _defineProperties(Constructor, staticProps); Object.defineProperty(Constructor, "prototype", { writable: false }); return Constructor; }
+function _toPropertyKey(arg) { var key = _toPrimitive(arg, "string"); return typeof key === "symbol" ? key : String(key); }
+function _toPrimitive(input, hint) { if (typeof input !== "object" || input === null) return input; var prim = input[Symbol.toPrimitive]; if (prim !== undefined) { var res = prim.call(input, hint || "default"); if (typeof res !== "object") return res; throw new TypeError("@@toPrimitive must return a primitive value."); } return (hint === "string" ? String : Number)(input); }
+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) {
+  var _globalThis$crypto;
+  if (!((_globalThis$crypto = globalThis.crypto) !== null && _globalThis$crypto !== void 0 && _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}`;
+}
+let Fingerprint = /*#__PURE__*/function () {
+  function Fingerprint() {
+    _classCallCheck(this, Fingerprint);
+  }
+  _createClass(Fingerprint, null, [{
+    key: "matches",
+    value: function matches(storedFingerprint, fingerprint) {
+      return !!storedFingerprint && storedFingerprint === fingerprint;
+    }
+  }, {
+    key: "generate",
+    value: async function generate(session, userId, options = {}) {
+      return await sha256(serializePayload(session, userId, options));
+    }
+  }]);
+  return Fingerprint;
+}();
+exports.Fingerprint = Fingerprint;

package/lib/models/fingerprint.js

@@ -0,0 +1,101 @@
+function _classCallCheck(instance, Constructor) { if (!(instance instanceof Constructor)) { throw new TypeError("Cannot call a class as a function"); } }
+function _defineProperties(target, props) { for (var i = 0; i < props.length; i++) { var descriptor = props[i]; descriptor.enumerable = descriptor.enumerable || false; descriptor.configurable = true; if ("value" in descriptor) descriptor.writable = true; Object.defineProperty(target, _toPropertyKey(descriptor.key), descriptor); } }
+function _createClass(Constructor, protoProps, staticProps) { if (protoProps) _defineProperties(Constructor.prototype, protoProps); if (staticProps) _defineProperties(Constructor, staticProps); Object.defineProperty(Constructor, "prototype", { writable: false }); return Constructor; }
+function asyncGeneratorStep(gen, resolve, reject, _next, _throw, key, arg) { try { var info = gen[key](arg); var value = info.value; } catch (error) { reject(error); return; } if (info.done) { resolve(value); } else { Promise.resolve(value).then(_next, _throw); } }
+function _asyncToGenerator(fn) { return function () { var self = this, args = arguments; return new Promise(function (resolve, reject) { var gen = fn.apply(self, args); function _next(value) { asyncGeneratorStep(gen, resolve, reject, _next, _throw, "next", value); } function _throw(err) { asyncGeneratorStep(gen, resolve, reject, _next, _throw, "throw", err); } _next(undefined); }); }; }
+function ownKeys(object, enumerableOnly) { var keys = Object.keys(object); if (Object.getOwnPropertySymbols) { var symbols = Object.getOwnPropertySymbols(object); enumerableOnly && (symbols = symbols.filter(function (sym) { return Object.getOwnPropertyDescriptor(object, sym).enumerable; })), keys.push.apply(keys, symbols); } return keys; }
+function _objectSpread(target) { for (var i = 1; i < arguments.length; i++) { var source = null != arguments[i] ? arguments[i] : {}; i % 2 ? ownKeys(Object(source), !0).forEach(function (key) { _defineProperty(target, key, source[key]); }) : Object.getOwnPropertyDescriptors ? Object.defineProperties(target, Object.getOwnPropertyDescriptors(source)) : ownKeys(Object(source)).forEach(function (key) { Object.defineProperty(target, key, Object.getOwnPropertyDescriptor(source, key)); }); } return target; }
+function _defineProperty(obj, key, value) { key = _toPropertyKey(key); if (key in obj) { Object.defineProperty(obj, key, { value: value, enumerable: true, configurable: true, writable: true }); } else { obj[key] = value; } return obj; }
+function _toPropertyKey(arg) { var key = _toPrimitive(arg, "string"); return typeof key === "symbol" ? key : String(key); }
+function _toPrimitive(input, hint) { if (typeof input !== "object" || input === null) return input; var prim = input[Symbol.toPrimitive]; if (prim !== undefined) { var res = prim.call(input, hint || "default"); if (typeof res !== "object") return res; throw new TypeError("@@toPrimitive must return a primitive value."); } return (hint === "string" ? String : Number)(input); }
+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') {
+    var 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.
+    var normalizedObject = Object.keys(value).sort((leftKey, rightKey) => leftKey.localeCompare(rightKey)).reduce((result, key) => {
+      var 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) {
+  var options = arguments.length > 2 && arguments[2] !== undefined ? arguments[2] : {};
+  var normalizedPayload = normalizeValue(_objectSpread({
+    session,
+    user_id: userId
+  }, options)) || {};
+  return JSON.stringify(normalizedPayload);
+}
+function fallbackHash(value) {
+  var hash = 5381;
+  for (var index = 0; index < value.length; index += 1) {
+    hash = hash * 33 ^ value.charCodeAt(index);
+  }
+  return "v1:".concat((hash >>> 0).toString(16));
+}
+function sha256(_x) {
+  return _sha.apply(this, arguments);
+}
+function _sha() {
+  _sha = _asyncToGenerator(function* (value) {
+    var _globalThis$crypto;
+    if (!((_globalThis$crypto = globalThis.crypto) !== null && _globalThis$crypto !== void 0 && _globalThis$crypto.subtle) || typeof TextEncoder === 'undefined') {
+      return fallbackHash(value);
+    }
+    var digest = yield globalThis.crypto.subtle.digest('SHA-256', new TextEncoder().encode(value));
+    var hex = Array.from(new Uint8Array(digest)).map(byte => byte.toString(16).padStart(2, '0')).join('');
+    return "v1:".concat(hex);
+  });
+  return _sha.apply(this, arguments);
+}
+var Fingerprint = /*#__PURE__*/function () {
+  function Fingerprint() {
+    _classCallCheck(this, Fingerprint);
+  }
+  _createClass(Fingerprint, null, [{
+    key: "matches",
+    value: function matches(storedFingerprint, fingerprint) {
+      return !!storedFingerprint && storedFingerprint === fingerprint;
+    }
+  }, {
+    key: "generate",
+    value: function () {
+      var _generate = _asyncToGenerator(function* (session, userId) {
+        var options = arguments.length > 2 && arguments[2] !== undefined ? arguments[2] : {};
+        return yield sha256(serializePayload(session, userId, options));
+      });
+      function generate(_x2, _x3) {
+        return _generate.apply(this, arguments);
+      }
+      return generate;
+    }()
+  }]);
+  return Fingerprint;
+}();
+export { Fingerprint };

package/lib/models/index.cjs

@@ -15,6 +15,12 @@ Object.defineProperty(exports, "Cookies", {
     return _cookies.Cookies;
   }
 });
+Object.defineProperty(exports, "Fingerprint", {
+  enumerable: true,
+  get: function () {
+    return _fingerprint.Fingerprint;
+  }
+});
 Object.defineProperty(exports, "Form", {
   enumerable: true,
   get: function () {
@@ -65,6 +71,7 @@ Object.defineProperty(exports, "Webchat", {
 });
 var _business = require("./business");
 var _cookies = require("./cookies");
+var _fingerprint = require("./fingerprint");
 var _form = require("./form");
 var _form_collection = require("./form_collection");
 var _page = require("./page");

package/lib/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/lib/models/user.cjs

@@ -24,12 +24,20 @@ let User = /*#__PURE__*/function () {
     get: function () {
       return _cookies.Cookies.get('hello_user_source');
     }
+  }, {
+    key: "fingerprint",
+    get: function () {
+      return _cookies.Cookies.get('hello_user_identification_hash');
+    }
   }, {
     key: "remember",
-    value: function remember(id, source) {
+    value: function remember(id, source, fingerprint) {
       if (source) {
         _cookies.Cookies.set('hello_user_source', source);
       }
+      if (fingerprint) {
+        _cookies.Cookies.set('hello_user_identification_hash', fingerprint);
+      }
       _cookies.Cookies.set('hello_user_id', id);
     }
   }, {
@@ -37,6 +45,7 @@ let User = /*#__PURE__*/function () {
     value: function forget() {
       _cookies.Cookies.delete('hello_user_id');
       _cookies.Cookies.delete('hello_user_source');
+      _cookies.Cookies.delete('hello_user_identification_hash');
     }
   }, {
     key: "identificationData",

package/lib/models/user.js

@@ -18,12 +18,20 @@ var User = /*#__PURE__*/function () {
     get: function get() {
       return Cookies.get('hello_user_source');
     }
+  }, {
+    key: "fingerprint",
+    get: function get() {
+      return Cookies.get('hello_user_identification_hash');
+    }
   }, {
     key: "remember",
-    value: function remember(id, source) {
+    value: function 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);
     }
   }, {
@@ -31,6 +39,7 @@ var User = /*#__PURE__*/function () {
     value: function forget() {
       Cookies.delete('hello_user_id');
       Cookies.delete('hello_user_source');
+      Cookies.delete('hello_user_identification_hash');
     }
   }, {
     key: "identificationData",

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@hellotext/hellotext",
-  "version": "2.3.6",
+  "version": "2.3.7",
   "description": "Hellotext JavaScript Client",
   "source": "src/index.js",
   "main": "lib/index.cjs",

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'
 
@@ -83,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,
+        }),
       })
     }
 
@@ -103,7 +107,11 @@ class Hellotext {
     })
 
     if (response.succeeded) {
-      User.remember(externalId, options.source)
+      User.remember(
+        externalId,
+        options.source,
+        fingerprint,
+      )
     }
 
     return response

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/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() {