@webex/plugin-meetings 2.59.8-next.2 → 2.60.0-next.1

package/dist/controls-options-manager/index.js

@@ -1,12 +1,21 @@
 "use strict";
 
+var _Object$keys2 = 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 _keys = _interopRequireDefault(require("@babel/runtime-corejs2/core-js/object/keys"));
 var _promise = _interopRequireDefault(require("@babel/runtime-corejs2/core-js/promise"));
+var _stringify = _interopRequireDefault(require("@babel/runtime-corejs2/core-js/json/stringify"));
+var _entries = _interopRequireDefault(require("@babel/runtime-corejs2/core-js/object/entries"));
+var _slicedToArray2 = _interopRequireDefault(require("@babel/runtime-corejs2/helpers/slicedToArray"));
 var _classCallCheck2 = _interopRequireDefault(require("@babel/runtime-corejs2/helpers/classCallCheck"));
 var _createClass2 = _interopRequireDefault(require("@babel/runtime-corejs2/helpers/createClass"));
 var _defineProperty2 = _interopRequireDefault(require("@babel/runtime-corejs2/helpers/defineProperty"));
@@ -14,9 +23,11 @@ var _lodash = require("lodash");
 var _permission = _interopRequireDefault(require("../common/errors/permission"));
 var _constants = require("../constants");
 var _loggerProxy = _interopRequireDefault(require("../common/logs/logger-proxy"));
-var _enums = _interopRequireDefault(require("./enums"));
+var _enums = require("./enums");
 var _util = _interopRequireDefault(require("./util"));
 var _constants2 = require("./constants");
