@webex/plugin-meetings 3.0.0-stream-classes.1 → 3.0.0-stream-classes.3

package/dist/types/recording-controller/util.d.ts

@@ -1,9 +1,10 @@
+import { SELF_POLICY } from '../constants';
 import RecordingAction from './enums';
 declare const _default: {
-    canUserStart: (displayHints: string[]) => boolean;
-    canUserPause: (displayHints: string[]) => boolean;
-    canUserResume: (displayHints: string[]) => boolean;
-    canUserStop: (displayHints: string[]) => boolean;
+    canUserStart: (displayHints: string[], userPolicies: Record<SELF_POLICY, boolean>) => boolean;
+    canUserPause: (displayHints: string[], userPolicies: Record<SELF_POLICY, boolean>) => boolean;
+    canUserResume: (displayHints: string[], userPolicies: Record<SELF_POLICY, boolean>) => boolean;
+    canUserStop: (displayHints: string[], userPolicies: Record<SELF_POLICY, boolean>) => boolean;
     deriveRecordingStates: (action: RecordingAction) => {
         recording: boolean;
         paused: boolean;

package/dist/types/roap/request.d.ts

@@ -1,4 +1,5 @@
 import { StatelessWebexPlugin } from '@webex/webex-core';
+import { IP_VERSION } from '../constants';
 import { LocusMediaRequest } from '../meeting/locusMediaRequest';
 /**
  * @class RoapRequest
@@ -28,6 +29,7 @@ export default class RoapRequest extends StatelessWebexPlugin {
         locusSelfUrl: string;
         mediaId: string;
         meetingId: string;
+        ipVersion: IP_VERSION;
         locusMediaRequest?: LocusMediaRequest;
     }): Promise<{
         mediaConnections: any;

package/dist/types/rtcMetrics/constants.d.ts

@@ -0,0 +1,4 @@
+declare const RTC_METRICS: {
+    APP_ID: string;
+};
+export { RTC_METRICS as default };

package/dist/types/rtcMetrics/index.d.ts

@@ -0,0 +1,47 @@
+/**
+ * Rtc Metrics
+ */
+export default class RtcMetrics {
+    /**
+     * Array of MetricData items to be sent to the metrics service.
+     */
+    metricsQueue: any[];
+    intervalId: number;
+    webex: any;
+    meetingId: string;
+    correlationId: string;
+    /**
+     * Initialize the interval.
+     *
+     * @param {object} webex - The main `webex` object.
+     * @param {string} meetingId - The meeting id.
+     * @param {string} correlationId - The correlation id.
+     */
+    constructor(webex: any, meetingId: any, correlationId: any);
+    /**
+     * Check to see if the metrics queue has any items.
+     *
+     * @returns {void}
+     */
+    private checkMetrics;
+    /**
+     * Add metrics items to the metrics queue.
+     *
+     * @param {object} data - An object with a payload array of metrics items.
+     *
+     * @returns {void}
+     */
+    addMetrics(data: any): void;
+    /**
+     * Clear the metrics interval.
+     *
+     * @returns {void}
+     */
+    closeMetrics(): void;
+    /**
+     * Send metrics to the metrics service.
+     *
+     * @returns {void}
+     */
+    private sendMetrics;
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@webex/plugin-meetings",
-  "version": "3.0.0-stream-classes.01",
+  "version": "3.0.0-stream-classes.3",
   "description": "",
   "license": "Cisco EULA (https://www.cisco.com/c/en/us/products/end-user-license-agreement.html)",
   "contributors": [

package/src/common/errors/webex-errors.ts

@@ -107,6 +107,27 @@ class UserInLobbyError extends WebexMeetingsError {
 export {UserInLobbyError};
 WebExMeetingsErrors[UserInLobbyError.CODE] = UserInLobbyError;
 
+/**
+ * @class SpaceIDDeprecatedError
+ * @classdesc Raised whenever the user passes Space ID as destination for create meeting.
+ * @extends WebexMeetingsError
+ * @property {number} code - 30105
+ * @property {string} message - Using the space ID as a destination is no longer supported. Please refer to the [migration guide](https://github.com/webex/webex-js-sdk/wiki/Migration-guide-for-USM-meeting) to migrate to use the meeting ID or SIP address.'
+ */
+class SpaceIDDeprecatedError extends WebexMeetingsError {
+  static CODE = 30105;
+
+  constructor() {
+    super(
+      SpaceIDDeprecatedError.CODE,
+      'Using the space ID as a destination is no longer supported. Please refer to the [migration guide](https://github.com/webex/webex-js-sdk/wiki/Migration-guide-for-USM-meeting) to migrate to use the meeting ID or SIP address.'
+    );
+  }
+}
+
+export {SpaceIDDeprecatedError};
+WebExMeetingsErrors[SpaceIDDeprecatedError.CODE] = SpaceIDDeprecatedError;
+
 /**
  * @class IceGatheringFailed
  * @classdesc Raised whenever ice gathering fails.

package/src/config.ts

@@ -86,8 +86,8 @@ export default {
     installedOrgID: undefined,
     experimental: {
       enableMediaNegotiatedEvent: false,
-      enableUnifiedMeetings: false,
-      enableAdhocMeetings: false,
+      enableUnifiedMeetings: true,
+      enableAdhocMeetings: true,
       enableTurnDiscovery: true,
     },
     degradationPreferences: {

package/src/meeting/index.ts

@@ -4506,7 +4506,7 @@ export default class Meeting extends StatelessWebexPlugin {
           payload: {
             identifiers: {meetingLookupUrl: this.meetingInfo?.meetingLookupUrl},
           },
-          options: {meetingId: this.id, rawError: error, showToUser: true},
+          options: {meetingId: this.id, rawError: error},
         });
 
         // TODO:  change this to error codes and pre defined dictionary
@@ -4879,7 +4879,7 @@ export default class Meeting extends StatelessWebexPlugin {
         payload: {
           canProceed: false,
         },
-        options: {meetingId: this.id, rawError: error, showToUser: true},
+        options: {meetingId: this.id, rawError: error},
       });
     } else if (
       error instanceof Errors.SdpOfferHandlingError ||
@@ -4893,7 +4893,7 @@ export default class Meeting extends StatelessWebexPlugin {
         payload: {
           canProceed: false,
         },
-        options: {meetingId: this.id, rawError: error, showToUser: true},
+        options: {meetingId: this.id, rawError: error},
       });
     } else if (error instanceof Errors.SdpError) {
       // this covers also the case of Errors.IceGatheringError which extends Errors.SdpError
@@ -4905,7 +4905,7 @@ export default class Meeting extends StatelessWebexPlugin {
         payload: {
           canProceed: false,
         },
-        options: {meetingId: this.id, rawError: error, showToUser: true},
+        options: {meetingId: this.id, rawError: error},
       });
     }
   };

package/src/meeting-info/util.ts

@@ -233,7 +233,7 @@ MeetingInfoUtil.generateOptions = async (from) => {
     }
   } else {
     throw new ParameterError(
-      'MeetingInfo is fetched with meeting link, sip uri, phone number, hydra room id, hydra people id, or a conversation url.'
+      'MeetingInfo is fetched with the meeting link, SIP URI, phone number, Hydra people ID, or a conversation URL.'
     );
   }
 

package/src/meeting-info/utilv2.ts

@@ -28,8 +28,11 @@ import {
 } from '../constants';
 import ParameterError from '../common/errors/parameter';
 import LoggerProxy from '../common/logs/logger-proxy';
+import {SpaceIDDeprecatedError} from '../common/errors/webex-errors';
 
 const MeetingInfoUtil: any = {};
+const meetingInfoError =
+  'MeetingInfo is fetched with the meeting link, SIP URI, phone number, Hydra people ID, or a conversation URL.';
 
 MeetingInfoUtil.getParsedUrl = (link) => {
   try {
@@ -191,27 +194,14 @@ MeetingInfoUtil.getDestinationType = async (from) => {
       return Promise.resolve(options);
     });
   } else if (hydraId.room) {
-    options.type = _CONVERSATION_URL_;
-    try {
-      await webex.internal.services.waitForCatalog('postauth');
-
-      const conversationUrl = webex.internal.conversation.getUrlFromClusterId({
-        cluster: hydraId.cluster,
-        id: hydraId.destination,
-      });
-
-      options.destination = conversationUrl;
-    } catch (e) {
-      LoggerProxy.logger.error(`Meeting-info:util#getDestinationType --> ${e}`);
-      throw e;
-    }
-  } else {
-    LoggerProxy.logger.warn(
-      "Meeting-info:util#getDestinationType --> ('MeetingInfo is fetched with meeting link, sip uri, phone number, hydra room id, hydra people id, or a conversation url."
-    );
-    throw new ParameterError(
-      'MeetingInfo is fetched with meeting link, sip uri, phone number, hydra room id, hydra people id, or a conversation url.'
+    LoggerProxy.logger.error(
+      `Meeting-info:util#getDestinationType --> Using the space ID as a destination is no longer supported. Please refer to the [migration guide](https://github.com/webex/webex-js-sdk/wiki/Migration-guide-for-USM-meeting) to migrate to use the meeting ID or SIP address.`
     );
+    // Error code 30105 added as Space ID deprecated as of beta, Please refer migration guide.
+    throw new SpaceIDDeprecatedError();
+  } else {
+    LoggerProxy.logger.warn(`Meeting-info:util#getDestinationType --> ${meetingInfoError}`);
+    throw new ParameterError(`${meetingInfoError}`);
   }
 
   return Promise.resolve(options);

package/src/meetings/index.ts

@@ -60,6 +60,7 @@ import MeetingCollection from './collection';
 import MeetingsUtil from './util';
 import PermissionError from '../common/errors/permission';
 import {INoiseReductionEffect, IVirtualBackgroundEffect} from './meetings.types';
+import {SpaceIDDeprecatedError} from '../common/errors/webex-errors';
 
 let mediaLogger;
 
@@ -1037,7 +1038,7 @@ export default class Meetings extends WebexPlugin {
 
   /**
    * Create a meeting.
-   * @param {string} destination - sipURL, spaceId, phonenumber, or locus object}
+   * @param {string} destination - sipURL, phonenumber, or locus object}
    * @param {string} [type] - the optional specified type, such as locusId
    * @param {Boolean} useRandomDelayForInfo - whether a random delay should be added to fetching meeting info
    * @param {Object} infoExtraParams extra parameters to be provided when fetching meeting info
@@ -1064,9 +1065,12 @@ export default class Meetings extends WebexPlugin {
         .fetchInfoOptions(destination, type)
         // Catch a failure to fetch info options.
         .catch((error) => {
-          LoggerProxy.logger.info(
-            `Meetings:index#create --> INFO, unable to determine info options: ${error.message}`
+          LoggerProxy.logger.error(
+            `Meetings:index#create --> ERROR, unable to determine info options: ${error.message}`
           );
+          if (error instanceof SpaceIDDeprecatedError) {
+            throw new SpaceIDDeprecatedError();
+          }
         })
         .then((options: any = {}) => {
           // Normalize the destination.
@@ -1284,7 +1288,7 @@ export default class Meetings extends WebexPlugin {
     //
     // Our job is to determine the appropriate one
     // and its corresponding service so that developers
-    // need only sipURL or spaceID to get a meeting
+    // need only sipURL to get a meeting
     // and its ID, but have the option to use createWithType()
     // and specify those types to get meetingInfo
   }

package/test/unit/spec/meeting/index.js

@@ -4523,7 +4523,7 @@ describe('plugin-meetings', () => {
               payload: {
                 canProceed: false,
               },
-              options: {showToUser: true, rawError: error, meetingId: meeting.id},
+              options: {rawError: error, meetingId: meeting.id},
             });
           };
 

package/dist/common/browser-detection.d.ts

@@ -1,9 +0,0 @@
-/// <reference types="lodash" />
-declare const _default: ((agent?: any) => {
-    getOSName: () => any;
-    getOSVersion: () => any;
-    getBrowserName: () => any;
-    getBrowserVersion: () => any;
-    isBrowser: (name: any) => boolean;
-}) & import("lodash").MemoizedFunction;
-export default _default;

package/dist/common/collection.d.ts

@@ -1,48 +0,0 @@
-/**
- * @class Collection
- */
-export default class Collection {
-    namespace: string;
-    propertyName: string;
-    /**
-     * @param {String} property
-     * @memberof Collection
-     */
-    constructor(property: string);
-    /**
-     * @param {String} id ID of the thing stuffed into the collection at id location
-     * @returns {Any} returns whatever is being stuffed into the collection
-     * @public
-     * @memberof Collection
-     */
-    get(id: string): any;
-    /**
-     * @param {String} id the id of the meeting info instance to add to the collection
-     * @param {Any} value the thing to set in the collection
-     * @returns {Any} returns the thing just put in the collection
-     * @public
-     * @memberof Collection
-     */
-    set(id: string, value: any): any;
-    /**
-     * remove the thing at the id
-     * @param {String} id ID of the thing you wish to delete from the collection
-     * @returns {undefined}
-     * @public
-     * @memberof Collection
-     */
-    delete(id: string): void;
-    /**
-     * @returns {Object} returns an object map of things stuffed into the collection
-     * @public
-     * @memberof Collection
-     */
-    getAll(): any;
-    /**
-     * @param {Object} set the replacement object
-     * @returns {Object} returns an object map of things stuffed into the collection
-     * @public
-     * @memberof Collection
-     */
-    setAll(set: object): any;
-}

package/dist/common/config.d.ts

@@ -1,2 +0,0 @@
-declare const StaticConfig: any;
-export default StaticConfig;

package/dist/common/errors/captcha-error.d.ts

@@ -1,15 +0,0 @@
-/**
- * Extended Error object to signify captcha related errors
- */
-export default class CaptchaError extends Error {
-    code: any;
-    error: any;
-    sdkMessage: any;
-    /**
-     *
-     * @constructor
-     * @param {String} [message]
-     * @param {Object} [error]
-     */
-    constructor(message?: string, error?: any);
-}

package/dist/common/errors/intent-to-join.d.ts

@@ -1,16 +0,0 @@
-/**
- * Extended Error object to signify the intent to join for unclaimed PMR scenarios
- */
-export default class IntentToJoinError extends Error {
-    code: any;
-    error: any;
-    joinIntentRequired: any;
-    sdkMessage: any;
-    /**
-     *
-     * @constructor
-     * @param {String} [message]
-     * @param {Object} [error]
-     */
-    constructor(message?: string, error?: any);
-}

package/dist/common/errors/join-meeting.d.ts

@@ -1,17 +0,0 @@
-/**
- * Extended Error object to signify a join meeting error
- */
-export default class JoinMeetingError extends Error {
-    code: any;
-    error: any;
-    joinOptions: any;
-    sdkMessage: any;
-    /**
-     *
-     * @constructor
-     * @param {Object} [options]
-     * @param {String} [message]
-     * @param {Object} [error]
-     */
-    constructor(options?: object, message?: string, error?: any);
-}

package/dist/common/errors/media.d.ts

@@ -1,15 +0,0 @@
-/**
- * Extended Error object for media errors
- */
-export default class MediaError extends Error {
-    code: any;
-    error: any;
-    sdkMessage: any;
-    /**
-     *
-     * @constructor
-     * @param {String} [message]
-     * @param {Object} [error]
-     */
-    constructor(message?: string, error?: any);
-}

package/dist/common/errors/parameter.d.ts

@@ -1,15 +0,0 @@
-/**
- * Extended Error object for general parameter errors
- */
-export default class ParameterError extends Error {
-    sdkMessage: string;
-    error: null;
-    code: number;
-    /**
-     *
-     * @constructor
-     * @param {String} [message]
-     * @param {Object} [error]
-     */
-    constructor(message?: string, error?: any);
-}

package/dist/common/errors/password-error.d.ts

@@ -1,15 +0,0 @@
-/**
- * Extended Error object to signify password related errors
- */
-export default class PasswordError extends Error {
-    code: any;
-    error: any;
-    sdkMessage: any;
-    /**
-     *
-     * @constructor
-     * @param {String} [message]
-     * @param {Object} [error]
-     */
-    constructor(message?: string, error?: any);
-}

package/dist/common/errors/permission.d.ts

@@ -1,14 +0,0 @@
-/**
- * Extended Error object for general parameter errors
- */
-export default class PermissionError extends Error {
-    code: any;
-    error: any;
-    sdkMessage: any;
-    /**
-     * @constructor
-     * @param {String} [message]
-     * @param {Object} [error]
-     */
-    constructor(message?: string, error?: any);
-}

package/dist/common/errors/reconnection-in-progress.d.ts

@@ -1,9 +0,0 @@
-/**
- *
- *
- * @export
- * @class ReconnectInProgress
- * @extends {Error}
- */
-export default class ReconnectInProgress extends Error {
-}

package/dist/common/errors/reconnection.d.ts

@@ -1,15 +0,0 @@
-/**
- * Extended Error object to signify the intent to join for unclaimed PMR scenarios
- */
-export default class ReconnectionError extends Error {
-    code: any;
-    error: any;
-    sdkMessage: any;
-    /**
-     *
-     * @constructor
-     * @param {String} [message]
-     * @param {Object} [error]
-     */
-    constructor(message?: string, error?: any);
-}

package/dist/common/errors/stats.d.ts

@@ -1,15 +0,0 @@
-/**
- * Extended Error object for Stats Errors
- */
-export default class StatsError extends Error {
-    code: any;
-    error: any;
-    sdkMessage: any;
-    /**
-     *
-     * @constructor
-     * @param {String} [message]
-     * @param {Object} [error]
-     */
-    constructor(message?: string, error?: any);
-}

package/dist/common/errors/webex-errors.d.ts

@@ -1,81 +0,0 @@
-import WebexMeetingsError from './webex-meetings-error';
-/**
- * Create a {@link WebexMeetingsError} for a given code and message.
- * @private
- * @param {number} [code] - Error code
- * @param {string} [message] - Error message
- * @returns {WebexMeetingsError}
- */
-export declare function createMeetingsError(code?: number, message?: string): any;
-/**
- * @class MeetingNotActiveError
- * @classdesc Raised whenever Meeting has already ended and user tries to do a action.
- * @extends WebexMeetingsError
- * @property {number} code - 30101
- * @property {string} message - 'Meeting has already Ended or not Active'
- */
-declare class MeetingNotActiveError extends WebexMeetingsError {
-    static CODE: number;
-    constructor();
-}
-export { MeetingNotActiveError };
-/**
- * @class UserNotJoinedError
- * @classdesc Raised whenever the user has already left the meeting and user tries to do a action.
- * @extends WebexMeetingsError
- * @property {number} code - 30102
- * @property {string} message - 'User has already left the meeting'
- */
-declare class UserNotJoinedError extends WebexMeetingsError {
-    static CODE: number;
-    constructor();
-}
-export { UserNotJoinedError };
-/**
- * @class NoMediaEstablishedYetError
- * @classdesc Raised whenever the user has not established media yet.
- * @extends WebexMeetingsError
- * @property {number} code - 30103
- * @property {string} message - 'User has not established media yet'
- */
-declare class NoMediaEstablishedYetError extends WebexMeetingsError {
-    static CODE: number;
-    constructor();
-}
-export { NoMediaEstablishedYetError };
-/**
- * @class UserInLobbyError
- * @classdesc Raised whenever the user is in lobby and not joined yet.
- * @extends WebexMeetingsError
- * @property {number} code - 30104
- * @property {string} message - 'user is still in the lobby or not joined'
- */
-declare class UserInLobbyError extends WebexMeetingsError {
-    static CODE: number;
-    constructor();
-}
-export { UserInLobbyError };
-/**
- * @class InvalidSdpError
- * @classdesc Raised whenever SDP generated via browser is invalid.
- * @extends WebexMeetingsError
- * @property {number} code - 30201
- * @property {string} message - 'user is still in the lobby or not joined'
- */
-declare class InvalidSdpError extends WebexMeetingsError {
-    static CODE: number;
-    constructor(message: any);
-}
-export { InvalidSdpError };
-/**
- * @class IceGatheringFailed
- * @classdesc Raised whenever ice gathering fails.
- * @extends WebexMeetingsError
- * @property {number} code - 30202
- * @property {string} message - 'user failed ice gathering check network/firewall'
- */
-declare class IceGatheringFailed extends WebexMeetingsError {
-    static CODE: number;
-    constructor();
-}
-export { IceGatheringFailed };

package/dist/common/errors/webex-meetings-error.d.ts

@@ -1,20 +0,0 @@
-/**
- * @extends Error
- * @property {number} code - Error code
- */
-export default class WebexMeetingsError extends Error {
-    code: any;
-    /**
-     * Creates a new {@link WebexMeetingsError}
-     * @param {number} code - Error code
-     * @param {string} [message] - Error message
-     * @param {string} [fileName] - Name of the script file where error was generated
-     * @param {number} [lineNumber] - Line number of the script file where error was generated
-     */
-    constructor(code: number, ...args: any[]);
-    /**
-     * Returns human readable string describing the error.
-     * @returns {string}
-     */
-    toString(): string;
-}

package/dist/common/events/events-scope.d.ts

@@ -1,17 +0,0 @@
-/// <reference types="node" />
-import ChildEmitter from 'events';
-/**
- * Events
- * plugin-meetings local
- * Used to emit events internally between modules specific to an object
- */
-export default class EventsScope extends ChildEmitter {
-    /**
-     * Emits and logs an event
-     * @param {*} scope
-     * @param {*} eventName
-     * @param {*} args
-     * @returns {Function}
-     */
-    emit(scope: any, eventName: any, args: any): boolean;
-}

package/dist/common/events/events.d.ts

@@ -1,12 +0,0 @@
-/// <reference types="node" />
-import EventEmitter from 'events';
-/**
- * Events
- * plugin-meetings global
- * Used to emit events internally between modules
- */
-declare class Events extends EventEmitter {
-    emit(scope: any, eventName: any, args: any): boolean;
-}
-declare const _default: Events;
-export default _default;

package/dist/common/events/trigger-proxy.d.ts

@@ -1,2 +0,0 @@
-declare const TriggerProxy: any;
-export default TriggerProxy;

package/dist/common/events/util.d.ts

@@ -1,2 +0,0 @@
-declare const EventsUtil: any;
-export default EventsUtil;

package/dist/common/logs/logger-config.d.ts

@@ -1,2 +0,0 @@
-declare const LoggerConfig: any;
-export default LoggerConfig;

package/dist/common/logs/logger-proxy.d.ts

@@ -1,2 +0,0 @@
-declare const LoggerProxy: any;
-export default LoggerProxy;