@hellotext/hellotext 2.3.7 → 2.3.9

package/index.d.ts

@@ -5,24 +5,57 @@ export interface HellotextConfig {
     autoMount?: boolean
     successMessage?: boolean | string
   }
-  webchat?: {
-    id?: string
-    container?: string
-    placement?: 'top-left' | 'top-right' | 'bottom-left' | 'bottom-right'
-    classes?: string | string[]
-    triggerClasses?: string | string[]
-    behaviour?: 'modal' | 'popover'
-    style?: {
-      primaryColor?: string
-      secondaryColor?: string
-      typography?: string
-    }
-    strategy?: 'absolute' | 'fixed'
-  }
+  webchat?: false | HellotextWebchatConfig
   session?: string
   autoGenerateSession?: boolean
 }
 
+export interface HellotextWebchatConfig {
+  id?: string
+  container?: string
+  placement?: 'top-left' | 'top-right' | 'bottom-left' | 'bottom-right'
+  classes?: string | string[]
+  triggerClasses?: string | string[]
+  behaviour?: 'modal' | 'popover'
+  style?: {
+    primaryColor?: string
+    secondaryColor?: string
+    typography?: string
+  }
+  strategy?: 'absolute' | 'fixed'
+}
+
+export interface HellotextBusinessCountry {
+  code?: string
+  prefix?: string
+  [key: string]: any
+}
+
+export interface HellotextBusinessData {
+  id?: string
+  country?: HellotextBusinessCountry | string
+  features?: Record<string, any>
+  locale?: string
+  style_url?: string
+  webchat?: HellotextWebchatConfig | null
+  whitelist?: string | string[] | null
+  subscription?: string | null
+  [key: string]: any
+}
+
+export interface HellotextBusiness {
+  id: string
+  data: HellotextBusinessData | null
+  readonly subscription: string | null | undefined
+  readonly country: HellotextBusinessCountry | string | undefined
+  readonly enabledWhitelist: boolean
+  readonly locale: any
+  readonly features: Record<string, any> | null | undefined
+  hydrate(): Promise<HellotextBusinessData | null>
+  setData(data: HellotextBusinessData): void
+  setLocale(locale: string): void
+}
+
 export interface TrackingParams {
   amount?: number
   currency?: string
@@ -63,7 +96,7 @@ declare class Hellotext {
   static get session(): string
   static get isInitialized(): boolean
   static forms: any
-  static business: any
+  static business: HellotextBusiness
   static webchat: any
 }
 

package/lib/controllers/message_controller.cjs

@@ -5,6 +5,8 @@ Object.defineProperty(exports, "__esModule", {
 });
 exports.default = void 0;
 var _stimulus = require("@hotwired/stimulus");
+var _hellotext = _interopRequireDefault(require("../hellotext"));
+function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
 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; }
@@ -58,6 +60,23 @@ let _default = /*#__PURE__*/function (_Controller) {
         }
       });
     }
+  }, {
+    key: "addToCart",
+    value: function addToCart({
+      currentTarget
+    }) {
+      const card = currentTarget.closest('[data-hellotext--message-target="carouselCard"]');
+      const payload = {
+        object_parameters: {
+          items: [{
+            product: card.dataset.id,
+            quantity: 1
+          }]
+        }
+      };
+      _hellotext.default.track('cart.added', payload);
+      _hellotext.default.eventEmitter.dispatch('cart.added', payload);
+    }
   }, {
     key: "moveToLeft",
     value: function moveToLeft() {

package/lib/controllers/message_controller.js

@@ -11,6 +11,7 @@ function _assertThisInitialized(self) { if (self === void 0) { throw new Referen
 function _isNativeReflectConstruct() { if (typeof Reflect === "undefined" || !Reflect.construct) return false; if (Reflect.construct.sham) return false; if (typeof Proxy === "function") return true; try { Boolean.prototype.valueOf.call(Reflect.construct(Boolean, [], function () {})); return true; } catch (e) { return false; } }
 function _getPrototypeOf(o) { _getPrototypeOf = Object.setPrototypeOf ? Object.getPrototypeOf.bind() : function _getPrototypeOf(o) { return o.__proto__ || Object.getPrototypeOf(o); }; return _getPrototypeOf(o); }
 import { Controller } from '@hotwired/stimulus';
+import Hellotext from '../hellotext';
 var _default = /*#__PURE__*/function (_Controller) {
   _inherits(_default, _Controller);
   var _super = _createSuper(_default);
@@ -54,6 +55,24 @@ var _default = /*#__PURE__*/function (_Controller) {
         }
       });
     }
+  }, {
+    key: "addToCart",
+    value: function addToCart(_ref3) {
+      var {
+        currentTarget
+      } = _ref3;
+      var card = currentTarget.closest('[data-hellotext--message-target="carouselCard"]');
+      var payload = {
+        object_parameters: {
+          items: [{
+            product: card.dataset.id,
+            quantity: 1
+          }]
+        }
+      };
+      Hellotext.track('cart.added', payload);
+      Hellotext.eventEmitter.dispatch('cart.added', payload);
+    }
   }, {
     key: "moveToLeft",
     value: function moveToLeft() {

package/lib/core/event.cjs

@@ -68,4 +68,4 @@ let Event = /*#__PURE__*/function () {
   return Event;
 }();
 exports.default = Event;
-Event.events = ['session-set', 'utm-set', 'forms:collected', 'form:completed', 'webchat:mounted', 'webchat:opened', 'webchat:closed', 'webchat:message:sent', 'webchat:message:received'];
+Event.events = ['session-set', 'utm-set', 'forms:collected', 'form:completed', 'webchat:mounted', 'webchat:opened', 'webchat:closed', 'webchat:message:sent', 'webchat:message:received', 'cart.added'];

package/lib/core/event.js

@@ -63,5 +63,5 @@ var Event = /*#__PURE__*/function () {
   }]);
   return Event;
 }();
