@scaleflex/widget-companion-client 4.0.6 → 4.1.0

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/lib/index.js

@@ -1,7 +1,7 @@
 'use strict';
 
-/**
- * Manages communications with Companion
+/**
+ * Manages communications with Companion
  */
 import RequestClient from './RequestClient';
 import Provider from './Provider';

package/lib/tokenStorage.js

@@ -1,7 +1,7 @@
 'use strict';
 
-/**
- * This module serves as an Async wrapper for LocalStorage
+/**
+ * This module serves as an Async wrapper for LocalStorage
  */
 var setItem = function setItem(key, value) {
   return new Promise(function (resolve) {

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.0.6",
+  "version": "4.1.0",
   "license": "MIT",
   "main": "lib/index.js",
   "types": "types/index.d.ts",
@@ -14,8 +14,8 @@
     "access": "public"
   },
   "dependencies": {
-    "@scaleflex/widget-utils": "^4.0.6",
+    "@scaleflex/widget-utils": "^4.1.0",
     "namespace-emitter": "^2.0.1"
   },
-  "gitHead": "17ad9b9abc2add9c8b52ab56e3a72108bee20a7a"
+  "gitHead": "471120d67066617a0d8824eae11b07d1f2259473"
 }

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
+}