@webex/internal-plugin-metrics 3.4.0 → 3.5.0-next.10

package/dist/types/behavioral-metrics.d.ts

@@ -0,0 +1,25 @@
+import { MetricEventProduct, MetricEventAgent, MetricEventVerb, EventPayload } from './metrics.types';
+import GenericMetrics from './generic-metrics';
+/**
+ * @description Util class to handle Behavioral Metrics
+ * @export
+ * @class BehavioralMetrics
+ */
+export default class BehavioralMetrics extends GenericMetrics {
+    /**
+     * Submit a behavioral metric to our metrics endpoint.
+     * @param {MetricEventProduct} product the product from which the metric is being submitted, e.g. 'webex' web client, 'wxcc_desktop'
+     * @param {MetricEventAgent} agent the source of the action for this metric
+     * @param {string} target the 'thing' that this metric includes information about
+     * @param {MetricEventVerb} verb the action that this metric includes information about
+     * @param {EventPayload} payload information specific to this event. This should be flat, i.e. it should not include nested objects.
+     * @returns {Promise<any>}
+     */
+    submitBehavioralEvent({ product, agent, target, verb, payload, }: {
+        product: MetricEventProduct;
+        agent: MetricEventAgent;
+        target: string;
+        verb: MetricEventVerb;
+        payload?: EventPayload;
+    }): void;
+}

package/dist/types/business-metrics.d.ts

@@ -0,0 +1,47 @@
+import GenericMetrics from './generic-metrics';
+import { EventPayload, Table } from './metrics.types';
+/**
+ * @description Util class to handle Buisness Metrics
+ * @export
+ * @class BusinessMetrics
+ */
+export default class BusinessMetrics extends GenericMetrics {
+    /**
+     * unfortunately, the pinot team does not allow changes to the schema of wbxapp_callend_metrics
+     * so we have to shim this layer specifically for this
+     * @param {EventPayload} payload payload of the metric
+     * @returns {Promise<any>}
+     */
+    private submitCallEndEvent;
+    /**
+     * Submit a buisness metric to our metrics endpoint, going to the default business_ucf table
+     * all event payload keys are converted into a hex string value
+     * unfortunately, the pinot team does not allow changes to the schema of business_metrics
+     * so we have to shim this layer specifically for this
+     * @param {string} name of the metric
+     * @param {EventPayload} payload payload of the metric
+     * @returns {Promise<any>}
+     */
+    private submitBusinessMetricsEvent;
+    /**
+     * Submit a buisness metric to our metrics endpoint, going to the default business_ucf table
+     * all event payload keys are converted into a hex string value
+     * @param {string} name of the metric
+     * @param {EventPayload} user payload of the metric
+     * @returns {Promise<any>}
+     */
+    private submitDefaultEvent;
+    /**
+     * Submit a buisness metric to our metrics endpoint.
+     * routes to the correct table with the correct schema payload by table
+     * @param {string} name of the metric, ignored if going to wbxapp_callend_metrics
+     * @param {EventPayload} payload user payload of the metric
+     * @param {Table} table optional - to submit the metric to and adapt the sent schema
+     * @returns {Promise<any>}
+     */
+    submitBusinessEvent({ name, payload, table, }: {
+        name: string;
+        payload: EventPayload;
+        table?: Table;
+    }): Promise<void>;
+}

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

