@hellotext/hellotext 2.2.0 → 2.3.0

package/lib/models/user.cjs

@@ -0,0 +1,53 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.User = void 0;
+var _cookies = require("./cookies");
+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); }
+let User = /*#__PURE__*/function () {
+  function User() {
+    _classCallCheck(this, User);
+  }
+  _createClass(User, null, [{
+    key: "id",
+    get: function () {
+      return _cookies.Cookies.get('hello_user_id');
+    }
+  }, {
+    key: "source",
+    get: function () {
+      return _cookies.Cookies.get('hello_user_source');
+    }
+  }, {
+    key: "remember",
+    value: function remember(id, source) {
+      if (source) {
+        _cookies.Cookies.set('hello_user_source', source);
+      }
+      _cookies.Cookies.set('hello_user_id', id);
+    }
+  }, {
+    key: "forget",
+    value: function forget() {
+      _cookies.Cookies.delete('hello_user_id');
+      _cookies.Cookies.delete('hello_user_source');
+    }
+  }, {
+    key: "identificationData",
+    get: function () {
+      if (!this.id) return {};
+      return {
+        id: this.id,
+        source: this.source
+      };
+    }
+  }]);
+  return User;
+}();
+exports.User = User;

package/lib/models/user.js

@@ -0,0 +1,47 @@
+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); }
+import { Cookies } from './cookies';
+var User = /*#__PURE__*/function () {
+  function User() {
+    _classCallCheck(this, User);
+  }
+  _createClass(User, null, [{
+    key: "id",
+    get: function get() {
+      return Cookies.get('hello_user_id');
+    }
+  }, {
+    key: "source",
+    get: function get() {
+      return Cookies.get('hello_user_source');
+    }
+  }, {
+    key: "remember",
+    value: function remember(id, source) {
+      if (source) {
+        Cookies.set('hello_user_source', source);
+      }
+      Cookies.set('hello_user_id', id);
+    }
+  }, {
+    key: "forget",
+    value: function forget() {
+      Cookies.delete('hello_user_id');
+      Cookies.delete('hello_user_source');
+    }
+  }, {
+    key: "identificationData",
+    get: function get() {
+      if (!this.id) return {};
+      return {
+        id: this.id,
+        source: this.source
+      };
+    }
+  }]);
+  return User;
+}();
+export { User };

package/package.json

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

package/src/api/identifications.js

@@ -0,0 +1,25 @@
+import Hellotext from '../hellotext'
+
+import { Configuration } from '../core'
+import { Response } from './response'
+
+class IdentificationsAPI {
+  static get endpoint() {
+    return Configuration.endpoint('public/identifications')
+  }
+
+  static async create(data = {}) {
+    const response = await fetch(this.endpoint, {
+      method: 'POST',
+      headers: Hellotext.headers,
+      body: JSON.stringify({
+        session: Hellotext.session,
+        ...data,
+      }),
+    })
+
+    return new Response(response.ok, response)
+  }
+}
+
+export default IdentificationsAPI

package/src/api/index.js

@@ -1,6 +1,7 @@
 import BusinessesAPI from './businesses'
 import EventsAPI from './events'
 import FormsAPI from './forms'
