@webex/internal-plugin-board 3.0.0-beta.4 → 3.0.0-beta.400

package/README.md

@@ -21,14 +21,12 @@ 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
-
+webex.internal.board.WHATEVER;
 ```
 
 ## Maintainers

package/dist/board.js

@@ -1,50 +1,36 @@
 "use strict";
 
+var _Object$keys = require("@babel/runtime-corejs2/core-js/object/keys");
+var _Object$getOwnPropertySymbols = require("@babel/runtime-corejs2/core-js/object/get-own-property-symbols");
+var _Object$getOwnPropertyDescriptor = require("@babel/runtime-corejs2/core-js/object/get-own-property-descriptor");
+var _Object$getOwnPropertyDescriptors = require("@babel/runtime-corejs2/core-js/object/get-own-property-descriptors");
+var _Object$defineProperties = require("@babel/runtime-corejs2/core-js/object/define-properties");
 var _Object$defineProperty = require("@babel/runtime-corejs2/core-js/object/define-property");
-
 var _interopRequireDefault = require("@babel/runtime-corejs2/helpers/interopRequireDefault");
-
 _Object$defineProperty(exports, "__esModule", {
   value: true
 });
-
 exports.default = void 0;
-
-var _assign2 = _interopRequireDefault(require("@babel/runtime-corejs2/core-js/object/assign"));
-
 var _promise = _interopRequireDefault(require("@babel/runtime-corejs2/core-js/promise"));
-
 var _deleteProperty = _interopRequireDefault(require("@babel/runtime-corejs2/core-js/reflect/delete-property"));
-
 var _stringify = _interopRequireDefault(require("@babel/runtime-corejs2/core-js/json/stringify"));
-
 var _slicedToArray2 = _interopRequireDefault(require("@babel/runtime-corejs2/helpers/slicedToArray"));
-
+var _defineProperty2 = _interopRequireDefault(require("@babel/runtime-corejs2/helpers/defineProperty"));
 var _pick2 = _interopRequireDefault(require("lodash/pick"));
-
 var _chunk2 = _interopRequireDefault(require("lodash/chunk"));
-
 var _defaults2 = _interopRequireDefault(require("lodash/defaults"));
-
-var _assign3 = _interopRequireDefault(require("lodash/assign"));
-
+var _assign2 = _interopRequireDefault(require("lodash/assign"));
 var _querystring = _interopRequireDefault(require("querystring"));
-
 var _webexCore = require("@webex/webex-core");
-
 var _es6PromiseSeries = _interopRequireDefault(require("es6-promise-series"));
-
 var _realtime = _interopRequireDefault(require("./realtime"));
-
-/*!
- * Copyright (c) 2015-2022 Cisco Systems, Inc. See LICENSE file.
- */
+function ownKeys(object, enumerableOnly) { var keys = _Object$keys(object); if (_Object$getOwnPropertySymbols) { var symbols = _Object$getOwnPropertySymbols(object); enumerableOnly && (symbols = symbols.filter(function (sym) { return _Object$getOwnPropertyDescriptor(object, sym).enumerable; })), keys.push.apply(keys, symbols); } return keys; }
+function _objectSpread(target) { for (var i = 1; i < arguments.length; i++) { var source = null != arguments[i] ? arguments[i] : {}; i % 2 ? ownKeys(Object(source), !0).forEach(function (key) { (0, _defineProperty2.default)(target, key, source[key]); }) : _Object$getOwnPropertyDescriptors ? _Object$defineProperties(target, _Object$getOwnPropertyDescriptors(source)) : ownKeys(Object(source)).forEach(function (key) { _Object$defineProperty(target, key, _Object$getOwnPropertyDescriptor(source, key)); }); } return target; }
 var Board = _webexCore.WebexPlugin.extend({
   namespace: 'Board',
   children: {
     realtime: _realtime.default
   },
-
   /**
    * Adds Content to a Channel
    * If contents length is greater than config.board.numberContentsPerPageForAdd, this method
@@ -57,16 +43,15 @@ var Board = _webexCore.WebexPlugin.extend({
    */
   addContent: function addContent(channel, contents) {
     var _this = this;
-
     var chunks = [];
-    chunks = (0, _chunk2.default)(contents, this.config.numberContentsPerPageForAdd); // we want the first promise to resolve before continuing with the next
-    // chunk or else we'll have race conditions among patches
+    chunks = (0, _chunk2.default)(contents, this.config.numberContentsPerPageForAdd);
 
+    // we want the first promise to resolve before continuing with the next
+    // chunk or else we'll have race conditions among patches
     return (0, _es6PromiseSeries.default)(chunks.map(function (part) {
       return _this._addContentChunk.bind(_this, channel, part);
     }));
   },
-
   /**
    * Adds Image to a Channel
    * Uploads image to webex files and adds SCR + downloadUrl to the persistence
@@ -79,7 +64,6 @@ var Board = _webexCore.WebexPlugin.extend({
    */
   addImage: function addImage(channel, image, metadata) {
     var _this2 = this;
-
     return this.webex.internal.board._uploadImage(channel, image).then(function (scr) {
       return _this2.webex.internal.board.addContent(channel, [{
         type: 'FILE',
@@ -93,7 +77,6 @@ var Board = _webexCore.WebexPlugin.extend({
       }]);
     });
   },
-
   /**
    * Set a snapshot image for a board
    *
@@ -103,7 +86,6 @@ var Board = _webexCore.WebexPlugin.extend({
    */
   setSnapshotImage: function setSnapshotImage(channel, image) {
     var _this3 = this;
-
     var imageScr;
     return this.webex.internal.board._uploadImage(channel, image, {
       hiddenSpace: true
@@ -134,7 +116,6 @@ var Board = _webexCore.WebexPlugin.extend({
       return res.body;
     });
   },
-
   /**
    * Creates a Channel
    * @memberof Board.BoardService
@@ -152,18 +133,31 @@ var Board = _webexCore.WebexPlugin.extend({
       return res.body;
     });
   },
-  _prepareChannel: function _prepareChannel(conversation, channel) {
-    return (0, _assign2.default)({
+  /**
+   * Prepare a create request body to the board services based on the provided
+   * conversation and channel.
+   *
+   * @param {Conversation} conversation - Conversation object.
+   * @param {Channel} channel - Channel Object
+   * @returns {Object} - Create channel request body.
+   */
+  _prepareChannel: function _prepareChannel() {
+    var conversation = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : {};
+    var channel = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : {};
+    var results = _objectSpread({
       aclUrlLink: conversation.aclUrl,
       kmsMessage: {
         method: 'create',
         uri: '/resources',
-        userIds: [conversation.kmsResourceObjectUrl],
+        userIds: [],
         keyUris: []
       }
     }, channel);
+    if (conversation.kmsResourceObjectUrl) {
+      results.kmsMessage.userIds.push(conversation.kmsResourceObjectUrl);
+    }
+    return results;
   },
-
   /**
    * Deletes a Channel from a Conversation
    * @memberof Board.BoardService
@@ -175,7 +169,6 @@ var Board = _webexCore.WebexPlugin.extend({
    */
   deleteChannel: function deleteChannel(conversation, channel) {
     var _this4 = this;
-
     var options = arguments.length > 2 && arguments[2] !== undefined ? arguments[2] : {};
     // remove the ACL link between conversation and board
     // remove conversation auth from board KRO in kms message
@@ -190,13 +183,10 @@ var Board = _webexCore.WebexPlugin.extend({
       },
       aclLinkOperation: 'DELETE'
     };
-
     var promise = _promise.default.resolve();
-
     if (options.preventDeleteActiveChannel) {
       promise = this.lockChannelForDeletion(channel);
     }
-
     return promise.then(function () {
       return _this4.webex.request({
         method: 'PUT',
@@ -207,7 +197,6 @@ 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
@@ -226,7 +215,6 @@ var Board = _webexCore.WebexPlugin.extend({
       return res.body;
     });
   },
-
   /**
    * Keeps a channel as 'active' to prevent other people from deleting it
    * @param  {Board~Channel} channel
@@ -238,7 +226,6 @@ var Board = _webexCore.WebexPlugin.extend({
       uri: "".concat(channel.channelUrl, "/keepAlive")
     });
   },
-
   /**
    * Decrypts a collection of content objects
    *
@@ -248,16 +235,13 @@ var Board = _webexCore.WebexPlugin.extend({
    */
   decryptContents: function decryptContents(contents) {
     var _this5 = this;
-
     return _promise.default.all(contents.items.map(function (content) {
       var decryptPromise;
-
       if (content.type === 'FILE') {
         decryptPromise = _this5.decryptSingleFileContent(content.encryptionKeyUrl, content);
       } else {
         decryptPromise = _this5.decryptSingleContent(content.encryptionKeyUrl, content.payload);
       }
-
       return decryptPromise.then(function (res) {
         (0, _deleteProperty.default)(content, 'payload');
         (0, _deleteProperty.default)(content, 'encryptionKeyUrl');
@@ -265,7 +249,6 @@ var Board = _webexCore.WebexPlugin.extend({
       });
     }));
   },
-
   /**
    * Decryts a single STRING content object
    * @memberof Board.BoardService
@@ -278,7 +261,6 @@ var Board = _webexCore.WebexPlugin.extend({
       return JSON.parse(res);
     });
   },
-
   /**
    * Decryts a single FILE content object
    * @memberof Board.BoardService
@@ -288,36 +270,28 @@ var Board = _webexCore.WebexPlugin.extend({
    */
   decryptSingleFileContent: function decryptSingleFileContent(encryptionKeyUrl, encryptedContent) {
     var _this6 = this;
-
     var metadata;
-
     if (encryptedContent.payload) {
       metadata = encryptedContent.payload;
     }
-
     return this.webex.internal.encryption.decryptScr(encryptionKeyUrl, encryptedContent.file.scr).then(function (scr) {
       encryptedContent.file.scr = scr;
-
       if (metadata) {
         return _this6.webex.internal.encryption.decryptText(encryptionKeyUrl, metadata);
       }
-
       return '';
     }).then(function (decryptedMetadata) {
       try {
         encryptedContent.metadata = JSON.parse(decryptedMetadata);
-
         if (encryptedContent.metadata.displayName) {
           encryptedContent.displayName = encryptedContent.metadata.displayName;
         }
       } catch (error) {
         encryptedContent.metadata = {};
       }
-
       return encryptedContent;
     });
   },
-
   /**
    * Deletes all Content from a Channel
    * @memberof Board.BoardService
@@ -332,9 +306,10 @@ var Board = _webexCore.WebexPlugin.extend({
       return res.body;
     });
   },
-
   /**
    * Deletes Contents from a Channel except the ones listed in contentsToKeep
+   *
+   * THIS API HAS CHANGED!!! SEE SPARK-412694. NEEDS UPDATING.
    * @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)
@@ -355,7 +330,6 @@ var Board = _webexCore.WebexPlugin.extend({
       return res.body;
     });
   },
-
   /**
    * Encrypts a collection of content
    * @memberof Board.BoardService
@@ -365,20 +339,19 @@ var Board = _webexCore.WebexPlugin.extend({
    */
   encryptContents: function encryptContents(encryptionKeyUrl, contents) {
     var _this7 = this;
-
     return _promise.default.all(contents.map(function (content) {
       var encryptionPromise;
-      var contentType = 'STRING'; // the existence of an scr will determine if the content is a FILE.
+      var contentType = 'STRING';
 
+      // the existence of an scr will determine if the content is a FILE.
       if (content.file) {
         contentType = 'FILE';
         encryptionPromise = _this7.encryptSingleFileContent(encryptionKeyUrl, content);
       } else {
         encryptionPromise = _this7.encryptSingleContent(encryptionKeyUrl, content);
       }
-
       return encryptionPromise.then(function (res) {
-        return (0, _assign3.default)({
+        return (0, _assign2.default)({
           device: _this7.webex.internal.device.deviceType,
           type: contentType,
           encryptionKeyUrl: encryptionKeyUrl
@@ -386,7 +359,6 @@ var Board = _webexCore.WebexPlugin.extend({
       });
     }));
   },
-
   /**
    * Encrypts a single STRING content object
    * @memberof Board.BoardService
@@ -402,7 +374,6 @@ var Board = _webexCore.WebexPlugin.extend({
       };
     });
   },
-
   /**
    * Encrypts a single FILE content object
    * @memberof Board.BoardService
@@ -412,22 +383,18 @@ var Board = _webexCore.WebexPlugin.extend({
    */
   encryptSingleFileContent: function encryptSingleFileContent(encryptionKeyUrl, content) {
     var _this8 = this;
-
     return this.webex.internal.encryption.encryptScr(encryptionKeyUrl, content.file.scr).then(function (encryptedScr) {
       content.file.scr = encryptedScr;
-
       if (content.displayName) {
-        content.metadata = (0, _assign3.default)(content.metadata, {
+        content.metadata = (0, _assign2.default)(content.metadata, {
           displayName: content.displayName
         });
       }
-
       if (content.metadata) {
         return _this8.webex.internal.encryption.encryptText(encryptionKeyUrl, (0, _stringify.default)(content.metadata)).then(function (encryptedMetadata) {
           content.metadata = encryptedMetadata;
         });
       }
-
       return content;
     }).then(function () {
       return {
@@ -437,7 +404,6 @@ var Board = _webexCore.WebexPlugin.extend({
       };
     });
   },
-
   /**
    * Retrieves contents from a specified channel
    * @memberof Board.BoardService
@@ -448,7 +414,6 @@ var Board = _webexCore.WebexPlugin.extend({
    */
   getContents: function getContents(channel, options) {
     var _this9 = this;
-
     options = options || {};
     var params = {
       uri: "".concat(channel.channelUrl, "/contents"),
@@ -456,12 +421,11 @@ var Board = _webexCore.WebexPlugin.extend({
         contentsLimit: this.config.numberContentsPerPageForGet
       }
     };
-    (0, _assign3.default)(params.qs, (0, _pick2.default)(options, 'contentsLimit'));
+    (0, _assign2.default)(params.qs, (0, _pick2.default)(options, 'contentsLimit'));
     return this.request(params).then(function (res) {
       return new _webexCore.Page(res, _this9.webex);
     });
   },
-
   /**
    * Gets a Channel
    * @memberof Board.BoardService
@@ -476,7 +440,6 @@ var Board = _webexCore.WebexPlugin.extend({
       return res.body;
     });
   },
-
   /**
    * Gets Channels
    * @memberof Board.BoardService
@@ -488,13 +451,10 @@ var Board = _webexCore.WebexPlugin.extend({
    */
   getChannels: function getChannels(conversation, options) {
     var _this10 = this;
-
     options = options || {};
-
     if (!conversation) {
       return _promise.default.reject(new Error('`conversation` is required'));
     }
-
     var params = {
       api: 'board',
       resource: '/channels',
@@ -502,12 +462,11 @@ var Board = _webexCore.WebexPlugin.extend({
         aclUrlLink: conversation.aclUrl
       }
     };
-    (0, _assign3.default)(params.qs, (0, _pick2.default)(options, 'channelsLimit', 'type'));
+    (0, _assign2.default)(params.qs, (0, _pick2.default)(options, 'channelsLimit', 'type'));
     return this.request(params).then(function (res) {
       return new _webexCore.Page(res, _this10.webex);
     });
   },
-
   /**
    * Pings persistence
    * @memberof Board.BoardService
@@ -524,20 +483,17 @@ var Board = _webexCore.WebexPlugin.extend({
   },
   processActivityEvent: function processActivityEvent(message) {
     var decryptionPromise;
-
     if (message.contentType === 'FILE') {
       decryptionPromise = this.decryptSingleFileContent(message.envelope.encryptionKeyUrl, message.payload);
     } else {
       decryptionPromise = this.decryptSingleContent(message.envelope.encryptionKeyUrl, message.payload);
     }
-
     return decryptionPromise.then(function (decryptedData) {
       // call the event handlers
       message.payload = decryptedData;
       return message;
     });
   },
-
   /**
    * Registers with Mercury
    * @memberof Board.BoardService
@@ -554,7 +510,6 @@ var Board = _webexCore.WebexPlugin.extend({
       return res.body;
     });
   },
-
   /**
    * Registers with Mercury for sharing web socket
    * @memberof Board.BoardService
@@ -563,16 +518,13 @@ var Board = _webexCore.WebexPlugin.extend({
    */
   registerToShareMercury: function registerToShareMercury(channel) {
     var _this11 = this;
-
     return this.webex.internal.feature.getFeature('developer', 'web-shared-mercury').then(function (isSharingMercuryFeatureEnabled) {
       if (!_this11.webex.internal.mercury.localClusterServiceUrls) {
         return _promise.default.reject(new Error('`localClusterServiceUrls` is not defined, make sure mercury is connected'));
       }
-
       if (!isSharingMercuryFeatureEnabled) {
         return _promise.default.reject(new Error('`web-shared-mercury` is not enabled'));
       }
-
       var webSocketUrl = _this11.webex.internal.device.webSocketUrl;
       var mercuryConnectionServiceClusterUrl = _this11.webex.internal.mercury.localClusterServiceUrls.mercuryConnectionServiceClusterUrl;
       var data = {
@@ -589,7 +541,6 @@ var Board = _webexCore.WebexPlugin.extend({
       return res.body;
     });
   },
-
   /**
    * Remove board binding from existing mercury connection
    * @memberof Board.BoardService
@@ -614,7 +565,6 @@ var Board = _webexCore.WebexPlugin.extend({
   },
   _addContentChunk: function _addContentChunk(channel, contentChunk) {
     var _this12 = this;
-
     return this.webex.internal.board.encryptContents(channel.defaultEncryptionKeyUrl, contentChunk).then(function (res) {
       return _this12.webex.request({
         method: 'POST',
@@ -625,7 +575,6 @@ var Board = _webexCore.WebexPlugin.extend({
       return res.body;
     });
   },
-
   /**
    * Encrypts and uploads image to WebexFiles
    * @memberof Board.BoardService
@@ -638,29 +587,25 @@ var Board = _webexCore.WebexPlugin.extend({
    */
   _uploadImage: function _uploadImage(channel, file, options) {
     var _this13 = this;
-
     options = options || {};
     return this.webex.internal.encryption.encryptBinary(file).then(function (_ref) {
       var scr = _ref.scr,
-          cdata = _ref.cdata;
+        cdata = _ref.cdata;
       return _promise.default.all([scr, _this13._uploadImageToWebexFiles(channel, cdata, options.hiddenSpace)]);
     }).then(function (_ref2) {
       var _ref3 = (0, _slicedToArray2.default)(_ref2, 2),
-          scr = _ref3[0],
-          res = _ref3[1];
-
-      return (0, _assign3.default)(scr, {
+        scr = _ref3[0],
+        res = _ref3[1];
+      return (0, _assign2.default)(scr, {
         loc: res.downloadUrl
       });
     });
   },
   _getSpaceUrl: function _getSpaceUrl(channel, hiddenSpace) {
     var requestUri = "".concat(channel.channelUrl, "/spaces/open");
-
     if (hiddenSpace) {
       requestUri = "".concat(channel.channelUrl, "/spaces/hidden");
     }
-
     return this.webex.request({
       method: 'PUT',
       uri: requestUri
@@ -670,7 +615,6 @@ var Board = _webexCore.WebexPlugin.extend({
   },
   _uploadImageToWebexFiles: function _uploadImageToWebexFiles(channel, file, hiddenSpace) {
     var _this14 = this;
-
     var fileSize = file.length || file.size || file.byteLength;
     return this._getSpaceUrl(channel, hiddenSpace).then(function (spaceUrl) {
       return _this14.webex.upload({
@@ -700,7 +644,6 @@ var Board = _webexCore.WebexPlugin.extend({
       });
     });
   },
-
   /** Authorize transcoder (for sharing whiteboard to mobile)
    *
    * @param  {Board~Channel} board
@@ -709,11 +652,9 @@ var Board = _webexCore.WebexPlugin.extend({
    */
   authorizeMediaInjector: function authorizeMediaInjector(board) {
     var _this15 = this;
-
     if (!board) {
       _promise.default.reject(new Error('#authorizeMediaInjector --> cannot authorize transcoder without board'));
     }
-
     return this.webex.internal.encryption.kms.prepareRequest({
       method: 'create',
       uri: '/authorizations',
@@ -733,7 +674,6 @@ var Board = _webexCore.WebexPlugin.extend({
       if ((decryptedKmsMessage === null || decryptedKmsMessage === void 0 ? void 0 : decryptedKmsMessage.authorizations.length) > 0) {
         return decryptedKmsMessage.authorizations[0].bearer;
       }
-
       return undefined;
     }).catch(function (err) {
       return (
@@ -744,7 +684,6 @@ var Board = _webexCore.WebexPlugin.extend({
       );
     });
   },
-
   /** Unauthorize transcoder (for stopping whiteboard share to mobile)
    *
    * @param  {Board~Channel} board
@@ -753,11 +692,9 @@ var Board = _webexCore.WebexPlugin.extend({
    */
   unauthorizeMediaInjector: function unauthorizeMediaInjector(board) {
     var _this16 = this;
-
     if (!board) {
       _promise.default.reject(new Error('#unauthorizeMediaInjector --> cannot unauthorize transcoder without board'));
     }
-
     return this.webex.internal.encryption.kms.listAuthorizations({
       kroUri: board.kmsResourceUrl
     }).then(function (authorizations) {
@@ -774,25 +711,22 @@ var Board = _webexCore.WebexPlugin.extend({
         }).catch(function (err) {
           return (
             /* We don't want this to error out, otherwise the
-            * Promise.all will not process the rest of the request
-            */
+             * Promise.all will not process the rest of the request
+             */
             _promise.default.resolve(err)
           );
         });
       });
-
       if (promises.length > 0) {
         return _promise.default.all(promises).then(function (responses) {
           return responses;
         });
       }
-
       return _promise.default.resolve([]);
     });
   },
-  version: "3.0.0-beta.4"
+  version: "3.0.0-beta.400"
 });
-
 var _default = Board;
 exports.default = _default;
 //# sourceMappingURL=board.js.map