@atlaskit/editor-plugin-code-bidi-warning 2.2.0 → 3.0.1

package/CHANGELOG.md

@@ -1,5 +1,51 @@
 # @atlaskit/editor-plugin-code-bidi-warning
 
+## 3.0.1
+
+### Patch Changes
+
+- Updated dependencies
+
+## 3.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
+
 ## 2.2.0
 
 ### Minor Changes

package/dist/cjs/codeBidiWarningPlugin.js

@@ -6,14 +6,15 @@ Object.defineProperty(exports, "__esModule", {
 exports.codeBidiWarningPlugin = void 0;
 var _main = require("./pm-plugins/main");
 var codeBidiWarningPlugin = exports.codeBidiWarningPlugin = function codeBidiWarningPlugin(_ref) {
-  var config = _ref.config;
+  var config = _ref.config,
+    api = _ref.api;
   return {
     name: 'codeBidiWarning',
     pmPlugins: function pmPlugins() {
       return [{
         name: 'codeBidiWarning',
         plugin: function plugin(options) {
-          return (0, _main.createPlugin)(options, config !== null && config !== void 0 ? config : {});
+          return (0, _main.createPlugin)(api, options, config !== null && config !== void 0 ? config : {});
         }
       }];
     }

package/dist/cjs/pm-plugins/main.js

@@ -6,11 +6,12 @@ Object.defineProperty(exports, "__esModule", {
 exports.createPlugin = void 0;
 var _messages = require("@atlaskit/editor-common/messages");
 var _safePlugin = require("@atlaskit/editor-common/safe-plugin");
+var _view = require("@atlaskit/editor-prosemirror/view");
 var _platformFeatureFlags = require("@atlaskit/platform-feature-flags");
 var _pluginKey = require("./plugin-key");
 var _reactPluginFactory = require("./react-plugin-factory");
 var _vanillaPluginFactory = require("./vanilla-plugin-factory");
-var createPlugin = exports.createPlugin = function createPlugin(_ref, _ref2) {
+var createPlugin = exports.createPlugin = function createPlugin(api, _ref, _ref2) {
   var dispatch = _ref.dispatch,
     getIntl = _ref.getIntl,
     nodeViewPortalProviderAPI = _ref.nodeViewPortalProviderAPI;
@@ -23,6 +24,14 @@ var createPlugin = exports.createPlugin = function createPlugin(_ref, _ref2) {
   return new _safePlugin.SafePlugin({
     key: _pluginKey.codeBidiWarningPluginKey,
     state: createPluginState(dispatch, function (state) {
+      var _api$limitedMode;
+      if (api !== null && api !== void 0 && (_api$limitedMode = api.limitedMode) !== null && _api$limitedMode !== void 0 && (_api$limitedMode = _api$limitedMode.sharedState.currentState()) !== null && _api$limitedMode !== void 0 && _api$limitedMode.enabled) {
+        return {
+          decorationSet: _view.DecorationSet.empty,
+          codeBidiWarningLabel: '',
+          tooltipEnabled: false
+        };
+      }
       return {
         decorationSet: (0, _platformFeatureFlags.fg)('platform_editor_vanilla_codebidi_warning') ? (0, _vanillaPluginFactory.createBidiWarningsDecorationSetFromDoc)({
           doc: state.doc,

package/dist/es2019/codeBidiWarningPlugin.js

@@ -1,13 +1,14 @@
 import { createPlugin } from './pm-plugins/main';
 export const codeBidiWarningPlugin = ({
-  config
+  config,
+  api
 }) => ({
   name: 'codeBidiWarning',
   pmPlugins() {
     return [{
       name: 'codeBidiWarning',
       plugin: options => {
-        return createPlugin(options, config !== null && config !== void 0 ? config : {});
+        return createPlugin(api, options, config !== null && config !== void 0 ? config : {});
       }
     }];
   }

package/dist/es2019/pm-plugins/main.js

@@ -1,10 +1,11 @@
 import { codeBidiWarningMessages } from '@atlaskit/editor-common/messages';
 import { SafePlugin } from '@atlaskit/editor-common/safe-plugin';
+import { DecorationSet } from '@atlaskit/editor-prosemirror/view';
 import { fg } from '@atlaskit/platform-feature-flags';
 import { codeBidiWarningPluginKey } from './plugin-key';
 import { createBidiWarningsDecorationSetFromDoc as reactCreateBidiWarningsDecorationSetFromDoc, pluginFactoryCreator as reactPluginFactoryCreator } from './react-plugin-factory';
 import { createBidiWarningsDecorationSetFromDoc as vanillaCreateBidiWarningsDecorationSetFromDoc, pluginFactoryCreator as vanillaPluginFactoryCreator } from './vanilla-plugin-factory';
-export const createPlugin = ({
+export const createPlugin = (api, {
   dispatch,
   getIntl,
   nodeViewPortalProviderAPI
@@ -20,6 +21,14 @@ export const createPlugin = ({
   return new SafePlugin({
     key: codeBidiWarningPluginKey,
     state: createPluginState(dispatch, state => {
+      var _api$limitedMode, _api$limitedMode$shar;
+      if (api !== null && api !== void 0 && (_api$limitedMode = api.limitedMode) !== null && _api$limitedMode !== void 0 && (_api$limitedMode$shar = _api$limitedMode.sharedState.currentState()) !== null && _api$limitedMode$shar !== void 0 && _api$limitedMode$shar.enabled) {
+        return {
+          decorationSet: DecorationSet.empty,
+          codeBidiWarningLabel: '',
+          tooltipEnabled: false
+        };
+      }
       return {
         decorationSet: fg('platform_editor_vanilla_codebidi_warning') ? vanillaCreateBidiWarningsDecorationSetFromDoc({
           doc: state.doc,

package/dist/esm/codeBidiWarningPlugin.js

@@ -1,13 +1,14 @@
 import { createPlugin } from './pm-plugins/main';
 export var codeBidiWarningPlugin = function codeBidiWarningPlugin(_ref) {
-  var config = _ref.config;
+  var config = _ref.config,
+    api = _ref.api;
   return {
     name: 'codeBidiWarning',
     pmPlugins: function pmPlugins() {
       return [{
         name: 'codeBidiWarning',
         plugin: function plugin(options) {
-          return createPlugin(options, config !== null && config !== void 0 ? config : {});
+          return createPlugin(api, options, config !== null && config !== void 0 ? config : {});
         }
       }];
     }

package/dist/esm/pm-plugins/main.js

@@ -1,10 +1,11 @@
 import { codeBidiWarningMessages } from '@atlaskit/editor-common/messages';
 import { SafePlugin } from '@atlaskit/editor-common/safe-plugin';
+import { DecorationSet } from '@atlaskit/editor-prosemirror/view';
 import { fg } from '@atlaskit/platform-feature-flags';
 import { codeBidiWarningPluginKey } from './plugin-key';
 import { createBidiWarningsDecorationSetFromDoc as reactCreateBidiWarningsDecorationSetFromDoc, pluginFactoryCreator as reactPluginFactoryCreator } from './react-plugin-factory';
 import { createBidiWarningsDecorationSetFromDoc as vanillaCreateBidiWarningsDecorationSetFromDoc, pluginFactoryCreator as vanillaPluginFactoryCreator } from './vanilla-plugin-factory';
-export var createPlugin = function createPlugin(_ref, _ref2) {
+export var createPlugin = function createPlugin(api, _ref, _ref2) {
   var dispatch = _ref.dispatch,
     getIntl = _ref.getIntl,
     nodeViewPortalProviderAPI = _ref.nodeViewPortalProviderAPI;
@@ -17,6 +18,14 @@ export var createPlugin = function createPlugin(_ref, _ref2) {
   return new SafePlugin({
     key: codeBidiWarningPluginKey,
     state: createPluginState(dispatch, function (state) {
+      var _api$limitedMode;
+      if (api !== null && api !== void 0 && (_api$limitedMode = api.limitedMode) !== null && _api$limitedMode !== void 0 && (_api$limitedMode = _api$limitedMode.sharedState.currentState()) !== null && _api$limitedMode !== void 0 && _api$limitedMode.enabled) {
+        return {
+          decorationSet: DecorationSet.empty,
+          codeBidiWarningLabel: '',
+          tooltipEnabled: false
+        };
+      }
       return {
         decorationSet: fg('platform_editor_vanilla_codebidi_warning') ? vanillaCreateBidiWarningsDecorationSetFromDoc({
           doc: state.doc,

package/dist/types/codeBidiWarningPluginType.d.ts

@@ -1,7 +1,9 @@
-import type { EditorAppearance, NextEditorPlugin } from '@atlaskit/editor-common/types';
+import type { EditorAppearance, NextEditorPlugin, OptionalPlugin } from '@atlaskit/editor-common/types';
+import type { LimitedModePlugin } from '@atlaskit/editor-plugin-limited-mode';
 export type CodeBidiWarningPluginOptions = {
     appearance?: EditorAppearance;
 };
 export type CodeBidiWarningPlugin = NextEditorPlugin<'codeBidiWarning', {
+    dependencies: [OptionalPlugin<LimitedModePlugin>];
     pluginConfiguration: CodeBidiWarningPluginOptions | undefined;
 }>;

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

@@ -1,5 +1,6 @@
 import { SafePlugin } from '@atlaskit/editor-common/safe-plugin';
-import type { EditorAppearance, PMPluginFactoryParams } from '@atlaskit/editor-common/types';
-export declare const createPlugin: ({ dispatch, getIntl, nodeViewPortalProviderAPI }: PMPluginFactoryParams, { appearance }: {
-    appearance?: EditorAppearance | undefined;
+import type { EditorAppearance, ExtractInjectionAPI, PMPluginFactoryParams } from '@atlaskit/editor-common/types';
+import type { CodeBidiWarningPlugin } from '../codeBidiWarningPluginType';
+export declare const createPlugin: (api: ExtractInjectionAPI<CodeBidiWarningPlugin> | undefined, { dispatch, getIntl, nodeViewPortalProviderAPI }: PMPluginFactoryParams, { appearance }: {
+    appearance?: EditorAppearance;
 }) => SafePlugin<import("./types").CodeBidiWarningPluginState>;

package/dist/types/pm-plugins/react-plugin-factory.d.ts

@@ -3,7 +3,7 @@ import type { Node as PmNode } from '@atlaskit/editor-prosemirror/model';
 import { DecorationSet } from '@atlaskit/editor-prosemirror/view';
 export declare const pluginFactoryCreator: (nodeViewPortalProviderAPI: PortalProviderAPI) => {
     createPluginState: (dispatch: import("@atlaskit/editor-common/event-dispatcher").Dispatch, initialState: import("./types").CodeBidiWarningPluginState | ((state: import("prosemirror-state").EditorState) => import("./types").CodeBidiWarningPluginState)) => import("prosemirror-state").SafeStateField<import("./types").CodeBidiWarningPluginState>;
-    createCommand: <A = unknown>(action: A | ((state: Readonly<import("prosemirror-state").EditorState>) => false | A), transform?: ((tr: import("prosemirror-state").Transaction, state: import("prosemirror-state").EditorState) => import("prosemirror-state").Transaction) | undefined) => import("@atlaskit/editor-common/types").Command;
+    createCommand: <A = unknown>(action: A | ((state: Readonly<import("prosemirror-state").EditorState>) => false | A), transform?: (tr: import("prosemirror-state").Transaction, state: import("prosemirror-state").EditorState) => import("prosemirror-state").Transaction) => import("@atlaskit/editor-common/types").Command;
     getPluginState: (state: import("prosemirror-state").EditorState) => import("./types").CodeBidiWarningPluginState;
 };
 export declare function createBidiWarningsDecorationSetFromDoc({ doc, codeBidiWarningLabel, tooltipEnabled, nodeViewPortalProviderAPI, }: {

package/dist/types/pm-plugins/vanilla-plugin-factory.d.ts

@@ -2,7 +2,7 @@ import { type Node as PmNode } from '@atlaskit/editor-prosemirror/model';
 import { DecorationSet } from '@atlaskit/editor-prosemirror/view';
 export declare const pluginFactoryCreator: () => {
     createPluginState: (dispatch: import("@atlaskit/editor-common/event-dispatcher").Dispatch, initialState: import("./types").CodeBidiWarningPluginState | ((state: import("prosemirror-state").EditorState) => import("./types").CodeBidiWarningPluginState)) => import("prosemirror-state").SafeStateField<import("./types").CodeBidiWarningPluginState>;
-    createCommand: <A = unknown>(action: A | ((state: Readonly<import("prosemirror-state").EditorState>) => false | A), transform?: ((tr: import("prosemirror-state").Transaction, state: import("prosemirror-state").EditorState) => import("prosemirror-state").Transaction) | undefined) => import("@atlaskit/editor-common/types").Command;
+    createCommand: <A = unknown>(action: A | ((state: Readonly<import("prosemirror-state").EditorState>) => false | A), transform?: (tr: import("prosemirror-state").Transaction, state: import("prosemirror-state").EditorState) => import("prosemirror-state").Transaction) => import("@atlaskit/editor-common/types").Command;
     getPluginState: (state: import("prosemirror-state").EditorState) => import("./types").CodeBidiWarningPluginState;
 };
 export declare function createBidiWarningsDecorationSetFromDoc({ doc, codeBidiWarningLabel, tooltipEnabled, }: {

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

@@ -1,7 +1,11 @@
-import type { EditorAppearance, NextEditorPlugin } from '@atlaskit/editor-common/types';
+import type { EditorAppearance, NextEditorPlugin, OptionalPlugin } from '@atlaskit/editor-common/types';
+import type { LimitedModePlugin } from '@atlaskit/editor-plugin-limited-mode';
 export type CodeBidiWarningPluginOptions = {
     appearance?: EditorAppearance;
 };
 export type CodeBidiWarningPlugin = NextEditorPlugin<'codeBidiWarning', {
+    dependencies: [
+        OptionalPlugin<LimitedModePlugin>
+    ];
     pluginConfiguration: CodeBidiWarningPluginOptions | undefined;
 }>;

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

@@ -1,5 +1,6 @@
 import { SafePlugin } from '@atlaskit/editor-common/safe-plugin';
-import type { EditorAppearance, PMPluginFactoryParams } from '@atlaskit/editor-common/types';
-export declare const createPlugin: ({ dispatch, getIntl, nodeViewPortalProviderAPI }: PMPluginFactoryParams, { appearance }: {
-    appearance?: EditorAppearance | undefined;
+import type { EditorAppearance, ExtractInjectionAPI, PMPluginFactoryParams } from '@atlaskit/editor-common/types';
+import type { CodeBidiWarningPlugin } from '../codeBidiWarningPluginType';
+export declare const createPlugin: (api: ExtractInjectionAPI<CodeBidiWarningPlugin> | undefined, { dispatch, getIntl, nodeViewPortalProviderAPI }: PMPluginFactoryParams, { appearance }: {
+    appearance?: EditorAppearance;
 }) => SafePlugin<import("./types").CodeBidiWarningPluginState>;

package/dist/types-ts4.5/pm-plugins/react-plugin-factory.d.ts

@@ -3,7 +3,7 @@ import type { Node as PmNode } from '@atlaskit/editor-prosemirror/model';
 import { DecorationSet } from '@atlaskit/editor-prosemirror/view';
 export declare const pluginFactoryCreator: (nodeViewPortalProviderAPI: PortalProviderAPI) => {
     createPluginState: (dispatch: import("@atlaskit/editor-common/event-dispatcher").Dispatch, initialState: import("./types").CodeBidiWarningPluginState | ((state: import("prosemirror-state").EditorState) => import("./types").CodeBidiWarningPluginState)) => import("prosemirror-state").SafeStateField<import("./types").CodeBidiWarningPluginState>;
-    createCommand: <A = unknown>(action: A | ((state: Readonly<import("prosemirror-state").EditorState>) => false | A), transform?: ((tr: import("prosemirror-state").Transaction, state: import("prosemirror-state").EditorState) => import("prosemirror-state").Transaction) | undefined) => import("@atlaskit/editor-common/types").Command;
+    createCommand: <A = unknown>(action: A | ((state: Readonly<import("prosemirror-state").EditorState>) => false | A), transform?: (tr: import("prosemirror-state").Transaction, state: import("prosemirror-state").EditorState) => import("prosemirror-state").Transaction) => import("@atlaskit/editor-common/types").Command;
     getPluginState: (state: import("prosemirror-state").EditorState) => import("./types").CodeBidiWarningPluginState;
 };
 export declare function createBidiWarningsDecorationSetFromDoc({ doc, codeBidiWarningLabel, tooltipEnabled, nodeViewPortalProviderAPI, }: {

package/dist/types-ts4.5/pm-plugins/vanilla-plugin-factory.d.ts

@@ -2,7 +2,7 @@ import { type Node as PmNode } from '@atlaskit/editor-prosemirror/model';
 import { DecorationSet } from '@atlaskit/editor-prosemirror/view';
 export declare const pluginFactoryCreator: () => {
     createPluginState: (dispatch: import("@atlaskit/editor-common/event-dispatcher").Dispatch, initialState: import("./types").CodeBidiWarningPluginState | ((state: import("prosemirror-state").EditorState) => import("./types").CodeBidiWarningPluginState)) => import("prosemirror-state").SafeStateField<import("./types").CodeBidiWarningPluginState>;
-    createCommand: <A = unknown>(action: A | ((state: Readonly<import("prosemirror-state").EditorState>) => false | A), transform?: ((tr: import("prosemirror-state").Transaction, state: import("prosemirror-state").EditorState) => import("prosemirror-state").Transaction) | undefined) => import("@atlaskit/editor-common/types").Command;
+    createCommand: <A = unknown>(action: A | ((state: Readonly<import("prosemirror-state").EditorState>) => false | A), transform?: (tr: import("prosemirror-state").Transaction, state: import("prosemirror-state").EditorState) => import("prosemirror-state").Transaction) => import("@atlaskit/editor-common/types").Command;
     getPluginState: (state: import("prosemirror-state").EditorState) => import("./types").CodeBidiWarningPluginState;
 };
 export declare function createBidiWarningsDecorationSetFromDoc({ doc, codeBidiWarningLabel, tooltipEnabled, }: {

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@atlaskit/editor-plugin-code-bidi-warning",
-	"version": "2.2.0",
+	"version": "3.0.1",
 	"description": "Code bidi warning plugin for @atlaskit/editor-core.",
 	"author": "Atlassian Pty Ltd",
 	"license": "Apache-2.0",
@@ -31,13 +31,14 @@
 	},
 	"dependencies": {
 		"@atlaskit/code": "^17.2.0",
-		"@atlaskit/editor-common": "^107.5.0",
+		"@atlaskit/editor-plugin-limited-mode": "^0.0.1",
 		"@atlaskit/editor-prosemirror": "7.0.0",
 		"@atlaskit/platform-feature-flags": "^1.1.0",
 		"@babel/runtime": "^7.0.0",
 		"uuid": "^3.1.0"
 	},
 	"peerDependencies": {
+		"@atlaskit/editor-common": "^107.25.0",
 		"react": "^18.2.0",
 		"react-dom": "^18.2.0"
 	},
@@ -47,7 +48,6 @@
 		"@atlaskit/ssr": "workspace:^",
 		"@atlaskit/visual-regression": "workspace:^",
 		"@testing-library/react": "^13.4.0",
-		"typescript": "~5.4.2",
 		"wait-for-expect": "^1.2.0"
 	},
 	"techstack": {