@webex/internal-plugin-metrics 3.0.0-beta.17 → 3.0.0-beta.171

package/dist/new-metrics.js

@@ -0,0 +1,171 @@
+"use strict";
+
+var _Reflect$construct = require("@babel/runtime-corejs2/core-js/reflect/construct");
+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 _assertThisInitialized2 = _interopRequireDefault(require("@babel/runtime-corejs2/helpers/assertThisInitialized"));
+var _inherits2 = _interopRequireDefault(require("@babel/runtime-corejs2/helpers/inherits"));
+var _possibleConstructorReturn2 = _interopRequireDefault(require("@babel/runtime-corejs2/helpers/possibleConstructorReturn"));
+var _getPrototypeOf2 = _interopRequireDefault(require("@babel/runtime-corejs2/helpers/getPrototypeOf"));
+var _defineProperty2 = _interopRequireDefault(require("@babel/runtime-corejs2/helpers/defineProperty"));
+var _webexCore = require("@webex/webex-core");
+var _callDiagnosticMetrics = _interopRequireDefault(require("./call-diagnostic/call-diagnostic-metrics"));
+var _callDiagnosticMetricsLatencies = _interopRequireDefault(require("./call-diagnostic/call-diagnostic-metrics-latencies"));
+function _createSuper(Derived) { var hasNativeReflectConstruct = _isNativeReflectConstruct(); return function _createSuperInternal() { var Super = (0, _getPrototypeOf2.default)(Derived), result; if (hasNativeReflectConstruct) { var NewTarget = (0, _getPrototypeOf2.default)(this).constructor; result = _Reflect$construct(Super, arguments, NewTarget); } else { result = Super.apply(this, arguments); } return (0, _possibleConstructorReturn2.default)(this, result); }; }
+function _isNativeReflectConstruct() { if (typeof Reflect === "undefined" || !_Reflect$construct) return false; if (_Reflect$construct.sham) return false; if (typeof Proxy === "function") return true; try { Boolean.prototype.valueOf.call(_Reflect$construct(Boolean, [], function () {})); return true; } catch (e) { return false; } }
+/**
+ * Metrics plugin to centralize all types of metrics.
+ * @class
+ */
+var Metrics = /*#__PURE__*/function (_WebexPlugin) {
+  (0, _inherits2.default)(Metrics, _WebexPlugin);
+  var _super = _createSuper(Metrics);
+  // eslint-disable-next-line no-use-before-define
+
+  // Call Diagnostic latencies
+
+  // Helper classes to handle the different types of metrics
+
+  /**
+   * Constructor
+   * @param args
+   * @constructor
+   * @private
+   * @returns
+   */
+  function Metrics() {
+    var _this;
+    (0, _classCallCheck2.default)(this, Metrics);
+    for (var _len = arguments.length, args = new Array(_len), _key = 0; _key < _len; _key++) {
+      args[_key] = arguments[_key];
+    }
+    _this = _super.call.apply(_super, [this].concat(args));
+    (0, _defineProperty2.default)((0, _assertThisInitialized2.default)(_this), "callDiagnosticLatencies", void 0);
+    (0, _defineProperty2.default)((0, _assertThisInitialized2.default)(_this), "callDiagnosticMetrics", void 0);
+    _this.callDiagnosticLatencies = new _callDiagnosticMetricsLatencies.default();
+    _this.onReady();
+    return _this;
+  }
+
+  /**
+   * On Ready
+   */
+  (0, _createClass2.default)(Metrics, [{
+    key: "onReady",
+    value: function onReady() {
+      var _this2 = this;
+      // @ts-ignore
+      this.webex.once('ready', function () {
+        // @ts-ignore
+        _this2.callDiagnosticMetrics = new _callDiagnosticMetrics.default({}, {
+          parent: _this2.webex
+        });
+      });
+    }
+
+    /**
+     * Used for internal purposes only
+     * @param args
+     */
+  }, {
+    key: "submitInternalEvent",
+    value: function submitInternalEvent(_ref) {
+      var name = _ref.name,
+        payload = _ref.payload,
+        options = _ref.options;
+      if (name === 'internal.reset.join.latencies') {
+        this.callDiagnosticLatencies.clearTimestamps();
+      } else {
+        this.callDiagnosticLatencies.saveTimestamp(name);
+      }
+    }
+
+    /**
+     * Behavioral event
+     * @param args
+     */
+  }, {
+    key: "submitBehavioralEvent",
+    value: function submitBehavioralEvent(_ref2) {
+      var name = _ref2.name,
+        payload = _ref2.payload,
+        options = _ref2.options;
+      this.callDiagnosticLatencies.saveTimestamp(name);
+      throw new Error('Not implemented.');
+    }
+
+    /**
+     * Operational event
+     * @param args
+     */
+  }, {
+    key: "submitOperationalEvent",
+    value: function submitOperationalEvent(_ref3) {
+      var name = _ref3.name,
+        payload = _ref3.payload,
+        options = _ref3.options;
+      throw new Error('Not implemented.');
+    }
+
+    /**
+     * Call Analyzer: Media Quality Event
+     * @param args
+     */
+  }, {
+    key: "submitMQE",
+    value: function submitMQE(_ref4) {
+      var name = _ref4.name,
+        payload = _ref4.payload,
+        options = _ref4.options;
+      this.callDiagnosticLatencies.saveTimestamp(name);
+      this.callDiagnosticMetrics.submitMQE({
+        name: name,
+        payload: payload,
+        options: options
+      });
+    }
+
+    /**
+     * Call Analyzer: Feature Usage Event
+     * @param args
+     */
+  }, {
+    key: "submitFeatureEvent",
+    value: function submitFeatureEvent(_ref5) {
+      var name = _ref5.name,
+        payload = _ref5.payload,
+        options = _ref5.options;
+      throw new Error('Not implemented.');
+    }
+
+    /**
+     * Call Analyzer: Client Event
+     * @public
+     * @param args
+     */
+  }, {
+    key: "submitClientEvent",
+    value: function submitClientEvent(_ref6) {
+      var name = _ref6.name,
+        payload = _ref6.payload,
+        options = _ref6.options;
+      this.callDiagnosticLatencies.saveTimestamp(name);
+      this.callDiagnosticMetrics.submitClientEvent({
+        name: name,
+        payload: payload,
+        options: options
+      });
+    }
+  }]);
+  return Metrics;
+}(_webexCore.WebexPlugin);
+(0, _defineProperty2.default)(Metrics, "instance", void 0);
+var _default = Metrics;
+exports.default = _default;
+//# sourceMappingURL=new-metrics.js.map

