@webex/plugin-meetings 3.0.0-beta.21 → 3.0.0-beta.211

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

@@ -0,0 +1,297 @@
+"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"));
+var _camelCase2 = _interopRequireDefault(require("lodash/camelCase"));
+var _permission = _interopRequireDefault(require("../common/errors/permission"));
+var _constants = require("../constants");
+var _loggerProxy = _interopRequireDefault(require("../common/logs/logger-proxy"));
+var _enums = require("./enums");
+var _util = _interopRequireDefault(require("./util"));
+var _constants2 = require("./constants");
+function ownKeys(object, enumerableOnly) { var keys = _Object$keys2(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; }
+/**
+ * docs
+ * https://sqbu-github.cisco.com/pages/WebExSquared/locus/guides/mute.html
+ * https://confluence-eng-gpk2.cisco.com/conf/display/LOCUS/Hard+Mute+and+Audio+Privacy#HardMuteandAudioPrivacy-SelfMuteonEntry
+ * 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
+ * https://jira-eng-gpk2.cisco.com/jira/browse/SPARK-180867
+ * https://jira-eng-gpk2.cisco.com/jira/browse/SPARK-393351
+ */
+/**
+ * @description ControlsOptionsManager is responsible for handling the behavior of participant controls when somebody joins a meeting
+ * @export
+ * @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
+   */
+
+  /**
+   * @param {MeetingRequest} request
+   * @param {Object} options
+   * @constructor
+   * @memberof ControlsOptionsManager
+   */
+  function ControlsOptionsManager(request, options) {
+    (0, _classCallCheck2.default)(this, ControlsOptionsManager);
+    (0, _defineProperty2.default)(this, "request", void 0);
+    (0, _defineProperty2.default)(this, "displayHints", []);
+    (0, _defineProperty2.default)(this, "locusUrl", void 0);
+    this.initialize(request);
+    this.set(options);
+  }
+
+  /**
+   * @param {MeetingRequest} request
+   * @returns {void}
+   * @private
+   * @memberof ControlsOptionsManager
+   */
+  (0, _createClass2.default)(ControlsOptionsManager, [{
+    key: "initialize",
+    value: function initialize(request) {
+      this.request = request;
+    }
+
+    /**
+     * @param {Object} options
+     * @returns {void}
+     * @public
+     * @memberof ControlsOptionsManager
+     */
+  }, {
+    key: "set",
+    value: function set(options) {
+      this.extract(options);
+    }
+
+    /**
+     * @param {string} url
+     * @returns {void}
+     * @public
+     * @memberof ControlsOptionsManager
+     */
+  }, {
+    key: "setLocusUrl",
+    value: function setLocusUrl(url) {
+      this.locusUrl = url;
+    }
+
+    /**
+     * @param {Array} hints
+     * @returns {void}
+     * @public
+     * @memberof ControlsOptionsManager
+     */
+  }, {
+    key: "setDisplayHints",
+    value: function setDisplayHints(hints) {
+      this.displayHints = hints;
+    }
+
+    /**
+     * @returns {string}
+     * @public
+     * @memberof ControlsOptionsManager
+     */
+  }, {
+    key: "getLocusUrl",
+    value: function getLocusUrl() {
+      return this.locusUrl;
+    }
+
+    /**
+     * @returns {Array}
+     * @public
+     * @memberof ControlsOptionsManager
+     */
+  }, {
+    key: "getDisplayHints",
+    value: function getDisplayHints() {
+      return this.displayHints;
+    }
+
+    /**
+     * @param {Object} options
+     * @returns {void}
+     * @private
+     * @memberof ControlsOptionsManager
+     */
+  }, {
+    key: "extract",
+    value: function extract(options) {
+      this.setDisplayHints(options === null || options === void 0 ? void 0 : options.displayHints);
+      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
+     * @private
+     * @memberof ControlsOptionsManager
+     * @returns {Promise}
+     */
+  }, {
+    key: "setControls",
+    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, _camelCase2.default)(key), value)) : (0, _defineProperty2.default)({}, (0, _camelCase2.default)(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, _camelCase2.default)(key), value)) : (0, _defineProperty2.default)({}, (0, _camelCase2.default)(key), value);
+              body.audio[(0, _camelCase2.default)(key)] = value;
+            } else {
+              body[(0, _camelCase2.default)(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);
+      }
+
+      // @ts-ignore
+      return this.request.request({
+        uri: "".concat(this.locusUrl, "/").concat(_constants.CONTROLS),
+        body: body,
+        method: _constants.HTTP_VERBS.PATCH
+      });
+    }
+
+    /**
+     * @public
+     * @param {boolean} enabled
+     * @memberof ControlsOptionsManager
+     * @returns {Promise}
+     */
+  }, {
+    key: "setMuteOnEntry",
+    value: function setMuteOnEntry(enabled) {
+      return this.setControls((0, _defineProperty2.default)({}, _enums.Setting.muteOnEntry, enabled));
+    }
+
+    /**
+     * @public
+     * @param {boolean} enabled
+     * @memberof ControlsOptionsManager
+     * @returns {Promise}
+     */
+  }, {
+    key: "setDisallowUnmute",
+    value: function setDisallowUnmute(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) {
+      var _this$setControls3;
+      return this.setControls((_this$setControls3 = {}, (0, _defineProperty2.default)(_this$setControls3, _enums.Setting.muted, mutedEnabled), (0, _defineProperty2.default)(_this$setControls3, _enums.Setting.disallowUnmute, disallowUnmuteEnabled), (0, _defineProperty2.default)(_this$setControls3, _enums.Setting.muteOnEntry, muteOnEntryEnabled), _this$setControls3));
+    }
+  }]);
+  return ControlsOptionsManager;
+}();
+exports.default = ControlsOptionsManager;
+//# sourceMappingURL=index.js.map

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

