@hellotext/hellotext 1.8.7 → 2.0.0

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/styles/index.css

@@ -1,38 +0,0 @@
-.hidden {
-  display: none;
-}
-
-form[data-hello-form] {
-  position: relative;
-
-  & article {
-    & [data-error-container] {
-      font-size: 0.875rem;
-      line-height: 1.25rem;
-      display: none;
-    }
-
-    &:has(input:invalid) {
-      & [data-error-container] {
-        display: block;
-      }
-    }
-  }
-
-  & [data-logo-container] {
-    display: flex;
-    justify-content: center;
-    align-items: flex-end;
-    position: absolute;
-    right: 1rem;
-    bottom: 1rem;
-
-    & small {
-      margin: 0 0.3rem;
-    }
-
-    & [data-hello-brand] {
-      width: 4rem;
-    }
-  }
-}

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'],
-      },
-    ],
-  },
-}