@dynatrace/react-native-plugin 2.329.1 → 2.333.1

package/types.d.ts

@@ -126,11 +126,13 @@ declare enum DataCollectionLevel {
 declare class UserPrivacyOptions {
     private _dataCollectionLevel;
     private _crashReportingOptedIn;
+    private _screenRecordOptedIn;
     /**
      * Creates a new UserPrivacyOptions instance with the specified privacy settings.
      *
      * @param {DataCollectionLevel} dataCollectionLevel The level of data collection to allow
      * @param {boolean} crashReportingOptedIn Whether crash reporting should be enabled
+     * @param {boolean} screenRecordOptedIn Whether screen recording (Session Replay) should be enabled
      *
      * @example
      * ```ts
@@ -147,7 +149,7 @@ declare class UserPrivacyOptions {
      *
      * @see https://www.npmjs.com/package/@dynatrace/react-native-plugin#user-privacy-options
      */
-    constructor(dataCollectionLevel: DataCollectionLevel, crashReportingOptedIn: boolean);
+    constructor(dataCollectionLevel: DataCollectionLevel, crashReportingOptedIn: boolean, screenRecordOptedIn?: boolean);
     /**
      * Gets the current data collection level.
      *
@@ -216,6 +218,8 @@ declare class UserPrivacyOptions {
      * @see https://www.npmjs.com/package/@dynatrace/react-native-plugin#user-privacy-options
      */
     set dataCollectionLevel(dataCollectionLevel: DataCollectionLevel);
+    get screenRecordOptedIn(): boolean;
+    set screenRecordOptedIn(screenRecordOptedIn: boolean);
 }
 
 /**
@@ -394,15 +398,16 @@ interface IDynatraceAction {
      */
     cancel(platform?: Platform): void;
     /**
-     * Generates a Dynatrace request tag for manual web request tagging. This tag must be added as an
-     * HTTP header to link the web request with this mobile action. The header key can be obtained
-     * using `getRequestTagHeader()`.
+     * Generates a unique x-dynatrace header for the web request with a specified url,
+     * which has to be manually added as http header.
      *
-     * The tag value is evaluated by the Dynatrace web server agent, which links server-side PurePath
-     * data with this mobile user action for end-to-end tracing.
+     * This is the same tag that was provided when constructing the DynatraceWebRequestTiming instance.
+     * The header key can be obtained with the method getRequestTagHeader.
      *
-     * **Note:** The returned string may be empty if the Dynatrace agent is disabled or not started yet,
-     * if communication with the Dynatrace server fails, or if privacy settings do not allow monitoring of requests.
+     * The string value can be empty in cases when the agent is not able to send data, the agent is turned off completly,
+     * has not started yet or is not allowed to track web requests because of privacy reasons.
+     * The tag value is evaluated by the corresponding web server agent.
+     * The Dynatrace server will link the server-side PurePath data with this mobile user action.
      *
      * @param {string} url The URL of the request you want to track
      * @returns {Promise<string>} The request tag value to be used as the HTTP header value
@@ -636,7 +641,7 @@ interface IEventModifier {
      * }});
      * ```
      *
-     * @see https://docs.dynatrace.com/docs/observe/digital-experience/new-rum-experience/api
+     * @see https://docs.dynatrace.com/docs/shortlink/react-native-custom-events#event-modifiers
      */
     modifyEvent(event: JSONObject): JSONObject | null;
 }
