@webex/internal-plugin-metrics 3.12.0-next.6 → 3.12.0-next.60

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

@@ -18,6 +18,7 @@ type GetIdentifiersOptions = {
     preLoginId?: string;
     globalMeetingId?: string;
     webexConferenceIdStr?: string;
+    locusCluster?: string;
 };
 /**
  * @description Util class to handle Call Analyzer Metrics
@@ -27,7 +28,7 @@ type GetIdentifiersOptions = {
 export default class CallDiagnosticMetrics extends StatelessWebexPlugin {
     private callDiagnosticEventsBatcher;
     private preLoginMetricsBatcher;
-    private logger;
+    private get logger();
     private hasLoggedBrowserSerial;
     private device;
     private delayedClientEvents;
@@ -36,6 +37,8 @@ export default class CallDiagnosticMetrics extends StatelessWebexPlugin {
     private isMercuryConnected;
     private eventLimitTracker;
     private eventLimitWarningsLogged;
+    private isTelemetryOptOutManual;
+    private isTelemetryOptOutAutomatic;
     validator: (options: {
         type: 'mqe' | 'ce';
         event: Event;
@@ -53,6 +56,29 @@ export default class CallDiagnosticMetrics extends StatelessWebexPlugin {
      * @returns one of 'login-ci','unverified-guest', null
      */
     getCurLoginType(): "unverified-guest" | "login-ci";
