@atlaskit/editor-common 110.25.0 → 110.25.2

package/dist/types-ts4.5/experiences/Experience.d.ts

@@ -1,10 +1,30 @@
-import { type CustomData } from '@atlaskit/ufo';
+import type { CustomData } from '@atlaskit/ufo';
+import type { DispatchAnalyticsEvent } from '../analytics';
 import type { ExperienceCheck } from './ExperienceCheck';
 type ExperienceOptions = {
     /**
-     * Checks used to determine experience completion, either success, or failure.
+     * Checks used to control experience transition to various states.
+     * Once the experience is in progress, these checks can automatically trigger
+     * state transitions (e.g., timeout check to trigger failure).
      */
     checks?: ExperienceCheck[];
+    /**
+     * Function to dispatch analytics events for experience tracking.
+     * Required for tracking experienceMeasured and experienceSampled events.
+     */
+    dispatchAnalyticsEvent: DispatchAnalyticsEvent;
+    /**
+     * Sample rate for experienceSampled events.
+     * Determines how frequently we should track events for the experience based on
+     * expected volume. Value should be between 0 and 1.
+     *
+     * @default DEFAULT_EXPERIENCE_SAMPLE_RATE (0.001 = 1 in 1000)
+     *
+     * Newly defined experiences should use the default unless they have data
+     * to justify a different rate. Measurements should be gathered after initial
+     * instrumentation, then the sample rate can be tuned up to a safe threshold.
+     */
+    sampleRate?: number;
 };
 type ExperienceStartOptions = {
     metadata?: CustomData;
@@ -14,21 +34,49 @@ type ExperienceEndOptions = {
 };
 export declare class Experience {
     private readonly id;
-    private readonly options;
-    private _ufoExperience;
+    private readonly dispatchAnalyticsEvent;
+    private readonly sampleRate;
     private check;
     private startOptions;
-    constructor(id: string, options?: ExperienceOptions);
-    private get ufoExperience();
+    private currentState;
+    private statesSeen;
+    /**
+     * Indicates whether sampled tracking is enabled for this current experience session.
+     *
+     * Set to true | false upon transitioning to 'started' state.
+     * When true, on subsequent transitions we fire experienceSampled events.
+     * Ensures that every tracked start has corresponding abort/fail/success tracked.
+     */
+    private isSampledTrackingEnabled;
+    constructor(id: string, options: ExperienceOptions);
     private startCheck;
     private stopCheck;
-    private isInProgress;
     private getEndStateConfig;
+    /**
+     * Transitions to a new experience state and tracks analytics events.
+     *
+     * Upon transition to each state, two events are tracked:
+     * - experienceMeasured: tracked on every successful transition, used for data analysis
+     * - experienceSampled: tracked only on 1 out of every N transitions based on sample rate
+     *
+     * @param toState - The target state to transition to
+     * @param metadata - Optional metadata to attach to the analytics events
+     * @returns true if transition was successful, false if invalid transition
+     */
+    private transitionTo;
+    /**
+     * Tracks analytics events for a state transition.
+     *
+     * Fires both experienceMeasured (always) and experienceSampled (sampled) events.
+     *
+     * @param toState - The state that was transitioned to
+     * @param metadata - Metadata to include in the event, including firstInSession flag
+     */
+    private trackTransition;
     /**
      * Starts tracking the experience and all checks which monitor for completion.
      *
-     * If the experience is already in progress, this will restart the checks.
-     * Metadata from options will be merged with any end state metadata.
+     * Metadata from options will be merged with metadata provided in subsequent events.
      *
      * @param options - Configuration for starting the experience
      * @param options.metadata - Optional metadata attached to all subsequent events for this started experience
@@ -37,8 +85,6 @@ export declare class Experience {
     /**
      * Marks the experience as successful and stops any ongoing checks.
      *
-     * Use this when the experience completes as expected.
-     *
      * @param options - Configuration for the success event
      * @param options.metadata - Optional metadata attached to the success event
      */

package/dist/types-ts4.5/experiences/consts.d.ts

@@ -18,3 +18,13 @@ export declare const EXPERIENCE_FAILURE_REASON: {
      */
     readonly DOM_MUTATION_CHECK_ERROR: "dom-mutation-check-error";
 };
+/**
+ * Default sample rate for experienceSampled events.
+ * Set to 1 in 1000 (0.001) to balance data collection with event volume.
+ *
+ * Newly defined experiences should use this default unless they have data
+ * to justify a different rate. The expectation is that measurements will be
+ * gathered after initial instrumentation, then the sample rate can be tuned
+ * up to a safe threshold.
+ */
+export declare const DEFAULT_EXPERIENCE_SAMPLE_RATE = 0.001;

package/dist/types-ts4.5/experiences/experience-state.d.ts

@@ -0,0 +1,16 @@
+/**
+ * Represents the state of an experience throughout its lifecycle.
+ */
+export type ExperienceState = 'pending' | 'started' | 'aborted' | 'failed' | 'succeeded';
+/**
+ * State transition map defining valid state transitions.
+ */
+export declare const EXPERIENCE_STATE_TRANSITIONS: Record<ExperienceState, ExperienceState[]>;
+/**
+ * Validates whether a state transition is allowed.
+ *
+ * @param fromState - The current state
+ * @param toState - The target state to transition to
+ * @returns true if the transition is valid, false otherwise
+ */
+export declare const canTransition: (fromState: ExperienceState, toState: ExperienceState) => boolean;

package/dist/types-ts4.5/styles/shared/table.d.ts

@@ -13,6 +13,7 @@ export declare const tableControlsSpacing: number;
 export declare const TableSharedCssClassName: {
     readonly TABLE_CONTAINER: "pm-table-container";
     readonly TABLE_NODE_WRAPPER: "pm-table-wrapper";
+    readonly TABLE_NODE_WRAPPER_NO_OVERFLOW: "pm-table-wrapper-no-overflow";
     readonly TABLE_SCROLL_INLINE_SHADOW: "pm-table-scroll-inline-shadow";
     readonly TABLE_RIGHT_BORDER: "pm-table-right-border";
     readonly TABLE_LEFT_BORDER: "pm-table-left-border";

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@atlaskit/editor-common",
-	"version": "110.25.0",
+	"version": "110.25.2",
 	"description": "A package that contains common classes and components for editor and renderer",
 	"publishConfig": {
 		"registry": "https://registry.npmjs.org/"
@@ -57,7 +57,7 @@
 		"@atlaskit/link-datasource": "^4.29.0",
 		"@atlaskit/link-picker": "^3.16.0",
 		"@atlaskit/media-card": "^79.6.0",
-		"@atlaskit/media-client": "^35.5.0",
+		"@atlaskit/media-client": "^35.6.0",
 		"@atlaskit/media-client-react": "^4.1.0",
 		"@atlaskit/media-common": "^12.3.0",
 		"@atlaskit/media-file-preview": "^0.11.0",
@@ -82,7 +82,7 @@
 		"@atlaskit/task-decision": "^19.2.0",
 		"@atlaskit/textfield": "^8.0.0",
 		"@atlaskit/theme": "^21.0.0",
-		"@atlaskit/tmp-editor-statsig": "^13.32.0",
+		"@atlaskit/tmp-editor-statsig": "^13.34.0",
 		"@atlaskit/tokens": "^8.0.0",
 		"@atlaskit/tooltip": "^20.8.0",
 		"@atlaskit/ufo": "^0.4.0",