@dynatrace/dtrum-api-types 1.249.3 → 1.251.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (3) hide show
  1. package/README.md +1 -1
  2. package/dtrum.d.ts +33 -36
  3. package/package.json +1 -1
package/README.md CHANGED
@@ -2,7 +2,7 @@
2
2
  This package contains the Typescript type information for the Dtrum Api of the javascript agent.
3
3
 
4
4
  Keep in mind that when the javascript agent is updated, this type package might not provide accurate types.
5
- Version: 1.249.3
5
+ Version: 1.251.1
6
6
 
7
7
  ## Installation
8
8
  > npm install --save-dev @dynatrace/dtrum-api-types
package/dtrum.d.ts CHANGED
@@ -111,6 +111,37 @@ export const enum ActionNameResult {
111
111
  INVALID_ACTION_ID = 3
112
112
  }
113
113
 
114
+ export interface MetaData {
115
+ /**
116
+ * An internally used id
117
+ *
118
+ * @hidden
119
+ */
120
+ id: string;
121
+ /**
122
+ * Specifies where the metadata is collected from:
123
+ * * CSS Selector
124
+ * * JavaScript Variable
125
+ * * Cookie
126
+ * * Query String
127
+ * * JavaScript Function
128
+ */
129
+ type: string;
130
+ /**
131
+ * How the metadata can be retrieved(cookie name, css selector, javascript variable name, ...)
132
+ */
133
+ expression: string;
134
+ /**
135
+ * The current value for the given expression
136
+ */
137
+ value: string | null;
138
+ /**
139
+ * Shows information about captured value
140
+ */
141
+ info?: string;
142
+ }
143
+
144
+
114
145
  export interface DtrumApi {
115
146
  /**
116
147
  * Enables/disables automatic action detection. Use when you want to instrument your application only manually.
@@ -157,16 +188,6 @@ export interface DtrumApi {
157
188
  * @returns false if the values were incorrect or the function has been called too late, true otherwise
158
189
  */
159
190
  markXHRFailed(responseCode: number, message: string, parentActionId?: number): boolean;
160
- /**
161
- * Force signal sending to make sure that actions aren't lost (e.g., use before a window unload event).
162
- *
163
- * @deprecated Use {@link sendBeacon} instead. We will remove "sendSignal" in June 2022.
164
- * @see {@link sendBeacon}
165
- * @param forceSync Force synchronous sending of signal (if false, it'll be sent asynchronously)
166
- * @param sendPreview Force sending of preview signals which haven't been closed yet.
167
- * @param killUnfinished Kills unfinished actions and sends them immediately. Handle with care, actions might be inaccurate.
168
- */
169
- sendSignal(forceSync: boolean, sendPreview: boolean, killUnfinished: boolean): void;
170
191
  /**
171
192
  * Forces beacon sending to make sure actions aren't lost.
172
193
  * For example, use before a window unload event by adding a {@link addPageLeavingListener}.
@@ -183,8 +204,7 @@ export interface DtrumApi {
183
204
  *
184
205
  * @see {@link leaveAction}
185
206
  * @param actionName Name of the action
186
- * @param actionType Type of the action (e.g., can be 'click', 'load', 'KD',...) -
187
- * DEPRECATED: not used any more, will be removed in June 2022.
207
+ * @param actionType DEPRECATED: not used any more and has no effect if provided
188
208
  * @param startTime Timestamp in milliseconds. if null, current time is used.
189
209
  * @param sourceUrl Source url for the action
190
210
  * @returns ID of the created action
@@ -282,28 +302,6 @@ export interface DtrumApi {
282
302
  * @param value The name of the user. For example, use a name, userid, or your user's email address.
283
303
  */
284
304
  identifyUser(value: string): void;
285
- /**
286
- * Indicates the start of a third party resource
287
- *
288
- * @deprecated Since modern browsers already provide resource timings, including for third parties,
289
- * we will remove this function in June 2022.
290
- * @param type 'i'...image, 's'...script, 'c'... custom
291
- * @param url Complete URL of resource
292
- */
293
- startThirdParty(type: ResourceSummaryTypes, url: string): void;
294
- /**
295
- * Indicates the stop of a third party resource
296
- *
297
- * @deprecated Since modern browsers already provide resource timings, including for third parties,
298
- * we will remove this function in June 2022.
299
- * @param url Complete URL of resource (must match URL provided in startThirdParty)
300
- * @param success True if the resource was loaded successfully, false if not
301
- * @param start Absolute start time in milliseconds. Optional. When parameter is not passed or <=0,
302
- * time of startThirdParty call is used
303
- * @param stop Absolute stop time in milliseconds. Optional. When parameter is not passed or <=0,
304
- * time of stopThirdParty call is used
305
- */
306
- stopThirdParty(url: string, success: boolean, start?: number, stop?: number): void;
307
305
  /**
308
306
  * Adds a listener that is called when the user is leaving the page, but before the RUM monitoring beacon is sent
309
307
  * Use when you want to hook into the unload of the page.
@@ -344,12 +342,11 @@ export interface DtrumApi {
344
342
  * @param xmode XHR action creation mode
345
343
  * 0 ... Just extend running XHR actions
346
344
  * 1 ... Extend any running action
347
- * 2 ... Extend any running action - visible subaction - DEPRECATED: use 1 instead
348
345
  * 3 ... Start action if user input is present
349
346
  * @param xhrUrl url of the requested resource
350
347
  * @returns ID of the XhrAction
351
348
  */
352
- enterXhrAction(type: string, xmode?: 0 | 1 | 2 | 3, xhrUrl?: string): number;
349
+ enterXhrAction(type: string, xmode?: 0 | 1 | 3, xhrUrl?: string): number;
353
350
  /**
354
351
  * Indicates the end of an XHR action
355
352
  *
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@dynatrace/dtrum-api-types",
3
- "version": "1.249.3",
3
+ "version": "1.251.1",
4
4
  "description": "Typescript types for Dynatrace jsagents dtrum api.",
5
5
  "main": "",
6
6
  "typings": "dtrum.d.ts",