+    /**
+     * Returns the user activation state reported from the browser's navigator.userActivation API
+     * @returns object with hasBeenActive and isActive booleans, or undefined if unavailable
+     */
+    getUserActivation(): {
+        hasBeenActive: boolean;
+        isActive: boolean;
+    } | undefined;
+    /**
+     * Returns the telemetryOptOut value of the current user
+     * @returns one of 'manual', 'automatic', undefined
+     */
+    getTelemetryOptOut(): "manual" | "automatic";
+    /**
+     * Sets the manual telemetry opt-out status for the current user
+     * @param value - boolean value indicating manual telemetry opt-out status
+     */
+    setIsTelemetryOptOutManual(value: boolean): void;
+    /**
+     * Sets the automatic telemetry opt-out status for the current user
+     * @param value - boolean value indicating automatic telemetry opt-out status
+     */
+    setIsTelemetryOptOutAutomatic(value: boolean): void;
     /**
      * Returns if the meeting has converged architecture enabled
      * @param options.meetingId
@@ -84,6 +110,7 @@ export default class CallDiagnosticMetrics extends StatelessWebexPlugin {
         userAgent: string;
         buildType?: "debug" | "test" | "prod" | "tap" | "analyzer-test";
         upgradeChannel?: string;
+        upgradeSource?: string;
         instanceId?: string;
         networkType: "wifi" | "ethernet" | "cellular" | "unknown";
         localIP?: string;
@@ -106,6 +133,8 @@ export default class CallDiagnosticMetrics extends StatelessWebexPlugin {
             urlProtocolLaunchMethod?: "manual" | "auto" | "extension-fallback";
             browser?: string;
             browserVersion?: string;
+            isSupportedBrowserFamily?: boolean;
+            isOutdatedBrowserVersion?: boolean;
             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" | "WEBEX_RELAY";
             subClientType?: "TEAMS_DEVICE" | "SIP" | "AUTOMOTIVE_APP" | "BROWSER_EXTENSION" | "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" | "SIP_PSTN";
             schedulingClientType?: "TEAMS_CLIENT" | "GOOGLE_ADDON" | "PT" | "PUBLIC_API" | "UNIFIED_PAGE" | "WEBEX_PAGE" | "GOOGLE_NOTIFICATION_CALENDAR" | "MSFT_NOTIFICATION_ADDIN" | "MSFT_NOTIFICATION_CALENDAR" | "OUTLOOK_ADDIN";
@@ -113,6 +142,10 @@ export default class CallDiagnosticMetrics extends StatelessWebexPlugin {
             clientVersionStatus?: "CURRENT" | "LEGACY" | "UNSUPPORTED";
             localClientVersion?: string;
             launcherVersion?: string;
+            installerVersion?: string;
+            installerMajorVersion?: number;
+            installerMinorVersion?: number;
+            installerRevision?: number;
             modelNumber?: string;
             joinFirstUpdateLater?: "ep-enabled" | "sp-enabled" | "not-enabled";
             standbyUsed?: boolean;
@@ -137,11 +170,12 @@ export default class CallDiagnosticMetrics extends StatelessWebexPlugin {
                 architecture: "unknown" | "intel32" | "intel64" | "amd32" | "amd64" | "arm32" | "arm64" | "armv9" | "armv8" | "armv7" | "armv6" | "x86_64" | "x86_32";
                 staticPerformance?: string;
                 clockSpeedGigaHertz?: number;
-                additionalProperties?: false;
+                additionalProperties?: never;
             };
             shareType?: "cb-normal-share" | "ce-airplay-share" | "ce-direct-share" | "ce-gui-loopback-share" | "ce-input-source-share" | "ce-input-source-share-hdmi" | "ce-input-source-share-usbc" | "ce-jpg-share" | "ce-miracast-share" | "mcs-normal-share" | "mcs-normal-audio-share" | "mcs-hfps-share" | "mcs-hfps-audio-share";
             videoDisplayMode?: "grid-view" | "active-speaker-view";
-            videoLayoutType?: "stack" | "stackWithShare" | "sideBySide" | "sideBySideWithShare" | "grid" | "floatingActive" | "floatingThumbnail" | "floatingGrid" | "overlay" | "focus" | "prominent" | "focusWithShare" | "prominentWithShare" | "equal" | "equalWithShare" | "largeGallery";
+            videoLayoutType?: "auto" | "stack" | "stackWithShare" | "sideBySide" | "sideBySideWithShare" | "grid" | "floatingActive" | "floatingThumbnail" | "floatingGrid" | "overlay" | "focus" | "prominent" | "focusWithShare" | "prominentWithShare" | "equal" | "equalWithShare" | "largeGallery" | "autoWithShare";
+            appliedLayout?: "auto" | "stack" | "stackWithShare" | "sideBySide" | "sideBySideWithShare" | "grid" | "floatingActive" | "floatingThumbnail" | "floatingGrid" | "overlay" | "focus" | "prominent" | "focusWithShare" | "prominentWithShare" | "equal" | "equalWithShare" | "largeGallery" | "autoWithShare";
             videoRenderType?: "wme" | "client_d3d" | "client_gdi";
             vdiInfo?: {};
             is64BitsClient?: boolean;
@@ -153,14 +187,31 @@ export default class CallDiagnosticMetrics extends StatelessWebexPlugin {
             vendorId?: string;
             staticPerformanceLevel?: string;
             staticPerformanceScore?: number;
-            additionalProperties?: false;
+            preInstalledTime?: string;
+            preInstalledType?: "installer" | "launcher" | "app";
+            preInstalledVersion?: string;
+            additionalProperties?: never;
+        };
+        installerInfo?: {
+            packageSuffix?: string;
+            packageArch?: string;
+            launchId?: string;
+            packageCount?: number;
+            totalSize?: number;
+            additionalProperties?: never;
         };
         emmVendorId?: string;
         isHybridMedia?: boolean;
         originData?: {};
         serviceVersion?: string;
-        additionalProperties?: false;
+        additionalProperties?: never;
     };
+    /**
+     * Returns the signed-in user's CI ID derived from credentials tokens.
+     * Used as a fallback when no device is registered.
+     * @returns the userId, or undefined if it can't be determined
+     */
+    private getUserIdFromCredentials;
     /**
      * Gather identifier details for call diagnostic payload.
      * @throws Error if initialization fails.
@@ -172,6 +223,7 @@ export default class CallDiagnosticMetrics extends StatelessWebexPlugin {
         participantId?: string;
         breakoutGroupId?: string;
         breakoutMoveId?: string;
+        breakoutTrackingId?: string;
         breakoutSessionId?: string;
         browserId?: string;
         ciExchangeTokenUrl?: string;
@@ -183,7 +235,7 @@ export default class CallDiagnosticMetrics extends StatelessWebexPlugin {
             imiAppId: string;
             sessionId: string;
             sessionInstanceId: string;
-            additionalProperties?: false;
+            additionalProperties?: never;
         };
         csdmDeviceUrl?: string;
         destinationBreakoutSessionId?: string;
@@ -200,6 +252,7 @@ export default class CallDiagnosticMetrics extends StatelessWebexPlugin {
         callId?: string;
         pairCallId?: string;
         llmWebsocketUrl?: string;
+        locusCluster?: string;
         locusId?: string;
         locusJoinUrl?: string;
         locusSessionId?: string;
@@ -217,6 +270,7 @@ export default class CallDiagnosticMetrics extends StatelessWebexPlugin {
         msteamsTenantGuid?: string;
         msteamsConferenceId?: string;
         msteamsMeetingId?: string;
+        mtid?: string;
         oauth2ClientId?: string;
         orgId?: string;
         provisionalCorrelationId?: string;
@@ -227,7 +281,7 @@ export default class CallDiagnosticMetrics extends StatelessWebexPlugin {
         sipSessionId?: {
             local?: string;
             remote?: string;
-            additionalProperties?: false;
+            additionalProperties?: never;
         };
         sipUri?: string;
         subConfId?: string;
@@ -255,13 +309,14 @@ export default class CallDiagnosticMetrics extends StatelessWebexPlugin {
         idForEndpointAB?: string;
         customerOrgId?: string;
         correlationId: string;
-        additionalProperties?: false;
+        additionalProperties?: never;
     } | {
         aggregatedBreakoutMoveId?: string;
         attendeeId?: string;
         participantId?: string;
         breakoutGroupId?: string;
         breakoutMoveId?: string;
+        breakoutTrackingId?: string;
         breakoutSessionId?: string;
         browserId?: string;
         ciExchangeTokenUrl?: string;
@@ -273,7 +328,7 @@ export default class CallDiagnosticMetrics extends StatelessWebexPlugin {
             imiAppId: string;
             sessionId: string;
             sessionInstanceId: string;
-            additionalProperties?: false;
+            additionalProperties?: never;
         };
         csdmDeviceUrl?: string;
         destinationBreakoutSessionId?: string;
@@ -290,6 +345,7 @@ export default class CallDiagnosticMetrics extends StatelessWebexPlugin {
         callId?: string;
         pairCallId?: string;
         llmWebsocketUrl?: string;
+        locusCluster?: string;
         locusId?: string;
         locusJoinUrl?: string;
         locusSessionId?: string;
@@ -307,6 +363,7 @@ export default class CallDiagnosticMetrics extends StatelessWebexPlugin {
         msteamsTenantGuid?: string;
         msteamsConferenceId?: string;
         msteamsMeetingId?: string;
+        mtid?: string;
         oauth2ClientId?: string;
         orgId?: string;
         provisionalCorrelationId?: string;
@@ -317,7 +374,7 @@ export default class CallDiagnosticMetrics extends StatelessWebexPlugin {
         sipSessionId?: {
             local?: string;
             remote?: string;
-            additionalProperties?: false;
+            additionalProperties?: never;
         };
         sipUri?: string;
         subConfId?: string;
@@ -345,13 +402,14 @@ export default class CallDiagnosticMetrics extends StatelessWebexPlugin {
         idForEndpointAB?: string;
         customerOrgId?: string;
         correlationId: string;
-        additionalProperties?: false;
+        additionalProperties?: never;
     } | {
         aggregatedBreakoutMoveId?: string;
         attendeeId?: string;
         participantId?: string;
         breakoutGroupId?: string;
         breakoutMoveId?: string;
+        breakoutTrackingId?: string;
         breakoutSessionId?: string;
         browserId?: string;
         ciExchangeTokenUrl?: string;
@@ -363,7 +421,7 @@ export default class CallDiagnosticMetrics extends StatelessWebexPlugin {
             imiAppId: string;
             sessionId: string;
             sessionInstanceId: string;
-            additionalProperties?: false;
+            additionalProperties?: never;
         };
         csdmDeviceUrl?: string;
         destinationBreakoutSessionId?: string;
@@ -380,6 +438,7 @@ export default class CallDiagnosticMetrics extends StatelessWebexPlugin {
         callId?: string;
         pairCallId?: string;
         llmWebsocketUrl?: string;
+        locusCluster?: string;
         locusId?: string;
         locusJoinUrl?: string;
         locusSessionId?: string;
@@ -397,6 +456,7 @@ export default class CallDiagnosticMetrics extends StatelessWebexPlugin {
         msteamsTenantGuid?: string;
         msteamsConferenceId?: string;
         msteamsMeetingId?: string;
+        mtid?: string;
         oauth2ClientId?: string;
         orgId?: string;
         provisionalCorrelationId?: string;
@@ -407,7 +467,7 @@ export default class CallDiagnosticMetrics extends StatelessWebexPlugin {
         sipSessionId?: {
             local?: string;
             remote?: string;
-            additionalProperties?: false;
+            additionalProperties?: never;
         };
         sipUri?: string;
         subConfId?: string;
@@ -435,7 +495,7 @@ export default class CallDiagnosticMetrics extends StatelessWebexPlugin {
         idForEndpointAB?: string;
         customerOrgId?: string;
         correlationId: string;
-        additionalProperties?: false;
+        additionalProperties?: never;
     };
     /**
      * Create diagnostic event, which can hold client event, feature event or MQE event data.
@@ -488,16 +548,16 @@ export default class CallDiagnosticMetrics extends StatelessWebexPlugin {
      * @param arg.clientErrorCode
      * @param arg.serviceErrorCode
      * @param arg.payloadOverrides
-     * @param arg.httpStatusCode
+     * @param arg.httpCode
      * @returns
      */
