@dynatrace/rum-javascript-sdk 1.329.2

package/dist/types/user-actions/user-action-start-options.d.ts

@@ -0,0 +1,23 @@
+/**
+ * Options to create a user action with.
+ *
+ * @category User Actions
+ * @experimental
+ */
+export interface UserActionStartOptions {
+    /**
+     * Automatically closes the user action upon timeout, page hide or when new user action is detected.
+     *
+     * default: true
+     */
+    autoClose?: boolean;
+    /**
+     * The unix timestamp indicating when the user action should start. Future timestamps are not supported - use current
+     * or past timestamps.
+     */
+    startTime?: number;
+    /**
+     * A human-readable name to identify the user action.
+     */
+    name?: string;
+}

package/dist/types/user-actions/user-action-start-options.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoidXNlci1hY3Rpb24tc3RhcnQtb3B0aW9ucy5qcyIsInNvdXJjZVJvb3QiOiIiLCJzb3VyY2VzIjpbIi4uLy4uLy4uL3NvdXJjZS90eXBlcy91c2VyLWFjdGlvbnMvdXNlci1hY3Rpb24tc3RhcnQtb3B0aW9ucy50cyJdLCJuYW1lcyI6W10sIm1hcHBpbmdzIjoiIiwic291cmNlc0NvbnRlbnQiOlsiLyoqXG4gKiBPcHRpb25zIHRvIGNyZWF0ZSBhIHVzZXIgYWN0aW9uIHdpdGguXG4gKlxuICogQGNhdGVnb3J5IFVzZXIgQWN0aW9uc1xuICogQGV4cGVyaW1lbnRhbFxuICovXG5leHBvcnQgaW50ZXJmYWNlIFVzZXJBY3Rpb25TdGFydE9wdGlvbnMge1xuICAgIC8qKlxuICAgICAqIEF1dG9tYXRpY2FsbHkgY2xvc2VzIHRoZSB1c2VyIGFjdGlvbiB1cG9uIHRpbWVvdXQsIHBhZ2UgaGlkZSBvciB3aGVuIG5ldyB1c2VyIGFjdGlvbiBpcyBkZXRlY3RlZC5cbiAgICAgKlxuICAgICAqIGRlZmF1bHQ6IHRydWVcbiAgICAgKi9cbiAgICBhdXRvQ2xvc2U/OiBib29sZWFuO1xuXG4gICAgLyoqXG4gICAgICogVGhlIHVuaXggdGltZXN0YW1wIGluZGljYXRpbmcgd2hlbiB0aGUgdXNlciBhY3Rpb24gc2hvdWxkIHN0YXJ0LiBGdXR1cmUgdGltZXN0YW1wcyBhcmUgbm90IHN1cHBvcnRlZCAtIHVzZSBjdXJyZW50XG4gICAgICogb3IgcGFzdCB0aW1lc3RhbXBzLlxuICAgICAqL1xuICAgIHN0YXJ0VGltZT86IG51bWJlcjtcblxuICAgIC8qKlxuICAgICAqIEEgaHVtYW4tcmVhZGFibGUgbmFtZSB0byBpZGVudGlmeSB0aGUgdXNlciBhY3Rpb24uXG4gICAgICovXG4gICAgbmFtZT86IHN0cmluZztcbn1cbiJdfQ==

package/dist/types/user-actions/user-action-tracker.d.ts

@@ -0,0 +1,72 @@
+import type { Unsubscriber } from "../api/dynatrace-api-types.js";
+import type { UserActionEndEvent } from "./user-action-end-event.js";
+/**
+ * An object to work with user actions.
+ *
+ * @category User Actions
+ * @experimental
+ */
+export interface UserActionTracker {
+    /**
+     * Completes this user action and sends a user action event for it.
+     */
+    finish(): void;
+    /**
+     * Subscribes to this user action to be notified when it would automatically complete.
+     *
+     * @param subscriber The listener to be called.
+     */
+    subscribe(subscriber: (event: UserActionEndEvent) => void): Unsubscriber;
+    /**
+     * Allows to configure this user action to stop automatically.
+     *
+     * @param stopAutomatically If set to false, the user action has to be stopped with a call to {@link finish}.
+     */
+    set autoClose(stopAutomatically: boolean);
+    /**
+     * @returns True if this user action stops automatically. If false, the user action has to be stopped with a call to {@link finish}.
+     */
+    get autoClose(): boolean;
+    /**
+     * Retrieves the current state of the user action, which can be either "active" or "complete".
+     *
+     * @returns The current state of the user action.
+     */
+    get state(): "active" | "complete";
+    /**
+     * Sets the event properties for the user action.
+     *
+     * @param properties The properties to set for the event.
+     */
+    set event_properties(properties: Record<`event_properties.${string}`, string | number | boolean> | undefined);
+    /**
+     * Retrieves the event properties for the user action.
+     *
+     * @returns The event properties for the user action.
+     */
+    get event_properties(): Record<`event_properties.${string}`, string | number | boolean> | undefined;
+    /**
+     * Retrieves the start time of the user action.
+     *
+     * @returns The start time of the user action.
+     */
+    get startTime(): number;
+    /**
+     * Sets the start time of the user action.
+     *
+     * @param value The start time to set for the user action. Must not be in the future.
+     */
+    set startTime(value: number);
+    /**
+     * Retrieves the name of the user action.
+     *
+     * @returns The name of the user action.
+     */
+    get name(): string | undefined;
+    /**
+     * Sets the name of the user action.
+     *
+     * @param value The name to set for the user action.
+     */
+    set name(value: string | undefined);
+}