+function ownKeys(e, r) { var t = _Object$keys2(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) { (0, _defineProperty2.default)(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; }
 /**
  * docs
  * https://sqbu-github.cisco.com/pages/WebExSquared/locus/guides/mute.html
@@ -31,28 +42,7 @@ var _constants2 = require("./constants");
  * @private
  * @class Recording
  */
-var ControlsOptionsManager = /*#__PURE__*/function () {
-  /**
-   * @instance
-   * @type {MeetingRequest}
-   * @private
-   * @memberof ControlsOptionsManager
-   */
-
-  /**
-   * @instance
-   * @type {Array}
-   * @private
-   * @memberof ControlsOptionsManager
-   */
-
-  /**
-   * @instance
-   * @type {string}
-   * @private
-   * @memberof ControlsOptionsManager
-   */
-
+var ControlsOptionsManager = exports.default = /*#__PURE__*/function () {
   /**
    * @param {MeetingRequest} request
    * @param {Object} options
@@ -61,8 +51,26 @@ var ControlsOptionsManager = /*#__PURE__*/function () {
    */
   function ControlsOptionsManager(request, options) {
     (0, _classCallCheck2.default)(this, ControlsOptionsManager);
+    /**
+     * @instance
+     * @type {MeetingRequest}
+     * @private
+     * @memberof ControlsOptionsManager
+     */
     (0, _defineProperty2.default)(this, "request", void 0);
+    /**
+     * @instance
+     * @type {Array}
+     * @private
+     * @memberof ControlsOptionsManager
+     */
     (0, _defineProperty2.default)(this, "displayHints", []);
+    /**
+     * @instance
+     * @type {string}
+     * @private
+     * @memberof ControlsOptionsManager
+     */
     (0, _defineProperty2.default)(this, "locusUrl", void 0);
     this.initialize(request);
     this.set(options);
@@ -151,26 +159,94 @@ var ControlsOptionsManager = /*#__PURE__*/function () {
       this.setLocusUrl(options === null || options === void 0 ? void 0 : options.locusUrl);
     }
 
+    /**
+     * Set controls for this meeting.
+     *
+     * @param {Array<ControlConfig>} controls - Spread Array of ControlConfigs
+     * @returns {Promise<Array<any>>}- Promise resolving if the request was successful.
+     */
+  }, {
+    key: "update",
+    value: function update() {
+      var _this = this;
+      for (var _len = arguments.length, controls = new Array(_len), _key = 0; _key < _len; _key++) {
+        controls[_key] = arguments[_key];
+      }
+      var payloads = controls.map(function (control) {
+        if (!(0, _keys.default)(_enums.Control).includes(control.scope)) {
+          throw new Error("updating meeting control scope \"".concat(control.scope, "\" is not a supported scope"));
+        }
+        if (!_util.default.canUpdate(control, _this.displayHints)) {
+          throw new _permission.default("updating meeting control scope \"".concat(control.scope, "\" not allowed, due to moderator property."));
+        }
+        return (0, _defineProperty2.default)({}, control.scope, control.properties);
+      });
+      return payloads.reduce(function (previous, payload) {
+        return previous.then(function () {
+          return (
+            // @ts-ignore
+            _this.request.request({
+              uri: "".concat(_this.locusUrl, "/").concat(_constants.CONTROLS),
+              body: payload,
+              method: _constants.HTTP_VERBS.PATCH
+            })
+          );
+        });
+      }, _promise.default.resolve());
+    }
+
     /**
      * @param {Setting} setting
-     * @param {boolean} enabled
      * @private
      * @memberof ControlsOptionsManager
      * @returns {Promise}
      */
   }, {
     key: "setControls",
-    value: function setControls(setting, enabled) {
-      _loggerProxy.default.logger.log("ControlsOptionsManager:index#setControls --> ".concat(setting, " [").concat(enabled, "]"));
-      if (_util.default !== null && _util.default !== void 0 && _util.default["".concat(enabled ? _constants2.CAN_SET : _constants2.CAN_UNSET).concat(setting)](this.displayHints)) {
-        // @ts-ignore
-        return this.request.request({
-          uri: "".concat(this.locusUrl, "/").concat(_constants.CONTROLS),
-          body: (0, _defineProperty2.default)({}, (0, _lodash.camelCase)(setting), (0, _defineProperty2.default)({}, _constants2.ENABLED, enabled)),
-          method: _constants.HTTP_VERBS.PATCH
-        });
+    value: function setControls(setting) {
+      var _this2 = this;
+      _loggerProxy.default.logger.log("ControlsOptionsManager:index#setControls --> ".concat((0, _stringify.default)(setting)));
+      var body = {};
+      var error;
+      var shouldSkipCheckToMergeBody = false;
+      (0, _entries.default)(setting).forEach(function (_ref2) {
+        var _ref3 = (0, _slicedToArray2.default)(_ref2, 2),
+          key = _ref3[0],
+          value = _ref3[1];
+        if (!shouldSkipCheckToMergeBody && !(_util.default !== null && _util.default !== void 0 && _util.default["".concat(value ? _constants2.CAN_SET : _constants2.CAN_UNSET).concat(key)](_this2.displayHints))) {
+          error = new _permission.default("".concat(key, " [").concat(value, "] not allowed, due to moderator property."));
+        }
+        if (error) {
+          return;
+        }
+        switch (key) {
+          case _enums.Setting.muted:
+            shouldSkipCheckToMergeBody = true;
+            body.audio = body.audio ? _objectSpread(_objectSpread({}, body.audio), {}, (0, _defineProperty2.default)({}, (0, _lodash.camelCase)(key), value)) : (0, _defineProperty2.default)({}, (0, _lodash.camelCase)(key), value);
+            break;
+          case _enums.Setting.disallowUnmute:
+          case _enums.Setting.muteOnEntry:
+            if ((0, _keys.default)(setting).includes(_enums.Setting.muted)) {
+              body.audio = body.audio ? _objectSpread(_objectSpread({}, body.audio), {}, (0, _defineProperty2.default)({}, (0, _lodash.camelCase)(key), value)) : (0, _defineProperty2.default)({}, (0, _lodash.camelCase)(key), value);
+              body.audio[(0, _lodash.camelCase)(key)] = value;
+            } else {
+              body[(0, _lodash.camelCase)(key)] = (0, _defineProperty2.default)({}, _constants2.ENABLED, value);
+            }
+            break;
+          default:
+            error = new _permission.default("".concat(key, " [").concat(value, "] not allowed, due to moderator property."));
+        }
+      });
+      if (error) {
+        return _promise.default.reject(error);
       }
-      return _promise.default.reject(new _permission.default("".concat(setting, " [").concat(enabled, "] not allowed, due to moderator property.")));
+
+      // @ts-ignore
+      return this.request.request({
+        uri: "".concat(this.locusUrl, "/").concat(_constants.CONTROLS),
+        body: body,
+        method: _constants.HTTP_VERBS.PATCH
+      });
     }
 
     /**
@@ -182,7 +258,7 @@ var ControlsOptionsManager = /*#__PURE__*/function () {
   }, {
     key: "setMuteOnEntry",
     value: function setMuteOnEntry(enabled) {
-      return this.setControls(_enums.default.muteOnEntry, enabled);
+      return this.setControls((0, _defineProperty2.default)({}, _enums.Setting.muteOnEntry, enabled));
     }
 
     /**
@@ -194,10 +270,23 @@ var ControlsOptionsManager = /*#__PURE__*/function () {
   }, {
     key: "setDisallowUnmute",
     value: function setDisallowUnmute(enabled) {
-      return this.setControls(_enums.default.disallowUnmute, enabled);
+      return this.setControls((0, _defineProperty2.default)({}, _enums.Setting.disallowUnmute, enabled));
+    }
+
+    /**
+     * @public
+     * @param {boolean} mutedEnabled
+     * @param {boolean} disallowUnmuteEnabled
+     * @param {boolean} muteOnEntryEnabled
+     * @memberof ControlsOptionsManager
+     * @returns {Promise}
+     */
+  }, {
+    key: "setMuteAll",
+    value: function setMuteAll(mutedEnabled, disallowUnmuteEnabled, muteOnEntryEnabled) {
+      return this.setControls((0, _defineProperty2.default)((0, _defineProperty2.default)((0, _defineProperty2.default)({}, _enums.Setting.muted, mutedEnabled), _enums.Setting.disallowUnmute, disallowUnmuteEnabled), _enums.Setting.muteOnEntry, muteOnEntryEnabled));
     }
   }]);
   return ControlsOptionsManager;
 }();
-exports.default = ControlsOptionsManager;
 //# sourceMappingURL=index.js.map

package/dist/controls-options-manager/index.js.map

@@ -1 +1 @@
-{"version":3,"names":["_lodash","require","_permission","_interopRequireDefault","_constants","_loggerProxy","_enums","_util","_constants2","ControlsOptionsManager","request","options","_classCallCheck2","default","_defineProperty2","initialize","set","_createClass2","key","value","extract","setLocusUrl","url","locusUrl","setDisplayHints","hints","displayHints","getLocusUrl","getDisplayHints","setControls","setting","enabled","LoggerProxy","logger","log","concat","Util","CAN_SET","CAN_UNSET","uri","CONTROLS","body","camelCase","ENABLED","method","HTTP_VERBS","PATCH","_promise","reject","PermissionError","setMuteOnEntry","Setting","muteOnEntry","setDisallowUnmute","disallowUnmute","exports"],"sources":["index.ts"],"sourcesContent":["import {camelCase} from 'lodash';\nimport PermissionError from '../common/errors/permission';\nimport {CONTROLS, HTTP_VERBS} from '../constants';\nimport MeetingRequest from '../meeting/request';\nimport LoggerProxy from '../common/logs/logger-proxy';\nimport Setting from './enums';\nimport Util from './util';\nimport {CAN_SET, CAN_UNSET, ENABLED} from './constants';\n\n/**\n * docs\n * https://sqbu-github.cisco.com/pages/WebExSquared/locus/guides/mute.html\n * https://confluence-eng-gpk2.cisco.com/conf/display/LOCUS/Hard+Mute+and+Audio+Privacy#HardMuteandAudioPrivacy-SelfMuteonEntry\n * https://confluence-eng-gpk2.cisco.com/conf/pages/viewpage.action?spaceKey=UC&title=WEBEX-124454%3A+UCF%3A+Hard+mute+support+for+Teams+joining+Webex+meeting\n * https://jira-eng-gpk2.cisco.com/jira/browse/SPARK-180867\n * https://jira-eng-gpk2.cisco.com/jira/browse/SPARK-393351\n */\n\n/**\n * @description ControlsOptionsManager is responsible for handling the behavior of participant controls when somebody joins a meeting\n * @export\n * @private\n * @class Recording\n */\nexport default class ControlsOptionsManager {\n  /**\n   * @instance\n   * @type {MeetingRequest}\n   * @private\n   * @memberof ControlsOptionsManager\n   */\n  private request: MeetingRequest;\n\n  /**\n   * @instance\n   * @type {Array}\n   * @private\n   * @memberof ControlsOptionsManager\n   */\n  private displayHints: Array<string> = [];\n\n  /**\n   * @instance\n   * @type {string}\n   * @private\n   * @memberof ControlsOptionsManager\n   */\n  private locusUrl: string;\n\n  /**\n   * @param {MeetingRequest} request\n   * @param {Object} options\n   * @constructor\n   * @memberof ControlsOptionsManager\n   */\n  constructor(\n    request: MeetingRequest,\n    options?: {\n      locusUrl: string;\n      displayHints?: Array<string>;\n    }\n  ) {\n    this.initialize(request);\n    this.set(options);\n  }\n\n  /**\n   * @param {MeetingRequest} request\n   * @returns {void}\n   * @private\n   * @memberof ControlsOptionsManager\n   */\n  private initialize(request: MeetingRequest) {\n    this.request = request;\n  }\n\n  /**\n   * @param {Object} options\n   * @returns {void}\n   * @public\n   * @memberof ControlsOptionsManager\n   */\n  public set(options?: {locusUrl: string; displayHints?: Array<string>}) {\n    this.extract(options);\n  }\n\n  /**\n   * @param {string} url\n   * @returns {void}\n   * @public\n   * @memberof ControlsOptionsManager\n   */\n  public setLocusUrl(url: string) {\n    this.locusUrl = url;\n  }\n\n  /**\n   * @param {Array} hints\n   * @returns {void}\n   * @public\n   * @memberof ControlsOptionsManager\n   */\n  public setDisplayHints(hints: Array<string>) {\n    this.displayHints = hints;\n  }\n\n  /**\n   * @returns {string}\n   * @public\n   * @memberof ControlsOptionsManager\n   */\n  public getLocusUrl() {\n    return this.locusUrl;\n  }\n\n  /**\n   * @returns {Array}\n   * @public\n   * @memberof ControlsOptionsManager\n   */\n  public getDisplayHints() {\n    return this.displayHints;\n  }\n\n  /**\n   * @param {Object} options\n   * @returns {void}\n   * @private\n   * @memberof ControlsOptionsManager\n   */\n  private extract(options?: {locusUrl: string; displayHints?: Array<string>}) {\n    this.setDisplayHints(options?.displayHints);\n    this.setLocusUrl(options?.locusUrl);\n  }\n\n  /**\n   * @param {Setting} setting\n   * @param {boolean} enabled\n   * @private\n   * @memberof ControlsOptionsManager\n   * @returns {Promise}\n   */\n  private setControls(setting: Setting, enabled: boolean): Promise<any> {\n    LoggerProxy.logger.log(`ControlsOptionsManager:index#setControls --> ${setting} [${enabled}]`);\n\n    if (Util?.[`${enabled ? CAN_SET : CAN_UNSET}${setting}`](this.displayHints)) {\n      // @ts-ignore\n      return this.request.request({\n        uri: `${this.locusUrl}/${CONTROLS}`,\n        body: {\n          [camelCase(setting)]: {\n            [ENABLED]: enabled,\n          },\n        },\n        method: HTTP_VERBS.PATCH,\n      });\n    }\n\n    return Promise.reject(\n      new PermissionError(`${setting} [${enabled}] not allowed, due to moderator property.`)\n    );\n  }\n\n  /**\n   * @public\n   * @param {boolean} enabled\n   * @memberof ControlsOptionsManager\n   * @returns {Promise}\n   */\n  public setMuteOnEntry(enabled: boolean): Promise<any> {\n    return this.setControls(Setting.muteOnEntry, enabled);\n  }\n\n  /**\n   * @public\n   * @param {boolean} enabled\n   * @memberof ControlsOptionsManager\n   * @returns {Promise}\n   */\n  public setDisallowUnmute(enabled: boolean): Promise<any> {\n    return this.setControls(Setting.disallowUnmute, enabled);\n  }\n}\n"],"mappings":";;;;;;;;;;;;AAAA,IAAAA,OAAA,GAAAC,OAAA;AACA,IAAAC,WAAA,GAAAC,sBAAA,CAAAF,OAAA;AACA,IAAAG,UAAA,GAAAH,OAAA;AAEA,IAAAI,YAAA,GAAAF,sBAAA,CAAAF,OAAA;AACA,IAAAK,MAAA,GAAAH,sBAAA,CAAAF,OAAA;AACA,IAAAM,KAAA,GAAAJ,sBAAA,CAAAF,OAAA;AACA,IAAAO,WAAA,GAAAP,OAAA;AAEA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AAEA;AACA;AACA;AACA;AACA;AACA;AALA,IAMqBQ,sBAAsB;EACzC;AACF;AACA;AACA;AACA;AACA;;EAGE;AACF;AACA;AACA;AACA;AACA;;EAGE;AACF;AACA;AACA;AACA;AACA;;EAGE;AACF;AACA;AACA;AACA;AACA;EACE,SAAAA,uBACEC,OAAuB,EACvBC,OAGC,EACD;IAAA,IAAAC,gBAAA,CAAAC,OAAA,QAAAJ,sBAAA;IAAA,IAAAK,gBAAA,CAAAD,OAAA;IAAA,IAAAC,gBAAA,CAAAD,OAAA,wBAtBoC,EAAE;IAAA,IAAAC,gBAAA,CAAAD,OAAA;IAuBtC,IAAI,CAACE,UAAU,CAACL,OAAO,CAAC;IACxB,IAAI,CAACM,GAAG,CAACL,OAAO,CAAC;EACnB;;EAEA;AACF;AACA;AACA;AACA;AACA;EALE,IAAAM,aAAA,CAAAJ,OAAA,EAAAJ,sBAAA;IAAAS,GAAA;IAAAC,KAAA,EAMA,SAAAJ,WAAmBL,OAAuB,EAAE;MAC1C,IAAI,CAACA,OAAO,GAAGA,OAAO;IACxB;;IAEA;AACF;AACA;AACA;AACA;AACA;EALE;IAAAQ,GAAA;IAAAC,KAAA,EAMA,SAAAH,IAAWL,OAA0D,EAAE;MACrE,IAAI,CAACS,OAAO,CAACT,OAAO,CAAC;IACvB;;IAEA;AACF;AACA;AACA;AACA;AACA;EALE;IAAAO,GAAA;IAAAC,KAAA,EAMA,SAAAE,YAAmBC,GAAW,EAAE;MAC9B,IAAI,CAACC,QAAQ,GAAGD,GAAG;IACrB;;IAEA;AACF;AACA;AACA;AACA;AACA;EALE;IAAAJ,GAAA;IAAAC,KAAA,EAMA,SAAAK,gBAAuBC,KAAoB,EAAE;MAC3C,IAAI,CAACC,YAAY,GAAGD,KAAK;IAC3B;;IAEA;AACF;AACA;AACA;AACA;EAJE;IAAAP,GAAA;IAAAC,KAAA,EAKA,SAAAQ,YAAA,EAAqB;MACnB,OAAO,IAAI,CAACJ,QAAQ;IACtB;;IAEA;AACF;AACA;AACA;AACA;EAJE;IAAAL,GAAA;IAAAC,KAAA,EAKA,SAAAS,gBAAA,EAAyB;MACvB,OAAO,IAAI,CAACF,YAAY;IAC1B;;IAEA;AACF;AACA;AACA;AACA;AACA;EALE;IAAAR,GAAA;IAAAC,KAAA,EAMA,SAAAC,QAAgBT,OAA0D,EAAE;MAC1E,IAAI,CAACa,eAAe,CAACb,OAAO,aAAPA,OAAO,uBAAPA,OAAO,CAAEe,YAAY,CAAC;MAC3C,IAAI,CAACL,WAAW,CAACV,OAAO,aAAPA,OAAO,uBAAPA,OAAO,CAAEY,QAAQ,CAAC;IACrC;;IAEA;AACF;AACA;AACA;AACA;AACA;AACA;EANE;IAAAL,GAAA;IAAAC,KAAA,EAOA,SAAAU,YAAoBC,OAAgB,EAAEC,OAAgB,EAAgB;MACpEC,oBAAW,CAACC,MAAM,CAACC,GAAG,iDAAAC,MAAA,CAAiDL,OAAO,QAAAK,MAAA,CAAKJ,OAAO,OAAI;MAE9F,IAAIK,aAAI,aAAJA,aAAI,eAAJA,aAAI,IAAAD,MAAA,CAAMJ,OAAO,GAAGM,mBAAO,GAAGC,qBAAS,EAAAH,MAAA,CAAGL,OAAO,EAAG,CAAC,IAAI,CAACJ,YAAY,CAAC,EAAE;QAC3E;QACA,OAAO,IAAI,CAAChB,OAAO,CAACA,OAAO,CAAC;UAC1B6B,GAAG,KAAAJ,MAAA,CAAK,IAAI,CAACZ,QAAQ,OAAAY,MAAA,CAAIK,mBAAQ,CAAE;UACnCC,IAAI,MAAA3B,gBAAA,CAAAD,OAAA,MACD,IAAA6B,iBAAS,EAACZ,OAAO,CAAC,MAAAhB,gBAAA,CAAAD,OAAA,MAChB8B,mBAAO,EAAGZ,OAAO,EAErB;UACDa,MAAM,EAAEC,qBAAU,CAACC;QACrB,CAAC,CAAC;MACJ;MAEA,OAAOC,QAAA,CAAAlC,OAAA,CAAQmC,MAAM,CACnB,IAAIC,mBAAe,IAAAd,MAAA,CAAIL,OAAO,QAAAK,MAAA,CAAKJ,OAAO,+CAA4C,CACvF;IACH;;IAEA;AACF;AACA;AACA;AACA;AACA;EALE;IAAAb,GAAA;IAAAC,KAAA,EAMA,SAAA+B,eAAsBnB,OAAgB,EAAgB;MACpD,OAAO,IAAI,CAACF,WAAW,CAACsB,cAAO,CAACC,WAAW,EAAErB,OAAO,CAAC;IACvD;;IAEA;AACF;AACA;AACA;AACA;AACA;EALE;IAAAb,GAAA;IAAAC,KAAA,EAMA,SAAAkC,kBAAyBtB,OAAgB,EAAgB;MACvD,OAAO,IAAI,CAACF,WAAW,CAACsB,cAAO,CAACG,cAAc,EAAEvB,OAAO,CAAC;IAC1D;EAAC;EAAA,OAAAtB,sBAAA;AAAA;AAAA8C,OAAA,CAAA1C,OAAA,GAAAJ,sBAAA"}
+{"version":3,"names":["_lodash","require","_permission","_interopRequireDefault","_constants","_loggerProxy","_enums","_util","_constants2","ownKeys","e","r","t","_Object$keys2","_Object$getOwnPropertySymbols","o","filter","_Object$getOwnPropertyDescriptor","enumerable","push","apply","_objectSpread","arguments","length","Object","forEach","_defineProperty2","default","_Object$getOwnPropertyDescriptors","_Object$defineProperties","_Object$defineProperty","ControlsOptionsManager","exports","request","options","_classCallCheck2","initialize","set","_createClass2","key","value","extract","setLocusUrl","url","locusUrl","setDisplayHints","hints","displayHints","getLocusUrl","getDisplayHints","update","_this","_len","controls","Array","_key","payloads","map","control","_keys","Control","includes","scope","Error","concat","Util","canUpdate","PermissionError","properties","reduce","previous","payload","then","uri","CONTROLS","body","method","HTTP_VERBS","PATCH","_promise","resolve","setControls","setting","_this2","LoggerProxy","logger","log","_stringify","error","shouldSkipCheckToMergeBody","_entries","_ref2","_ref3","_slicedToArray2","CAN_SET","CAN_UNSET","Setting","muted","audio","camelCase","disallowUnmute","muteOnEntry","ENABLED","reject","setMuteOnEntry","enabled","setDisallowUnmute","setMuteAll","mutedEnabled","disallowUnmuteEnabled","muteOnEntryEnabled"],"sources":["index.ts"],"sourcesContent":["import {camelCase} from 'lodash';\nimport PermissionError from '../common/errors/permission';\nimport {CONTROLS, HTTP_VERBS} from '../constants';\nimport MeetingRequest from '../meeting/request';\nimport LoggerProxy from '../common/logs/logger-proxy';\nimport {Control, Setting} from './enums';\nimport {ControlConfig} from './types';\nimport Util from './util';\nimport {CAN_SET, CAN_UNSET, ENABLED} from './constants';\n\n/**\n * docs\n * https://sqbu-github.cisco.com/pages/WebExSquared/locus/guides/mute.html\n * https://confluence-eng-gpk2.cisco.com/conf/display/LOCUS/Hard+Mute+and+Audio+Privacy#HardMuteandAudioPrivacy-SelfMuteonEntry\n * https://confluence-eng-gpk2.cisco.com/conf/pages/viewpage.action?spaceKey=UC&title=WEBEX-124454%3A+UCF%3A+Hard+mute+support+for+Teams+joining+Webex+meeting\n * https://jira-eng-gpk2.cisco.com/jira/browse/SPARK-180867\n * https://jira-eng-gpk2.cisco.com/jira/browse/SPARK-393351\n */\n\n/**\n * @description ControlsOptionsManager is responsible for handling the behavior of participant controls when somebody joins a meeting\n * @export\n * @private\n * @class Recording\n */\nexport default class ControlsOptionsManager {\n  /**\n   * @instance\n   * @type {MeetingRequest}\n   * @private\n   * @memberof ControlsOptionsManager\n   */\n  private request: MeetingRequest;\n\n  /**\n   * @instance\n   * @type {Array}\n   * @private\n   * @memberof ControlsOptionsManager\n   */\n  private displayHints: Array<string> = [];\n\n  /**\n   * @instance\n   * @type {string}\n   * @private\n   * @memberof ControlsOptionsManager\n   */\n  private locusUrl: string;\n\n  /**\n   * @param {MeetingRequest} request\n   * @param {Object} options\n   * @constructor\n   * @memberof ControlsOptionsManager\n   */\n  constructor(\n    request: MeetingRequest,\n    options?: {\n      locusUrl: string;\n      displayHints?: Array<string>;\n    }\n  ) {\n    this.initialize(request);\n    this.set(options);\n  }\n\n  /**\n   * @param {MeetingRequest} request\n   * @returns {void}\n   * @private\n   * @memberof ControlsOptionsManager\n   */\n  private initialize(request: MeetingRequest) {\n    this.request = request;\n  }\n\n  /**\n   * @param {Object} options\n   * @returns {void}\n   * @public\n   * @memberof ControlsOptionsManager\n   */\n  public set(options?: {locusUrl: string; displayHints?: Array<string>}) {\n    this.extract(options);\n  }\n\n  /**\n   * @param {string} url\n   * @returns {void}\n   * @public\n   * @memberof ControlsOptionsManager\n   */\n  public setLocusUrl(url: string) {\n    this.locusUrl = url;\n  }\n\n  /**\n   * @param {Array} hints\n   * @returns {void}\n   * @public\n   * @memberof ControlsOptionsManager\n   */\n  public setDisplayHints(hints: Array<string>) {\n    this.displayHints = hints;\n  }\n\n  /**\n   * @returns {string}\n   * @public\n   * @memberof ControlsOptionsManager\n   */\n  public getLocusUrl() {\n    return this.locusUrl;\n  }\n\n  /**\n   * @returns {Array}\n   * @public\n   * @memberof ControlsOptionsManager\n   */\n  public getDisplayHints() {\n    return this.displayHints;\n  }\n\n  /**\n   * @param {Object} options\n   * @returns {void}\n   * @private\n   * @memberof ControlsOptionsManager\n   */\n  private extract(options?: {locusUrl: string; displayHints?: Array<string>}) {\n    this.setDisplayHints(options?.displayHints);\n    this.setLocusUrl(options?.locusUrl);\n  }\n\n  /**\n   * Set controls for this meeting.\n   *\n   * @param {Array<ControlConfig>} controls - Spread Array of ControlConfigs\n   * @returns {Promise<Array<any>>}- Promise resolving if the request was successful.\n   */\n  public update(...controls: Array<ControlConfig>) {\n    const payloads = controls.map((control) => {\n      if (!Object.keys(Control).includes(control.scope)) {\n        throw new Error(\n          `updating meeting control scope \"${control.scope}\" is not a supported scope`\n        );\n      }\n\n      if (!Util.canUpdate(control, this.displayHints)) {\n        throw new PermissionError(\n          `updating meeting control scope \"${control.scope}\" not allowed, due to moderator property.`\n        );\n      }\n\n      return {\n        [control.scope]: control.properties,\n      };\n    });\n\n    return payloads.reduce((previous, payload) => {\n      return previous.then(() =>\n        // @ts-ignore\n        this.request.request({\n          uri: `${this.locusUrl}/${CONTROLS}`,\n          body: payload,\n          method: HTTP_VERBS.PATCH,\n        })\n      );\n    }, Promise.resolve());\n  }\n\n  /**\n   * @param {Setting} setting\n   * @private\n   * @memberof ControlsOptionsManager\n   * @returns {Promise}\n   */\n  private setControls(setting: {[key in Setting]?: boolean}): Promise<any> {\n    LoggerProxy.logger.log(\n      `ControlsOptionsManager:index#setControls --> ${JSON.stringify(setting)}`\n    );\n\n    const body: Record<string, any> = {};\n    let error: PermissionError;\n\n    let shouldSkipCheckToMergeBody = false;\n\n    Object.entries(setting).forEach(([key, value]) => {\n      if (\n        !shouldSkipCheckToMergeBody &&\n        !Util?.[`${value ? CAN_SET : CAN_UNSET}${key}`](this.displayHints)\n      ) {\n        error = new PermissionError(`${key} [${value}] not allowed, due to moderator property.`);\n      }\n\n      if (error) {\n        return;\n      }\n\n      switch (key) {\n        case Setting.muted:\n          shouldSkipCheckToMergeBody = true;\n          body.audio = body.audio\n            ? {...body.audio, [camelCase(key)]: value}\n            : {[camelCase(key)]: value};\n          break;\n\n        case Setting.disallowUnmute:\n        case Setting.muteOnEntry:\n          if (Object.keys(setting).includes(Setting.muted)) {\n            body.audio = body.audio\n              ? {...body.audio, [camelCase(key)]: value}\n              : {[camelCase(key)]: value};\n            body.audio[camelCase(key)] = value;\n          } else {\n            body[camelCase(key)] = {[ENABLED]: value};\n          }\n          break;\n\n        default:\n          error = new PermissionError(`${key} [${value}] not allowed, due to moderator property.`);\n      }\n    });\n\n    if (error) {\n      return Promise.reject(error);\n    }\n\n    // @ts-ignore\n    return this.request.request({\n      uri: `${this.locusUrl}/${CONTROLS}`,\n      body,\n      method: HTTP_VERBS.PATCH,\n    });\n  }\n\n  /**\n   * @public\n   * @param {boolean} enabled\n   * @memberof ControlsOptionsManager\n   * @returns {Promise}\n   */\n  public setMuteOnEntry(enabled: boolean): Promise<any> {\n    return this.setControls({[Setting.muteOnEntry]: enabled});\n  }\n\n  /**\n   * @public\n   * @param {boolean} enabled\n   * @memberof ControlsOptionsManager\n   * @returns {Promise}\n   */\n  public setDisallowUnmute(enabled: boolean): Promise<any> {\n    return this.setControls({[Setting.disallowUnmute]: enabled});\n  }\n\n  /**\n   * @public\n   * @param {boolean} mutedEnabled\n   * @param {boolean} disallowUnmuteEnabled\n   * @param {boolean} muteOnEntryEnabled\n   * @memberof ControlsOptionsManager\n   * @returns {Promise}\n   */\n  public setMuteAll(\n    mutedEnabled: boolean,\n    disallowUnmuteEnabled: boolean,\n    muteOnEntryEnabled: boolean\n  ): Promise<any> {\n    return this.setControls({\n      [Setting.muted]: mutedEnabled,\n      [Setting.disallowUnmute]: disallowUnmuteEnabled,\n      [Setting.muteOnEntry]: muteOnEntryEnabled,\n    });\n  }\n}\n"],"mappings":";;;;;;;;;;;;;;;;;;;;;AAAA,IAAAA,OAAA,GAAAC,OAAA;AACA,IAAAC,WAAA,GAAAC,sBAAA,CAAAF,OAAA;AACA,IAAAG,UAAA,GAAAH,OAAA;AAEA,IAAAI,YAAA,GAAAF,sBAAA,CAAAF,OAAA;AACA,IAAAK,MAAA,GAAAL,OAAA;AAEA,IAAAM,KAAA,GAAAJ,sBAAA,CAAAF,OAAA;AACA,IAAAO,WAAA,GAAAP,OAAA;AAAwD,SAAAQ,QAAAC,CAAA,EAAAC,CAAA,QAAAC,CAAA,GAAAC,aAAA,CAAAH,CAAA,OAAAI,6BAAA,QAAAC,CAAA,GAAAD,6BAAA,CAAAJ,CAAA,GAAAC,CAAA,KAAAI,CAAA,GAAAA,CAAA,CAAAC,MAAA,WAAAL,CAAA,WAAAM,gCAAA,CAAAP,CAAA,EAAAC,CAAA,EAAAO,UAAA,OAAAN,CAAA,CAAAO,IAAA,CAAAC,KAAA,CAAAR,CAAA,EAAAG,CAAA,YAAAH,CAAA;AAAA,SAAAS,cAAAX,CAAA,aAAAC,CAAA,MAAAA,CAAA,GAAAW,SAAA,CAAAC,MAAA,EAAAZ,CAAA,UAAAC,CAAA,WAAAU,SAAA,CAAAX,CAAA,IAAAW,SAAA,CAAAX,CAAA,QAAAA,CAAA,OAAAF,OAAA,CAAAe,MAAA,CAAAZ,CAAA,OAAAa,OAAA,WAAAd,CAAA,QAAAe,gBAAA,CAAAC,OAAA,EAAAjB,CAAA,EAAAC,CAAA,EAAAC,CAAA,CAAAD,CAAA,SAAAiB,iCAAA,GAAAC,wBAAA,CAAAnB,CAAA,EAAAkB,iCAAA,CAAAhB,CAAA,KAAAH,OAAA,CAAAe,MAAA,CAAAZ,CAAA,GAAAa,OAAA,WAAAd,CAAA,IAAAmB,sBAAA,CAAApB,CAAA,EAAAC,CAAA,EAAAM,gCAAA,CAAAL,CAAA,EAAAD,CAAA,iBAAAD,CAAA;AAExD;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AAEA;AACA;AACA;AACA;AACA;AACA;AALA,IAMqBqB,sBAAsB,GAAAC,OAAA,CAAAL,OAAA;EAyBzC;AACF;AACA;AACA;AACA;AACA;EACE,SAAAI,uBACEE,OAAuB,EACvBC,OAGC,EACD;IAAA,IAAAC,gBAAA,CAAAR,OAAA,QAAAI,sBAAA;IApCF;AACF;AACA;AACA;AACA;AACA;IALE,IAAAL,gBAAA,CAAAC,OAAA;IAQA;AACF;AACA;AACA;AACA;AACA;IALE,IAAAD,gBAAA,CAAAC,OAAA,wBAMsC,EAAE;IAExC;AACF;AACA;AACA;AACA;AACA;IALE,IAAAD,gBAAA,CAAAC,OAAA;IAqBE,IAAI,CAACS,UAAU,CAACH,OAAO,CAAC;IACxB,IAAI,CAACI,GAAG,CAACH,OAAO,CAAC;EACnB;;EAEA;AACF;AACA;AACA;AACA;AACA;EALE,IAAAI,aAAA,CAAAX,OAAA,EAAAI,sBAAA;IAAAQ,GAAA;IAAAC,KAAA,EAMA,SAAAJ,WAAmBH,OAAuB,EAAE;MAC1C,IAAI,CAACA,OAAO,GAAGA,OAAO;IACxB;;IAEA;AACF;AACA;AACA;AACA;AACA;EALE;IAAAM,GAAA;IAAAC,KAAA,EAMA,SAAAH,IAAWH,OAA0D,EAAE;MACrE,IAAI,CAACO,OAAO,CAACP,OAAO,CAAC;IACvB;;IAEA;AACF;AACA;AACA;AACA;AACA;EALE;IAAAK,GAAA;IAAAC,KAAA,EAMA,SAAAE,YAAmBC,GAAW,EAAE;MAC9B,IAAI,CAACC,QAAQ,GAAGD,GAAG;IACrB;;IAEA;AACF;AACA;AACA;AACA;AACA;EALE;IAAAJ,GAAA;IAAAC,KAAA,EAMA,SAAAK,gBAAuBC,KAAoB,EAAE;MAC3C,IAAI,CAACC,YAAY,GAAGD,KAAK;IAC3B;;IAEA;AACF;AACA;AACA;AACA;EAJE;IAAAP,GAAA;IAAAC,KAAA,EAKA,SAAAQ,YAAA,EAAqB;MACnB,OAAO,IAAI,CAACJ,QAAQ;IACtB;;IAEA;AACF;AACA;AACA;AACA;EAJE;IAAAL,GAAA;IAAAC,KAAA,EAKA,SAAAS,gBAAA,EAAyB;MACvB,OAAO,IAAI,CAACF,YAAY;IAC1B;;IAEA;AACF;AACA;AACA;AACA;AACA;EALE;IAAAR,GAAA;IAAAC,KAAA,EAMA,SAAAC,QAAgBP,OAA0D,EAAE;MAC1E,IAAI,CAACW,eAAe,CAACX,OAAO,aAAPA,OAAO,uBAAPA,OAAO,CAAEa,YAAY,CAAC;MAC3C,IAAI,CAACL,WAAW,CAACR,OAAO,aAAPA,OAAO,uBAAPA,OAAO,CAAEU,QAAQ,CAAC;IACrC;;IAEA;AACF;AACA;AACA;AACA;AACA;EALE;IAAAL,GAAA;IAAAC,KAAA,EAMA,SAAAU,OAAA,EAAiD;MAAA,IAAAC,KAAA;MAAA,SAAAC,IAAA,GAAA9B,SAAA,CAAAC,MAAA,EAAhC8B,QAAQ,OAAAC,KAAA,CAAAF,IAAA,GAAAG,IAAA,MAAAA,IAAA,GAAAH,IAAA,EAAAG,IAAA;QAARF,QAAQ,CAAAE,IAAA,IAAAjC,SAAA,CAAAiC,IAAA;MAAA;MACvB,IAAMC,QAAQ,GAAGH,QAAQ,CAACI,GAAG,CAAC,UAACC,OAAO,EAAK;QACzC,IAAI,CAAC,IAAAC,KAAA,CAAAhC,OAAA,EAAYiC,cAAO,CAAC,CAACC,QAAQ,CAACH,OAAO,CAACI,KAAK,CAAC,EAAE;UACjD,MAAM,IAAIC,KAAK,qCAAAC,MAAA,CACsBN,OAAO,CAACI,KAAK,gCAClD,CAAC;QACH;QAEA,IAAI,CAACG,aAAI,CAACC,SAAS,CAACR,OAAO,EAAEP,KAAI,CAACJ,YAAY,CAAC,EAAE;UAC/C,MAAM,IAAIoB,mBAAe,qCAAAH,MAAA,CACYN,OAAO,CAACI,KAAK,+CAClD,CAAC;QACH;QAEA,WAAApC,gBAAA,CAAAC,OAAA,MACG+B,OAAO,CAACI,KAAK,EAAGJ,OAAO,CAACU,UAAU;MAEvC,CAAC,CAAC;MAEF,OAAOZ,QAAQ,CAACa,MAAM,CAAC,UAACC,QAAQ,EAAEC,OAAO,EAAK;QAC5C,OAAOD,QAAQ,CAACE,IAAI,CAAC;UAAA;YACnB;YACArB,KAAI,CAAClB,OAAO,CAACA,OAAO,CAAC;cACnBwC,GAAG,KAAAT,MAAA,CAAKb,KAAI,CAACP,QAAQ,OAAAoB,MAAA,CAAIU,mBAAQ,CAAE;cACnCC,IAAI,EAAEJ,OAAO;cACbK,MAAM,EAAEC,qBAAU,CAACC;YACrB,CAAC;UAAC;QAAA,CACJ,CAAC;MACH,CAAC,EAAEC,QAAA,CAAApD,OAAA,CAAQqD,OAAO,CAAC,CAAC,CAAC;IACvB;;IAEA;AACF;AACA;AACA;AACA;AACA;EALE;IAAAzC,GAAA;IAAAC,KAAA,EAMA,SAAAyC,YAAoBC,OAAqC,EAAgB;MAAA,IAAAC,MAAA;MACvEC,oBAAW,CAACC,MAAM,CAACC,GAAG,iDAAAtB,MAAA,CAC4B,IAAAuB,UAAA,CAAA5D,OAAA,EAAeuD,OAAO,CAAC,CACzE,CAAC;MAED,IAAMP,IAAyB,GAAG,CAAC,CAAC;MACpC,IAAIa,KAAsB;MAE1B,IAAIC,0BAA0B,GAAG,KAAK;MAEtC,IAAAC,QAAA,CAAA/D,OAAA,EAAeuD,OAAO,CAAC,CAACzD,OAAO,CAAC,UAAAkE,KAAA,EAAkB;QAAA,IAAAC,KAAA,OAAAC,eAAA,CAAAlE,OAAA,EAAAgE,KAAA;UAAhBpD,GAAG,GAAAqD,KAAA;UAAEpD,KAAK,GAAAoD,KAAA;QAC1C,IACE,CAACH,0BAA0B,IAC3B,EAACxB,aAAI,aAAJA,aAAI,eAAJA,aAAI,IAAAD,MAAA,CAAMxB,KAAK,GAAGsD,mBAAO,GAAGC,qBAAS,EAAA/B,MAAA,CAAGzB,GAAG,EAAG,CAAC4C,MAAI,CAACpC,YAAY,CAAC,GAClE;UACAyC,KAAK,GAAG,IAAIrB,mBAAe,IAAAH,MAAA,CAAIzB,GAAG,QAAAyB,MAAA,CAAKxB,KAAK,8CAA2C,CAAC;QAC1F;QAEA,IAAIgD,KAAK,EAAE;UACT;QACF;QAEA,QAAQjD,GAAG;UACT,KAAKyD,cAAO,CAACC,KAAK;YAChBR,0BAA0B,GAAG,IAAI;YACjCd,IAAI,CAACuB,KAAK,GAAGvB,IAAI,CAACuB,KAAK,GAAA7E,aAAA,CAAAA,aAAA,KACfsD,IAAI,CAACuB,KAAK,WAAAxE,gBAAA,CAAAC,OAAA,MAAG,IAAAwE,iBAAS,EAAC5D,GAAG,CAAC,EAAGC,KAAK,SAAAd,gBAAA,CAAAC,OAAA,MACrC,IAAAwE,iBAAS,EAAC5D,GAAG,CAAC,EAAGC,KAAK,CAAC;YAC7B;UAEF,KAAKwD,cAAO,CAACI,cAAc;UAC3B,KAAKJ,cAAO,CAACK,WAAW;YACtB,IAAI,IAAA1C,KAAA,CAAAhC,OAAA,EAAYuD,OAAO,CAAC,CAACrB,QAAQ,CAACmC,cAAO,CAACC,KAAK,CAAC,EAAE;cAChDtB,IAAI,CAACuB,KAAK,GAAGvB,IAAI,CAACuB,KAAK,GAAA7E,aAAA,CAAAA,aAAA,KACfsD,IAAI,CAACuB,KAAK,WAAAxE,gBAAA,CAAAC,OAAA,MAAG,IAAAwE,iBAAS,EAAC5D,GAAG,CAAC,EAAGC,KAAK,SAAAd,gBAAA,CAAAC,OAAA,MACrC,IAAAwE,iBAAS,EAAC5D,GAAG,CAAC,EAAGC,KAAK,CAAC;cAC7BmC,IAAI,CAACuB,KAAK,CAAC,IAAAC,iBAAS,EAAC5D,GAAG,CAAC,CAAC,GAAGC,KAAK;YACpC,CAAC,MAAM;cACLmC,IAAI,CAAC,IAAAwB,iBAAS,EAAC5D,GAAG,CAAC,CAAC,OAAAb,gBAAA,CAAAC,OAAA,MAAK2E,mBAAO,EAAG9D,KAAK,CAAC;YAC3C;YACA;UAEF;YACEgD,KAAK,GAAG,IAAIrB,mBAAe,IAAAH,MAAA,CAAIzB,GAAG,QAAAyB,MAAA,CAAKxB,KAAK,8CAA2C,CAAC;QAC5F;MACF,CAAC,CAAC;MAEF,IAAIgD,KAAK,EAAE;QACT,OAAOT,QAAA,CAAApD,OAAA,CAAQ4E,MAAM,CAACf,KAAK,CAAC;MAC9B;;MAEA;MACA,OAAO,IAAI,CAACvD,OAAO,CAACA,OAAO,CAAC;QAC1BwC,GAAG,KAAAT,MAAA,CAAK,IAAI,CAACpB,QAAQ,OAAAoB,MAAA,CAAIU,mBAAQ,CAAE;QACnCC,IAAI,EAAJA,IAAI;QACJC,MAAM,EAAEC,qBAAU,CAACC;MACrB,CAAC,CAAC;IACJ;;IAEA;AACF;AACA;AACA;AACA;AACA;EALE;IAAAvC,GAAA;IAAAC,KAAA,EAMA,SAAAgE,eAAsBC,OAAgB,EAAgB;MACpD,OAAO,IAAI,CAACxB,WAAW,KAAAvD,gBAAA,CAAAC,OAAA,MAAGqE,cAAO,CAACK,WAAW,EAAGI,OAAO,CAAC,CAAC;IAC3D;;IAEA;AACF;AACA;AACA;AACA;AACA;EALE;IAAAlE,GAAA;IAAAC,KAAA,EAMA,SAAAkE,kBAAyBD,OAAgB,EAAgB;MACvD,OAAO,IAAI,CAACxB,WAAW,KAAAvD,gBAAA,CAAAC,OAAA,MAAGqE,cAAO,CAACI,cAAc,EAAGK,OAAO,CAAC,CAAC;IAC9D;;IAEA;AACF;AACA;AACA;AACA;AACA;AACA;AACA;EAPE;IAAAlE,GAAA;IAAAC,KAAA,EAQA,SAAAmE,WACEC,YAAqB,EACrBC,qBAA8B,EAC9BC,kBAA2B,EACb;MACd,OAAO,IAAI,CAAC7B,WAAW,KAAAvD,gBAAA,CAAAC,OAAA,MAAAD,gBAAA,CAAAC,OAAA,MAAAD,gBAAA,CAAAC,OAAA,MACpBqE,cAAO,CAACC,KAAK,EAAGW,YAAY,GAC5BZ,cAAO,CAACI,cAAc,EAAGS,qBAAqB,GAC9Cb,cAAO,CAACK,WAAW,EAAGS,kBAAkB,CAC1C,CAAC;IACJ;EAAC;EAAA,OAAA/E,sBAAA;AAAA"}

package/dist/controls-options-manager/types.js

@@ -0,0 +1,7 @@
+"use strict";
+
+var _Object$defineProperty = require("@babel/runtime-corejs2/core-js/object/define-property");
+_Object$defineProperty(exports, "__esModule", {
+  value: true
+});
+//# sourceMappingURL=types.js.map

package/dist/controls-options-manager/types.js.map

@@ -0,0 +1 @@
+{"version":3,"names":[],"sources":["types.ts"],"sourcesContent":["import {Control} from './enums';\n\nexport interface ControlProperties {\n  /**\n   * A list of additional properties that apply to various specific settings.\n   *\n   * @remarks\n   * The values stored here, per the service, are fully ambiguous, an can vary\n   * depending on which control scope is being configured.\n   */\n  [key: string]: boolean;\n}\n\nexport interface AudioProperties {\n  muted?: boolean;\n  disallowUnmute?: boolean;\n  muteOnEntry?: boolean;\n}\n\nexport interface RaiseHandProperties {\n  enabled?: boolean;\n}\n\nexport interface ReactionsProperties {\n  enabled?: boolean;\n  showDisplayNameWithReactions?: boolean;\n}\n\nexport interface ShareControlProperties {\n  control?: 'ANYONE' | 'MODERATOR_PRESENTER';\n}\n\nexport interface VideoProperties {\n  enabled?: boolean;\n}\n\nexport interface ViewTheParticipantListProperties {\n  enabled?: boolean;\n}\n\nexport type Properties =\n  | AudioProperties\n  | RaiseHandProperties\n  | ReactionsProperties\n  | ShareControlProperties\n  | VideoProperties\n  | ViewTheParticipantListProperties;\n\nexport interface ControlConfig<Props = Properties> {\n  /**\n   * The scope of the control within this object.\n   */\n  scope: Control;\n\n  /**\n   * The properties to assign to this control.\n   */\n  properties: Props;\n}\n"],"mappings":""}

package/dist/controls-options-manager/util.js

@@ -1,28 +1,318 @@
 "use strict";
 
 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 _classCallCheck2 = _interopRequireDefault(require("@babel/runtime-corejs2/helpers/classCallCheck"));
+var _createClass2 = _interopRequireDefault(require("@babel/runtime-corejs2/helpers/createClass"));
 var _constants = require("../constants");
-var canSetMuteOnEntry = function canSetMuteOnEntry(displayHints) {
-  return displayHints.includes(_constants.DISPLAY_HINTS.ENABLE_MUTE_ON_ENTRY);
-};
-var canSetDisallowUnmute = function canSetDisallowUnmute(displayHints) {
-  return displayHints.includes(_constants.DISPLAY_HINTS.ENABLE_HARD_MUTE);
-};
-var canUnsetMuteOnEntry = function canUnsetMuteOnEntry(displayHints) {
-  return displayHints.includes(_constants.DISPLAY_HINTS.DISABLE_MUTE_ON_ENTRY);
-};
-var canUnsetDisallowUnmute = function canUnsetDisallowUnmute(displayHints) {
-  return displayHints.includes(_constants.DISPLAY_HINTS.DISABLE_HARD_MUTE);
-};
-var _default = {
-  canSetMuteOnEntry: canSetMuteOnEntry,
-  canSetDisallowUnmute: canSetDisallowUnmute,
-  canUnsetMuteOnEntry: canUnsetMuteOnEntry,
-  canUnsetDisallowUnmute: canUnsetDisallowUnmute
-};
-exports.default = _default;
+var _enums = require("./enums");
+/**
+ * The Controls Options Manager utilities
+ *
+ * @internal
+ */
+var Utils = /*#__PURE__*/function () {
+  function Utils() {
+    (0, _classCallCheck2.default)(this, Utils);
+  }
+  (0, _createClass2.default)(Utils, null, [{
+    key: "canSetMuteOnEntry",
+    value:
+    /**
+     * Validate if enabling mute on entry can be set.
+     *
+     * @param {Array<string>} displayHints - Display Hints to use when validating.
+     * @returns {boolean} - True if the action is allowed.
+     */
+    function canSetMuteOnEntry(displayHints) {
+      return displayHints.includes(_constants.DISPLAY_HINTS.ENABLE_MUTE_ON_ENTRY);
+    }
+
+    /**
+     * Validate if allowing unmuting can be set.
+     *
+     * @param {Array<string>} displayHints - Display Hints to use when validating.
+     * @returns {boolean} - True if the action is allowed.
+     */
+  }, {
+    key: "canSetDisallowUnmute",
+    value: function canSetDisallowUnmute(displayHints) {
+      return displayHints.includes(_constants.DISPLAY_HINTS.ENABLE_HARD_MUTE);
+    }
+
+    /**
+     * Validate if disabling mute on entry can be set.
+     *
+     * @param {Array<string>} displayHints - Display Hints to use when validating.
+     * @returns {boolean} - True if the action is allowed.
+     */
+  }, {
+    key: "canUnsetMuteOnEntry",
+    value: function canUnsetMuteOnEntry(displayHints) {
+      return displayHints.includes(_constants.DISPLAY_HINTS.DISABLE_MUTE_ON_ENTRY);
+    }
+
+    /**
+     * Validate if enabling muting can be set.
+     *
+     * @param {Array<string>} displayHints - Display Hints to use when validating.
+     * @returns {boolean} - True if the action is allowed.
+     */
+  }, {
+    key: "canUnsetDisallowUnmute",
+    value: function canUnsetDisallowUnmute(displayHints) {
+      return displayHints.includes(_constants.DISPLAY_HINTS.DISABLE_HARD_MUTE);
+    }
+
+    /**
+     * Validate if muting all can be set.
+     *
+     * @param {Array<string>} displayHints - Display Hints to use when validating.
+     * @returns {boolean} - True if the action is allowed.
+     */
+  }, {
+    key: "canSetMuted",
+    value: function canSetMuted(displayHints) {
+      return displayHints.includes(_constants.DISPLAY_HINTS.MUTE_ALL);
+    }
+
+    /**
+     * Validate if unmuting all can be set.
+     *
+     * @param {Array<string>} displayHints - Display Hints to use when validating.
+     * @returns {boolean} - True if the action is allowed.
+     */
+  }, {
+    key: "canUnsetMuted",
+    value: function canUnsetMuted(displayHints) {
+      return displayHints.includes(_constants.DISPLAY_HINTS.UNMUTE_ALL);
+    }
+
+    /**
+     * Validate an array of hints are allowed based on a full collection of hints.
+     *
+     * @param {Object} config - Configuration Object.
+     * @param {Array<string>} config.requiredHints - Hints required for validation.
+     * @param {Array<string>} config.displayHints - All available hints.
+     * @returns {boolean} - True if all of the actions are allowed.
+     */
+  }, {
+    key: "hasHints",
+    value: function hasHints(config) {
+      var requiredHints = config.requiredHints,
+        displayHints = config.displayHints;
+      return requiredHints.every(function (hint) {
+        return displayHints.includes(hint);
+      });
+    }
+
+    /**
+     * Validate that the self policy object contains the required policies.
+     *
+     * @param {Object} config - Configuration Object.
+     * @param {Array<string>} config.requiredPolicies - Policies required for validation.
+     * @param {Array<string>} config.policies - All available policies.
+     * @returns {boolean} - True if all of the actions are allowed.
+     */
+  }, {
+    key: "hasPolicies",
+    value: function hasPolicies(config) {
+      var requiredPolicies = config.requiredPolicies,
+        _config$policies = config.policies,
+        policies = _config$policies === void 0 ? {} : _config$policies;
+      return requiredPolicies.every(function (hint) {
+        return policies[hint];
+      });
+    }
+
+    /**
+     * Validate if an audio-scoped control is allowed to be sent to the service.
+     *
+     * @param {ControlConfig<AudioProperties>} control - Audio control config to validate.
+     * @param {Array<string>} displayHints - All available hints.
+     * @returns {boolean} - True if all of the actions are allowed.
+     */
+  }, {
+    key: "canUpdateAudio",
+    value: function canUpdateAudio(control, displayHints) {
+      var requiredHints = [];
+      if (control.properties.muted === true) {
+        requiredHints.push(_constants.DISPLAY_HINTS.MUTE_ALL);
+      }
+      if (control.properties.muted === false) {
+        requiredHints.push(_constants.DISPLAY_HINTS.UNMUTE_ALL);
+      }
+      if (control.properties.disallowUnmute === true) {
+        requiredHints.push(_constants.DISPLAY_HINTS.ENABLE_HARD_MUTE);
+      }
+      if (control.properties.disallowUnmute === false) {
+        requiredHints.push(_constants.DISPLAY_HINTS.DISABLE_HARD_MUTE);
+      }
+      if (control.properties.muteOnEntry === true) {
+        requiredHints.push(_constants.DISPLAY_HINTS.ENABLE_MUTE_ON_ENTRY);
+      }
+      if (control.properties.muteOnEntry === false) {
+        requiredHints.push(_constants.DISPLAY_HINTS.DISABLE_MUTE_ON_ENTRY);
+      }
+      return Utils.hasHints({
+        requiredHints: requiredHints,
+        displayHints: displayHints
+      });
+    }
+  }, {
+    key: "canUpdateRaiseHand",
+    value: function canUpdateRaiseHand(control, displayHints) {
+      var requiredHints = [];
+      if (control.properties.enabled === true) {
+        requiredHints.push(_constants.DISPLAY_HINTS.ENABLE_RAISE_HAND);
+      }
+      if (control.properties.enabled === false) {
+        requiredHints.push(_constants.DISPLAY_HINTS.DISABLE_RAISE_HAND);
+      }
+      return Utils.hasHints({
+        requiredHints: requiredHints,
+        displayHints: displayHints
+      });
+    }
+
+    /**
+     * Validate if an reactions-scoped control is allowed to be sent to the service.
+     *
+     * @param {ControlConfig<ReactionsProperties>} control - Reaction control config to validate.
+     * @param {Array<string>} displayHints - All available hints.
+     * @returns {boolean} - True if all of the actions are allowed.
+     */
+  }, {
+    key: "canUpdateReactions",
+    value: function canUpdateReactions(control, displayHints) {
+      var requiredHints = [];
+
+      // This additional if statement avoids the display hint discrepency due to
+      // the service blocking partial requests with this property only.
+      if (control.properties.showDisplayNameWithReactions !== undefined) {
+        if (control.properties.showDisplayNameWithReactions === true) {
+          requiredHints.push(_constants.DISPLAY_HINTS.ENABLE_SHOW_DISPLAY_NAME);
+        }
+        if (control.properties.showDisplayNameWithReactions === false) {
+          requiredHints.push(_constants.DISPLAY_HINTS.DISABLE_SHOW_DISPLAY_NAME);
+        }
+      } else {
+        if (control.properties.enabled === true) {
+          requiredHints.push(_constants.DISPLAY_HINTS.ENABLE_REACTIONS);
+        }
+        if (control.properties.enabled === false) {
+          requiredHints.push(_constants.DISPLAY_HINTS.DISABLE_REACTIONS);
+        }
+      }
+      return Utils.hasHints({
+        requiredHints: requiredHints,
+        displayHints: displayHints
+      });
+    }
+
+    /**
+     * Validate if an share-control-scoped control is allowed to be sent to the service.
+     *
+     * @param {Array<string>} displayHints - All available hints.
+     * @returns {boolean} - True if all of the actions are allowed.
+     */
+  }, {
+    key: "canUpdateShareControl",
+    value: function canUpdateShareControl(displayHints) {
+      return Utils.hasHints({
+        requiredHints: [_constants.DISPLAY_HINTS.SHARE_CONTROL],
+        displayHints: displayHints
+      });
+    }
+
+    /**
+     * Validate if an view-the-participants-list-scoped control is allowed to be sent to the service.
+     *
+     * @param {ControlConfig<ViewTheParticipantListProperties>} control - View Participants List control config to validate.
+     * @param {Array<string>} displayHints - All available hints.
+     * @returns {boolean} - True if all of the actions are allowed.
+     */
+  }, {
+    key: "canUpdateViewTheParticipantsList",
+    value: function canUpdateViewTheParticipantsList(control, displayHints) {
+      var requiredHints = [];
+      if (control.properties.enabled === true) {
+        requiredHints.push(_constants.DISPLAY_HINTS.ENABLE_VIEW_THE_PARTICIPANT_LIST);
+      }
+      if (control.properties.enabled === false) {
+        requiredHints.push(_constants.DISPLAY_HINTS.DISABLE_VIEW_THE_PARTICIPANT_LIST);
+      }
+      return Utils.hasHints({
+        requiredHints: requiredHints,
+        displayHints: displayHints
+      });
+    }
+
+    /**
+     * Validate if a video-scoped control is allowed to be sent to the service.
+     *
+     * @param {ControlConfig<VideoProperties>} control - Video control config to validate.
+     * @param {Array<string>} displayHints - All available hints.
+     * @returns {boolean} - True if all of the actions are allowed.
+     */
+  }, {
+    key: "canUpdateVideo",
+    value: function canUpdateVideo(control, displayHints) {
+      var requiredHints = [];
+      if (control.properties.enabled === true) {
+        requiredHints.push(_constants.DISPLAY_HINTS.ENABLE_VIDEO);
+      }
+      if (control.properties.enabled === false) {
+        requiredHints.push(_constants.DISPLAY_HINTS.DISABLE_VIDEO);
+      }
+      return Utils.hasHints({
+        requiredHints: requiredHints,
+        displayHints: displayHints
+      });
+    }
+
+    /**
+     * Validate that a control can be sent to the service based on the provided
+     * display hints.
+     *
+     * @param {ControlConfig} control - Control to validate.
+     * @param {Array<string>} displayHints - All available hints.
+     * @returns {boolean} - True if all of the actions are allowed.
+     */
+  }, {
+    key: "canUpdate",
+    value: function canUpdate(control, displayHints) {
+      var determinant;
+      switch (control.scope) {
+        case _enums.Control.audio:
+          determinant = Utils.canUpdateAudio(control, displayHints);
+          break;
+        case _enums.Control.raiseHand:
+          determinant = Utils.canUpdateRaiseHand(control, displayHints);
+          break;
+        case _enums.Control.reactions:
+          determinant = Utils.canUpdateReactions(control, displayHints);
+          break;
+        case _enums.Control.shareControl:
+          determinant = Utils.canUpdateShareControl(displayHints);
+          break;
+        case _enums.Control.video:
+          determinant = Utils.canUpdateVideo(control, displayHints);
+          break;
+        case _enums.Control.viewTheParticipantList:
+          determinant = Utils.canUpdateViewTheParticipantsList(control, displayHints);
+          break;
+        default:
+          determinant = false;
+      }
+      return determinant;
+    }
+  }]);
+  return Utils;
+}();
+var _default = exports.default = Utils;
 //# sourceMappingURL=util.js.map