-    getErrorPayloadForClientErrorCode({ clientErrorCode, serviceErrorCode, serviceErrorName, rawErrorMessage, payloadOverrides, httpStatusCode, }: {
+    getErrorPayloadForClientErrorCode({ clientErrorCode, serviceErrorCode, serviceErrorName, rawErrorMessage, payloadOverrides, httpCode, }: {
         clientErrorCode: number;
         serviceErrorCode: any;
         serviceErrorName?: any;
         rawErrorMessage?: string;
         payloadOverrides?: any;
-        httpStatusCode?: number;
+        httpCode?: number;
     }): ClientEventError;
     /**
      * Clear the error cache

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

@@ -2,6 +2,8 @@ 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 LOCUS_RATE_LIMITED_OUTGOING_CLIENT_CODE = 1002;
+export declare const LOCUS_UNAVAILABLE_CLIENT_CODE = 1003;
 export declare const NETWORK_ERROR = 1026;
 export declare const NEW_LOCUS_ERROR_CLIENT_CODE = 4008;
 export declare const MEETING_INFO_LOOKUP_ERROR_CLIENT_CODE = 4100;
@@ -102,11 +104,13 @@ export declare const ERROR_DESCRIPTIONS: {
     WEBRTC_API_NOT_AVAILABLE: string;
     WDM_RESTRICTED_REGION: string;
     USER_NOT_ALLOWED_JOIN_WEBINAR: string;
+    INVALID_MEETING_INFO: string;
 };
 export declare const SERVICE_ERROR_CODES_TO_CLIENT_ERROR_CODES_MAP: {
     58400: number;
     99002: number;
     99009: number;
+    99019: number;
     58500: number;
     400001: number;
     403004: number;
@@ -134,6 +138,7 @@ export declare const SERVICE_ERROR_CODES_TO_CLIENT_ERROR_CODES_MAP: {
     423001: number;
     423005: number;
     423006: number;
+    423008: number;
     423010: number;
     423012: number;
     423013: number;
@@ -147,6 +152,7 @@ export declare const SERVICE_ERROR_CODES_TO_CLIENT_ERROR_CODES_MAP: {
     403037: number;
     403003: number;
     403030: number;
+    403106: number;
     2403001: number;
     2403002: number;
     2403003: number;

package/dist/types/config.d.ts

@@ -8,10 +8,19 @@ declare namespace _default {
     }
     export namespace metrics_1 {
         const appType: string;
+        namespace unhandledExceptionTelemetry {
+            const enabled: boolean;
+        }
+        namespace networkTelemetry {
+            const enabled_1: boolean;
+            export { enabled_1 as enabled };
+            export const intervalMs: number;
+        }
         const batcherWait: number;
         const batcherMaxCalls: number;
         const batcherMaxWait: number;
         const batcherRetryPlateau: number;
+        const batcherRetryOnNetworkError: boolean;
         const waitForServiceTimeout: number;
     }
     export { metrics_1 as metrics };

package/dist/types/index.d.ts

@@ -4,7 +4,8 @@
 import config from './config';
 import NewMetrics from './new-metrics';
 import * as Utils from './utils';
-import { ClientEvent, ClientEventLeaveReason, SubmitBehavioralEvent, SubmitClientEvent, SubmitInternalEvent, SubmitOperationalEvent, SubmitBusinessEvent, SubmitMQE, PreComputedLatencies, SubmitFeatureEvent } from './metrics.types';
+import * as AutomatedUserUtils from './automated-user';
+import { ClientEvent, ClientEventLeaveReason, SubmitBehavioralEvent, SubmitClientEvent, SubmitInternalEvent, SubmitOperationalEvent, SubmitBusinessEvent, SubmitMQE, PreComputedLatencies, SubmitFeatureEvent, LocusSyncLatencyEventName, PrivacyAndSecurityPermission } 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,5 +16,6 @@ import BusinessMetrics from './business-metrics';
 import RtcMetrics from './rtcMetrics';
 import PreLoginMetrics from './prelogin-metrics';
 export { default, getOSNameInternal } from './metrics';
-export { config, CALL_DIAGNOSTIC_CONFIG, NewMetrics, Utils, CallDiagnosticUtils, CallDiagnosticLatencies, CallDiagnosticMetrics, BehavioralMetrics, OperationalMetrics, BusinessMetrics, RtcMetrics, PreLoginMetrics, };
-export type { ClientEvent, ClientEventLeaveReason, SubmitBehavioralEvent, SubmitClientEvent, SubmitInternalEvent, SubmitMQE, SubmitOperationalEvent, SubmitBusinessEvent, PreComputedLatencies, SubmitFeatureEvent, };
+export { config, CALL_DIAGNOSTIC_CONFIG, AutomatedUserUtils, NewMetrics, Utils, CallDiagnosticUtils, CallDiagnosticLatencies, CallDiagnosticMetrics, BehavioralMetrics, OperationalMetrics, BusinessMetrics, RtcMetrics, PreLoginMetrics, };
+export { isAutomatedUser, isAutomatedUserAgent } from './automated-user';
+export type { ClientEvent, ClientEventLeaveReason, SubmitBehavioralEvent, SubmitClientEvent, SubmitInternalEvent, SubmitMQE, SubmitOperationalEvent, SubmitBusinessEvent, PreComputedLatencies, SubmitFeatureEvent, LocusSyncLatencyEventName, PrivacyAndSecurityPermission, };

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

@@ -8,6 +8,9 @@ export type NewEnvironmentType = NonNullable<RawEvent['origin']['newEnvironment'
 export type ClientLaunchMethodType = NonNullable<RawEvent['origin']['clientInfo']>['clientLaunchMethod'];
 export type ClientUserNameInput = NonNullable<RawClientEvent['userNameInput']>;
 export type ClientEmailInput = NonNullable<RawClientEvent['emailInput']>;
+export type PrivacyAndSecurityPermission = NonNullable<RawClientEvent['privacyAndSecurityPermission']>;
+export type PrivacyAndSecurityPermissionResource = keyof PrivacyAndSecurityPermission;
+export type PrivacyAndSecurityPermissionState = PrivacyAndSecurityPermission[PrivacyAndSecurityPermissionResource];
 export type BrowserLaunchMethodType = NonNullable<RawEvent['origin']['clientInfo']>['browserLaunchMethod'];
 export type MetricEventProduct = 'webex' | 'wxcc_desktop' | 'wxcc_crm' | 'wxcc_sdk';
 export type MetricEventAgent = 'user' | 'browser' | 'system' | 'sdk' | 'redux' | 'service' | 'api';
@@ -27,6 +30,7 @@ export type SubmitClientEventOptions = {
     browserLaunchMethod?: BrowserLaunchMethodType;
     webexConferenceIdStr?: string;
     globalMeetingId?: string;
+    locusCluster?: string;
     joinFlowVersion?: MetricEventJoinFlowVersion;
     meetingJoinPhase?: MetricEventMeetingJoinPhase;
     triggeredTime?: string;
@@ -41,8 +45,10 @@ export type SubmitMQEOptions = {
     webexConferenceIdStr?: string;
     globalMeetingId?: string;
 };
+export declare const LOCUS_SYNC_LATENCY_EVENT_NAMES: readonly ["internal.client.locus.sync.start", "internal.client.locus.hashtree.request", "internal.client.locus.hashtree.response", "internal.client.locus.sync.request", "internal.client.locus.sync.response", "internal.client.locus.sync.message.received"];
+export type LocusSyncLatencyEventName = (typeof LOCUS_SYNC_LATENCY_EVENT_NAMES)[number];
 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' | 'internal.client.share.initiated' | 'internal.client.share.stopped';
+    name: 'internal.client.meetinginfo.request' | 'internal.client.meetinginfo.response' | 'internal.register.device.request' | 'internal.register.device.response' | 'internal.reset.join.latencies' | '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' | LocusSyncLatencyEventName;
     payload?: never;
     options?: never;
 };
@@ -107,10 +113,10 @@ export type ClientInfo = NonNullable<RawEvent['origin']['clientInfo']>;
 export type ClientType = NonNullable<RawEvent['origin']['clientInfo']>['clientType'];
 export type SubClientType = NonNullable<RawEvent['origin']['clientInfo']>['subClientType'];
 export type NetworkType = NonNullable<RawEvent['origin']>['networkType'];
-export type ClientSubServiceType = ClientEvent['payload']['webexSubServiceType'];
+export type ClientSubServiceType = NonNullable<ClientEvent['payload']>['webexSubServiceType'];
 export type ClientEventPayload = RecursivePartial<ClientEvent['payload']>;
-export type ClientEventLeaveReason = ClientEvent['payload']['leaveReason'];
-export type ClientEventPayloadError = ClientEvent['payload']['errors'];
+export type ClientEventLeaveReason = NonNullable<ClientEvent['payload']>['leaveReason'];
+export type ClientEventPayloadError = NonNullable<ClientEvent['payload']>['errors'];
 export type ClientFeatureEventPayload = RecursivePartial<FeatureEvent['payload']>;
 export type MediaQualityEventAudioSetupDelayPayload = NonNullable<MediaQualityEvent['payload']>['audioSetupDelay'];
 export type MediaQualityEventVideoSetupDelayPayload = NonNullable<MediaQualityEvent['payload']>['videoSetupDelay'];
@@ -154,7 +160,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.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 type PreComputedLatencies = 'internal.client.pageJMT' | 'internal.download.time' | 'internal.get.cluster.time' | 'internal.click.to.interstitial' | 'internal.click.to.interstitial.with.user.delay' | 'internal.click.to.interstitial.for.client.jmt' | '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' | 'internal.client.locus.sync.random.backoff';
 export interface IdType {
     meetingId?: string;
     callId?: string;

package/dist/types/network-telemetry.d.ts

@@ -0,0 +1,108 @@
+export declare const NETWORK_REQUEST_SUMMARY_METRIC = "JS_SDK_NETWORK_REQUEST_SUMMARY";
+export declare const NETWORK_TELEMETRY_INTERVAL_MS: number;
+type Headers = Record<string, unknown>;
+type MetricsSummary = {
+    totalSendRequest: number;
+    totalFailedRequest: number;
+    totalRecvdResponse: number;
+    totalFailedResponse: number;
+};
+type RequestMetric = {
+    host: string;
+    endPoint: string;
+    countSendRequest: number;
+    countFailedRequest: number;
+    countRecvdResponse: number;
+    countFailedResponse: number;
+    averageNetworkDurationMs: number;
+    maxNetworkDurationP90Ms: number;
+    maxNetworkDurationP99Ms: number;
+};
+export type NetworkErrorMetric = {
+    host: string;
+    endPoint: string;
+    statusCode: number;
+    errorCode: string;
+    method: string;
+    errorType: string;
+    errorMessage: string;
+    trackingIds: string[];
+    countError: number;
+};
+export type NetworkTelemetry = {
+    metricsSummary: MetricsSummary;
+    metrics: RequestMetric[];
+    errorMetrics: NetworkErrorMetric[];
+    errorMetricsSummary: Record<string, {
+        count: number;
+    }>;
+};
+type ErrorDetails = {
+    code?: number | string;
+    errorCode?: number | string;
+    message?: string;
+    name?: string;
+};
+type RequestOptions = {
+    api?: string;
+    headers?: Headers;
+    method?: string;
+    resource?: string;
+    service?: string;
+    timeout?: number;
+    uri?: string;
+    url?: string;
+    $timings?: {
+        networkEnd?: number;
+        networkStart?: number;
+    };
+};
+type RequestFailure = ErrorDetails & {
+    body?: ErrorDetails | string;
+    status?: number;
+    statusCode?: number;
+};
+type NetworkMetricProperties = {
+    type: 'operational';
+    tags: Record<string, string>;
+    fields: MetricsSummary;
+    eventPayload: NetworkTelemetry;
+};
+type NetworkTelemetryCollectorOptions = {
+    intervalMs?: number;
+    onSubmissionFailure: () => void;
+    submitMetric: (name: string, properties: NetworkMetricProperties) => unknown;
+};
+type NetworkTelemetryCollector = {
+    recordRequest: (options?: RequestOptions) => void;
+    recordResponse: (options?: RequestOptions) => void;
+    recordFailure: (options?: RequestOptions, reason?: RequestFailure) => void;
+    flush: () => Promise<void>;
+    stop: () => Promise<void>;
+};
+/**
+ * Removes query data and redacts dynamic-looking endpoint segments.
+ * @param resource SDK resource path.
+ * @returns The normalized endpoint.
+ */
+export declare function getOperation(resource?: string): string;
+/**
+ * Excludes the transports used to submit telemetry, preventing self-reporting.
+ * @param options Request options.
+ * @returns Whether the request should be tracked.
+ */
+export declare function shouldTrackNetworkRequest(options?: RequestOptions): boolean;
+/**
+ * Creates the error entry produced by one failed request.
+ * @param options Request options.
+ * @param reason Request failure.
+ * @returns The normalized error metric.
+ */
+export declare function createNetworkErrorMetric(options?: RequestOptions, reason?: RequestFailure): NetworkErrorMetric;
+/**
+ * Creates a network telemetry collector and starts its periodic timer.
+ * @param options Submission callbacks.
+ * @returns The network telemetry collector.
+ */
+export declare function createNetworkTelemetryCollector({ intervalMs, onSubmissionFailure, submitMetric, }: NetworkTelemetryCollectorOptions): NetworkTelemetryCollector;
+export {};

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

@@ -4,7 +4,7 @@ import BehavioralMetrics from './behavioral-metrics';
 import OperationalMetrics from './operational-metrics';
 import BusinessMetrics from './business-metrics';
 import PreLoginMetrics from './prelogin-metrics';
-import { RecursivePartial, MetricEventProduct, MetricEventAgent, MetricEventVerb, ClientEvent, FeatureEvent, EventPayload, MediaQualityEvent, InternalEvent, SubmitClientEventOptions, Table, DelayedClientEvent, DelayedClientFeatureEvent } from './metrics.types';
+import { RecursivePartial, MetricEventProduct, MetricEventAgent, MetricEventVerb, ClientEvent, FeatureEvent, EventPayload, MediaQualityEvent, InternalEvent, SubmitClientEventOptions, Table, DelayedClientEvent, DelayedClientFeatureEvent, PrivacyAndSecurityPermission } from './metrics.types';
 import CallDiagnosticLatencies from './call-diagnostic/call-diagnostic-metrics-latencies';
 /**
  * Metrics plugin to centralize all types of metrics.
@@ -33,6 +33,7 @@ declare class Metrics extends WebexPlugin {
      */
     delayedClientEventsOverrides: Partial<DelayedClientEvent['options']>;
     delayedClientFeatureEventsOverrides: Partial<DelayedClientFeatureEvent['options']>;
+    private privacyAndSecurityPermissionEnricher;
     /**
      * Constructor
      * @param args
@@ -78,6 +79,10 @@ declare class Metrics extends WebexPlugin {
      * @returns true once we have the deviceId we need to submit business events
      */
     isReadyToSubmitBusinessEvents(): boolean;
+    /**
+     * @returns whether the current user agent belongs to an automated user
+     */
+    isAutomatedUser(): boolean;
     /**
      * Behavioral event
      * @param args
@@ -147,6 +152,17 @@ declare class Metrics extends WebexPlugin {
         payload?: RecursivePartial<ClientEvent['payload']>;
         options?: SubmitClientEventOptions;
     }): Promise<any>;
+    /**
+     * Stores the latest browser permission state supplied by the client.
+     * @param permission latest normalized permission snapshot
+     */
+    setPrivacyAndSecurityPermission(permission: PrivacyAndSecurityPermission): void;
+    /**
+     * Resolves event options to the call identity used by Call Diagnostic where possible.
+     * @param options client event options
+     * @returns the permission history scope
+     */
+    private getPermissionScope;
     /**
      * Issue request to alias a user's pre-login ID with their CI UUID
      * @param {string} preLoginId