package/dist/types/user-actions/user-action-tracker.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoidXNlci1hY3Rpb24tdHJhY2tlci5qcyIsInNvdXJjZVJvb3QiOiIiLCJzb3VyY2VzIjpbIi4uLy4uLy4uL3NvdXJjZS90eXBlcy91c2VyLWFjdGlvbnMvdXNlci1hY3Rpb24tdHJhY2tlci50cyJdLCJuYW1lcyI6W10sIm1hcHBpbmdzIjoiIiwic291cmNlc0NvbnRlbnQiOlsiaW1wb3J0IHR5cGUgeyBVbnN1YnNjcmliZXIgfSBmcm9tIFwiLi4vYXBpL2R5bmF0cmFjZS1hcGktdHlwZXMuanNcIjtcbmltcG9ydCB0eXBlIHsgVXNlckFjdGlvbkVuZEV2ZW50IH0gZnJvbSBcIi4vdXNlci1hY3Rpb24tZW5kLWV2ZW50LmpzXCI7XG5cbi8qKlxuICogQW4gb2JqZWN0IHRvIHdvcmsgd2l0aCB1c2VyIGFjdGlvbnMuXG4gKlxuICogQGNhdGVnb3J5IFVzZXIgQWN0aW9uc1xuICogQGV4cGVyaW1lbnRhbFxuICovXG5leHBvcnQgaW50ZXJmYWNlIFVzZXJBY3Rpb25UcmFja2VyIHtcbiAgICAvKipcbiAgICAgKiBDb21wbGV0ZXMgdGhpcyB1c2VyIGFjdGlvbiBhbmQgc2VuZHMgYSB1c2VyIGFjdGlvbiBldmVudCBmb3IgaXQuXG4gICAgICovXG4gICAgZmluaXNoKCk6IHZvaWQ7XG5cbiAgICAvKipcbiAgICAgKiBTdWJzY3JpYmVzIHRvIHRoaXMgdXNlciBhY3Rpb24gdG8gYmUgbm90aWZpZWQgd2hlbiBpdCB3b3VsZCBhdXRvbWF0aWNhbGx5IGNvbXBsZXRlLlxuICAgICAqXG4gICAgICogQHBhcmFtIHN1YnNjcmliZXIgVGhlIGxpc3RlbmVyIHRvIGJlIGNhbGxlZC5cbiAgICAgKi9cbiAgICBzdWJzY3JpYmUoc3Vic2NyaWJlcjogKGV2ZW50OiBVc2VyQWN0aW9uRW5kRXZlbnQpID0+IHZvaWQpOiBVbnN1YnNjcmliZXI7XG5cbiAgICAvKipcbiAgICAgKiBBbGxvd3MgdG8gY29uZmlndXJlIHRoaXMgdXNlciBhY3Rpb24gdG8gc3RvcCBhdXRvbWF0aWNhbGx5LlxuICAgICAqXG4gICAgICogQHBhcmFtIHN0b3BBdXRvbWF0aWNhbGx5IElmIHNldCB0byBmYWxzZSwgdGhlIHVzZXIgYWN0aW9uIGhhcyB0byBiZSBzdG9wcGVkIHdpdGggYSBjYWxsIHRvIHtAbGluayBmaW5pc2h9LlxuICAgICAqL1xuICAgIHNldCBhdXRvQ2xvc2Uoc3RvcEF1dG9tYXRpY2FsbHk6IGJvb2xlYW4pO1xuXG4gICAgLyoqXG4gICAgICogQHJldHVybnMgVHJ1ZSBpZiB0aGlzIHVzZXIgYWN0aW9uIHN0b3BzIGF1dG9tYXRpY2FsbHkuIElmIGZhbHNlLCB0aGUgdXNlciBhY3Rpb24gaGFzIHRvIGJlIHN0b3BwZWQgd2l0aCBhIGNhbGwgdG8ge0BsaW5rIGZpbmlzaH0uXG4gICAgICovXG4gICAgZ2V0IGF1dG9DbG9zZSgpOiBib29sZWFuO1xuXG4gICAgLyoqXG4gICAgICogUmV0cmlldmVzIHRoZSBjdXJyZW50IHN0YXRlIG9mIHRoZSB1c2VyIGFjdGlvbiwgd2hpY2ggY2FuIGJlIGVpdGhlciBcImFjdGl2ZVwiIG9yIFwiY29tcGxldGVcIi5cbiAgICAgKlxuICAgICAqIEByZXR1cm5zIFRoZSBjdXJyZW50IHN0YXRlIG9mIHRoZSB1c2VyIGFjdGlvbi5cbiAgICAgKi9cbiAgICBnZXQgc3RhdGUoKTogXCJhY3RpdmVcIiB8IFwiY29tcGxldGVcIjtcblxuICAgIC8qKlxuICAgICAqIFNldHMgdGhlIGV2ZW50IHByb3BlcnRpZXMgZm9yIHRoZSB1c2VyIGFjdGlvbi5cbiAgICAgKlxuICAgICAqIEBwYXJhbSBwcm9wZXJ0aWVzIFRoZSBwcm9wZXJ0aWVzIHRvIHNldCBmb3IgdGhlIGV2ZW50LlxuICAgICAqL1xuICAgIHNldCBldmVudF9wcm9wZXJ0aWVzKHByb3BlcnRpZXM6IFJlY29yZDxgZXZlbnRfcHJvcGVydGllcy4ke3N0cmluZ31gLCBzdHJpbmcgfCBudW1iZXIgfCBib29sZWFuPiB8IHVuZGVmaW5lZCk7XG5cbiAgICAvKipcbiAgICAgKiBSZXRyaWV2ZXMgdGhlIGV2ZW50IHByb3BlcnRpZXMgZm9yIHRoZSB1c2VyIGFjdGlvbi5cbiAgICAgKlxuICAgICAqIEByZXR1cm5zIFRoZSBldmVudCBwcm9wZXJ0aWVzIGZvciB0aGUgdXNlciBhY3Rpb24uXG4gICAgICovXG4gICAgZ2V0IGV2ZW50X3Byb3BlcnRpZXMoKTogUmVjb3JkPGBldmVudF9wcm9wZXJ0aWVzLiR7c3RyaW5nfWAsIHN0cmluZyB8IG51bWJlciB8IGJvb2xlYW4+IHwgdW5kZWZpbmVkO1xuXG4gICAgLyoqXG4gICAgICogUmV0cmlldmVzIHRoZSBzdGFydCB0aW1lIG9mIHRoZSB1c2VyIGFjdGlvbi5cbiAgICAgKlxuICAgICAqIEByZXR1cm5zIFRoZSBzdGFydCB0aW1lIG9mIHRoZSB1c2VyIGFjdGlvbi5cbiAgICAgKi9cbiAgICBnZXQgc3RhcnRUaW1lKCk6IG51bWJlcjtcblxuICAgIC8qKlxuICAgICAqIFNldHMgdGhlIHN0YXJ0IHRpbWUgb2YgdGhlIHVzZXIgYWN0aW9uLlxuICAgICAqXG4gICAgICogQHBhcmFtIHZhbHVlIFRoZSBzdGFydCB0aW1lIHRvIHNldCBmb3IgdGhlIHVzZXIgYWN0aW9uLiBNdXN0IG5vdCBiZSBpbiB0aGUgZnV0dXJlLlxuICAgICAqL1xuICAgIHNldCBzdGFydFRpbWUodmFsdWU6IG51bWJlcik7XG5cbiAgICAvKipcbiAgICAgKiBSZXRyaWV2ZXMgdGhlIG5hbWUgb2YgdGhlIHVzZXIgYWN0aW9uLlxuICAgICAqXG4gICAgICogQHJldHVybnMgVGhlIG5hbWUgb2YgdGhlIHVzZXIgYWN0aW9uLlxuICAgICAqL1xuICAgIGdldCBuYW1lKCk6IHN0cmluZyB8IHVuZGVmaW5lZDtcblxuICAgIC8qKlxuICAgICAqIFNldHMgdGhlIG5hbWUgb2YgdGhlIHVzZXIgYWN0aW9uLlxuICAgICAqXG4gICAgICogQHBhcmFtIHZhbHVlIFRoZSBuYW1lIHRvIHNldCBmb3IgdGhlIHVzZXIgYWN0aW9uLlxuICAgICAqL1xuICAgIHNldCBuYW1lKHZhbHVlOiBzdHJpbmcgfCB1bmRlZmluZWQpO1xufVxuIl19

