@atlaskit/react-ufo 5.0.13 → 5.1.0

package/dist/types-ts4.5/experience-trace-id-context/context-manager.d.ts

@@ -0,0 +1,65 @@
+import { type Context, type ContextManager } from '@opentelemetry/api';
+export declare function setContextManager(ctxMgr: ContextManager): void;
+export declare function getContextManager(): ContextManager;
+/**
+ * The below is shamelessly borrowed from StackContextManager from @opentelemetry/sdk-trace-web
+ * Using this rather than importing the entire package because this is all we need for now
+ */
+/**
+ * UFO Context Manager for managing the state in web
+ * it doesn't fully support the async calls though
+ */
+export declare class UFOContextManager implements ContextManager {
+    /**
+     * whether the context manager is enabled or not
+     */
+    private _enabled;
+    /**
+     * Keeps the reference to current context
+     */
+    _currentContext: Context;
+    /**
+     *
+     * @param context
+     * @param target Function to be executed within the context
+     */
+    private _bindFunction;
+    /**
+     * Returns the active context
+     */
+    active(): Context;
+    /**
+     * Binds a the certain context or the active one to the target function and then returns the target
+     * @param context A context (span) to be bind to target
+     * @param target a function or event emitter. When target or one of its callbacks is called,
+     *  the provided context will be used as the active context for the duration of the call.
+     */
+    bind<T>(context: Context, target: T): T;
+    /**
+     * Disable the context manager (clears the current context)
+     */
+    disable(): this;
+    /**
+     * Enables the context manager and creates a default(root) context
+     */
+    enable(): this;
+    /**
+     * Calls the callback function [fn] with the provided [context]. If [context] is undefined then it will use the window.
+     * The context will be set as active
+     * @param context
+     * @param fn Callback function
+     * @param thisArg optional receiver to be used for calling fn
+     * @param args optional arguments forwarded to fn
+     */
+    with<A extends unknown[], F extends (...args: A) => ReturnType<F>>(context: Context | null, fn: F, thisArg?: ThisParameterType<F>, ...args: A): ReturnType<F>;
+    /**
+     * Sets the active context.
+     * This function is an extension of the OTel spec, in order to facilitate the current API of React UFO trace context handling.
+     * It doesn't keep track of any previously set active contexts, because it's assumed (for now) that only one trace context
+     * will ever exist at a time.
+     * The next step in the work to improve tracing in the FE will likely remove this function as we need to track the
+     * hierarchy of contexts (likely using the `with()` function above).
+     * @param context The context to be made the globally active one
+     */
+    setActive(context: Context): void;
+}

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@atlaskit/react-ufo",
-	"version": "5.0.13",
+	"version": "5.1.0",
 	"description": "Parts of React UFO that are publicly available",
 	"author": "Atlassian Pty Ltd",
 	"license": "Apache-2.0",
@@ -32,6 +32,7 @@
 		"@atlaskit/interaction-context": "^3.1.0",
 		"@atlaskit/platform-feature-flags": "^1.1.0",
 		"@babel/runtime": "^7.0.0",
+		"@opentelemetry/api": "^1.9.0",
 		"bind-event-listener": "^3.0.0",
 		"bowser-ultralight": "^1.0.6",
 		"scheduler": "0.23.2",
@@ -42,7 +43,7 @@
 	},
 	"devDependencies": {
 		"@af/integration-testing": "workspace:^",
-		"@atlassian/a11y-jest-testing": "^0.8.0",
+		"@atlassian/a11y-jest-testing": "^0.9.0",
 		"@atlassian/feature-flags-test-utils": "^1.0.0",
 		"@testing-library/react": "^16.3.0",
 		"@types/is-ci": "^3.0.0",
@@ -193,6 +194,9 @@
 		"platform_ufo_keypress_interaction_abort": {
 			"type": "boolean"
 		},
+		"platform_ufo_enable_otel_context_manager": {
+			"type": "boolean"
+		},
 		"platform_ufo_raw_data_thirdparty": {
 			"type": "boolean"
 		},