@atlaskit/editor-plugin-user-preferences 0.2.2 → 1.0.0

package/CHANGELOG.md

@@ -1,5 +1,57 @@
 # @atlaskit/editor-plugin-user-preferences
 
+## 1.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
+
+## 0.3.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
+
 ## 0.2.2
 
 ### Patch Changes

package/afm-cc/tsconfig.json

@@ -17,9 +17,6 @@
         "../src/**/examples.*"
     ],
     "references": [
-        {
-            "path": "../../editor-common/afm-cc/tsconfig.json"
-        },
         {
             "path": "../../editor-plugin-analytics/afm-cc/tsconfig.json"
         },
@@ -28,6 +25,9 @@
         },
         {
             "path": "../../tmp-editor-statsig/afm-cc/tsconfig.json"
+        },
+        {
+            "path": "../../editor-common/afm-cc/tsconfig.json"
         }
     ]
 }

package/afm-jira/tsconfig.json

@@ -17,9 +17,6 @@
 		"../src/**/examples.*"
 	],
 	"references": [
-		{
-			"path": "../../editor-common/afm-jira/tsconfig.json"
-		},
 		{
 			"path": "../../editor-plugin-analytics/afm-jira/tsconfig.json"
 		},
@@ -28,6 +25,9 @@
 		},
 		{
 			"path": "../../tmp-editor-statsig/afm-jira/tsconfig.json"
+		},
+		{
+			"path": "../../editor-common/afm-jira/tsconfig.json"
 		}
 	]
 }

package/afm-post-office/tsconfig.json

@@ -17,9 +17,6 @@
 		"../src/**/examples.*"
 	],
 	"references": [
-		{
-			"path": "../../editor-common/afm-post-office/tsconfig.json"
-		},
 		{
 			"path": "../../editor-plugin-analytics/afm-post-office/tsconfig.json"
 		},
@@ -28,6 +25,9 @@
 		},
 		{
 			"path": "../../tmp-editor-statsig/afm-post-office/tsconfig.json"
+		},
+		{
+			"path": "../../editor-common/afm-post-office/tsconfig.json"
 		}
 	]
 }

package/afm-volt/tsconfig.json

@@ -0,0 +1,33 @@
+{
+	"extends": "../../../../tsconfig.entry-points.volt.json",
+	"compilerOptions": {
+		"target": "es5",
+		"outDir": "../../../../../volt/tsDist/@atlaskit__editor-plugin-user-preferences/app",
+		"rootDir": "../",
+		"composite": true
+	},
+	"include": [
+		"../src/**/*.ts",
+		"../src/**/*.tsx"
+	],
+	"exclude": [
+		"../src/**/__tests__/*",
+		"../src/**/*.test.*",
+		"../src/**/test.*",
+		"../src/**/examples.*"
+	],
+	"references": [
+		{
+			"path": "../../editor-common/afm-volt/tsconfig.json"
+		},
+		{
+			"path": "../../editor-plugin-analytics/afm-volt/tsconfig.json"
+		},
+		{
+			"path": "../../../platform/feature-flags/afm-volt/tsconfig.json"
+		},
+		{
+			"path": "../../tmp-editor-statsig/afm-volt/tsconfig.json"
+		}
+	]
+}

package/dist/cjs/userPreferencesPlugin.js

@@ -7,7 +7,6 @@ exports.userPreferencesPlugin = void 0;
 var _userPreferences = require("@atlaskit/editor-common/user-preferences");
 var _commands = require("./pm-plugins/commands");
 var _main = require("./pm-plugins/main");
-var _useDocumentVisibilityWatcher = require("./ui/useDocumentVisibilityWatcher");
 var _useUserPreferencesInitListener = require("./ui/useUserPreferencesInitListener");
 var _useUserPreferencesUpdateListener = require("./ui/useUserPreferencesUpdateListener");
 var userPreferencesPlugin = exports.userPreferencesPlugin = function userPreferencesPlugin(_ref) {
@@ -46,7 +45,6 @@ var userPreferencesPlugin = exports.userPreferencesPlugin = function userPrefere
       var _useResolvedUserPrefe = (0, _userPreferences.useResolvedUserPreferences)(userPreferencesProvider),
         resolvedUserPreferences = _useResolvedUserPrefe.resolvedUserPreferences;
       (0, _useUserPreferencesUpdateListener.useUserPreferencesUpdateListener)(editorView, resolvedUserPreferences);
-      (0, _useDocumentVisibilityWatcher.useDocumentVisibilityWatcher)(userPreferencesProvider);
       (0, _useUserPreferencesInitListener.useUserPreferencesInitListener)(Boolean(userPreferencesProvider === null || userPreferencesProvider === void 0 ? void 0 : userPreferencesProvider.isInitialized), resolvedUserPreferences, api);
     }
   };