package/dist/new-metrics.js.map

@@ -0,0 +1 @@
+{"version":3,"names":["Metrics","args","callDiagnosticLatencies","CallDiagnosticLatencies","onReady","webex","once","callDiagnosticMetrics","CallDiagnosticMetrics","parent","name","payload","options","clearTimestamps","saveTimestamp","Error","submitMQE","submitClientEvent","WebexPlugin"],"sources":["new-metrics.ts"],"sourcesContent":["/* eslint-disable @typescript-eslint/no-unused-vars */\n/* eslint-disable class-methods-use-this */\n/* eslint-disable valid-jsdoc */\n\n// @ts-ignore\nimport {WebexPlugin} from '@webex/webex-core';\n\nimport CallDiagnosticMetrics from './call-diagnostic/call-diagnostic-metrics';\nimport {\n  RecursivePartial,\n  ClientEvent,\n  FeatureEvent,\n  BehavioralEvent,\n  OperationalEvent,\n  MediaQualityEvent,\n  InternalEvent,\n  SubmitClientEventOptions,\n} from './metrics.types';\nimport CallDiagnosticLatencies from './call-diagnostic/call-diagnostic-metrics-latencies';\n\n/**\n * Metrics plugin to centralize all types of metrics.\n * @class\n */\nclass Metrics extends WebexPlugin {\n  // eslint-disable-next-line no-use-before-define\n  static instance: Metrics;\n\n  // Call Diagnostic latencies\n  callDiagnosticLatencies: CallDiagnosticLatencies;\n  // Helper classes to handle the different types of metrics\n  callDiagnosticMetrics: CallDiagnosticMetrics;\n\n  /**\n   * Constructor\n   * @param args\n   * @constructor\n   * @private\n   * @returns\n   */\n  constructor(...args) {\n    super(...args);\n\n    this.callDiagnosticLatencies = new CallDiagnosticLatencies();\n\n    this.onReady();\n  }\n\n  /**\n   * On Ready\n   */\n  private onReady() {\n    // @ts-ignore\n    this.webex.once('ready', () => {\n      // @ts-ignore\n      this.callDiagnosticMetrics = new CallDiagnosticMetrics({}, {parent: this.webex});\n    });\n  }\n\n  /**\n   * Used for internal purposes only\n   * @param args\n   */\n  submitInternalEvent({\n    name,\n    payload,\n    options,\n  }: {\n    name: InternalEvent['name'];\n    payload?: RecursivePartial<InternalEvent['payload']>;\n    options?: any;\n  }) {\n    if (name === 'internal.reset.join.latencies') {\n      this.callDiagnosticLatencies.clearTimestamps();\n    } else {\n      this.callDiagnosticLatencies.saveTimestamp(name);\n    }\n  }\n\n  /**\n   * Behavioral event\n   * @param args\n   */\n  submitBehavioralEvent({\n    name,\n    payload,\n    options,\n  }: {\n    name: BehavioralEvent['name'];\n    payload?: RecursivePartial<BehavioralEvent['payload']>;\n    options?: any;\n  }) {\n    this.callDiagnosticLatencies.saveTimestamp(name);\n    throw new Error('Not implemented.');\n  }\n\n  /**\n   * Operational event\n   * @param args\n   */\n  submitOperationalEvent({\n    name,\n    payload,\n    options,\n  }: {\n    name: OperationalEvent['name'];\n    payload?: RecursivePartial<OperationalEvent['payload']>;\n    options?: any;\n  }) {\n    throw new Error('Not implemented.');\n  }\n\n  /**\n   * Call Analyzer: Media Quality Event\n   * @param args\n   */\n  submitMQE({\n    name,\n    payload,\n    options,\n  }: {\n    name: MediaQualityEvent['name'];\n    payload: RecursivePartial<MediaQualityEvent['payload']> & {\n      intervals: MediaQualityEvent['payload']['intervals'];\n    };\n    options: any;\n  }) {\n    this.callDiagnosticLatencies.saveTimestamp(name);\n    this.callDiagnosticMetrics.submitMQE({name, payload, options});\n  }\n\n  /**\n   * Call Analyzer: Feature Usage Event\n   * @param args\n   */\n  submitFeatureEvent({\n    name,\n    payload,\n    options,\n  }: {\n    name: FeatureEvent['name'];\n    payload?: RecursivePartial<FeatureEvent['payload']>;\n    options: any;\n  }) {\n    throw new Error('Not implemented.');\n  }\n\n  /**\n   * Call Analyzer: Client Event\n   * @public\n   * @param args\n   */\n  public submitClientEvent({\n    name,\n    payload,\n    options,\n  }: {\n    name: ClientEvent['name'];\n    payload?: RecursivePartial<ClientEvent['payload']>;\n    options: SubmitClientEventOptions;\n  }) {\n    this.callDiagnosticLatencies.saveTimestamp(name);\n    this.callDiagnosticMetrics.submitClientEvent({name, payload, options});\n  }\n}\n\nexport default Metrics;\n"],"mappings":";;;;;;;;;;;;;;;;AAKA;AAEA;AAWA;AAA0F;AAAA;AAE1F;AACA;AACA;AACA;AAHA,IAIMA,OAAO;EAAA;EAAA;EACX;;EAGA;;EAEA;;EAGA;AACF;AACA;AACA;AACA;AACA;AACA;EACE,mBAAqB;IAAA;IAAA;IAAA,kCAANC,IAAI;MAAJA,IAAI;IAAA;IACjB,gDAASA,IAAI;IAAE;IAAA;IAEf,MAAKC,uBAAuB,GAAG,IAAIC,uCAAuB,EAAE;IAE5D,MAAKC,OAAO,EAAE;IAAC;EACjB;;EAEA;AACF;AACA;EAFE;IAAA;IAAA,OAGA,mBAAkB;MAAA;MAChB;MACA,IAAI,CAACC,KAAK,CAACC,IAAI,CAAC,OAAO,EAAE,YAAM;QAC7B;QACA,MAAI,CAACC,qBAAqB,GAAG,IAAIC,8BAAqB,CAAC,CAAC,CAAC,EAAE;UAACC,MAAM,EAAE,MAAI,CAACJ;QAAK,CAAC,CAAC;MAClF,CAAC,CAAC;IACJ;;IAEA;AACF;AACA;AACA;EAHE;IAAA;IAAA,OAIA,mCAQG;MAAA,IAPDK,IAAI,QAAJA,IAAI;QACJC,OAAO,QAAPA,OAAO;QACPC,OAAO,QAAPA,OAAO;MAMP,IAAIF,IAAI,KAAK,+BAA+B,EAAE;QAC5C,IAAI,CAACR,uBAAuB,CAACW,eAAe,EAAE;MAChD,CAAC,MAAM;QACL,IAAI,CAACX,uBAAuB,CAACY,aAAa,CAACJ,IAAI,CAAC;MAClD;IACF;;IAEA;AACF;AACA;AACA;EAHE;IAAA;IAAA,OAIA,sCAQG;MAAA,IAPDA,IAAI,SAAJA,IAAI;QACJC,OAAO,SAAPA,OAAO;QACPC,OAAO,SAAPA,OAAO;MAMP,IAAI,CAACV,uBAAuB,CAACY,aAAa,CAACJ,IAAI,CAAC;MAChD,MAAM,IAAIK,KAAK,CAAC,kBAAkB,CAAC;IACrC;;IAEA;AACF;AACA;AACA;EAHE;IAAA;IAAA,OAIA,uCAQG;MAAA,IAPDL,IAAI,SAAJA,IAAI;QACJC,OAAO,SAAPA,OAAO;QACPC,OAAO,SAAPA,OAAO;MAMP,MAAM,IAAIG,KAAK,CAAC,kBAAkB,CAAC;IACrC;;IAEA;AACF;AACA;AACA;EAHE;IAAA;IAAA,OAIA,0BAUG;MAAA,IATDL,IAAI,SAAJA,IAAI;QACJC,OAAO,SAAPA,OAAO;QACPC,OAAO,SAAPA,OAAO;MAQP,IAAI,CAACV,uBAAuB,CAACY,aAAa,CAACJ,IAAI,CAAC;MAChD,IAAI,CAACH,qBAAqB,CAACS,SAAS,CAAC;QAACN,IAAI,EAAJA,IAAI;QAAEC,OAAO,EAAPA,OAAO;QAAEC,OAAO,EAAPA;MAAO,CAAC,CAAC;IAChE;;IAEA;AACF;AACA;AACA;EAHE;IAAA;IAAA,OAIA,mCAQG;MAAA,IAPDF,IAAI,SAAJA,IAAI;QACJC,OAAO,SAAPA,OAAO;QACPC,OAAO,SAAPA,OAAO;MAMP,MAAM,IAAIG,KAAK,CAAC,kBAAkB,CAAC;IACrC;;IAEA;AACF;AACA;AACA;AACA;EAJE;IAAA;IAAA,OAKA,kCAQG;MAAA,IAPDL,IAAI,SAAJA,IAAI;QACJC,OAAO,SAAPA,OAAO;QACPC,OAAO,SAAPA,OAAO;MAMP,IAAI,CAACV,uBAAuB,CAACY,aAAa,CAACJ,IAAI,CAAC;MAChD,IAAI,CAACH,qBAAqB,CAACU,iBAAiB,CAAC;QAACP,IAAI,EAAJA,IAAI;QAAEC,OAAO,EAAPA,OAAO;QAAEC,OAAO,EAAPA;MAAO,CAAC,CAAC;IACxE;EAAC;EAAA;AAAA,EA3ImBM,sBAAW;AAAA,8BAA3BlB,OAAO;AAAA,eA8IEA,OAAO;AAAA"}

