@webex/plugin-meetings 3.0.0-beta.15 → 3.0.0-beta.151

package/dist/types/members/util.d.ts

@@ -0,0 +1,210 @@
+import { RoleAssignmentOptions, RoleAssignmentRequest, ServerRoleShape } from './types';
+declare const MembersUtil: {
+    /**
+     * @param {Object} invitee with emailAddress, email or phoneNumber
+     * @param {String} locusUrl
+     * @param {Boolean} alertIfActive
+     * @returns {Object} the format object
+     */
+    generateAddMemberOptions: (invitee: object, locusUrl: string, alertIfActive: boolean) => {
+        invitee: object;
+        locusUrl: string;
+        alertIfActive: boolean;
+    };
+    /**
+     * @param {Array} memberIds
+     * @param {String} locusUrl
+     * @returns {Object} the format object
+     */
+    generateAdmitMemberOptions: (memberIds: Array<any>, locusUrl: string) => {
+        locusUrl: string;
+        memberIds: any[];
+    };
+    /**
+     * @param {Object} options with {invitee: {emailAddress, email, phoneNumber}, alertIfActive}
+     * @returns {Object} with {invitees: [{address}], alertIfActive}
+     */
+    getAddMemberBody: (options: any) => {
+        invitees: {
+            address: any;
+        }[];
+        alertIfActive: any;
+    };
+    /**
+     * @param {Object} options with {memberIds, authorizingLocusUrl}
+     * @returns {Object} admit with {memberIds}
+     */
+    getAdmitMemberRequestBody: (options: any) => any;
+    /**
+     * @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: (format: any) => {
+        method: string;
+        uri: string;
+        body: any;
+    };
+    /**
+     * @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: (format: any) => {
+        method: string;
+        uri: any;
+        body: {
+            invitees: {
+                address: any;
+            }[];
+            alertIfActive: any;
+        };
+    };
+    isInvalidInvitee: (invitee: any) => boolean;
+    getRemoveMemberRequestParams: (options: any) => {
+        method: string;
+        uri: string;
+        body: {
+            reason: any;
+        };
+    };
+    generateTransferHostMemberOptions: (transfer: any, moderator: any, locusUrl: any) => {
+        moderator: any;
+        locusUrl: any;
+        memberId: any;
+    };
+    generateRemoveMemberOptions: (removal: any, locusUrl: any) => {
+        reason: string;
+        memberId: any;
+        locusUrl: any;
+    };
+    generateMuteMemberOptions: (memberId: any, status: any, locusUrl: any, isAudio: any) => {
+        memberId: any;
+        muted: any;
+        locusUrl: any;
+        isAudio: any;
+    };
+    generateRaiseHandMemberOptions: (memberId: any, status: any, locusUrl: any) => {
+        memberId: any;
+        raised: any;
+        locusUrl: any;
+    };
+    /**
+     * @param {String} memberId
+     * @param {[ServerRoleShape]} roles
+     * @param {String} locusUrl
+     * @returns {RoleAssignmentOptions}
+     */
+    generateRoleAssignmentMemberOptions: (memberId: string, roles: Array<ServerRoleShape>, locusUrl: string) => RoleAssignmentOptions;
+    generateLowerAllHandsMemberOptions: (requestingParticipantId: any, locusUrl: any) => {
+        requestingParticipantId: any;
+        locusUrl: any;
+    };
+    /**
+     * @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: (memberId: any, requestingParticipantId: any, alias: any, locusUrl: any) => {
+        memberId: any;
+        requestingParticipantId: any;
+        alias: any;
+        locusUrl: any;
+    };
+    getMuteMemberRequestParams: (options: any) => {
+        method: string;
+        uri: string;
+        body: {
+            [x: string]: {
+                muted: any;
+            };
+        };
+    };
+    /**
+     * @param {RoleAssignmentOptions} options
+     * @returns {RoleAssignmentRequest} the request parameters (method, uri, body) needed to make a addMember request
+     */
+    getRoleAssignmentMemberRequestParams: (options: RoleAssignmentOptions) => RoleAssignmentRequest;
+    getRaiseHandMemberRequestParams: (options: any) => {
+        method: string;
+        uri: string;
+        body: {
+            hand: {
+                raised: any;
+            };
+        };
+    };
+    getLowerAllHandsMemberRequestParams: (options: any) => {
+        method: string;
+        uri: string;
+        body: {
+            hand: {
+                raised: boolean;
+            };
+            requestingParticipantId: any;
+        };
+    };
+    /**
+     * @param {Object} options with format of {locusUrl: string, requestingParticipantId: string}
+     * @returns {Object} request parameters (method, uri, body) needed to make a editDisplayName request
+     */
+    editDisplayNameMemberRequestParams: (options: any) => {
+        method: string;
+        uri: string;
+        body: {
+            aliasValue: any;
+            requestingParticipantId: any;
+        };
+    };
+    getTransferHostToMemberRequestParams: (options: any) => {
+        method: string;
+        uri: string;
+        body: {
+            role: {
+                moderator: any;
+            };
+        };
+    };
+    genderateSendDTMFOptions: (url: any, tones: any, memberId: any, locusUrl: any) => {
+        url: any;
+        tones: any;
+        memberId: any;
+        locusUrl: any;
+    };
+    generateSendDTMFRequestParams: ({ url, tones, memberId, locusUrl }: {
+        url: any;
+        tones: any;
+        memberId: any;
+        locusUrl: any;
+    }) => {
+        method: string;
+        uri: string;
+        body: {
+            device: {
+                url: any;
+            };
+            memberId: any;
+            dtmf: {
+                correlationId: any;
+                tones: any;
+                direction: string;
+            };
+        };
+    };
+    cancelPhoneInviteOptions: (invitee: any, locusUrl: any) => {
+        invitee: any;
+        locusUrl: any;
+    };
+    generateCancelInviteRequestParams: (options: any) => {
+        method: string;
+        uri: any;
+        body: {
+            actionType: string;
+            invitees: {
+                address: any;
+            }[];
+        };
+    };
+};
+export default MembersUtil;