package/dist/es2019/userPreferencesPlugin.js

@@ -1,7 +1,6 @@
 import { useResolvedUserPreferences } from '@atlaskit/editor-common/user-preferences';
 import { updateUserPreference } from './pm-plugins/commands';
 import { createPlugin, userPreferencesPluginKey } from './pm-plugins/main';
-import { useDocumentVisibilityWatcher } from './ui/useDocumentVisibilityWatcher';
 import { useUserPreferencesInitListener } from './ui/useUserPreferencesInitListener';
 import { useUserPreferencesUpdateListener } from './ui/useUserPreferencesUpdateListener';
 export const userPreferencesPlugin = ({
@@ -43,7 +42,6 @@ export const userPreferencesPlugin = ({
         resolvedUserPreferences
       } = useResolvedUserPreferences(userPreferencesProvider);
       useUserPreferencesUpdateListener(editorView, resolvedUserPreferences);
-      useDocumentVisibilityWatcher(userPreferencesProvider);
       useUserPreferencesInitListener(Boolean(userPreferencesProvider === null || userPreferencesProvider === void 0 ? void 0 : userPreferencesProvider.isInitialized), resolvedUserPreferences, api);
     }
   };

package/dist/esm/userPreferencesPlugin.js

@@ -1,7 +1,6 @@
 import { useResolvedUserPreferences } from '@atlaskit/editor-common/user-preferences';
 import { updateUserPreference as _updateUserPreference } from './pm-plugins/commands';
 import { createPlugin, userPreferencesPluginKey } from './pm-plugins/main';
-import { useDocumentVisibilityWatcher } from './ui/useDocumentVisibilityWatcher';
 import { useUserPreferencesInitListener } from './ui/useUserPreferencesInitListener';
 import { useUserPreferencesUpdateListener } from './ui/useUserPreferencesUpdateListener';
 export var userPreferencesPlugin = function userPreferencesPlugin(_ref) {
@@ -40,7 +39,6 @@ export var userPreferencesPlugin = function userPreferencesPlugin(_ref) {
       var _useResolvedUserPrefe = useResolvedUserPreferences(userPreferencesProvider),
         resolvedUserPreferences = _useResolvedUserPrefe.resolvedUserPreferences;
       useUserPreferencesUpdateListener(editorView, resolvedUserPreferences);
-      useDocumentVisibilityWatcher(userPreferencesProvider);
       useUserPreferencesInitListener(Boolean(userPreferencesProvider === null || userPreferencesProvider === void 0 ? void 0 : userPreferencesProvider.isInitialized), resolvedUserPreferences, api);
     }
   };

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

@@ -1,6 +1,6 @@
 import { type EditorAnalyticsAPI } from '@atlaskit/editor-common/analytics';
 import type { EditorCommand } from '@atlaskit/editor-common/types';
-import { type ResolvedUserPreferences, type UserPreferences, UserPreferencesProvider } from '@atlaskit/editor-common/user-preferences';
+import { type ResolvedUserPreferences, type UserPreferences, type UserPreferencesProvider } from '@atlaskit/editor-common/user-preferences';
 export declare const updateUserPreference: ({ key, value, userPreferencesProvider, editorAnalyticsApi, }: {
     key: keyof UserPreferences;
     value: "top" | "none";

package/dist/types/ui/useUserPreferencesInitListener.d.ts

@@ -1,4 +1,4 @@
-import { ExtractInjectionAPI } from '@atlaskit/editor-common/types';
-import { ResolvedUserPreferences } from '@atlaskit/editor-common/user-preferences';
-import { UserPreferencesPlugin } from '../userPreferencesPluginType';
+import type { ExtractInjectionAPI } from '@atlaskit/editor-common/types';
+import type { ResolvedUserPreferences } from '@atlaskit/editor-common/user-preferences';
+import type { UserPreferencesPlugin } from '../userPreferencesPluginType';
 export declare const useUserPreferencesInitListener: (isInitialized: boolean, resolvedUserPreferences: ResolvedUserPreferences | null, api?: ExtractInjectionAPI<UserPreferencesPlugin>) => void;

package/dist/types/ui/useUserPreferencesUpdateListener.d.ts

@@ -1,3 +1,3 @@
-import { ResolvedUserPreferences } from '@atlaskit/editor-common/user-preferences';
-import { EditorView } from '@atlaskit/editor-prosemirror/view';
+import type { ResolvedUserPreferences } from '@atlaskit/editor-common/user-preferences';
+import { type EditorView } from '@atlaskit/editor-prosemirror/view';
 export declare const useUserPreferencesUpdateListener: (editorView: EditorView, resolvedUserPreferences: ResolvedUserPreferences | null) => void;

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

@@ -1,6 +1,6 @@
 import { type EditorAnalyticsAPI } from '@atlaskit/editor-common/analytics';
 import type { EditorCommand } from '@atlaskit/editor-common/types';
-import { type ResolvedUserPreferences, type UserPreferences, UserPreferencesProvider } from '@atlaskit/editor-common/user-preferences';
+import { type ResolvedUserPreferences, type UserPreferences, type UserPreferencesProvider } from '@atlaskit/editor-common/user-preferences';
 export declare const updateUserPreference: ({ key, value, userPreferencesProvider, editorAnalyticsApi, }: {
     key: keyof UserPreferences;
     value: "top" | "none";

package/dist/types-ts4.5/ui/useUserPreferencesInitListener.d.ts

@@ -1,4 +1,4 @@
-import { ExtractInjectionAPI } from '@atlaskit/editor-common/types';
-import { ResolvedUserPreferences } from '@atlaskit/editor-common/user-preferences';
-import { UserPreferencesPlugin } from '../userPreferencesPluginType';
+import type { ExtractInjectionAPI } from '@atlaskit/editor-common/types';
+import type { ResolvedUserPreferences } from '@atlaskit/editor-common/user-preferences';
+import type { UserPreferencesPlugin } from '../userPreferencesPluginType';
 export declare const useUserPreferencesInitListener: (isInitialized: boolean, resolvedUserPreferences: ResolvedUserPreferences | null, api?: ExtractInjectionAPI<UserPreferencesPlugin>) => void;

package/dist/types-ts4.5/ui/useUserPreferencesUpdateListener.d.ts

@@ -1,3 +1,3 @@
-import { ResolvedUserPreferences } from '@atlaskit/editor-common/user-preferences';
-import { EditorView } from '@atlaskit/editor-prosemirror/view';
+import type { ResolvedUserPreferences } from '@atlaskit/editor-common/user-preferences';
+import { type EditorView } from '@atlaskit/editor-prosemirror/view';
 export declare const useUserPreferencesUpdateListener: (editorView: EditorView, resolvedUserPreferences: ResolvedUserPreferences | null) => void;

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@atlaskit/editor-plugin-user-preferences",
-	"version": "0.2.2",
+	"version": "1.0.0",
 	"description": "UserPreferences plugin for @atlaskit/editor-core",
 	"author": "Atlassian Pty Ltd",
 	"license": "Apache-2.0",
@@ -10,8 +10,7 @@
 	"atlassian": {
 		"team": "Editor: Lego",
 		"releaseModel": "continuous",
-		"singleton": true,
-		"runReact18": true
+		"singleton": true
 	},
 	"repository": "https://bitbucket.org/atlassian/atlassian-frontend-mirror",
 	"main": "dist/cjs/index.js",
@@ -32,15 +31,15 @@
 		".": "./src/index.ts"
 	},
 	"dependencies": {
-		"@atlaskit/editor-common": "^107.0.0",
-		"@atlaskit/editor-plugin-analytics": "^2.3.0",
+		"@atlaskit/editor-plugin-analytics": "^3.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"
 	},
 	"devDependencies": {

package/dist/cjs/ui/useDocumentVisibilityWatcher.js

@@ -1,53 +0,0 @@
-"use strict";
-
-var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault");
-Object.defineProperty(exports, "__esModule", {
-  value: true
-});
-exports.useDocumentVisibilityWatcher = void 0;
-var _regenerator = _interopRequireDefault(require("@babel/runtime/regenerator"));
-var _asyncToGenerator2 = _interopRequireDefault(require("@babel/runtime/helpers/asyncToGenerator"));
-var _react = require("react");
-var _bindEventListener = require("bind-event-listener");
-var _monitoring = require("@atlaskit/editor-common/monitoring");
-var useDocumentVisibilityWatcher = exports.useDocumentVisibilityWatcher = function useDocumentVisibilityWatcher(userPreferencesProvider) {
-  (0, _react.useEffect)(function () {
-    if (userPreferencesProvider) {
-      var refreshPreferences = /*#__PURE__*/function () {
-        var _ref = (0, _asyncToGenerator2.default)( /*#__PURE__*/_regenerator.default.mark(function _callee() {
-          return _regenerator.default.wrap(function _callee$(_context) {
-            while (1) switch (_context.prev = _context.next) {
-              case 0:
-                if (!(document.visibilityState === 'visible')) {
-                  _context.next = 9;
-                  break;
-                }
-                _context.prev = 1;
-                _context.next = 4;
-                return userPreferencesProvider.loadPreferences();
-              case 4:
-                _context.next = 9;
-                break;
-              case 6:
-                _context.prev = 6;
-                _context.t0 = _context["catch"](1);
-                (0, _monitoring.logException)(_context.t0, {
-                  location: 'editor-plugin-user-preferences/userPreferencesPlugin'
-                });
-              case 9:
-              case "end":
-                return _context.stop();
-            }
-          }, _callee, null, [[1, 6]]);
-        }));
-        return function refreshPreferences() {
-          return _ref.apply(this, arguments);
-        };
-      }();
-      return (0, _bindEventListener.bind)(document, {
-        type: 'visibilitychange',
-        listener: refreshPreferences
-      });
-    }
-  }, [userPreferencesProvider]);
-};

package/dist/es2019/ui/useDocumentVisibilityWatcher.js

@@ -1,24 +0,0 @@
-import { useEffect } from 'react';
-import { bind } from 'bind-event-listener';
-import { logException } from '@atlaskit/editor-common/monitoring';
-export const useDocumentVisibilityWatcher = userPreferencesProvider => {
-  useEffect(() => {
-    if (userPreferencesProvider) {
-      const refreshPreferences = async () => {
-        if (document.visibilityState === 'visible') {
-          try {
-            await userPreferencesProvider.loadPreferences();
-          } catch (error) {
-            logException(error, {
-              location: 'editor-plugin-user-preferences/userPreferencesPlugin'
-            });
-          }
-        }
-      };
-      return bind(document, {
-        type: 'visibilitychange',
-        listener: refreshPreferences
-      });
-    }
-  }, [userPreferencesProvider]);
-};

package/dist/esm/ui/useDocumentVisibilityWatcher.js

@@ -1,46 +0,0 @@
-import _asyncToGenerator from "@babel/runtime/helpers/asyncToGenerator";
-import _regeneratorRuntime from "@babel/runtime/regenerator";
-import { useEffect } from 'react';
-import { bind } from 'bind-event-listener';
-import { logException } from '@atlaskit/editor-common/monitoring';
-export var useDocumentVisibilityWatcher = function useDocumentVisibilityWatcher(userPreferencesProvider) {
-  useEffect(function () {
-    if (userPreferencesProvider) {
-      var refreshPreferences = /*#__PURE__*/function () {
-        var _ref = _asyncToGenerator( /*#__PURE__*/_regeneratorRuntime.mark(function _callee() {
-          return _regeneratorRuntime.wrap(function _callee$(_context) {
-            while (1) switch (_context.prev = _context.next) {
-              case 0:
-                if (!(document.visibilityState === 'visible')) {
-                  _context.next = 9;
-                  break;
-                }
-                _context.prev = 1;
-                _context.next = 4;
-                return userPreferencesProvider.loadPreferences();
-              case 4:
-                _context.next = 9;
-                break;
-              case 6:
-                _context.prev = 6;
-                _context.t0 = _context["catch"](1);
-                logException(_context.t0, {
-                  location: 'editor-plugin-user-preferences/userPreferencesPlugin'
-                });
-              case 9:
-              case "end":
-                return _context.stop();
-            }
-          }, _callee, null, [[1, 6]]);
-        }));
-        return function refreshPreferences() {
-          return _ref.apply(this, arguments);
-        };
-      }();
-      return bind(document, {
-        type: 'visibilitychange',
-        listener: refreshPreferences
-      });
-    }
-  }, [userPreferencesProvider]);
-};

package/dist/types/ui/useDocumentVisibilityWatcher.d.ts

@@ -1,2 +0,0 @@
-import { UserPreferencesProvider } from '@atlaskit/editor-common/user-preferences';
-export declare const useDocumentVisibilityWatcher: (userPreferencesProvider?: UserPreferencesProvider) => void;

package/dist/types-ts4.5/ui/useDocumentVisibilityWatcher.d.ts

@@ -1,2 +0,0 @@
-import { UserPreferencesProvider } from '@atlaskit/editor-common/user-preferences';
-export declare const useDocumentVisibilityWatcher: (userPreferencesProvider?: UserPreferencesProvider) => void;