+import IdentificationsAPI from './identifications'
 import WebchatsAPI from './webchats'
 
 export default class API {
@@ -19,6 +20,10 @@ export default class API {
   static get webchats() {
     return WebchatsAPI
   }
+
+  static get identifications() {
+    return IdentificationsAPI
+  }
 }
 
 export { Response } from './response'

package/src/hellotext.js

@@ -1,14 +1,11 @@
 import { Configuration, Event } from './core'
 
 import API, { Response } from './api'
-import { Business, FormCollection, Page, Query, Session, Webchat } from './models'
+import { Business, FormCollection, Page, Query, Session, User, Webchat } from './models'
 
 import { NotInitializedError } from './errors'
 
 class Hellotext {
-  static #session
-  static #query
-
   static eventEmitter = new Event()
   static forms
   static business
@@ -27,7 +24,7 @@ class Hellotext {
     this.business = new Business(business)
     this.forms = new FormCollection()
 
-    this.#query = new Query()
+    this.query = new Query()
 
     if (Configuration.webchat.id) {
       this.webchat = await Webchat.load(Configuration.webchat.id)
@@ -59,6 +56,7 @@ class Hellotext {
 
     const body = {
       session: this.session,
+      user: User.identificationData,
       action,
       ...params,
       ...pageInstance.trackingData,
@@ -72,6 +70,40 @@ class Hellotext {
     })
   }
 
+  /**
+   * @typedef { Object } IdentificationOptions
+   * @property { String } [email] - the email of the user
+   * @property { String } [phone] - the phone number of the user
+   * @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
+   * @param { String } externalId - the user ID
+   * @param { IdentificationOptions } options - the options for the identification
+   * @returns {Promise<Response>}
+   */
+  static async identify(externalId, options = {}) {
+    const response = await API.identifications.create({
+      user_id: externalId,
+      ...options,
+    })
+
+    if (response.succeeded) {
+      User.remember(externalId, options.source)
+    }
+
+    return response
+  }
+
+  /**
+   * Clears the user session, use when the user logs out to clear the hello cookies
+   *
+   * @returns {void}
+   */
+  static forget() {
+    User.forget()
+  }
+
   /**
    * Registers an event listener
    * @param event the name of the event to listen to

package/src/models/cookies.js

@@ -1,9 +1,18 @@
 import Hellotext from '../hellotext'
+import { Page } from './page'
 
 class Cookies {
   static set(name, value) {
     if (typeof document !== 'undefined') {
-      document.cookie = `${name}=${value}; path=/;`
+      const secure = window.location.protocol === 'https:' ? '; Secure' : ''
+      const domain = Page.getRootDomain()
+      const maxAge = 10 * 365 * 24 * 60 * 60 // 10 years in seconds
+
+      if (domain) {
+        document.cookie = `${name}=${value}; path=/${secure}; domain=${domain}; max-age=${maxAge}; SameSite=Lax`
+      } else {
+        document.cookie = `${name}=${value}; path=/${secure}; max-age=${maxAge}; SameSite=Lax`
+      }
     }
 
     if (name === 'hello_session') {
@@ -24,6 +33,19 @@ class Cookies {
       return undefined
     }
   }
+
+  static delete(name) {
+    if (typeof document !== 'undefined') {
+      const domain = Page.getRootDomain()
+      const secure = window.location.protocol === 'https:' ? '; Secure' : ''
+
+      if (domain) {
+        document.cookie = `${name}=; path=/; expires=Thu, 01 Jan 1970 00:00:00 GMT${secure}; domain=${domain}; SameSite=Lax`
+      } else {
+        document.cookie = `${name}=; path=/; expires=Thu, 01 Jan 1970 00:00:00 GMT${secure}; SameSite=Lax`
+      }
+    }
+  }
 }
 
 export { Cookies }

package/src/models/index.js

@@ -5,5 +5,6 @@ export { FormCollection } from './form_collection'
 export { Page } from './page'
 export { Query } from './query'
 export { Session } from './session'
+export { User } from './user'
 export { UTM } from './utm'
 export { Webchat } from './webchat'

package/src/models/page.js

@@ -11,7 +11,7 @@ class Page {
    * @returns {string} The page URL
    */
   get url() {
-    return this._url || window.location.href
+    return this._url !== null && this._url !== undefined ? this._url : window.location.href
   }
 
   /**
@@ -60,6 +60,88 @@ class Page {
       utm_params: this.utmParams,
     }
   }
+
+  /**
+   * Get the current page domain (root domain for cookie sharing)
+   * @returns {string} The root domain with leading dot, or null if no valid URL
+   */
+  get domain() {
+    try {
+      const url = this.url
+      if (!url) {
+        return null
+      }
+
+      const hostname = new URL(url).hostname
+      return Page.getRootDomain(hostname)
+    } catch (e) {
+      return null
+    }
+  }
+
+  /**
+   * Get the root domain from a hostname (static method, no instance needed)
+   * @param {string} hostname - The hostname to parse
+   * @returns {string} The root domain with leading dot, or null if invalid
+   */
+  static getRootDomain(hostname = null) {
+    try {
+      if (!hostname) {
+        if (typeof window === 'undefined' || !window.location?.hostname) {
+          return null
+        }
+        hostname = window.location.hostname
+      }
+
+      const parts = hostname.split('.')
+
+      // Handle localhost or single-part domains
+      if (parts.length <= 1) {
+        return hostname
+      }
+
+      // Handle e-commerce platform domains where store identifier must be preserved
+      // Examples:
+      //   storename.myshopify.com -> .storename.myshopify.com
+      //   storename.vtexcommercestable.com.br -> .storename.vtexcommercestable.com.br
+      //   storename.wixsite.com -> .storename.wixsite.com
+      const platformSuffixes = [
+        'myshopify.com',
+        'vtexcommercestable.com.br',
+        'myvtex.com',
+        'wixsite.com',
+      ]
+
+      for (const suffix of platformSuffixes) {
+        const suffixParts = suffix.split('.')
+        // Get the last N parts of the hostname (e.g., last 2 parts for 'myshopify.com')
+        const domainTail = parts.slice(-suffixParts.length).join('.')
+
+        // Check if the tail exactly matches the platform suffix
+        // and there are additional parts for the store identifier
+        if (domainTail === suffix && parts.length > suffixParts.length) {
+          // Include store identifier + platform suffix
+          // e.g., ['secure', 'mystore', 'myshopify', 'com'] -> '.mystore.myshopify.com'
+          return `.${parts.slice(-(suffixParts.length + 1)).join('.')}`
+        }
+      }
+
+      // Simple heuristic: if TLD is 2 chars and second-level is short (<=3 chars),
+      // it's likely a multi-part TLD like .com.br, .co.uk
+      const tld = parts[parts.length - 1]
+      const secondLevel = parts[parts.length - 2]
+
+      if (parts.length > 2 && tld.length === 2 && secondLevel.length <= 3) {
+        // Multi-part TLD: take last 3 parts (e.g., store.com.br)
+        return `.${parts.slice(-3).join('.')}`
+      }
+
+      // Regular TLD: take last 2 parts (e.g., example.com)
+      return `.${parts.slice(-2).join('.')}`
+    } catch (e) {
+      return null
+    }
+  }
 }
 
 export { Page }

package/src/models/user.js

@@ -0,0 +1,35 @@
+import { Cookies } from './cookies'
+
+class User {
+  static get id() {
+    return Cookies.get('hello_user_id')
+  }
+
+  static get source() {
+    return Cookies.get('hello_user_source')
+  }
+
+  static remember(id, source) {
+    if (source) {
+      Cookies.set('hello_user_source', source)
+    }
+
+    Cookies.set('hello_user_id', id)
+  }
+
+  static forget() {
+    Cookies.delete('hello_user_id')
+    Cookies.delete('hello_user_source')
+  }
+
+  static get identificationData() {
+    if (!this.id) return {}
+
+    return {
+      id: this.id,
+      source: this.source,
+    }
+  }
+}
+
+export { User }