@atlaskit/editor-common 110.18.3 → 110.18.5

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

@@ -1,3 +1,4 @@
+import { type CustomData } from '@atlaskit/ufo';
 import type { ExperienceCheck } from './ExperienceCheck';
 type ExperienceOptions = {
     /**
@@ -5,37 +6,67 @@ type ExperienceOptions = {
      */
     checks?: ExperienceCheck[];
 };
-type ExperienceFailureOptions = {
-    reason?: string;
+type ExperienceStartOptions = {
+    metadata?: CustomData;
+};
+type ExperienceEndOptions = {
+    metadata?: CustomData;
 };
 export declare class Experience {
     private readonly id;
     private readonly options;
     private _ufoExperience;
     private check;
+    private startOptions;
     constructor(id: string, options?: ExperienceOptions);
     private get ufoExperience();
     private startCheck;
     private stopCheck;
     private isInProgress;
+    private getEndStateConfig;
     /**
-     * Starts UFO experience tracking and starts all checks which monitor for completion of the experience.
+     * 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.
+     *
+     * @param options - Configuration for starting the experience
+     * @param options.metadata - Optional metadata attached to all subsequent events for this started experience
      */
-    start(): void;
+    start(options?: ExperienceStartOptions): void;
     /**
-     * Manually mark the experience as successful and stop any ongoing checks.
+     * 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
      */
-    success(): void;
+    success(options?: ExperienceEndOptions): void;
     /**
-     * Manually abort the experience and stop any ongoing checks.
+     * Aborts the experience and stops any ongoing checks.
      *
-     * Typically used when the experience did not complete due to user action and should not be marked as success or failure,
-     * for example on unmount or when navigating away from a page.
+     * Use this when a started experience terminates early due to user action or context change
+     * (e.g., component unmount, navigation). This is neither success nor failure.
+     *
+     * @param options - Configuration for the abort event
+     * @param options.metadata - Optional metadata attached to the abort event
+     *
+     * @example
+     * // Abort on component unmount
+     * useEffect(() => {
+     *   return () => experience.abort({ metadata: { reason: 'unmount' } });
+     * }, []);
      */
-    abort(): void;
+    abort(options?: ExperienceEndOptions): void;
     /**
-     * Manually mark the experience as failed and stop any ongoing checks.
+     * Manually marks the experience as failed and stops any ongoing checks.
+     *
+     * Use this for actual failures in the experience flow (e.g., timeout, error conditions).
+     *
+     * @param options - Configuration for the failure event
+     * @param options.metadata - Optional metadata attached to the failure event
      */
-    failure({ reason }?: ExperienceFailureOptions): void;
+    failure(options?: ExperienceEndOptions): void;
 }
 export {};

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

@@ -1,11 +1,9 @@
-type ExperienceCheckSuccessResult = {
-    status: 'success';
+import type { CustomData } from '@atlaskit/ufo';
+type ExperienceCheckResultStatus = 'success' | 'failure' | 'abort';
+export type ExperienceCheckResult = {
+    metadata?: CustomData;
+    status: ExperienceCheckResultStatus;
 };
-type ExperienceCheckFailureResult = {
-    reason?: string;
-    status: 'failure';
-};
-export type ExperienceCheckResult = ExperienceCheckSuccessResult | ExperienceCheckFailureResult;
 export type ExperienceCheckCallback = (result: ExperienceCheckResult) => void;
 export interface ExperienceCheck {
     start: (callback: ExperienceCheckCallback) => void;

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

@@ -5,9 +5,21 @@ export type ExperienceDomMutationCheckOptions = {
 export type ExperienceCheckDomMutationObserveConfig = {
     /**
      * MutationObserver options specifying what types of mutations to observe
+     *
+     * !!IMPORTANT!!
+     * For performance reasons, avoid observing more mutation types than necessary.
+     *
+     * We explicitly only support a subset of MutationObserverInit options that
+     * are relevant for most use cases and less likely to cause performance issues.
+     *
+     * These include:
+     * - childList: adding/removing child nodes directly under the target node
+     * - attributes: changes to attributes on the target node
+     * - attributeFilter: defines the specific attributes to monitor for changes
+     *
      * @see https://developer.mozilla.org/en-US/docs/Web/API/MutationObserver/observe
      */
-    options?: MutationObserverInit;
+    options?: Pick<MutationObserverInit, 'childList' | 'attributes' | 'attributeFilter'>;
     /**
      * Target element to observe for mutations
      *
@@ -23,16 +35,14 @@ export type ExperienceCheckDomMutationConfig = {
      * - What element to observe (performance: smaller scope = better performance)
      * - What mutations to monitor (performance: fewer types = better performance)
      *
-     * IMPORTANT: Return null if the target element cannot be found.
+     * !!IMPORTANT!!
+     * Return null if the target element cannot be found.
      * This will immediately fail the experience with reason 'target-not-found'.
-     *
-     * Common patterns:
-     * - Safe fallback: { target: document.querySelector('[data-testid="toolbar"]') ?? document.body, options: {...} }
-     * - Explicit null: const target = document.querySelector('[data-testid="toolbar"]'); return target ? { target, options: {...} } : null;
      */
     observeConfig: () => ExperienceCheckDomMutationObserveConfig | null;
     /**
      * Callback invoked when DOM mutations are detected
+     *
      * Return a result to complete the experience, or undefined to continue observing
      */
     onDomMutation: (options: ExperienceDomMutationCheckOptions) => ExperienceCheckResult | undefined;

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

@@ -1,13 +1,28 @@
-import type { ExperienceCheck, ExperienceCheckCallback } from './ExperienceCheck';
+import type { ExperienceCheck, ExperienceCheckCallback, ExperienceCheckResult } from './ExperienceCheck';
+export type ExperienceCheckTimeoutConfig = {
+    /**
+     * Maximum duration in milliseconds before timing out
+     */
+    durationMs: number;
+    /**
+     * Optional callback to provide custom result on timeout
+     *
+     * If not provided, or callback returns undefined, defaults to failure with reason 'timeout'
+     */
+    onTimeout?: () => ExperienceCheckResult | undefined;
+};
 /**
  * Check for the completion of an experience based on a timeout
  *
- * Will always result in failure after the timeout duration
+ * By default, will result in failure with reason 'timeout' after the specified duration.
+ *
+ * Can be customized for different results on timeout via the onTimeout callback.
  */
 export declare class ExperienceCheckTimeout implements ExperienceCheck {
     private timeoutId;
-    private maxDurationMs;
-    constructor(maxDurationMs: number);
+    private durationMs;
+    private onTimeout;
+    constructor({ durationMs, onTimeout, }: ExperienceCheckTimeoutConfig);
     start(callback: ExperienceCheckCallback): void;
     stop(): void;
 }

package/dist/types-ts4.5/extensions/types/utils.d.ts

@@ -13,6 +13,7 @@ export type MenuItem = {
     node: ADFEntity | ExtensionModuleActionHandler;
     summary?: string;
     title: string;
+    priority?: number;
 };
 export type MenuItemMap = {
     [key: string]: MenuItem;

package/dist/types-ts4.5/ui/Popup/index.d.ts

@@ -25,6 +25,7 @@ export interface Props {
     onUnmount?: () => void;
     preventOverflow?: boolean;
     rect?: DOMRect;
+    role?: string;
     scrollableElement?: HTMLElement;
     shouldRenderPopup?: (position: Position) => boolean;
     stick?: boolean;

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@atlaskit/editor-common",
-	"version": "110.18.3",
+	"version": "110.18.5",
 	"description": "A package that contains common classes and components for editor and renderer",
 	"publishConfig": {
 		"registry": "https://registry.npmjs.org/"
@@ -75,14 +75,14 @@
 		"@atlaskit/prosemirror-history": "^0.2.0",
 		"@atlaskit/react-ufo": "^4.12.0",
 		"@atlaskit/section-message": "^8.7.0",
-		"@atlaskit/smart-card": "^43.3.0",
+		"@atlaskit/smart-card": "^43.4.0",
 		"@atlaskit/smart-user-picker": "^8.4.0",
 		"@atlaskit/spinner": "^19.0.0",
 		"@atlaskit/status": "^3.0.0",
 		"@atlaskit/task-decision": "^19.2.0",
 		"@atlaskit/textfield": "^8.0.0",
 		"@atlaskit/theme": "^21.0.0",
-		"@atlaskit/tmp-editor-statsig": "^13.18.0",
+		"@atlaskit/tmp-editor-statsig": "^13.19.0",
 		"@atlaskit/tokens": "^7.0.0",
 		"@atlaskit/tooltip": "^20.6.0",
 		"@atlaskit/ufo": "^0.4.0",
@@ -216,6 +216,9 @@
 		"platform_editor_fix_media_in_renderer": {
 			"type": "boolean"
 		},
+		"platform_editor_a11y_add_role_to_popup": {
+			"type": "boolean"
+		},
 		"cc_comments_log_draft_annotation_ancestor_nodes": {
 			"type": "boolean"
 		},
@@ -245,6 +248,9 @@
 		},
 		"platform_editor_fix_mixed_types_column_sort": {
 			"type": "boolean"
+		},
+		"cc_fd_wb_create_priority_in_slash_menu_enabled": {
+			"type": "boolean"
 		}
 	}
 }

package/afm-dev-agents/tsconfig.json

@@ -1,195 +0,0 @@
-{
-	"extends": "../../../../tsconfig.entry-points.dev-agents.json",
-	"compilerOptions": {
-		"declaration": true,
-		"target": "es5",
-		"outDir": "../../../../../dev-agents/tsDist/@atlaskit__editor-common/app",
-		"rootDir": "../",
-		"composite": true
-	},
-	"include": [
-		"../src/**/*.ts",
-		"../src/**/*.tsx"
-	],
-	"exclude": [
-		"../src/**/__tests__/*",
-		"../src/**/*.test.*",
-		"../src/**/test.*",
-		"../src/**/examples.*",
-		"../src/**/examples/*",
-		"../src/**/examples/**/*",
-		"../src/**/*.stories.*",
-		"../src/**/stories/*",
-		"../src/**/stories/**/*"
-	],
-	"references": [
-		{
-			"path": "../../activity-provider/afm-dev-agents/tsconfig.json"
-		},
-		{
-			"path": "../../adf-utils/afm-dev-agents/tsconfig.json"
-		},
-		{
-			"path": "../../../analytics/analytics-listeners/afm-dev-agents/tsconfig.json"
-		},
-		{
-			"path": "../../../analytics/analytics-namespaced-context/afm-dev-agents/tsconfig.json"
-		},
-		{
-			"path": "../../../analytics/analytics-next/afm-dev-agents/tsconfig.json"
-		},
-		{
-			"path": "../../../uip/atlassian-context/afm-dev-agents/tsconfig.json"
-		},
-		{
-			"path": "../../../design-system/button/afm-dev-agents/tsconfig.json"
-		},
-		{
-			"path": "../../../design-system/code/afm-dev-agents/tsconfig.json"
-		},
-		{
-			"path": "../../../monorepo-tooling/codemod-utils/afm-dev-agents/tsconfig.json"
-		},
-		{
-			"path": "../../../design-system/css/afm-dev-agents/tsconfig.json"
-		},
-		{
-			"path": "../../custom-steps/afm-dev-agents/tsconfig.json"
-		},
-		{
-			"path": "../../../design-system/dropdown-menu/afm-dev-agents/tsconfig.json"
-		},
-		{
-			"path": "../../editor-json-transformer/afm-dev-agents/tsconfig.json"
-		},
-		{
-			"path": "../../editor-palette/afm-dev-agents/tsconfig.json"
-		},
-		{
-			"path": "../../editor-shared-styles/afm-dev-agents/tsconfig.json"
-		},
-		{
-			"path": "../../editor-tables/afm-dev-agents/tsconfig.json"
-		},
-		{
-			"path": "../../editor-toolbar/afm-dev-agents/tsconfig.json"
-		},
-		{
-			"path": "../../editor-toolbar-model/afm-dev-agents/tsconfig.json"
-		},
-		{
-			"path": "../../../elements/emoji/afm-dev-agents/tsconfig.json"
-		},
-		{
-			"path": "../../../design-system/icon/afm-dev-agents/tsconfig.json"
-		},
-		{
-			"path": "../../../design-system/icon-object/afm-dev-agents/tsconfig.json"
-		},
-		{
-			"path": "../../../design-system/link/afm-dev-agents/tsconfig.json"
-		},
-		{
-			"path": "../../../linking-platform/link-datasource/afm-dev-agents/tsconfig.json"
-		},
-		{
-			"path": "../../../linking-platform/link-picker/afm-dev-agents/tsconfig.json"
-		},
-		{
-			"path": "../../../media/media-card/afm-dev-agents/tsconfig.json"
-		},
-		{
-			"path": "../../../media/media-client/afm-dev-agents/tsconfig.json"
-		},
-		{
-			"path": "../../../media/media-client-react/afm-dev-agents/tsconfig.json"
-		},
-		{
-			"path": "../../../media/media-common/afm-dev-agents/tsconfig.json"
-		},
-		{
-			"path": "../../../media/media-file-preview/afm-dev-agents/tsconfig.json"
-		},
-		{
-			"path": "../../../media/media-picker/afm-dev-agents/tsconfig.json"
-		},
-		{
-			"path": "../../../media/media-ui/afm-dev-agents/tsconfig.json"
-		},
-		{
-			"path": "../../../media/media-viewer/afm-dev-agents/tsconfig.json"
-		},
-		{
-			"path": "../../../elements/mention/afm-dev-agents/tsconfig.json"
-		},
-		{
-			"path": "../../../design-system/menu/afm-dev-agents/tsconfig.json"
-		},
-		{
-			"path": "../../../design-system/onboarding/afm-dev-agents/tsconfig.json"
-		},
-		{
-			"path": "../../../platform/feature-flags/afm-dev-agents/tsconfig.json"
-		},
-		{
-			"path": "../../../platform/feature-flags-react/afm-dev-agents/tsconfig.json"
-		},
-		{
-			"path": "../../../design-system/popper/afm-dev-agents/tsconfig.json"
-		},
-		{
-			"path": "../../../design-system/primitives/afm-dev-agents/tsconfig.json"
-		},
-		{
-			"path": "../../../people-and-teams/profilecard/afm-dev-agents/tsconfig.json"
-		},
-		{
-			"path": "../../prosemirror-history/afm-dev-agents/tsconfig.json"
-		},
-		{
-			"path": "../../../react-ufo/atlaskit/afm-dev-agents/tsconfig.json"
-		},
-		{
-			"path": "../../../design-system/section-message/afm-dev-agents/tsconfig.json"
-		},
-		{
-			"path": "../../../linking-platform/smart-card/afm-dev-agents/tsconfig.json"
-		},
-		{
-			"path": "../../../smart-experiences/smart-user-picker/afm-dev-agents/tsconfig.json"
-		},
-		{
-			"path": "../../../design-system/spinner/afm-dev-agents/tsconfig.json"
-		},
-		{
-			"path": "../../../elements/status/afm-dev-agents/tsconfig.json"
-		},
-		{
-			"path": "../../../elements/task-decision/afm-dev-agents/tsconfig.json"
-		},
-		{
-			"path": "../../../design-system/textfield/afm-dev-agents/tsconfig.json"
-		},
-		{
-			"path": "../../../design-system/theme/afm-dev-agents/tsconfig.json"
-		},
-		{
-			"path": "../../tmp-editor-statsig/afm-dev-agents/tsconfig.json"
-		},
-		{
-			"path": "../../../design-system/tokens/afm-dev-agents/tsconfig.json"
-		},
-		{
-			"path": "../../../design-system/tooltip/afm-dev-agents/tsconfig.json"
-		},
-		{
-			"path": "../../../data/ufo-external/afm-dev-agents/tsconfig.json"
-		},
-		{
-			"path": "../../../design-system/width-detector/afm-dev-agents/tsconfig.json"
-		},
-		{
-			"path": "../../../media/media-core/afm-dev-agents/tsconfig.json"
-		}
-	]
-}

package/afm-passionfruit/tsconfig.json

@@ -1,195 +0,0 @@
-{
-	"extends": "../../../../tsconfig.entry-points.passionfruit.json",
-	"compilerOptions": {
-		"declaration": true,
-		"target": "es5",
-		"outDir": "../../../../../passionfruit/tsDist/@atlaskit__editor-common/app",
-		"rootDir": "../",
-		"composite": true
-	},
-	"include": [
-		"../src/**/*.ts",
-		"../src/**/*.tsx"
-	],
-	"exclude": [
-		"../src/**/__tests__/*",
-		"../src/**/*.test.*",
-		"../src/**/test.*",
-		"../src/**/examples.*",
-		"../src/**/examples/*",
-		"../src/**/examples/**/*",
-		"../src/**/*.stories.*",
-		"../src/**/stories/*",
-		"../src/**/stories/**/*"
-	],
-	"references": [
-		{
-			"path": "../../activity-provider/afm-passionfruit/tsconfig.json"
-		},
-		{
-			"path": "../../adf-utils/afm-passionfruit/tsconfig.json"
-		},
-		{
-			"path": "../../../analytics/analytics-listeners/afm-passionfruit/tsconfig.json"
-		},
-		{
-			"path": "../../../analytics/analytics-namespaced-context/afm-passionfruit/tsconfig.json"
-		},
-		{
-			"path": "../../../analytics/analytics-next/afm-passionfruit/tsconfig.json"
-		},
-		{
-			"path": "../../../uip/atlassian-context/afm-passionfruit/tsconfig.json"
-		},
-		{
-			"path": "../../../design-system/button/afm-passionfruit/tsconfig.json"
-		},
-		{
-			"path": "../../../design-system/code/afm-passionfruit/tsconfig.json"
-		},
-		{
-			"path": "../../../monorepo-tooling/codemod-utils/afm-passionfruit/tsconfig.json"
-		},
-		{
-			"path": "../../../design-system/css/afm-passionfruit/tsconfig.json"
-		},
-		{
-			"path": "../../custom-steps/afm-passionfruit/tsconfig.json"
-		},
-		{
-			"path": "../../../design-system/dropdown-menu/afm-passionfruit/tsconfig.json"
-		},
-		{
-			"path": "../../editor-json-transformer/afm-passionfruit/tsconfig.json"
-		},
-		{
-			"path": "../../editor-palette/afm-passionfruit/tsconfig.json"
-		},
-		{
-			"path": "../../editor-shared-styles/afm-passionfruit/tsconfig.json"
-		},
-		{
-			"path": "../../editor-tables/afm-passionfruit/tsconfig.json"
-		},
-		{
-			"path": "../../editor-toolbar/afm-passionfruit/tsconfig.json"
-		},
-		{
-			"path": "../../editor-toolbar-model/afm-passionfruit/tsconfig.json"
-		},
-		{
-			"path": "../../../elements/emoji/afm-passionfruit/tsconfig.json"
-		},
-		{
-			"path": "../../../design-system/icon/afm-passionfruit/tsconfig.json"
-		},
-		{
-			"path": "../../../design-system/icon-object/afm-passionfruit/tsconfig.json"
-		},
-		{
-			"path": "../../../design-system/link/afm-passionfruit/tsconfig.json"
-		},
-		{
-			"path": "../../../linking-platform/link-datasource/afm-passionfruit/tsconfig.json"
-		},
-		{
-			"path": "../../../linking-platform/link-picker/afm-passionfruit/tsconfig.json"
-		},
-		{
-			"path": "../../../media/media-card/afm-passionfruit/tsconfig.json"
-		},
-		{
-			"path": "../../../media/media-client/afm-passionfruit/tsconfig.json"
-		},
-		{
-			"path": "../../../media/media-client-react/afm-passionfruit/tsconfig.json"
-		},
-		{
-			"path": "../../../media/media-common/afm-passionfruit/tsconfig.json"
-		},
-		{
-			"path": "../../../media/media-file-preview/afm-passionfruit/tsconfig.json"
-		},
-		{
-			"path": "../../../media/media-picker/afm-passionfruit/tsconfig.json"
-		},
-		{
-			"path": "../../../media/media-ui/afm-passionfruit/tsconfig.json"
-		},
-		{
-			"path": "../../../media/media-viewer/afm-passionfruit/tsconfig.json"
-		},
-		{
-			"path": "../../../elements/mention/afm-passionfruit/tsconfig.json"
-		},
-		{
-			"path": "../../../design-system/menu/afm-passionfruit/tsconfig.json"
-		},
-		{
-			"path": "../../../design-system/onboarding/afm-passionfruit/tsconfig.json"
-		},
-		{
-			"path": "../../../platform/feature-flags/afm-passionfruit/tsconfig.json"
-		},
-		{
-			"path": "../../../platform/feature-flags-react/afm-passionfruit/tsconfig.json"
-		},
-		{
-			"path": "../../../design-system/popper/afm-passionfruit/tsconfig.json"
-		},
-		{
-			"path": "../../../design-system/primitives/afm-passionfruit/tsconfig.json"
-		},
-		{
-			"path": "../../../people-and-teams/profilecard/afm-passionfruit/tsconfig.json"
-		},
-		{
-			"path": "../../prosemirror-history/afm-passionfruit/tsconfig.json"
-		},
-		{
-			"path": "../../../react-ufo/atlaskit/afm-passionfruit/tsconfig.json"
-		},
-		{
-			"path": "../../../design-system/section-message/afm-passionfruit/tsconfig.json"
-		},
-		{
-			"path": "../../../linking-platform/smart-card/afm-passionfruit/tsconfig.json"
-		},
-		{
-			"path": "../../../smart-experiences/smart-user-picker/afm-passionfruit/tsconfig.json"
-		},
-		{
-			"path": "../../../design-system/spinner/afm-passionfruit/tsconfig.json"
-		},
-		{
-			"path": "../../../elements/status/afm-passionfruit/tsconfig.json"
-		},
-		{
-			"path": "../../../elements/task-decision/afm-passionfruit/tsconfig.json"
-		},
-		{
-			"path": "../../../design-system/textfield/afm-passionfruit/tsconfig.json"
-		},
-		{
-			"path": "../../../design-system/theme/afm-passionfruit/tsconfig.json"
-		},
-		{
-			"path": "../../tmp-editor-statsig/afm-passionfruit/tsconfig.json"
-		},
-		{
-			"path": "../../../design-system/tokens/afm-passionfruit/tsconfig.json"
-		},
-		{
-			"path": "../../../design-system/tooltip/afm-passionfruit/tsconfig.json"
-		},
-		{
-			"path": "../../../data/ufo-external/afm-passionfruit/tsconfig.json"
-		},
-		{
-			"path": "../../../design-system/width-detector/afm-passionfruit/tsconfig.json"
-		},
-		{
-			"path": "../../../media/media-core/afm-passionfruit/tsconfig.json"
-		}
-	]
-}