@hellotext/hellotext 2.2.1 → 2.3.0

package/index.d.ts

@@ -35,6 +35,18 @@ export interface TrackingParams {
   object_type?: string
 }
 
+export interface IdentificationOptions {
+  email?: string
+  phone?: string
+  name?: string
+  source?: string
+}
+
+export interface IdentificationData {
+  id: string
+  source?: string
+}
+
 export interface Response {
   data: any
   succeeded: boolean
@@ -44,6 +56,8 @@ export interface Response {
 declare class Hellotext {
   static initialize(businessId: string, config?: HellotextConfig): Promise<void>
   static track(action: string, params?: TrackingParams): Promise<Response>
+  static identify(userId: string, options?: IdentificationOptions): Promise<Response>
+  static forget(): void
   static on(event: string, callback: (data: any) => void): void
   static removeEventListener(event: string, callback: (data: any) => void): void
   static get session(): string
@@ -53,6 +67,20 @@ declare class Hellotext {
   static webchat: any
 }
 
+export declare class User {
+  static get id(): string | undefined
+  static get source(): string | undefined
+  static remember(id: string, source?: string): void
+  static forget(): void
+  static get identificationData(): IdentificationData | Record<string, never>
+}
+
+export declare class Cookies {
+  static get(name: string): string | undefined
+  static set(name: string, value: string): string
+  static delete(name: string): void
+}
+
 export default Hellotext
 
 // Declare the CSS module

package/lib/api/identifications.cjs

@@ -0,0 +1,42 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.default = void 0;
+var _hellotext = _interopRequireDefault(require("../hellotext"));
+var _core = require("../core");
+var _response = require("./response");
+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); }
+let IdentificationsAPI = /*#__PURE__*/function () {
+  function IdentificationsAPI() {
+    _classCallCheck(this, IdentificationsAPI);
+  }
+  _createClass(IdentificationsAPI, null, [{
+    key: "endpoint",
+    get: function () {
+      return _core.Configuration.endpoint('public/identifications');
+    }
+  }, {
+    key: "create",
+    value: async function create(data = {}) {
+      const response = await fetch(this.endpoint, {
+        method: 'POST',
+        headers: _hellotext.default.headers,
+        body: JSON.stringify({
+          session: _hellotext.default.session,
+          ...data
+        })
+      });
+      return new _response.Response(response.ok, response);
+    }
+  }]);
+  return IdentificationsAPI;
+}();
+var _default = IdentificationsAPI;
+exports.default = _default;

package/lib/api/identifications.js

@@ -0,0 +1,45 @@
+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"); } }
+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 Hellotext from '../hellotext';
+import { Configuration } from '../core';
+import { Response } from './response';
+var IdentificationsAPI = /*#__PURE__*/function () {
+  function IdentificationsAPI() {
+    _classCallCheck(this, IdentificationsAPI);
+  }
+  _createClass(IdentificationsAPI, null, [{
+    key: "endpoint",
+    get: function get() {
+      return Configuration.endpoint('public/identifications');
+    }
+  }, {
+    key: "create",
+    value: function () {
+      var _create = _asyncToGenerator(function* () {
+        var data = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : {};
+        var response = yield fetch(this.endpoint, {
+          method: 'POST',
+          headers: Hellotext.headers,
+          body: JSON.stringify(_objectSpread({
+            session: Hellotext.session
+          }, data))
+        });
+        return new Response(response.ok, response);
+      });
+      function create() {
+        return _create.apply(this, arguments);
+      }
+      return create;
+    }()
+  }]);
+  return IdentificationsAPI;
+}();
+export default IdentificationsAPI;

package/lib/api/index.cjs

@@ -13,6 +13,7 @@ exports.default = void 0;
 var _businesses = _interopRequireDefault(require("./businesses"));
 var _events = _interopRequireDefault(require("./events"));
 var _forms = _interopRequireDefault(require("./forms"));
+var _identifications = _interopRequireDefault(require("./identifications"));
 var _webchats = _interopRequireDefault(require("./webchats"));
 var _response = require("./response");
 function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
@@ -45,6 +46,11 @@ let API = /*#__PURE__*/function () {
     get: function () {
       return _webchats.default;
     }
+  }, {
+    key: "identifications",
+    get: function () {
+      return _identifications.default;
+    }
   }]);
   return API;
 }();

