@hellotext/hellotext 2.3.8 → 2.4.0

package/src/models/business.js

@@ -1,11 +1,83 @@
 import locales from '../locales'
+import BusinessesAPI from '../api/businesses'
 
+/**
+ * @typedef {Object} BusinessCountry
+ * @property {String} [code] - ISO country code configured for the business.
+ * @property {String} [prefix] - Phone country prefix configured for the business.
+ */
+
+/**
+ * @typedef {Object} BusinessWebchat
+ * @property {String} [id] - Dashboard webchat id configured for the business.
+ * @property {Object} [appearance] - Dashboard appearance defaults for the webchat.
+ * @property {Object} [whatsapp] - Dashboard WhatsApp handoff defaults for the webchat.
+ */
+
+/**
+ * Public business metadata returned by `public/businesses/:id`.
+ *
+ * @typedef {Object} BusinessData
+ * @property {String} [id] - Public business id.
+ * @property {BusinessCountry|String} [country] - Business country metadata.
+ * @property {Object} [features] - Feature flags enabled for the business.
+ * @property {String} [locale] - Default dashboard locale for the business.
+ * @property {String} [style_url] - Stylesheet URL to inject for dashboard-managed surfaces.
+ * @property {BusinessWebchat|null} [webchat] - Dashboard webchat defaults.
+ * @property {String|Array<String>} [whitelist] - Domain whitelist configuration.
+ * @property {String} [subscription] - Current business subscription tier.
+ */
+
+/**
+ * Public business context used by the SDK for tracking, forms, and webchat defaults.
+ */
 class Business {
+  /**
+   * @param {String} id - Public business id.
+   */
   constructor(id) {
     this.id = id
     this.data = null
   }
 
+  /**
+   * Hydrates business metadata from the public business endpoint.
+   *
+   * Fetch failures return `null` so tracking initialization can continue even
+   * when dashboard-driven webchat defaults are unavailable.
+   *
+   * @returns {Promise<BusinessData|null>}
+   */
+  async hydrate() {
+    try {
+      const response = await BusinessesAPI.get(this.id)
+
+      if (response.ok === false) {
+        return null
+      }
+
+      const business = await response.json()
+
+      if (!business) {
+        return null
+      }
+
+      this.setData(business)
+
+      if (business.locale) {
+        this.setLocale(business.locale)
+      }
+
+      return business
+    } catch (_error) {
+      return null
+    }
+  }
+
+  /**
+   * @param {BusinessData} data
+   * @returns {void}
+   */
   setData(data) {
     this.data = data
 
@@ -30,6 +102,10 @@ class Business {
     return this.data.whitelist !== 'disabled'
   }
 
+  /**
+   * @param {String} locale
+   * @returns {void}
+   */
   setLocale(locale) {
     if (!locales[locale]) {
       return console.warn(`Locale ${locale} not found`)

package/src/models/webchat.js

@@ -16,9 +16,37 @@ class Webchat {
   }
 
   render() {
+    this.applyBehaviourOverride()
     this.containerToAppendTo.appendChild(this.data.html)
   }
 
+  applyBehaviourOverride() {
+    if (!Configuration.webchat.hasBehaviourOverride || !Configuration.webchat.behaviour) return
+
+    this.data.html.setAttribute(
+      'data-hellotext--webchat-behaviour-value',
+      JSON.stringify(this.serializedBehaviour),
+    )
+  }
+
+  get serializedBehaviour() {
+    const behaviour = Configuration.webchat.behaviour
+
+    return {
+      trigger: this.serializeTrigger(behaviour.trigger),
+      delay_seconds: behaviour.delaySeconds,
+      first_visit_only: behaviour.firstVisitOnly,
+      once_per_session: behaviour.oncePerSession,
+    }
+  }
+
+  serializeTrigger(trigger) {
+    if (trigger === 'onLoad') return 'on_load'
+    if (trigger === 'onClick') return 'on_click'
+
+    return trigger
+  }
+
   get containerToAppendTo() {
     return document.querySelector(Configuration.webchat.container)
   }