package/dist/types/metrics/config.d.ts

@@ -0,0 +1,195 @@
+export declare const eventType: {
+    MEDIA_QUALITY: string;
+    CALL_INITIATED: string;
+    MERCURY_CONNECTION_LOST: string;
+    MERCURY_CONNECTION_RESTORED: string;
+    MOVE_MEDIA: string;
+    LOCAL_SDP_GENERATED: string;
+    REMOTE_SDP_RECEIVED: string;
+    LOCUS_JOIN_REQUEST: string;
+    LOCUS_JOIN_RESPONSE: string;
+    MEETING_INFO_REQUEST: string;
+    MEETING_INFO_RESPONSE: string;
+    ALERT_DISPLAYED: string;
+    ICE_START: string;
+    ICE_END: string;
+    ICE_DISCONNECT: string;
+    RECEIVING_MEDIA_START: string;
+    RECEIVING_MEDIA_STOP: string;
+    SENDING_MEDIA_START: string;
+    SENDING_MEDIA_STOP: string;
+    MEDIA_RENDER_START: string;
+    MEDIA_RENDER_STOP: string;
+    MEDIA_CAPABILITIES: string;
+    MEDIA_RECONNECTING: string;
+    MEDIA_RECOVERED: string;
+    CALL_ABORTED: string;
+    PIN_PROMPT: string;
+    PIN_COLLECTED: string;
+    LOBBY_ENTERED: string;
+    LOBBY_EXITED: string;
+    SHARE_INITIATED: string;
+    SHARE_STOPPED: string;
+    LOCAL_SHARE_FLOOR_GRANTED: string;
+    SHARE_LAYOUT_DISPLAYED: string;
+    WHITEBOARD_SHARE_INITIATED: string;
+    WHITEBOARD_SHARE_STOPPED: string;
+    WHITEBOARD_SHARE_FLOOR_GRANTED: string;
+    MUTED: string;
+    UNMUTED: string;
+    LEAVE: string;
+    REMOTE_ENDED: string;
+    REMOTE_STARTED: string;
+    MEDIA_REQUEST: string;
+    MEDIA_RESPONSE: string;
+    PSTN_AUDIO_ATTEMPT_START: string;
+    PSTN_AUDIO_ATTEMPT_FINISH: string;
+    PSTN_AUDIO_ATTEMPT_SKIP: string;
+    BREAKOUT_MOVE_REQUEST: string;
+    BREAKOUT_MOVE_RESPONSE: string;
+    BREAKOUT_JOIN_RESPONSE: string;
+};
+export declare const error: {
+    name: {
+        MEDIA_ENGINE: string;
+        ICE_FAILED: string;
+        LOCUS_RESPONSE: string;
+        LOCUS_LEAVE: string;
+        OTHER: string;
+    };
+    notFatalErrorList: number[];
+    errors: {
+        1000: string[];
+        1001: string[];
+        1002: string[];
+        1003: string[];
+        1004: string[];
+        1005: string[];
+        1006: string[];
+        1007: string[];
+        2001: string[];
+        2002: string[];
+        2003: string[];
+        2004: string[];
+        2005: string[];
+        2006: string[];
+        3001: string[];
+        3002: string[];
+        3004: string[];
+        3005: string[];
+        3006: string[];
+        3007: string[];
+        4001: string[];
+        4002: string[];
+        4003: string[];
+        4004: string[];
+        4005: string[];
+        4006: string[];
+        4007: string[];
+        4008: string[];
+        4009: string[];
+        4010: string[];
+        4011: string[];
+        4012: string[];
+        4013: string[];
+        4014: string[];
+        4015: string[];
+        4016: string[];
+        4017: string[];
+        4018: string[];
+        4019: string[];
+        4020: string[];
+        4021: string[];
+        4022: string[];
+        4023: string[];
+        4024: string[];
+        4025: string[];
+        4026: string[];
+        4027: string[];
+        4028: string[];
+        4029: string[];
+        4030: string[];
+        5000: string[];
+        5001: string[];
+        4100: string[];
+    };
+};
+export declare const WebexAPIServiceErrorCodes: {
+    58400: number;
+    99002: number;
+    99009: number;
+    403040: number;
+    403041: number;
+    403038: number;
+    403036: number;
+    403043: number;
+    403048: number;
+    403049: number;
+    403100: number;
+    403101: number;
+    403102: number;
+    403103: number;
+    403104: number;
+    404001: number;
+    404006: number;
+    429005: number;
+};
+export declare const trigger: {
+    USER_INTERACTION: string;
+    MERCURY_EVENT: string;
+    LOCI_UPDATE: string;
+    MEDIA_ENGINE_EVENT: string;
+    TIMEOUT: string;
+    SIGNALING: string;
+    OTHER: string;
+};
+export declare const pstnAudioType: {
+    DIAL_IN: string;
+    DIAL_OUT: string;
+};
+export declare const displayLocation: {
+    TOAST: string;
+    ROOM_LIST: string;
+    CALL_PANE: string;
+    CALL_VIEW: string;
+    OTHER: string;
+};
+export declare const mediaType: {
+    AUDIO: string;
+    VIDEO: string;
+    SHARE: string;
+    WHITEBOARD: string;
+};
+export declare const reconnection: {
+    RECOVERED_BY_NEW: string;
+    RECOVERED_BY_RETRY: string;
+};
+export declare const errorCodes: {
+    USER_CREATE_FAILED: number;
+    USER_ALREADY_PARTICIPANT: number;
+    CONVO_ALREADY_EXISTS: number;
+    ALREADY_ANNOUNCEMENT_SPACE: number;
+    NOT_ANNOUNCEMENT_SPACE: number;
+    USER_NOT_MODERATOR_IN_ANNOUNCEMENT_SPACE: number;
+    TEMP_ID_ALREADY_EXISTS: number;
+    PARENT_ACTIVITY_ID_NOT_FOUND_OR_INVALID: number;
+};
+export declare const statusCodes: {
+    NETWORK_OR_CORS: number;
+    BAD_REQUEST: number;
+    FORBIDDEN: number;
+    NOT_FOUND: number;
+    CONFLICT: number;
+};
+export declare const errorObjects: {
+    category: {
+        media: string;
+        expected: string;
+    };
+    name: {
+        mediaEngine: string;
+    };
+};
+export declare const UNKNOWN = "unknown";
+export declare const CLIENT_NAME = "webex-js-sdk";
+export declare const PLATFORM = "Web";

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

