@atlaskit/editor-plugin-ufo 8.0.22 → 8.0.24

package/CHANGELOG.md

@@ -1,5 +1,21 @@
 # @atlaskit/editor-plugin-ufo
 
+## 8.0.24
+
+### Patch Changes
+
+- [`7b7c52dff5d7d`](https://bitbucket.org/atlassian/atlassian-frontend-monorepo/commits/7b7c52dff5d7d) -
+  Fix eslint violations for type import syntax
+- Updated dependencies
+
+## 8.0.23
+
+### Patch Changes
+
+- [`9ff7d1c1aa288`](https://bitbucket.org/atlassian/atlassian-frontend-monorepo/commits/9ff7d1c1aa288) -
+  Update README.md and 0-intro.tsx
+- Updated dependencies
+
 ## 8.0.22
 
 ### Patch Changes

package/README.md

@@ -1 +1,41 @@
-# Editor plugin ufo
+# Editor Plugin UFO
+
+UFO plugin for @atlaskit/editor-core
+
+**Note:** This component is designed for internal Atlassian development.
+External contributors will be able to use this component but will not be able to submit issues.
+
+## Overview
+
+The UFO (User-Facing Operations) plugin provides performance monitoring and interaction tracking capabilities for the Atlassian Editor. It integrates with `@atlaskit/react-ufo` to abort UFO measurements when user interactions occur, ensuring accurate performance metrics by preventing false measurements from ongoing interactions.
+
+## Key features
+
+- **Interaction tracking** - Monitors first user interaction with the editor to abort ongoing UFO measurements
+- **SSR compatibility** - Automatically disabled in server-side rendering environments
+- **Event-based abort** - Aborts UFO measurements on various user interaction events (wheel, keydown, mousedown, pointerdown, pointerup, touchend, scroll, mouseover)
+- **Selection change detection** - Aborts active 'edit-page' and 'live-edit' UFO interactions when editor selection changes
+
+## Install
+---
+- **Install** - *yarn add @atlaskit/editor-plugin-ufo*
+- **npm** - [@atlaskit/editor-plugin-ufo](https://www.npmjs.com/package/@atlaskit/editor-plugin-ufo)
+- **Source** - [Bitbucket](https://bitbucket.org/atlassian/atlassian-frontend/src/master/packages/editor/editor-plugin-ufo)
+- **Bundle** - [unpkg.com](https://unpkg.com/@atlaskit/editor-plugin-ufo/dist/)
+
+## Usage
+---
+**Internal use only**
+
+@atlaskit/editor-plugin-ufo is intended for internal use by the @atlaskit/editor-core and as a plugin dependency of the Editor within your product.
+
+Direct use of this component is not supported.
+
+Please see [Atlaskit - Editor plugin ufo](https://atlaskit.atlassian.com/packages/editor/editor-plugin-ufo) for documentation and examples for this package.
+
+## Support
+---
+For internal Atlassian, visit the slack channel [#help-editor](https://atlassian.slack.com/archives/CFG3PSQ9E) for support or visit [go/editor-help](https://go/editor-help) to submit a bug.
+## License
+---
+ Please see [Atlassian Frontend - License](https://hello.atlassian.net/wiki/spaces/AF/pages/2589099144/Documentation#License) for more licensing information.

package/docs/0-intro.tsx

@@ -0,0 +1,43 @@
+import React from 'react';
+
+import { AtlassianInternalWarning, code, md } from '@atlaskit/docs';
+// eslint-disable-next-line @atlassian/tangerine/import/entry-points
+import { createEditorUseOnlyNotice } from '@atlaskit/editor-common/doc-utils';
+import { token } from '@atlaskit/tokens';
+
+// eslint-disable-next-line @typescript-eslint/no-explicit-any
+const _default_1: any = md`
+
+${createEditorUseOnlyNotice('Editor Plugin UFO', [
+	{ name: 'Editor Core', link: '/packages/editor/editor-core' },
+])}\
+
+  ${
+		(
+			// eslint-disable-next-line @atlaskit/ui-styling-standard/enforce-style-prop -- Ignored via go/DSP-18766
+			<div style={{ marginTop: token('space.100', '8px') }}>
+				<AtlassianInternalWarning />
+			</div>
+		)
+	}\
+
+  This package includes the UFO plugin used by \`@atlaskit/editor-core\`.
+
+  ## Usage
+---
+
+The exported types of the plugin are defined below:
+
+${code`
+export type UfoPlugin = NextEditorPlugin<'ufo', Object>;
+`}\
+
+
+  ## Support
+---
+For internal Atlassian, visit the slack channel [#help-editor](https://atlassian.slack.com/archives/CFG3PSQ9E) for support or visit [go/editor-help](https://go/editor-help) to submit a bug.
+## License
+---
+ Please see [Atlassian Frontend - License](https://hello.atlassian.net/wiki/spaces/AF/pages/2589099144/Documentation#License) for more licensing information.
+`;
+export default _default_1;

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@atlaskit/editor-plugin-ufo",
-	"version": "8.0.22",
+	"version": "8.0.24",
 	"description": "Ufo plugin for @atlaskit/editor-core",
 	"author": "Atlassian Pty Ltd",
 	"license": "Apache-2.0",
@@ -30,7 +30,7 @@
 	"dependencies": {
 		"@atlaskit/editor-prosemirror": "^7.3.0",
 		"@atlaskit/react-ufo": "^5.12.0",
-		"@atlaskit/tmp-editor-statsig": "^57.0.0",
+		"@atlaskit/tmp-editor-statsig": "^58.0.0",
 		"@babel/runtime": "^7.0.0"
 	},
 	"peerDependencies": {

package/src/pm-plugins/traceUFOInteractionOnFirstInteraction.ts

@@ -1,8 +1,8 @@
 import { SafePlugin } from '@atlaskit/editor-common/safe-plugin';
 import { atTheBeginningOfDoc } from '@atlaskit/editor-common/selection';
 import { isEmptyDocument } from '@atlaskit/editor-common/utils';
-import { type EditorState } from '@atlaskit/editor-prosemirror/state';
-import { type EditorView } from '@atlaskit/editor-prosemirror/view';
+import type { EditorState } from '@atlaskit/editor-prosemirror/state';
+import type { EditorView } from '@atlaskit/editor-prosemirror/view';
 import { abortAll, getActiveInteraction } from '@atlaskit/react-ufo/interaction-metrics';
 
 export const traceUFOInteractionOnFirstInteraction = (): SafePlugin => {

package/tsconfig.dev.json

@@ -40,6 +40,15 @@
 	"references": [
 		{
 			"path": "./tsconfig.app.json"
+		},
+		{
+			"path": "../../../build/website/docs/tsconfig.app.json"
+		},
+		{
+			"path": "../editor-common/tsconfig.app.json"
+		},
+		{
+			"path": "../../design-system/tokens/tsconfig.app.json"
 		}
 	]
 }