@dynatrace/dtrum-api-types 1.261.2 → 1.263.3

package/README.md

@@ -2,7 +2,7 @@
 This package contains the Typescript type information for the Dtrum Api of the javascript agent.
 
 Keep in mind that when the javascript agent is updated, this type package might not provide accurate types.
-Version: 1.261.2
+Version: 1.263.3
 
 ## Installation
 > npm install --save-dev @dynatrace/dtrum-api-types

package/dtrum.d.ts

@@ -1,8 +1,8 @@
 /**
  * Signature of the function passed as callback in {@link addLeaveActionListener}
  *
- * @param actionId the ID for which the leave is called
- * @param stoptime start resp. endtime of the action
+ * @param actionId     the ID for which the leave is called
+ * @param stoptime     start resp. endtime of the action
  * @param isRootAction true if the action with the provided ID is a root action
  */
 export interface ActionLeaveListener {
@@ -12,10 +12,10 @@ export interface ActionLeaveListener {
 /**
  * Signature of the function passed as callback in {@link addEnterActionListener}
  *
- * @param actionId the ID for which the enter is called
- * @param starttime start resp. endtime of the action
+ * @param actionId     the ID for which the enter is called
+ * @param starttime    start resp. endtime of the action
  * @param isRootAction true if the action with the provided ID is a root action
- * @param [element] the element which resulted in the initiation of the event
+ * @param [element]    the element which resulted in the initiation of the event
  */
 export interface ActionEnterListener {
     (actionId: number, starttime: number, isRootAction: boolean, element?: EventTarget | string): void;
@@ -171,8 +171,8 @@ export interface DtrumApi {
      * Needs to be called before the onload event of the page has finished, otherwise the information will be discarded.
      *
      * @param responseCode Sets the HTTP status code
-     * @param message An additional informational message
-     * @returns false if the values were incorrect or the function has been called too late, true otherwise
+     * @param message      An additional informational message
+     * @returns            false if the values were incorrect or the function has been called too late, true otherwise
      */
     markAsErrorPage(responseCode: number, message: string): boolean;
     /**
@@ -181,11 +181,11 @@ export interface DtrumApi {
      * by the server indicates a failed request.
      * Needs to be called before the XHR action is finished and all listeners have been invoked.
      *
-     * @param responseCode The response code of the current XHR action
-     * @param message An additional informational message
+     * @param responseCode   The response code of the current XHR action
+     * @param message        An additional informational message
      * @param parentActionId The optional ID of the action to mark as failed. If it is not present,
-     * the currently open action is used.
-     * @returns false if the values were incorrect or the function has been called too late, true otherwise
+     *                       the currently open action is used.
+     * @returns              false if the values were incorrect or the function has been called too late, true otherwise
      */
     markXHRFailed(responseCode: number, message: string, parentActionId?: number): boolean;
     /**
@@ -193,8 +193,8 @@ export interface DtrumApi {
      * For example, use before a window unload event by adding a {@link addPageLeavingListener}.
      *
      * @see {@link addPageLeavingListener}
-     * @param forceSync Force synchronous sending of beacons. If false, the beacon will be sent asynchronously.
-     * @param sendPreview Force sending of preview beacons which haven't been closed yet.
+     * @param forceSync      Force synchronous sending of beacons. If false, the beacon will be sent asynchronously.
+     * @param sendPreview    Force sending of preview beacons which haven't been closed yet.
      * @param killUnfinished Kills unfinished actions and sends them immediately. Handle with care, actions might be inaccurate.
      */
     sendBeacon(forceSync: boolean, sendPreview: boolean, killUnfinished: boolean): void;
@@ -205,9 +205,9 @@ export interface DtrumApi {
      * @see {@link leaveAction}
      * @param actionName Name of the action
      * @param actionType DEPRECATED: not used any more and has no effect if provided
-     * @param startTime Timestamp in milliseconds. if null, current time is used.
-     * @param sourceUrl Source url for the action
-     * @returns ID of the created action
+     * @param startTime  Timestamp in milliseconds. if null, current time is used.
+     * @param sourceUrl  Source url for the action
+     * @returns          ID of the created action
      */
     "enterAction"(actionName: string, actionType?: string, startTime?: number, sourceUrl?: string): number;
     /**
@@ -235,12 +235,12 @@ export interface DtrumApi {
      * Needs to be called after {@link enterAction}.
      *
      * @see {@link enterAction}
-     * @param actionId ID of the action to leave. must be the value returned by enterAction
-     * @param stopTime Timestamp in milliseconds.
-     * Note that, when providing a stop time, it will force stop the action and prevent visually complete from extending it.
+     * @param actionId  ID of the action to leave. must be the value returned by enterAction
+     * @param stopTime  Timestamp in milliseconds.
+     *                  Note that, when providing a stop time, it will force stop the action and prevent visually complete from extending it.
      * @param startTime Optional start time in milliseconds (necessary if start time should be modified).
-     * Note that, when providing a start time, it mustn't be longer than an hour in the past, otherwise the
-     * RUM monitoring code will ignore it.
+     *                  Note that, when providing a start time, it mustn't be longer than an hour in the past, otherwise the
+     *                  RUM monitoring code will ignore it.
      */
     "leaveAction"(actionId: number, stopTime?: number, startTime?: number): void;
     /**
@@ -251,34 +251,34 @@ export interface DtrumApi {
      *
      * @see {@link removeLeaveActionListener}
      * @see {@link addActionProperties}
-     * @param  listener A function that will be called when leaving an action
+     * @param listener A function that will be called when leaving an action
      */
     addLeaveActionListener(listener: ActionLeaveListener): void;
     /**
      * Removes a previously attached listener that detects the leave action event
      *
-     * @param  listener A leave action listener to be removed
+     * @param listener A leave action listener to be removed
      */
     removeLeaveActionListener(listener: ActionLeaveListener): void;
     /**
      * Adds custom {@link https://www.dynatrace.com/support/help/shortlink/user-session-properties | action properties}
      * to the currently active action.  <br />
      * Only accepts valid java long, java double (as a string representation), Date objects, and
-     *          short strings with a maximum length of 100 characters. <br />
+     * short strings with a maximum length of 100 characters. <br />
      * Action properties must be defined first under Application settings and use a lower case key.
      *
      * @see {@link sendSessionProperties}
      * @param parentActionId ID of the action.
-     * @param javaLong JSON object containing key value pairs of valid numbers. <br /> Value should be between
-     *          range -9223372036854776000 & 9223372036854776000
-     * @param date JSON object containing key value pairs of JavaScript Date objects.<br />  Value should be JavaScript Date object
-     * @param shortString JSON object containing key value pairs of strings.<br />  Value character count should be less
-     *          than 100 characters
-     * @param javaDouble JSON object containing key value pairs of valid floating point numbers.<br />
-     * Value should be between range -1.7976931348623157e+308 & 1.7976931348623157e+308
+     * @param javaLong       JSON object containing key value pairs of valid numbers. <br /> Value should be between
+     *                       range -9223372036854776000 & 9223372036854776000
+     * @param date           JSON object containing key value pairs of JavaScript Date objects.<br />  Value should be JavaScript Date object
+     * @param shortString    JSON object containing key value pairs of strings.<br />  Value character count should be less
+     *                       than 100 characters
+     * @param javaDouble     JSON object containing key value pairs of valid floating point numbers.<br />
+     *                       Value should be between range -1.7976931348623157e+308 & 1.7976931348623157e+308
      *
-     * Each key value pair must be defined in the following format 'key: { value: value<AllowedMapTypes>, public?: boolean }'
-     * Public property is optional and if not declared as true values will be sent as masked(dT_pv) in doNotTrack mode
+     *                       Each key value pair must be defined in the following format 'key: { value: value<AllowedMapTypes>, public?: boolean }'
+     *                       Public property is optional and if not declared as true values will be sent as masked(dT_pv) in doNotTrack mode
      */
     addActionProperties(parentActionId: number, javaLong?: PropertyMap<number>, date?: PropertyMap<Date>, shortString?: PropertyMap<string>, javaDouble?: PropertyMap<number>): void;
     /**
@@ -288,10 +288,10 @@ export interface DtrumApi {
      * by the global JavaScript {@link https://developer.mozilla.org/en-US/docs/Web/API/GlobalEventHandlers/onerror | onerror event handler},
      * which is used by Dynatrace to automatically capture JavaScritp errors.
      *
-     * @param error The error to be reported. Any browser error object is supported and if the error doesn't
-     *  have a stacktrace the RUM JavaScipt monitoring code will attempt to generate one.
-     *   Alternatively create your own object that has the following properties set: 'message',
-     *   'file', 'line', 'column', and 'stack'. The 'message' property must be provided; all other values are optional.
+     * @param error          The error to be reported. Any browser error object is supported and if the error doesn't
+     *                       have a stacktrace the RUM JavaScipt monitoring code will attempt to generate one.
+     *                       Alternatively create your own object that has the following properties set: 'message',
+     *                       'file', 'line', 'column', and 'stack'. The 'message' property must be provided; all other values are optional.
      * @param parentActionId parent action id. if not passed or null, error is added to current action
      */
     reportError(error: Error | string, parentActionId?: number): void;
@@ -312,15 +312,15 @@ export interface DtrumApi {
     /**
      * Indicates the start of a user input. User inputs must always be stopped by calling {@link endUserInput}.
      * If an XHR call or a page load happens, the RUM monitoring code checks if a user input is active. If so, that user input is
-     *          set to have triggered the user action.
+     * set to have triggered the user action.
      * Use when a user input is not automatically detected by the RUM monitoring code.
      *
      * @see {@link endUserInput}
-     * @param domNode DOM node which triggered the action (button, etc) or a string is used for determining its caption
-     * @param type Type of action: 'click', 'keypress', 'scroll',...
-     * @param addInfo Additional info for user input such as key, mouse button, etc ('F5', 'RETURN',...)
+     * @param domNode   DOM node which triggered the action (button, etc) or a string is used for determining its caption
+     * @param type      Type of action: 'click', 'keypress', 'scroll',...
+     * @param addInfo   Additional info for user input such as key, mouse button, etc ('F5', 'RETURN',...)
      * @param validTime How long this userInput should be valid(in ms)
-     * @returns An object containing all the information about the userInput
+     * @returns         An object containing all the information about the userInput
      */
     beginUserInput(domNode: HTMLElement | string, type: string, addInfo?: string, validTime?: number): DtRumUserInput;
     /**
@@ -338,19 +338,21 @@ export interface DtrumApi {
      * Needs to be called before {@link leaveXhrAction}.
      *
      * @see {@link leaveXhrAction}
-     * @param type Optional additional info about type of XHR (e.g., framework name, etc.)
-     * @param xmode XHR action creation mode
-     *          0 ... Just extend running XHR actions
-     *          1 ... Extend any running action
-     *          3 ... Start action if user input is present
+     * @param type   Optional additional info about type of XHR (e.g., framework name, etc.)
+     * @param xmode  XHR action creation mode
+     *               0 ... Just extend running XHR actions
+     *               1 ... Extend any running action
+     *               3 ... Start action if user input is present
      * @param xhrUrl url of the requested resource
-     * @returns ID of the XhrAction
+     *               note that in the future, this argument will be required
+     *               if not provided, the request will be marked as `/undefined` in the waterfall
+     * @returns      ID of the XhrAction
      */
     enterXhrAction(type: string, xmode?: 0 | 1 | 3, xhrUrl?: string): number;
     /**
      * Indicates the end of an XHR action
      *
-     * @param actionId ID of the XHR Action
+     * @param actionId   ID of the XHR Action
      * @param [stopTime] The stop time of the XHR Action
      */
     leaveXhrAction(actionId: number, stopTime?: number): void;
@@ -398,8 +400,8 @@ export interface DtrumApi {
      * Sets the actionName of the currently active action, or the action with the provided id
      *
      * @param actionName The new name of the action
-     * @param actionId The action ID of the to be updated action name
-     * @returns an {@link  ActionNameResult} whether the process was successful
+     * @param actionId   The action ID of the to be updated action name
+     * @returns          an {@link  ActionNameResult} whether the process was successful
      */
     actionName(actionName: string, actionId?: number): ActionNameResult;
     /**
@@ -471,15 +473,15 @@ export interface DtrumApi {
      * Read more about {@link https://www.dynatrace.com/support/help/shortlink/cookies#cookie-storage | cookie storage}.
      *
      * @param remember If true, this configuration state is persisted in local storage, so that it doesn't
-     *  reset on each page load
+     *                 reset on each page load
      */
     disablePersistentValues(remember: boolean): void;
     /**
      * Registers a method which will be invoked before the 'diff' action in session replay during recording.
      *
      * @param method Listener which will be called before diff action. Listener receives one argument
-     * which is a string with diff. Listener also must return the diff string.
-     * Read more about {@link https://www.dynatrace.com/support/help/shortlink/cookies#cookie-storage | cookie storage}.
+     *               which is a string with diff. Listener also must return the diff string.
+     *               Read more about {@link https://www.dynatrace.com/support/help/shortlink/cookies#cookie-storage | cookie storage}.
      */
     registerPreDiffMethod(method: (diff: string) => string): void;
     /**
@@ -492,37 +494,37 @@ export interface DtrumApi {
      *
      * @see {@link addActionProperties} is related and works similarly.
      * @param javaLongOrObject JSON object containing key value pairs of valid numbers. <br /> Value should be between range -9223372036854776000 & 9223372036854776000
-     * @param date JSON object containing key value pairs of JavaScript date objects.<br />  Value should be JavaScript Date object
-     * @param shortString JSON object containing key value pairs of strings.<br />  Value character count should be less than
-     *          100 characters
-     * @param javaDouble JSON object containing key value pairs of valid floating point numbers.<br />
-     * Value should be between range -1.7976931348623157e+308 & 1.7976931348623157e+308
+     * @param date             JSON object containing key value pairs of JavaScript date objects.<br />  Value should be JavaScript Date object
+     * @param shortString      JSON object containing key value pairs of strings.<br />  Value character count should be less than
+     *                         100 characters
+     * @param javaDouble       JSON object containing key value pairs of valid floating point numbers.<br />
+     *                         Value should be between range -1.7976931348623157e+308 & 1.7976931348623157e+308
      *
-     * Each key value pair must be defined in the following format 'key: { value: value<AllowedMapTypes>, public?: boolean }'
-     * Public property is optional and if not declared as true values will be sent as masked(dT_pv) in doNotTrack mode
+     *                         Each key value pair must be defined in the following format 'key: { value: value<AllowedMapTypes>, public?: boolean }'
+     *                         Public property is optional and if not declared as true values will be sent as masked(dT_pv) in doNotTrack mode
      *
-     * @returns Status report about properties that were passed to the function.
-     *          It contains data about failed properties with the failure reason.
-     *          Contains data about properties that were sent successfully and a general message with information about total failed properties.
+     * @returns                Status report about properties that were passed to the function.
+     *                         It contains data about failed properties with the failure reason.
+     *                         Contains data about properties that were sent successfully and a general message with information about total failed properties.
      */
     sendSessionProperties(
         javaLongOrObject?: PropertyMap<number> | PropertyObject,
         date?: PropertyMap<Date>,
         shortString?: PropertyMap<string>,
         javaDouble?: PropertyMap<number>
-        // eslint-disable-next-line @dynatrace/dem-eslint-rules/correct-null-void-undefined -- jquery types return void by design - keep native types
+
     ): PropertiesSendingReport | undefined;
     /**
      * Report your own{@link https://www.dynatrace.com/support/help/shortlink/configure-application-errors#configure-custom-errors | custom errors}.
      * For example, use when you want to capture form validation errors in your signup process.
      * Custom errors must first be defined in the Application settings.
      *
-     * @param key The key of the error. For example, 'validation error'
-     * @param value The error value. For example, 'Email validation failed'
-     * @param hint A hint to pinpoint the problem, e.g. content of the input element which triggered the failed validation
+     * @param key           The key of the error. For example, 'validation error'
+     * @param value         The error value. For example, 'Email validation failed'
+     * @param hint          A hint to pinpoint the problem, e.g. content of the input element which triggered the failed validation
      * @param parentingInfo How the custom error should be attached (default = false),
-     *               [case number]: To which open action the custom error event should be attached,
-     *              [case boolean]: If true it will get attached to the current active action
+     *                      [case number]: To which open action the custom error event should be attached,
+     *                      [case boolean]: If true it will get attached to the current active action
      */
     reportCustomError(key: string, value: string, hint?: string, parentingInfo?: number | boolean): void;
 
@@ -539,8 +541,8 @@ export interface DtrumApi {
      * @param newPage New page containing page name and page group.
      * @returns       1 if new page is started succesfully.
      *                2 if new page is started during onload. It means it is cached and will be sent with load action.
-     *                -1 if page that is being set is the same as previous one.
-     *                -2 if page is trying to be set but mechanism is not active. Probably 'dtrum.enableManualPageDetection()' was not called.
+     *                - 1 if page that is being set is the same as previous one.
+     *                - 2 if page is trying to be set but mechanism is not active. Probably 'dtrum.enableManualPageDetection()' was not called.
      *                Negative number means new page failed to start and positive means that new page is started successfully.
      */
     "setPage"(newPage: APIPage): number;

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@dynatrace/dtrum-api-types",
-    "version": "1.261.2",
+    "version": "1.263.3",
     "description": "Typescript types for Dynatrace jsagents dtrum api.",
     "main": "",
     "typings": "dtrum.d.ts",