@@ -676,7 +681,7 @@ interface IHttpRequestEventData extends IBaseEvent {
      * Dynatrace.sendHttpRequestEvent(requestEvent);
      * ```
      *
-     * @see https://docs.dynatrace.com/docs/observe/digital-experience/new-rum-experience/api
+     * @see https://docs.dynatrace.com/docs/shortlink/react-native-web-request-performance#manual-http-request-reporting
      */
     withDuration(duration: number): this;
     /**
@@ -694,7 +699,7 @@ interface IHttpRequestEventData extends IBaseEvent {
      * Dynatrace.sendHttpRequestEvent(requestEvent);
      * ```
      *
-     * @see https://docs.dynatrace.com/docs/observe/digital-experience/new-rum-experience/api
+     * @see https://docs.dynatrace.com/docs/shortlink/react-native-web-request-performance#manual-http-request-reporting
      */
     withStatusCode(statusCode: number): this;
     /**
@@ -712,7 +717,7 @@ interface IHttpRequestEventData extends IBaseEvent {
      * Dynatrace.sendHttpRequestEvent(requestEvent);
      * ```
      *
-     * @see https://docs.dynatrace.com/docs/observe/digital-experience/new-rum-experience/api
+     * @see https://docs.dynatrace.com/docs/shortlink/react-native-web-request-performance#manual-http-request-reporting
      */
     withReasonPhrase(reasonPhrase: string): this;
     /**
@@ -738,7 +743,7 @@ interface IHttpRequestEventData extends IBaseEvent {
      * }
      * ```
      *
-     * @see https://docs.dynatrace.com/docs/observe/digital-experience/new-rum-experience/api
+     * @see https://docs.dynatrace.com/docs/shortlink/react-native-web-request-performance#manual-http-request-reporting
      */
     withError(error: Error): this;
     /**
@@ -756,7 +761,7 @@ interface IHttpRequestEventData extends IBaseEvent {
      * Dynatrace.sendHttpRequestEvent(requestEvent);
      * ```
      *
-     * @see https://docs.dynatrace.com/docs/observe/digital-experience/new-rum-experience/api
+     * @see https://docs.dynatrace.com/docs/shortlink/react-native-web-request-performance#manual-http-request-reporting
      */
     withBytesSent(bytesSent: number): this;
     /**
@@ -774,7 +779,7 @@ interface IHttpRequestEventData extends IBaseEvent {
      * Dynatrace.sendHttpRequestEvent(requestEvent);
      * ```
      *
-     * @see https://docs.dynatrace.com/docs/observe/digital-experience/new-rum-experience/api
+     * @see https://docs.dynatrace.com/docs/shortlink/react-native-web-request-performance#manual-http-request-reporting
      */
     withBytesReceived(bytesReceived: number): this;
     /**
@@ -793,7 +798,7 @@ interface IHttpRequestEventData extends IBaseEvent {
      * Dynatrace.sendHttpRequestEvent(requestEvent);
      * ```
      *
-     * @see https://docs.dynatrace.com/docs/observe/digital-experience/new-rum-experience/api
+     * @see https://docs.dynatrace.com/docs/shortlink/react-native-web-request-performance#manual-http-request-reporting
      */
     withTraceparentHeader(traceparentHeader: TraceparentHeader): this;
     /**
@@ -822,13 +827,15 @@ interface IHttpRequestEventData extends IBaseEvent {
      * Dynatrace.sendHttpRequestEvent(requestEvent);
      * ```
      *
-     * @see https://docs.dynatrace.com/docs/observe/digital-experience/new-rum-experience/api
+     * @see https://docs.dynatrace.com/docs/shortlink/react-native-web-request-performance#manual-http-request-reporting
      */
     addEventProperty(key: `event_properties.${string}`, value: EventProperty): this;
 }
 
 type TraceparentHeader = `00-${string}-${string}-0${'0' | '1'}`;
 type AllowedRequestMethods = 'GET' | 'HEAD' | 'POST' | 'PUT' | 'DELETE' | 'CONNECT' | 'OPTIONS' | 'TRACE' | 'PATCH' | 'get' | 'head' | 'post' | 'put' | 'delete' | 'connect' | 'options' | 'trace' | 'patch';
