@scaleflex/widget-companion-client 4.8.4 → 4.8.6

package/LICENSE

@@ -1,21 +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.
+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

@@ -1,33 +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://assets.scaleflex.com/Corporate+Branding/%5B2025%5D+ALL+LOGOS+%2B+ICONS/SCALEFLEX/VXP+logo/Horizontal+White/VXP+logo+WHITE.png?vh=663932" 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/p/sandbox/scalelfex-widget-v4-sandbox-dtp6l3?file=%2Fsrc%2Findex.js
-
-
-[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
+# @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://assets.scaleflex.com/Corporate+Branding/%5B2025%5D+ALL+LOGOS+%2B+ICONS/SCALEFLEX/VXP+logo/Horizontal+White/VXP+logo+WHITE.png?vh=663932" 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/p/sandbox/scalelfex-widget-v4-sandbox-dtp6l3?file=%2Fsrc%2Findex.js
+
+
+[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/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@scaleflex/widget-companion-client",
   "description": "Client library for communication with Companion. Intended for use in Scaleflex plugins.",
-  "version": "4.8.4",
+  "version": "4.8.6",
   "license": "MIT",
   "main": "lib/index.js",
   "types": "types/index.d.ts",
@@ -14,8 +14,8 @@
     "access": "public"
   },
   "dependencies": {
-    "@scaleflex/widget-utils": "^4.8.4",
+    "@scaleflex/widget-utils": "^4.8.6",
     "namespace-emitter": "^2.0.1"
   },
-  "gitHead": "1b8c9f44e43bb143b8c1f2abae60da740c660729"
+  "gitHead": "cbb232cc92583c3888556df91ff90b4654e64790"
 }

package/types/index.d.ts

@@ -1,65 +1,65 @@
-/**
- * Async storage interface, similar to `localStorage`. This can be used to
- * implement custom storages for authentication tokens.
- */
-export interface TokenStorage {
-  setItem: (key: string, value: string) => Promise<void>
-  getItem: (key: string) => Promise<string>
-  removeItem: (key: string) => Promise<void>
-}
-
-export interface RequestClientOptions {
-  companionUrl: string
-  companionHeaders?: object
-}
-
-export class RequestClient {
-  constructor (filerobot: any, opts: RequestClientOptions)
-  get (path: string): Promise<any>
-  post (path: string, data: object): Promise<any>
-  delete (path: string, data: object): Promise<any>
-}
-
-/**
- * Options for Providers that can be passed in by Filerobot users through
- * Plugin constructors.
- */
-export interface PublicProviderOptions extends RequestClientOptions {
-  companionAllowedHosts?: string | RegExp | Array<string | RegExp>
-}
-
-/**
- * Options for Providers, including internal options that Plugins can set.
- */
-export interface ProviderOptions extends PublicProviderOptions {
-  provider: string
-  name?: string
-  pluginId: string
-}
-
-export class Provider extends RequestClient {
-  constructor (filerobot: any, opts: ProviderOptions)
-  checkAuth (): Promise<boolean>
-  authUrl (): string
-  fileUrl (id: string): string
-  list (directory: string): Promise<any>
-  logout (redirect?: string): Promise<any>
-  static initPlugin (plugin: any, opts: object, defaultOpts?: object): void
-}
-
-export interface SocketOptions {
-  target: string
-  autoOpen?: boolean
-}
-
-export class Socket {
-  isOpen: boolean
-
-  constructor (opts: SocketOptions)
-  open (): void
-  close (): void
-  send (action: string, payload: any): void
-  on (action: string, handler: (param: any) => void): void
-  once (action: string, handler: (param: any) => void): void
-  emit (action: string, payload: (param: any) => void): void
-}
+/**
+ * Async storage interface, similar to `localStorage`. This can be used to
+ * implement custom storages for authentication tokens.
+ */
+export interface TokenStorage {
+  setItem: (key: string, value: string) => Promise<void>
+  getItem: (key: string) => Promise<string>
+  removeItem: (key: string) => Promise<void>
+}
+
+export interface RequestClientOptions {
+  companionUrl: string
+  companionHeaders?: object
+}
+
+export class RequestClient {
+  constructor (filerobot: any, opts: RequestClientOptions)
+  get (path: string): Promise<any>
+  post (path: string, data: object): Promise<any>
+  delete (path: string, data: object): Promise<any>
+}
+
+/**
+ * Options for Providers that can be passed in by Filerobot users through
+ * Plugin constructors.
+ */
+export interface PublicProviderOptions extends RequestClientOptions {
+  companionAllowedHosts?: string | RegExp | Array<string | RegExp>
+}
+
+/**
+ * Options for Providers, including internal options that Plugins can set.
+ */
+export interface ProviderOptions extends PublicProviderOptions {
+  provider: string
+  name?: string
+  pluginId: string
+}
+
+export class Provider extends RequestClient {
+  constructor (filerobot: any, opts: ProviderOptions)
+  checkAuth (): Promise<boolean>
+  authUrl (): string
+  fileUrl (id: string): string
+  list (directory: string): Promise<any>
+  logout (redirect?: string): Promise<any>
+  static initPlugin (plugin: any, opts: object, defaultOpts?: object): void
+}
+
+export interface SocketOptions {
+  target: string
+  autoOpen?: boolean
+}
+
+export class Socket {
+  isOpen: boolean
+
+  constructor (opts: SocketOptions)
+  open (): void
+  close (): void
+  send (action: string, payload: any): void
+  on (action: string, handler: (param: any) => void): void
+  once (action: string, handler: (param: any) => void): void
+  emit (action: string, payload: (param: any) => void): void
+}

package/lib/AuthError.js

@@ -1,31 +0,0 @@
-'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

@@ -1,117 +0,0 @@
-'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;