@atlaskit/editor-plugin-metrics 3.5.3 → 4.0.0

package/CHANGELOG.md

@@ -1,5 +1,57 @@
 # @atlaskit/editor-plugin-metrics
 
+## 4.0.0
+
+### Major Changes
+
+- [#181024](https://bitbucket.org/atlassian/atlassian-frontend-monorepo/pull-requests/181024)
+  [`8e80c487ca307`](https://bitbucket.org/atlassian/atlassian-frontend-monorepo/commits/8e80c487ca307) - ##
+  Make `@atlaskit/editor-common` a peer dependency
+
+  **WHAT:** `@atlaskit/editor-common` has been moved from `dependencies` to `peerDependencies` in
+  all editor plugin packages.
+
+  **WHY:** This change ensures that only a single version of `@atlaskit/editor-common` is used in
+  consuming applications, preventing issues caused by multiple versions of singleton libraries (such
+  as context mismatches or duplicated state). This is especially important for packages that rely on
+  shared context or singletons.
+
+  **HOW TO ADJUST:**
+
+  - Consumers must now explicitly install `@atlaskit/editor-common` in their own project if they use
+    any of these editor plugins.
+  - Ensure the version you install matches the version required by the plugins.
+  - You can use the
+    [`check-peer-dependencies`](https://www.npmjs.com/package/check-peer-dependencies) package to
+    verify that all required peer dependencies are installed and compatible.
+  - Example install command:
+    ```
+    npm install @atlaskit/editor-common
+    ```
+    or
+    ```
+    yarn add @atlaskit/editor-common
+    ```
+
+  **Note:** This is a breaking change. If `@atlaskit/editor-common` is not installed at the
+  application level, you may see errors or unexpected behavior.
+
+### Patch Changes
+
+- Updated dependencies
+
+## 3.6.0
+
+### Minor Changes
+
+- [#177157](https://bitbucket.org/atlassian/atlassian-frontend-monorepo/pull-requests/177157)
+  [`6bcf8912217df`](https://bitbucket.org/atlassian/atlassian-frontend-monorepo/commits/6bcf8912217df) -
+  ED-27284 additional integration with user preference plugin
+
+### Patch Changes
+
+- Updated dependencies
+
 ## 3.5.3
 
 ### Patch Changes

package/dist/cjs/metricsPlugin.js

@@ -62,8 +62,8 @@ var metricsPlugin = exports.metricsPlugin = function metricsPlugin(_ref) {
             var _api$analytics;
             var toolbarDocking;
             if ((0, _expValEqualsNoExposure.expValEqualsNoExposure)('platform_editor_controls', 'cohort', 'variant1') && (0, _platformFeatureFlags.fg)('platform_editor_controls_patch_13')) {
-              var _config$userPreferenc;
-              toolbarDocking = config === null || config === void 0 || (_config$userPreferenc = config.userPreferencesProvider) === null || _config$userPreferenc === void 0 ? void 0 : _config$userPreferenc.getPreference('toolbarDockingInitialPosition');
+              var _api$userPreferences, _config$userPreferenc;
+              toolbarDocking = toolbarDocking = (0, _platformFeatureFlags.fg)('platform_editor_use_preferences_plugin') ? api === null || api === void 0 || (_api$userPreferences = api.userPreferences) === null || _api$userPreferences === void 0 || (_api$userPreferences = _api$userPreferences.sharedState.currentState()) === null || _api$userPreferences === void 0 || (_api$userPreferences = _api$userPreferences.preferences) === null || _api$userPreferences === void 0 ? void 0 : _api$userPreferences.toolbarDockingPosition : config === null || config === void 0 || (_config$userPreferenc = config.userPreferencesProvider) === null || _config$userPreferenc === void 0 ? void 0 : _config$userPreferenc.getPreference('toolbarDockingInitialPosition');
             }
             var payloadToSend = (0, _analytics.getAnalyticsPayload)({
               currentContent: tr.doc.content,

package/dist/es2019/metricsPlugin.js

@@ -52,8 +52,8 @@ export const metricsPlugin = ({
         var _api$analytics;
         let toolbarDocking;
         if (expValEqualsNoExposure('platform_editor_controls', 'cohort', 'variant1') && fg('platform_editor_controls_patch_13')) {
-          var _config$userPreferenc;
-          toolbarDocking = config === null || config === void 0 ? void 0 : (_config$userPreferenc = config.userPreferencesProvider) === null || _config$userPreferenc === void 0 ? void 0 : _config$userPreferenc.getPreference('toolbarDockingInitialPosition');
+          var _api$userPreferences, _api$userPreferences$, _api$userPreferences$2, _config$userPreferenc;
+          toolbarDocking = toolbarDocking = fg('platform_editor_use_preferences_plugin') ? api === null || api === void 0 ? void 0 : (_api$userPreferences = api.userPreferences) === null || _api$userPreferences === void 0 ? void 0 : (_api$userPreferences$ = _api$userPreferences.sharedState.currentState()) === null || _api$userPreferences$ === void 0 ? void 0 : (_api$userPreferences$2 = _api$userPreferences$.preferences) === null || _api$userPreferences$2 === void 0 ? void 0 : _api$userPreferences$2.toolbarDockingPosition : config === null || config === void 0 ? void 0 : (_config$userPreferenc = config.userPreferencesProvider) === null || _config$userPreferenc === void 0 ? void 0 : _config$userPreferenc.getPreference('toolbarDockingInitialPosition');
         }
         const payloadToSend = getAnalyticsPayload({
           currentContent: tr.doc.content,

package/dist/esm/metricsPlugin.js

@@ -56,8 +56,8 @@ export var metricsPlugin = function metricsPlugin(_ref) {
             var _api$analytics;
             var toolbarDocking;
             if (expValEqualsNoExposure('platform_editor_controls', 'cohort', 'variant1') && fg('platform_editor_controls_patch_13')) {
-              var _config$userPreferenc;
-              toolbarDocking = config === null || config === void 0 || (_config$userPreferenc = config.userPreferencesProvider) === null || _config$userPreferenc === void 0 ? void 0 : _config$userPreferenc.getPreference('toolbarDockingInitialPosition');
+              var _api$userPreferences, _config$userPreferenc;
+              toolbarDocking = toolbarDocking = fg('platform_editor_use_preferences_plugin') ? api === null || api === void 0 || (_api$userPreferences = api.userPreferences) === null || _api$userPreferences === void 0 || (_api$userPreferences = _api$userPreferences.sharedState.currentState()) === null || _api$userPreferences === void 0 || (_api$userPreferences = _api$userPreferences.preferences) === null || _api$userPreferences === void 0 ? void 0 : _api$userPreferences.toolbarDockingPosition : config === null || config === void 0 || (_config$userPreferenc = config.userPreferencesProvider) === null || _config$userPreferenc === void 0 ? void 0 : _config$userPreferenc.getPreference('toolbarDockingInitialPosition');
             }
             var payloadToSend = getAnalyticsPayload({
               currentContent: tr.doc.content,

package/dist/types/metricsPluginType.d.ts

@@ -1,5 +1,6 @@
 import type { EditorCommand, NextEditorPlugin, OptionalPlugin, UserPreferencesProvider } from '@atlaskit/editor-common/types';
 import type { AnalyticsPlugin } from '@atlaskit/editor-plugin-analytics';
+import type { UserPreferencesPlugin } from '@atlaskit/editor-plugin-user-preferences';
 import type { Selection } from '@atlaskit/editor-prosemirror/state';
 import type { MetricsState } from './pm-plugins/main';
 type handleIntentToStartEditProps = {
@@ -12,7 +13,7 @@ export type MetricsPluginOptions = {
 };
 export type MetricsPlugin = NextEditorPlugin<'metrics', {
     pluginConfiguration?: MetricsPluginOptions;
-    dependencies: [OptionalPlugin<AnalyticsPlugin>];
+    dependencies: [OptionalPlugin<AnalyticsPlugin>, OptionalPlugin<UserPreferencesPlugin>];
     sharedState: MetricsState;
     commands: {
         setContentMoved: () => EditorCommand;

package/dist/types/pm-plugins/main.d.ts

@@ -1,7 +1,7 @@
 import { SafePlugin } from '@atlaskit/editor-common/safe-plugin';
 import type { UserPreferencesProvider, ExtractInjectionAPI } from '@atlaskit/editor-common/types';
-import { Fragment } from '@atlaskit/editor-prosemirror/model';
-import { PluginKey, Selection } from '@atlaskit/editor-prosemirror/state';
+import { type Fragment } from '@atlaskit/editor-prosemirror/model';
+import { PluginKey, type Selection } from '@atlaskit/editor-prosemirror/state';
 import { type MetricsPlugin } from '../metricsPluginType';
 import { type TrActionType } from './utils/check-tr-actions/types';
 export declare const metricsKey: PluginKey<any>;

package/dist/types/pm-plugins/utils/analytics.d.ts

@@ -1,5 +1,5 @@
 import { type ActiveSessionEventPayload } from '@atlaskit/editor-common/analytics';
-import { Fragment } from '@atlaskit/editor-prosemirror/model';
+import { type Fragment } from '@atlaskit/editor-prosemirror/model';
 import type { MetricsState } from '../main';
 export declare const getAnalyticsPayload: ({ currentContent, pluginState, toolbarDocking, }: {
     currentContent: Fragment;

package/dist/types/pm-plugins/utils/check-tr-actions/tr-checks/check-deleting-content.d.ts

@@ -1,3 +1,3 @@
-import { ReplaceStep } from '@atlaskit/editor-prosemirror/transform';
+import { type ReplaceStep } from '@atlaskit/editor-prosemirror/transform';
 import { ActionType, type TrAction } from '../types';
 export declare const checkDeletingContent: (step: ReplaceStep) => TrAction<ActionType.DELETING_CONTENT> | undefined;

package/dist/types/pm-plugins/utils/check-tr-actions/tr-checks/check-empty-line-added-or-deleted.d.ts

@@ -1,3 +1,3 @@
-import { ReplaceStep } from '@atlaskit/editor-prosemirror/transform';
+import { type ReplaceStep } from '@atlaskit/editor-prosemirror/transform';
 import { ActionType, type TrAction } from '../types';
 export declare const checkEmptyLineAddedOrDeleted: (step: ReplaceStep) => TrAction<ActionType.EMPTY_LINE_ADDED_OR_DELETED> | undefined;

package/dist/types/pm-plugins/utils/check-tr-actions/tr-checks/check-list-type-node-changed.d.ts

@@ -1,3 +1,3 @@
-import { ReplaceAroundStep, ReplaceStep } from '@atlaskit/editor-prosemirror/transform';
+import { type ReplaceAroundStep, type ReplaceStep } from '@atlaskit/editor-prosemirror/transform';
 import { ActionType, type TrAction } from '../types';
 export declare const checkListTypeNodeChanged: (step: ReplaceStep | ReplaceAroundStep) => TrAction<ActionType.INSERTING_NEW_LIST_TYPE_NODE | ActionType.UPDATING_NEW_LIST_TYPE_ITEM> | undefined;

package/dist/types/pm-plugins/utils/check-tr-actions/tr-checks/check-mark-changed.d.ts

@@ -1,3 +1,3 @@
-import { Step } from '@atlaskit/editor-prosemirror/transform';
+import { type Step } from '@atlaskit/editor-prosemirror/transform';
 import { type MarkChangeAction } from '../types';
 export declare const checkMarkChanged: (step: Step) => MarkChangeAction | undefined;

package/dist/types/pm-plugins/utils/check-tr-actions/tr-checks/check-node-attribute-changed.d.ts

@@ -1,4 +1,4 @@
 import type { ReadonlyTransaction } from '@atlaskit/editor-prosemirror/state';
-import { ReplaceAroundStep, ReplaceStep } from '@atlaskit/editor-prosemirror/transform';
+import { type ReplaceAroundStep, type ReplaceStep } from '@atlaskit/editor-prosemirror/transform';
 import { type AttrChangeAction } from '../types';
 export declare const checkNodeAttributeChanged: (tr: ReadonlyTransaction, step: ReplaceAroundStep | ReplaceStep) => AttrChangeAction | undefined;

package/dist/types/pm-plugins/utils/check-tr-actions/tr-checks/check-status-changed.d.ts

@@ -1,3 +1,3 @@
-import { ReplaceStep } from '@atlaskit/editor-prosemirror/transform';
+import { type ReplaceStep } from '@atlaskit/editor-prosemirror/transform';
 import { type StatusChangeAction } from '../types';
 export declare const checkStatusChanged: (step: ReplaceStep) => StatusChangeAction | undefined;

package/dist/types/pm-plugins/utils/check-tr-actions/tr-checks/check-text-input.d.ts

@@ -1,3 +1,3 @@
-import { ReplaceStep } from '@atlaskit/editor-prosemirror/transform';
+import { type ReplaceStep } from '@atlaskit/editor-prosemirror/transform';
 import { type TrAction, ActionType } from '../types';
 export declare const checkTextInput: (step: ReplaceStep) => TrAction<ActionType.TEXT_INPUT> | undefined;

package/dist/types/pm-plugins/utils/check-tr-actions/types.d.ts

@@ -1,5 +1,5 @@
-import { Slice } from '@atlaskit/editor-prosemirror/model';
-import { ReplaceStep } from '@atlaskit/editor-prosemirror/transform';
+import { type Slice } from '@atlaskit/editor-prosemirror/model';
+import { type ReplaceStep } from '@atlaskit/editor-prosemirror/transform';
 export interface DetailedReplaceStep extends ReplaceStep {
     from: number;
     to: number;

package/dist/types/pm-plugins/utils/get-node-changes.d.ts

@@ -1,4 +1,4 @@
-import { Fragment } from '@atlaskit/editor-prosemirror/model';
+import { type Fragment } from '@atlaskit/editor-prosemirror/model';
 import type { MetricsState } from '../main';
 export declare const getNodeChanges: ({ currentContent, pluginState, }: {
     currentContent: Fragment;

package/dist/types/pm-plugins/utils/is-safe-insert.d.ts

@@ -1,3 +1,3 @@
 import type { ReadonlyTransaction } from '@atlaskit/editor-prosemirror/state';
-import { ActionType } from './check-tr-actions/types';
+import { type ActionType } from './check-tr-actions/types';
 export declare const isSafeInsert: (tr: ReadonlyTransaction, insertPos: number, trType?: ActionType) => boolean;

package/dist/types-ts4.5/metricsPluginType.d.ts

@@ -1,5 +1,6 @@
 import type { EditorCommand, NextEditorPlugin, OptionalPlugin, UserPreferencesProvider } from '@atlaskit/editor-common/types';
 import type { AnalyticsPlugin } from '@atlaskit/editor-plugin-analytics';
+import type { UserPreferencesPlugin } from '@atlaskit/editor-plugin-user-preferences';
 import type { Selection } from '@atlaskit/editor-prosemirror/state';
 import type { MetricsState } from './pm-plugins/main';
 type handleIntentToStartEditProps = {
@@ -13,7 +14,8 @@ export type MetricsPluginOptions = {
 export type MetricsPlugin = NextEditorPlugin<'metrics', {
     pluginConfiguration?: MetricsPluginOptions;
     dependencies: [
-        OptionalPlugin<AnalyticsPlugin>
+        OptionalPlugin<AnalyticsPlugin>,
+        OptionalPlugin<UserPreferencesPlugin>
     ];
     sharedState: MetricsState;
     commands: {

package/dist/types-ts4.5/pm-plugins/main.d.ts

@@ -1,7 +1,7 @@
 import { SafePlugin } from '@atlaskit/editor-common/safe-plugin';
 import type { UserPreferencesProvider, ExtractInjectionAPI } from '@atlaskit/editor-common/types';
-import { Fragment } from '@atlaskit/editor-prosemirror/model';
-import { PluginKey, Selection } from '@atlaskit/editor-prosemirror/state';
+import { type Fragment } from '@atlaskit/editor-prosemirror/model';
+import { PluginKey, type Selection } from '@atlaskit/editor-prosemirror/state';
 import { type MetricsPlugin } from '../metricsPluginType';
 import { type TrActionType } from './utils/check-tr-actions/types';
 export declare const metricsKey: PluginKey<any>;

package/dist/types-ts4.5/pm-plugins/utils/analytics.d.ts

@@ -1,5 +1,5 @@
 import { type ActiveSessionEventPayload } from '@atlaskit/editor-common/analytics';
-import { Fragment } from '@atlaskit/editor-prosemirror/model';
+import { type Fragment } from '@atlaskit/editor-prosemirror/model';
 import type { MetricsState } from '../main';
 export declare const getAnalyticsPayload: ({ currentContent, pluginState, toolbarDocking, }: {
     currentContent: Fragment;

package/dist/types-ts4.5/pm-plugins/utils/check-tr-actions/tr-checks/check-deleting-content.d.ts

@@ -1,3 +1,3 @@
-import { ReplaceStep } from '@atlaskit/editor-prosemirror/transform';
+import { type ReplaceStep } from '@atlaskit/editor-prosemirror/transform';
 import { ActionType, type TrAction } from '../types';
 export declare const checkDeletingContent: (step: ReplaceStep) => TrAction<ActionType.DELETING_CONTENT> | undefined;

package/dist/types-ts4.5/pm-plugins/utils/check-tr-actions/tr-checks/check-empty-line-added-or-deleted.d.ts

@@ -1,3 +1,3 @@
-import { ReplaceStep } from '@atlaskit/editor-prosemirror/transform';
+import { type ReplaceStep } from '@atlaskit/editor-prosemirror/transform';
 import { ActionType, type TrAction } from '../types';
 export declare const checkEmptyLineAddedOrDeleted: (step: ReplaceStep) => TrAction<ActionType.EMPTY_LINE_ADDED_OR_DELETED> | undefined;

package/dist/types-ts4.5/pm-plugins/utils/check-tr-actions/tr-checks/check-list-type-node-changed.d.ts

@@ -1,3 +1,3 @@
-import { ReplaceAroundStep, ReplaceStep } from '@atlaskit/editor-prosemirror/transform';
+import { type ReplaceAroundStep, type ReplaceStep } from '@atlaskit/editor-prosemirror/transform';
 import { ActionType, type TrAction } from '../types';
 export declare const checkListTypeNodeChanged: (step: ReplaceStep | ReplaceAroundStep) => TrAction<ActionType.INSERTING_NEW_LIST_TYPE_NODE | ActionType.UPDATING_NEW_LIST_TYPE_ITEM> | undefined;

package/dist/types-ts4.5/pm-plugins/utils/check-tr-actions/tr-checks/check-mark-changed.d.ts

@@ -1,3 +1,3 @@
-import { Step } from '@atlaskit/editor-prosemirror/transform';
+import { type Step } from '@atlaskit/editor-prosemirror/transform';
 import { type MarkChangeAction } from '../types';
 export declare const checkMarkChanged: (step: Step) => MarkChangeAction | undefined;

package/dist/types-ts4.5/pm-plugins/utils/check-tr-actions/tr-checks/check-node-attribute-changed.d.ts

@@ -1,4 +1,4 @@
 import type { ReadonlyTransaction } from '@atlaskit/editor-prosemirror/state';
-import { ReplaceAroundStep, ReplaceStep } from '@atlaskit/editor-prosemirror/transform';
+import { type ReplaceAroundStep, type ReplaceStep } from '@atlaskit/editor-prosemirror/transform';
 import { type AttrChangeAction } from '../types';
 export declare const checkNodeAttributeChanged: (tr: ReadonlyTransaction, step: ReplaceAroundStep | ReplaceStep) => AttrChangeAction | undefined;

package/dist/types-ts4.5/pm-plugins/utils/check-tr-actions/tr-checks/check-status-changed.d.ts

@@ -1,3 +1,3 @@
-import { ReplaceStep } from '@atlaskit/editor-prosemirror/transform';
+import { type ReplaceStep } from '@atlaskit/editor-prosemirror/transform';
 import { type StatusChangeAction } from '../types';
 export declare const checkStatusChanged: (step: ReplaceStep) => StatusChangeAction | undefined;

package/dist/types-ts4.5/pm-plugins/utils/check-tr-actions/tr-checks/check-text-input.d.ts

@@ -1,3 +1,3 @@
-import { ReplaceStep } from '@atlaskit/editor-prosemirror/transform';
+import { type ReplaceStep } from '@atlaskit/editor-prosemirror/transform';
 import { type TrAction, ActionType } from '../types';
 export declare const checkTextInput: (step: ReplaceStep) => TrAction<ActionType.TEXT_INPUT> | undefined;

package/dist/types-ts4.5/pm-plugins/utils/check-tr-actions/types.d.ts

@@ -1,5 +1,5 @@
-import { Slice } from '@atlaskit/editor-prosemirror/model';
-import { ReplaceStep } from '@atlaskit/editor-prosemirror/transform';
+import { type Slice } from '@atlaskit/editor-prosemirror/model';
+import { type ReplaceStep } from '@atlaskit/editor-prosemirror/transform';
 export interface DetailedReplaceStep extends ReplaceStep {
     from: number;
     to: number;

package/dist/types-ts4.5/pm-plugins/utils/get-node-changes.d.ts

@@ -1,4 +1,4 @@
-import { Fragment } from '@atlaskit/editor-prosemirror/model';
+import { type Fragment } from '@atlaskit/editor-prosemirror/model';
 import type { MetricsState } from '../main';
 export declare const getNodeChanges: ({ currentContent, pluginState, }: {
     currentContent: Fragment;

package/dist/types-ts4.5/pm-plugins/utils/is-safe-insert.d.ts

@@ -1,3 +1,3 @@
 import type { ReadonlyTransaction } from '@atlaskit/editor-prosemirror/state';
-import { ActionType } from './check-tr-actions/types';
+import { type ActionType } from './check-tr-actions/types';
 export declare const isSafeInsert: (tr: ReadonlyTransaction, insertPos: number, trType?: ActionType) => boolean;

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@atlaskit/editor-plugin-metrics",
-	"version": "3.5.3",
+	"version": "4.0.0",
 	"description": "Metrics plugin for @atlaskit/editor-core",
 	"author": "Atlassian Pty Ltd",
 	"license": "Apache-2.0",
@@ -10,8 +10,7 @@
 	"atlassian": {
 		"team": "Editor: Jenga",
 		"singleton": true,
-		"releaseModel": "continuous",
-		"runReact18": true
+		"releaseModel": "continuous"
 	},
 	"repository": "https://bitbucket.org/atlassian/atlassian-frontend",
 	"main": "dist/cjs/index.js",
@@ -33,15 +32,16 @@
 	},
 	"dependencies": {
 		"@atlaskit/adf-schema": "^47.6.0",
-		"@atlaskit/editor-common": "^107.0.0",
-		"@atlaskit/editor-plugin-analytics": "^2.3.0",
+		"@atlaskit/editor-plugin-analytics": "^3.0.0",
+		"@atlaskit/editor-plugin-user-preferences": "^1.0.0",
 		"@atlaskit/editor-prosemirror": "7.0.0",
 		"@atlaskit/platform-feature-flags": "^1.1.0",
-		"@atlaskit/tmp-editor-statsig": "^8.0.0",
+		"@atlaskit/tmp-editor-statsig": "^8.7.0",
 		"@babel/runtime": "^7.0.0",
 		"bind-event-listener": "^3.0.0"
 	},
 	"peerDependencies": {
+		"@atlaskit/editor-common": "^107.6.0",
 		"react": "^18.2.0",
 		"react-dom": "^18.2.0"
 	},
@@ -83,6 +83,9 @@
 		}
 	},
 	"platform-feature-flags": {
+		"platform_editor_use_preferences_plugin": {
+			"type": "boolean"
+		},
 		"platform_editor_controls_patch_13": {
 			"type": "boolean"
 		}