package/dist/types/batcher.d.ts

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

package/dist/types/call-diagnostic/call-diagnostic-metrics-batcher.d.ts

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

package/dist/types/call-diagnostic/call-diagnostic-metrics-latencies.d.ts

@@ -0,0 +1,154 @@
+import { MetricEventNames } from '../metrics.types';
+/**
+ * @description Helper class to store latencies timestamp and to calculate various latencies for CA.
+ * @exports
+ * @class CallDiagnosticLatencies
+ */
+export default class CallDiagnosticLatencies {
+    latencyTimestamps: Map<MetricEventNames, number>;
+    /**
+     * @constructor
+     */
+    constructor();
+    /**
+     * Clear timestamps
+     */
+    clearTimestamps(): void;
+    /**
+     * Store timestamp value
+     * @param key - key
+     * @param  value -value
+     * @throws
+     * @returns
+     */
+    saveTimestamp(key: MetricEventNames, value?: number): void;
+    /**
+     * Helper to calculate end - start
+     * @param a start
+     * @param b end
+     * @returns latency
+     */
+    getDiffBetweenTimestamps(a: MetricEventNames, b: MetricEventNames): number;
+    /**
+     * Meeting Info Request
+     * @note Meeting Info request happen not just in the join phase. CA requires
+     * metrics around meeting info request that are only part of join phase.
+     * This internal.* event is used to track the real timestamps
+     * (when the actual request/response happen). This is because the actual CA event is
+     * sent inside the join method on the meeting object based on some logic, but that's not exactly when
+     * those events are actually fired. The logic only confirms that they have happened, and we send them over.
+     * @returns - latency
+     */
+    getMeetingInfoReqResp(): number;
+    /**
+     * Interstitial Time
+     * @returns - latency
+     */
+    getShowInterstitialTime(): number;
+    /**
+     * Call Init Join Request
+     * @returns - latency
+     */
+    getCallInitJoinReq(): number;
+    /**
+     * Locus Join Request
+     * @returns - latency
+     */
+    getJoinReqResp(): number;
+    /**
+     * Locus Join Response Sent Received
+     * @returns - latency
+     */
+    getJoinRespSentReceived(): any;
+    /**
+     * Local SDP Generated Remote SDP REceived
+     * @returns - latency
+     */
+    getLocalSDPGenRemoteSDPRecv(): number;
+    /**
+     * ICE Setup Time
+     * @returns - latency
+     */
+    getICESetupTime(): number;
+    /**
+     * Audio ICE time
+     * @returns - latency
+     */
+    getAudioICESetupTime(): number;
+    /**
+     * Video ICE Time
+     * @returns - latency
+     */
+    getVideoICESetupTime(): number;
+    /**
+     * Share ICE Time
+     * @returns - latency
+     */
+    getShareICESetupTime(): number;
+    /**
+     * Stay Lobby Time
+     * @returns - latency
+     */
+    getStayLobbyTime(): number;
+    /**
+     * Page JMT
+     * @returns - latency
+     */
+    getPageJMT(): number;
+    /**
+     * Click To Interstitial
+     * @returns - latency
+     */
+    getClickToInterstitial(): number;
+    /**
+     * Interstitial To Join Ok
+     * @returns - latency
+     */
+    getInterstitialToJoinOK(): number;
+    /**
+     * Interstitial To Media Ok
+     * @returns - latency
+     */
+    getInterstitialToMediaOK(): number;
+    /**
+     * Total JMT
+     * @returns - latency
+     */
+    getTotalJMT(): number;
+    /**
+     * Join Conf JMT
+     * @returns - latency
+     */
+    getJoinConfJMT(): number;
+    /**
+     * Total Media JMT
+     * @returns - latency
+     */
+    getTotalMediaJMT(): number;
+    /**
+     * Client JMT
+     * @returns - latency
+     */
+    getClientJMT(): number;
+    /**
+     * Interstitial To Media OK JMT
+     * @returns - latency
+     */
+    getInterstitialToMediaOKJMT(): number;
+    /**
+     * Audio setup delay receive
+     */
+    getAudioJoinRespRxStart(): number;
+    /**
+     * Video setup delay receive
+     */
+    getVideoJoinRespRxStart(): number;
+    /**
+     * Audio setup delay transmit
+     */
+    getAudioJoinRespTxStart(): number;
+    /**
+     * Video setup delay transmit
+     */
+    getVideoJoinRespTxStart(): number;
+}

