@hellotext/hellotext 2.2.1 → 2.3.1

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,48 @@ 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 = {}) {
+    if (User.id === externalId) {
+      return new Response(true, {
+        json: async () => {
+          already_identified: true
+        },
+      })
+    }
+
+    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

@@ -33,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/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 }