package/lib/api/index.js

@@ -6,6 +6,7 @@ function _toPrimitive(input, hint) { if (typeof input !== "object" || input ===
 import BusinessesAPI from './businesses';
 import EventsAPI from './events';
 import FormsAPI from './forms';
+import IdentificationsAPI from './identifications';
 import WebchatsAPI from './webchats';
 var API = /*#__PURE__*/function () {
   function API() {
@@ -31,6 +32,11 @@ var API = /*#__PURE__*/function () {
     get: function get() {
       return WebchatsAPI;
     }
+  }, {
+    key: "identifications",
+    get: function get() {
+      return IdentificationsAPI;
+    }
   }]);
   return API;
 }();

package/lib/hellotext.cjs

@@ -15,11 +15,6 @@ 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); }
-function _classPrivateFieldLooseBase(receiver, privateKey) { if (!Object.prototype.hasOwnProperty.call(receiver, privateKey)) { throw new TypeError("attempted to use private field on non-instance"); } return receiver; }
-var id = 0;
-function _classPrivateFieldLooseKey(name) { return "__private_" + id++ + "_" + name; }
-var _session = /*#__PURE__*/_classPrivateFieldLooseKey("session");
-var _query = /*#__PURE__*/_classPrivateFieldLooseKey("query");
 let Hellotext = /*#__PURE__*/function () {
   function Hellotext() {
     _classCallCheck(this, Hellotext);
@@ -38,7 +33,7 @@ let Hellotext = /*#__PURE__*/function () {
       this.page = new _models.Page();
       this.business = new _models.Business(business);
       this.forms = new _models.FormCollection();
-      _classPrivateFieldLooseBase(this, _query)[_query] = new _models.Query();
+      this.query = new _models.Query();
       if (_core.Configuration.webchat.id) {
         this.webchat = await _models.Webchat.load(_core.Configuration.webchat.id);
       }
@@ -67,6 +62,7 @@ let Hellotext = /*#__PURE__*/function () {
       const pageInstance = params && params.url ? new _models.Page(params.url) : this.page;
       const body = {
         session: this.session,
+        user: _models.User.identificationData,
         action,
         ...params,
         ...pageInstance.trackingData
@@ -78,6 +74,42 @@ let Hellotext = /*#__PURE__*/function () {
       });
     }
 
+    /**
+     * @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>}
+     */
+  }, {
+    key: "identify",
+    value: async function identify(externalId, options = {}) {
+      const response = await _api.default.identifications.create({
+        user_id: externalId,
+        ...options
+      });
+      if (response.succeeded) {
+        _models.User.remember(externalId, options.source);
+      }
+      return response;
+    }
+
+    /**
+     * Clears the user session, use when the user logs out to clear the hello cookies
+     *
+     * @returns {void}
+     */
+  }, {
+    key: "forget",
+    value: function forget() {
+      _models.User.forget();
+    }
+
     /**
      * Registers an event listener
      * @param event the name of the event to listen to
@@ -141,14 +173,6 @@ let Hellotext = /*#__PURE__*/function () {
   }]);
   return Hellotext;
 }();
-Object.defineProperty(Hellotext, _session, {
-  writable: true,
-  value: void 0
-});
-Object.defineProperty(Hellotext, _query, {
-  writable: true,
-  value: void 0
-});
 Hellotext.eventEmitter = new _core.Event();
 Hellotext.forms = void 0;
 Hellotext.business = void 0;

package/lib/hellotext.js

@@ -8,15 +8,10 @@ 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); }
-function _classPrivateFieldLooseBase(receiver, privateKey) { if (!Object.prototype.hasOwnProperty.call(receiver, privateKey)) { throw new TypeError("attempted to use private field on non-instance"); } return receiver; }
-var id = 0;
-function _classPrivateFieldLooseKey(name) { return "__private_" + id++ + "_" + name; }
 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';
