@hellotext/hellotext 2.4.51 → 2.4.53

package/lib/api/acks.cjs

@@ -23,8 +23,9 @@ let AcksAPI = /*#__PURE__*/function () {
     }
   }, {
     key: "send",
-    value: async function send() {
+    value: async function send(params = {}) {
       const payload = {
+        ...params,
         session: _hellotext.default.session,
         at: new Date().toISOString()
       };

package/lib/api/acks.js

@@ -1,3 +1,6 @@
+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 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"); } }
@@ -20,10 +23,11 @@ var AcksAPI = /*#__PURE__*/function () {
     key: "send",
     value: function () {
       var _send = _asyncToGenerator(function* () {
-        var payload = {
+        var params = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : {};
+        var payload = _objectSpread(_objectSpread({}, params), {}, {
           session: Hellotext.session,
           at: new Date().toISOString()
-        };
+        });
         fetch(this.endpoint, {
           method: 'POST',
           headers: Hellotext.headers,

package/lib/api/events.cjs

@@ -25,18 +25,28 @@ let EventsAPI = /*#__PURE__*/function () {
     key: "create",
     value: async function create({
       headers,
-      body
+      body,
+      keepalive = false
     }) {
       if (_models.Query.inPreviewMode) {
         return new _response.Response(true, {
           received: true
         });
       }
-      const response = await fetch(this.endpoint, {
+      const fetchOptions = {
         method: 'POST',
         headers,
         body: JSON.stringify(body)
-      });
+      };
+
+      // Do not send `keepalive: false`. The track caller opts in only for payloads
+      // that fit the browser keepalive budget; omitting the key for larger events
+      // preserves normal fetch behavior for rich carts/orders instead of asking
+      // the browser to use an unload-safe transport it may reject.
+      if (keepalive) {
+        fetchOptions.keepalive = true;
+      }
+      const response = await fetch(this.endpoint, fetchOptions);
       return new _response.Response(response.status === 200, await response.json());
     }
   }]);

package/lib/api/events.js

@@ -23,18 +23,28 @@ var EventsAPI = /*#__PURE__*/function () {
       var _create = _asyncToGenerator(function* (_ref) {
         var {
           headers,
-          body
+          body,
+          keepalive = false
         } = _ref;
         if (Query.inPreviewMode) {
           return new Response(true, {
             received: true
           });
         }
-        var response = yield fetch(this.endpoint, {
+        var fetchOptions = {
           method: 'POST',
           headers,
           body: JSON.stringify(body)
-        });
+        };
+
+        // Do not send `keepalive: false`. The track caller opts in only for payloads
+        // that fit the browser keepalive budget; omitting the key for larger events
+        // preserves normal fetch behavior for rich carts/orders instead of asking
+        // the browser to use an unload-safe transport it may reject.
+        if (keepalive) {
+          fetchOptions.keepalive = true;
+        }
+        var response = yield fetch(this.endpoint, fetchOptions);
         return new Response(response.status === 200, yield response.json());
       });
       function create(_x) {

package/lib/api/index.cjs

@@ -10,6 +10,7 @@ Object.defineProperty(exports, "Response", {
   }
 });
 exports.default = void 0;
+exports.keepaliveFor = keepaliveFor;
 var _businesses = _interopRequireDefault(require("./businesses"));
 var _events = _interopRequireDefault(require("./events"));
 var _forms = _interopRequireDefault(require("./forms"));
@@ -23,6 +24,26 @@ function _defineProperties(target, props) { for (var i = 0; i < props.length; i+
 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); }
+// Browsers keep `fetch(..., { keepalive: true })` requests alive during page
+// unload/navigation, which is exactly the failure mode for analytics events
+// fired from checkout redirects, form submissions, tab closes, and pixel
+// lifecycles. The platform also caps keepalive request bodies around 64KB, and
+// browsers can reject or drop oversized requests instead of making delivery
+// more reliable. Keep the limit below that ceiling so the SDK only opts in when
+// the payload is small enough for the keepalive transport contract.
+const KEEPALIVE_BODY_LIMIT = 60000;
+function keepaliveFor(body) {
+  const serializedBody = JSON.stringify(body);
+
+  // Use byte size when the runtime exposes Blob because non-ASCII JSON can be
+  // larger on the wire than its JavaScript string length. The string-length
+  // fallback keeps older/non-browser runtimes conservative without pulling in
+  // another encoder just for this transport hint.
+  if (typeof Blob === 'undefined') {
+    return serializedBody.length < KEEPALIVE_BODY_LIMIT;
+  }
+  return new Blob([serializedBody]).size < KEEPALIVE_BODY_LIMIT;
+}
 let API = /*#__PURE__*/function () {
   function API() {
     _classCallCheck(this, API);

package/lib/api/index.js

@@ -9,6 +9,27 @@ import FormsAPI from './forms';
 import IdentificationsAPI from './identifications';
 import WebchatsAPI from './webchats';
 import AcksAPI from './acks';
+
+// Browsers keep `fetch(..., { keepalive: true })` requests alive during page
+// unload/navigation, which is exactly the failure mode for analytics events
+// fired from checkout redirects, form submissions, tab closes, and pixel
+// lifecycles. The platform also caps keepalive request bodies around 64KB, and
+// browsers can reject or drop oversized requests instead of making delivery
+// more reliable. Keep the limit below that ceiling so the SDK only opts in when
+// the payload is small enough for the keepalive transport contract.
+var KEEPALIVE_BODY_LIMIT = 60000;
+function keepaliveFor(body) {
+  var serializedBody = JSON.stringify(body);
+
+  // Use byte size when the runtime exposes Blob because non-ASCII JSON can be
+  // larger on the wire than its JavaScript string length. The string-length
+  // fallback keeps older/non-browser runtimes conservative without pulling in
+  // another encoder just for this transport hint.
+  if (typeof Blob === 'undefined') {
+    return serializedBody.length < KEEPALIVE_BODY_LIMIT;
+  }
+  return new Blob([serializedBody]).size < KEEPALIVE_BODY_LIMIT;
+}
 var API = /*#__PURE__*/function () {
   function API() {
     _classCallCheck(this, API);
@@ -47,4 +68,5 @@ var API = /*#__PURE__*/function () {
   return API;
 }();
 export { API as default };
-export { Response } from './response';
+export { Response } from './response';
+export { keepaliveFor };

package/lib/hellotext.cjs

@@ -29,9 +29,9 @@ let Hellotext = /*#__PURE__*/function () {
      */
     async function initialize(business, config = {}) {
       this.business = new _models.Business(business);
-      _core.Configuration.assign(config);
-      _models.Session.initialize();
       this.page = new _models.Page();
+      _core.Configuration.assign(config);
+      _models.Session.initialize(this.page);
       this.forms = new _models.FormCollection();
       this.query = new _models.Query();
       const businessData = await this.business.hydrate();
@@ -104,7 +104,12 @@ let Hellotext = /*#__PURE__*/function () {
       delete body.headers;
       return await _api.default.events.create({
         headers,
-        body
+        body,
+        // Track is the SDK's unload-sensitive analytics path. Keepalive belongs
+        // here rather than on identify/forms/webchat calls because event tracking
+        // is allowed to be fire-and-navigate, while those other calls have
+        // stronger request/response or interaction contracts.
+        keepalive: (0, _api.keepaliveFor)(body)
       });
     }
 

package/lib/hellotext.js

@@ -9,7 +9,7 @@ function _createClass(Constructor, protoProps, staticProps) { if (protoProps) _d
 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 { Configuration, Event } from './core';
-import API, { Response } from './api';
+import API, { Response, keepaliveFor } from './api';
 import { Business, Fingerprint, FormCollection, Page, Query, Session, User, Webchat } from './models';
 import { NotInitializedError } from './errors';
 var Hellotext = /*#__PURE__*/function () {
@@ -28,9 +28,9 @@ var Hellotext = /*#__PURE__*/function () {
       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();
+        Configuration.assign(config);
+        Session.initialize(this.page);
         this.forms = new FormCollection();
         this.query = new Query();
         var businessData = yield this.business.hydrate();
@@ -101,7 +101,12 @@ var Hellotext = /*#__PURE__*/function () {
         delete body.headers;
         return yield API.events.create({
           headers,
-          body
+          body,
+          // Track is the SDK's unload-sensitive analytics path. Keepalive belongs
+          // here rather than on identify/forms/webchat calls because event tracking
+          // is allowed to be fire-and-navigate, while those other calls have
+          // stronger request/response or interaction contracts.
+          keepalive: keepaliveFor(body)
         });
       });
       function track(_x2) {

package/lib/models/session.cjs

@@ -6,6 +6,7 @@ Object.defineProperty(exports, "__esModule", {
 exports.Session = void 0;
 var _core = require("../core");
 var _cookies = require("./cookies");
+var _page2 = require("./page");
 var _query2 = require("./query");
 var _api = _interopRequireDefault(require("../api"));
 function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
@@ -19,6 +20,7 @@ var id = 0;
 function _classPrivateFieldLooseKey(name) { return "__private_" + id++ + "_" + name; }
 var _session = /*#__PURE__*/_classPrivateFieldLooseKey("session");
 var _query = /*#__PURE__*/_classPrivateFieldLooseKey("query");
+var _page = /*#__PURE__*/_classPrivateFieldLooseKey("page");
 let Session = /*#__PURE__*/function () {
   function Session() {
     _classCallCheck(this, Session);
@@ -36,14 +38,23 @@ let Session = /*#__PURE__*/function () {
         _cookies.Cookies.delete('hello_session_ack_at');
       }
       if (!_cookies.Cookies.get('hello_session_ack_at')) {
-        _api.default.acks.send();
+        _api.default.acks.send(this.ackPayload);
         _cookies.Cookies.set('hello_session_ack_at', new Date().toISOString());
       }
       return _classPrivateFieldLooseBase(this, _session)[_session];
     }
+  }, {
+    key: "ackPayload",
+    get: function () {
+      var _classPrivateFieldLoo;
+      return {
+        utm_params: ((_classPrivateFieldLoo = _classPrivateFieldLooseBase(this, _page)[_page]) === null || _classPrivateFieldLoo === void 0 ? void 0 : _classPrivateFieldLoo.utmParams) || {}
+      };
+    }
   }, {
     key: "initialize",
-    value: function initialize() {
+    value: function initialize(page = new _page2.Page()) {
+      _classPrivateFieldLooseBase(this, _page)[_page] = page;
       _classPrivateFieldLooseBase(this, _query)[_query] = new _query2.Query();
       this.session = _classPrivateFieldLooseBase(this, _query)[_query].session || _core.Configuration.session || _cookies.Cookies.get('hello_session');
       if (!this.session && _core.Configuration.autoGenerateSession) {
@@ -61,4 +72,8 @@ Object.defineProperty(Session, _session, {
 Object.defineProperty(Session, _query, {
   writable: true,
   value: void 0
+});
+Object.defineProperty(Session, _page, {
+  writable: true,
+  value: void 0
 });

package/lib/models/session.js

@@ -8,10 +8,12 @@ var id = 0;
 function _classPrivateFieldLooseKey(name) { return "__private_" + id++ + "_" + name; }
 import { Configuration } from '../core';
 import { Cookies } from './cookies';
+import { Page } from './page';
 import { Query } from './query';
 import API from '../api';
 var _session = /*#__PURE__*/_classPrivateFieldLooseKey("session");
 var _query = /*#__PURE__*/_classPrivateFieldLooseKey("query");
+var _page = /*#__PURE__*/_classPrivateFieldLooseKey("page");
 var Session = /*#__PURE__*/function () {
   function Session() {
     _classCallCheck(this, Session);
@@ -29,14 +31,24 @@ var Session = /*#__PURE__*/function () {
         Cookies.delete('hello_session_ack_at');
       }
       if (!Cookies.get('hello_session_ack_at')) {
-        API.acks.send();
+        API.acks.send(this.ackPayload);
         Cookies.set('hello_session_ack_at', new Date().toISOString());
       }
       return _classPrivateFieldLooseBase(this, _session)[_session];
     }
+  }, {
+    key: "ackPayload",
+    get: function get() {
+      var _classPrivateFieldLoo;
+      return {
+        utm_params: ((_classPrivateFieldLoo = _classPrivateFieldLooseBase(this, _page)[_page]) === null || _classPrivateFieldLoo === void 0 ? void 0 : _classPrivateFieldLoo.utmParams) || {}
+      };
+    }
   }, {
     key: "initialize",
     value: function initialize() {
+      var page = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : new Page();
+      _classPrivateFieldLooseBase(this, _page)[_page] = page;
       _classPrivateFieldLooseBase(this, _query)[_query] = new Query();
       this.session = _classPrivateFieldLooseBase(this, _query)[_query].session || Configuration.session || Cookies.get('hello_session');
       if (!this.session && Configuration.autoGenerateSession) {
@@ -54,4 +66,8 @@ Object.defineProperty(Session, _query, {
   writable: true,
   value: void 0
 });
+Object.defineProperty(Session, _page, {
+  writable: true,
+  value: void 0
+});
 export { Session };

package/package.json

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

package/src/api/acks.js

@@ -7,8 +7,9 @@ class AcksAPI {
     return Configuration.endpoint('public/acks')
   }
 
-  static async send() {
+  static async send(params = {}) {
     const payload = {
+      ...params,
       session: Hellotext.session,
       at: new Date().toISOString(),
     }

package/src/api/events.js

@@ -8,16 +8,26 @@ export default class EventsAPI {
     return Configuration.endpoint('track/events')
   }
 
-  static async create({ headers, body }) {
+  static async create({ headers, body, keepalive = false }) {
     if (Query.inPreviewMode) {
       return new Response(true, { received: true })
     }
 
-    const response = await fetch(this.endpoint, {
+    const fetchOptions = {
       method: 'POST',
       headers,
       body: JSON.stringify(body),
-    })
+    }
+
+    // Do not send `keepalive: false`. The track caller opts in only for payloads
+    // that fit the browser keepalive budget; omitting the key for larger events
+    // preserves normal fetch behavior for rich carts/orders instead of asking
+    // the browser to use an unload-safe transport it may reject.
+    if (keepalive) {
+      fetchOptions.keepalive = true
+    }
+
+    const response = await fetch(this.endpoint, fetchOptions)
 
     return new Response(response.status === 200, await response.json())
   }

package/src/api/index.js

@@ -5,6 +5,29 @@ import IdentificationsAPI from './identifications'
 import WebchatsAPI from './webchats'
 import AcksAPI from './acks'
 
+// Browsers keep `fetch(..., { keepalive: true })` requests alive during page
+// unload/navigation, which is exactly the failure mode for analytics events
+// fired from checkout redirects, form submissions, tab closes, and pixel
+// lifecycles. The platform also caps keepalive request bodies around 64KB, and
+// browsers can reject or drop oversized requests instead of making delivery
+// more reliable. Keep the limit below that ceiling so the SDK only opts in when
+// the payload is small enough for the keepalive transport contract.
+const KEEPALIVE_BODY_LIMIT = 60000
+
+function keepaliveFor(body) {
+  const serializedBody = JSON.stringify(body)
+
+  // Use byte size when the runtime exposes Blob because non-ASCII JSON can be
+  // larger on the wire than its JavaScript string length. The string-length
+  // fallback keeps older/non-browser runtimes conservative without pulling in
+  // another encoder just for this transport hint.
+  if (typeof Blob === 'undefined') {
+    return serializedBody.length < KEEPALIVE_BODY_LIMIT
+  }
+
+  return new Blob([serializedBody]).size < KEEPALIVE_BODY_LIMIT
+}
+
 export default class API {
   static get businesses() {
     return BusinessesAPI
@@ -32,3 +55,4 @@ export default class API {
 }
 
 export { Response } from './response'
+export { keepaliveFor }

package/src/hellotext.js

@@ -1,7 +1,16 @@
 import { Configuration, Event } from './core'
 
-import API, { Response } from './api'
-import { Business, Fingerprint, FormCollection, Page, Query, Session, User, Webchat } from './models'
+import API, { Response, keepaliveFor } from './api'
+import {
+  Business,
+  Fingerprint,
+  FormCollection,
+  Page,
+  Query,
+  Session,
+  User,
+  Webchat,
+} from './models'
 
 import { NotInitializedError } from './errors'
 
@@ -18,25 +27,28 @@ class Hellotext {
    */
   static async initialize(business, config = {}) {
     this.business = new Business(business)
+    this.page = new Page()
 
     Configuration.assign(config)
-    Session.initialize()
+    Session.initialize(this.page)
 
-    this.page = new Page()
     this.forms = new FormCollection()
 
     this.query = new Query()
 
     const businessData = await this.business.hydrate()
-    const webchatConfig = config.webchat === false ?
-      false :
-      this.mergeWebchatConfig((businessData && businessData.webchat) || {}, config.webchat || {})
-
-    const hasExplicitBehaviourOverride = (
+    const webchatConfig =
+      config.webchat === false
+        ? false
+        : this.mergeWebchatConfig(
+            (businessData && businessData.webchat) || {},
+            config.webchat || {},
+          )
+
+    const hasExplicitBehaviourOverride =
       config.webchat &&
       config.webchat !== false &&
       Object.prototype.hasOwnProperty.call(config.webchat, 'behaviour')
-    )
     Configuration.webchat.behaviourOverride = hasExplicitBehaviourOverride
 
     if (webchatConfig && webchatConfig.id) {
@@ -108,6 +120,11 @@ class Hellotext {
     return await API.events.create({
       headers,
       body,
+      // Track is the SDK's unload-sensitive analytics path. Keepalive belongs
+      // here rather than on identify/forms/webchat calls because event tracking
+      // is allowed to be fire-and-navigate, while those other calls have
+      // stronger request/response or interaction contracts.
+      keepalive: keepaliveFor(body),
     })
   }
 
@@ -142,11 +159,7 @@ class Hellotext {
     })
 
     if (response.succeeded) {
-      User.remember(
-        externalId,
-        options.source,
-        fingerprint,
-      )
+      User.remember(externalId, options.source, fingerprint)
     }
 
     return response

package/src/models/session.js

@@ -1,16 +1,24 @@
 import { Configuration } from '../core'
 import { Cookies } from './cookies'
+import { Page } from './page'
 import { Query } from './query'
 import API from '../api'
 
 class Session {
   static #session
   static #query
+  static #page
 
   static get session() {
     return this.#session
   }
 
+  static get ackPayload() {
+    return {
+      utm_params: this.#page?.utmParams || {},
+    }
+  }
+
   static set session(value) {
     const oldSession = Cookies.get('hello_session')
 
@@ -22,14 +30,15 @@ class Session {
     }
 
     if (!Cookies.get('hello_session_ack_at')) {
-      API.acks.send()
+      API.acks.send(this.ackPayload)
       Cookies.set('hello_session_ack_at', new Date().toISOString())
     }
 
     return this.#session
   }
 
-  static initialize() {
+  static initialize(page = new Page()) {
+    this.#page = page
     this.#query = new Query()
 
     this.session = this.#query.session || Configuration.session || Cookies.get('hello_session')