@webex/plugin-meetings 3.0.0-beta.13 → 3.0.0-beta.131

package/dist/members/types.js

@@ -0,0 +1,15 @@
+"use strict";
+
+var _Object$defineProperty = require("@babel/runtime-corejs2/core-js/object/define-property");
+_Object$defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.ServerRoles = void 0;
+var ServerRoles;
+exports.ServerRoles = ServerRoles;
+(function (ServerRoles) {
+  ServerRoles["Cohost"] = "COHOST";
+  ServerRoles["Moderator"] = "MODERATOR";
+  ServerRoles["Presenter"] = "PRESENTER";
+})(ServerRoles || (exports.ServerRoles = ServerRoles = {}));
+//# sourceMappingURL=types.js.map

package/dist/members/types.js.map

@@ -0,0 +1 @@
+{"version":3,"names":["ServerRoles"],"sources":["types.ts"],"sourcesContent":["export enum ServerRoles {\n  Cohost = 'COHOST',\n  Moderator = 'MODERATOR',\n  Presenter = 'PRESENTER',\n}\n\nexport type ServerRoleShape = {\n  type: ServerRoles;\n  hasRole: boolean;\n};\n\nexport type RoleAssignmentOptions = {\n  roles: Array<ServerRoleShape>;\n  locusUrl: string;\n  memberId: string;\n};\n\nexport type RoleAssignmentBody = {\n  role: {\n    roles: Array<ServerRoleShape>;\n  };\n};\n\nexport type RoleAssignmentRequest = {\n  method: string;\n  uri: string;\n  body: RoleAssignmentBody;\n};\n"],"mappings":";;;;;;;IAAYA,WAAW;AAAA;AAAA,WAAXA,WAAW;EAAXA,WAAW;EAAXA,WAAW;EAAXA,WAAW;AAAA,GAAXA,WAAW,2BAAXA,WAAW"}

package/dist/members/util.js

@@ -1,280 +1,334 @@
 "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 _defineProperty2 = _interopRequireDefault(require("@babel/runtime-corejs2/helpers/defineProperty"));
 var _uuid = _interopRequireDefault(require("uuid"));
-
 var _constants = require("../constants");
