Skip to content

Commit 2530726

Browse files
fuzzybinaryfuzzybinary
committed
Merge branch 'master' into jward/RUM-7416-rum-cpp
# Conflicts: # lib/cjs/generated/telemetry.d.ts # lib/esm/generated/telemetry.d.ts
2 parents 8e7b64e + 20f414a commit 2530726

21 files changed

Lines changed: 281 additions & 58 deletions

‎lib/cjs/generated/browserProfiling.d.ts‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -274,7 +274,7 @@ export interface RumProfilerVitalEntry {
274274
/**
275275
* Duration in ms of the vital.
276276
*/
277-
readonly duration: number;
277+
readonly duration?: number;
278278
startClocks: ClocksState;
279279
[k: string]: unknown;
280280
}
@@ -293,7 +293,7 @@ export interface RumProfilerActionEntry {
293293
/**
294294
* Duration in ms of the duration vital.
295295
*/
296-
readonly duration: number;
296+
readonly duration?: number;
297297
startClocks: ClocksState;
298298
[k: string]: unknown;
299299
}

‎lib/cjs/generated/mobileSessionReplay.d.ts‎

Lines changed: 20 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -50,6 +50,10 @@ export declare type ShapeWireframe = CommonShapeWireframe & {
5050
* The type of the wireframe.
5151
*/
5252
readonly type: 'shape';
53+
/**
54+
* A globally unique and stable identifier for this UI element, computed as the hash of the element's path (32 lowercase hex characters). Used to correlate wireframes with RUM action events.
55+
*/
56+
readonly permanentId?: string;
5357
};
5458
/**
5559
* Schema of common properties for ShapeWireframe events type and all its sub - types.
@@ -102,6 +106,10 @@ export declare type TextWireframe = CommonShapeWireframe & {
102106
text: string;
103107
textStyle: TextStyle;
104108
textPosition?: TextPosition;
109+
/**
110+
* A globally unique and stable identifier for this UI element, computed as the hash of the element's path (32 lowercase hex characters). Used to correlate wireframes with RUM action events.
111+
*/
112+
readonly permanentId?: string;
105113
};
106114
/**
107115
* Schema of all properties of a TextStyle.
@@ -181,6 +189,10 @@ export declare type ImageWireframe = CommonShapeWireframe & {
181189
* Flag describing an image wireframe that should render an empty state placeholder
182190
*/
183191
isEmpty?: boolean;
192+
/**
193+
* A globally unique and stable identifier for this UI element, computed as the hash of the element's path (32 lowercase hex characters). Used to correlate wireframes with RUM action events.
194+
*/
195+
readonly permanentId?: string;
184196
};
185197
/**
186198
* Schema of all properties of a PlaceholderWireframe.
@@ -194,6 +206,10 @@ export declare type PlaceholderWireframe = CommonWireframe & {
194206
* Label of the placeholder
195207
*/
196208
label?: string;
209+
/**
210+
* A globally unique and stable identifier for this UI element, computed as the hash of the element's path (32 lowercase hex characters). Used to correlate wireframes with RUM action events.
211+
*/
212+
readonly permanentId?: string;
197213
};
198214
/**
199215
* Schema of all properties of a WebviewWireframe.
@@ -211,6 +227,10 @@ export declare type WebviewWireframe = CommonShapeWireframe & {
211227
* Whether this webview is visible or not.
212228
*/
213229
readonly isVisible?: boolean;
230+
/**
231+
* A globally unique and stable identifier for this UI element, computed as the hash of the element's path (32 lowercase hex characters). Used to correlate wireframes with RUM action events.
232+
*/
233+
readonly permanentId?: string;
214234
};
215235
/**
216236
* Mobile-specific. Schema of a Record type which contains mutations of a screen.
@@ -541,10 +561,6 @@ export interface CommonWireframe {
541561
*/
542562
readonly height: number;
543563
clip?: WireframeClip;
544-
/**
545-
* A globally unique and stable identifier for this UI element, computed as the hash of the element's path (32 lowercase hex characters). Used to correlate wireframes with RUM action events.
546-
*/
547-
readonly permanentId?: string;
548564
}
549565
/**
550566
* Schema of clipping information for a Wireframe.

‎lib/cjs/generated/rum.d.ts‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -131,10 +131,6 @@ export declare type RumActionEvent = CommonProperties & ViewContainerSchema & {
131131
* CSS selector path of the target element
132132
*/
133133
readonly selector?: string;
134-
/**
135-
* Mobile-only: a globally unique and stable identifier for this UI element, computed as the hash of the element's path (32 lowercase hex characters). Used to correlate actions with mobile session replay wireframes.
136-
*/
137-
readonly permanent_id?: string;
138134
/**
139135
* Width of the target element (in pixels)
140136
*/
@@ -143,6 +139,10 @@ export declare type RumActionEvent = CommonProperties & ViewContainerSchema & {
143139
* Height of the target element (in pixels)
144140
*/
145141
readonly height?: number;
142+
/**
143+
* Mobile-only: a globally unique and stable identifier for this UI element, computed as the hash of the element's path (32 lowercase hex characters). Used to correlate actions with mobile session replay wireframes.
144+
*/
145+
readonly permanent_id?: string;
146146
[k: string]: unknown;
147147
};
148148
/**

‎lib/cjs/generated/sessionReplay.d.ts‎

Lines changed: 20 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -591,6 +591,10 @@ export declare type ShapeWireframe = CommonShapeWireframe & {
591591
* The type of the wireframe.
592592
*/
593593
readonly type: 'shape';
594+
/**
595+
* A globally unique and stable identifier for this UI element, computed as the hash of the element's path (32 lowercase hex characters). Used to correlate wireframes with RUM action events.
596+
*/
597+
readonly permanentId?: string;
594598
};
595599
/**
596600
* Schema of common properties for ShapeWireframe events type and all its sub - types.
@@ -643,6 +647,10 @@ export declare type TextWireframe = CommonShapeWireframe & {
643647
text: string;
644648
textStyle: TextStyle;
645649
textPosition?: TextPosition;
650+
/**
651+
* A globally unique and stable identifier for this UI element, computed as the hash of the element's path (32 lowercase hex characters). Used to correlate wireframes with RUM action events.
652+
*/
653+
readonly permanentId?: string;
646654
};
647655
/**
648656
* Schema of all properties of a TextStyle.
@@ -722,6 +730,10 @@ export declare type ImageWireframe = CommonShapeWireframe & {
722730
* Flag describing an image wireframe that should render an empty state placeholder
723731
*/
724732
isEmpty?: boolean;
733+
/**
734+
* A globally unique and stable identifier for this UI element, computed as the hash of the element's path (32 lowercase hex characters). Used to correlate wireframes with RUM action events.
735+
*/
736+
readonly permanentId?: string;
725737
};
726738
/**
727739
* Schema of all properties of a PlaceholderWireframe.
@@ -735,6 +747,10 @@ export declare type PlaceholderWireframe = CommonWireframe & {
735747
* Label of the placeholder
736748
*/
737749
label?: string;
750+
/**
751+
* A globally unique and stable identifier for this UI element, computed as the hash of the element's path (32 lowercase hex characters). Used to correlate wireframes with RUM action events.
752+
*/
753+
readonly permanentId?: string;
738754
};
739755
/**
740756
* Schema of all properties of a WebviewWireframe.
@@ -752,6 +768,10 @@ export declare type WebviewWireframe = CommonShapeWireframe & {
752768
* Whether this webview is visible or not.
753769
*/
754770
readonly isVisible?: boolean;
771+
/**
772+
* A globally unique and stable identifier for this UI element, computed as the hash of the element's path (32 lowercase hex characters). Used to correlate wireframes with RUM action events.
773+
*/
774+
readonly permanentId?: string;
755775
};
756776
/**
757777
* Mobile-specific. Schema of a Record type which contains mutations of a screen.
@@ -1347,10 +1367,6 @@ export interface CommonWireframe {
13471367
*/
13481368
readonly height: number;
13491369
clip?: WireframeClip;
1350-
/**
1351-
* A globally unique and stable identifier for this UI element, computed as the hash of the element's path (32 lowercase hex characters). Used to correlate wireframes with RUM action events.
1352-
*/
1353-
readonly permanentId?: string;
13541370
}
13551371
/**
13561372
* Schema of clipping information for a Wireframe.

‎lib/cjs/generated/telemetry.d.ts‎

Lines changed: 48 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -4,11 +4,11 @@
44
/**
55
* Schema of all properties of a telemetry event
66
*/
7-
export declare type TelemetryEvent = TelemetryErrorEvent | TelemetryDebugEvent | TelemetryConfigurationEvent | TelemetryUsageEvent;
7+
export type TelemetryEvent = TelemetryErrorEvent | TelemetryDebugEvent | TelemetryConfigurationEvent | TelemetryUsageEvent;
88
/**
99
* Schema of all properties of a telemetry error event
1010
*/
11-
export declare type TelemetryErrorEvent = CommonTelemetryProperties & {
11+
export type TelemetryErrorEvent = CommonTelemetryProperties & {
1212
/**
1313
* The telemetry log information
1414
*/
@@ -46,7 +46,7 @@ export declare type TelemetryErrorEvent = CommonTelemetryProperties & {
4646
/**
4747
* Schema of all properties of a telemetry debug event
4848
*/
49-
export declare type TelemetryDebugEvent = CommonTelemetryProperties & {
49+
export type TelemetryDebugEvent = CommonTelemetryProperties & {
5050
/**
5151
* The telemetry log information
5252
*/
@@ -70,7 +70,7 @@ export declare type TelemetryDebugEvent = CommonTelemetryProperties & {
7070
/**
7171
* Schema of all properties of a telemetry configuration event
7272
*/
73-
export declare type TelemetryConfigurationEvent = CommonTelemetryProperties & {
73+
export type TelemetryConfigurationEvent = CommonTelemetryProperties & {
7474
/**
7575
* The telemetry configuration information
7676
*/
@@ -474,7 +474,7 @@ export declare type TelemetryConfigurationEvent = CommonTelemetryProperties & {
474474
/**
475475
* Schema of all properties of a telemetry usage event
476476
*/
477-
export declare type TelemetryUsageEvent = CommonTelemetryProperties & {
477+
export type TelemetryUsageEvent = CommonTelemetryProperties & {
478478
/**
479479
* The telemetry usage information
480480
*/
@@ -491,15 +491,15 @@ export declare type TelemetryUsageEvent = CommonTelemetryProperties & {
491491
/**
492492
* Schema of features usage common across SDKs
493493
*/
494-
export declare type TelemetryCommonFeaturesUsage = SetTrackingConsent | StopSession | StartView | SetViewContext | SetViewContextProperty | SetViewName | GetViewContext | AddAction | AddError | GetGlobalContext | SetGlobalContext | SetGlobalContextProperty | RemoveGlobalContextProperty | ClearGlobalContext | GetUser | SetUser | SetUserProperty | RemoveUserProperty | ClearUser | GetAccount | SetAccount | SetAccountProperty | RemoveAccountProperty | ClearAccount | AddFeatureFlagEvaluation | AddOperationStepVital | GraphQLRequest;
494+
export type TelemetryCommonFeaturesUsage = SetTrackingConsent | StopSession | StartView | SetViewContext | SetViewContextProperty | SetViewName | GetViewContext | AddAction | AddError | GetGlobalContext | SetGlobalContext | SetGlobalContextProperty | RemoveGlobalContextProperty | ClearGlobalContext | GetUser | SetUser | SetUserProperty | RemoveUserProperty | ClearUser | GetAccount | SetAccount | SetAccountProperty | RemoveAccountProperty | ClearAccount | AddFeatureFlagEvaluation | AddOperationStepVital | GraphQLRequest;
495495
/**
496496
* Schema of browser specific features usage
497497
*/
498-
export declare type TelemetryBrowserFeaturesUsage = StartSessionReplayRecording | StartDurationVital | StopDurationVital | AddDurationVital;
498+
export type TelemetryBrowserFeaturesUsage = StartSessionReplayRecording | StartDurationVital | StopDurationVital | AddDurationVital | StartAction | StopAction | StartResource | StopResource;
499499
/**
500500
* Schema of mobile specific features usage
501501
*/
502-
export declare type TelemetryMobileFeaturesUsage = AddViewLoadingTime | TrackWebView;
502+
export type TelemetryMobileFeaturesUsage = AddViewLoadingTime | TrackWebView | AndroidNetworkInstrumentation;
503503
/**
504504
* Schema of common properties of Telemetry events
505505
*/
@@ -529,7 +529,7 @@ export interface CommonTelemetryProperties {
529529
/**
530530
* The source of this event
531531
*/
532-
readonly source: 'android' | 'ios' | 'browser' | 'flutter' | 'react-native' | 'unity' | 'kotlin-multiplatform' | 'electron' | 'rum-cpp';
532+
readonly source: 'android' | 'ios' | 'browser' | 'flutter' | 'react-native' | 'unity' | 'kotlin-multiplatform' | 'electron';
533533
/**
534534
* The version of the SDK generating the telemetry event
535535
*/
@@ -864,6 +864,34 @@ export interface AddDurationVital {
864864
feature: 'add-duration-vital';
865865
[k: string]: unknown;
866866
}
867+
export interface StartAction {
868+
/**
869+
* startAction API
870+
*/
871+
feature: 'start-action';
872+
[k: string]: unknown;
873+
}
874+
export interface StopAction {
875+
/**
876+
* stopAction API
877+
*/
878+
feature: 'stop-action';
879+
[k: string]: unknown;
880+
}
881+
export interface StartResource {
882+
/**
883+
* startResource API
884+
*/
885+
feature: 'start-resource';
886+
[k: string]: unknown;
887+
}
888+
export interface StopResource {
889+
/**
890+
* stopResource API
891+
*/
892+
feature: 'stop-resource';
893+
[k: string]: unknown;
894+
}
867895
export interface AddViewLoadingTime {
868896
/**
869897
* addViewLoadingTime API
@@ -890,3 +918,14 @@ export interface TrackWebView {
890918
feature: 'trackWebView';
891919
[k: string]: unknown;
892920
}
921+
export interface AndroidNetworkInstrumentation {
922+
/**
923+
* Android network instrumentation
924+
*/
925+
feature: 'androidNetworkInstrumentation';
926+
/**
927+
* The network instrumentation API used
928+
*/
929+
type: 'CRONET' | 'OKHTTP';
930+
[k: string]: unknown;
931+
}

‎lib/esm/generated/browserProfiling.d.ts‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -274,7 +274,7 @@ export interface RumProfilerVitalEntry {
274274
/**
275275
* Duration in ms of the vital.
276276
*/
277-
readonly duration: number;
277+
readonly duration?: number;
278278
startClocks: ClocksState;
279279
[k: string]: unknown;
280280
}
@@ -293,7 +293,7 @@ export interface RumProfilerActionEntry {
293293
/**
294294
* Duration in ms of the duration vital.
295295
*/
296-
readonly duration: number;
296+
readonly duration?: number;
297297
startClocks: ClocksState;
298298
[k: string]: unknown;
299299
}

‎lib/esm/generated/mobileSessionReplay.d.ts‎

Lines changed: 20 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -50,6 +50,10 @@ export declare type ShapeWireframe = CommonShapeWireframe & {
5050
* The type of the wireframe.
5151
*/
5252
readonly type: 'shape';
53+
/**
54+
* A globally unique and stable identifier for this UI element, computed as the hash of the element's path (32 lowercase hex characters). Used to correlate wireframes with RUM action events.
55+
*/
56+
readonly permanentId?: string;
5357
};
5458
/**
5559
* Schema of common properties for ShapeWireframe events type and all its sub - types.
@@ -102,6 +106,10 @@ export declare type TextWireframe = CommonShapeWireframe & {
102106
text: string;
103107
textStyle: TextStyle;
104108
textPosition?: TextPosition;
109+
/**
110+
* A globally unique and stable identifier for this UI element, computed as the hash of the element's path (32 lowercase hex characters). Used to correlate wireframes with RUM action events.
111+
*/
112+
readonly permanentId?: string;
105113
};
106114
/**
107115
* Schema of all properties of a TextStyle.
@@ -181,6 +189,10 @@ export declare type ImageWireframe = CommonShapeWireframe & {
181189
* Flag describing an image wireframe that should render an empty state placeholder
182190
*/
183191
isEmpty?: boolean;
192+
/**
193+
* A globally unique and stable identifier for this UI element, computed as the hash of the element's path (32 lowercase hex characters). Used to correlate wireframes with RUM action events.
194+
*/
195+
readonly permanentId?: string;
184196
};
185197
/**
186198
* Schema of all properties of a PlaceholderWireframe.
@@ -194,6 +206,10 @@ export declare type PlaceholderWireframe = CommonWireframe & {
194206
* Label of the placeholder
195207
*/
196208
label?: string;
209+
/**
210+
* A globally unique and stable identifier for this UI element, computed as the hash of the element's path (32 lowercase hex characters). Used to correlate wireframes with RUM action events.
211+
*/
212+
readonly permanentId?: string;
197213
};
198214
/**
199215
* Schema of all properties of a WebviewWireframe.
@@ -211,6 +227,10 @@ export declare type WebviewWireframe = CommonShapeWireframe & {
211227
* Whether this webview is visible or not.
212228
*/
213229
readonly isVisible?: boolean;
230+
/**
231+
* A globally unique and stable identifier for this UI element, computed as the hash of the element's path (32 lowercase hex characters). Used to correlate wireframes with RUM action events.
232+
*/
233+
readonly permanentId?: string;
214234
};
215235
/**
216236
* Mobile-specific. Schema of a Record type which contains mutations of a screen.
@@ -541,10 +561,6 @@ export interface CommonWireframe {
541561
*/
542562
readonly height: number;
543563
clip?: WireframeClip;
544-
/**
545-
* A globally unique and stable identifier for this UI element, computed as the hash of the element's path (32 lowercase hex characters). Used to correlate wireframes with RUM action events.
546-
*/
547-
readonly permanentId?: string;
548564
}
549565
/**
550566
* Schema of clipping information for a Wireframe.

‎lib/esm/generated/rum.d.ts‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -131,10 +131,6 @@ export declare type RumActionEvent = CommonProperties & ViewContainerSchema & {
131131
* CSS selector path of the target element
132132
*/
133133
readonly selector?: string;
134-
/**
135-
* Mobile-only: a globally unique and stable identifier for this UI element, computed as the hash of the element's path (32 lowercase hex characters). Used to correlate actions with mobile session replay wireframes.
136-
*/
137-
readonly permanent_id?: string;
138134
/**
139135
* Width of the target element (in pixels)
140136
*/
@@ -143,6 +139,10 @@ export declare type RumActionEvent = CommonProperties & ViewContainerSchema & {
143139
* Height of the target element (in pixels)
144140
*/
145141
readonly height?: number;
142+
/**
143+
* Mobile-only: a globally unique and stable identifier for this UI element, computed as the hash of the element's path (32 lowercase hex characters). Used to correlate actions with mobile session replay wireframes.
144+
*/
145+
readonly permanent_id?: string;
146146
[k: string]: unknown;
147147
};
148148
/**

0 commit comments

Comments
 (0)