-var _session = /*#__PURE__*/_classPrivateFieldLooseKey("session");
-var _query = /*#__PURE__*/_classPrivateFieldLooseKey("query");
 var Hellotext = /*#__PURE__*/function () {
   function Hellotext() {
     _classCallCheck(this, Hellotext);
@@ -36,7 +31,7 @@ var Hellotext = /*#__PURE__*/function () {
         this.page = new Page();
         this.business = new Business(business);
         this.forms = new FormCollection();
-        _classPrivateFieldLooseBase(this, _query)[_query] = new Query();
+        this.query = new Query();
         if (Configuration.webchat.id) {
           this.webchat = yield Webchat.load(Configuration.webchat.id);
         }
@@ -68,6 +63,7 @@ var Hellotext = /*#__PURE__*/function () {
         var pageInstance = params && params.url ? new Page(params.url) : this.page;
         var body = _objectSpread(_objectSpread({
           session: this.session,
+          user: User.identificationData,
           action
         }, params), pageInstance.trackingData);
         delete body.headers;
@@ -81,6 +77,47 @@ var Hellotext = /*#__PURE__*/function () {
       }
       return track;
     }()
+    /**
+     * @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>}
+     */
+  }, {
+    key: "identify",
+    value: function () {
+      var _identify = _asyncToGenerator(function* (externalId) {
+        var options = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : {};
+        var response = yield API.identifications.create(_objectSpread({
+          user_id: externalId
+        }, options));
+        if (response.succeeded) {
+          User.remember(externalId, options.source);
+        }
+        return response;
+      });
+      function identify(_x4) {
+        return _identify.apply(this, arguments);
+      }
+      return identify;
+    }()
+    /**
+     * Clears the user session, use when the user logs out to clear the hello cookies
+     *
+     * @returns {void}
+     */
+  }, {
+    key: "forget",
+    value: function forget() {
+      User.forget();
+    }
+
     /**
      * Registers an event listener
      * @param event the name of the event to listen to
@@ -144,14 +181,6 @@ var Hellotext = /*#__PURE__*/function () {
   }]);
   return Hellotext;
 }();
-Object.defineProperty(Hellotext, _session, {
-  writable: true,
-  value: void 0
-});
-Object.defineProperty(Hellotext, _query, {
-  writable: true,
-  value: void 0
-});
 Hellotext.eventEmitter = new Event();
 Hellotext.forms = void 0;
 Hellotext.business = void 0;

package/lib/models/cookies.cjs

@@ -48,6 +48,19 @@ let Cookies = /*#__PURE__*/function () {
         return undefined;
       }
     }
+  }, {
+    key: "delete",
+    value: function _delete(name) {
+      if (typeof document !== 'undefined') {
+        const domain = _page.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`;
+        }
+      }
+    }
   }]);
   return Cookies;
 }();

package/lib/models/cookies.js

@@ -41,6 +41,19 @@ var Cookies = /*#__PURE__*/function () {
         return undefined;
       }
     }
+  }, {
+    key: "delete",
+    value: function _delete(name) {
+      if (typeof document !== 'undefined') {
+        var domain = Page.getRootDomain();
+        var secure = window.location.protocol === 'https:' ? '; Secure' : '';
+        if (domain) {
+          document.cookie = "".concat(name, "=; path=/; expires=Thu, 01 Jan 1970 00:00:00 GMT").concat(secure, "; domain=").concat(domain, "; SameSite=Lax");
+        } else {
+          document.cookie = "".concat(name, "=; path=/; expires=Thu, 01 Jan 1970 00:00:00 GMT").concat(secure, "; SameSite=Lax");
+        }
+      }
+    }
   }]);
   return Cookies;
 }();

package/lib/models/index.cjs

@@ -51,6 +51,12 @@ Object.defineProperty(exports, "UTM", {
     return _utm.UTM;
   }
 });
+Object.defineProperty(exports, "User", {
+  enumerable: true,
+  get: function () {
+    return _user.User;
+  }
+});
 Object.defineProperty(exports, "Webchat", {
   enumerable: true,
   get: function () {
@@ -64,5 +70,6 @@ var _form_collection = require("./form_collection");
 var _page = require("./page");
 var _query = require("./query");
 var _session = require("./session");
+var _user = require("./user");
 var _utm = require("./utm");
 var _webchat = require("./webchat");

package/lib/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/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.1",
+  "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