@webex/internal-plugin-board 2.59.1 → 2.59.3-next.1

package/.eslintrc.js

@@ -1,6 +1,6 @@
-const config = {
-  root: true,
-  extends: ['@webex/eslint-config-legacy'],
-};
-
-module.exports = config;
+const config = {
+  root: true,
+  extends: ['@webex/eslint-config-legacy'],
+};
+
+module.exports = config;

package/README.md

@@ -1,42 +1,42 @@
-# @webex/internal-plugin-board
-
-[![standard-readme compliant](https://img.shields.io/badge/readme%20style-standard-brightgreen.svg?style=flat-square)](https://github.com/RichardLitt/standard-readme)
-
-> Plugin for the Board service
-
-This is an internal Cisco Webex plugin. As such, it does not strictly adhere to semantic versioning. Use at your own risk. If you're not working on one of our first party clients, please look at our [developer api](https://developer.webex.com/) and stick to our public plugins.
-
-- [Install](#install)
-- [Usage](#usage)
-- [Contribute](#contribute)
-- [Maintainers](#maintainers)
-- [License](#license)
-
-## Install
-
-```bash
-npm install --save @webex/internal-plugin-board
-```
-
-## Usage
-
-```js
-import '@webex/internal-plugin-board';
-
-import WebexCore from '@webex/webex-core';
-
-const webex = new WebexCore();
-webex.internal.board.WHATEVER;
-```
-
-## Maintainers
-
-This package is maintained by [Cisco Webex for Developers](https://developer.webex.com/).
-
-## Contribute
-
-Pull requests welcome. Please see [CONTRIBUTING.md](https://github.com/webex/webex-js-sdk/blob/master/CONTRIBUTING.md) for more details.
-
-## License
-
-© 2016-2020 Cisco and/or its affiliates. All Rights Reserved.
+# @webex/internal-plugin-board
+
+[![standard-readme compliant](https://img.shields.io/badge/readme%20style-standard-brightgreen.svg?style=flat-square)](https://github.com/RichardLitt/standard-readme)
+
+> Plugin for the Board service
+
+This is an internal Cisco Webex plugin. As such, it does not strictly adhere to semantic versioning. Use at your own risk. If you're not working on one of our first party clients, please look at our [developer api](https://developer.webex.com/) and stick to our public plugins.
+
+- [Install](#install)
+- [Usage](#usage)
+- [Contribute](#contribute)
+- [Maintainers](#maintainers)
+- [License](#license)
+
+## Install
+
+```bash
+npm install --save @webex/internal-plugin-board
+```
+
+## Usage
+
+```js
+import '@webex/internal-plugin-board';
+
+import WebexCore from '@webex/webex-core';
+
+const webex = new WebexCore();
+webex.internal.board.WHATEVER;
+```
+
+## Maintainers
+
+This package is maintained by [Cisco Webex for Developers](https://developer.webex.com/).
+
+## Contribute
+
+Pull requests welcome. Please see [CONTRIBUTING.md](https://github.com/webex/webex-js-sdk/blob/master/CONTRIBUTING.md) for more details.
+
+## License
+
+© 2016-2020 Cisco and/or its affiliates. All Rights Reserved.

package/babel.config.js

@@ -1,3 +1,3 @@
-const babelConfigLegacy = require('@webex/babel-config-legacy');
-
-module.exports = babelConfigLegacy;
+const babelConfigLegacy = require('@webex/babel-config-legacy');
+
+module.exports = babelConfigLegacy;

package/dist/board.js

@@ -31,15 +31,15 @@ var Board = _webexCore.WebexPlugin.extend({
   children: {
     realtime: _realtime.default
   },
-  /**
-   * Adds Content to a Channel
-   * If contents length is greater than config.board.numberContentsPerPageForAdd, this method
-   * will break contents into chunks and make multiple GET request to the
-   * board service
-   * @memberof Board.BoardService
-   * @param  {Board~Channel} channel
-   * @param  {Array} contents - Array of {@link Board~Content} objects
-   * @returns {Promise<Board~Content>}
+  /**
+   * Adds Content to a Channel
+   * If contents length is greater than config.board.numberContentsPerPageForAdd, this method
+   * will break contents into chunks and make multiple GET request to the
+   * board service
+   * @memberof Board.BoardService
+   * @param  {Board~Channel} channel
+   * @param  {Array} contents - Array of {@link Board~Content} objects
+   * @returns {Promise<Board~Content>}
    */
   addContent: function addContent(channel, contents) {
     var _this = this;
@@ -52,15 +52,15 @@ var Board = _webexCore.WebexPlugin.extend({
       return _this._addContentChunk.bind(_this, channel, part);
     }));
   },
-  /**
-   * Adds Image to a Channel
-   * Uploads image to webex files and adds SCR + downloadUrl to the persistence
-   * service
-   * @memberof Board.BoardService
-   * @param  {Board~Channel} channel
-   * @param  {File} image - image to be uploaded
-   * @param  {Object} metadata - metadata such as displayName
-   * @returns {Promise<Board~Content>}
+  /**
+   * Adds Image to a Channel
+   * Uploads image to webex files and adds SCR + downloadUrl to the persistence
+   * service
+   * @memberof Board.BoardService
+   * @param  {Board~Channel} channel
+   * @param  {File} image - image to be uploaded
+   * @param  {Object} metadata - metadata such as displayName
+   * @returns {Promise<Board~Content>}
    */
   addImage: function addImage(channel, image, metadata) {
     var _this2 = this;
@@ -77,12 +77,12 @@ var Board = _webexCore.WebexPlugin.extend({
       }]);
     });
   },
-  /**
-   * Set a snapshot image for a board
-   *
-   * @param {Board~Channel} channel
-   * @param {File} image
-   * @returns {Promise<Board~Channel>}
+  /**
+   * Set a snapshot image for a board
+   *
+   * @param {Board~Channel} channel
+   * @param {File} image
+   * @returns {Promise<Board~Channel>}
    */
   setSnapshotImage: function setSnapshotImage(channel, image) {
     var _this3 = this;
@@ -116,12 +116,12 @@ var Board = _webexCore.WebexPlugin.extend({
       return res.body;
     });
   },
-  /**
-   * Creates a Channel
-   * @memberof Board.BoardService
-   * @param  {Conversation~ConversationObject} conversation
-   * @param  {Board~Channel} channel
-   * @returns {Promise<Board~Channel>}
+  /**
+   * Creates a Channel
+   * @memberof Board.BoardService
+   * @param  {Conversation~ConversationObject} conversation
+   * @param  {Board~Channel} channel
+   * @returns {Promise<Board~Channel>}
    */
   createChannel: function createChannel(conversation, channel) {
     return this.webex.request({
@@ -144,14 +144,14 @@ var Board = _webexCore.WebexPlugin.extend({
       }
     }, channel);
   },
-  /**
-   * Deletes a Channel from a Conversation
-   * @memberof Board.BoardService
-   * @param  {Conversation~ConversationObject} conversation
-   * @param  {Board~Channel} channel
-   * @param  {Object} options
-   * @param  {Object} options.preventDeleteActiveChannel Returns error if channel is in use
-   * @returns {Promise}
+  /**
+   * Deletes a Channel from a Conversation
+   * @memberof Board.BoardService
+   * @param  {Conversation~ConversationObject} conversation
+   * @param  {Board~Channel} channel
+   * @param  {Object} options
+   * @param  {Object} options.preventDeleteActiveChannel Returns error if channel is in use
+   * @returns {Promise}
    */
   deleteChannel: function deleteChannel(conversation, channel) {
     var _this4 = this;
@@ -183,12 +183,12 @@ var Board = _webexCore.WebexPlugin.extend({
       return res.body;
     });
   },
-  /**
-   * Locks and marks a channel for deletion
-   * If a channel is being used, it will return 409 - Conflict
-   * @memberof Board.BoardService
-   * @param  {Board~Channel} channel
-   * @returns {Promise}
+  /**
+   * Locks and marks a channel for deletion
+   * If a channel is being used, it will return 409 - Conflict
+   * @memberof Board.BoardService
+   * @param  {Board~Channel} channel
+   * @returns {Promise}
    */
   lockChannelForDeletion: function lockChannelForDeletion(channel) {
     return this.webex.request({
@@ -201,10 +201,10 @@ var Board = _webexCore.WebexPlugin.extend({
       return res.body;
     });
   },
-  /**
-   * Keeps a channel as 'active' to prevent other people from deleting it
-   * @param  {Board~Channel} channel
-   * @returns {Promise}
+  /**
+   * Keeps a channel as 'active' to prevent other people from deleting it
+   * @param  {Board~Channel} channel
+   * @returns {Promise}
    */
   keepActive: function keepActive(channel) {
     return this.webex.request({
@@ -212,12 +212,12 @@ var Board = _webexCore.WebexPlugin.extend({
       uri: "".concat(channel.channelUrl, "/keepAlive")
     });
   },
-  /**
-   * Decrypts a collection of content objects
-   *
-   * @memberof Board.BoardService
-   * @param  {Array} contents curves, text, and images
-   * @returns {Promise<Array>} Resolves with an array of {@link Board~Content} objects.
+  /**
+   * Decrypts a collection of content objects
+   *
+   * @memberof Board.BoardService
+   * @param  {Array} contents curves, text, and images
+   * @returns {Promise<Array>} Resolves with an array of {@link Board~Content} objects.
    */
   decryptContents: function decryptContents(contents) {
     var _this5 = this;
@@ -235,24 +235,24 @@ var Board = _webexCore.WebexPlugin.extend({
       });
     }));
   },
-  /**
-   * Decryts a single STRING content object
-   * @memberof Board.BoardService
-   * @param  {string} encryptionKeyUrl
-   * @param  {string} encryptedData
-   * @returns {Promise<Board~Content>}
+  /**
+   * Decryts a single STRING content object
+   * @memberof Board.BoardService
+   * @param  {string} encryptionKeyUrl
+   * @param  {string} encryptedData
+   * @returns {Promise<Board~Content>}
    */
   decryptSingleContent: function decryptSingleContent(encryptionKeyUrl, encryptedData) {
     return this.webex.internal.encryption.decryptText(encryptionKeyUrl, encryptedData).then(function (res) {
       return JSON.parse(res);
     });
   },
-  /**
-   * Decryts a single FILE content object
-   * @memberof Board.BoardService
-   * @param  {string} encryptionKeyUrl
-   * @param  {object} encryptedContent {file, payload}
-   * @returns {Promise<Board~Content>}
+  /**
+   * Decryts a single FILE content object
+   * @memberof Board.BoardService
+   * @param  {string} encryptionKeyUrl
+   * @param  {object} encryptedContent {file, payload}
+   * @returns {Promise<Board~Content>}
    */
   decryptSingleFileContent: function decryptSingleFileContent(encryptionKeyUrl, encryptedContent) {
     var _this6 = this;
@@ -278,11 +278,11 @@ var Board = _webexCore.WebexPlugin.extend({
       return encryptedContent;
     });
   },
-  /**
-   * Deletes all Content from a Channel
-   * @memberof Board.BoardService
-   * @param  {Board~Channel} channel
-   * @returns {Promise} Resolves with an content response
+  /**
+   * Deletes all Content from a Channel
+   * @memberof Board.BoardService
+   * @param  {Board~Channel} channel
+   * @returns {Promise} Resolves with an content response
    */
   deleteAllContent: function deleteAllContent(channel) {
     return this.webex.request({
@@ -292,12 +292,12 @@ var Board = _webexCore.WebexPlugin.extend({
       return res.body;
     });
   },
-  /**
-   * Deletes Contents from a Channel except the ones listed in contentsToKeep
-   * @memberof Board.BoardService
-   * @param  {Board~Channel} channel
-   * @param  {Array<Board~Content>} contentsToKeep Array of board objects (curves, text, and images) with valid contentId (received from server)
-   * @returns {Promise} Resolves with an content response
+  /**
+   * Deletes Contents from a Channel except the ones listed in contentsToKeep
+   * @memberof Board.BoardService
+   * @param  {Board~Channel} channel
+   * @param  {Array<Board~Content>} contentsToKeep Array of board objects (curves, text, and images) with valid contentId (received from server)
+   * @returns {Promise} Resolves with an content response
    */
   deletePartialContent: function deletePartialContent(channel, contentsToKeep) {
     var body = contentsToKeep.map(function (content) {
@@ -314,12 +314,12 @@ var Board = _webexCore.WebexPlugin.extend({
       return res.body;
     });
   },
-  /**
-   * Encrypts a collection of content
-   * @memberof Board.BoardService
-   * @param  {string} encryptionKeyUrl channel.defaultEncryptionKeyUrl
-   * @param  {Array} contents   Array of {@link Board~Content} objects. (curves, text, and images)
-   * @returns {Promise<Array>} Resolves with an array of encrypted {@link Board~Content} objects.
+  /**
+   * Encrypts a collection of content
+   * @memberof Board.BoardService
+   * @param  {string} encryptionKeyUrl channel.defaultEncryptionKeyUrl
+   * @param  {Array} contents   Array of {@link Board~Content} objects. (curves, text, and images)
+   * @returns {Promise<Array>} Resolves with an array of encrypted {@link Board~Content} objects.
    */
   encryptContents: function encryptContents(encryptionKeyUrl, contents) {
     var _this7 = this;
@@ -343,12 +343,12 @@ var Board = _webexCore.WebexPlugin.extend({
       });
     }));
   },
-  /**
-   * Encrypts a single STRING content object
-   * @memberof Board.BoardService
-   * @param  {string} encryptionKeyUrl
-   * @param  {Board~Content} content
-   * @returns {Promise<Board~Content>}
+  /**
+   * Encrypts a single STRING content object
+   * @memberof Board.BoardService
+   * @param  {string} encryptionKeyUrl
+   * @param  {Board~Content} content
+   * @returns {Promise<Board~Content>}
    */
   encryptSingleContent: function encryptSingleContent(encryptionKeyUrl, content) {
     return this.webex.internal.encryption.encryptText(encryptionKeyUrl, (0, _stringify.default)(content)).then(function (res) {
@@ -358,12 +358,12 @@ var Board = _webexCore.WebexPlugin.extend({
       };
     });
   },
-  /**
-   * Encrypts a single FILE content object
-   * @memberof Board.BoardService
-   * @param  {string} encryptionKeyUrl
-   * @param  {Board~Content} content
-   * @returns {Promise<Board~Content>}
+  /**
+   * Encrypts a single FILE content object
+   * @memberof Board.BoardService
+   * @param  {string} encryptionKeyUrl
+   * @param  {Board~Content} content
+   * @returns {Promise<Board~Content>}
    */
   encryptSingleFileContent: function encryptSingleFileContent(encryptionKeyUrl, content) {
     var _this8 = this;
@@ -388,13 +388,13 @@ var Board = _webexCore.WebexPlugin.extend({
       };
     });
   },
-  /**
-   * Retrieves contents from a specified channel
-   * @memberof Board.BoardService
-   * @param  {Board~Channel} channel
-   * @param  {Object} options
-   * @param  {Object} options.qs
-   * @returns {Promise<Page<Board~Channel>>} Resolves with an array of Content items
+  /**
+   * Retrieves contents from a specified channel
+   * @memberof Board.BoardService
+   * @param  {Board~Channel} channel
+   * @param  {Object} options
+   * @param  {Object} options.qs
+   * @returns {Promise<Page<Board~Channel>>} Resolves with an array of Content items
    */
   getContents: function getContents(channel, options) {
     var _this9 = this;
@@ -410,11 +410,11 @@ var Board = _webexCore.WebexPlugin.extend({
       return new _webexCore.Page(res, _this9.webex);
     });
   },
-  /**
-   * Gets a Channel
-   * @memberof Board.BoardService
-   * @param  {Board~Channel} channel
-   * @returns {Promise<Board~Channel>}
+  /**
+   * Gets a Channel
+   * @memberof Board.BoardService
+   * @param  {Board~Channel} channel
+   * @returns {Promise<Board~Channel>}
    */
   getChannel: function getChannel(channel) {
     return this.webex.request({
@@ -424,14 +424,14 @@ var Board = _webexCore.WebexPlugin.extend({
       return res.body;
     });
   },
-  /**
-   * Gets Channels
-   * @memberof Board.BoardService
-   * @param {Conversation~ConversationObject} conversation
-   * @param {Object} options
-   * @param {number} options.channelsLimit number of boards to return per page
-   * @param {number} options.type type of whiteboard: whiteboard or annotated
-   * @returns {Promise<Page<Board~Channel>>} Resolves with an array of Channel items
+  /**
+   * Gets Channels
+   * @memberof Board.BoardService
+   * @param {Conversation~ConversationObject} conversation
+   * @param {Object} options
+   * @param {number} options.channelsLimit number of boards to return per page
+   * @param {number} options.type type of whiteboard: whiteboard or annotated
+   * @returns {Promise<Page<Board~Channel>>} Resolves with an array of Channel items
    */
   getChannels: function getChannels(conversation, options) {
     var _this10 = this;
@@ -451,10 +451,10 @@ var Board = _webexCore.WebexPlugin.extend({
       return new _webexCore.Page(res, _this10.webex);
     });
   },
-  /**
-   * Pings persistence
-   * @memberof Board.BoardService
-   * @returns {Promise<Object>} ping response body
+  /**
+   * Pings persistence
+   * @memberof Board.BoardService
+   * @returns {Promise<Object>} ping response body
    */
   ping: function ping() {
     return this.webex.request({
@@ -478,11 +478,11 @@ var Board = _webexCore.WebexPlugin.extend({
       return message;
     });
   },
-  /**
-   * Registers with Mercury
-   * @memberof Board.BoardService
-   * @param  {Object} data - Mercury bindings
-   * @returns {Promise<Board~Registration>}
+  /**
+   * Registers with Mercury
+   * @memberof Board.BoardService
+   * @param  {Object} data - Mercury bindings
+   * @returns {Promise<Board~Registration>}
    */
   register: function register(data) {
     return this.webex.request({
@@ -494,11 +494,11 @@ var Board = _webexCore.WebexPlugin.extend({
       return res.body;
     });
   },
-  /**
-   * Registers with Mercury for sharing web socket
-   * @memberof Board.BoardService
-   * @param  {Board~Channel} channel
-   * @returns {Promise<Board~Registration>}
+  /**
+   * Registers with Mercury for sharing web socket
+   * @memberof Board.BoardService
+   * @param  {Board~Channel} channel
+   * @returns {Promise<Board~Registration>}
    */
   registerToShareMercury: function registerToShareMercury(channel) {
     var _this11 = this;
@@ -525,12 +525,12 @@ var Board = _webexCore.WebexPlugin.extend({
       return res.body;
     });
   },
-  /**
-   * Remove board binding from existing mercury connection
-   * @memberof Board.BoardService
-   * @param  {Board~Channel} channel
-   * @param  {String} binding - the binding as provided in board registration
-   * @returns {Promise<Board~Registration>}
+  /**
+   * Remove board binding from existing mercury connection
+   * @memberof Board.BoardService
+   * @param  {Board~Channel} channel
+   * @param  {String} binding - the binding as provided in board registration
+   * @returns {Promise<Board~Registration>}
    */
   unregisterFromSharedMercury: function unregisterFromSharedMercury(channel, binding) {
     var webSocketUrl = this.webex.internal.device.webSocketUrl;
@@ -559,15 +559,15 @@ var Board = _webexCore.WebexPlugin.extend({
       return res.body;
     });
   },
-  /**
-   * Encrypts and uploads image to WebexFiles
-   * @memberof Board.BoardService
-   * @param  {Board~Channel} channel
-   * @param  {File} file - File to be uploaded
-   * @param  {Object} options
-   * @param  {Object} options.hiddenSpace - true for hidden, false for open space
-   * @private
-   * @returns {Object} Encrypted Scr and KeyUrl
+  /**
+   * Encrypts and uploads image to WebexFiles
+   * @memberof Board.BoardService
+   * @param  {Board~Channel} channel
+   * @param  {File} file - File to be uploaded
+   * @param  {Object} options
+   * @param  {Object} options.hiddenSpace - true for hidden, false for open space
+   * @private
+   * @returns {Object} Encrypted Scr and KeyUrl
    */
   _uploadImage: function _uploadImage(channel, file, options) {
     var _this13 = this;
@@ -628,11 +628,11 @@ var Board = _webexCore.WebexPlugin.extend({
       });
     });
   },
-  /** Authorize transcoder (for sharing whiteboard to mobile)
-   *
-   * @param  {Board~Channel} board
-   * @memberof Board.BoardService
-   * @returns {String} authorization
+  /** Authorize transcoder (for sharing whiteboard to mobile)
+   *
+   * @param  {Board~Channel} board
+   * @memberof Board.BoardService
+   * @returns {String} authorization
    */
   authorizeMediaInjector: function authorizeMediaInjector(board) {
     var _this15 = this;
@@ -661,18 +661,18 @@ var Board = _webexCore.WebexPlugin.extend({
       return undefined;
     }).catch(function (err) {
       return (
-        /* We want to resolve any errors so that whiteboard share will still work
-         * except mobile being able to receive the share
+        /* We want to resolve any errors so that whiteboard share will still work
+         * except mobile being able to receive the share
          */
         _promise.default.resolve(err)
       );
     });
   },
-  /** Unauthorize transcoder (for stopping whiteboard share to mobile)
-   *
-   * @param  {Board~Channel} board
-   * @memberof Board.BoardService
-   * @returns {Array} list of authIds removed
+  /** Unauthorize transcoder (for stopping whiteboard share to mobile)
+   *
+   * @param  {Board~Channel} board
+   * @memberof Board.BoardService
+   * @returns {Array} list of authIds removed
    */
   unauthorizeMediaInjector: function unauthorizeMediaInjector(board) {
     var _this16 = this;
@@ -682,8 +682,8 @@ var Board = _webexCore.WebexPlugin.extend({
     return this.webex.internal.encryption.kms.listAuthorizations({
       kroUri: board.kmsResourceUrl
     }).then(function (authorizations) {
-      /* Attempt to remove the authorization made from starting whiteboard share
-       * Also removing any previous authorizations that were not cleared
+      /* Attempt to remove the authorization made from starting whiteboard share
+       * Also removing any previous authorizations that were not cleared
        */
       var promises = authorizations.map(function (auth) {
         var authId = auth.authId;
@@ -694,8 +694,8 @@ var Board = _webexCore.WebexPlugin.extend({
           return _promise.default.resolve(authId);
         }).catch(function (err) {
           return (
-            /* We don't want this to error out, otherwise the
-             * Promise.all will not process the rest of the request
+            /* We don't want this to error out, otherwise the
+             * Promise.all will not process the rest of the request
              */
             _promise.default.resolve(err)
           );
@@ -709,7 +709,7 @@ var Board = _webexCore.WebexPlugin.extend({
       return _promise.default.resolve([]);
     });
   },
-  version: "2.59.1"
+  version: "2.59.0"
 });
 var _default = Board;
 exports.default = _default;