@atlaskit/editor-plugin-base 0.1.0 → 0.2.0

package/CHANGELOG.md

@@ -1,10 +1,91 @@
 # @atlaskit/editor-plugin-base
 
+## 0.2.0
+
+### Minor Changes
+
+- [#40718](https://bitbucket.org/atlassian/atlassian-frontend/pull-requests/40718) [`c1d4b48bdd9`](https://bitbucket.org/atlassian/atlassian-frontend/commits/c1d4b48bdd9) - WHAT: This change removes plugin exports from editor-core that were used only for the mobile bridge.
+
+  This includes:
+
+  - All plugin keys
+  - Plugin commands
+  - Plugin types
+
+  The full list is:
+
+  - EditorFeatureFlags (available via '@atlaskit/editor-common/types' as `FeatureFlags`)
+  - EmojiResource (available via '@atlaskit/emoji/resource' as `EmojiResource`)
+  - mediaPlugin
+  - insertMediaSingleNode
+  - CustomMediaPicker
+  - mediaPluginKey
+  - textColorPluginKey
+  - TextColorPluginState
+  - changeColor
+  - CodeBlockPlugin
+  - PanelPlugin
+  - subscribeToToolbarAndPickerUpdates
+  - subscribeTypeAheadUpdates
+  - TextFormattingInputMethodToolbar
+  - TextFormattingInputMethodBasic
+  - createTable
+  - insertTaskDecisionCommand
+  - TaskDecisionInputMethod
+  - EventDispatcher
+  - statusPluginKey
+  - StatusState
+  - StatusType
+  - DatePluginState
+  - insertDate
+  - openDatePicker
+  - deleteDate
+  - dateToDateType
+  - datePluginKey
+  - commitStatusPicker
+  - setStatusPickerAt
+  - updateStatus
+  - updateStatusWithAnalytics
+  - removeStatus
+  - typeAheadPluginKey
+  - TypeAheadPluginState
+  - setKeyboardHeight
+  - setMobilePaddingTop
+  - setIsExpanded
+  - dedupe (available via '@atlaskit/editor-common/utils' as `dedupe`)
+  - GapCursorSelection (available via '@atlaskit/editor-common/selection' as `GapCursorSelection`)
+  - GapCursorSide (available via '@atlaskit/editor-common/selection' as `Side`)
+  - HistoryPluginState
+  - MentionPluginState
+  - InsertBlockInputMethodToolbar
+  - selectionPluginKey
+  - SelectionData
+  - SelectionDataState
+  - insertExpand
+  - createTypeAheadTools
+  - AbstractMentionResource (available via '@atlaskit/mention/resource' as `AbstractMentionResource`)
+  - PresenceResource (available via '@atlaskit/mention/resource' as `PresenceResource`)
+  - ReactEditorView
+  - BaseReactEditorView
+  - getDefaultPresetOptionsFromEditorProps
+  - lightModeStatusColorPalette
+  - darkModeStatusColorPalette
+  - PaletteColor
+  - DEFAULT_BORDER_COLOR
+
+  WHY: We have been extracting plugins out of `editor-core` and as we move them out we need to remove these exports as the new architecture does not support plugin keys or commands.
+
+  This major bump will remove all remaining commands and keys in one go - some of these features will be accessible in a safe manner in the future via the `ComposableEditor` and the appropriate plugins.
+
+  HOW: Should be no consumers using these methods currently (only mobile bridge which has been updated).
+
+  If there are any issues please reach out to the #help-editor for information on how to update appropriately.
+
 ## 0.1.0
 
 ### Minor Changes
 
-- [`f8e7203eec6`](https://bitbucket.org/atlassian/atlassian-frontend/commits/f8e7203eec6) - ED-19618 Extract base plugin from editor-core
+- [#40580](https://bitbucket.org/atlassian/atlassian-frontend/pull-requests/40580) [`f8e7203eec6`](https://bitbucket.org/atlassian/atlassian-frontend/commits/f8e7203eec6) - ED-19618 Extract base plugin from editor-core
 
 ### Patch Changes
 

package/README.md

@@ -30,4 +30,4 @@ For internal Atlassian, visit the slack channel [#help-editor](https://atlassian
 
 ## License
 ---
-Please see [Atlassian Frontend - License](https://developer.atlassian.com/cloud/framework/atlassian-frontend/#license) for more licensing information.
+Please see [Atlassian Frontend - License](https://hello.atlassian.net/wiki/spaces/AF/pages/2589099144/Documentation#License) for more licensing information.

package/dist/cjs/index.js

@@ -4,30 +4,10 @@ var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefau
 Object.defineProperty(exports, "__esModule", {
   value: true
 });
-Object.defineProperty(exports, "DEGRADED_SEVERITY_THRESHOLD", {
-  enumerable: true,
-  get: function get() {
-    return _frozenEditor.DEGRADED_SEVERITY_THRESHOLD;
-  }
-});
-Object.defineProperty(exports, "NORMAL_SEVERITY_THRESHOLD", {
-  enumerable: true,
-  get: function get() {
-    return _frozenEditor.NORMAL_SEVERITY_THRESHOLD;
-  }
-});
 Object.defineProperty(exports, "basePlugin", {
   enumerable: true,
   get: function get() {
     return _plugin.default;
   }
 });
-Object.defineProperty(exports, "setKeyboardHeight", {
-  enumerable: true,
-  get: function get() {
-    return _commands.setKeyboardHeight;
-  }
-});
-var _plugin = _interopRequireDefault(require("./plugin"));
-var _frozenEditor = require("./pm-plugins/frozen-editor");
-var _commands = require("./commands");
+var _plugin = _interopRequireDefault(require("./plugin"));

package/dist/cjs/plugin.js

@@ -13,6 +13,7 @@ var _utils = require("@atlaskit/editor-common/utils");
 var _commands = require("@atlaskit/editor-prosemirror/commands");
 var _history = require("@atlaskit/editor-prosemirror/history");
 var _platformFeatureFlags = require("@atlaskit/platform-feature-flags");
+var _commands2 = require("./commands");
 var _contextIdentifier = _interopRequireWildcard(require("./pm-plugins/context-identifier"));
 var _disableSpellChecking = _interopRequireDefault(require("./pm-plugins/disable-spell-checking"));
 var _filterSteps = _interopRequireDefault(require("./pm-plugins/filter-steps"));
@@ -41,6 +42,9 @@ var basePlugin = function basePlugin(_ref) {
         keyboardHeight: (0, _scrollGutter.getKeyboardHeight)(editorState)
       };
     },
+    actions: {
+      setKeyboardHeight: _commands2.setKeyboardHeight
+    },
     pmPlugins: function pmPlugins() {
       var plugins = [{
         name: 'filterStepsPlugin',

package/dist/es2019/index.js

@@ -1,4 +1,2 @@
 import basePlugin from './plugin';
-export { basePlugin };
-export { NORMAL_SEVERITY_THRESHOLD, DEGRADED_SEVERITY_THRESHOLD } from './pm-plugins/frozen-editor';
-export { setKeyboardHeight } from './commands';
+export { basePlugin };

package/dist/es2019/plugin.js

@@ -4,6 +4,7 @@ import { browser } from '@atlaskit/editor-common/utils';
 import { baseKeymap } from '@atlaskit/editor-prosemirror/commands';
 import { history } from '@atlaskit/editor-prosemirror/history';
 import { getBooleanFF } from '@atlaskit/platform-feature-flags';
+import { setKeyboardHeight } from './commands';
 import contextIdentifierPlugin, { getContextIdentifier } from './pm-plugins/context-identifier';
 import disableSpellcheckingPlugin from './pm-plugins/disable-spell-checking';
 import filterStepsPlugin from './pm-plugins/filter-steps';
@@ -28,6 +29,9 @@ const basePlugin = ({
         keyboardHeight: getKeyboardHeight(editorState)
       };
     },
+    actions: {
+      setKeyboardHeight
+    },
     pmPlugins() {
       const plugins = [{
         name: 'filterStepsPlugin',

package/dist/esm/index.js

@@ -1,4 +1,2 @@
 import basePlugin from './plugin';
-export { basePlugin };
-export { NORMAL_SEVERITY_THRESHOLD, DEGRADED_SEVERITY_THRESHOLD } from './pm-plugins/frozen-editor';
-export { setKeyboardHeight } from './commands';
+export { basePlugin };

package/dist/esm/plugin.js

@@ -7,6 +7,7 @@ import { browser } from '@atlaskit/editor-common/utils';
 import { baseKeymap } from '@atlaskit/editor-prosemirror/commands';
 import { history } from '@atlaskit/editor-prosemirror/history';
 import { getBooleanFF } from '@atlaskit/platform-feature-flags';
+import { setKeyboardHeight } from './commands';
 import contextIdentifierPlugin, { getContextIdentifier } from './pm-plugins/context-identifier';
 import disableSpellcheckingPlugin from './pm-plugins/disable-spell-checking';
 import filterStepsPlugin from './pm-plugins/filter-steps';
@@ -30,6 +31,9 @@ var basePlugin = function basePlugin(_ref) {
         keyboardHeight: getKeyboardHeight(editorState)
       };
     },
+    actions: {
+      setKeyboardHeight: setKeyboardHeight
+    },
     pmPlugins: function pmPlugins() {
       var plugins = [{
         name: 'filterStepsPlugin',

package/dist/types/index.d.ts

@@ -3,5 +3,3 @@ import type { BasePlugin, BasePluginOptions, BasePluginState } from './plugin';
 import type { ScrollGutterPluginOptions } from './pm-plugins/scroll-gutter';
 export { basePlugin };
 export type { BasePlugin, BasePluginState, BasePluginOptions, ScrollGutterPluginOptions, };
-export { NORMAL_SEVERITY_THRESHOLD, DEGRADED_SEVERITY_THRESHOLD, } from './pm-plugins/frozen-editor';
-export { setKeyboardHeight } from './commands';

package/dist/types/plugin.d.ts

@@ -1,6 +1,7 @@
 import type { ContextIdentifierProvider } from '@atlaskit/editor-common/provider-factory';
 import type { BrowserFreezetracking, InputTracking, NextEditorPlugin } from '@atlaskit/editor-common/types';
 import type { FeatureFlagsPlugin } from '@atlaskit/editor-plugin-feature-flags';
+import { setKeyboardHeight } from './commands';
 import type { ScrollGutterPluginOptions } from './pm-plugins/scroll-gutter';
 export interface BasePluginOptions {
     allowScrollGutter?: ScrollGutterPluginOptions;
@@ -18,6 +19,9 @@ export type BasePlugin = NextEditorPlugin<'base', {
     pluginConfiguration: BasePluginOptions | undefined;
     dependencies: [FeatureFlagsPlugin];
     sharedState: BasePluginState;
+    actions: {
+        setKeyboardHeight: typeof setKeyboardHeight;
+    };
 }>;
 export declare const isChromeWithSelectionBug: any;
 declare const basePlugin: BasePlugin;

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

@@ -3,5 +3,3 @@ import type { BasePlugin, BasePluginOptions, BasePluginState } from './plugin';
 import type { ScrollGutterPluginOptions } from './pm-plugins/scroll-gutter';
 export { basePlugin };
 export type { BasePlugin, BasePluginState, BasePluginOptions, ScrollGutterPluginOptions, };
-export { NORMAL_SEVERITY_THRESHOLD, DEGRADED_SEVERITY_THRESHOLD, } from './pm-plugins/frozen-editor';
-export { setKeyboardHeight } from './commands';

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

@@ -1,6 +1,7 @@
 import type { ContextIdentifierProvider } from '@atlaskit/editor-common/provider-factory';
 import type { BrowserFreezetracking, InputTracking, NextEditorPlugin } from '@atlaskit/editor-common/types';
 import type { FeatureFlagsPlugin } from '@atlaskit/editor-plugin-feature-flags';
+import { setKeyboardHeight } from './commands';
 import type { ScrollGutterPluginOptions } from './pm-plugins/scroll-gutter';
 export interface BasePluginOptions {
     allowScrollGutter?: ScrollGutterPluginOptions;
@@ -20,6 +21,9 @@ export type BasePlugin = NextEditorPlugin<'base', {
         FeatureFlagsPlugin
     ];
     sharedState: BasePluginState;
+    actions: {
+        setKeyboardHeight: typeof setKeyboardHeight;
+    };
 }>;
 export declare const isChromeWithSelectionBug: any;
 declare const basePlugin: BasePlugin;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@atlaskit/editor-plugin-base",
-  "version": "0.1.0",
+  "version": "0.2.0",
   "description": "Base plugin for @atlaskit/editor-core",
   "author": "Atlassian Pty Ltd",
   "license": "Apache-2.0",
@@ -32,7 +32,7 @@
   },
   "dependencies": {
     "@atlaskit/adf-schema": "^29.1.0",
-    "@atlaskit/editor-common": "^76.0.0",
+    "@atlaskit/editor-common": "^76.1.0",
     "@atlaskit/editor-plugin-feature-flags": "^1.0.1",
     "@atlaskit/editor-prosemirror": "1.1.0",
     "@atlaskit/platform-feature-flags": "^0.2.0",

package/report.api.md

@@ -30,6 +30,9 @@ export type BasePlugin = NextEditorPlugin<
     pluginConfiguration: BasePluginOptions | undefined;
     dependencies: [FeatureFlagsPlugin];
     sharedState: BasePluginState;
+    actions: {
+      setKeyboardHeight: typeof setKeyboardHeight;
+    };
   }
 >;
 
@@ -56,12 +59,6 @@ export type BasePluginState = {
   keyboardHeight: number | undefined;
 };
 
-// @public (undocumented)
-export const DEGRADED_SEVERITY_THRESHOLD = 3000;
-
-// @public (undocumented)
-export const NORMAL_SEVERITY_THRESHOLD = 2000;
-
 // @public (undocumented)
 export type ScrollGutterPluginOptions = {
   getScrollElement?: (view: EditorView) => HTMLElement | null;
@@ -71,7 +68,7 @@ export type ScrollGutterPluginOptions = {
 };
 
 // @public (undocumented)
-export const setKeyboardHeight: (keyboardHeight: number) => Command;
+const setKeyboardHeight: (keyboardHeight: number) => Command;
 
 // (No @packageDocumentation comment for this package)
 ```

package/tmp/api-report-tmp.d.ts

@@ -17,6 +17,9 @@ export type BasePlugin = NextEditorPlugin<'base', {
     pluginConfiguration: BasePluginOptions | undefined;
     dependencies: [FeatureFlagsPlugin];
     sharedState: BasePluginState;
+    actions: {
+        setKeyboardHeight: typeof setKeyboardHeight;
+    };
 }>;
 
 // @public (undocumented)
@@ -42,12 +45,6 @@ export type BasePluginState = {
     keyboardHeight: number | undefined;
 };
 
-// @public (undocumented)
-export const DEGRADED_SEVERITY_THRESHOLD = 3000;
-
-// @public (undocumented)
-export const NORMAL_SEVERITY_THRESHOLD = 2000;
-
 // @public (undocumented)
 export type ScrollGutterPluginOptions = {
     getScrollElement?: (view: EditorView) => HTMLElement | null;
@@ -57,7 +54,7 @@ export type ScrollGutterPluginOptions = {
 };
 
 // @public (undocumented)
-export const setKeyboardHeight: (keyboardHeight: number) => Command;
+const setKeyboardHeight: (keyboardHeight: number) => Command;
 
 // (No @packageDocumentation comment for this package)