@@ -0,0 +1,55 @@
+declare const BEHAVIORAL_METRICS: {
+    MEETINGS_REGISTRATION_FAILED: string;
+    MEETINGS_REGISTRATION_SUCCESS: string;
+    MERCURY_CONNECTION_FAILURE: string;
+    MERCURY_CONNECTION_RESTORED: string;
+    JOIN_SUCCESS: string;
+    JOIN_FAILURE: string;
+    ADD_MEDIA_SUCCESS: string;
+    ADD_MEDIA_FAILURE: string;
+    ROAP_MERCURY_EVENT_RECEIVED: string;
+    CONNECTION_SUCCESS: string;
+    CONNECTION_FAILURE: string;
+    MEETING_LEAVE_FAILURE: string;
+    MEETING_END_ALL_FAILURE: string;
+    MEETING_END_ALL_INITIATED: string;
+    GET_USER_MEDIA_FAILURE: string;
+    GET_DISPLAY_MEDIA_FAILURE: string;
+    JOIN_WITH_MEDIA_FAILURE: string;
+    DISCONNECT_DUE_TO_INACTIVITY: string;
+    MEETING_MEDIA_INACTIVE: string;
+    MEETING_RECONNECT_FAILURE: string;
+    MEETING_MAX_REJOIN_FAILURE: string;
+    MEETING_SHARE_FAILURE: string;
+    MEETING_START_WHITEBOARD_SHARE_FAILURE: string;
+    MEETING_STOP_WHITEBOARD_SHARE_FAILURE: string;
+    MUTE_AUDIO_FAILURE: string;
+    MUTE_VIDEO_FAILURE: string;
+    SET_MEETING_QUALITY_FAILURE: string;
+    STOP_FLOOR_REQUEST_FAILURE: string;
+    ADD_DIAL_IN_FAILURE: string;
+    ADD_DIAL_OUT_FAILURE: string;
+    UPDATE_MEDIA_FAILURE: string;
+    UNMUTE_AUDIO_FAILURE: string;
+    UNMUTE_VIDEO_FAILURE: string;
+    ROAP_ANSWER_FAILURE: string;
+    ROAP_GLARE_CONDITION: string;
+    PEERCONNECTION_FAILURE: string;
+    INVALID_ICE_CANDIDATE: string;
+    UPLOAD_LOGS_FAILURE: string;
+    RECEIVE_TRANSCRIPTION_FAILURE: string;
+    FETCH_MEETING_INFO_V1_SUCCESS: string;
+    FETCH_MEETING_INFO_V1_FAILURE: string;
+    ADHOC_MEETING_SUCCESS: string;
+    ADHOC_MEETING_FAILURE: string;
+    VERIFY_PASSWORD_SUCCESS: string;
+    VERIFY_PASSWORD_ERROR: string;
+    VERIFY_CAPTCHA_ERROR: string;
+    MOVE_TO_SUCCESS: string;
+    MOVE_TO_FAILURE: string;
+    MOVE_FROM_SUCCESS: string;
+    MOVE_FROM_FAILURE: string;
+    TURN_DISCOVERY_FAILURE: string;
+    MEETING_INFO_POLICY_ERROR: string;
+};
+export { BEHAVIORAL_METRICS as default };

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