package/dist/types/call-diagnostic/call-diagnostic-metrics.d.ts

@@ -0,0 +1,324 @@
+import { StatelessWebexPlugin } from '@webex/webex-core';
+import { Event, ClientType, SubClientType, NetworkType, ClientEvent, SubmitClientEventOptions, MediaQualityEvent, SubmitMQEOptions, SubmitMQEPayload, ClientEventError, ClientEventPayload } from '../metrics.types';
+type GetOriginOptions = {
+    clientType: ClientType;
+    subClientType: SubClientType;
+    networkType?: NetworkType;
+};
+type GetIdentifiersOptions = {
+    meeting?: any;
+    mediaConnections?: any[];
+    correlationId?: string;
+};
+/**
+ * @description Util class to handle Call Analyzer Metrics
+ * @export
+ * @class CallDiagnosticMetrics
+ */
+export default class CallDiagnosticMetrics extends StatelessWebexPlugin {
+    private callDiagnosticEventsBatcher;
+    /**
+     * Constructor
+     * @param args
+     */
+    constructor(...args: any[]);
+    /**
+     * Returns the login type of the current user
+     * @returns one of 'login-ci','unverified-guest', null
+     */
+    getCurLoginType(): "login-ci" | "unverified-guest";
+    /**
+     * Get origin object for Call Diagnostic Event payload.
+     * @param options
+     * @param meetingId
+     * @returns
+     */
+    getOrigin(options: GetOriginOptions, meetingId?: string): {
+        name: "antares" | "beech" | "breakout" | "cb" | "cloudproxy" | "edonus" | "endpoint" | "givr" | "hecate" | "hedge" | "hesiod" | "homer" | "superhomer" | "l2sip" | "linus" | "locus" | "mcc" | "mcs" | "mercury" | "mes" | "mjs" | "mmp" | "mygdon" | "orpheus" | "page" | "poros" | "rhesos" | "terminus" | "tpgw" | "ucc" | "wdm" | "webexivr";
+        userAgent: string;
+        buildType?: "debug" | "test" | "prod" | "tap" | "analyzer-test";
+        upgradeChannel?: string;
+        instanceId?: string;
+        networkType: "unknown" | "wifi" | "ethernet" | "cellular";
+        localIP?: string;
+        usingProxy?: boolean;
+        mediaEngineSoftwareVersion?: string;
+        environment?: string;
+        newEnvironment?: string;
+        clientInfo?: {
+            os: "windows" | "mac" | "ios" | "android" | "chrome" | "linux" | "other" | "uwp-arm64";
+            osVersion: string;
+            localIP?: string;
+            gatewayIP?: string;
+            macAddress?: string;
+            localNetworkPrefix?: string;
+            publicNetworkPrefix?: string;
+            browserLaunchMethod?: "activex" | "npapi" | "extension" | "cwsapi" | "java" | "tfs" | "webacd" | "url-handler" | "thinclient";
+            clientLaunchMethod?: "url-handler" | "universal-link" | "voice-command" | "notification" | "manual" | "teams-cross-launch";
+            browser?: string;
+            browserVersion?: string;
+            clientType?: "SIP" | "MEETING_CENTER" | "EVENT_CENTER" | "TRAINING_CENTER" | "TEAMS_CLIENT" | "TEAMS_DEVICE" | "TEAMS_SHARE" | "RECORDING" | "CLOUD_AWARE_SIP" | "TEAMS_WXC_CLIENT" | "WXC_CLIENT" | "WXC_DEVICE" | "WEBEX_JS_SDK" | "VOICEA_CLIENT" | "CISCO_SIP_GW" | "WEBEX_SDK" | "CPAAS_THIRD_PARTY_SDK" | "WXC_THIRD_PARTY";
+            subClientType?: "DESKTOP_APP" | "DESKTOP_APP_VDI" | "DEVICE_CURRENT" | "DEVICE_LEGACY_2020" | "HVDI_APP" | "MOBILE_APP" | "VDI_APP" | "WEB_APP" | "MOBILE_NETWORK" | "HOLOGRAM_HEADSET_APP";
+            clientVersion?: string;
+            localClientVersion?: string;
+            modelNumber?: string;
+            joinFirstUpdateLater?: "ep-enabled" | "sp-enabled" | "not-enabled";
+            standbyUsed?: boolean;
+            prefetchDocShowUsed?: boolean;
+            fastJoinUsed?: boolean;
+            clientDownloadSize?: number;
+            clientDownloadFileCount?: number;
+            nodeId?: number;
+            machineInfo?: string;
+            parentAppName?: string;
+            parentAppInPermitList?: boolean;
+            meetingSiteType?: "train" | "webex-11" | "orion";
+            CDNEnabled?: boolean;
+            clientMajorVersion?: string;
+            majorVersion?: number;
+            minorVersion?: number;
+            revision?: number;
+            isValidClientVersion?: boolean;
+            cpuInfo?: {
+                description: string;
+                clockSpeedGigaHertz: number;
+                numberOfCores: number;
+                architecture: "unknown" | "intel32" | "intel64" | "amd32" | "amd64" | "arm32" | "arm64";
+                staticPerformance?: string;
+            };
+            shareType?: "cb-normal-share" | "ce-airplay-share" | "ce-direct-share" | "ce-gui-loopback-share" | "ce-input-source-share" | "ce-input-source-share-hdmi" | "ce-input-source-share-usbc" | "ce-jpg-share" | "ce-miracast-share" | "mcs-normal-share" | "mcs-normal-audio-share" | "mcs-hfps-share" | "mcs-hfps-audio-share";
+            videoDisplayMode?: "grid-view" | "active-speaker-view";
+            videoLayoutType?: "stack" | "stackWithShare" | "sideBySide" | "sideBySideWithShare" | "grid" | "floatingActive" | "floatingThumbnail" | "floatingGrid" | "overlay" | "focus" | "prominent" | "focusWithShare" | "prominentWithShare" | "equal" | "equalWithShare";
+            videoRenderType?: "wme" | "client_d3d" | "client_gdi";
+            vdiInfo?: unknown;
+            is64BitsClient?: boolean;
+            webexAppVersion?: string;
+            launch32BitsReason?: "forcewin32" | "disablewin64" | "platform_win32" | "platform_arm" | "platform_unknown" | "version_below_41.11";
+            inMeetingUpdate?: boolean;
+            mtaVersion?: string;
+            isWarholOpening?: boolean;
+        };
+        isHybridMedia?: boolean;
+        originData?: {};
+    };
+    /**
+     * Gather identifier details for call diagnostic payload.
+     * @throws Error if initialization fails.
+     * @param options
+     */
+    getIdentifiers(options: GetIdentifiersOptions): {
+        attendeeId?: string;
+        breakoutGroupId?: string;
+        breakoutMoveId?: string;
+        breakoutSessionId?: string;
+        confluenceId?: string;
+        cpaasIdentifiers?: {
+            imiTenantId: string;
+            devClientId: string;
+            imiServiceId: string;
+            imiAppId: string;
+            sessionId: string;
+            sessionInstanceId: string;
+        };
+        csdmDeviceUrl?: string;
+        destinationBreakoutSessionId?: string;
+        destinationLocusSessionId?: string;
+        destinationLocusUrl?: string;
+        destinationVenueId?: string;
+        deviceId?: string;
+        ivrCallId?: string;
+        ivrDialogId?: string;
+        ivrId?: string;
+        locusId?: string;
+        locusSessionId?: string;
+        locusStartTime?: string;
+        locusUrl?: string;
+        mediaAgentAlias?: string;
+        mediaAgentGroupId?: string;
+        meetClusterName?: string;
+        meetingLookupUrl?: string;
+        meetingOrgId?: string;
+        msteamsTenantGuid?: string;
+        msteamsConferenceId?: string;
+        oauth2ClientId?: string;
+        orgId?: string;
+        roomId?: string;
+        sipCallId?: string;
+        sipSessionId?: {
+            local?: string;
+            remote?: string;
+        };
+        sipUri?: string;
+        subConfId?: string;
+        tenantId?: string;
+        trackingId?: string;
+        userId?: string;
+        venueId?: string;
+        venueUrl?: string;
+        whiteboardUrl?: string;
+        webexConferenceId?: number;
+        webexClusterName?: string;
+        webexConferenceIdStr?: string;
+        webexDataCenter?: string;
+        webexGuestId?: number;
+        webexMeetingId?: number;
+        webexNodeId?: number;
+        webexSiteId?: number;
+        webexSiteName?: string;
+        webexUserId?: number;
+        webexWebDomain?: string;
+        correlationId: string;
+    } | {
+        attendeeId?: string;
+        breakoutGroupId?: string;
+        breakoutMoveId?: string;
+        breakoutSessionId?: string;
+        confluenceId?: string;
+        cpaasIdentifiers?: {
+            imiTenantId: string;
+            devClientId: string;
+            imiServiceId: string;
+            imiAppId: string;
+            sessionId: string;
+            sessionInstanceId: string;
+        };
+        csdmDeviceUrl?: string;
+        destinationBreakoutSessionId?: string;
+        destinationLocusSessionId?: string;
+        destinationLocusUrl?: string;
+        destinationVenueId?: string;
+        deviceId?: string;
+        ivrCallId?: string;
+        ivrDialogId?: string;
+        ivrId?: string;
+        locusId?: string;
+        locusSessionId?: string;
+        locusStartTime?: string;
+        locusUrl?: string;
+        mediaAgentAlias?: string;
+        mediaAgentGroupId?: string;
+        meetClusterName?: string;
+        meetingLookupUrl?: string;
+        meetingOrgId?: string;
+        msteamsTenantGuid?: string;
+        msteamsConferenceId?: string;
+        oauth2ClientId?: string;
+        orgId?: string;
+        provisionalCorrelationId?: string;
+        roomId?: string;
+        sipCallId?: string;
+        sipSessionId?: {
+            local?: string;
+            remote?: string;
+        };
+        sipUri?: string;
+        subConfId?: string;
+        tenantId?: string;
+        trackingId?: string;
+        userId?: string;
+        venueId?: string;
+        venueUrl?: string;
+        whiteboardUrl?: string;
+        webexConferenceId?: number;
+        webexClusterName?: string;
+        webexConferenceIdStr?: string;
+        webexDataCenter?: string;
+        webexGuestId?: number;
+        webexMeetingId?: number;
+        webexNodeId?: number;
+        webexSiteId?: number;
+        webexSiteName?: string;
+        webexUserId?: number;
+        webexWebDomain?: string;
+        correlationId: string;
+    };
+    /**
+     * Create diagnostic event, which can hold client event, feature event or MQE event data.
+     * This just initiates the shared properties that are required for all the 3 event categories.
+     * @param eventData
+     * @param options
+     * @returns
+     */
+    prepareDiagnosticEvent(eventData: Event['event'], options: any): Event;
+    /**
+     * TODO: NOT IMPLEMENTED
+     * Submit Feature Event
+     * @returns
+     */
+    submitFeatureEvent(): void;
+    /**
+     * Submit Media Quality Event
+     * @param args - submit params
+     * @param arg.name - event key
+     * @param arg.payload - additional payload to be merge with the default payload
+     * @param arg.options - options
+     */
+    submitMQE({ name, payload, options, }: {
+        name: MediaQualityEvent['name'];
+        payload: SubmitMQEPayload;
+        options: SubmitMQEOptions;
+    }): void;
+    /**
+     * Return Client Event payload by client error code
+     * @param arg - get error arg
+     * @param arg.clientErrorCode
+     * @param arg.serviceErrorCode
+     * @returns
+     */
+    getErrorPayloadForClientErrorCode({ clientErrorCode, serviceErrorCode, }: {
+        clientErrorCode: number;
+        serviceErrorCode: any;
+    }): ClientEventError;
+    /**
+     * Generate error payload for Client Event
+     * @param rawError
+     */
+    generateClientEventErrorPayload(rawError: any): {
+        fatal: boolean;
+        category: "other" | "signaling" | "media" | "expected";
+        errorDescription?: string;
+        errorCode?: number;
+        errorCodeStr?: string;
+        httpCode?: number;
+        errorData?: {};
+        shownToUser: boolean;
+        serviceErrorCode?: number;
+        name: "other" | "media-engine" | "ice.failed" | "locus.response" | "locus.leave" | "client.leave" | "media-device" | "media-sca";
+    };
+    /**
+     * Create client event object for in meeting events
+     * @param arg - create args
+     * @param arg.event - event key
+     * @param arg.options - options
+     * @returns object
+     */
+    private createClientEventObjectInMeeting;
+    /**
+     * Create client event object for pre meeting events
+     * @param arg - create args
+     * @param arg.event - event key
+     * @param arg.options - payload
+     * @returns object
+     */
+    private createClientEventObjectPreMeeting;
+    /**
+     * Submit Client Event CA event.
+     * @param arg - submit params
+     * @param arg.event - event key
+     * @param arg.payload - additional payload to be merged with default payload
+     * @param arg.options - payload
+     * @throws
+     */
+    submitClientEvent({ name, payload, options, }: {
+        name: ClientEvent['name'];
+        payload?: ClientEventPayload;
+        options: SubmitClientEventOptions;
+    }): void;
+    /**
+     * Prepare the event and send the request to metrics-a service.
+     * @param event
+     * @returns promise
+     */
+    submitToCallDiagnostics(event: Event): Promise<void>;
+}
+export {};