@@ -13,6 +13,7 @@ type GetIdentifiersOptions = {
     meeting?: any;
     mediaConnections?: any[];
     correlationId?: string;
+    sessionCorrelationId?: string;
     preLoginId?: string;
     globalMeetingId?: string;
     webexConferenceIdStr?: string;
@@ -65,7 +66,7 @@ export default class CallDiagnosticMetrics extends StatelessWebexPlugin {
      * @returns
      */
     getOrigin(options: GetOriginOptions, meetingId?: string): {
-        name: "endpoint" | "antares" | "beech" | "breakout" | "cb" | "cloudproxy" | "edonus" | "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";
+        name: "endpoint" | "addin" | "antares" | "appapi" | "beech" | "breakout" | "calendar" | "cb" | "cca" | "ccc" | "cloudproxy" | "edonus" | "givr" | "hecate" | "hedge" | "hesiod" | "homer" | "superhomer" | "l2sip" | "linus" | "locus" | "mbs" | "mcc" | "mcs" | "mercury" | "mes" | "mjs" | "mmp" | "mygdon" | "ngservice" | "orpheus" | "page" | "poros" | "publicapi" | "rhesos" | "terminus" | "tpgw" | "ucc" | "wdm" | "webexivr";
         userAgent: string;
         buildType?: "debug" | "test" | "prod" | "tap" | "analyzer-test";
         upgradeChannel?: string;
@@ -77,7 +78,7 @@ export default class CallDiagnosticMetrics extends StatelessWebexPlugin {
         environment?: string;
         newEnvironment?: string;
         clientInfo?: {
-            os?: "other" | "chrome" | "windows" | "mac" | "ios" | "android" | "linux" | "android-x64" | "android-arm64" | "uwp-arm64";
+            os?: "windows" | "mac" | "ios" | "android" | "chrome" | "linux" | "other" | "android-x64" | "android-arm64" | "uwp-arm64";
             osVersion?: string;
             localIP?: string;
             gatewayIP?: string;
@@ -89,7 +90,8 @@ export default class CallDiagnosticMetrics extends StatelessWebexPlugin {
             browser?: string;
             browserVersion?: string;
             clientType?: "MEETING_CENTER" | "EVENT_CENTER" | "TRAINING_CENTER" | "TEAMS_CLIENT" | "TEAMS_DEVICE" | "TEAMS_SHARE" | "SIP" | "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" | "WXCC";
-            subClientType?: "TEAMS_DEVICE" | "DESKTOP_APP" | "DESKTOP_APP_VDI" | "DEVICE_CURRENT" | "DEVICE_LEGACY_2020" | "HOLOGRAM_HEADSET_APP" | "HVDI_APP" | "MIXED" | "MOBILE_APP" | "MOBILE_NETWORK" | "PAGE" | "VDI_APP" | "WEB_APP";
+            subClientType?: "TEAMS_DEVICE" | "AUTOMOTIVE_APP" | "DESKTOP_APP" | "DESKTOP_APP_VDI" | "DEVICE_CURRENT" | "DEVICE_LEGACY_2020" | "HOLOGRAM_HEADSET_APP" | "HVDI_APP" | "MIXED" | "MOBILE_APP" | "MOBILE_NETWORK" | "PAGE" | "VDI_APP" | "WEB_APP";
+            schedulingClientType?: "TEAMS_CLIENT" | "GOOGLE_ADDON" | "PT" | "PUBLIC_API" | "UNIFIED_PAGE" | "WEBEX_PAGE" | "GOOGLE_NOTIFICATION_CALENDAR" | "MSFT_NOTIFICATION_ADDIN" | "MSFT_NOTIFICATION_CALENDAR" | "OUTLOOK_ADDIN";
             clientVersion?: string;
             clientVersionStatus?: "CURRENT" | "LEGACY" | "UNSUPPORTED";
             localClientVersion?: string;
@@ -113,10 +115,15 @@ export default class CallDiagnosticMetrics extends StatelessWebexPlugin {
             isValidClientVersion?: boolean;
             cpuInfo?: {
                 description: string;
-                clockSpeedGigaHertz: number;
                 numberOfCores: number;
-                architecture: "unknown" | "intel32" | "intel64" | "amd32" | "amd64" | "arm32" | "arm64";
+                architecture: "unknown" | "intel32" | "intel64" | "amd32" | "amd64" | "arm32" | "arm64"; /**
+                 * Get origin object for Call Diagnostic Event payload.
+                 * @param options
+                 * @param meetingId
+                 * @returns
+                 */
                 staticPerformance?: string;
+                clockSpeedGigaHertz?: number;
                 additionalProperties?: false;
             };
             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";
@@ -147,6 +154,7 @@ export default class CallDiagnosticMetrics extends StatelessWebexPlugin {
         breakoutGroupId?: string;
         breakoutMoveId?: string;
         breakoutSessionId?: string;
+        ciExchangeTokenUrl?: string;
         confluenceId?: string;
         cpaasIdentifiers?: {
             imiTenantId: string;
@@ -164,11 +172,14 @@ export default class CallDiagnosticMetrics extends StatelessWebexPlugin {
         destinationVenueId?: string;
         deviceId?: string;
         globalMeetingId?: string;
+        installationId?: string;
+        webexMeetingUUID?: string;
         ivrCallId?: string;
         ivrDialogId?: string;
         ivrId?: string;
         callId?: string;
         locusId?: string;
+        locusJoinUrl?: string;
         locusSessionId?: string;
         locusStartTime?: string;
         locusUrl?: string;
@@ -179,6 +190,7 @@ export default class CallDiagnosticMetrics extends StatelessWebexPlugin {
         meetingInstanceId?: string;
         meetingLookupUrl?: string;
         meetingOrgId?: string;
+        metricServiceUrl?: string;
         msteamsTenantGuid?: string;
         msteamsConferenceId?: string;
         msteamsMeetingId?: string;
@@ -186,6 +198,7 @@ export default class CallDiagnosticMetrics extends StatelessWebexPlugin {
         orgId?: string;
         provisionalCorrelationId?: string;
         roomId?: string;
+        sessionCorrelationId?: string;
         sipCallId?: string;
         sipSessionId?: {
             local?: string;
@@ -200,6 +213,7 @@ export default class CallDiagnosticMetrics extends StatelessWebexPlugin {
         venueId?: string;
         venueUrl?: string;
         whiteboardUrl?: string;
+        wdmDeviceRegistrationUrl?: string;
         webexConferenceId?: number;
         webexClusterName?: string;
         webexConferenceIdStr?: string;
@@ -219,6 +233,7 @@ export default class CallDiagnosticMetrics extends StatelessWebexPlugin {
         breakoutGroupId?: string;
         breakoutMoveId?: string;
         breakoutSessionId?: string;
+        ciExchangeTokenUrl?: string;
         confluenceId?: string;
         cpaasIdentifiers?: {
             imiTenantId: string;
@@ -236,11 +251,14 @@ export default class CallDiagnosticMetrics extends StatelessWebexPlugin {
         destinationVenueId?: string;
         deviceId?: string;
         globalMeetingId?: string;
+        installationId?: string;
+        webexMeetingUUID?: string;
         ivrCallId?: string;
         ivrDialogId?: string;
         ivrId?: string;
         callId?: string;
         locusId?: string;
+        locusJoinUrl?: string;
         locusSessionId?: string;
         locusStartTime?: string;
         locusUrl?: string;
@@ -251,6 +269,7 @@ export default class CallDiagnosticMetrics extends StatelessWebexPlugin {
         meetingInstanceId?: string;
         meetingLookupUrl?: string;
         meetingOrgId?: string;
+        metricServiceUrl?: string;
         msteamsTenantGuid?: string;
         msteamsConferenceId?: string;
         msteamsMeetingId?: string;
@@ -258,6 +277,7 @@ export default class CallDiagnosticMetrics extends StatelessWebexPlugin {
         orgId?: string;
         provisionalCorrelationId?: string;
         roomId?: string;
+        sessionCorrelationId?: string;
         sipCallId?: string;
         sipSessionId?: {
             local?: string;
@@ -272,6 +292,7 @@ export default class CallDiagnosticMetrics extends StatelessWebexPlugin {
         venueId?: string;
         venueUrl?: string;
         whiteboardUrl?: string;
+        wdmDeviceRegistrationUrl?: string;
         webexConferenceId?: number;
         webexClusterName?: string;
         webexConferenceIdStr?: string;
@@ -336,7 +357,7 @@ export default class CallDiagnosticMetrics extends StatelessWebexPlugin {
      */
     generateClientEventErrorPayload(rawError: any): {
         fatal: boolean;
-        category: "signaling" | "media" | "network" | "other" | "expected";
+        category: "other" | "signaling" | "media" | "network" | "expected";
         errorDescription?: string;
         errorCode?: number;
         errorCodeStr?: string;

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

@@ -68,10 +68,11 @@ export declare const isSdpOfferCreationError: (rawError: any) => boolean;
  */
 export declare const isBrowserMediaErrorName: (errorName: any) => boolean;
 /**
+ * @param {Object} webex sdk instance
  * @param webClientDomain
  * @returns
  */
-export declare const getBuildType: (webClientDomain: any, markAsTestEvent?: boolean) => Event['origin']['buildType'];
+export declare const getBuildType: (webex: any, webClientDomain: any, markAsTestEvent?: boolean) => Event['origin']['buildType'];
 /**
  * Prepare metric item for submission.
  * @param {Object} webex sdk instance

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

@@ -96,6 +96,7 @@ export declare const ERROR_DESCRIPTIONS: {
     ICE_AND_REACHABILITY_FAILED: string;
     SDP_OFFER_CREATION_ERROR: string;
     SDP_OFFER_CREATION_ERROR_MISSING_CODEC: string;
+    WDM_RESTRICTED_REGION: string;
 };
 export declare const SERVICE_ERROR_CODES_TO_CLIENT_ERROR_CODES_MAP: {
     58400: number;
@@ -175,6 +176,8 @@ export declare const SERVICE_ERROR_CODES_TO_CLIENT_ERROR_CODES_MAP: {
     100006: number;
     100005: number;
     100004: number;
+    4404002: number;
+    4404003: number;
 };
 export declare const CLIENT_ERROR_CODE_TO_ERROR_PAYLOAD: Record<number, Partial<ClientEventError>>;
 export declare const CALL_DIAGNOSTIC_EVENT_FAILED_TO_SEND = "js_sdk_call_diagnostic_event_failed_to_send";

package/dist/types/generic-metrics.d.ts

@@ -0,0 +1,63 @@
+import { StatelessWebexPlugin } from '@webex/webex-core';
+import { DeviceContext, TaggedEvent, EventPayload, MetricType } from './metrics.types';
+/**
+ * @description top-level abstract class to handle Metrics and common routines.
+ * @export
+ * @class GenericMetrics
+ */
+export default abstract class GenericMetrics extends StatelessWebexPlugin {
+    private clientMetricsBatcher;
+    private logger;
+    private device;
+    private version;
+    private deviceId;
+    /**
+     * Constructor
+     * @param {any[]} args
+     */
+    constructor(...args: any[]);
+    /**
+     * Submit a buisness metric to our metrics endpoint.
+     * @param {string} kind of metric for logging
+     * @param {string} name of the metric
+     * @param {object} event
+     * @returns {Promise<any>}
+     */
+    protected submitEvent({ kind, name, event }: {
+        kind: string;
+        name: string;
+        event: object;
+    }): any;
+    /**
+     * Returns the deviceId from our registration with WDM.
+     * @returns {string} deviceId or empty string
+     */
+    protected getDeviceId(): string;
+    /**
+     * Returns the context object to be submitted with all metrics.
+     * @returns {DeviceContext}
+     */
+    protected getContext(): DeviceContext;
+    /**
+     * Returns the browser details to be included with all metrics.
+     * @returns {object}
+     */
+    protected getBrowserDetails(): object;
+    /**
+     * Returns true once we have the deviceId we need to submit behavioral/operational/buisness events
+     * @returns {boolean}
+     */
+    isReadyToSubmitEvents(): boolean;
+    /**
+     * Creates the object to send to our metrics endpoint for a tagged event (i.e. behavoral or operational)
+     * @param {[MetricType]} list of event type (i.e. ['behavioral'], ['operational', 'behavioral'])
+     * @param {string} metric name
+     * @param {EventPayload} user payload
+     * @returns {EventPayload}
+     */
+    protected createTaggedEventObject({ type, name, payload, }: {
+        type: [MetricType];
+        name: string;
+        payload: EventPayload;
+    }): TaggedEvent;
+}

package/dist/types/index.d.ts

@@ -9,7 +9,10 @@ import * as CALL_DIAGNOSTIC_CONFIG from './call-diagnostic/config';
 import * as CallDiagnosticUtils from './call-diagnostic/call-diagnostic-metrics.util';
 import CallDiagnosticMetrics from './call-diagnostic/call-diagnostic-metrics';
 import CallDiagnosticLatencies from './call-diagnostic/call-diagnostic-metrics-latencies';
-import BehavioralMetrics from './behavioral/behavioral-metrics';
+import BehavioralMetrics from './behavioral-metrics';
+import OperationalMetrics from './operational-metrics';
+import BusinessMetrics from './business-metrics';
+import RtcMetrics from './rtcMetrics';
 export { default, getOSNameInternal } from './metrics';
-export { config, CALL_DIAGNOSTIC_CONFIG, NewMetrics, Utils, CallDiagnosticUtils, CallDiagnosticLatencies, CallDiagnosticMetrics, BehavioralMetrics, };
+export { config, CALL_DIAGNOSTIC_CONFIG, NewMetrics, Utils, CallDiagnosticUtils, CallDiagnosticLatencies, CallDiagnosticMetrics, BehavioralMetrics, OperationalMetrics, BusinessMetrics, RtcMetrics, };
 export type { ClientEvent, ClientEventLeaveReason, SubmitBehavioralEvent, SubmitClientEvent, SubmitInternalEvent, SubmitMQE, SubmitOperationalEvent, PreComputedLatencies, };

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

@@ -15,6 +15,7 @@ export type SubmitClientEventOptions = {
     mediaConnections?: any[];
     rawError?: any;
     correlationId?: string;
+    sessionCorrelationId?: string;
     preLoginId?: string;
     environment?: EnvironmentType;
     newEnvironmentType?: NewEnvironmentType;
@@ -40,7 +41,7 @@ export interface ClientEvent {
     payload?: RawClientEvent;
     options?: SubmitClientEventOptions;
 }
-export interface BehavioralEventContext {
+export interface DeviceContext {
     app: {
         version: string;
     };
@@ -53,19 +54,31 @@ export interface BehavioralEventContext {
         version: string;
     };
 }
-export interface BehavioralEvent {
-    context: BehavioralEventContext;
+export type MetricType = 'behavioral' | 'operational' | 'business';
+export type Table = 'wbxapp_callend_metrics' | 'business_metrics' | 'business_ucf' | 'default';
+type InternalEventPayload = string | number | boolean;
+export type EventPayload = Record<string, InternalEventPayload>;
+export type BehavioralEventPayload = EventPayload;
+export interface BusinessEventPayload {
     metricName: string;
-    tags: Record<string, string | number | boolean>;
     timestamp: number;
+    context: DeviceContext;
+    browserDetails: EventPayload;
+    value: EventPayload;
+}
+export interface BusinessEvent {
     type: string[];
+    eventPayload: BusinessEventPayload;
 }
-export type BehavioralEventPayload = BehavioralEvent['tags'];
-export interface OperationalEvent {
-    name: never;
-    payload?: never;
-    options?: never;
+export interface TaggedEvent {
+    context: DeviceContext;
+    metricName: string;
+    tags: EventPayload;
+    timestamp: number;
+    type: [MetricType];
 }
+export type BehavioralEvent = TaggedEvent;
+export type OperationalEvent = TaggedEvent;
 export interface FeatureEvent {
     name: never;
     payload?: never;
@@ -79,7 +92,7 @@ export interface MediaQualityEvent {
 export type RecursivePartial<T> = {
     [P in keyof T]?: T[P] extends (infer U)[] ? RecursivePartial<U>[] : T[P] extends object ? RecursivePartial<T[P]> : T[P];
 };
-export type MetricEventNames = InternalEvent['name'] | ClientEvent['name'] | BehavioralEvent['metricName'] | OperationalEvent['name'] | FeatureEvent['name'] | MediaQualityEvent['name'];
+export type MetricEventNames = InternalEvent['name'] | ClientEvent['name'] | BehavioralEvent['metricName'] | OperationalEvent['metricName'] | BusinessEvent['eventPayload']['metricName'] | FeatureEvent['name'] | MediaQualityEvent['name'];
 export type ClientInfo = NonNullable<RawEvent['origin']['clientInfo']>;
 export type ClientType = NonNullable<RawEvent['origin']['clientInfo']>['clientType'];
 export type SubClientType = NonNullable<RawEvent['origin']['clientInfo']>['subClientType'];
@@ -103,7 +116,7 @@ export type SubmitBehavioralEvent = (args: {
     agent: MetricEventAgent;
     target: string;
     verb: MetricEventVerb;
-    payload?: BehavioralEventPayload;
+    payload?: EventPayload;
 }) => void;
 export type SubmitClientEvent = (args: {
     name: ClientEvent['name'];
@@ -111,9 +124,8 @@ export type SubmitClientEvent = (args: {
     options?: SubmitClientEventOptions;
 }) => Promise<any>;
 export type SubmitOperationalEvent = (args: {
-    name: OperationalEvent['name'];
-    payload?: RecursivePartial<OperationalEvent['payload']>;
-    options?: any;
+    name: OperationalEvent['metricName'];
+    payload: EventPayload;
 }) => void;
 export type SubmitMQE = (args: {
     name: MediaQualityEvent['name'];
@@ -126,3 +138,4 @@ export type BuildClientEventFetchRequestOptions = (args: {
     options?: SubmitClientEventOptions;
 }) => Promise<any>;
 export type PreComputedLatencies = 'internal.client.pageJMT' | 'internal.download.time' | 'internal.get.cluster.time' | 'internal.click.to.interstitial' | 'internal.refresh.captcha.time' | 'internal.exchange.ci.token.time' | 'internal.get.u2c.time' | 'internal.call.init.join.req' | 'internal.other.app.api.time' | 'internal.api.fetch.intelligence.models';
+export {};

package/dist/types/new-metrics.d.ts

@@ -1,7 +1,9 @@
 import { WebexPlugin } from '@webex/webex-core';
 import CallDiagnosticMetrics from './call-diagnostic/call-diagnostic-metrics';
-import BehavioralMetrics from './behavioral/behavioral-metrics';
-import { RecursivePartial, MetricEventProduct, MetricEventAgent, MetricEventVerb, ClientEvent, FeatureEvent, BehavioralEventPayload, OperationalEvent, MediaQualityEvent, InternalEvent, SubmitClientEventOptions } from './metrics.types';
+import BehavioralMetrics from './behavioral-metrics';
+import OperationalMetrics from './operational-metrics';
+import BusinessMetrics from './business-metrics';
+import { RecursivePartial, MetricEventProduct, MetricEventAgent, MetricEventVerb, ClientEvent, FeatureEvent, EventPayload, MediaQualityEvent, InternalEvent, SubmitClientEventOptions, Table } from './metrics.types';
 import CallDiagnosticLatencies from './call-diagnostic/call-diagnostic-metrics-latencies';
 /**
  * Metrics plugin to centralize all types of metrics.
@@ -12,6 +14,9 @@ declare class Metrics extends WebexPlugin {
     callDiagnosticLatencies: CallDiagnosticLatencies;
     callDiagnosticMetrics: CallDiagnosticMetrics;
     behavioralMetrics: BehavioralMetrics;
+    operationalMetrics: OperationalMetrics;
+    businessMetrics: BusinessMetrics;
+    isReady: boolean;
     /**
      * Constructor
      * @param args
@@ -33,10 +38,30 @@ declare class Metrics extends WebexPlugin {
         payload?: RecursivePartial<InternalEvent['payload']>;
         options?: any;
     }): void;
+    /**
+     * if webex metrics is ready, build behavioral metric backend if not already done.
+     */
+    private lazyBuildBehavioralMetrics;
+    /**
+     * if webex metrics is ready, build operational metric backend if not already done.
+     */
+    private lazyBuildOperationalMetrics;
+    /**
+     * if webex metrics is ready, build business metric backend if not already done.
+     */
+    private lazyBuildBusinessMetrics;
     /**
      * @returns true once we have the deviceId we need to submit behavioral events to Amplitude
      */
     isReadyToSubmitBehavioralEvents(): boolean;
+    /**
+     * @returns true once we have the deviceId we need to submit operational events
+     */
+    isReadyToSubmitOperationalEvents(): boolean;
+    /**
+     * @returns true once we have the deviceId we need to submit buisness events
+     */
+    isReadyToSubmitBusinessEvents(): boolean;
     /**
      * Behavioral event
      * @param args
@@ -46,17 +71,25 @@ declare class Metrics extends WebexPlugin {
         agent: MetricEventAgent;
         target: string;
         verb: MetricEventVerb;
-        payload?: BehavioralEventPayload;
-    }): any;
+        payload?: EventPayload;
+    }): void | Promise<void>;
     /**
      * Operational event
      * @param args
      */
-    submitOperationalEvent({ name, payload, options, }: {
-        name: OperationalEvent['name'];
-        payload?: RecursivePartial<OperationalEvent['payload']>;
-        options?: any;
-    }): void;
+    submitOperationalEvent({ name, payload }: {
+        name: string;
+        payload?: EventPayload;
+    }): void | Promise<void>;
+    /**
+     * Buisness event
+     * @param args
+     */
+    submitBusinessEvent({ name, payload, table, }: {
+        name: string;
+        payload: EventPayload;
+        table?: Table;
+    }): Promise<void>;
     /**
      * Call Analyzer: Media Quality Event
      * @param args

package/dist/types/operational-metrics.d.ts

@@ -0,0 +1,19 @@
+import GenericMetrics from './generic-metrics';
+import { EventPayload } from './metrics.types';
+/**
+ * @description Util class to handle Operational Metrics
+ * @export
+ * @class OperationalMetrics
+ */
+export default class OperationalMetrics extends GenericMetrics {
+    /**
+     * Submit an operational metric to our metrics endpoint.
+     * @param {string} name of the metric
+     * @param {EventPayload} user payload of the metric
+     * @returns {Promise<any>}
+     */
+    submitOperationalEvent({ name, payload }: {
+        name: string;
+        payload: EventPayload;
+    }): void;
+}

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

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

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

@@ -0,0 +1,71 @@
+/**
+ * Rtc Metrics
+ */
+export default class RtcMetrics {
+    /**
+     * Array of MetricData items to be sent to the metrics service.
+     */
+    metricsQueue: any[];
+    intervalId: number;
+    webex: any;
+    meetingId: string;
+    correlationId: string;
+    connectionId: string;
+    shouldSendMetricsOnNextStatsReport: boolean;
+    /**
+     * Initialize the interval.
+     *
+     * @param {object} webex - The main `webex` object.
+     * @param {string} meetingId - The meeting id.
+     * @param {string} correlationId - The correlation id.
+     */
+    constructor(webex: any, meetingId: any, correlationId: any);
+    /**
+     * Check to see if the metrics queue has any items.
+     *
+     * @returns {void}
+     */
+    sendMetricsInQueue(): void;
+    /**
+     * Forces sending metrics when we get the next stats-report
+     *
+     * This is useful for cases when something important happens that affects the media connection,
+     * for example when we move from lobby into the meeting.
+     *
+     * @returns {void}
+     */
+    sendNextMetrics(): void;
+    /**
+     * Add metrics items to the metrics queue.
+     *
+     * @param {object} data - An object with a payload array of metrics items.
+     *
+     * @returns {void}
+     */
+    addMetrics(data: any): void;
+    /**
+     * Clear the metrics interval.
+     *
+     * @returns {void}
+     */
+    closeMetrics(): void;
+    /**
+     * Anonymize IP addresses.
+     *
+     * @param {array} stats - An RTCStatsReport organized into an array of strings.
+     * @returns {string}
+     */
+    anonymizeIp(stats: string): string;
+    /**
+     * Set a new connection id.
+     *
+     * @returns {void}
+     */
+    private resetConnection;
+    /**
+     * Send metrics to the metrics service.
+     *
+     * @returns {void}
+     */
+    private sendMetrics;
+}

package/package.json

@@ -26,22 +26,22 @@
     "@webex/eslint-config-legacy": "0.0.0",
     "@webex/jest-config-legacy": "0.0.0",
     "@webex/legacy-tools": "0.0.0",
-    "@webex/test-helper-chai": "3.4.0",
-    "@webex/test-helper-mocha": "3.4.0",
-    "@webex/test-helper-mock-webex": "3.4.0",
-    "@webex/test-helper-test-users": "3.4.0",
+    "@webex/test-helper-chai": "3.5.0-next.10",
+    "@webex/test-helper-mocha": "3.5.0-next.10",
+    "@webex/test-helper-mock-webex": "3.5.0-next.10",
+    "@webex/test-helper-test-users": "3.5.0-next.10",
     "eslint": "^8.24.0",
     "prettier": "^2.7.1",
     "sinon": "^9.2.4"
   },
   "dependencies": {
-    "@webex/common": "3.4.0",
-    "@webex/common-timers": "3.4.0",
-    "@webex/event-dictionary-ts": "^1.0.1406",
-    "@webex/internal-plugin-metrics": "3.4.0",
-    "@webex/test-helper-chai": "3.4.0",
-    "@webex/test-helper-mock-webex": "3.4.0",
-    "@webex/webex-core": "3.4.0",
+    "@webex/common": "3.5.0-next.10",
+    "@webex/common-timers": "3.5.0-next.10",
+    "@webex/event-dictionary-ts": "^1.0.1546",
+    "@webex/internal-plugin-metrics": "3.5.0-next.10",
+    "@webex/test-helper-chai": "3.5.0-next.10",
+    "@webex/test-helper-mock-webex": "3.5.0-next.10",
+    "@webex/webex-core": "3.5.0-next.10",
     "ip-anonymize": "^0.1.0",
     "lodash": "^4.17.21",
     "uuid": "^3.3.2"
@@ -54,5 +54,5 @@
     "test:style": "eslint ./src/**/*.*",
     "test:unit": "webex-legacy-tools test --unit --runner mocha"
   },
-  "version": "3.4.0"
+  "version": "3.5.0-next.10"
 }