@@ -0,0 +1 @@
+{"version":3,"names":["ControlsOptionsManager","request","options","initialize","set","extract","url","locusUrl","hints","displayHints","setDisplayHints","setLocusUrl","controls","payloads","map","control","Control","includes","scope","Error","Util","canUpdate","PermissionError","properties","reduce","previous","payload","then","uri","CONTROLS","body","method","HTTP_VERBS","PATCH","resolve","setting","LoggerProxy","logger","log","error","shouldSkipCheckToMergeBody","forEach","key","value","CAN_SET","CAN_UNSET","Setting","muted","audio","disallowUnmute","muteOnEntry","ENABLED","reject","enabled","setControls","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":";;;;;;;;;;;;;;;;;;;;;;AACA;AACA;AAEA;AACA;AAEA;AACA;AAAwD;AAAA;AAExD;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AAEA;AACA;AACA;AACA;AACA;AACA;AALA,IAMqBA,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,gCACEC,OAAuB,EACvBC,OAGC,EACD;IAAA;IAAA;IAAA,oDAtBoC,EAAE;IAAA;IAuBtC,IAAI,CAACC,UAAU,CAACF,OAAO,CAAC;IACxB,IAAI,CAACG,GAAG,CAACF,OAAO,CAAC;EACnB;;EAEA;AACF;AACA;AACA;AACA;AACA;EALE;IAAA;IAAA,OAMA,oBAAmBD,OAAuB,EAAE;MAC1C,IAAI,CAACA,OAAO,GAAGA,OAAO;IACxB;;IAEA;AACF;AACA;AACA;AACA;AACA;EALE;IAAA;IAAA,OAMA,aAAWC,OAA0D,EAAE;MACrE,IAAI,CAACG,OAAO,CAACH,OAAO,CAAC;IACvB;;IAEA;AACF;AACA;AACA;AACA;AACA;EALE;IAAA;IAAA,OAMA,qBAAmBI,GAAW,EAAE;MAC9B,IAAI,CAACC,QAAQ,GAAGD,GAAG;IACrB;;IAEA;AACF;AACA;AACA;AACA;AACA;EALE;IAAA;IAAA,OAMA,yBAAuBE,KAAoB,EAAE;MAC3C,IAAI,CAACC,YAAY,GAAGD,KAAK;IAC3B;;IAEA;AACF;AACA;AACA;AACA;EAJE;IAAA;IAAA,OAKA,uBAAqB;MACnB,OAAO,IAAI,CAACD,QAAQ;IACtB;;IAEA;AACF;AACA;AACA;AACA;EAJE;IAAA;IAAA,OAKA,2BAAyB;MACvB,OAAO,IAAI,CAACE,YAAY;IAC1B;;IAEA;AACF;AACA;AACA;AACA;AACA;EALE;IAAA;IAAA,OAMA,iBAAgBP,OAA0D,EAAE;MAC1E,IAAI,CAACQ,eAAe,CAACR,OAAO,aAAPA,OAAO,uBAAPA,OAAO,CAAEO,YAAY,CAAC;MAC3C,IAAI,CAACE,WAAW,CAACT,OAAO,aAAPA,OAAO,uBAAPA,OAAO,CAAEK,QAAQ,CAAC;IACrC;;IAEA;AACF;AACA;AACA;AACA;AACA;EALE;IAAA;IAAA,OAMA,kBAAiD;MAAA;MAAA,kCAAhCK,QAAQ;QAARA,QAAQ;MAAA;MACvB,IAAMC,QAAQ,GAAGD,QAAQ,CAACE,GAAG,CAAC,UAACC,OAAO,EAAK;QACzC,IAAI,CAAC,mBAAYC,cAAO,CAAC,CAACC,QAAQ,CAACF,OAAO,CAACG,KAAK,CAAC,EAAE;UACjD,MAAM,IAAIC,KAAK,4CACsBJ,OAAO,CAACG,KAAK,iCACjD;QACH;QAEA,IAAI,CAACE,aAAI,CAACC,SAAS,CAACN,OAAO,EAAE,KAAI,CAACN,YAAY,CAAC,EAAE;UAC/C,MAAM,IAAIa,mBAAe,4CACYP,OAAO,CAACG,KAAK,gDACjD;QACH;QAEA,yCACGH,OAAO,CAACG,KAAK,EAAGH,OAAO,CAACQ,UAAU;MAEvC,CAAC,CAAC;MAEF,OAAOV,QAAQ,CAACW,MAAM,CAAC,UAACC,QAAQ,EAAEC,OAAO,EAAK;QAC5C,OAAOD,QAAQ,CAACE,IAAI,CAAC;UAAA;YACnB;YACA,KAAI,CAAC1B,OAAO,CAACA,OAAO,CAAC;cACnB2B,GAAG,YAAK,KAAI,CAACrB,QAAQ,cAAIsB,mBAAQ,CAAE;cACnCC,IAAI,EAAEJ,OAAO;cACbK,MAAM,EAAEC,qBAAU,CAACC;YACrB,CAAC;UAAC;QAAA,EACH;MACH,CAAC,EAAE,iBAAQC,OAAO,EAAE,CAAC;IACvB;;IAEA;AACF;AACA;AACA;AACA;AACA;EALE;IAAA;IAAA,OAMA,qBAAoBC,OAAqC,EAAgB;MAAA;MACvEC,oBAAW,CAACC,MAAM,CAACC,GAAG,wDAC4B,wBAAeH,OAAO,CAAC,EACxE;MAED,IAAML,IAAyB,GAAG,CAAC,CAAC;MACpC,IAAIS,KAAsB;MAE1B,IAAIC,0BAA0B,GAAG,KAAK;MAEtC,sBAAeL,OAAO,CAAC,CAACM,OAAO,CAAC,iBAAkB;QAAA;UAAhBC,GAAG;UAAEC,KAAK;QAC1C,IACE,CAACH,0BAA0B,IAC3B,EAACpB,aAAI,aAAJA,aAAI,eAAJA,aAAI,WAAMuB,KAAK,GAAGC,mBAAO,GAAGC,qBAAS,SAAGH,GAAG,EAAG,CAAC,MAAI,CAACjC,YAAY,CAAC,GAClE;UACA8B,KAAK,GAAG,IAAIjB,mBAAe,WAAIoB,GAAG,eAAKC,KAAK,+CAA4C;QAC1F;QAEA,IAAIJ,KAAK,EAAE;UACT;QACF;QAEA,QAAQG,GAAG;UACT,KAAKI,cAAO,CAACC,KAAK;YAChBP,0BAA0B,GAAG,IAAI;YACjCV,IAAI,CAACkB,KAAK,GAAGlB,IAAI,CAACkB,KAAK,mCACflB,IAAI,CAACkB,KAAK,yCAAG,yBAAUN,GAAG,CAAC,EAAGC,KAAK,uCACrC,yBAAUD,GAAG,CAAC,EAAGC,KAAK,CAAC;YAC7B;UAEF,KAAKG,cAAO,CAACG,cAAc;UAC3B,KAAKH,cAAO,CAACI,WAAW;YACtB,IAAI,mBAAYf,OAAO,CAAC,CAAClB,QAAQ,CAAC6B,cAAO,CAACC,KAAK,CAAC,EAAE;cAChDjB,IAAI,CAACkB,KAAK,GAAGlB,IAAI,CAACkB,KAAK,mCACflB,IAAI,CAACkB,KAAK,yCAAG,yBAAUN,GAAG,CAAC,EAAGC,KAAK,uCACrC,yBAAUD,GAAG,CAAC,EAAGC,KAAK,CAAC;cAC7Bb,IAAI,CAACkB,KAAK,CAAC,yBAAUN,GAAG,CAAC,CAAC,GAAGC,KAAK;YACpC,CAAC,MAAM;cACLb,IAAI,CAAC,yBAAUY,GAAG,CAAC,CAAC,qCAAKS,mBAAO,EAAGR,KAAK,CAAC;YAC3C;YACA;UAEF;YACEJ,KAAK,GAAG,IAAIjB,mBAAe,WAAIoB,GAAG,eAAKC,KAAK,+CAA4C;QAAC;MAE/F,CAAC,CAAC;MAEF,IAAIJ,KAAK,EAAE;QACT,OAAO,iBAAQa,MAAM,CAACb,KAAK,CAAC;MAC9B;;MAEA;MACA,OAAO,IAAI,CAACtC,OAAO,CAACA,OAAO,CAAC;QAC1B2B,GAAG,YAAK,IAAI,CAACrB,QAAQ,cAAIsB,mBAAQ,CAAE;QACnCC,IAAI,EAAJA,IAAI;QACJC,MAAM,EAAEC,qBAAU,CAACC;MACrB,CAAC,CAAC;IACJ;;IAEA;AACF;AACA;AACA;AACA;AACA;EALE;IAAA;IAAA,OAMA,wBAAsBoB,OAAgB,EAAgB;MACpD,OAAO,IAAI,CAACC,WAAW,mCAAGR,cAAO,CAACI,WAAW,EAAGG,OAAO,EAAE;IAC3D;;IAEA;AACF;AACA;AACA;AACA;AACA;EALE;IAAA;IAAA,OAMA,2BAAyBA,OAAgB,EAAgB;MACvD,OAAO,IAAI,CAACC,WAAW,mCAAGR,cAAO,CAACG,cAAc,EAAGI,OAAO,EAAE;IAC9D;;IAEA;AACF;AACA;AACA;AACA;AACA;AACA;AACA;EAPE;IAAA;IAAA,OAQA,oBACEE,YAAqB,EACrBC,qBAA8B,EAC9BC,kBAA2B,EACb;MAAA;MACd,OAAO,IAAI,CAACH,WAAW,6EACpBR,cAAO,CAACC,KAAK,EAAGQ,YAAY,qDAC5BT,cAAO,CAACG,cAAc,EAAGO,qBAAqB,qDAC9CV,cAAO,CAACI,WAAW,EAAGO,kBAAkB,uBACzC;IACJ;EAAC;EAAA;AAAA;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

@@ -0,0 +1,319 @@
+"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 _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 = Utils;
+exports.default = _default;
+//# sourceMappingURL=util.js.map