+type Url = `http://${string}` | `https://${string}`;
+type EventPropertyKey = `event_properties.${string}`;
 declare class HttpRequestEventData implements IHttpRequestEventData {
     private url;
     private requestMethod;
@@ -841,7 +848,6 @@ declare class HttpRequestEventData implements IHttpRequestEventData {
     private error?;
     private traceparentHeader?;
     private rawEventProperties;
-    private traceContextHint;
     private hasDroppedProperties;
     private triedToOverwriteDuration;
     /**
@@ -860,9 +866,9 @@ declare class HttpRequestEventData implements IHttpRequestEventData {
      * Dynatrace.sendHttpRequestEvent(requestEvent);
      * ```
      *
-     * @see https://docs.dynatrace.com/docs/observe/digital-experience/new-rum-experience/api
+     * @see https://docs.dynatrace.com/docs/shortlink/react-native-web-request-performance#manual-http-request-reporting
      */
-    constructor(url: `http://${string}` | `https://${string}`, requestMethod: AllowedRequestMethods);
+    constructor(url: Url, requestMethod: AllowedRequestMethods);
     withDuration(duration: number): this;
     withStatusCode(statusCode: number): this;
     withReasonPhrase(reasonPhrase: string): this;
@@ -870,7 +876,7 @@ declare class HttpRequestEventData implements IHttpRequestEventData {
     withBytesSent(bytesSent: number): this;
     withBytesReceived(bytesReceived: number): this;
     withTraceparentHeader(traceparentHeader: TraceparentHeader): this;
-    addEventProperty(key: `event_properties.${string}`, value: EventProperty): this;
+    addEventProperty(key: EventPropertyKey, value: EventProperty): this;
     toJSON(): JSONObject | null;
     private hasValidMandatoryAttributes;
     private isInvalidUrl;
@@ -889,7 +895,7 @@ declare class HttpRequestEventData implements IHttpRequestEventData {
  * Events can include custom properties and duration information.
  * Use implementations of this interface with `Dynatrace.sendEvent()`.
  *
- * @see https://docs.dynatrace.com/docs/observe/digital-experience/new-rum-experience/api
+ * @see https://docs.dynatrace.com/docs/shortlink/react-native-custom-events#send-custom-events
  */
 interface IEventData extends IBaseEvent {
     /**
@@ -959,7 +965,7 @@ declare class EventData implements IEventData {
  * user session and are attached to all subsequent events in that session.
  * Use implementations of this interface with `Dynatrace.sendSessionPropertyEvent()`.
  *
- * @see https://docs.dynatrace.com/docs/observe/digital-experience/new-rum-experience/api
+ * @see https://docs.dynatrace.com/docs/shortlink/react-native-custom-events#send-session-property-events
  */
 interface ISessionPropertyEventData extends IBaseEvent {
     /**
@@ -1011,7 +1017,7 @@ declare class SessionPropertyEventData implements ISessionPropertyEventData {
  * to Dynatrace. Exception events can include custom properties.
  * Use implementations of this interface with `Dynatrace.sendExceptionEvent()`.
  *
- * @see https://docs.dynatrace.com/docs/observe/digital-experience/new-rum-experience/api
+ * @see https://docs.dynatrace.com/docs/shortlink/react-native-error-crash-reporting#send-exception-event
  */
 interface IExceptionEventData extends IBaseEvent {
     /**
@@ -1100,7 +1106,7 @@ interface IDynatrace$1 {
      * });
      * ```
      *
-     * @see https://docs.dynatrace.com/docs/observe/digital-experience/new-rum-experience/api
+     * @see https://docs.dynatrace.com/docs/shortlink/react-native-custom-events#event-modifiers
      */
     addEventModifier(eventModifier: IEventModifier): IEventModifier;
     /**
@@ -1117,7 +1123,7 @@ interface IDynatrace$1 {
      * const removed = Dynatrace.removeEventModifier(modifier);
      * ```
      *
-     * @see https://docs.dynatrace.com/docs/observe/digital-experience/new-rum-experience/api
+     * @see https://docs.dynatrace.com/docs/shortlink/react-native-custom-events#remove-event-modifiers
      */
     removeEventModifier(eventModifier: IEventModifier): boolean;
     /**
@@ -1143,7 +1149,7 @@ interface IDynatrace$1 {
      * }
      * ```
      *
-     * @see https://docs.dynatrace.com/docs/observe/digital-experience/new-rum-experience/api
+     * @see https://docs.dynatrace.com/docs/shortlink/react-native-error-crash-reporting#send-exception-event
      */
     sendExceptionEvent(exceptionEventData: ExceptionEventData): void;
     /**
@@ -1164,7 +1170,7 @@ interface IDynatrace$1 {
      * Dynatrace.sendEvent(customEvent);
      * ```
      *
-     * @see https://docs.dynatrace.com/docs/observe/digital-experience/new-rum-experience/api
+     * @see https://docs.dynatrace.com/docs/shortlink/react-native-custom-events#send-custom-events
      */
     sendEvent(eventData: EventData): void;
     /**
@@ -1184,7 +1190,7 @@ interface IDynatrace$1 {
      * Dynatrace.startView('HomeScreen');
      * ```
      *
-     * @see https://docs.dynatrace.com/docs/observe/digital-experience/new-rum-experience/api
+     * @see https://docs.dynatrace.com/docs/shortlink/react-native-app-performance#view-monitoring
      */
     startView(name: string): void;
     /**
@@ -1208,7 +1214,7 @@ interface IDynatrace$1 {
      * Dynatrace.sendSessionPropertyEvent(sessionEvent);
      * ```
      *
-     * @see https://docs.dynatrace.com/docs/observe/digital-experience/new-rum-experience/api
+     * @see https://docs.dynatrace.com/docs/shortlink/react-native-custom-events#send-session-property-events
      */
     sendSessionPropertyEvent(sessionPropertyEventData: SessionPropertyEventData): void;
     /**
@@ -1231,7 +1237,7 @@ interface IDynatrace$1 {
      * Dynatrace.sendHttpRequestEvent(detailedRequest);
      * ```
      *
-     * @see https://docs.dynatrace.com/docs/observe/digital-experience/new-rum-experience/api
+     * @see https://docs.dynatrace.com/docs/shortlink/react-native-web-request-performance#manual-http-request-reporting
      */
     sendHttpRequestEvent(httpRequestEvent: HttpRequestEventData): void;
 }
@@ -2080,8 +2086,16 @@ interface IDynatraceWebRequestTiming {
      */
     stopWebRequestTimingWithSize(responseCode: number, responseMessage: string, requestSize: number, responseSize: number): void;
     /**
-     * Returns the request tag value that should be used as the HTTP header value for tracking.
+     * Generates a unique x-dynatrace header for the web request with a specified url,
+     * which has to be manually added as http header.
+     *
      * This is the same tag that was provided when constructing the DynatraceWebRequestTiming instance.
+     * The header key can be obtained with the method getRequestTagHeader.
+     *
+     * The string value can be empty in cases when the agent is not able to send data, the agent is turned off completly,
+     * has not started yet or is not allowed to track web requests because of privacy reasons.
+     * The tag value is evaluated by the corresponding web server agent.
+     * The Dynatrace server will link the server-side PurePath data with this mobile user action.
      *
      * @returns {string} The request tag value to be used as the HTTP header value
      *