-
-var MembersUtil = {};
-/**
- * @param {Object} invitee with emailAddress, email or phoneNumber
- * @param {String} locusUrl
- * @param {Boolean} alertIfActive
- * @returns {Object} the format object
- */
-
-MembersUtil.generateAddMemberOptions = function (invitee, locusUrl, alertIfActive) {
-  return {
-    invitee: invitee,
-    locusUrl: locusUrl,
-    alertIfActive: alertIfActive
-  };
-};
-/**
- * @param {Array} memberIds
- * @param {String} locusUrl
- * @returns {Object} the format object
- */
-
-
-MembersUtil.generateAdmitMemberOptions = function (memberIds, locusUrl) {
-  return {
-    locusUrl: locusUrl,
-    memberIds: memberIds
-  };
-};
-/**
- * @param {Object} options with {invitee: {emailAddress, email, phoneNumber}, alertIfActive}
- * @returns {Object} with {invitees: [{address}], alertIfActive}
- */
-
-
-MembersUtil.getAddMemberBody = function (options) {
-  return {
-    invitees: [{
-      address: options.invitee.emailAddress || options.invitee.email || options.invitee.phoneNumber
-    }],
-    alertIfActive: options.alertIfActive
-  };
-};
-/**
- * @param {Object} options with {memberIds}
- * @returns {Object} admit with {memberIds}
- */
-
-
-MembersUtil.getAdmitMemberRequestBody = function (options) {
-  return {
-    admit: {
-      participantIds: options.memberIds
-    }
-  };
-};
-/**
- * @param {Object} format with {memberIds, locusUrl}
- * @returns {Object} the request parameters (method, uri, body) needed to make a admitMember request
- */
-
-
-MembersUtil.getAdmitMemberRequestParams = function (format) {
-  var body = MembersUtil.getAdmitMemberRequestBody(format);
-  var uri = "".concat(format.locusUrl, "/").concat(_constants.CONTROLS);
-  return {
-    method: _constants.HTTP_VERBS.PUT,
-    uri: uri,
-    body: body
-  };
-};
-/**
- * @param {Object} format with {invitee {emailAddress, email, phoneNumber}, locusUrl, alertIfActive}
- * @returns {Object} the request parameters (method, uri, body) needed to make a addMember request
- */
-
-
-MembersUtil.getAddMemberRequestParams = function (format) {
-  var body = MembersUtil.getAddMemberBody(format);
-  var requestParams = {
-    method: _constants.HTTP_VERBS.PUT,
-    uri: format.locusUrl,
-    body: body
-  };
-  return requestParams;
-};
-
-MembersUtil.isInvalidInvitee = function (invitee) {
-  if (!(invitee && (invitee.email || invitee.emailAddress || invitee.phoneNumber))) {
-    return true;
-  }
-
-  if (invitee.phoneNumber) {
-    return !_constants.DIALER_REGEX.E164_FORMAT.test(invitee.phoneNumber);
-  }
-
-  return !_constants.VALID_EMAIL_ADDRESS.test(invitee.email || invitee.emailAddress);
-};
-
-MembersUtil.getRemoveMemberRequestParams = function (options) {
-  var body = {
-    reason: options.reason
-  };
-  var uri = "".concat(options.locusUrl, "/").concat(_constants.PARTICIPANT, "/").concat(options.memberId, "/").concat(_constants.LEAVE);
-  return {
-    method: _constants.HTTP_VERBS.PUT,
-    uri: uri,
-    body: body
-  };
-};
-
-MembersUtil.generateTransferHostMemberOptions = function (transfer, moderator, locusUrl) {
-  return {
-    moderator: moderator,
-    locusUrl: locusUrl,
-    memberId: transfer
-  };
-};
-
-MembersUtil.generateRemoveMemberOptions = function (removal, locusUrl) {
-  return {
-    reason: _constants._FORCED_,
-    memberId: removal,
-    locusUrl: locusUrl
-  };
-};
-
-MembersUtil.generateMuteMemberOptions = function (memberId, status, locusUrl) {
-  return {
-    memberId: memberId,
-    muted: status,
-    locusUrl: locusUrl
-  };
-};
-
-MembersUtil.generateRaiseHandMemberOptions = function (memberId, status, locusUrl) {
-  return {
-    memberId: memberId,
-    raised: status,
-    locusUrl: locusUrl
-  };
-};
-
-MembersUtil.generateLowerAllHandsMemberOptions = function (requestingParticipantId, locusUrl) {
-  return {
-    requestingParticipantId: requestingParticipantId,
-    locusUrl: locusUrl
-  };
-};
-
-MembersUtil.getMuteMemberRequestParams = function (options) {
-  var body = {
-    audio: {
-      muted: options.muted
+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 MembersUtil = {
+  /**
+   * @param {Object} invitee with emailAddress, email or phoneNumber
+   * @param {String} locusUrl
+   * @param {Boolean} alertIfActive
+   * @returns {Object} the format object
+   */
+  generateAddMemberOptions: function generateAddMemberOptions(invitee, locusUrl, alertIfActive) {
+    return {
+      invitee: invitee,
+      locusUrl: locusUrl,
+      alertIfActive: alertIfActive
+    };
+  },
+  /**
+   * @param {Array} memberIds
+   * @param {String} locusUrl
+   * @returns {Object} the format object
+   */
+  generateAdmitMemberOptions: function generateAdmitMemberOptions(memberIds, locusUrl) {
+    return {
+      locusUrl: locusUrl,
+      memberIds: memberIds
+    };
+  },
+  /**
+   * @param {Object} options with {invitee: {emailAddress, email, phoneNumber}, alertIfActive}
+   * @returns {Object} with {invitees: [{address}], alertIfActive}
+   */
+  getAddMemberBody: function getAddMemberBody(options) {
+    return {
+      invitees: [{
+        address: options.invitee.emailAddress || options.invitee.email || options.invitee.phoneNumber
+      }],
+      alertIfActive: options.alertIfActive
+    };
+  },
+  /**
+   * @param {Object} options with {memberIds, authorizingLocusUrl}
+   * @returns {Object} admit with {memberIds}
+   */
+  getAdmitMemberRequestBody: function getAdmitMemberRequestBody(options) {
+    var memberIds = options.memberIds,
+      sessionLocusUrls = options.sessionLocusUrls;
+    var body = {
+      admit: {
+        participantIds: memberIds
+      }
+    };
+    if (sessionLocusUrls) {
+      var authorizingLocusUrl = sessionLocusUrls.authorizingLocusUrl;
+      return _objectSpread({
+        authorizingLocusUrl: authorizingLocusUrl
+      }, body);
     }
-  };
-  var uri = "".concat(options.locusUrl, "/").concat(_constants.PARTICIPANT, "/").concat(options.memberId, "/").concat(_constants.CONTROLS);
-  return {
-    method: _constants.HTTP_VERBS.PATCH,
-    uri: uri,
-    body: body
-  };
-};
-
-MembersUtil.getRaiseHandMemberRequestParams = function (options) {
-  var body = {
-    hand: {
-      raised: options.raised
+    return body;
+  },
+  /**
+   * @param {Object} format with {memberIds, locusUrl, sessionLocusUrls}
+   * @returns {Object} the request parameters (method, uri, body) needed to make a admitMember request
+   * if a host/cohost is in a breakout session, the locus url should be the main session locus url
+   */
+  getAdmitMemberRequestParams: function getAdmitMemberRequestParams(format) {
+    var body = MembersUtil.getAdmitMemberRequestBody(format);
+    var locusUrl = format.locusUrl,
+      sessionLocusUrls = format.sessionLocusUrls;
+    var baseUrl = (sessionLocusUrls === null || sessionLocusUrls === void 0 ? void 0 : sessionLocusUrls.mainLocusUrl) || locusUrl;
+    var uri = "".concat(baseUrl, "/").concat(_constants.CONTROLS);
+    return {
+      method: _constants.HTTP_VERBS.PUT,
+      uri: uri,
+      body: body
+    };
+  },
+  /**
+   * @param {Object} format with {invitee {emailAddress, email, phoneNumber}, locusUrl, alertIfActive}
+   * @returns {Object} the request parameters (method, uri, body) needed to make a addMember request
+   */
+  getAddMemberRequestParams: function getAddMemberRequestParams(format) {
+    var body = MembersUtil.getAddMemberBody(format);
+    var requestParams = {
+      method: _constants.HTTP_VERBS.PUT,
+      uri: format.locusUrl,
+      body: body
+    };
+    return requestParams;
+  },
+  isInvalidInvitee: function isInvalidInvitee(invitee) {
+    if (!(invitee && (invitee.email || invitee.emailAddress || invitee.phoneNumber))) {
+      return true;
     }
-  };
-  var uri = "".concat(options.locusUrl, "/").concat(_constants.PARTICIPANT, "/").concat(options.memberId, "/").concat(_constants.CONTROLS);
-  return {
-    method: _constants.HTTP_VERBS.PATCH,
-    uri: uri,
-    body: body
-  };
-};
-
-MembersUtil.getLowerAllHandsMemberRequestParams = function (options) {
-  var body = {
-    hand: {
-      raised: false
-    },
-    requestingParticipantId: options.requestingParticipantId
-  };
-  var uri = "".concat(options.locusUrl, "/").concat(_constants.CONTROLS);
-  return {
-    method: _constants.HTTP_VERBS.PATCH,
-    uri: uri,
-    body: body
-  };
-};
-
-MembersUtil.getTransferHostToMemberRequestParams = function (options) {
-  var body = {
-    role: {
-      moderator: options.moderator
+    if (invitee.phoneNumber) {
+      return !_constants.DIALER_REGEX.E164_FORMAT.test(invitee.phoneNumber);
     }
-  };
-  var uri = "".concat(options.locusUrl, "/").concat(_constants.PARTICIPANT, "/").concat(options.memberId, "/").concat(_constants.CONTROLS);
-  return {
-    method: _constants.HTTP_VERBS.PATCH,
-    uri: uri,
-    body: body
-  };
-};
-
-MembersUtil.genderateSendDTMFOptions = function (url, tones, memberId, locusUrl) {
-  return {
-    url: url,
-    tones: tones,
-    memberId: memberId,
-    locusUrl: locusUrl
-  };
-};
-
-MembersUtil.generateSendDTMFRequestParams = function (_ref) {
-  var url = _ref.url,
+    return !_constants.VALID_EMAIL_ADDRESS.test(invitee.email || invitee.emailAddress);
+  },
+  getRemoveMemberRequestParams: function getRemoveMemberRequestParams(options) {
+    var body = {
+      reason: options.reason
+    };
+    var uri = "".concat(options.locusUrl, "/").concat(_constants.PARTICIPANT, "/").concat(options.memberId, "/").concat(_constants.LEAVE);
+    return {
+      method: _constants.HTTP_VERBS.PUT,
+      uri: uri,
+      body: body
+    };
+  },
+  generateTransferHostMemberOptions: function generateTransferHostMemberOptions(transfer, moderator, locusUrl) {
+    return {
+      moderator: moderator,
+      locusUrl: locusUrl,
+      memberId: transfer
+    };
+  },
+  generateRemoveMemberOptions: function generateRemoveMemberOptions(removal, locusUrl) {
+    return {
+      reason: _constants._FORCED_,
+      memberId: removal,
+      locusUrl: locusUrl
+    };
+  },
+  generateMuteMemberOptions: function generateMuteMemberOptions(memberId, status, locusUrl, isAudio) {
+    return {
+      memberId: memberId,
+      muted: status,
+      locusUrl: locusUrl,
+      isAudio: isAudio
+    };
+  },
+  generateRaiseHandMemberOptions: function generateRaiseHandMemberOptions(memberId, status, locusUrl) {
+    return {
+      memberId: memberId,
+      raised: status,
+      locusUrl: locusUrl
+    };
+  },
+  /**
+   * @param {String} memberId
+   * @param {[ServerRoleShape]} roles
+   * @param {String} locusUrl
+   * @returns {RoleAssignmentOptions}
+   */
+  generateRoleAssignmentMemberOptions: function generateRoleAssignmentMemberOptions(memberId, roles, locusUrl) {
+    return {
+      memberId: memberId,
+      roles: roles,
+      locusUrl: locusUrl
+    };
+  },
+  generateLowerAllHandsMemberOptions: function generateLowerAllHandsMemberOptions(requestingParticipantId, locusUrl) {
+    return {
+      requestingParticipantId: requestingParticipantId,
+      locusUrl: locusUrl
+    };
+  },
+  /**
+   * @param {String} memberId id of the participant who is receiving request
+   * @param {String} requestingParticipantId id of the participant who is sending request (optional)
+   * @param {String} alias alias name
+   * @param {String} locusUrl url
+   * @returns {Object} consists of {memberID: string, requestingParticipantId: string, alias: string, locusUrl: string}
+   */
+  generateEditDisplayNameMemberOptions: function generateEditDisplayNameMemberOptions(memberId, requestingParticipantId, alias, locusUrl) {
+    return {
+      memberId: memberId,
+      requestingParticipantId: requestingParticipantId,
+      alias: alias,
+      locusUrl: locusUrl
+    };
+  },
+  getMuteMemberRequestParams: function getMuteMemberRequestParams(options) {
+    var property = options.isAudio === false ? 'video' : 'audio';
+    var body = (0, _defineProperty2.default)({}, property, {
+      muted: options.muted
+    });
+    var uri = "".concat(options.locusUrl, "/").concat(_constants.PARTICIPANT, "/").concat(options.memberId, "/").concat(_constants.CONTROLS);
+    return {
+      method: _constants.HTTP_VERBS.PATCH,
+      uri: uri,
+      body: body
+    };
+  },
+  /**
+   * @param {RoleAssignmentOptions} options
+   * @returns {RoleAssignmentRequest} the request parameters (method, uri, body) needed to make a addMember request
+   */
+  getRoleAssignmentMemberRequestParams: function getRoleAssignmentMemberRequestParams(options) {
+    var body = {
+      role: {
+        roles: []
+      }
+    };
+    options.roles.forEach(function (role) {
+      body.role.roles.push({
+        type: role.type,
+        hasRole: role.hasRole
+      });
+    });
+    var uri = "".concat(options.locusUrl, "/").concat(_constants.PARTICIPANT, "/").concat(options.memberId, "/").concat(_constants.CONTROLS);
+    return {
+      method: _constants.HTTP_VERBS.PATCH,
+      uri: uri,
+      body: body
+    };
+  },
+  getRaiseHandMemberRequestParams: function getRaiseHandMemberRequestParams(options) {
+    var body = {
+      hand: {
+        raised: options.raised
+      }
+    };
+    var uri = "".concat(options.locusUrl, "/").concat(_constants.PARTICIPANT, "/").concat(options.memberId, "/").concat(_constants.CONTROLS);
+    return {
+      method: _constants.HTTP_VERBS.PATCH,
+      uri: uri,
+      body: body
+    };
+  },
+  getLowerAllHandsMemberRequestParams: function getLowerAllHandsMemberRequestParams(options) {
+    var body = {
+      hand: {
+        raised: false
+      },
+      requestingParticipantId: options.requestingParticipantId
+    };
+    var uri = "".concat(options.locusUrl, "/").concat(_constants.CONTROLS);
+    return {
+      method: _constants.HTTP_VERBS.PATCH,
+      uri: uri,
+      body: body
+    };
+  },
+  /**
+   * @param {Object} options with format of {locusUrl: string, requestingParticipantId: string}
+   * @returns {Object} request parameters (method, uri, body) needed to make a editDisplayName request
+   */
+  editDisplayNameMemberRequestParams: function editDisplayNameMemberRequestParams(options) {
+    var body = {
+      aliasValue: options.alias,
+      requestingParticipantId: options.requestingParticipantId
+    };
+    var uri = "".concat(options.locusUrl, "/").concat(_constants.PARTICIPANT, "/").concat(options.memberId, "/").concat(_constants.ALIAS);
+    return {
+      method: _constants.HTTP_VERBS.POST,
+      uri: uri,
+      body: body
+    };
+  },
+  getTransferHostToMemberRequestParams: function getTransferHostToMemberRequestParams(options) {
+    var body = {
+      role: {
+        moderator: options.moderator
+      }
+    };
+    var uri = "".concat(options.locusUrl, "/").concat(_constants.PARTICIPANT, "/").concat(options.memberId, "/").concat(_constants.CONTROLS);
+    return {
+      method: _constants.HTTP_VERBS.PATCH,
+      uri: uri,
+      body: body
+    };
+  },
+  genderateSendDTMFOptions: function genderateSendDTMFOptions(url, tones, memberId, locusUrl) {
+    return {
+      url: url,
+      tones: tones,
+      memberId: memberId,
+      locusUrl: locusUrl
+    };
+  },
+  generateSendDTMFRequestParams: function generateSendDTMFRequestParams(_ref) {
+    var url = _ref.url,
       tones = _ref.tones,
       memberId = _ref.memberId,
       locusUrl = _ref.locusUrl;
-  var body = {
-    device: {
-      url: url
-    },
-    memberId: memberId,
-    dtmf: {
-      correlationId: _uuid.default.v4(),
-      tones: tones,
-      direction: 'transmit'
-    }
-  };
-  var uri = "".concat(locusUrl, "/").concat(_constants.PARTICIPANT, "/").concat(memberId, "/").concat(_constants.SEND_DTMF_ENDPOINT);
-  return {
-    method: _constants.HTTP_VERBS.POST,
-    uri: uri,
-    body: body
-  };
-};
-
-MembersUtil.cancelPhoneInviteOptions = function (invitee, locusUrl) {
-  return {
-    invitee: invitee,
-    locusUrl: locusUrl
-  };
-};
-
-MembersUtil.generateCancelInviteRequestParams = function (options) {
-  var body = {
-    actionType: _constants._REMOVE_,
-    invitees: [{
-      address: options.invitee.phoneNumber
-    }]
-  };
-  var requestParams = {
-    method: _constants.HTTP_VERBS.PUT,
-    uri: options.locusUrl,
-    body: body
-  };
-  return requestParams;
+    var body = {
+      device: {
+        url: url
+      },
+      memberId: memberId,
+      dtmf: {
+        correlationId: _uuid.default.v4(),
+        tones: tones,
+        direction: 'transmit'
+      }
+    };
+    var uri = "".concat(locusUrl, "/").concat(_constants.PARTICIPANT, "/").concat(memberId, "/").concat(_constants.SEND_DTMF_ENDPOINT);
+    return {
+      method: _constants.HTTP_VERBS.POST,
+      uri: uri,
+      body: body
+    };
+  },
+  cancelPhoneInviteOptions: function cancelPhoneInviteOptions(invitee, locusUrl) {
+    return {
+      invitee: invitee,
+      locusUrl: locusUrl
+    };
+  },
+  generateCancelInviteRequestParams: function generateCancelInviteRequestParams(options) {
+    var body = {
+      actionType: _constants._REMOVE_,
+      invitees: [{
+        address: options.invitee.phoneNumber
+      }]
+    };
+    var requestParams = {
+      method: _constants.HTTP_VERBS.PUT,
+      uri: options.locusUrl,
+      body: body
+    };
+    return requestParams;
+  }
 };
-
 var _default = MembersUtil;
 exports.default = _default;
 //# sourceMappingURL=util.js.map