@webex/internal-plugin-metrics 3.0.0-beta.27 → 3.0.0-beta.270

package/dist/config.js

@@ -4,7 +4,7 @@ var _Object$defineProperty = require("@babel/runtime-corejs2/core-js/object/defi
 _Object$defineProperty(exports, "__esModule", {
   value: true
 });
-exports.default = exports.CLIENT_NAME = void 0;
+exports.default = exports.OS_NAME = exports.OSMap = exports.CLIENT_NAME = void 0;
 var _common = require("@webex/common");
 /*!
  * Copyright (c) 2015-2020 Cisco Systems, Inc. See LICENSE file.
@@ -28,4 +28,23 @@ var _default = {
   }
 };
 exports.default = _default;
+var OS_NAME = {
+  WINDOWS: 'windows',
+  MAC: 'mac',
+  IOS: 'ios',
+  ANDROID: 'android',
+  CHROME: 'chrome',
+  LINUX: 'linux',
+  OTHERS: 'other'
+};
+exports.OS_NAME = OS_NAME;
+var OSMap = {
+  'Chrome OS': OS_NAME.CHROME,
+  macOS: OS_NAME.MAC,
+  Windows: OS_NAME.WINDOWS,
+  iOS: OS_NAME.IOS,
+  Android: OS_NAME.ANDROID,
+  Linux: OS_NAME.LINUX
+};
+exports.OSMap = OSMap;
 //# sourceMappingURL=config.js.map

package/dist/config.js.map

@@ -1 +1 @@
-{"version":3,"names":["CLIENT_NAME","device","preDiscoveryServices","metricsServiceUrl","process","env","METRICS_SERVICE_URL","metrics","appType","inBrowser","batcherWait","batcherMaxCalls","batcherMaxWait","batcherRetryPlateau"],"sources":["config.js"],"sourcesContent":["/*!\n * Copyright (c) 2015-2020 Cisco Systems, Inc. See LICENSE file.\n */\n\nimport {inBrowser} from '@webex/common';\n\nexport const CLIENT_NAME = 'webex-js-sdk';\nexport default {\n  device: {\n    preDiscoveryServices: {\n      metricsServiceUrl:\n        process.env.METRICS_SERVICE_URL || 'https://metrics-a.wbx2.com/metrics/api/v1',\n      metrics: process.env.METRICS_SERVICE_URL || 'https://metrics-a.wbx2.com/metrics/api/v1',\n    },\n  },\n  metrics: {\n    appType: inBrowser ? 'browser' : 'nodejs',\n    batcherWait: 500,\n    batcherMaxCalls: 50,\n    batcherMaxWait: 1500,\n    batcherRetryPlateau: 32000,\n  },\n};\n"],"mappings":";;;;;;;AAIA;AAJA;AACA;AACA;;AAIO,IAAMA,WAAW,GAAG,cAAc;AAAC;AAAA,eAC3B;EACbC,MAAM,EAAE;IACNC,oBAAoB,EAAE;MACpBC,iBAAiB,EACfC,OAAO,CAACC,GAAG,CAACC,mBAAmB,IAAI,2CAA2C;MAChFC,OAAO,EAAEH,OAAO,CAACC,GAAG,CAACC,mBAAmB,IAAI;IAC9C;EACF,CAAC;EACDC,OAAO,EAAE;IACPC,OAAO,EAAEC,iBAAS,GAAG,SAAS,GAAG,QAAQ;IACzCC,WAAW,EAAE,GAAG;IAChBC,eAAe,EAAE,EAAE;IACnBC,cAAc,EAAE,IAAI;IACpBC,mBAAmB,EAAE;EACvB;AACF,CAAC;AAAA"}
+{"version":3,"names":["CLIENT_NAME","device","preDiscoveryServices","metricsServiceUrl","process","env","METRICS_SERVICE_URL","metrics","appType","inBrowser","batcherWait","batcherMaxCalls","batcherMaxWait","batcherRetryPlateau","OS_NAME","WINDOWS","MAC","IOS","ANDROID","CHROME","LINUX","OTHERS","OSMap","macOS","Windows","iOS","Android","Linux"],"sources":["config.js"],"sourcesContent":["/*!\n * Copyright (c) 2015-2020 Cisco Systems, Inc. See LICENSE file.\n */\n\nimport {inBrowser} from '@webex/common';\n\nexport const CLIENT_NAME = 'webex-js-sdk';\nexport default {\n  device: {\n    preDiscoveryServices: {\n      metricsServiceUrl:\n        process.env.METRICS_SERVICE_URL || 'https://metrics-a.wbx2.com/metrics/api/v1',\n      metrics: process.env.METRICS_SERVICE_URL || 'https://metrics-a.wbx2.com/metrics/api/v1',\n    },\n  },\n  metrics: {\n    appType: inBrowser ? 'browser' : 'nodejs',\n    batcherWait: 500,\n    batcherMaxCalls: 50,\n    batcherMaxWait: 1500,\n    batcherRetryPlateau: 32000,\n  },\n};\n\nexport const OS_NAME = {\n  WINDOWS: 'windows',\n  MAC: 'mac',\n  IOS: 'ios',\n  ANDROID: 'android',\n  CHROME: 'chrome',\n  LINUX: 'linux',\n  OTHERS: 'other',\n};\n\nexport const OSMap = {\n  'Chrome OS': OS_NAME.CHROME,\n  macOS: OS_NAME.MAC,\n  Windows: OS_NAME.WINDOWS,\n  iOS: OS_NAME.IOS,\n  Android: OS_NAME.ANDROID,\n  Linux: OS_NAME.LINUX,\n};\n"],"mappings":";;;;;;;AAIA;AAJA;AACA;AACA;;AAIO,IAAMA,WAAW,GAAG,cAAc;AAAC;AAAA,eAC3B;EACbC,MAAM,EAAE;IACNC,oBAAoB,EAAE;MACpBC,iBAAiB,EACfC,OAAO,CAACC,GAAG,CAACC,mBAAmB,IAAI,2CAA2C;MAChFC,OAAO,EAAEH,OAAO,CAACC,GAAG,CAACC,mBAAmB,IAAI;IAC9C;EACF,CAAC;EACDC,OAAO,EAAE;IACPC,OAAO,EAAEC,iBAAS,GAAG,SAAS,GAAG,QAAQ;IACzCC,WAAW,EAAE,GAAG;IAChBC,eAAe,EAAE,EAAE;IACnBC,cAAc,EAAE,IAAI;IACpBC,mBAAmB,EAAE;EACvB;AACF,CAAC;AAAA;AAEM,IAAMC,OAAO,GAAG;EACrBC,OAAO,EAAE,SAAS;EAClBC,GAAG,EAAE,KAAK;EACVC,GAAG,EAAE,KAAK;EACVC,OAAO,EAAE,SAAS;EAClBC,MAAM,EAAE,QAAQ;EAChBC,KAAK,EAAE,OAAO;EACdC,MAAM,EAAE;AACV,CAAC;AAAC;AAEK,IAAMC,KAAK,GAAG;EACnB,WAAW,EAAER,OAAO,CAACK,MAAM;EAC3BI,KAAK,EAAET,OAAO,CAACE,GAAG;EAClBQ,OAAO,EAAEV,OAAO,CAACC,OAAO;EACxBU,GAAG,EAAEX,OAAO,CAACG,GAAG;EAChBS,OAAO,EAAEZ,OAAO,CAACI,OAAO;EACxBS,KAAK,EAAEb,OAAO,CAACM;AACjB,CAAC;AAAC"}

package/dist/index.js

@@ -1,10 +1,21 @@
 "use strict";
 
+var _typeof = require("@babel/runtime-corejs2/helpers/typeof");
+var _WeakMap = require("@babel/runtime-corejs2/core-js/weak-map");
 var _Object$defineProperty = require("@babel/runtime-corejs2/core-js/object/define-property");
+var _Object$getOwnPropertyDescriptor = require("@babel/runtime-corejs2/core-js/object/get-own-property-descriptor");
 var _interopRequireDefault = require("@babel/runtime-corejs2/helpers/interopRequireDefault");
 _Object$defineProperty(exports, "__esModule", {
   value: true
 });
+exports.CallDiagnosticUtils = exports.CALL_DIAGNOSTIC_CONFIG = void 0;
+_Object$defineProperty(exports, "NewMetrics", {
+  enumerable: true,
+  get: function get() {
+    return _newMetrics.default;
+  }
+});
+exports.Utils = void 0;
 _Object$defineProperty(exports, "config", {
   enumerable: true,
   get: function get() {
@@ -17,10 +28,25 @@ _Object$defineProperty(exports, "default", {
     return _metrics.default;
   }
 });
+_Object$defineProperty(exports, "getOSNameInternal", {
+  enumerable: true,
+  get: function get() {
+    return _metrics.getOSNameInternal;
+  }
+});
 require("@webex/internal-plugin-device");
 var _webexCore = require("@webex/webex-core");
-var _metrics = _interopRequireDefault(require("./metrics"));
+var _metrics = _interopRequireWildcard(require("./metrics"));
 var _config = _interopRequireDefault(require("./config"));
+var _newMetrics = _interopRequireDefault(require("./new-metrics"));
+var Utils = _interopRequireWildcard(require("./utils"));
+exports.Utils = Utils;
+var CALL_DIAGNOSTIC_CONFIG = _interopRequireWildcard(require("./call-diagnostic/config"));
+exports.CALL_DIAGNOSTIC_CONFIG = CALL_DIAGNOSTIC_CONFIG;
+var CallDiagnosticUtils = _interopRequireWildcard(require("./call-diagnostic/call-diagnostic-metrics.util"));
+exports.CallDiagnosticUtils = CallDiagnosticUtils;
+function _getRequireWildcardCache(nodeInterop) { if (typeof _WeakMap !== "function") return null; var cacheBabelInterop = new _WeakMap(); var cacheNodeInterop = new _WeakMap(); return (_getRequireWildcardCache = function _getRequireWildcardCache(nodeInterop) { return nodeInterop ? cacheNodeInterop : cacheBabelInterop; })(nodeInterop); }
+function _interopRequireWildcard(obj, nodeInterop) { if (!nodeInterop && obj && obj.__esModule) { return obj; } if (obj === null || _typeof(obj) !== "object" && typeof obj !== "function") { return { default: obj }; } var cache = _getRequireWildcardCache(nodeInterop); if (cache && cache.has(obj)) { return cache.get(obj); } var newObj = {}; var hasPropertyDescriptor = _Object$defineProperty && _Object$getOwnPropertyDescriptor; for (var key in obj) { if (key !== "default" && Object.prototype.hasOwnProperty.call(obj, key)) { var desc = hasPropertyDescriptor ? _Object$getOwnPropertyDescriptor(obj, key) : null; if (desc && (desc.get || desc.set)) { _Object$defineProperty(newObj, key, desc); } else { newObj[key] = obj[key]; } } } newObj.default = obj; if (cache) { cache.set(obj, newObj); } return newObj; }
 /*!
  * Copyright (c) 2015-2020 Cisco Systems, Inc. See LICENSE file.
  */
@@ -28,4 +54,7 @@ var _config = _interopRequireDefault(require("./config"));
 (0, _webexCore.registerInternalPlugin)('metrics', _metrics.default, {
   config: _config.default
 });
+(0, _webexCore.registerInternalPlugin)('newMetrics', _newMetrics.default, {
+  config: _config.default
+});
 //# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -1 +1 @@
-{"version":3,"names":["registerInternalPlugin","Metrics","config"],"sources":["index.js"],"sourcesContent":["/*!\n * Copyright (c) 2015-2020 Cisco Systems, Inc. See LICENSE file.\n */\n\nimport '@webex/internal-plugin-device';\n\nimport {registerInternalPlugin} from '@webex/webex-core';\n\nimport Metrics from './metrics';\nimport config from './config';\n\nregisterInternalPlugin('metrics', Metrics, {\n  config,\n});\n\nexport {default} from './metrics';\nexport {config};\n"],"mappings":";;;;;;;;;;;;;;;;;;;AAIA;AAEA;AAEA;AACA;AATA;AACA;AACA;;AASA,IAAAA,iCAAsB,EAAC,SAAS,EAAEC,gBAAO,EAAE;EACzCC,MAAM,EAANA;AACF,CAAC,CAAC"}
+{"version":3,"names":["registerInternalPlugin","Metrics","config","NewMetrics"],"sources":["index.ts"],"sourcesContent":["/*!\n * Copyright (c) 2015-2020 Cisco Systems, Inc. See LICENSE file.\n */\n\nimport '@webex/internal-plugin-device';\n\nimport {registerInternalPlugin} from '@webex/webex-core';\n\nimport Metrics from './metrics';\nimport config from './config';\nimport NewMetrics from './new-metrics';\nimport * as Utils from './utils';\nimport {\n  ClientEvent,\n  ClientEventLeaveReason,\n  SubmitBehavioralEvent,\n  SubmitClientEvent,\n  SubmitInternalEvent,\n  SubmitOperationalEvent,\n  SubmitMQE,\n} from './metrics.types';\nimport * as CALL_DIAGNOSTIC_CONFIG from './call-diagnostic/config';\nimport * as CallDiagnosticUtils from './call-diagnostic/call-diagnostic-metrics.util';\n\nregisterInternalPlugin('metrics', Metrics, {\n  config,\n});\n\nregisterInternalPlugin('newMetrics', NewMetrics, {\n  config,\n});\n\nexport {default, getOSNameInternal} from './metrics';\nexport {config, CALL_DIAGNOSTIC_CONFIG, NewMetrics, Utils, CallDiagnosticUtils};\nexport type {\n  ClientEvent,\n  ClientEventLeaveReason,\n  SubmitBehavioralEvent,\n  SubmitClientEvent,\n  SubmitInternalEvent,\n  SubmitMQE,\n  SubmitOperationalEvent,\n};\n"],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAIA;AAEA;AAEA;AACA;AACA;AACA;AAAiC;AAUjC;AAAmE;AACnE;AAAsF;AAAA;AAAA;AAtBtF;AACA;AACA;;AAsBA,IAAAA,iCAAsB,EAAC,SAAS,EAAEC,gBAAO,EAAE;EACzCC,MAAM,EAANA;AACF,CAAC,CAAC;AAEF,IAAAF,iCAAsB,EAAC,YAAY,EAAEG,mBAAU,EAAE;EAC/CD,MAAM,EAANA;AACF,CAAC,CAAC"}

package/dist/metrics.js

@@ -11,13 +11,13 @@ _Object$defineProperty(exports, "__esModule", {
   value: true
 });
 exports.default = void 0;
+exports.getOSNameInternal = getOSNameInternal;
 var _defineProperty2 = _interopRequireDefault(require("@babel/runtime-corejs2/helpers/defineProperty"));
 var _webexCore = require("@webex/webex-core");
 var _common = require("@webex/common");
 var _config = require("./config");
 var _batcher = _interopRequireDefault(require("./batcher"));
 var _clientMetricsBatcher = _interopRequireDefault(require("./client-metrics-batcher"));
-var _callDiagnosticEventsBatcher = _interopRequireDefault(require("./call-diagnostic-events-batcher"));
 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 _BrowserDetection = (0, _common.BrowserDetection)(),
@@ -25,6 +25,10 @@ var _BrowserDetection = (0, _common.BrowserDetection)(),
   getOSVersion = _BrowserDetection.getOSVersion,
   getBrowserName = _BrowserDetection.getBrowserName,
   getBrowserVersion = _BrowserDetection.getBrowserVersion;
+function getOSNameInternal() {
+  var _OSMap$getOSName;
+  return (_OSMap$getOSName = _config.OSMap[getOSName()]) !== null && _OSMap$getOSName !== void 0 ? _OSMap$getOSName : _config.OS_NAME.OTHERS;
+}
 function getSparkUserAgent(webex) {
   var _webex$config;
   var _ref = (_webex$config = webex === null || webex === void 0 ? void 0 : webex.config) !== null && _webex$config !== void 0 ? _webex$config : {},
@@ -43,8 +47,7 @@ function getSparkUserAgent(webex) {
 var Metrics = _webexCore.WebexPlugin.extend({
   children: {
     batcher: _batcher.default,
-    clientMetricsBatcher: _clientMetricsBatcher.default,
-    callDiagnosticEventsBatcher: _callDiagnosticEventsBatcher.default
+    clientMetricsBatcher: _clientMetricsBatcher.default
   },
   namespace: 'Metrics',
   submit: function submit(key, value) {
@@ -53,15 +56,12 @@ var Metrics = _webexCore.WebexPlugin.extend({
     }, value));
   },
   /**
-   * This corresponds to #sendSemiStructured() in the deprecated metrics handler
+   * Returns the payload for submitting client metrics.
    * @param {string} eventName
-   * @param {Object} props
-   * @param {string} preLoginId
-   * @returns {Object} HttpResponse object
+   * @param {any} props
+   * @returns {any} - the payload
    */
-  submitClientMetrics: function submitClientMetrics(eventName) {
-    var props = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : {};
-    var preLoginId = arguments.length > 2 ? arguments[2] : undefined;
+  getClientMetricsPayload: function getClientMetricsPayload(eventName, props) {
     if (!eventName) {
       throw Error('Missing behavioral metric name. Please provide one');
     }
@@ -70,25 +70,19 @@ var Metrics = _webexCore.WebexPlugin.extend({
     };
     payload.tags = _objectSpread(_objectSpread({}, props.tags), {}, {
       browser: getBrowserName(),
-      os: getOSName(),
+      os: getOSNameInternal(),
       // Node does not like this so we need to check if it exists or not
       // eslint-disable-next-line no-undef
-      domain: typeof window !== 'undefined' ? window.location.hostname || 'non-browser' : 'non-browser',
-      // Check what else we could measure
-      client_id: this.webex.credentials.config.client_id,
-      user_id: this.webex.internal.device.userId
+      domain: typeof window !== 'undefined' ? window.location.hostname || 'non-browser' : 'non-browser' // Check what else we could measure
     });
-    try {
-      payload.tags.org_id = this.webex.credentials.getOrgId();
-    } catch (_unused) {
-      this.logger.info('metrics: unable to get orgId');
-    }
+
     payload.fields = _objectSpread(_objectSpread({}, props.fields), {}, {
       browser_version: getBrowserVersion(),
       os_version: getOSVersion(),
       sdk_version: this.webex.version,
       platform: 'Web',
-      spark_user_agent: getSparkUserAgent(this.webex)
+      spark_user_agent: getSparkUserAgent(this.webex),
+      client_id: this.webex.credentials.config.client_id
     });
     payload.type = props.type || this.webex.config.metrics.type;
     payload.context = _objectSpread(_objectSpread({}, props.context), {}, {
@@ -97,7 +91,7 @@ var Metrics = _webexCore.WebexPlugin.extend({
       },
       locale: 'en-US',
       os: {
-        name: getOSName(),
+        name: getOSNameInternal(),
         version: getOSVersion()
       }
     });
@@ -108,6 +102,19 @@ var Metrics = _webexCore.WebexPlugin.extend({
     // Mocking the time in tests when running in node
     // is impossible so unable to use Date.now()
     payload.timestamp = new Date().valueOf();
+    return payload;
+  },
+  /**
+   * This corresponds to #sendSemiStructured() in the deprecated metrics handler
+   * @param {string} eventName
+   * @param {Object} props
+   * @param {string} preLoginId
+   * @returns {Object} HttpResponse object
+   */
+  submitClientMetrics: function submitClientMetrics(eventName) {
+    var props = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : {};
+    var preLoginId = arguments.length > 2 ? arguments[2] : undefined;
+    var payload = this.getClientMetricsPayload(eventName, props);
     if (preLoginId) {
       var _payload = {
         metrics: [payload]
@@ -154,14 +161,7 @@ var Metrics = _webexCore.WebexPlugin.extend({
       });
     });
   },
-  submitCallDiagnosticEvents: function submitCallDiagnosticEvents(payload) {
-    var event = {
-      type: 'diagnostic-event',
-      eventPayload: payload
-    };
-    return this.callDiagnosticEventsBatcher.request(event);
-  },
-  version: "3.0.0-beta.27"
+  version: "3.0.0-beta.270"
 });
 var _default = Metrics;
 exports.default = _default;

package/dist/metrics.js.map

@@ -1 +1 @@
-{"version":3,"names":["BrowserDetection","getOSName","getOSVersion","getBrowserName","getBrowserVersion","getSparkUserAgent","webex","config","appName","appVersion","appPlatform","sparkUserAgent","CLIENT_NAME","Metrics","WebexPlugin","extend","children","batcher","Batcher","clientMetricsBatcher","ClientMetricsBatcher","callDiagnosticEventsBatcher","CallDiagnosticEventsBatcher","namespace","submit","key","value","request","submitClientMetrics","eventName","props","preLoginId","Error","payload","metricName","tags","browser","os","domain","window","location","hostname","client_id","credentials","user_id","internal","device","userId","org_id","getOrgId","logger","info","fields","browser_version","os_version","sdk_version","version","platform","spark_user_agent","type","metrics","context","app","locale","name","eventPayload","timestamp","Date","valueOf","_payload","postPreLoginMetric","aliasUser","method","api","resource","headers","body","qs","alias","getClientToken","then","token","authorization","toString","submitCallDiagnosticEvents","event"],"sources":["metrics.js"],"sourcesContent":["/* eslint-disable default-param-last */\n\n/*!\n * Copyright (c) 2015-2020 Cisco Systems, Inc. See LICENSE file.\n */\n\nimport {WebexPlugin} from '@webex/webex-core';\nimport {BrowserDetection} from '@webex/common';\n\nimport {CLIENT_NAME} from './config';\nimport Batcher from './batcher';\nimport ClientMetricsBatcher from './client-metrics-batcher';\nimport CallDiagnosticEventsBatcher from './call-diagnostic-events-batcher';\n\nconst {getOSName, getOSVersion, getBrowserName, getBrowserVersion} = BrowserDetection();\n\nfunction getSparkUserAgent(webex) {\n  const {appName, appVersion, appPlatform} = webex?.config ?? {};\n\n  let sparkUserAgent = CLIENT_NAME;\n\n  if (appName) {\n    sparkUserAgent += ` ${appName}/${appVersion ?? '0.0'}`;\n  }\n\n  if (appPlatform) {\n    sparkUserAgent += ` ${appPlatform}`;\n  }\n\n  return sparkUserAgent;\n}\n\nconst Metrics = WebexPlugin.extend({\n  children: {\n    batcher: Batcher,\n    clientMetricsBatcher: ClientMetricsBatcher,\n    callDiagnosticEventsBatcher: CallDiagnosticEventsBatcher,\n  },\n\n  namespace: 'Metrics',\n\n  submit(key, value) {\n    return this.batcher.request({key, ...value});\n  },\n\n  /**\n   * This corresponds to #sendSemiStructured() in the deprecated metrics handler\n   * @param {string} eventName\n   * @param {Object} props\n   * @param {string} preLoginId\n   * @returns {Object} HttpResponse object\n   */\n  submitClientMetrics(eventName, props = {}, preLoginId) {\n    if (!eventName) {\n      throw Error('Missing behavioral metric name. Please provide one');\n    }\n    const payload = {metricName: eventName};\n\n    payload.tags = {\n      ...props.tags,\n      browser: getBrowserName(),\n      os: getOSName(),\n\n      // Node does not like this so we need to check if it exists or not\n      // eslint-disable-next-line no-undef\n      domain:\n        typeof window !== 'undefined' ? window.location.hostname || 'non-browser' : 'non-browser', // Check what else we could measure\n      client_id: this.webex.credentials.config.client_id,\n      user_id: this.webex.internal.device.userId,\n    };\n\n    try {\n      payload.tags.org_id = this.webex.credentials.getOrgId();\n    } catch {\n      this.logger.info('metrics: unable to get orgId');\n    }\n\n    payload.fields = {\n      ...props.fields,\n      browser_version: getBrowserVersion(),\n      os_version: getOSVersion(),\n      sdk_version: this.webex.version,\n      platform: 'Web',\n      spark_user_agent: getSparkUserAgent(this.webex),\n    };\n\n    payload.type = props.type || this.webex.config.metrics.type;\n\n    payload.context = {\n      ...props.context,\n      app: {\n        version: this.webex.version,\n      },\n      locale: 'en-US',\n      os: {\n        name: getOSName(),\n        version: getOSVersion(),\n      },\n    };\n\n    if (props.eventPayload) {\n      payload.eventPayload = props.eventPayload;\n    }\n\n    // Mocking the time in tests when running in node\n    // is impossible so unable to use Date.now()\n    payload.timestamp = new Date().valueOf();\n\n    if (preLoginId) {\n      const _payload = {\n        metrics: [payload],\n      };\n\n      // Do not batch these because pre-login events occur during onboarding, so we will be partially blind\n      // to users' progress through the reg flow if we wait to persist pre-login metrics for people who drop off because\n      // their metrics will not post from a queue flush in time\n      return this.postPreLoginMetric(_payload, preLoginId);\n    }\n\n    return this.clientMetricsBatcher.request(payload);\n  },\n\n  /**\n   * Issue request to alias a user's pre-login ID with their CI UUID\n   * @param {string} preLoginId\n   * @returns {Object} HttpResponse object\n   */\n  aliasUser(preLoginId) {\n    return this.request({\n      method: 'POST',\n      api: 'metrics',\n      resource: 'clientmetrics',\n      headers: {\n        'x-prelogin-userid': preLoginId,\n      },\n      body: {},\n      qs: {\n        alias: true,\n      },\n    });\n  },\n\n  postPreLoginMetric(payload, preLoginId) {\n    return this.webex.credentials.getClientToken().then((token) =>\n      this.request({\n        method: 'POST',\n        api: 'metrics',\n        resource: 'clientmetrics-prelogin',\n        headers: {\n          authorization: token.toString(),\n          'x-prelogin-userid': preLoginId,\n        },\n        body: payload,\n      })\n    );\n  },\n\n  submitCallDiagnosticEvents(payload) {\n    const event = {\n      type: 'diagnostic-event',\n      eventPayload: payload,\n    };\n\n    return this.callDiagnosticEventsBatcher.request(event);\n  },\n});\n\nexport default Metrics;\n"],"mappings":";;;;;;;;;;;;;;AAMA;AACA;AAEA;AACA;AACA;AACA;AAA2E;AAAA;AAE3E,wBAAqE,IAAAA,wBAAgB,GAAE;EAAhFC,SAAS,qBAATA,SAAS;EAAEC,YAAY,qBAAZA,YAAY;EAAEC,cAAc,qBAAdA,cAAc;EAAEC,iBAAiB,qBAAjBA,iBAAiB;AAEjE,SAASC,iBAAiB,CAACC,KAAK,EAAE;EAAA;EAChC,4BAA2CA,KAAK,aAALA,KAAK,uBAALA,KAAK,CAAEC,MAAM,yDAAI,CAAC,CAAC;IAAvDC,OAAO,QAAPA,OAAO;IAAEC,UAAU,QAAVA,UAAU;IAAEC,WAAW,QAAXA,WAAW;EAEvC,IAAIC,cAAc,GAAGC,mBAAW;EAEhC,IAAIJ,OAAO,EAAE;IACXG,cAAc,eAAQH,OAAO,cAAIC,UAAU,aAAVA,UAAU,cAAVA,UAAU,GAAI,KAAK,CAAE;EACxD;EAEA,IAAIC,WAAW,EAAE;IACfC,cAAc,eAAQD,WAAW,CAAE;EACrC;EAEA,OAAOC,cAAc;AACvB;AAEA,IAAME,OAAO,GAAGC,sBAAW,CAACC,MAAM,CAAC;EACjCC,QAAQ,EAAE;IACRC,OAAO,EAAEC,gBAAO;IAChBC,oBAAoB,EAAEC,6BAAoB;IAC1CC,2BAA2B,EAAEC;EAC/B,CAAC;EAEDC,SAAS,EAAE,SAAS;EAEpBC,MAAM,kBAACC,GAAG,EAAEC,KAAK,EAAE;IACjB,OAAO,IAAI,CAACT,OAAO,CAACU,OAAO;MAAEF,GAAG,EAAHA;IAAG,GAAKC,KAAK,EAAE;EAC9C,CAAC;EAED;AACF;AACA;AACA;AACA;AACA;AACA;EACEE,mBAAmB,+BAACC,SAAS,EAA0B;IAAA,IAAxBC,KAAK,uEAAG,CAAC,CAAC;IAAA,IAAEC,UAAU;IACnD,IAAI,CAACF,SAAS,EAAE;MACd,MAAMG,KAAK,CAAC,oDAAoD,CAAC;IACnE;IACA,IAAMC,OAAO,GAAG;MAACC,UAAU,EAAEL;IAAS,CAAC;IAEvCI,OAAO,CAACE,IAAI,mCACPL,KAAK,CAACK,IAAI;MACbC,OAAO,EAAEjC,cAAc,EAAE;MACzBkC,EAAE,EAAEpC,SAAS,EAAE;MAEf;MACA;MACAqC,MAAM,EACJ,OAAOC,MAAM,KAAK,WAAW,GAAGA,MAAM,CAACC,QAAQ,CAACC,QAAQ,IAAI,aAAa,GAAG,aAAa;MAAE;MAC7FC,SAAS,EAAE,IAAI,CAACpC,KAAK,CAACqC,WAAW,CAACpC,MAAM,CAACmC,SAAS;MAClDE,OAAO,EAAE,IAAI,CAACtC,KAAK,CAACuC,QAAQ,CAACC,MAAM,CAACC;IAAM,EAC3C;IAED,IAAI;MACFd,OAAO,CAACE,IAAI,CAACa,MAAM,GAAG,IAAI,CAAC1C,KAAK,CAACqC,WAAW,CAACM,QAAQ,EAAE;IACzD,CAAC,CAAC,gBAAM;MACN,IAAI,CAACC,MAAM,CAACC,IAAI,CAAC,8BAA8B,CAAC;IAClD;IAEAlB,OAAO,CAACmB,MAAM,mCACTtB,KAAK,CAACsB,MAAM;MACfC,eAAe,EAAEjD,iBAAiB,EAAE;MACpCkD,UAAU,EAAEpD,YAAY,EAAE;MAC1BqD,WAAW,EAAE,IAAI,CAACjD,KAAK,CAACkD,OAAO;MAC/BC,QAAQ,EAAE,KAAK;MACfC,gBAAgB,EAAErD,iBAAiB,CAAC,IAAI,CAACC,KAAK;IAAC,EAChD;IAED2B,OAAO,CAAC0B,IAAI,GAAG7B,KAAK,CAAC6B,IAAI,IAAI,IAAI,CAACrD,KAAK,CAACC,MAAM,CAACqD,OAAO,CAACD,IAAI;IAE3D1B,OAAO,CAAC4B,OAAO,mCACV/B,KAAK,CAAC+B,OAAO;MAChBC,GAAG,EAAE;QACHN,OAAO,EAAE,IAAI,CAAClD,KAAK,CAACkD;MACtB,CAAC;MACDO,MAAM,EAAE,OAAO;MACf1B,EAAE,EAAE;QACF2B,IAAI,EAAE/D,SAAS,EAAE;QACjBuD,OAAO,EAAEtD,YAAY;MACvB;IAAC,EACF;IAED,IAAI4B,KAAK,CAACmC,YAAY,EAAE;MACtBhC,OAAO,CAACgC,YAAY,GAAGnC,KAAK,CAACmC,YAAY;IAC3C;;IAEA;IACA;IACAhC,OAAO,CAACiC,SAAS,GAAG,IAAIC,IAAI,EAAE,CAACC,OAAO,EAAE;IAExC,IAAIrC,UAAU,EAAE;MACd,IAAMsC,QAAQ,GAAG;QACfT,OAAO,EAAE,CAAC3B,OAAO;MACnB,CAAC;;MAED;MACA;MACA;MACA,OAAO,IAAI,CAACqC,kBAAkB,CAACD,QAAQ,EAAEtC,UAAU,CAAC;IACtD;IAEA,OAAO,IAAI,CAACZ,oBAAoB,CAACQ,OAAO,CAACM,OAAO,CAAC;EACnD,CAAC;EAED;AACF;AACA;AACA;AACA;EACEsC,SAAS,qBAACxC,UAAU,EAAE;IACpB,OAAO,IAAI,CAACJ,OAAO,CAAC;MAClB6C,MAAM,EAAE,MAAM;MACdC,GAAG,EAAE,SAAS;MACdC,QAAQ,EAAE,eAAe;MACzBC,OAAO,EAAE;QACP,mBAAmB,EAAE5C;MACvB,CAAC;MACD6C,IAAI,EAAE,CAAC,CAAC;MACRC,EAAE,EAAE;QACFC,KAAK,EAAE;MACT;IACF,CAAC,CAAC;EACJ,CAAC;EAEDR,kBAAkB,8BAACrC,OAAO,EAAEF,UAAU,EAAE;IAAA;IACtC,OAAO,IAAI,CAACzB,KAAK,CAACqC,WAAW,CAACoC,cAAc,EAAE,CAACC,IAAI,CAAC,UAACC,KAAK;MAAA,OACxD,KAAI,CAACtD,OAAO,CAAC;QACX6C,MAAM,EAAE,MAAM;QACdC,GAAG,EAAE,SAAS;QACdC,QAAQ,EAAE,wBAAwB;QAClCC,OAAO,EAAE;UACPO,aAAa,EAAED,KAAK,CAACE,QAAQ,EAAE;UAC/B,mBAAmB,EAAEpD;QACvB,CAAC;QACD6C,IAAI,EAAE3C;MACR,CAAC,CAAC;IAAA,EACH;EACH,CAAC;EAEDmD,0BAA0B,sCAACnD,OAAO,EAAE;IAClC,IAAMoD,KAAK,GAAG;MACZ1B,IAAI,EAAE,kBAAkB;MACxBM,YAAY,EAAEhC;IAChB,CAAC;IAED,OAAO,IAAI,CAACZ,2BAA2B,CAACM,OAAO,CAAC0D,KAAK,CAAC;EACxD,CAAC;EAAA;AACH,CAAC,CAAC;AAAC,eAEYxE,OAAO;AAAA"}
+{"version":3,"names":["BrowserDetection","getOSName","getOSVersion","getBrowserName","getBrowserVersion","getOSNameInternal","OSMap","OS_NAME","OTHERS","getSparkUserAgent","webex","config","appName","appVersion","appPlatform","sparkUserAgent","CLIENT_NAME","Metrics","WebexPlugin","extend","children","batcher","Batcher","clientMetricsBatcher","ClientMetricsBatcher","namespace","submit","key","value","request","getClientMetricsPayload","eventName","props","Error","payload","metricName","tags","browser","os","domain","window","location","hostname","fields","browser_version","os_version","sdk_version","version","platform","spark_user_agent","client_id","credentials","type","metrics","context","app","locale","name","eventPayload","timestamp","Date","valueOf","submitClientMetrics","preLoginId","_payload","postPreLoginMetric","aliasUser","method","api","resource","headers","body","qs","alias","getClientToken","then","token","authorization","toString"],"sources":["metrics.js"],"sourcesContent":["/* eslint-disable default-param-last */\n\n/*!\n * Copyright (c) 2015-2020 Cisco Systems, Inc. See LICENSE file.\n */\n\nimport {WebexPlugin} from '@webex/webex-core';\nimport {BrowserDetection} from '@webex/common';\nimport {OS_NAME, OSMap, CLIENT_NAME} from './config';\n\nimport Batcher from './batcher';\nimport ClientMetricsBatcher from './client-metrics-batcher';\n\nconst {getOSName, getOSVersion, getBrowserName, getBrowserVersion} = BrowserDetection();\n\nexport function getOSNameInternal() {\n  return OSMap[getOSName()] ?? OS_NAME.OTHERS;\n}\n\nfunction getSparkUserAgent(webex) {\n  const {appName, appVersion, appPlatform} = webex?.config ?? {};\n\n  let sparkUserAgent = CLIENT_NAME;\n\n  if (appName) {\n    sparkUserAgent += ` ${appName}/${appVersion ?? '0.0'}`;\n  }\n\n  if (appPlatform) {\n    sparkUserAgent += ` ${appPlatform}`;\n  }\n\n  return sparkUserAgent;\n}\n\nconst Metrics = WebexPlugin.extend({\n  children: {\n    batcher: Batcher,\n    clientMetricsBatcher: ClientMetricsBatcher,\n  },\n\n  namespace: 'Metrics',\n\n  submit(key, value) {\n    return this.batcher.request({key, ...value});\n  },\n\n  /**\n   * Returns the payload for submitting client metrics.\n   * @param {string} eventName\n   * @param {any} props\n   * @returns {any} - the payload\n   */\n  getClientMetricsPayload(eventName, props) {\n    if (!eventName) {\n      throw Error('Missing behavioral metric name. Please provide one');\n    }\n    const payload = {metricName: eventName};\n\n    payload.tags = {\n      ...props.tags,\n      browser: getBrowserName(),\n      os: getOSNameInternal(),\n\n      // Node does not like this so we need to check if it exists or not\n      // eslint-disable-next-line no-undef\n      domain:\n        typeof window !== 'undefined' ? window.location.hostname || 'non-browser' : 'non-browser', // Check what else we could measure\n    };\n\n    payload.fields = {\n      ...props.fields,\n      browser_version: getBrowserVersion(),\n      os_version: getOSVersion(),\n      sdk_version: this.webex.version,\n      platform: 'Web',\n      spark_user_agent: getSparkUserAgent(this.webex),\n      client_id: this.webex.credentials.config.client_id,\n    };\n\n    payload.type = props.type || this.webex.config.metrics.type;\n\n    payload.context = {\n      ...props.context,\n      app: {\n        version: this.webex.version,\n      },\n      locale: 'en-US',\n      os: {\n        name: getOSNameInternal(),\n        version: getOSVersion(),\n      },\n    };\n\n    if (props.eventPayload) {\n      payload.eventPayload = props.eventPayload;\n    }\n\n    // Mocking the time in tests when running in node\n    // is impossible so unable to use Date.now()\n    payload.timestamp = new Date().valueOf();\n\n    return payload;\n  },\n\n  /**\n   * This corresponds to #sendSemiStructured() in the deprecated metrics handler\n   * @param {string} eventName\n   * @param {Object} props\n   * @param {string} preLoginId\n   * @returns {Object} HttpResponse object\n   */\n  submitClientMetrics(eventName, props = {}, preLoginId) {\n    const payload = this.getClientMetricsPayload(eventName, props);\n\n    if (preLoginId) {\n      const _payload = {\n        metrics: [payload],\n      };\n\n      // Do not batch these because pre-login events occur during onboarding, so we will be partially blind\n      // to users' progress through the reg flow if we wait to persist pre-login metrics for people who drop off because\n      // their metrics will not post from a queue flush in time\n      return this.postPreLoginMetric(_payload, preLoginId);\n    }\n\n    return this.clientMetricsBatcher.request(payload);\n  },\n\n  /**\n   * Issue request to alias a user's pre-login ID with their CI UUID\n   * @param {string} preLoginId\n   * @returns {Object} HttpResponse object\n   */\n  aliasUser(preLoginId) {\n    return this.request({\n      method: 'POST',\n      api: 'metrics',\n      resource: 'clientmetrics',\n      headers: {\n        'x-prelogin-userid': preLoginId,\n      },\n      body: {},\n      qs: {\n        alias: true,\n      },\n    });\n  },\n\n  postPreLoginMetric(payload, preLoginId) {\n    return this.webex.credentials.getClientToken().then((token) =>\n      this.request({\n        method: 'POST',\n        api: 'metrics',\n        resource: 'clientmetrics-prelogin',\n        headers: {\n          authorization: token.toString(),\n          'x-prelogin-userid': preLoginId,\n        },\n        body: payload,\n      })\n    );\n  },\n});\n\nexport default Metrics;\n"],"mappings":";;;;;;;;;;;;;;;AAMA;AACA;AACA;AAEA;AACA;AAA4D;AAAA;AAE5D,wBAAqE,IAAAA,wBAAgB,GAAE;EAAhFC,SAAS,qBAATA,SAAS;EAAEC,YAAY,qBAAZA,YAAY;EAAEC,cAAc,qBAAdA,cAAc;EAAEC,iBAAiB,qBAAjBA,iBAAiB;AAE1D,SAASC,iBAAiB,GAAG;EAAA;EAClC,2BAAOC,aAAK,CAACL,SAAS,EAAE,CAAC,+DAAIM,eAAO,CAACC,MAAM;AAC7C;AAEA,SAASC,iBAAiB,CAACC,KAAK,EAAE;EAAA;EAChC,4BAA2CA,KAAK,aAALA,KAAK,uBAALA,KAAK,CAAEC,MAAM,yDAAI,CAAC,CAAC;IAAvDC,OAAO,QAAPA,OAAO;IAAEC,UAAU,QAAVA,UAAU;IAAEC,WAAW,QAAXA,WAAW;EAEvC,IAAIC,cAAc,GAAGC,mBAAW;EAEhC,IAAIJ,OAAO,EAAE;IACXG,cAAc,eAAQH,OAAO,cAAIC,UAAU,aAAVA,UAAU,cAAVA,UAAU,GAAI,KAAK,CAAE;EACxD;EAEA,IAAIC,WAAW,EAAE;IACfC,cAAc,eAAQD,WAAW,CAAE;EACrC;EAEA,OAAOC,cAAc;AACvB;AAEA,IAAME,OAAO,GAAGC,sBAAW,CAACC,MAAM,CAAC;EACjCC,QAAQ,EAAE;IACRC,OAAO,EAAEC,gBAAO;IAChBC,oBAAoB,EAAEC;EACxB,CAAC;EAEDC,SAAS,EAAE,SAAS;EAEpBC,MAAM,kBAACC,GAAG,EAAEC,KAAK,EAAE;IACjB,OAAO,IAAI,CAACP,OAAO,CAACQ,OAAO;MAAEF,GAAG,EAAHA;IAAG,GAAKC,KAAK,EAAE;EAC9C,CAAC;EAED;AACF;AACA;AACA;AACA;AACA;EACEE,uBAAuB,mCAACC,SAAS,EAAEC,KAAK,EAAE;IACxC,IAAI,CAACD,SAAS,EAAE;MACd,MAAME,KAAK,CAAC,oDAAoD,CAAC;IACnE;IACA,IAAMC,OAAO,GAAG;MAACC,UAAU,EAAEJ;IAAS,CAAC;IAEvCG,OAAO,CAACE,IAAI,mCACPJ,KAAK,CAACI,IAAI;MACbC,OAAO,EAAElC,cAAc,EAAE;MACzBmC,EAAE,EAAEjC,iBAAiB,EAAE;MAEvB;MACA;MACAkC,MAAM,EACJ,OAAOC,MAAM,KAAK,WAAW,GAAGA,MAAM,CAACC,QAAQ,CAACC,QAAQ,IAAI,aAAa,GAAG,aAAa,CAAE;IAAA,EAC9F;;IAEDR,OAAO,CAACS,MAAM,mCACTX,KAAK,CAACW,MAAM;MACfC,eAAe,EAAExC,iBAAiB,EAAE;MACpCyC,UAAU,EAAE3C,YAAY,EAAE;MAC1B4C,WAAW,EAAE,IAAI,CAACpC,KAAK,CAACqC,OAAO;MAC/BC,QAAQ,EAAE,KAAK;MACfC,gBAAgB,EAAExC,iBAAiB,CAAC,IAAI,CAACC,KAAK,CAAC;MAC/CwC,SAAS,EAAE,IAAI,CAACxC,KAAK,CAACyC,WAAW,CAACxC,MAAM,CAACuC;IAAS,EACnD;IAEDhB,OAAO,CAACkB,IAAI,GAAGpB,KAAK,CAACoB,IAAI,IAAI,IAAI,CAAC1C,KAAK,CAACC,MAAM,CAAC0C,OAAO,CAACD,IAAI;IAE3DlB,OAAO,CAACoB,OAAO,mCACVtB,KAAK,CAACsB,OAAO;MAChBC,GAAG,EAAE;QACHR,OAAO,EAAE,IAAI,CAACrC,KAAK,CAACqC;MACtB,CAAC;MACDS,MAAM,EAAE,OAAO;MACflB,EAAE,EAAE;QACFmB,IAAI,EAAEpD,iBAAiB,EAAE;QACzB0C,OAAO,EAAE7C,YAAY;MACvB;IAAC,EACF;IAED,IAAI8B,KAAK,CAAC0B,YAAY,EAAE;MACtBxB,OAAO,CAACwB,YAAY,GAAG1B,KAAK,CAAC0B,YAAY;IAC3C;;IAEA;IACA;IACAxB,OAAO,CAACyB,SAAS,GAAG,IAAIC,IAAI,EAAE,CAACC,OAAO,EAAE;IAExC,OAAO3B,OAAO;EAChB,CAAC;EAED;AACF;AACA;AACA;AACA;AACA;AACA;EACE4B,mBAAmB,+BAAC/B,SAAS,EAA0B;IAAA,IAAxBC,KAAK,uEAAG,CAAC,CAAC;IAAA,IAAE+B,UAAU;IACnD,IAAM7B,OAAO,GAAG,IAAI,CAACJ,uBAAuB,CAACC,SAAS,EAAEC,KAAK,CAAC;IAE9D,IAAI+B,UAAU,EAAE;MACd,IAAMC,QAAQ,GAAG;QACfX,OAAO,EAAE,CAACnB,OAAO;MACnB,CAAC;;MAED;MACA;MACA;MACA,OAAO,IAAI,CAAC+B,kBAAkB,CAACD,QAAQ,EAAED,UAAU,CAAC;IACtD;IAEA,OAAO,IAAI,CAACxC,oBAAoB,CAACM,OAAO,CAACK,OAAO,CAAC;EACnD,CAAC;EAED;AACF;AACA;AACA;AACA;EACEgC,SAAS,qBAACH,UAAU,EAAE;IACpB,OAAO,IAAI,CAAClC,OAAO,CAAC;MAClBsC,MAAM,EAAE,MAAM;MACdC,GAAG,EAAE,SAAS;MACdC,QAAQ,EAAE,eAAe;MACzBC,OAAO,EAAE;QACP,mBAAmB,EAAEP;MACvB,CAAC;MACDQ,IAAI,EAAE,CAAC,CAAC;MACRC,EAAE,EAAE;QACFC,KAAK,EAAE;MACT;IACF,CAAC,CAAC;EACJ,CAAC;EAEDR,kBAAkB,8BAAC/B,OAAO,EAAE6B,UAAU,EAAE;IAAA;IACtC,OAAO,IAAI,CAACrD,KAAK,CAACyC,WAAW,CAACuB,cAAc,EAAE,CAACC,IAAI,CAAC,UAACC,KAAK;MAAA,OACxD,KAAI,CAAC/C,OAAO,CAAC;QACXsC,MAAM,EAAE,MAAM;QACdC,GAAG,EAAE,SAAS;QACdC,QAAQ,EAAE,wBAAwB;QAClCC,OAAO,EAAE;UACPO,aAAa,EAAED,KAAK,CAACE,QAAQ,EAAE;UAC/B,mBAAmB,EAAEf;QACvB,CAAC;QACDQ,IAAI,EAAErC;MACR,CAAC,CAAC;IAAA,EACH;EACH,CAAC;EAAA;AACH,CAAC,CAAC;AAAC,eAEYjB,OAAO;AAAA"}

package/dist/metrics.types.js

@@ -0,0 +1,7 @@
+"use strict";
+
+var _Object$defineProperty = require("@babel/runtime-corejs2/core-js/object/define-property");
+_Object$defineProperty(exports, "__esModule", {
+  value: true
+});
+//# sourceMappingURL=metrics.types.js.map

package/dist/metrics.types.js.map

@@ -0,0 +1 @@
+{"version":3,"names":[],"sources":["metrics.types.ts"],"sourcesContent":["import {\n  ClientEvent as RawClientEvent,\n  Event as RawEvent,\n  MediaQualityEvent as RawMediaQualityEvent,\n} from '@webex/event-dictionary-ts';\n\nexport type Event = Omit<RawEvent, 'event'> & {event: RawClientEvent | RawMediaQualityEvent};\n\nexport type ClientEventError = NonNullable<RawClientEvent['errors']>[0];\n\nexport type EnvironmentType = NonNullable<RawEvent['origin']['environment']>;\n\nexport type NewEnvironmentType = NonNullable<RawEvent['origin']['newEnvironment']>;\n\nexport type ClientLaunchMethodType = NonNullable<\n  RawEvent['origin']['clientInfo']\n>['clientLaunchMethod'];\n\nexport type SubmitClientEventOptions = {\n  meetingId?: string;\n  mediaConnections?: any[];\n  rawError?: any;\n  correlationId?: string;\n  preLoginId?: string;\n  environment?: EnvironmentType;\n  newEnvironmentType?: NewEnvironmentType;\n  clientLaunchMethod?: ClientLaunchMethodType;\n};\n\nexport type SubmitMQEOptions = {\n  meetingId: string;\n  mediaConnections?: any[];\n  networkType?: Event['origin']['networkType'];\n};\n\nexport type InternalEvent = {\n  name:\n    | 'internal.client.meetinginfo.request'\n    | 'internal.client.meetinginfo.response'\n    | 'internal.reset.join.latencies'\n    | 'internal.client.meeting.click.joinbutton'\n    | 'internal.host.meeting.participant.admitted'\n    | 'internal.client.meeting.interstitial-window.showed'\n    | 'internal.client.interstitial-window.click.joinbutton';\n  payload?: never;\n  options?: never;\n};\n\nexport interface ClientEvent {\n  name: RawClientEvent['name'];\n  payload?: RawClientEvent;\n  options?: SubmitClientEventOptions;\n}\n\nexport interface BehavioralEvent {\n  // TODO: not implemented\n  name: 'host.meeting.participant.admitted' | 'sdk.media-flow.started';\n  payload?: never;\n  options?: never;\n}\n\nexport interface OperationalEvent {\n  // TODO: not implemented\n  name: never;\n  payload?: never;\n  options?: never;\n}\n\nexport interface FeatureEvent {\n  // TODO: not implemented\n  name: never;\n  payload?: never;\n  options?: never;\n}\n\nexport interface MediaQualityEvent {\n  name: RawMediaQualityEvent['name'];\n  payload?: RawMediaQualityEvent;\n  options: SubmitMQEOptions;\n}\n\nexport type RecursivePartial<T> = {\n  [P in keyof T]?: T[P] extends (infer U)[]\n    ? RecursivePartial<U>[]\n    : T[P] extends object\n    ? RecursivePartial<T[P]>\n    : T[P];\n};\n\nexport type MetricEventNames =\n  | InternalEvent['name']\n  | ClientEvent['name']\n  | BehavioralEvent['name']\n  | OperationalEvent['name']\n  | FeatureEvent['name']\n  | MediaQualityEvent['name'];\n\nexport type ClientInfo = NonNullable<RawEvent['origin']['clientInfo']>;\nexport type ClientType = NonNullable<RawEvent['origin']['clientInfo']>['clientType'];\nexport type SubClientType = NonNullable<RawEvent['origin']['clientInfo']>['subClientType'];\nexport type NetworkType = NonNullable<RawEvent['origin']>['networkType'];\n\nexport type ClientEventPayload = RecursivePartial<ClientEvent['payload']>;\nexport type ClientEventLeaveReason = ClientEvent['payload']['leaveReason'];\nexport type ClientEventPayloadError = ClientEvent['payload']['errors'];\n\nexport type MediaQualityEventAudioSetupDelayPayload = NonNullable<\n  MediaQualityEvent['payload']\n>['audioSetupDelay'];\nexport type MediaQualityEventVideoSetupDelayPayload = NonNullable<\n  MediaQualityEvent['payload']\n>['videoSetupDelay'];\n\nexport type SubmitMQEPayload = RecursivePartial<MediaQualityEvent['payload']> & {\n  intervals: NonNullable<MediaQualityEvent['payload']>['intervals'];\n};\n\nexport type SubmitInternalEvent = (args: {\n  name: InternalEvent['name'];\n  payload?: RecursivePartial<InternalEvent['payload']>;\n  options?: any;\n}) => void;\n\nexport type SubmitBehavioralEvent = (args: {\n  name: BehavioralEvent['name'];\n  payload?: RecursivePartial<BehavioralEvent['payload']>;\n  options?: any;\n}) => void;\n\nexport type SubmitClientEvent = (args: {\n  name: ClientEvent['name'];\n  payload?: RecursivePartial<ClientEvent['payload']>;\n  options?: SubmitClientEventOptions;\n}) => Promise<any>;\n\nexport type SubmitOperationalEvent = (args: {\n  name: OperationalEvent['name'];\n  payload?: RecursivePartial<OperationalEvent['payload']>;\n  options?: any;\n}) => void;\n\nexport type SubmitMQE = (args: {\n  name: MediaQualityEvent['name'];\n  payload: SubmitMQEPayload;\n  options: any;\n}) => void;\n\nexport type BuildClientEventFetchRequestOptions = (args: {\n  name: ClientEvent['name'];\n  payload?: RecursivePartial<ClientEvent['payload']>;\n  options?: SubmitClientEventOptions;\n}) => Promise<any>;\n"],"mappings":""}

package/dist/new-metrics.js

@@ -0,0 +1,333 @@
+"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 _regenerator = _interopRequireDefault(require("@babel/runtime-corejs2/regenerator"));
+var _promise = _interopRequireDefault(require("@babel/runtime-corejs2/core-js/promise"));
+var _asyncToGenerator2 = _interopRequireDefault(require("@babel/runtime-corejs2/helpers/asyncToGenerator"));
+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"));
+var _callDiagnosticMetrics2 = require("./call-diagnostic/call-diagnostic-metrics.util");
+var _utils = require("./utils");
+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.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
+        });
+        // @ts-ignore
+        _this2.callDiagnosticLatencies = new _callDiagnosticMetricsLatencies.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({
+          key: name
+        });
+      }
+    }
+
+    /**
+     * Behavioral event
+     * @param args
+     */
+  }, {
+    key: "submitBehavioralEvent",
+    value: function submitBehavioralEvent(_ref2) {
+      var name = _ref2.name,
+        payload = _ref2.payload,
+        options = _ref2.options;
+      this.callDiagnosticLatencies.saveTimestamp({
+        key: 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({
+        key: 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;
+      if (!this.callDiagnosticLatencies || !this.callDiagnosticMetrics) {
+        // @ts-ignore
+        this.webex.logger.log("NewMetrics: @submitClientEvent. Attempted to submit before webex.ready. Event name: ".concat(name));
+        return _promise.default.resolve();
+      }
+      this.callDiagnosticLatencies.saveTimestamp({
+        key: name,
+        options: {
+          meetingId: options === null || options === void 0 ? void 0 : options.meetingId
+        }
+      });
+      return this.callDiagnosticMetrics.submitClientEvent({
+        name: name,
+        payload: payload,
+        options: options
+      });
+    }
+
+    /**
+     * Submit a pre-login metric to clientmetrics
+     * @public
+     * @param payload
+     * @param preLoginId - pre-login ID of user
+     * @returns
+     */
+  }, {
+    key: "postPreLoginMetric",
+    value: function postPreLoginMetric(payload, preLoginId) {
+      var _this3 = this;
+      // @ts-ignore
+      return this.webex.request({
+        method: 'POST',
+        api: 'metrics',
+        resource: 'clientmetrics-prelogin',
+        headers: {
+          authorization: false,
+          'x-prelogin-userid': preLoginId
+        },
+        body: {
+          metrics: [payload]
+        }
+      }).then(function (res) {
+        // @ts-ignore
+        _this3.webex.logger.log("NewMetrics: @postPreLoginMetric. Request successful:", res);
+        return res;
+      }).catch(function (err) {
+        // @ts-ignore
+        _this3.logger.error("NewMetrics: @postPreLoginMetric. Request failed:", "err: ".concat((0, _utils.generateCommonErrorMetadata)(err)));
+        return _promise.default.reject(err);
+      });
+    }
+
+    /**
+     * Issue request to alias a user's pre-login ID with their CI UUID
+     * @param {string} preLoginId
+     * @returns {Object} HttpResponse object
+     */
+  }, {
+    key: "clientMetricsAliasUser",
+    value: function clientMetricsAliasUser(preLoginId) {
+      var _this4 = this;
+      // @ts-ignore
+      return this.webex.request({
+        method: 'POST',
+        api: 'metrics',
+        resource: 'clientmetrics',
+        headers: {
+          'x-prelogin-userid': preLoginId
+        },
+        body: {},
+        qs: {
+          alias: true
+        }
+      }).then(function (res) {
+        // @ts-ignore
+        _this4.webex.logger.log("NewMetrics: @clientMetricsAliasUser. Request successful:", res);
+        return res;
+      }).catch(function (err) {
+        // @ts-ignore
+        _this4.logger.error("NewMetrics: @clientMetricsAliasUser. Request failed:", "err: ".concat((0, _utils.generateCommonErrorMetadata)(err)));
+        return _promise.default.reject(err);
+      });
+    }
+
+    /**
+     * Returns a promise that will resolve to fetch options for submitting a metric.
+     *
+     * This is to support quickly submitting metrics when the browser/tab is closing.
+     * Calling submitClientEvent will not work because there some async steps that will
+     * not complete before the browser is closed.  Instead, we pre-gather all the
+     * information/options needed for the request(s), and then simply and quickly
+     * fire the fetch(es) when beforeUnload is triggered.
+     *
+     * We must use fetch instead of request because fetch has a keepalive option that
+     * allows the request it to outlive the page.
+     *
+     * Note: the timings values will be wrong, but setMetricTimingsAndFetch() will
+     * properly adjust them before submitting.
+     *
+     * @public
+     * @param {Object} arg
+     * @param {String} arg.name - event name
+     * @param {Object} arg.payload - event payload
+     * @param {Object} arg.options - other options
+     * @returns {Promise} promise that resolves to options to be used with fetch
+     */
+  }, {
+    key: "buildClientEventFetchRequestOptions",
+    value: function () {
+      var _buildClientEventFetchRequestOptions = (0, _asyncToGenerator2.default)( /*#__PURE__*/_regenerator.default.mark(function _callee(_ref7) {
+        var name, payload, options;
+        return _regenerator.default.wrap(function _callee$(_context) {
+          while (1) switch (_context.prev = _context.next) {
+            case 0:
+              name = _ref7.name, payload = _ref7.payload, options = _ref7.options;
+              return _context.abrupt("return", this.callDiagnosticMetrics.buildClientEventFetchRequestOptions({
+                name: name,
+                payload: payload,
+                options: options
+              }));
+            case 2:
+            case "end":
+              return _context.stop();
+          }
+        }, _callee, this);
+      }));
+      function buildClientEventFetchRequestOptions(_x) {
+        return _buildClientEventFetchRequestOptions.apply(this, arguments);
+      }
+      return buildClientEventFetchRequestOptions;
+    }()
+    /**
+     * Submits a metric from pre-built request options via the fetch API. Updates
+     * the "$timings" and "originTime" values to Date.now() since the existing times
+     * were set when the options were built (not submitted).
+      * @param {any} options - the pre-built request options for submitting a metric
+     * @returns {Promise} promise that resolves to the response object
+     */
+  }, {
+    key: "setMetricTimingsAndFetch",
+    value: function setMetricTimingsAndFetch(options) {
+      // @ts-ignore
+      return this.webex.setTimingsAndFetch((0, _callDiagnosticMetrics2.setMetricTimings)(options));
+    }
+
+    /**
+     * Returns true if the specified serviceErrorCode maps to an expected error.
+     * @param {number} serviceErrorCode the service error code
+     * @returns {boolean}
+     */
+  }, {
+    key: "isServiceErrorExpected",
+    value: function isServiceErrorExpected(serviceErrorCode) {
+      return this.callDiagnosticMetrics.isServiceErrorExpected(serviceErrorCode);
+    }
+  }]);
+  return Metrics;
+}(_webexCore.WebexPlugin);
+(0, _defineProperty2.default)(Metrics, "instance", void 0);
+var _default = Metrics;
+exports.default = _default;
+//# sourceMappingURL=new-metrics.js.map