-Event.events = ['session-set', 'utm-set', 'forms:collected', 'form:completed', 'webchat:mounted', 'webchat:opened', 'webchat:closed', 'webchat:message:sent', 'webchat:message:received'];
+Event.events = ['session-set', 'utm-set', 'forms:collected', 'form:completed', 'webchat:mounted', 'webchat:opened', 'webchat:closed', 'webchat:message:sent', 'webchat:message:received', 'cart.added'];
 export { Event as default };

package/lib/hellotext.cjs

@@ -27,15 +27,21 @@ let Hellotext = /*#__PURE__*/function () {
      * @param business public business id
      * @param { Configuration } config
      */
-    async function initialize(business, config) {
+    async function initialize(business, config = {}) {
       this.business = new _models.Business(business);
       _core.Configuration.assign(config);
       _models.Session.initialize();
       this.page = new _models.Page();
       this.forms = new _models.FormCollection();
       this.query = new _models.Query();
-      if (_core.Configuration.webchat.id) {
-        this.webchat = await _models.Webchat.load(_core.Configuration.webchat.id);
+      const businessData = await this.business.hydrate();
+      const webchatConfig = config.webchat === false ? false : {
+        ...(businessData && businessData.webchat || {}),
+        ...(config.webchat || {})
+      };
+      if (webchatConfig && webchatConfig.id) {
+        _core.Configuration.webchat.assign(webchatConfig);
+        this.webchat = await _models.Webchat.load(webchatConfig.id);
       }
       if (typeof MutationObserver !== 'undefined') {
         this.forms.collectExistingFormsOnPage();

package/lib/hellotext.js

@@ -25,21 +25,25 @@ var Hellotext = /*#__PURE__*/function () {
      * @param { Configuration } config
      */
     function () {
-      var _initialize = _asyncToGenerator(function* (business, config) {
+      var _initialize = _asyncToGenerator(function* (business) {
+        var config = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : {};
         this.business = new Business(business);
         Configuration.assign(config);
         Session.initialize();
         this.page = new Page();
         this.forms = new FormCollection();
         this.query = new Query();
-        if (Configuration.webchat.id) {
-          this.webchat = yield Webchat.load(Configuration.webchat.id);
+        var businessData = yield this.business.hydrate();
+        var webchatConfig = config.webchat === false ? false : _objectSpread(_objectSpread({}, businessData && businessData.webchat || {}), config.webchat || {});
+        if (webchatConfig && webchatConfig.id) {
+          Configuration.webchat.assign(webchatConfig);
+          this.webchat = yield Webchat.load(webchatConfig.id);
         }
         if (typeof MutationObserver !== 'undefined') {
           this.forms.collectExistingFormsOnPage();
         }
       });
-      function initialize(_x, _x2) {
+      function initialize(_x) {
         return _initialize.apply(this, arguments);
       }
       return initialize;
@@ -73,7 +77,7 @@ var Hellotext = /*#__PURE__*/function () {
           body
         });
       });
-      function track(_x3) {
+      function track(_x2) {
         return _track.apply(this, arguments);
       }
       return track;
@@ -121,7 +125,7 @@ var Hellotext = /*#__PURE__*/function () {
         }
         return response;
       });
-      function identify(_x4) {
+      function identify(_x3) {
         return _identify.apply(this, arguments);
       }
       return identify;

package/lib/models/business.cjs

@@ -5,19 +5,83 @@ Object.defineProperty(exports, "__esModule", {
 });
 exports.Business = void 0;
 var _locales = _interopRequireDefault(require("../locales"));
+var _businesses = _interopRequireDefault(require("../api/businesses"));
 function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
 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); }
+/**
+ * @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.
+ */
+/**
+ * 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.
+ */
 let Business = /*#__PURE__*/function () {
+  /**
+   * @param {String} id - Public business id.
+   */
   function Business(id) {
     _classCallCheck(this, Business);
     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>}
+   */
   _createClass(Business, [{
+    key: "hydrate",
+    value: async function hydrate() {
+      try {
+        const response = await _businesses.default.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}
+     */
+  }, {
     key: "setData",
     value: function setData(data) {
       this.data = data;
@@ -43,6 +107,11 @@ let Business = /*#__PURE__*/function () {
     get: function () {
       return this.data.whitelist !== 'disabled';
     }
+
+    /**
+     * @param {String} locale
+     * @returns {void}
+     */
   }, {
     key: "setLocale",
     value: function setLocale(locale) {

package/lib/models/business.js

@@ -1,16 +1,91 @@
+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 _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 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.
+ */
+
+/**
+ * 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.
+ */
 var Business = /*#__PURE__*/function () {
+  /**
+   * @param {String} id - Public business id.
+   */
   function Business(id) {
     _classCallCheck(this, Business);
     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>}
+   */
   _createClass(Business, [{
+    key: "hydrate",
+    value: function () {
+      var _hydrate = _asyncToGenerator(function* () {
+        try {
+          var response = yield BusinessesAPI.get(this.id);
+          if (response.ok === false) {
+            return null;
+          }
+          var business = yield response.json();
+          if (!business) {
+            return null;
+          }
+          this.setData(business);
+          if (business.locale) {
+            this.setLocale(business.locale);
+          }
+          return business;
+        } catch (_error) {
+          return null;
+        }
+      });
+      function hydrate() {
+        return _hydrate.apply(this, arguments);
+      }
+      return hydrate;
+    }()
+    /**
+     * @param {BusinessData} data
+     * @returns {void}
+     */
+  }, {
     key: "setData",
     value: function setData(data) {
       this.data = data;
@@ -36,6 +111,11 @@ var Business = /*#__PURE__*/function () {
     get: function get() {
       return this.data.whitelist !== 'disabled';
     }
+
+    /**
+     * @param {String} locale
+     * @returns {void}
+     */
   }, {
     key: "setLocale",
     value: function setLocale(locale) {

package/package.json

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

package/src/controllers/message_controller.js

@@ -1,5 +1,7 @@
 import { Controller } from '@hotwired/stimulus'
 
+import Hellotext from '../hellotext'
+
 export default class extends Controller {
   static values = {
     id: String,
@@ -34,6 +36,24 @@ export default class extends Controller {
     })
   }
 
+  addToCart({ currentTarget }) {
+    const card = currentTarget.closest('[data-hellotext--message-target="carouselCard"]')
+
+    const payload = {
+      object_parameters: {
+        items: [
+          {
+            product: card.dataset.id,
+            quantity: 1,
+          },
+        ],
+      },
+    }
+
+    Hellotext.track('cart.added', payload)
+    Hellotext.eventEmitter.dispatch('cart.added', payload)
+  }
+
   moveToLeft() {
     if (!this.hasCarouselContainerTarget) return
 

package/src/core/event.js

@@ -11,6 +11,7 @@ export default class Event {
     'webchat:closed',
     'webchat:message:sent',
     'webchat:message:received',
+    'cart.added',
   ]
 
   static valid(name) {

package/src/hellotext.js

@@ -16,7 +16,7 @@ class Hellotext {
    * @param business public business id
    * @param { Configuration } config
    */
-  static async initialize(business, config) {
+  static async initialize(business, config = {}) {
     this.business = new Business(business)
 
     Configuration.assign(config)
@@ -27,8 +27,15 @@ class Hellotext {
 
     this.query = new Query()
 
-    if (Configuration.webchat.id) {
-      this.webchat = await Webchat.load(Configuration.webchat.id)
+    const businessData = await this.business.hydrate()
+    const webchatConfig = config.webchat === false ? false : {
+      ...((businessData && businessData.webchat) || {}),
+      ...(config.webchat || {}),
+    }
+
+    if (webchatConfig && webchatConfig.id) {
+      Configuration.webchat.assign(webchatConfig)
+      this.webchat = await Webchat.load(webchatConfig.id)
     }
 
     if (typeof MutationObserver !== 'undefined') {

package/src/models/business.js

@@ -1,11 +1,81 @@
 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.
+ */
+
+/**
+ * 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 +100,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`)