@webex/internal-plugin-metrics 3.8.1 → 3.9.0

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

@@ -73,7 +73,10 @@ export default class CallDiagnosticLatencies extends WebexPlugin {
      * @param b end
      * @returns latency
      */
-    getDiffBetweenTimestamps(a: MetricEventNames, b: MetricEventNames): number;
+    getDiffBetweenTimestamps(a: MetricEventNames, b: MetricEventNames, clampValues?: {
+        minimum?: number;
+        maximum?: number;
+    }): number;
     /**
      * Meeting Info Request
      * @note Meeting Info request happen not just in the join phase. CA requires
@@ -160,6 +163,11 @@ export default class CallDiagnosticLatencies extends WebexPlugin {
      * @returns - latency
      */
     getClickToInterstitial(): number;
+    /**
+     * Click To Interstitial With User Delay
+     * @returns - latency
+     */
+    getClickToInterstitialWithUserDelay(): number;
     /**
      * Interstitial To Join Ok
      * @returns - latency
@@ -180,6 +188,11 @@ export default class CallDiagnosticLatencies extends WebexPlugin {
      * @returns - latency
      */
     getTotalJMT(): number;
+    /**
+     * Total JMT With User Delay
+     * @returns - latency
+     */
+    getTotalJMTWithUserDelay(): number;
     /**
      * Join Conf JMT
      * @returns - latency
@@ -190,6 +203,11 @@ export default class CallDiagnosticLatencies extends WebexPlugin {
      * @returns - latency
      */
     getTotalMediaJMT(): number;
+    /**
+     * Total Media JMT With User Delay
+     * @returns - latency
+     */
+    getTotalMediaJMTWithUserDelay(): number;
     /**
      * Client JMT
      * @returns - latency
@@ -215,6 +233,10 @@ export default class CallDiagnosticLatencies extends WebexPlugin {
      * Video setup delay transmit
      */
     getVideoJoinRespTxStart(): number;
+    /**
+     * Time from share initiation to share stop (ms).
+     */
+    getShareDuration(): number;
     /**
      * Total latency for all exchange ci token.
      */

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

@@ -1,5 +1,5 @@
 import { StatelessWebexPlugin } from '@webex/webex-core';
-import { Event, ClientType, SubClientType, NetworkType, EnvironmentType, NewEnvironmentType, ClientEvent, SubmitClientEventOptions, MediaQualityEvent, SubmitMQEOptions, SubmitMQEPayload, ClientLaunchMethodType, ClientEventError, ClientEventPayload, ClientSubServiceType, BrowserLaunchMethodType, DelayedClientEvent } from '../metrics.types';
+import { Event, ClientType, SubClientType, NetworkType, EnvironmentType, NewEnvironmentType, ClientEvent, SubmitClientEventOptions, MediaQualityEvent, SubmitMQEOptions, SubmitMQEPayload, ClientLaunchMethodType, ClientEventError, ClientEventPayload, ClientSubServiceType, BrowserLaunchMethodType, DelayedClientEvent, FeatureEvent, ClientFeatureEventPayload } from '../metrics.types';
 type GetOriginOptions = {
     clientType: ClientType;
     subClientType: SubClientType;
@@ -30,7 +30,11 @@ export default class CallDiagnosticMetrics extends StatelessWebexPlugin {
     private hasLoggedBrowserSerial;
     private device;
     private delayedClientEvents;
+    private delayedClientFeatureEvents;
     private eventErrorCache;
+    private isMercuryConnected;
+    private eventLimitTracker;
+    private eventLimitWarningsLogged;
     validator: (options: {
         type: 'mqe' | 'ce';
         event: Event;
@@ -55,6 +59,13 @@ export default class CallDiagnosticMetrics extends StatelessWebexPlugin {
     getIsConvergedArchitectureEnabled({ meetingId }: {
         meetingId?: string;
     }): boolean;
+    /**
+     * Sets mercury connected status for event data object in CA events
+     * @public
+     * @param status - boolean value indicating mercury connection status
+     * @return {void}
+     */
+    setMercuryConnectedStatus(status: boolean): void;
     /**
      * Returns meeting's subServiceType
      * @param meeting
@@ -68,7 +79,7 @@ export default class CallDiagnosticMetrics extends StatelessWebexPlugin {
      * @returns
      */
     getOrigin(options: GetOriginOptions, meetingId?: string): {
-        name: "endpoint" | "addin" | "antares" | "appapi" | "beech" | "breakout" | "calendar" | "cb" | "cca" | "ccc" | "cloudproxy" | "crc" | "edonus" | "givr" | "hecate" | "hedge" | "hesiod" | "homer" | "idbroker" | "superhomer" | "l2sip" | "linus" | "locus" | "mbs" | "mcc" | "mcs" | "mercury" | "mes" | "mjs" | "mmp" | "mygdon" | "ngservice" | "orpheus" | "page" | "poros" | "publicapi" | "rhesos" | "terminus" | "tpgw" | "ucc" | "wdm" | "webexivr" | "meetingcontainer";
+        name: "endpoint" | "addin" | "antares" | "appapi" | "beech" | "breakout" | "calendar" | "cb" | "cca" | "ccc" | "cloudproxy" | "crc" | "edonus" | "givr" | "hecate" | "hedge" | "hesiod" | "homer" | "idbroker" | "superhomer" | "l2sip" | "linus" | "locus" | "mbs" | "mcc" | "mcs" | "mercury" | "mes" | "mjs" | "mmp" | "mrs" | "mygdon" | "ngpage" | "ngservice" | "oauth" | "orpheus" | "page" | "poros" | "publicapi" | "rhesos" | "terminus" | "tpgw" | "ucc" | "wdm" | "webexivr" | "meetingcontainer";
         userAgent: string;
         buildType?: "debug" | "test" | "prod" | "tap" | "analyzer-test";
         upgradeChannel?: string;
@@ -88,23 +99,26 @@ export default class CallDiagnosticMetrics extends StatelessWebexPlugin {
             localNetworkPrefix?: string;
             publicNetworkPrefix?: string;
             browserLaunchMethod?: "url-handler" | "activex" | "npapi" | "extension" | "cwsapi" | "java" | "tfs" | "webacd" | "thinclient" | "switch-to-web" | "switch-to-native";
-            clientLaunchMethod?: "url-handler" | "universal-link" | "voice-command" | "notification" | "manual" | "teams-cross-launch" | "mc-cross-launch" | "cws" | "launcher" | "cws-launcher";
+            clientLaunchMethod?: "url-handler" | "universal-link" | "voice-command" | "notification" | "manual" | "teams-cross-launch" | "mc-cross-launch" | "cws" | "installer" | "installer-launcher" | "launcher" | "cws-launcher";
             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" | "TEAMS_PHONE"; /**
-             * Constructor
-             * @param args
-             */
+            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" | "TEAMS_PHONE";
             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" | "PHONE_NOVUM" | "PHONE_ESPRESSO" | "PHONE_BUMBLEBEE";
             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;
+            launcherVersion?: string;
             modelNumber?: string;
             joinFirstUpdateLater?: "ep-enabled" | "sp-enabled" | "not-enabled";
             standbyUsed?: boolean;
             prefetchDocShowUsed?: boolean;
-            fastJoinUsed?: boolean;
+            fastJoinUsed?: boolean; /**
+             * Sets mercury connected status for event data object in CA events
+             * @public
+             * @param status - boolean value indicating mercury connection status
+             * @return {void}
+             */
             clientDownloadSize?: number;
             clientDownloadFileCount?: number;
             nodeId?: number;
@@ -181,6 +195,7 @@ export default class CallDiagnosticMetrics extends StatelessWebexPlugin {
         ivrDialogId?: string;
         ivrId?: string;
         callId?: string;
+        pairCallId?: string;
         locusId?: string;
         locusJoinUrl?: string;
         locusSessionId?: string;
@@ -232,6 +247,7 @@ export default class CallDiagnosticMetrics extends StatelessWebexPlugin {
         webexWebDomain?: string;
         recordingId?: string;
         clientCorrelationId?: string;
+        idForEndpointAB?: string;
         correlationId: string;
         additionalProperties?: false;
     } | {
@@ -265,6 +281,7 @@ export default class CallDiagnosticMetrics extends StatelessWebexPlugin {
         ivrDialogId?: string;
         ivrId?: string;
         callId?: string;
+        pairCallId?: string;
         locusId?: string;
         locusJoinUrl?: string;
         locusSessionId?: string;
@@ -316,6 +333,93 @@ export default class CallDiagnosticMetrics extends StatelessWebexPlugin {
         webexWebDomain?: string;
         recordingId?: string;
         clientCorrelationId?: string;
+        idForEndpointAB?: string;
+        correlationId: string;
+        additionalProperties?: false;
+    } | {
+        aggregatedBreakoutMoveId?: string;
+        attendeeId?: string;
+        participantId?: string;
+        breakoutGroupId?: string;
+        breakoutMoveId?: string;
+        breakoutSessionId?: string;
+        ciExchangeTokenUrl?: string;
+        confluenceId?: string;
+        cpaasIdentifiers?: {
+            imiTenantId: string;
+            devClientId: string;
+            imiServiceId: string;
+            imiAppId: string;
+            sessionId: string;
+            sessionInstanceId: string;
+            additionalProperties?: false;
+        };
+        csdmDeviceUrl?: string;
+        destinationBreakoutSessionId?: string;
+        destinationLocusSessionId?: string;
+        destinationLocusUrl?: string;
+        destinationVenueId?: string;
+        deviceId?: string;
+        globalMeetingId?: string;
+        installationId?: string;
+        webexMeetingUUID?: string;
+        ivrCallId?: string;
+        ivrDialogId?: string;
+        ivrId?: string;
+        callId?: string;
+        pairCallId?: string;
+        locusId?: string;
+        locusJoinUrl?: string;
+        locusSessionId?: string;
+        locusStartTime?: string;
+        locusUrl?: string;
+        machineId?: string;
+        mediaAgentAlias?: string;
+        mediaAgentGroupId?: string;
+        meetClusterName?: string;
+        meetingInstanceId?: string;
+        meetingLookupUrl?: string;
+        meetingOrgId?: string;
+        metricServiceUrl?: string;
+        msteamsTenantGuid?: string;
+        msteamsConferenceId?: string;
+        msteamsMeetingId?: string;
+        oauth2ClientId?: string;
+        orgId?: string;
+        provisionalCorrelationId?: string;
+        roomId?: string;
+        sessionCorrelationId?: string;
+        sharedMediaId?: string;
+        sipCallId?: string;
+        sipSessionId?: {
+            local?: string;
+            remote?: string;
+            additionalProperties?: false;
+        };
+        sipUri?: string;
+        subConfId?: string;
+        tenantId?: string;
+        trackingId?: string;
+        userId?: string;
+        venueId?: string;
+        venueUrl?: string;
+        whiteboardUrl?: string;
+        wdmDeviceRegistrationUrl?: string;
+        webexConferenceId?: number;
+        webexClusterName?: string;
+        webexConferenceIdStr?: string;
+        webexDataCenter?: string;
+        webexGuestId?: number;
+        webexMeetingId?: number;
+        webexNodeId?: number;
+        webexSiteId?: number;
+        webexSiteName?: string;
+        webexSiteUuid?: string;
+        webexUserId?: number;
+        webexWebDomain?: string;
+        recordingId?: string;
+        clientCorrelationId?: string;
+        idForEndpointAB?: string;
         correlationId: string;
         additionalProperties?: false;
     };
@@ -328,11 +432,30 @@ export default class CallDiagnosticMetrics extends StatelessWebexPlugin {
      */
     prepareDiagnosticEvent(eventData: Event['event'], options: any): Event;
     /**
-     * TODO: NOT IMPLEMENTED
+     * Create feature event
+     * @param name
+     * @param payload
+     * @param options
+     * @returns
+     */
+    private prepareClientFeatureEvent;
+    /**
      * Submit Feature Event
+     * submit to business_ucf
      * @returns
      */
-    submitFeatureEvent(): void;
+    submitFeatureEvent({ name, payload, options, delaySubmitEvent, }: {
+        name: FeatureEvent['name'];
+        payload?: ClientFeatureEventPayload;
+        options?: SubmitClientEventOptions;
+        delaySubmitEvent?: boolean;
+    }): Promise<any>;
+    /**
+     * Submit Feature Event
+     * type is business
+     * @param event
+     */
+    submitToCallFeatures(event: Event): Promise<any>;
     /**
      * Submit Media Quality Event
      * @param args - submit params
@@ -366,11 +489,43 @@ export default class CallDiagnosticMetrics extends StatelessWebexPlugin {
      * Clear the error cache
      */
     clearErrorCache(): void;
+    /**
+     * Checks if an event should be limited based on criteria defined in the event dictionary.
+     * Returns true if the event should be sent, false if it has reached its limit.
+     * @param event - The diagnostic event object
+     * @returns boolean indicating whether the event should be sent
+     */
+    private shouldSendEvent;
+    /**
+     * Checks the current count for a limit key and increments if under limit.
+     * @param limitKey - The unique key for this limit combination
+     * @param maxCount - Maximum allowed count
+     * @param eventDescription - Description for logging
+     * @returns true if under limit and incremented, false if at/over limit
+     */
+    private checkAndIncrementEventCount;
+    /**
+     * Clears event limit tracking
+     */
+    clearEventLimits(): void;
+    /**
+     * Clears event limit tracking for a specific correlationId only.
+     * Keeps limits for other meetings intact.
+     */
+    clearEventLimitsForCorrelationId(correlationId: string): void;
     /**
      * Generate error payload for Client Event
      * @param rawError
      */
     generateClientEventErrorPayload(rawError: any): any[];
+    /**
+     * Create common object for in meeting events
+     * @param name
+     * @param options
+     * @param eventType - 'client' | 'feature'
+     * @returns object
+     */
+    private createCommonEventObjectInMeeting;
     /**
      * Create client event object for in meeting events
      * @param arg - create args
@@ -379,6 +534,13 @@ export default class CallDiagnosticMetrics extends StatelessWebexPlugin {
      * @returns object
      */
     private createClientEventObjectInMeeting;
+    /**
+     * Create feature event object for in meeting function event
+     * @param name
+     * @param options
+     * @returns object
+     */
+    private createFeatureEventObjectInMeeting;
     /**
      * Create client event object for pre meeting events
      * @param arg - create args
@@ -416,6 +578,10 @@ export default class CallDiagnosticMetrics extends StatelessWebexPlugin {
      * Submit Delayed Client Event CA events. Clears delayedClientEvents array after submission.
      */
     submitDelayedClientEvents(overrides?: Partial<DelayedClientEvent['options']>): Promise<any[]> | Promise<void>;
+    /**
+     * Submit Delayed feature Event CA events. Clears submitDelayedClientFeatureEvents array after submission.
+     */
+    submitDelayedClientFeatureEvents(overrides?: Partial<DelayedClientEvent['options']>): Promise<any[]> | Promise<void>;
     /**
      * Prepare the event and send the request to metrics-a service.
      * @param event

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

@@ -1,5 +1,6 @@
 import { ClientEventError, ClientSubServiceType } from '../metrics.types';
 export declare const CALL_DIAGNOSTIC_LOG_IDENTIFIER = "call-diagnostic-events -> ";
+export declare const CALL_FEATURE_LOG_IDENTIFIER = "call-diagnostic-events-feature -> ";
 export declare const AUTHENTICATION_FAILED_CODE = 1010;
 export declare const NETWORK_ERROR = 1026;
 export declare const NEW_LOCUS_ERROR_CLIENT_CODE = 4008;
@@ -195,3 +196,4 @@ export declare const SERVICE_ERROR_CODES_TO_CLIENT_ERROR_CODES_MAP: {
 };
 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";
+export declare const CALL_FEATURE_EVENT_FAILED_TO_SEND = "js_sdk_call_feature_event_failed_to_send";

package/dist/types/index.d.ts

@@ -4,7 +4,7 @@
 import config from './config';
 import NewMetrics from './new-metrics';
 import * as Utils from './utils';
-import { ClientEvent, ClientEventLeaveReason, SubmitBehavioralEvent, SubmitClientEvent, SubmitInternalEvent, SubmitOperationalEvent, SubmitBusinessEvent, SubmitMQE, PreComputedLatencies } from './metrics.types';
+import { ClientEvent, ClientEventLeaveReason, SubmitBehavioralEvent, SubmitClientEvent, SubmitInternalEvent, SubmitOperationalEvent, SubmitBusinessEvent, SubmitMQE, PreComputedLatencies, SubmitFeatureEvent } from './metrics.types';
 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';
@@ -15,4 +15,4 @@ 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, OperationalMetrics, BusinessMetrics, RtcMetrics, };
-export type { ClientEvent, ClientEventLeaveReason, SubmitBehavioralEvent, SubmitClientEvent, SubmitInternalEvent, SubmitMQE, SubmitOperationalEvent, SubmitBusinessEvent, PreComputedLatencies, };
+export type { ClientEvent, ClientEventLeaveReason, SubmitBehavioralEvent, SubmitClientEvent, SubmitInternalEvent, SubmitMQE, SubmitOperationalEvent, SubmitBusinessEvent, PreComputedLatencies, SubmitFeatureEvent, };

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

@@ -1,6 +1,6 @@
-import { ClientEvent as RawClientEvent, Event as RawEvent, MediaQualityEvent as RawMediaQualityEvent } from '@webex/event-dictionary-ts';
+import { ClientEvent as RawClientEvent, Event as RawEvent, MediaQualityEvent as RawMediaQualityEvent, FeatureEvent as RawFeatureEvent } from '@webex/event-dictionary-ts';
 export type Event = Omit<RawEvent, 'event'> & {
-    event: RawClientEvent | RawMediaQualityEvent;
+    event: RawClientEvent | RawMediaQualityEvent | RawFeatureEvent;
 };
 export type ClientEventError = NonNullable<RawClientEvent['errors']>[0];
 export type EnvironmentType = NonNullable<RawEvent['origin']['environment']>;
@@ -41,7 +41,7 @@ export type SubmitMQEOptions = {
     globalMeetingId?: string;
 };
 export type InternalEvent = {
-    name: 'internal.client.meetinginfo.request' | 'internal.client.meetinginfo.response' | 'internal.register.device.request' | 'internal.register.device.response' | 'internal.reset.join.latencies' | 'internal.client.meeting.click.joinbutton' | 'internal.host.meeting.participant.admitted' | 'internal.client.meeting.interstitial-window.showed' | 'internal.client.interstitial-window.click.joinbutton' | 'internal.client.add-media.turn-discovery.start' | 'internal.client.add-media.turn-discovery.end';
+    name: 'internal.client.meetinginfo.request' | 'internal.client.meetinginfo.response' | 'internal.register.device.request' | 'internal.register.device.response' | 'internal.reset.join.latencies' | 'internal.client.meeting.click.joinbutton' | 'internal.host.meeting.participant.admitted' | 'internal.client.meeting.interstitial-window.showed' | 'internal.client.interstitial-window.click.joinbutton' | 'internal.client.add-media.turn-discovery.start' | 'internal.client.add-media.turn-discovery.end' | 'internal.client.share.initiated' | 'internal.client.share.stopped';
     payload?: never;
     options?: never;
 };
@@ -89,9 +89,9 @@ export interface TaggedEvent {
 export type BehavioralEvent = TaggedEvent;
 export type OperationalEvent = TaggedEvent;
 export interface FeatureEvent {
-    name: never;
-    payload?: never;
-    options?: never;
+    name: RawFeatureEvent['name'];
+    payload?: RawFeatureEvent;
+    options?: SubmitClientEventOptions;
 }
 export interface MediaQualityEvent {
     name: RawMediaQualityEvent['name'];
@@ -110,6 +110,7 @@ export type ClientSubServiceType = ClientEvent['payload']['webexSubServiceType']
 export type ClientEventPayload = RecursivePartial<ClientEvent['payload']>;
 export type ClientEventLeaveReason = ClientEvent['payload']['leaveReason'];
 export type ClientEventPayloadError = ClientEvent['payload']['errors'];
+export type ClientFeatureEventPayload = RecursivePartial<FeatureEvent['payload']>;
 export type MediaQualityEventAudioSetupDelayPayload = NonNullable<MediaQualityEvent['payload']>['audioSetupDelay'];
 export type MediaQualityEventVideoSetupDelayPayload = NonNullable<MediaQualityEvent['payload']>['videoSetupDelay'];
 export type SubmitMQEPayload = RecursivePartial<MediaQualityEvent['payload']> & {
@@ -152,7 +153,7 @@ export type BuildClientEventFetchRequestOptions = (args: {
     payload?: RecursivePartial<ClientEvent['payload']>;
     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 type PreComputedLatencies = 'internal.client.pageJMT' | 'internal.download.time' | 'internal.get.cluster.time' | 'internal.click.to.interstitial' | 'internal.click.to.interstitial.with.user.delay' | '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 interface IdType {
     meetingId?: string;
     callId?: string;
@@ -172,4 +173,14 @@ export interface DelayedClientEvent {
     payload?: RecursivePartial<ClientEvent['payload']>;
     options?: SubmitClientEventOptions;
 }
+export type SubmitFeatureEvent = (args: {
+    name: FeatureEvent['name'];
+    payload?: RecursivePartial<FeatureEvent['payload']>;
+    options?: SubmitClientEventOptions;
+}) => Promise<any>;
+export interface DelayedClientFeatureEvent {
+    name: FeatureEvent['name'];
+    payload?: RecursivePartial<FeatureEvent['payload']>;
+    options?: SubmitClientEventOptions;
+}
 export {};

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

@@ -3,7 +3,7 @@ import CallDiagnosticMetrics from './call-diagnostic/call-diagnostic-metrics';
 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, DelayedClientEvent } from './metrics.types';
+import { RecursivePartial, MetricEventProduct, MetricEventAgent, MetricEventVerb, ClientEvent, FeatureEvent, EventPayload, MediaQualityEvent, InternalEvent, SubmitClientEventOptions, Table, DelayedClientEvent, DelayedClientFeatureEvent } from './metrics.types';
 import CallDiagnosticLatencies from './call-diagnostic/call-diagnostic-metrics-latencies';
 /**
  * Metrics plugin to centralize all types of metrics.
@@ -22,10 +22,15 @@ declare class Metrics extends WebexPlugin {
      * Whether or not to delay the submission of client events.
      */
     delaySubmitClientEvents: boolean;
+    /**
+     * Whether or not to delay the submission of feature events.
+     */
+    delaySubmitClientFeatureEvents: boolean;
     /**
      * Overrides for delayed client events. E.g. if you want to override the correlationId for all delayed client events, you can set this to { correlationId: 'newCorrelationId' }
      */
     delayedClientEventsOverrides: Partial<DelayedClientEvent['options']>;
+    delayedClientFeatureEventsOverrides: Partial<DelayedClientFeatureEvent['options']>;
     /**
      * Constructor
      * @param args
@@ -119,7 +124,7 @@ declare class Metrics extends WebexPlugin {
         name: FeatureEvent['name'];
         payload?: RecursivePartial<FeatureEvent['payload']>;
         options: any;
-    }): void;
+    }): Promise<any>;
     /**
      * Call Analyzer: Client Event
      * @public
@@ -188,5 +193,17 @@ declare class Metrics extends WebexPlugin {
         shouldDelay: boolean;
         overrides?: Partial<DelayedClientEvent['options']>;
     }): Promise<any[]> | Promise<void>;
+    /**
+     * Sets the value of setDelaySubmitClientFeatureEvents.
+     * If set to true, feature events will be delayed until submitDelayedClientFeatureEvents is called.
+     * If set to false, delayed feature events will be submitted.
+     *
+     * @param {object} options - {shouldDelay: A boolean value indicating whether to delay the submission of feature events,
+     * overrides: An object containing overrides for the feature events}
+     */
+    setDelaySubmitClientFeatureEvents({ shouldDelay, overrides, }: {
+        shouldDelay: boolean;
+        overrides?: Partial<DelayedClientFeatureEvent['options']>;
+    }): Promise<any[]> | Promise<void>;
 }
 export default Metrics;

package/package.json

@@ -26,22 +26,21 @@
     "@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.8.1",
-    "@webex/test-helper-mocha": "3.8.1",
-    "@webex/test-helper-mock-webex": "3.8.1",
-    "@webex/test-helper-test-users": "3.8.1",
+    "@webex/test-helper-chai": "3.9.0",
+    "@webex/test-helper-mocha": "3.9.0",
+    "@webex/test-helper-mock-webex": "3.9.0",
+    "@webex/test-helper-test-users": "3.9.0",
     "eslint": "^8.24.0",
     "prettier": "^2.7.1",
     "sinon": "^9.2.4"
   },
   "dependencies": {
-    "@webex/common": "3.8.1",
-    "@webex/common-timers": "3.8.1",
-    "@webex/event-dictionary-ts": "^1.0.1753",
-    "@webex/internal-plugin-metrics": "3.8.1",
-    "@webex/test-helper-chai": "3.8.1",
-    "@webex/test-helper-mock-webex": "3.8.1",
-    "@webex/webex-core": "3.8.1",
+    "@webex/common": "3.9.0",
+    "@webex/common-timers": "3.9.0",
+    "@webex/event-dictionary-ts": "^1.0.1819",
+    "@webex/test-helper-chai": "3.9.0",
+    "@webex/test-helper-mock-webex": "3.9.0",
+    "@webex/webex-core": "3.9.0",
     "ip-anonymize": "^0.1.0",
     "lodash": "^4.17.21",
     "uuid": "^3.3.2"
@@ -54,5 +53,5 @@
     "test:style": "eslint ./src/**/*.*",
     "test:unit": "webex-legacy-tools test --unit --runner mocha"
   },
-  "version": "3.8.1"
+  "version": "3.9.0"
 }