@hellotext/hellotext 1.8.7 → 2.0.1

package/docs/tracking.md

@@ -1,203 +0,0 @@
-## Tracking Events
-
-Track subscriber events as they happen on your website and let Hellotext report them back to your business.
-
-Tracking events is straightforward and perhaps the simplest example is tracking a page view:
-
-```javascript
-Hellotext.track('page.viewed')
-```
-
-In the example above only the name of the action is required.
-
-### Handling Responses
-
-The `track` method returns a Promise that can be `await`ed using the async/await syntax. Or using `.then` on the returned Promise.
-
-```javascript
-const response = await Hellotext.track('page.viewed')
-```
-
-The return of the `Hellotext.track` method is an instance of a `Response` object that ships with the package. You can check the status of the response via methods, like:
-
-```javascript
-if (response.failed) {
-  console.log('failed because', response.data)
-}
-
-if (response.succeeded) {
-  console.log('success')
-  console.log(response.data) // { status: "received" }
-}
-```
-
-### Parameters
-
-The parameters passed to the action must be a valid set of parameters as described in
-[Tracking Actions](https://www.hellotext.com/api#tracking).
-
-#### URL Parameter
-
-The library takes care of handling the `url` parameter with the current URL automatically and is not required to specify it explicitly.
-If you want to provide another url, you can pass a `url` key in the params object when tracking an event.
-
-```javascript
-Hellotext.track('page.viewed', {
-  url: 'www.example.org',
-})
-```
-
-### Headers 
-
-You can add any custom or additional headers to the request by passing a `headers` object in the parameter.
-
-```javascript
-Hellotext.track('page.viewed', {
-  headers: {
-    'X-Custom-Header': 'value',
-  },
-  // event related parameters
-})
-```
-
-### Errors
-
-Failing to provide valid set of parameters will result in an error object being returned, describing the parameters that did not satisfy the rules.
-
-```javascript
-const response = await Hellotext.track('app.installed', { object_parameters: { name: null } })
-
-console.log(response.data)
-```
-
-yields
-
-```javascript
-{
-  errors: [
-    {
-      type: 'parameter_invalid_empty',
-      parameter: 'name',
-      description: 'This required parameter has an empty value. Provide a valid value for the parameter.',
-    },
-  ]
-}
-```
-
-For a complete list of errors types. See [Error Types](https://www.hellotext.com/api#errors)
-
-### Event parameters 
-
-Every tracked event has the following parameters which you can pass to the `track` method:
-
-
-| Property       | Description                                                                                                                                                                           | Type     | Default |
-| -------------- |---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -------- | ------- |
-| **amount**     | Monetary amount that represents the revenue associated to this tracked event.                                                                                                         | float    | `0`     |
-| **currency**   | Currency for the `amount` given in ISO 4217 format. If not specified, the currency default to the business' configured reporting currency.                                            | currency | `USD`   |
-| **metadata**   | Set of key-value pairs that you can attach to an event. This can be useful for storing additional information about the object in a structured format.                                | hash     | `{}`    |
-| **tracked_at** | Original date when the event happened. This is useful if you want to record an event that happened in the past. If no value is provided its value will be the same from `created_at`. | epoch    | `null`  |
-
-### Associated object parameters
-
-Generally, most actions also require an associated object. These can be of type [`app`](https://www.hellotext.com/api#apps), [`coupon`](https://www.hellotext.com/api#coupons), [`form`](https://www.hellotext.com/api#forms), [`order`](https://www.hellotext.com/api#orders), [`product`](https://www.hellotext.com/api#products) and [`refund`](https://www.hellotext.com/api#refunds), these events require an existing object to be present 
-in order to be tracked aside from [Custom Actions](https://www.hellotext.com/api#create_an_action), which don't require the trackable to be present.
-
-Associated objects are represented by three possible parameters: 
-
-- `object`: An ID of an existing object of the same type. For example, when tracking app events, the `object` must be a previously created app object.
-- `object_parameters`: A set of parameters for creating a new object of the same type. For example, when tracking app events, the `object_parameters` must be a set of parameters for creating a new app object.
-- `object_type`: An ID or `name` of an existing custom object. Only required when tracking custom objects. Lets Hellotext know which type of object is being tracked. Learn more about [Objects](https://www.hellotext.com/api#objects).
-
-You can create the associated object directly by defining its parameters in a hash:
-
-```javascript
-Hellotext.track('order.placed', {
-  amount: 395.0,
-  currency: 'USD',
-  object_parameters: {
-    reference: '654321',
-    source: 'myshop',
-    items: [
-      {
-        product: 'erA2RAXE',
-        quantity: 2,
-      }
-    ]
-  },
-})
-```
-
-If you want to reuse existing objects, you must pass the identifier of an existing associated object. For example, to track a product purchase the identifier of a previously created product object as the `product`.
-For more information about identifiers, view the [Tracking API](https://www.hellotext.com/api#tracking)
-
-```javascript
-Hellotext.track('product.purchased', {
-  amount: 395.0,
-  currency: 'USD',
-  object: 'erA2RAXE',
-})
-```
-
-## List of actions
-
-The following is a complete list of built-in actions and their required associated objects. Each associated action accepts a possible set of two parameters 
-
-
-
-| Action                | Description                                              | Required Parameter                                                        |
-| --------------------- | -------------------------------------------------------- |---------------------------------------------------------------------------|
-| **app.installed**     | An app was installed.                                    | `object` or [object_parameters](https://www.hellotext.com/api#app)        |
-| **app.removed**       | An app was removed.                                      | `object` or [object_parameters](https://www.hellotext.com/api#app)              |
-| **app.spent**         | A customer spent on an app.                              | `object` or [object_parameters](https://www.hellotext.com/api#app)              |
-| **cart.abandoned**    | A cart was abandoned.                                    | `object` or [object_parameters](https://www.hellotext.com/api#products) |
-| **cart.added**        | Added an item to the cart.                               | `object` or [object_parameters](https://www.hellotext.com/api#products) |
-| **cart.removed**      | Removed an item from the cart.                           | `object` or [object_parameters](https://www.hellotext.com/api#products) |
-| **coupon.redeemed**   | A coupon was redeem by a customer.                       | `object` or [object_parameters](https://www.hellotext.com/api#coupons)    |
-| **form.completed**    | A form was completed by the customer.                    | `object` or [object_parameters](https://www.hellotext.com/api#forms)          |
-| **order.placed**      | Order has been placed.                                   | `object` or [object_parameters](https://www.hellotext.com/api#orders)       |
-| **order.confirmed**   | Order has been confirmed by you.                         | `object` or [object_parameters](https://www.hellotext.com/api#orders)       |
-| **order.cancelled**   | Order has been cancelled either by you or your customer. | `object` or [object_parameters](https://www.hellotext.com/api#orders)       |
-| **order.shipped**     | Order has been shipped to your customer.                 | `object` or [object_parameters](https://www.hellotext.com/api#orders)       |
-| **order.delivered**   | Order has been delivered to your customer.               | `object` or [object_parameters](https://www.hellotext.com/api#orders)       |
-| **page.viewed**       | A page was viewed by a customer.                         | `url`                                                                     |
-| **product.purchased** | A product has been purchased.                            | `object` or [object_parameters](https://www.hellotext.com/api#products) |
-| **product.viewed**    | A product page has been viewed.                          | `object` or [object_parameters](https://www.hellotext.com/api#products) |
-| **refund.requested**  | A customer requested a refund.                           | `object` or [object_parameters](https://www.hellotext.com/api#refunds)    |
-| **refund.received**   | A refund was issued by you to your customer.             | `object` or [object_parameters](https://www.hellotext.com/api#refunds)    |
-
-You can also create your **[own defined actions](https://www.hellotext.com/api#actions)**.
-
-### Tracking Custom Actions
-
-Once you have created a custom action, you track it by specifying the action's name. Custom actions do not require an associated object to be present in order to be tracked.
-However, it's possible to track custom actions alongside existing Objects, or new objects you introduce. 
-
-```javascript
-// Custom Action without an associated object
-
-Hellotext.track('appointment.booked')
-
-// Custom Action with an existing custom object instance.
-
-Hellotext.track('appointment.booked', {
-  object_type: 'appointment',
-  object: 'erA2RAXE',
-})
-
-// Custom Action with a new custom object instance.
-Hellotext.track('appointment.booked', {
-  object_type: 'appointment',
-  object_parameters: {
-    room: 'AA-101',
-    booked_at: 1632313200,
-  }
-})
-
-// Custom Action with a builtin object instance.
-
-Hellotext.track('appointment.booked', {
-  object_type: 'product',
-  object: 'erA2RAXE',
-})
-```

package/docs/webchat.md

@@ -1,101 +0,0 @@
-## Webchat
-
-Hellotext allows you to build webchats via the dashboard and allow Hellotext.js to load a given webchat with 
-a specific ID and show it to the user. A webchat can be specified when initializing the library by passing a `webchat` property
-to the configuration option.
-
-```js
-Hellotext.initialize('PUBLIC_BUSINESS_ID', {
-  webchat: {
-    id,
-    container,
-    placement,
-    classes,
-    triggerClasses,
-    style: {
-      primaryColor,
-      secondaryColor,
-      typography
-    },
-    behaviour,
-  }
-})
-```
-
-| Property       | Description                                                                                                                              | Type   | Default        |
-|----------------|------------------------------------------------------------------------------------------------------------------------------------------|--------|----------------|
-| id             | The id of the webchat to load. **required**                                                                                              | String | null           |
-| container      | The container to append the webchat to, must be a valid CSS selector. If none specified, the webchat is appended at the end of the body. | String | `body`         |
-| placement      | The placement of the webchat, determined according to the parent `container`.                                                            | Enum   | `bottom-right` |
-| classes        | An array or comma separated String of additional CSS classes to apply to the webchat popover.                                            | String | null           |
-| triggerClasses | An array or comma separated String of additional CSS classes to apply to the webchat trigger.                                            | String | null           |
-| style          | Style overrides to the WebChat's style configuration as created on the dashboard.                                                        | Object | null           |
-| behaviour      | The behaviour of the webchat when it is open and a click was made outside of it                                                          | Enum   | `popover`      |
-
-### Position 
-
-The default position for a webchat is `bottom-right`, but you can specify any of the following values 
-
-- `bottom-left`
-- `bottom-right`
-- `top-left`
-- `top-right`
-
-### Style 
-
-The following properties are accepted for the `style` object.
-
-- `primaryColor` - The primary color of the Webchat. Must be either in hex or rgb/a formats. Affects the following elements:
-  - Trigger background
-  - Popover header background
-  - Agent icon color
-  - Toolbar button hover
-  - Incoming message background
-
-The primary color is controlled via a `--webchat-primary-color` CSS variable.
-
-- `secondaryColor` - The secondary color of the webchat. Must be either in hex or rgb/a formats. Affects the following elements:
-  - Trigger icon color
-  - Popover header text color
-  - Agent icon background
-  - Incoming message text color
-
-The secondary color is controlled via a `--webchat-secondary-color` CSS variable.
-- `typography` - The font family to use for the webchat.
-
-All properties accept a valid CSS value, for example, `primaryColor: '#EEEEEE'` or `secondaryColor: '#ff0000'`.
-
-### behaviour
-
-Determines how the webchat functions when it is open and a click is made outside of it. The following values are accepted.
-
-- `popover` - Closes the webchat when a click is made outside of it. This is the default behaviour.
-- `modal` - Prevents the webchat from closing when a click is made outside of it. The webchat can only be closed by clicking on the trigger.
-
-### Events 
-
-The webchat emits the following events which can be listened to, to add an event listener you can `Hellotext.addEventListener(event, callback)`.
-
-- `webchat:mounted` - Emitted when the webchat is mounted
-- `webchat:opened` - Emitted when the webchat is opened
-- `webchat:closed` - Emitted when the webchat is closed
-
-- `webchat:message:sent` - Emitted when a message is sent by the user. The message is passed as an argument to the callback, containing the following properties
-
-```javascript
-{
-  id: 'xxxxxx'
-  body: 'The message the client sent',
-  attachments: [], // An array of File objects that reference the attachments the user sent.
-}
-```
-
-- `webchat:message:received` - Emitted when a message is received by the webchat from Hellotext. The message is passed as an argument to the callback, containing the following properties
-
-```javascript
-{
-  id: 'xxxxxx',
-  body: 'The message the client received from Hellotext',
-  attachments: [], // An Array of URLs referencing the attachments the user received.
-}
-```

package/jest.config.js

@@ -1,4 +0,0 @@
-module.exports = {
-  setupFiles: ['<rootDir>/jest.setup.js'], // Setup file to run before tests
-  testEnvironment: 'jsdom',
-};

package/jest.setup.js

@@ -1,16 +0,0 @@
-require('whatwg-fetch');
-
-global.crypto.randomUUID = () => {
-  return 'xxxxxxxx-xxxx-4xxx-yxxx-xxxxxxxxxxxx'.replace(/[xy]/g, function (c) {
-    const r = (Math.random() * 16) | 0;
-    const v = c === 'x' ? r : (r & 0x3) | 0x8;
-    return v.toString(16);
-  });
-};
-
-global.fetch = jest.fn(() =>
-  Promise.resolve({
-    json: () => Promise.resolve({}),
-    text: () => Promise.resolve(''),
-  })
-);

package/lib/api/web_chat/messages.js

@@ -1,74 +0,0 @@
-"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 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); }
-var WebChatMessagesAPI = /*#__PURE__*/function () {
-  function WebChatMessagesAPI(webChatId) {
-    _classCallCheck(this, WebChatMessagesAPI);
-    this.webChatId = webChatId;
-  }
-  _createClass(WebChatMessagesAPI, [{
-    key: "index",
-    value: function () {
-      var _index = _asyncToGenerator(function* (params) {
-        var url = new URL(this.url);
-        Object.entries(params).forEach(_ref => {
-          var [key, value] = _ref;
-          url.searchParams.append(key, value);
-        });
-        return yield fetch(url, {
-          method: 'GET',
-          headers: _hellotext.default.headers
-        });
-      });
-      function index(_x) {
-        return _index.apply(this, arguments);
-      }
-      return index;
-    }()
-  }, {
-    key: "create",
-    value: function () {
-      var _create = _asyncToGenerator(function* (formData) {
-        var response = yield fetch(this.url, {
-          method: 'POST',
-          headers: {
-            Authorization: "Bearer ".concat(_hellotext.default.business.id)
-          },
-          body: formData
-        });
-        return new _response.Response(response.ok, response);
-      });
-      function create(_x2) {
-        return _create.apply(this, arguments);
-      }
-      return create;
-    }()
-  }, {
-    key: "url",
-    get: function get() {
-      return WebChatMessagesAPI.endpoint.replace(':id', this.webChatId);
-    }
-  }], [{
-    key: "endpoint",
-    get: function get() {
-      return _core.Configuration.endpoint("public/webchats/:id/messages");
-    }
-  }]);
-  return WebChatMessagesAPI;
-}();
-var _default = WebChatMessagesAPI;
-exports.default = _default;

package/lib/api/web_chats.js

@@ -1,53 +0,0 @@
-"use strict";
-
-Object.defineProperty(exports, "__esModule", {
-  value: true
-});
-exports.default = void 0;
-var _hellotext = _interopRequireDefault(require("../hellotext"));
-var _core = require("../core");
-function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: 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); }
-var WebChatsAPI = /*#__PURE__*/function () {
-  function WebChatsAPI() {
-    _classCallCheck(this, WebChatsAPI);
-  }
-  _createClass(WebChatsAPI, null, [{
-    key: "endpoint",
-    get: function get() {
-      return _core.Configuration.endpoint('public/webchats');
-    }
-  }, {
-    key: "get",
-    value: function () {
-      var _get = _asyncToGenerator(function* (id) {
-        var url = new URL("".concat(this.endpoint, "/").concat(id));
-        url.searchParams.append('session', _hellotext.default.session);
-        Object.entries(_core.Configuration.webChat.style).forEach(_ref => {
-          var [key, value] = _ref;
-          url.searchParams.append("style[".concat(key, "]"), value);
-        });
-        url.searchParams.append('placement', _core.Configuration.webChat.placement);
-        var response = yield fetch(url, {
-          method: 'GET',
-          headers: _hellotext.default.headers
-        });
-        var htmlText = yield response.text();
-        return new DOMParser().parseFromString(htmlText, "text/html").querySelector('article');
-      });
-      function get(_x) {
-        return _get.apply(this, arguments);
-      }
-      return get;
-    }()
-  }]);
-  return WebChatsAPI;
-}();
-var _default = WebChatsAPI;
-exports.default = _default;

package/webpack.config.js

@@ -1,24 +0,0 @@
-module.exports = {
-  mode: 'production',
-  entry: ['@hotwired/stimulus', './lib/index.js'],
-  output: {
-    filename: 'hellotext.js',
-  },
-  module: {
-    rules: [
-      {
-        test: /\.m?js$/,
-        exclude: [/node_modules/],
-        use: [
-          {
-            loader: 'babel-loader',
-          },
-        ],
-      },
-      {
-        test: /\.css$/i,
-        use: ['style-loader', 'css-loader'],
-      },
-    ],
-  },
-}