@scaleflex/widget-companion-client 0.0.1

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2019 scaleflex
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,33 @@
+# @scaleflex/widget-companion-client
+
+[![Plugins][plugins-image]](#plugins)
+[![Website][filerobot-image]][sfx-url]
+[![Version][filerobot-version]][version-url]
+[![Scaleflex team][made-by-image]][sfx-url]
+[![License][license-image]][license-url]
+[![CodeSandbox][codeSandbox-image]][codeSandbox-url]
+
+
+<div align='center'>
+<img title="Scaleflex Widget logo" alt="Scaleflex Widget logo" src="https://cdn.scaleflex.com/plugins/filerobot-widget/assets/filerobot_widget_logo_with_fire.png?vh=b2ff09" width="140"/>
+</div>
+
+The package used internally in [Scaleflex Media Asset Widget](https://www.npmjs.com/package/@scaleflex/widget-core) while communicating with companion of backend for handling 3rd parties uploading.
+
+
+<!-- Variables -->
+
+[npm-url]: https://www.npmjs.com/package/@scaleflex/widget-companion-client
+[license-url]: https://opensource.org/licenses/MIT
+[sfx-url]: https://www.scaleflex.com/
+[version-url]: https://www.npmjs.com/package/@scaleflex/widget-companion-client
+[codeSandbox-url]: https://codesandbox.io/s/filerobot-widget-v3-c5l9th
+
+
+[npm-image]: https://img.shields.io/npm/v/@telus/remark-config.svg?style=for-the-badge&logo=npm
+[license-image]: https://img.shields.io/badge/license-MIT-blue.svg?style=for-the-badge
+[made-by-image]: https://img.shields.io/badge/%3C%2F%3E%20with%20%E2%99%A5%20by-the%20Scaleflex%20team-6986fa.svg?style=for-the-badge
+[plugins-image]: https://img.shields.io/static/v1?label=Scaleflex&message=Plugins&color=yellow&style=for-the-badge
+[filerobot-image]: https://img.shields.io/static/v1?label=Scaleflex&message=website&color=orange&style=for-the-badge
+[filerobot-version]: https://img.shields.io/npm/v/@scaleflex/widget-companion-client?label=Version&style=for-the-badge&logo=npm
+[codeSandbox-image]: https://img.shields.io/badge/CodeSandbox-black?style=for-the-badge&logo=CodeSandbox

package/lib/AuthError.js

@@ -0,0 +1,31 @@
+'use strict';
+
+function _typeof(o) { "@babel/helpers - typeof"; return _typeof = "function" == typeof Symbol && "symbol" == typeof Symbol.iterator ? function (o) { return typeof o; } : function (o) { return o && "function" == typeof Symbol && o.constructor === Symbol && o !== Symbol.prototype ? "symbol" : typeof o; }, _typeof(o); }
+function _defineProperties(e, r) { for (var t = 0; t < r.length; t++) { var o = r[t]; o.enumerable = o.enumerable || !1, o.configurable = !0, "value" in o && (o.writable = !0), Object.defineProperty(e, _toPropertyKey(o.key), o); } }
+function _createClass(e, r, t) { return r && _defineProperties(e.prototype, r), t && _defineProperties(e, t), Object.defineProperty(e, "prototype", { writable: !1 }), e; }
+function _toPropertyKey(t) { var i = _toPrimitive(t, "string"); return "symbol" == _typeof(i) ? i : i + ""; }
+function _toPrimitive(t, r) { if ("object" != _typeof(t) || !t) return t; var e = t[Symbol.toPrimitive]; if (void 0 !== e) { var i = e.call(t, r || "default"); if ("object" != _typeof(i)) return i; throw new TypeError("@@toPrimitive must return a primitive value."); } return ("string" === r ? String : Number)(t); }
+function _classCallCheck(a, n) { if (!(a instanceof n)) throw new TypeError("Cannot call a class as a function"); }
+function _callSuper(t, o, e) { return o = _getPrototypeOf(o), _possibleConstructorReturn(t, _isNativeReflectConstruct() ? Reflect.construct(o, e || [], _getPrototypeOf(t).constructor) : o.apply(t, e)); }
+function _possibleConstructorReturn(t, e) { if (e && ("object" == _typeof(e) || "function" == typeof e)) return e; if (void 0 !== e) throw new TypeError("Derived constructors may only return object or undefined"); return _assertThisInitialized(t); }
+function _assertThisInitialized(e) { if (void 0 === e) throw new ReferenceError("this hasn't been initialised - super() hasn't been called"); return e; }
+function _inherits(t, e) { if ("function" != typeof e && null !== e) throw new TypeError("Super expression must either be null or a function"); t.prototype = Object.create(e && e.prototype, { constructor: { value: t, writable: !0, configurable: !0 } }), Object.defineProperty(t, "prototype", { writable: !1 }), e && _setPrototypeOf(t, e); }
+function _wrapNativeSuper(t) { var r = "function" == typeof Map ? new Map() : void 0; return _wrapNativeSuper = function _wrapNativeSuper(t) { if (null === t || !_isNativeFunction(t)) return t; if ("function" != typeof t) throw new TypeError("Super expression must either be null or a function"); if (void 0 !== r) { if (r.has(t)) return r.get(t); r.set(t, Wrapper); } function Wrapper() { return _construct(t, arguments, _getPrototypeOf(this).constructor); } return Wrapper.prototype = Object.create(t.prototype, { constructor: { value: Wrapper, enumerable: !1, writable: !0, configurable: !0 } }), _setPrototypeOf(Wrapper, t); }, _wrapNativeSuper(t); }
+function _construct(t, e, r) { if (_isNativeReflectConstruct()) return Reflect.construct.apply(null, arguments); var o = [null]; o.push.apply(o, e); var p = new (t.bind.apply(t, o))(); return r && _setPrototypeOf(p, r.prototype), p; }
+function _isNativeReflectConstruct() { try { var t = !Boolean.prototype.valueOf.call(Reflect.construct(Boolean, [], function () {})); } catch (t) {} return (_isNativeReflectConstruct = function _isNativeReflectConstruct() { return !!t; })(); }
+function _isNativeFunction(t) { try { return -1 !== Function.toString.call(t).indexOf("[native code]"); } catch (n) { return "function" == typeof t; } }
+function _setPrototypeOf(t, e) { return _setPrototypeOf = Object.setPrototypeOf ? Object.setPrototypeOf.bind() : function (t, e) { return t.__proto__ = e, t; }, _setPrototypeOf(t, e); }
+function _getPrototypeOf(t) { return _getPrototypeOf = Object.setPrototypeOf ? Object.getPrototypeOf.bind() : function (t) { return t.__proto__ || Object.getPrototypeOf(t); }, _getPrototypeOf(t); }
+var AuthError = /*#__PURE__*/function (_Error) {
+  function AuthError() {
+    var _this;
+    _classCallCheck(this, AuthError);
+    _this = _callSuper(this, AuthError, ['Authorization required']);
+    _this.name = 'AuthError';
+    _this.isAuthError = true;
+    return _this;
+  }
+  _inherits(AuthError, _Error);
+  return _createClass(AuthError);
+}(/*#__PURE__*/_wrapNativeSuper(Error));
+export default AuthError;

package/lib/Provider.js

@@ -0,0 +1,117 @@
+'use strict';
+
+function _typeof(o) { "@babel/helpers - typeof"; return _typeof = "function" == typeof Symbol && "symbol" == typeof Symbol.iterator ? function (o) { return typeof o; } : function (o) { return o && "function" == typeof Symbol && o.constructor === Symbol && o !== Symbol.prototype ? "symbol" : typeof o; }, _typeof(o); }
+function _extends() { return _extends = Object.assign ? Object.assign.bind() : function (n) { for (var e = 1; e < arguments.length; e++) { var t = arguments[e]; for (var r in t) ({}).hasOwnProperty.call(t, r) && (n[r] = t[r]); } return n; }, _extends.apply(null, arguments); }
+function _classCallCheck(a, n) { if (!(a instanceof n)) throw new TypeError("Cannot call a class as a function"); }
+function _defineProperties(e, r) { for (var t = 0; t < r.length; t++) { var o = r[t]; o.enumerable = o.enumerable || !1, o.configurable = !0, "value" in o && (o.writable = !0), Object.defineProperty(e, _toPropertyKey(o.key), o); } }
+function _createClass(e, r, t) { return r && _defineProperties(e.prototype, r), t && _defineProperties(e, t), Object.defineProperty(e, "prototype", { writable: !1 }), e; }
+function _toPropertyKey(t) { var i = _toPrimitive(t, "string"); return "symbol" == _typeof(i) ? i : i + ""; }
+function _toPrimitive(t, r) { if ("object" != _typeof(t) || !t) return t; var e = t[Symbol.toPrimitive]; if (void 0 !== e) { var i = e.call(t, r || "default"); if ("object" != _typeof(i)) return i; throw new TypeError("@@toPrimitive must return a primitive value."); } return ("string" === r ? String : Number)(t); }
+function _callSuper(t, o, e) { return o = _getPrototypeOf(o), _possibleConstructorReturn(t, _isNativeReflectConstruct() ? Reflect.construct(o, e || [], _getPrototypeOf(t).constructor) : o.apply(t, e)); }
+function _possibleConstructorReturn(t, e) { if (e && ("object" == _typeof(e) || "function" == typeof e)) return e; if (void 0 !== e) throw new TypeError("Derived constructors may only return object or undefined"); return _assertThisInitialized(t); }
+function _assertThisInitialized(e) { if (void 0 === e) throw new ReferenceError("this hasn't been initialised - super() hasn't been called"); return e; }
+function _isNativeReflectConstruct() { try { var t = !Boolean.prototype.valueOf.call(Reflect.construct(Boolean, [], function () {})); } catch (t) {} return (_isNativeReflectConstruct = function _isNativeReflectConstruct() { return !!t; })(); }
+function _superPropGet(t, o, e, r) { var p = _get(_getPrototypeOf(1 & r ? t.prototype : t), o, e); return 2 & r && "function" == typeof p ? function (t) { return p.apply(e, t); } : p; }
+function _get() { return _get = "undefined" != typeof Reflect && Reflect.get ? Reflect.get.bind() : function (e, t, r) { var p = _superPropBase(e, t); if (p) { var n = Object.getOwnPropertyDescriptor(p, t); return n.get ? n.get.call(arguments.length < 3 ? e : r) : n.value; } }, _get.apply(null, arguments); }
+function _superPropBase(t, o) { for (; !{}.hasOwnProperty.call(t, o) && null !== (t = _getPrototypeOf(t));); return t; }
+function _getPrototypeOf(t) { return _getPrototypeOf = Object.setPrototypeOf ? Object.getPrototypeOf.bind() : function (t) { return t.__proto__ || Object.getPrototypeOf(t); }, _getPrototypeOf(t); }
+function _inherits(t, e) { if ("function" != typeof e && null !== e) throw new TypeError("Super expression must either be null or a function"); t.prototype = Object.create(e && e.prototype, { constructor: { value: t, writable: !0, configurable: !0 } }), Object.defineProperty(t, "prototype", { writable: !1 }), e && _setPrototypeOf(t, e); }
+function _setPrototypeOf(t, e) { return _setPrototypeOf = Object.setPrototypeOf ? Object.setPrototypeOf.bind() : function (t, e) { return t.__proto__ = e, t; }, _setPrototypeOf(t, e); }
+import RequestClient from './RequestClient';
+import * as tokenStorage from './tokenStorage';
+var _getName = function _getName(id) {
+  return id.split('-').map(function (s) {
+    return s.charAt(0).toUpperCase() + s.slice(1);
+  }).join(' ');
+};
+var Provider = /*#__PURE__*/function (_RequestClient) {
+  function Provider(filerobot) {
+    var _this;
+    var opts = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : {};
+    _classCallCheck(this, Provider);
+    _this = _callSuper(this, Provider, [filerobot, opts]);
+    _this.provider = opts.provider;
+    _this.id = _this.provider;
+    _this.name = _this.opts.name || _getName(_this.id);
+    _this.pluginId = _this.opts.pluginId;
+    _this.tokenKey = "companion-".concat(_this.pluginId, "-auth-token");
+    return _this;
+  }
+  _inherits(Provider, _RequestClient);
+  return _createClass(Provider, [{
+    key: "headers",
+    value: function headers() {
+      var _this2 = this;
+      return new Promise(function (resolve, reject) {
+        _superPropGet(Provider, "headers", _this2, 3)([]).then(function (headers) {
+          _this2.getAuthToken().then(function (token) {
+            // TODO: change uppy-auth-token & all uppyTokens to filerobot-auth-token & filerobotTokens when BE do it.
+            resolve(_extends({}, headers, {
+              'uppy-auth-token': token
+            }));
+          });
+        })["catch"](reject);
+      });
+    }
+  }, {
+    key: "onReceiveResponse",
+    value: function onReceiveResponse(response) {
+      response = _superPropGet(Provider, "onReceiveResponse", this, 3)([response]);
+      var plugin = this.filerobot.getPlugin(this.pluginId);
+      var oldAuthenticated = plugin.getPluginCommonState().authenticated;
+      var authenticated = oldAuthenticated ? response.status !== 401 : response.status < 400;
+      plugin.setPluginCommonState({
+        authenticated: authenticated
+      });
+      return response;
+    }
+  }, {
+    key: "setAuthToken",
+    value: function setAuthToken(token) {
+      return this.filerobot.getPlugin(this.pluginId).storage.setItem(this.tokenKey, token);
+    }
+  }, {
+    key: "getAuthToken",
+    value: function getAuthToken() {
+      return this.filerobot.getPlugin(this.pluginId).storage.getItem(this.tokenKey);
+    }
+  }, {
+    key: "authUrl",
+    value: function authUrl() {
+      return "".concat(this.hostname, "/").concat(this.id, "/connect");
+    }
+  }, {
+    key: "fileUrl",
+    value: function fileUrl(id) {
+      return "".concat(this.hostname, "/").concat(this.id, "/get/").concat(id);
+    }
+  }, {
+    key: "list",
+    value: function list(directory) {
+      return this.get("".concat(this.id, "/list/").concat(directory || ''));
+    }
+  }, {
+    key: "logout",
+    value: function logout() {
+      var _this3 = this;
+      return new Promise(function (resolve, reject) {
+        _this3.get("".concat(_this3.id, "/logout")).then(function (res) {
+          _this3.filerobot.getPlugin(_this3.pluginId).storage.removeItem(_this3.tokenKey).then(function () {
+            return resolve(res);
+          })["catch"](reject);
+        })["catch"](reject);
+      });
+    }
+  }], [{
+    key: "initPlugin",
+    value: function initPlugin(plugin, opts, defaultOpts) {
+      plugin.type = 'acquirer';
+      plugin.files = [];
+      if (defaultOpts) {
+        plugin.opts = _extends({}, defaultOpts, opts);
+      }
+      plugin.storage = plugin.opts.storage || tokenStorage;
+    }
+  }]);
+}(RequestClient);
+export default Provider;

package/lib/RequestClient.js

@@ -0,0 +1,271 @@
+'use strict';
+
+function _typeof(o) { "@babel/helpers - typeof"; return _typeof = "function" == typeof Symbol && "symbol" == typeof Symbol.iterator ? function (o) { return typeof o; } : function (o) { return o && "function" == typeof Symbol && o.constructor === Symbol && o !== Symbol.prototype ? "symbol" : typeof o; }, _typeof(o); }
+function _slicedToArray(r, e) { return _arrayWithHoles(r) || _iterableToArrayLimit(r, e) || _unsupportedIterableToArray(r, e) || _nonIterableRest(); }
+function _nonIterableRest() { throw new TypeError("Invalid attempt to destructure non-iterable instance.\nIn order to be iterable, non-array objects must have a [Symbol.iterator]() method."); }
+function _unsupportedIterableToArray(r, a) { if (r) { if ("string" == typeof r) return _arrayLikeToArray(r, a); var t = {}.toString.call(r).slice(8, -1); return "Object" === t && r.constructor && (t = r.constructor.name), "Map" === t || "Set" === t ? Array.from(r) : "Arguments" === t || /^(?:Ui|I)nt(?:8|16|32)(?:Clamped)?Array$/.test(t) ? _arrayLikeToArray(r, a) : void 0; } }
+function _arrayLikeToArray(r, a) { (null == a || a > r.length) && (a = r.length); for (var e = 0, n = Array(a); e < a; e++) n[e] = r[e]; return n; }
+function _iterableToArrayLimit(r, l) { var t = null == r ? null : "undefined" != typeof Symbol && r[Symbol.iterator] || r["@@iterator"]; if (null != t) { var e, n, i, u, a = [], f = !0, o = !1; try { if (i = (t = t.call(r)).next, 0 === l) { if (Object(t) !== t) return; f = !1; } else for (; !(f = (e = i.call(t)).done) && (a.push(e.value), a.length !== l); f = !0); } catch (r) { o = !0, n = r; } finally { try { if (!f && null != t["return"] && (u = t["return"](), Object(u) !== u)) return; } finally { if (o) throw n; } } return a; } }
+function _arrayWithHoles(r) { if (Array.isArray(r)) return r; }
+function _extends() { return _extends = Object.assign ? Object.assign.bind() : function (n) { for (var e = 1; e < arguments.length; e++) { var t = arguments[e]; for (var r in t) ({}).hasOwnProperty.call(t, r) && (n[r] = t[r]); } return n; }, _extends.apply(null, arguments); }
+function ownKeys(e, r) { var t = Object.keys(e); if (Object.getOwnPropertySymbols) { var o = Object.getOwnPropertySymbols(e); r && (o = o.filter(function (r) { return Object.getOwnPropertyDescriptor(e, r).enumerable; })), t.push.apply(t, o); } return t; }
+function _objectSpread(e) { for (var r = 1; r < arguments.length; r++) { var t = null != arguments[r] ? arguments[r] : {}; r % 2 ? ownKeys(Object(t), !0).forEach(function (r) { _defineProperty(e, r, t[r]); }) : Object.getOwnPropertyDescriptors ? Object.defineProperties(e, Object.getOwnPropertyDescriptors(t)) : ownKeys(Object(t)).forEach(function (r) { Object.defineProperty(e, r, Object.getOwnPropertyDescriptor(t, r)); }); } return e; }
+function _defineProperty(e, r, t) { return (r = _toPropertyKey(r)) in e ? Object.defineProperty(e, r, { value: t, enumerable: !0, configurable: !0, writable: !0 }) : e[r] = t, e; }
+function _classCallCheck(a, n) { if (!(a instanceof n)) throw new TypeError("Cannot call a class as a function"); }
+function _defineProperties(e, r) { for (var t = 0; t < r.length; t++) { var o = r[t]; o.enumerable = o.enumerable || !1, o.configurable = !0, "value" in o && (o.writable = !0), Object.defineProperty(e, _toPropertyKey(o.key), o); } }
+function _createClass(e, r, t) { return r && _defineProperties(e.prototype, r), t && _defineProperties(e, t), Object.defineProperty(e, "prototype", { writable: !1 }), e; }
+function _toPropertyKey(t) { var i = _toPrimitive(t, "string"); return "symbol" == _typeof(i) ? i : i + ""; }
+function _toPrimitive(t, r) { if ("object" != _typeof(t) || !t) return t; var e = t[Symbol.toPrimitive]; if (void 0 !== e) { var i = e.call(t, r || "default"); if ("object" != _typeof(i)) return i; throw new TypeError("@@toPrimitive must return a primitive value."); } return ("string" === r ? String : Number)(t); }
+import { COMPANION_URLS } from '@scaleflex/widget-utils/lib/constants';
+import fetchWithNetworkError from '@scaleflex/widget-utils/lib/fetchWithNetworkError';
+import AuthError from './AuthError';
+// TODO: find a way to show version of the current plugin
+// why solution below isn't good?
+// first import doesn't work with webpack 5 as it was deprecated
+// second import fixes webpack 5 issue as it was mentioned in their docs
+// but it exposes our package.json to the client and it is mentioned as security rist in mutiple places
+// https://github.com/axelpale/genversion
+// https://stackoverflow.com/questions/64993118/error-should-not-import-the-named-export-version-imported-as-version
+// https://stackoverflow.com/questions/9153571/is-there-a-way-to-get-version-from-package-json-in-nodejs-code/10855054#10855054
+// import { version } from '../package.json'
+// import packageInfo from '../package.json'
+
+// Remove the trailing slash so we can always safely append /xyz.
+function stripSlash(url) {
+  return url.replace(/\/$/, '');
+}
+var RequestClient = /*#__PURE__*/function () {
+  // static VERSION = packageInfo.version
+
+  function RequestClient(filerobot) {
+    var opts = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : {};
+    _classCallCheck(this, RequestClient);
+    this.filerobot = filerobot;
+    this.companionUrl = filerobot.opts.dev ? COMPANION_URLS.DEV : COMPANION_URLS.PROD;
+    this.opts = opts;
+    this.onReceiveResponse = this.onReceiveResponse.bind(this);
+    // TODO: change uppy-auth-token & all uppyTokens to filerobot-auth-token & filerobotTokens when BE do it.
+    this.allowedHeaders = ['accept', 'content-type', 'uppy-auth-token'];
+    this.preflightDone = false;
+    this._addCancelAbility();
+    this._increaseRequestsNumber = this._increaseRequestsNumber.bind(this);
+    this._decreaseRequestsNumber = this._decreaseRequestsNumber.bind(this);
+    this.checkIfTherePendingRequests = this.checkIfTherePendingRequests.bind(this);
+  }
+  return _createClass(RequestClient, [{
+    key: "hostname",
+    get: function get() {
+      var _this$filerobot$getCo = this.filerobot.getCoreCommonState(),
+        companion = _this$filerobot$getCo.companion;
+      var host = this.companionUrl;
+      return stripSlash(companion && companion[host] ? companion[host] : host);
+    }
+  }, {
+    key: "defaultHeaders",
+    get: function get() {
+      return {
+        Accept: 'application/json',
+        'Content-Type': 'application/json',
+        'Filerobot-Versions': "@filerobot/companion-client=".concat(RequestClient.VERSION)
+      };
+    }
+  }, {
+    key: "headers",
+    value: function headers() {
+      var userHeaders = this.opts.companionHeaders || {};
+      return Promise.resolve(_objectSpread(_objectSpread({}, this.defaultHeaders), userHeaders));
+    }
+  }, {
+    key: "_getPostResponseFunc",
+    value: function _getPostResponseFunc(skip) {
+      var _this = this;
+      return function (response) {
+        if (!skip) {
+          return _this.onReceiveResponse(response);
+        }
+        return response;
+      };
+    }
+  }, {
+    key: "onReceiveResponse",
+    value: function onReceiveResponse(response) {
+      var state = this.filerobot.getCoreCommonState();
+      var companion = state.companion || {};
+      var host = this.companionUrl;
+      var headers = response.headers;
+
+      // Store the self-identified domain name for the Companion instance we just hit.
+      if (headers.has('i-am') && headers.get('i-am') !== companion[host]) {
+        this.filerobot.setCoreCommonState({
+          companion: _extends({}, companion, _defineProperty({}, host, headers.get('i-am')))
+        });
+      }
+      return response;
+    }
+  }, {
+    key: "_getUrl",
+    value: function _getUrl(url) {
+      if (/^(https?:|)\/\//.test(url)) {
+        return url;
+      }
+      return "".concat(this.hostname, "/").concat(url);
+    }
+  }, {
+    key: "_json",
+    value: function _json(res) {
+      if (res.status === 401) {
+        throw new AuthError();
+      }
+      if (res.status < 200 || res.status > 300) {
+        var errMsg = "Failed request with status: ".concat(res.status, ". ").concat(res.statusText);
+        return res.json().then(function (errData) {
+          errMsg = errData.message ? "".concat(errMsg, " message: ").concat(errData.message) : errMsg;
+          errMsg = errData.requestId ? "".concat(errMsg, " request-Id: ").concat(errData.requestId) : errMsg;
+          throw new Error(errMsg);
+        })["catch"](function () {
+          throw new Error(errMsg);
+        });
+      }
+      return res.json();
+    }
+  }, {
+    key: "_increaseRequestsNumber",
+    value: function _increaseRequestsNumber() {
+      this._requestsNumber++;
+    }
+  }, {
+    key: "_decreaseRequestsNumber",
+    value: function _decreaseRequestsNumber() {
+      this._requestsNumber--;
+    }
+  }, {
+    key: "_addCancelAbility",
+    value: function _addCancelAbility() {
+      this._controller = new AbortController();
+      this._signal = this._controller.signal;
+      this._requestsNumber = 0;
+    }
+  }, {
+    key: "checkIfTherePendingRequests",
+    value: function checkIfTherePendingRequests() {
+      return this._requestsNumber > 0;
+    }
+  }, {
+    key: "preflight",
+    value: function preflight(path) {
+      var _this2 = this;
+      return new Promise(function (resolve, reject) {
+        if (_this2.preflightDone) {
+          return resolve(_this2.allowedHeaders.slice());
+        }
+        _this2._increaseRequestsNumber();
+        fetch(_this2._getUrl(path), {
+          method: 'OPTIONS',
+          signal: _this2._signal
+        }).then(function (response) {
+          if (response.headers.has('access-control-allow-headers')) {
+            _this2.allowedHeaders = response.headers.get('access-control-allow-headers').split(',').map(function (headerName) {
+              return headerName.trim().toLowerCase();
+            });
+          }
+          _this2.preflightDone = true;
+          resolve(_this2.allowedHeaders.slice());
+        })["catch"](function (err) {
+          _this2.filerobot.log("[CompanionClient] unable to make preflight request ".concat(err), 'warning');
+          _this2.preflightDone = true;
+          resolve(_this2.allowedHeaders.slice());
+        })["finally"](_this2._decreaseRequestsNumber);
+      });
+    }
+  }, {
+    key: "preflightAndHeaders",
+    value: function preflightAndHeaders(path) {
+      var _this3 = this;
+      return Promise.all([this.preflight(path), this.headers()]).then(function (_ref) {
+        var _ref2 = _slicedToArray(_ref, 2),
+          allowedHeaders = _ref2[0],
+          headers = _ref2[1];
+        // filter to keep only allowed Headers
+        Object.keys(headers).forEach(function (header) {
+          if (allowedHeaders.indexOf(header.toLowerCase()) === -1) {
+            _this3.filerobot.log("[CompanionClient] excluding unallowed header ".concat(header));
+            delete headers[header];
+          }
+        });
+        return headers;
+      });
+    }
+  }, {
+    key: "get",
+    value: function get(path, skipPostResponse) {
+      var _this4 = this;
+      return new Promise(function (resolve, reject) {
+        _this4.preflightAndHeaders(path).then(function (headers) {
+          _this4._increaseRequestsNumber();
+          fetchWithNetworkError(_this4._getUrl(path), {
+            method: 'get',
+            headers: headers,
+            credentials: 'same-origin',
+            signal: _this4._signal
+          }).then(_this4._getPostResponseFunc(skipPostResponse)).then(function (res) {
+            return _this4._json(res).then(resolve);
+          })["catch"](function (err) {
+            err = err.isAuthError ? err : new Error("Could not get ".concat(_this4._getUrl(path), ". ").concat(err));
+            reject(err);
+          })["finally"](_this4._decreaseRequestsNumber);
+        })["catch"](reject);
+      });
+    }
+  }, {
+    key: "post",
+    value: function post(path, data, skipPostResponse) {
+      var _this5 = this;
+      return new Promise(function (resolve, reject) {
+        _this5.preflightAndHeaders(path).then(function (headers) {
+          _this5._increaseRequestsNumber();
+          fetchWithNetworkError(_this5._getUrl(path), {
+            method: 'post',
+            headers: headers,
+            credentials: 'same-origin',
+            body: JSON.stringify(data),
+            signal: _this5._signal
+          }).then(_this5._getPostResponseFunc(skipPostResponse)).then(function (res) {
+            return _this5._json(res).then(resolve);
+          })["catch"](function (err) {
+            err = err.isAuthError ? err : new Error("Could not post ".concat(_this5._getUrl(path), ". ").concat(err));
+            reject(err);
+          })["finally"](_this5._decreaseRequestsNumber);
+        })["catch"](reject);
+      });
+    }
+  }, {
+    key: "delete",
+    value: function _delete(path, data, skipPostResponse) {
+      var _this6 = this;
+      return new Promise(function (resolve, reject) {
+        _this6.preflightAndHeaders(path).then(function (headers) {
+          _this6._increaseRequestsNumber();
+          fetchWithNetworkError("".concat(_this6.hostname, "/").concat(path), {
+            method: 'delete',
+            headers: headers,
+            credentials: 'same-origin',
+            body: data ? JSON.stringify(data) : null,
+            signal: _this6._signal
+          }).then(_this6._getPostResponseFunc(skipPostResponse)).then(function (res) {
+            return _this6._json(res).then(resolve);
+          })["catch"](function (err) {
+            err = err.isAuthError ? err : new Error("Could not delete ".concat(_this6._getUrl(path), ". ").concat(err));
+            reject(err);
+          })["finally"](_this6._decreaseRequestsNumber);
+        })["catch"](reject);
+      });
+    }
+  }, {
+    key: "cancel",
+    value: function cancel() {
+      this._controller.abort();
+      this._addCancelAbility();
+    }
+  }]);
+}();
+export default RequestClient;

package/lib/SearchProvider.js

@@ -0,0 +1,46 @@
+'use strict';
+
+function _typeof(o) { "@babel/helpers - typeof"; return _typeof = "function" == typeof Symbol && "symbol" == typeof Symbol.iterator ? function (o) { return typeof o; } : function (o) { return o && "function" == typeof Symbol && o.constructor === Symbol && o !== Symbol.prototype ? "symbol" : typeof o; }, _typeof(o); }
+function _classCallCheck(a, n) { if (!(a instanceof n)) throw new TypeError("Cannot call a class as a function"); }
+function _defineProperties(e, r) { for (var t = 0; t < r.length; t++) { var o = r[t]; o.enumerable = o.enumerable || !1, o.configurable = !0, "value" in o && (o.writable = !0), Object.defineProperty(e, _toPropertyKey(o.key), o); } }
+function _createClass(e, r, t) { return r && _defineProperties(e.prototype, r), t && _defineProperties(e, t), Object.defineProperty(e, "prototype", { writable: !1 }), e; }
+function _toPropertyKey(t) { var i = _toPrimitive(t, "string"); return "symbol" == _typeof(i) ? i : i + ""; }
+function _toPrimitive(t, r) { if ("object" != _typeof(t) || !t) return t; var e = t[Symbol.toPrimitive]; if (void 0 !== e) { var i = e.call(t, r || "default"); if ("object" != _typeof(i)) return i; throw new TypeError("@@toPrimitive must return a primitive value."); } return ("string" === r ? String : Number)(t); }
+function _callSuper(t, o, e) { return o = _getPrototypeOf(o), _possibleConstructorReturn(t, _isNativeReflectConstruct() ? Reflect.construct(o, e || [], _getPrototypeOf(t).constructor) : o.apply(t, e)); }
+function _possibleConstructorReturn(t, e) { if (e && ("object" == _typeof(e) || "function" == typeof e)) return e; if (void 0 !== e) throw new TypeError("Derived constructors may only return object or undefined"); return _assertThisInitialized(t); }
+function _assertThisInitialized(e) { if (void 0 === e) throw new ReferenceError("this hasn't been initialised - super() hasn't been called"); return e; }
+function _isNativeReflectConstruct() { try { var t = !Boolean.prototype.valueOf.call(Reflect.construct(Boolean, [], function () {})); } catch (t) {} return (_isNativeReflectConstruct = function _isNativeReflectConstruct() { return !!t; })(); }
+function _getPrototypeOf(t) { return _getPrototypeOf = Object.setPrototypeOf ? Object.getPrototypeOf.bind() : function (t) { return t.__proto__ || Object.getPrototypeOf(t); }, _getPrototypeOf(t); }
+function _inherits(t, e) { if ("function" != typeof e && null !== e) throw new TypeError("Super expression must either be null or a function"); t.prototype = Object.create(e && e.prototype, { constructor: { value: t, writable: !0, configurable: !0 } }), Object.defineProperty(t, "prototype", { writable: !1 }), e && _setPrototypeOf(t, e); }
+function _setPrototypeOf(t, e) { return _setPrototypeOf = Object.setPrototypeOf ? Object.setPrototypeOf.bind() : function (t, e) { return t.__proto__ = e, t; }, _setPrototypeOf(t, e); }
+import RequestClient from './RequestClient';
+var getName = function getName(id) {
+  return id.split('-').map(function (s) {
+    return s.charAt(0).toUpperCase() + s.slice(1);
+  }).join(' ');
+};
+var SearchProvider = /*#__PURE__*/function (_RequestClient) {
+  function SearchProvider(filerobot, opts) {
+    var _this;
+    _classCallCheck(this, SearchProvider);
+    _this = _callSuper(this, SearchProvider, [filerobot, opts]);
+    _this.provider = opts.provider;
+    _this.id = _this.provider;
+    _this.name = _this.opts.name || getName(_this.id);
+    _this.pluginId = _this.opts.pluginId;
+    return _this;
+  }
+  _inherits(SearchProvider, _RequestClient);
+  return _createClass(SearchProvider, [{
+    key: "fileUrl",
+    value: function fileUrl(id) {
+      return "".concat(this.hostname, "/search/").concat(this.id, "/get/").concat(id);
+    }
+  }, {
+    key: "search",
+    value: function search(text, queries) {
+      return this.get("search/".concat(this.id, "/list?q=").concat(encodeURIComponent(text)).concat(queries ? "&".concat(queries) : ''));
+    }
+  }]);
+}(RequestClient);
+export { SearchProvider as default };

package/lib/Socket.js

@@ -0,0 +1,102 @@
+function _typeof(o) { "@babel/helpers - typeof"; return _typeof = "function" == typeof Symbol && "symbol" == typeof Symbol.iterator ? function (o) { return typeof o; } : function (o) { return o && "function" == typeof Symbol && o.constructor === Symbol && o !== Symbol.prototype ? "symbol" : typeof o; }, _typeof(o); }
+function _classCallCheck(a, n) { if (!(a instanceof n)) throw new TypeError("Cannot call a class as a function"); }
+function _defineProperties(e, r) { for (var t = 0; t < r.length; t++) { var o = r[t]; o.enumerable = o.enumerable || !1, o.configurable = !0, "value" in o && (o.writable = !0), Object.defineProperty(e, _toPropertyKey(o.key), o); } }
+function _createClass(e, r, t) { return r && _defineProperties(e.prototype, r), t && _defineProperties(e, t), Object.defineProperty(e, "prototype", { writable: !1 }), e; }
+function _toPropertyKey(t) { var i = _toPrimitive(t, "string"); return "symbol" == _typeof(i) ? i : i + ""; }
+function _toPrimitive(t, r) { if ("object" != _typeof(t) || !t) return t; var e = t[Symbol.toPrimitive]; if (void 0 !== e) { var i = e.call(t, r || "default"); if ("object" != _typeof(i)) return i; throw new TypeError("@@toPrimitive must return a primitive value."); } return ("string" === r ? String : Number)(t); }
+import ee from 'namespace-emitter';
+var FilerobotSocket = /*#__PURE__*/function () {
+  function FilerobotSocket(opts) {
+    _classCallCheck(this, FilerobotSocket);
+    this.opts = opts;
+    this._queued = [];
+    this.isOpen = false;
+    this.emitter = ee();
+    this._handleMessage = this._handleMessage.bind(this);
+    this.close = this.close.bind(this);
+    this.emit = this.emit.bind(this);
+    this.on = this.on.bind(this);
+    this.once = this.once.bind(this);
+    this.send = this.send.bind(this);
+    if (!opts || opts.autoOpen !== false) {
+      this.open();
+    }
+  }
+  return _createClass(FilerobotSocket, [{
+    key: "open",
+    value: function open() {
+      var _this = this;
+      this.socket = new WebSocket(this.opts.target);
+      this.socket.onopen = function (e) {
+        _this.isOpen = true;
+        while (_this._queued.length > 0 && _this.isOpen) {
+          var first = _this._queued[0];
+          _this.send(first.action, first.payload);
+          _this._queued = _this._queued.slice(1);
+        }
+      };
+      this.socket.onclose = function (e) {
+        _this.isOpen = false;
+      };
+      this.socket.onmessage = this._handleMessage;
+    }
+  }, {
+    key: "close",
+    value: function close() {
+      if (this.socket) {
+        this.socket.close();
+      }
+    }
+  }, {
+    key: "send",
+    value: function send(action, payload) {
+      // attach uuid
+
+      if (!this.socket || this.socket.readyState === WebSocket.CONNECTING) {
+        // If socket is still connecting
+        this._queued.push({
+          action: action,
+          payload: payload
+        });
+        return;
+      }
+      if (!this.isOpen) {
+        this._queued.push({
+          action: action,
+          payload: payload
+        });
+        return;
+      }
+      this.socket.send(JSON.stringify({
+        action: action,
+        payload: payload
+      }));
+    }
+  }, {
+    key: "on",
+    value: function on(action, handler) {
+      this.emitter.on(action, handler);
+    }
+  }, {
+    key: "emit",
+    value: function emit(action, payload) {
+      this.emitter.emit(action, payload);
+    }
+  }, {
+    key: "once",
+    value: function once(action, handler) {
+      this.emitter.once(action, handler);
+    }
+  }, {
+    key: "_handleMessage",
+    value: function _handleMessage(e) {
+      try {
+        var message = JSON.parse(e.data);
+        this.emit(message.action, message.payload);
+      } catch (err) {
+        console.log(err);
+      }
+    }
+  }]);
+}();
+export default FilerobotSocket;

package/lib/index.js

@@ -0,0 +1,16 @@
+'use strict';
+
+/**
+ * Manages communications with Companion
+ */
+import RequestClient from './RequestClient';
+import Provider from './Provider';
+import Socket from './Socket';
+import SearchProvider from './SearchProvider';
+export { RequestClient, Provider, Socket, SearchProvider };
+export default {
+  RequestClient: RequestClient,
+  Provider: Provider,
+  Socket: Socket,
+  SearchProvider: SearchProvider
+};