package/package.json

@@ -0,0 +1,115 @@
+{
+    "name": "@dynatrace/rum-javascript-sdk",
+    "version": "1.329.2",
+    "description": "JavaScript API for Real User Monitoring (RUM)",
+    "sideEffects": false,
+    "type": "module",
+    "types": "./dist/types/index.d.ts",
+    "files": [
+        "dist/api/**/*.js",
+        "dist/api/**/*.d.ts",
+        "dist/types/**/*.js",
+        "dist/types/**/*.d.ts",
+        "dist/testing/**/*.js",
+        "dist/testing/**/*.d.ts"
+    ],
+    "exports": {
+        "./api": {
+            "types": "./dist/api/index.d.ts",
+            "import": "./dist/api/index.js",
+            "default": "./dist/api/index.js"
+        },
+        "./api/user-actions": {
+            "types": "./dist/api/user-actions.d.ts",
+            "import": "./dist/api/user-actions.js",
+            "default": "./dist/api/user-actions.js"
+        },
+        "./api/promises/user-actions": {
+            "types": "./dist/api/promises/user-actions.d.ts",
+            "import": "./dist/api/promises/user-actions.js",
+            "default": "./dist/api/promises/user-actions.js"
+        },
+        "./api/promises": {
+            "types": "./dist/api/promises/index.d.ts",
+            "import": "./dist/api/promises/index.js",
+            "default": "./dist/api/promises/index.js"
+        },
+        "./internal": {
+            "types": "./dist/types/internal/index.d.ts",
+            "import": "./dist/types/internal/index.js",
+            "default": "./dist/types/internal/index.js"
+        },
+        "./test": {
+            "types": "./dist/testing/test.d.ts",
+            "import": "./dist/testing/test.js",
+            "default": "./dist/testing/test.js"
+        },
+        "./types": {
+            "types": "./dist/types/index.d.ts",
+            "import": "./dist/types/index.js",
+            "default": "./dist/types/index.js"
+        },
+        "./types/user-actions": {
+            "types": "./dist/types/user-actions/index.d.ts",
+            "import": "./dist/types/user-actions/index.js",
+            "default": "./dist/types/user-actions/index.js"
+        },
+        "./types/api": {
+            "types": "./dist/types/api/index.d.ts",
+            "import": "./dist/types/api/index.js",
+            "default": "./dist/types/api/index.js"
+        },
+        "./types/rum-events": {
+            "types": "./dist/types/rum-events/index.d.ts",
+            "import": "./dist/types/rum-events/index.js",
+            "default": "./dist/types/rum-events/index.js"
+        },
+        "./types/rum-events/event-context": {
+            "types": "./dist/types/rum-events/event-context/index.d.ts",
+            "import": "./dist/types/rum-events/event-context/index.js",
+            "default": "./dist/types/rum-events/event-context/index.js"
+        },
+        "./types/rum-events/shared-namespaces-and-fields": {
+            "types": "./dist/types/rum-events/shared-namespaces-and-fields/index.d.ts",
+            "import": "./dist/types/rum-events/shared-namespaces-and-fields/index.js",
+            "default": "./dist/types/rum-events/shared-namespaces-and-fields/index.js"
+        }
+    },
+    "scripts": {
+        "build:lib": "tsc -b tsconfig.build.json",
+        "test": "vitest --run --no-color --coverage",
+        "lint": "eslint \"source/**/*.ts\" \"./*.{ts,js,mjs}\"",
+        "lint:fix": "eslint \"source/**/*.ts\" \"./*.{ts,js,mjs}\" --fix && echo No Lint-Problems found",
+        "//": "Note: these 2 scripts below are only for local builds. The CI build in build.groovy needs to be updated as well if there are any changes",
+        "doc:api-gen3-internal": "typedoc --treatWarningsAsErrors --options ./typedoc-gen3-internal.api.json --tsconfig ./tsconfig-gen3.apidoc.json --plugin typedoc-plugin-mdn-links",
+        "doc:api-gen3-public": "typedoc --treatWarningsAsErrors --options ./typedoc-gen3-public.api.json --tsconfig ./tsconfig-gen3.apidoc.json --plugin typedoc-plugin-mdn-links",
+        "find-deadcode": "knip"
+    },
+    "keywords": [
+        "dynatrace",
+        "rum",
+        "real-user-monitoring",
+        "javascript",
+        "api"
+    ],
+    "dependencies": {
+        "snappyjs": "0.7.0"
+    },
+    "peerDependencies": {
+        "@playwright/test": "^1.52.0"
+    },
+    "author": "Dynatrace",
+    "license": "ISC",
+    "devDependencies": {
+        "@types/node": "catalog:",
+        "@vitest/coverage-v8": "catalog:",
+        "@vitest/ui": "catalog:",
+        "eslint": "catalog:",
+        "jsdom": "catalog:",
+        "knip": "catalog:",
+        "typedoc": "catalog:",
+        "typedoc-plugin-mdn-links": "catalog:",
+        "typescript": "catalog:",
+        "vitest": "catalog:"
+    }
+}