@@ -0,0 +1,169 @@
+/**
+ * @description Metrics handles all the call metrics events
+ * @export
+ * @class Metrics
+ */
+declare class Metrics {
+    static instance: Metrics;
+    _events: any;
+    keys: any;
+    meetingCollection: any;
+    webex: any;
+    /**
+     * Create Metrics Object
+     * @constructor
+     * @public
+     * @memberof Meetings
+     */
+    constructor();
+    /**
+     * Initializes the Metrics singleton with a meeting Collection.
+     *
+     * @param {Object} meetingCollection meetings object
+     * @param {Object} webex  webex SDK object
+     *
+     * @returns {void}
+     */
+    initialSetup(meetingCollection: object, webex: object): void;
+    /**
+     * poste Meeting event metrics
+     * @param {object} options {meetingId/meeting} as a json object
+     * @param {Meeting} options.meeting Meeting object
+     * @param {String} options.meetingId
+     * @param {object} options.data
+     * @param {object} options.event
+     * @returns {object} null
+     */
+    postEvent(options: {
+        meeting?: any;
+        meetingId?: string;
+        data?: object;
+        event?: any;
+    } | any): void;
+    /**
+     *  Docs for Call analyzer metrics
+     *   https://sqbu-github.cisco.com/WebExSquared/call-analyzer/wiki
+     *   https://sqbu-github.cisco.com/WebExSquared/event-dictionary/blob/master/diagnostic-events.raml
+     */
+    initPayload(eventType: any, identifiers: any, options: any): any;
+    /**
+     * get the payload specific for a media quality event through call analyzer
+     * @param {String} eventType the event name
+     * @param {Object} identifiers contains the identifiers needed for CA
+     * @param {String} identifiers.correlationId
+     * @param {String} identifiers.locusUrl
+     * @param {String} identifiers.locusId
+     * @param {Object} options
+     * @param {Object} options.intervalData
+     * @param {String} options.clientType
+     * @returns {Object}
+     * @public
+     * @memberof Metrics
+     */
+    initMediaPayload(eventType: string, identifiers: {
+        correlationId: string;
+        locusUrl: string;
+        locusId: string;
+    }, options?: {
+        intervalData: object;
+        clientType: string;
+    } | any): {
+        eventId: any;
+        version: number;
+        origin: {
+            audioSetupDelay: any;
+            videoSetupDelay: any;
+            name: string;
+            networkType: any;
+            userAgent: string;
+            clientInfo: {
+                clientType: any;
+                clientVersion: string;
+                localNetworkPrefix: string;
+                os: any;
+                osVersion: any;
+                subClientType: any;
+                browser: any;
+                browserVersion: any;
+            };
+        };
+        originTime: {
+            triggered: string;
+        };
+        senderCountryCode: any;
+        event: {
+            name: string;
+            canProceed: boolean;
+            identifiers: {
+                correlationId: string;
+                locusUrl: string;
+                locusId: string;
+            };
+            intervals: any[];
+            joinTimes: any;
+            eventData: {
+                webClientDomain: any;
+            };
+            sourceMetadata: {
+                applicationSoftwareType: string;
+                applicationSoftwareVersion: any;
+                mediaEngineSoftwareType: any;
+                mediaEngineSoftwareVersion: any;
+                startTime: string;
+            };
+        };
+    };
+    /**
+     * This function Parses a Locus error and returns a diagnostic event payload.
+     * It should keep updating from:
+     * https://sqbu-github.cisco.com/WebExSquared/spark-client-framework/blob/master/spark-client-framework/Adapters/TelephonyAdapter/TelephonyAdapter.cpp#L920
+     *
+     * @param {Object} err the error Object from Locus response
+     * @param {boolean} showToUser true if a toast is shown to user
+     * @returns {{showToUser: boolean, category: string, errorDescription: string,
+     *  errorCode: number, errorData: *, fatal: boolean, name: string}}
+     */
+    parseLocusError(err: any, showToUser: boolean): any;
+    /**
+     * Pareses webex api error.
+     *
+     * @param {object} err
+     * @param {boolean} showToUser
+     * @returns {object | null}
+     */
+    parseWebexApiError(err: any, showToUser: boolean): any;
+    /**
+     * Generates Error for the CA event
+     *
+     * @param {integer} errorCode
+     * @param {boolean} shownToUser
+     * @param {string} name
+     * @param {any} err
+     * @returns {any}
+     */
+    generateErrorPayload(errorCode: any, shownToUser: any, name: any, err: any): any;
+    /**
+     * Returns a formated string of the user agent.
+     *
+     * @returns {string} formatted user agent information
+     */
+    userAgentToString(): string;
+    /**
+     * Uploads given metric to the Metrics service as an Behavioral metric.
+     * Metadata about the environment such as browser, OS, SDK and their versions
+     * are automatically added when the metric is sent.
+     *
+     * The Metrics service will send an Behavioral metric to InfluxDB for
+     * aggregation.
+     * See https://confluence-eng-gpk2.cisco.com/conf/display/WBXT/Getting+started+with+Metrics+Service.
+     *
+     * @param {string} metricName  Name of the metric (measurement) to send
+     * @param {Object} metricFields  Key-valye pairs of data or values about this metric
+     * @param {Object} metricTags  Key-value pairs of metric metadata
+     *
+     * @returns {void}
+     */
+    sendBehavioralMetric(metricName: string, metricFields?: object, metricTags?: object): void;
+}
+declare const instance: Metrics;
+export default instance;