@dynatrace/rum-javascript-sdk 1.331.18 → 1.333.2

package/README.md

@@ -1,6 +1,6 @@
 # @dynatrace/rum-javascript-sdk
 
-A JavaScript API for interacting with the Dynatrace Real User Monitoring (RUM) JavaScript. This package provides both synchronous and asynchronous wrappers for the Dynatrace RUM API, along with TypeScript support and testing utilities.
+A JavaScript API for interacting with the Dynatrace Real User Monitoring (RUM) JavaScript. This package provides both synchronous and asynchronous wrappers for the Dynatrace RUM JavaScript API, along with TypeScript support and testing utilities.
 
 ## Installation
 
@@ -8,395 +8,13 @@ A JavaScript API for interacting with the Dynatrace Real User Monitoring (RUM) J
 npm install @dynatrace/rum-javascript-sdk
 ```
 
-## Overview
+## Documentation
 
-This package provides two main API approaches for interacting with the Dynatrace RUM JavaScript, as well as types and a Playwright testing framework:
+Due to rendering restrictions on npmjs.org, the full documentation for this package can be found in the [dynatrace documentation](https://www.dynatrace.com/support/doc/javascriptapi/doc-latest).
+Alternatively you can find the *.md files in the [docs](docs) directory.
 
-- **Synchronous API**: Safe wrapper functions that gracefully handle cases where the RUM JavaScript is not available
-- **Asynchronous API**: Promise-based functions that wait for the RUM JavaScript to become available
-- **User Actions API**: Manual control over user action creation and lifecycle (see [USERACTIONS.md](./docs/USERACTIONS.md))
-- **TypeScript Support**: Comprehensive type definitions for all RUM API functions
-- **Testing Framework**: Playwright-based utilities for testing RUM integration
+:::warn
+The dynatrace documentation only contains the documentation for the newest version of the `@dynatrace/rum-javascript-sdk` package.
+For older versions of the documentation, check the [docs](docs) directory.
+:::
 
-## Quick Start
-
-### Synchronous API (Recommended for most use cases)
-
-```typescript
-import { sendEvent, identifyUser } from '@dynatrace/rum-javascript-sdk/api';
-
-// Send a custom event - safely handles cases where RUM JavaScript is not loaded
-sendEvent({
-  'event_properties.component_name': 'UserProfile',
-  'event_properties.action': 'view'
-});
-
-// Identify the current user
-identifyUser('user@example.com');
-```
-
-### Asynchronous API (When you need to ensure RUM JavaScript is available)
-
-```typescript
-import { sendEvent, identifyUser } from '@dynatrace/rum-javascript-sdk/api/promises';
-
-try {
-  // Wait for RUM JavaScript to be available (with 10s timeout by default)
-  await sendEvent({
-    'event_properties.component_name': 'UserProfile',
-    'event_properties.action': 'view'
-  });
-  
-  await identifyUser('user@example.com');
-} catch (error) {
-  console.error('RUM JavaScript not available:', error);
-}
-```
-
-## API Reference
-
-### Synchronous API (`@dynatrace/rum-javascript-sdk/api`)
-
-The synchronous API provides safe wrapper functions that gracefully handle cases where the Dynatrace RUM JavaScript is not available. These functions will execute as no-ops if the JavaScript is not loaded, making them safe to use in any environment.
-
-#### `sendEvent(fields, eventContext?): void`
-
-Sends a custom event to Dynatrace RUM.
-
-**Parameters:**
-- `fields: ApiCreatedEventPropertiesEvent` - Event properties object. Must be serializable JSON with properties prefixed with `event_properties.`, plus optional `duration` and `start_time` properties.
-- `eventContext?: unknown` - Optional context for event modification callbacks.
-
-**Example:**
-```typescript
-import { sendEvent } from '@dynatrace/rum-javascript-sdk/api';
-
-sendEvent({
-  'event_properties.page_name': 'checkout',
-  'event_properties.step': 'payment',
-  'event_properties.amount': 99.99,
-  'duration': 1500,
-  'start_time': Date.now()
-});
-```
-
-#### `addEventModifier(eventModifier): Unsubscriber | undefined`
-
-Registers a function to modify events before they are sent to Dynatrace.
-
-**Parameters:**
-- `eventModifier: (jsonEvent: Readonly<JSONEvent>, eventContext?: EventContext) => JSONEvent | null` - Function that receives an event and returns a modified version or null to cancel the event.
-
-**Returns:**
-- `Unsubscriber | undefined` - Function to remove the modifier, or undefined if the RUM JavaScript is not available.
-
-**Example:**
-```typescript
-import { addEventModifier } from '@dynatrace/rum-javascript-sdk/api';
-
-const unsubscribe = addEventModifier((event, context) => {
-  // Add user context to all events
-  return {
-    ...event,
-    'event_properties.user_tier': 'premium'
-  };
-});
-
-// Later, remove the modifier
-unsubscribe?.();
-```
-
-#### `runHealthCheck(config?): Promise<unknown[] | undefined> | undefined`
-
-Runs a health check on the RUM JavaScript to diagnose potential issues.
-
-**Parameters:**
-- `config?: HealthCheckConfig` - Optional configuration object:
-  - `logVerbose?: boolean` - Include verbose information in the health check
-  - `returnDiagnosticData?: boolean` - Return diagnostic data as array instead of just logging
-  - `runDetailedOverrideCheck?: boolean` - Log additional information about overridden native APIs
-
-**Returns:**
-- `Promise<unknown[] | undefined> | undefined` - Promise resolving to diagnostic data (if requested), or undefined if the RUM JavaScript is not available.
-
-**Example:**
-```typescript
-import { runHealthCheck } from '@dynatrace/rum-javascript-sdk/api';
-
-const diagnostics = await runHealthCheck({
-  logVerbose: true,
-  returnDiagnosticData: true
-});
-
-if (diagnostics) {
-  console.log('RUM Health Check Results:', diagnostics);
-}
-```
-
-#### `identifyUser(value): void`
-
-Associates the current session with a specific user identifier.
-
-**Parameters:**
-- `value: string` - User identifier (name, email, user ID, etc.)
-
-**Example:**
-```typescript
-import { identifyUser } from '@dynatrace/rum-javascript-sdk/api';
-
-// Identify user after login
-identifyUser('john.doe@example.com');
-```
-
-#### `sendSessionPropertyEvent(fields): void`
-
-Sends session-level properties that will be attached to all subsequent events in the session.
-
-**Parameters:**
-- `fields: ApiCreatedSessionPropertiesEvent` - Session properties object. All keys must be prefixed with `session_properties.` and follow naming conventions (lowercase, numbers, underscores, dots).
-
-**Example:**
-```typescript
-import { sendSessionPropertyEvent } from '@dynatrace/rum-javascript-sdk/api';
-
-sendSessionPropertyEvent({
-  'session_properties.user_type': 'premium',
-  'session_properties.subscription_tier': 'gold',
-  'session_properties.region': 'us_east'
-});
-```
-
-#### `sendExceptionEvent(error, fields?): void`
-
-Sends an exception event. Marks the exception event with `characteristics.is_api_reported` and `error.source` = `api` to make it clear on DQL side where errors are coming from.
-Only available if the Errors module is enabled.
-
-**Parameters:**
-
-- `error: Error` - The error object to report. Must be an instance of the standard JavaScript `Error` class.
-- `fields: ApiCreatedEventPropertiesEvent` - Optional Event properties object. Must be serializable JSON with properties prefixed with `event_properties.`, plus optional `duration` and `start_time` properties.
-
-**Example:**
-```typescript
-import { sendExceptionEvent } from '@dynatrace/rum-javascript-sdk/api';
-
-const yourError = new Error("Your Error Message");
-
-sendExceptionEvent(yourError);
-```
-```typescript
-import { sendExceptionEvent } from '@dynatrace/rum-javascript-sdk/api';
-
-const yourError = new Error("Your Error Message");
-
-sendExceptionEvent(yourError, { "event_properties.component": "myExampleComponent" });
-```
-
-### Asynchronous API (`@dynatrace/rum-javascript-sdk/promises`)
-
-The asynchronous API provides Promise-based functions that wait for the Dynatrace RUM JavaScript to become available. These functions will throw a `DynatraceError` if the RUM JavaScript is not available within the specified timeout. This is useful for scenarios where you don't want to
-enable the RUM JavaScript before the user gives their consent.
-
-#### `sendEvent(fields, eventContext?, timeout?): Promise<void>`
-
-Async wrapper for sending custom events, with automatic waiting for RUM JavaScript availability.
-
-**Parameters:**
-- `fields: ApiCreatedEventPropertiesEvent` - Event properties object
-- `eventContext?: unknown` - Optional context for event modification callbacks
-- `timeout?: number` - Timeout in milliseconds to wait for RUM JavaScript (default: 10,000)
-
-**Throws:**
-- `DynatraceError` - If RUM JavaScript is not available within timeout
-
-**Example:**
-```typescript
-import { sendEvent } from '@dynatrace/rum-javascript-sdk/api/promises';
-
-try {
-  await sendEvent({
-    'event_properties.conversion': 'purchase',
-    'event_properties.value': 149.99
-  }, undefined, 15000); // 15 second timeout
-} catch (error) {
-  console.error('Failed to send event:', error.message);
-}
-```
-
-#### `addEventModifier(eventModifier, timeout?): Promise<Unsubscriber>`
-
-Async wrapper for registering event modifiers, with automatic waiting for RUM JavaScript availability.
-
-**Parameters:**
-- `eventModifier: (jsonEvent: Readonly<JSONEvent>, eventContext?: EventContext) => JSONEvent | null` - Event modifier function
-- `timeout?: number` - Timeout in milliseconds to wait for RUM JavaScript (default: 10,000)
-
-**Returns:**
-- `Promise<Unsubscriber>` - Promise resolving to unsubscriber function
-
-**Example:**
-```typescript
-import { addEventModifier } from '@dynatrace/rum-javascript-sdk/api/promises';
-
-const unsubscribe = await addEventModifier((event) => ({
-  ...event,
-  'event_properties.environment': 'production'
-}));
-```
-
-#### `runHealthCheck(config?, timeout?): Promise<unknown[] | undefined>`
-
-Async wrapper for running health checks, with automatic waiting for RUM JavaScript availability.
-
-**Parameters:**
-- `config?: HealthCheckConfig` - Optional health check configuration
-- `timeout?: number` - Timeout in milliseconds to wait for RUM JavaScript (default: 10,000)
-
-**Returns:**
-- `Promise<unknown[] | undefined>` - Promise resolving to diagnostic data
-
-#### `identifyUser(value, timeout?): Promise<void>`
-
-Async wrapper for user identification, with automatic waiting for RUM JavaScript availability.
-
-**Parameters:**
-- `value: string` - User identifier
-- `timeout?: number` - Timeout in milliseconds to wait for RUM JavaScript (default: 10,000)
-
-#### `sendSessionPropertyEvent(fields, timeout?): Promise<void>`
-
-Async wrapper for sending session properties, with automatic waiting for RUM JavaScript availability.
-
-**Parameters:**
-- `fields: ApiCreatedSessionPropertiesEvent` - Session properties object
-- `timeout?: number` - Timeout in milliseconds to wait for RUM JavaScript (default: 10,000)
-
-#### `sendExceptionEvent(error, fields?): void`
-
-Async wrapper for sending an exception event, with automatic waiting for RUM JavaScript availability.
-Marks the exception event with `characteristics.is_api_reported` and `error.source` = `api` to make it clear on DQL side where errors are coming from.
-Only available if the Errors module is enabled.
-
-**Parameters:**
-
-- `error: Error` - The error object to report. Must be an instance of the standard JavaScript `Error` class.
-- `fields: ApiCreatedEventPropertiesEvent` - Optional Event properties object. Must be serializable JSON with properties prefixed with `event_properties.`, plus optional `duration` and `start_time` properties.
-
-### User Actions API
-
-Both synchronous and asynchronous wrappers are available for the User Actions API. For detailed documentation and examples, see [USERACTIONS.md](./docs/USERACTIONS.md).
-
-**Synchronous API:**
-```typescript
-import {
-  createUserAction,
-  subscribeToUserActions,
-  setAutomaticUserActionDetection,
-  getCurrentUserAction
-} from '@dynatrace/rum-javascript-sdk/api';
-
-// Create a manual user action
-const userAction = createUserAction({ autoClose: false });
-// perform work
-userAction?.finish();
-```
-
-**Asynchronous API:**
-```typescript
-import { createUserAction } from '@dynatrace/rum-javascript-sdk/api/promises';
-
-const userAction = await createUserAction({ autoClose: false });
-// perform work
-userAction.finish();
-```
-
-## Error Handling
-
-### DynatraceError
-
-Both APIs export a `DynatraceError` class for handling RUM-specific errors:
-
-```typescript
-import { sendEvent, DynatraceError } from '@dynatrace/rum-javascript-sdk/promises';
-
-try {
-  await sendEvent({ 'event_properties.test': 'value' });
-} catch (error) {
-  if (error instanceof DynatraceError) {
-    console.error('RUM API Error:', error.message);
-    // Handle RUM-specific error
-  } else {
-    console.error('Unexpected error:', error);
-  }
-}
-```
-
-## TypeScript Support
-
-For detailed type information and usage examples, see [types.md](./docs/types.md).
-
-```typescript
-import type { 
-  ApiCreatedEventPropertiesEvent,
-  ApiCreatedSessionPropertiesEvent,
-  HealthCheckConfig,
-  JSONEvent,
-  EventContext
-} from '@dynatrace/rum-javascript-sdk/types';
-```
-
-## Testing
-
-This package includes a Playwright testing framework for validating RUM integration. See **[testing.md](./docs/testing.md)** for complete documentation including:
-
-- Setup and configuration
-- Fixture usage and ordering
-- Event assertion methods
-- Troubleshooting guide
-
-## Best Practices
-
-### When to Use Synchronous vs Asynchronous API
-
-**Use Synchronous API when:**
-- You want graceful degradation when the RUM JavaScript is not available
-- You're instrumenting existing code and don't want to change control flow
-- You're okay with events being dropped if the RUM JavaScript isn't loaded
-
-**Use Asynchronous API when:**
-- You need to ensure events are actually sent
-- You want to handle RUM JavaScript availability errors explicitly
-- You're building critical instrumentation that must not fail silently
-
-### Event Property Naming
-
-Follow prefix custom event properties with `event_properties.`:
-
-```typescript
-// ✅ Good - properties with prefix are accepted
-sendEvent({
-  'event_properties.action': 'login',
-  'event_properties.method': 'oauth',
-  'event_properties.page_name': 'dashboard',
-  'event_properties.load_time': 1234
-});
-
-// ❌ Avoid - properties without prefix are ignored
-sendEvent({
-  'action': 'click',
-  'data': 'some_value'
-});
-```
-
-### Session Properties
-
-Use session properties for data that applies to the entire user session:
-
-```typescript
-// Set once per session
-sendSessionPropertyEvent({
-  'session_properties.subscription_type': 'premium',
-  'session_properties.region': 'europe',
-  'session_properties.app_version': '2.1.0'
-});
-```

package/dist/testing/index.d.ts

@@ -0,0 +1,4 @@
+export type { SnapshotOptions, EventIgnorePattern } from "./snapshot.js";
+export { DEFAULT_IGNORED_EVENTS, DEFAULT_IGNORED_FIELDS, DEFAULT_REMOVED_FIELDS, IGNORED_PLACEHOLDER } from "./snapshot.js";
+export type { BeaconRequest, DynatraceConfig, DynatraceTesting, DynatraceTestingFixture, DynatraceTestingWorkerFixture, ExpectOptions, WaitForBeaconsOptions } from "./test.js";
+export { test } from "./test.js";

package/dist/testing/index.js

@@ -0,0 +1,3 @@
+export { DEFAULT_IGNORED_EVENTS, DEFAULT_IGNORED_FIELDS, DEFAULT_REMOVED_FIELDS, IGNORED_PLACEHOLDER } from "./snapshot.js";
+export { test } from "./test.js";
+//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiaW5kZXguanMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyIuLi8uLi9zb3VyY2UvdGVzdGluZy9pbmRleC50cyJdLCJuYW1lcyI6W10sIm1hcHBpbmdzIjoiQUFDQSxPQUFPLEVBQ0gsc0JBQXNCLEVBQ3RCLHNCQUFzQixFQUN0QixzQkFBc0IsRUFDdEIsbUJBQW1CLEVBQ3RCLE1BQU0sZUFBZSxDQUFDO0FBVXZCLE9BQU8sRUFBRSxJQUFJLEVBQUUsTUFBTSxXQUFXLENBQUMiLCJzb3VyY2VzQ29udGVudCI6WyJleHBvcnQgdHlwZSB7IFNuYXBzaG90T3B0aW9ucywgRXZlbnRJZ25vcmVQYXR0ZXJuIH0gZnJvbSBcIi4vc25hcHNob3QuanNcIjtcbmV4cG9ydCB7XG4gICAgREVGQVVMVF9JR05PUkVEX0VWRU5UUyxcbiAgICBERUZBVUxUX0lHTk9SRURfRklFTERTLFxuICAgIERFRkFVTFRfUkVNT1ZFRF9GSUVMRFMsXG4gICAgSUdOT1JFRF9QTEFDRUhPTERFUlxufSBmcm9tIFwiLi9zbmFwc2hvdC5qc1wiO1xuZXhwb3J0IHR5cGUge1xuICAgIEJlYWNvblJlcXVlc3QsXG4gICAgRHluYXRyYWNlQ29uZmlnLFxuICAgIER5bmF0cmFjZVRlc3RpbmcsXG4gICAgRHluYXRyYWNlVGVzdGluZ0ZpeHR1cmUsXG4gICAgRHluYXRyYWNlVGVzdGluZ1dvcmtlckZpeHR1cmUsXG4gICAgRXhwZWN0T3B0aW9ucyxcbiAgICBXYWl0Rm9yQmVhY29uc09wdGlvbnNcbn0gZnJvbSBcIi4vdGVzdC5qc1wiO1xuZXhwb3J0IHsgdGVzdCB9IGZyb20gXCIuL3Rlc3QuanNcIjtcbiJdfQ==

package/dist/testing/snapshot.d.ts

@@ -0,0 +1,129 @@
+/**
+ * Snapshot testing utilities for Dynatrace RUM event verification.
+ * Provides mechanisms to compare captured events against stored snapshots
+ * with support for masking volatile fields.
+ */
+/**
+ * Result of reading a snapshot file.
+ */
+interface SnapshotReadResult {
+    /**
+     * Whether the snapshot file exists.
+     */
+    exists: boolean;
+    /**
+     * The parsed snapshot data, or undefined if the file doesn't exist.
+     */
+    data?: Record<string, unknown>[];
+}
+/**
+ * Pattern to match events that should be completely ignored during snapshot comparison.
+ * Events matching any of these patterns will be filtered out before comparison.
+ */
+export type EventIgnorePattern = Record<string, unknown>;
+/**
+ * Options for configuring snapshot comparison behavior.
+ */
+export interface SnapshotOptions {
+    /**
+     * Properties to ignore before comparison. Values are replaced with "[IGNORED]" placeholder.
+     * Supports exact field names and wildcard patterns (`prefix.*`).
+     *
+     * Examples:
+     * - `"start_time"` → value replaced with "[IGNORED]"
+     * - `"inp.*"` → all fields starting with `inp.` have values replaced with "[IGNORED]"
+     *
+     * Default: DEFAULT_IGNORED_FIELDS
+     */
+    ignoredFields?: string[];
+    /**
+     * Properties to remove entirely before comparison.
+     * Supports exact field names and wildcard patterns (`prefix.*`).
+     *
+     * Examples:
+     * - `"start_time"` → field is removed from the event
+     * - `"inp.*"` → all fields starting with `inp.` are removed
+     *
+     * Default: DEFAULT_REMOVED_FIELDS
+     */
+    removedFields?: string[];
+    /**
+     * Event patterns to completely ignore during snapshot comparison.
+     * Events matching any of these patterns will be filtered out.
+     * Default: DEFAULT_IGNORED_EVENTS
+     */
+    ignoreEvents?: EventIgnorePattern[];
+    /**
+     * Custom snapshot name. If not provided, auto-generated from test name.
+     */
+    name?: string;
+}
+/**
+ * Default properties that are ignored (replaced with "[IGNORED]") in snapshots to prevent flaky tests.
+ * These fields typically contain volatile values like timestamps, IDs, and durations
+ * that change between test runs.
+ */
+export declare const DEFAULT_IGNORED_FIELDS: readonly string[];
+/**
+ * Default properties that are removed entirely from snapshots to prevent flaky tests.
+ * These fields vary in count or presence between test runs.
+ */
+export declare const DEFAULT_REMOVED_FIELDS: readonly string[];
+/**
+ * Default event patterns that are ignored during snapshot comparison.
+ * These events are volatile and may or may not be recorded depending on browser performance.
+ */
+export declare const DEFAULT_IGNORED_EVENTS: readonly EventIgnorePattern[];
+/**
+ * Placeholder value used to replace ignored property values.
+ */
+export declare const IGNORED_PLACEHOLDER = "[IGNORED]";
+/**
+ * Processes events by ignoring and removing specified properties.
+ * - Ignored properties have their values replaced with "[IGNORED]" placeholder
+ * - Removed properties are deleted entirely from the event
+ *
+ * @param events        Array of event objects to process
+ * @param ignoredFields Array of field paths to ignore (values replaced with placeholder)
+ * @param removedFields Array of field paths to remove entirely
+ * @returns             Deep copy of events with specified fields processed
+ */
+export declare function processEventProperties(events: Record<string, unknown>[], ignoredFields?: readonly string[], removedFields?: readonly string[]): Record<string, unknown>[];
+/**
+ * Filters out events that match any of the ignore patterns.
+ * An event matches a pattern if all properties in the pattern exist in the event with the same values.
+ *
+ * @param events         Array of events to filter
+ * @param ignorePatterns Array of patterns to match against
+ * @returns              Filtered array excluding events that match any pattern
+ */
+export declare function filterIgnoredEvents(events: Record<string, unknown>[], ignorePatterns?: readonly EventIgnorePattern[]): Record<string, unknown>[];
+/**
+ * Reads a snapshot file from disk.
+ * Returns an object indicating whether the file exists and its parsed contents.
+ *
+ * @param snapshotPath Absolute path to the snapshot file
+ * @returns            Object with exists flag and parsed data
+ * @throws             Error if the file contains invalid JSON or is not an array of records
+ */
+export declare function readSnapshot(snapshotPath: string): SnapshotReadResult;
+/**
+ * Writes snapshot data to disk.
+ * Creates parent directories if they don't exist.
+ * Events are sorted by characteristics for consistent ordering.
+ * Uses deterministic JSON serialization with sorted keys for consistent diffs.
+ *
+ * @param snapshotPath Absolute path to the snapshot file
+ * @param data         Array of events to write
+ */
+export declare function writeSnapshot(snapshotPath: string, data: Record<string, unknown>[]): void;
+/**
+ * Sorts events by their characteristics signature for order-independent comparison.
+ * Events with the same characteristics are further sorted by other stable properties.
+ * This ensures consistent ordering regardless of event arrival order.
+ *
+ * @param events Array of events to sort
+ * @returns      New array with events sorted by characteristics
+ */
+export declare function sortEventsByCharacteristics(events: Record<string, unknown>[]): Record<string, unknown>[];
+export {};