@atlaskit/editor-plugin-editor-disabled 2.0.6 → 2.1.0

package/CHANGELOG.md

@@ -1,5 +1,17 @@
 # @atlaskit/editor-plugin-editor-disabled
 
+## 2.1.0
+
+### Minor Changes
+
+- [#170934](https://bitbucket.org/atlassian/atlassian-frontend-monorepo/pull-requests/170934)
+  [`1b251997752cd`](https://bitbucket.org/atlassian/atlassian-frontend-monorepo/commits/1b251997752cd) -
+  Expose editor disabled prop to reduce number of initial transactions.
+
+### Patch Changes
+
+- Updated dependencies
+
 ## 2.0.6
 
 ### Patch Changes

package/dist/cjs/editorDisabledPlugin.js

@@ -5,39 +5,56 @@ Object.defineProperty(exports, "__esModule", {
   value: true
 });
 exports.editorDisabledPlugin = void 0;
+var _defineProperty2 = _interopRequireDefault(require("@babel/runtime/helpers/defineProperty"));
 var _rafSchd = _interopRequireDefault(require("raf-schd"));
 var _safePlugin = require("@atlaskit/editor-common/safe-plugin");
 var _utils = require("@atlaskit/editor-common/utils");
 var _state = require("@atlaskit/editor-prosemirror/state");
+function ownKeys(e, r) { var t = Object.keys(e); if (Object.getOwnPropertySymbols) { var o = Object.getOwnPropertySymbols(e); r && (o = o.filter(function (r) { return Object.getOwnPropertyDescriptor(e, r).enumerable; })), t.push.apply(t, o); } return t; }
+function _objectSpread(e) { for (var r = 1; r < arguments.length; r++) { var t = null != arguments[r] ? arguments[r] : {}; r % 2 ? ownKeys(Object(t), !0).forEach(function (r) { (0, _defineProperty2.default)(e, r, t[r]); }) : Object.getOwnPropertyDescriptors ? Object.defineProperties(e, Object.getOwnPropertyDescriptors(t)) : ownKeys(Object(t)).forEach(function (r) { Object.defineProperty(e, r, Object.getOwnPropertyDescriptor(t, r)); }); } return e; }
 var pluginKey = new _state.PluginKey('editorDisabledPlugin');
 function reducer(_pluginState, meta) {
   return meta;
 }
 var _pluginFactory = (0, _utils.pluginFactory)(pluginKey, reducer),
-  createPluginState = _pluginFactory.createPluginState,
   getPluginState = _pluginFactory.getPluginState;
-var scheduleEditorDisabledUpdate = (0, _rafSchd.default)(function (view) {
-  if (getPluginState(view.state).editorDisabled !== !view.editable) {
-    var tr = view.state.tr.setMeta(pluginKey, {
-      editorDisabled: !view.editable
-    });
-    tr.setMeta('isLocal', true);
-    view.dispatch(tr);
-  }
-});
 
 /*
 Stores the state of the editor enabled/disabled for panel and floating
 toolbar to subscribe to through useSharedPluginState. Otherwise the NodeViews
 won't re-render when it changes.
 */
-function createPlugin(dispatch) {
+function createPlugin(dispatch, options) {
+  var scheduleEditorDisabledUpdate = (0, _rafSchd.default)(function (view) {
+    if (getPluginState(view.state).editorDisabled !== !view.editable) {
+      var disabledMeta = {
+        editorDisabled: !view.editable
+      };
+      var tr = view.state.tr.setMeta(pluginKey, disabledMeta).setMeta('editorDisabledPlugin', disabledMeta);
+      tr.setMeta('isLocal', true);
+      view.dispatch(tr);
+    }
+  });
   return new _safePlugin.SafePlugin({
     key: pluginKey,
-    state: createPluginState(dispatch, {
-      editorDisabled: false
-    }),
-    view: function view() {
+    state: {
+      init: function init() {
+        var _options$initialDisab;
+        return {
+          editorDisabled: (_options$initialDisab = options === null || options === void 0 ? void 0 : options.initialDisabledState) !== null && _options$initialDisab !== void 0 ? _options$initialDisab : false
+        };
+      },
+      apply: function apply(tr, pluginState) {
+        var meta = tr.getMeta(pluginKey);
+        if (meta) {
+          return pluginState.editorDisabled !== meta.editorDisabled ? _objectSpread(_objectSpread({}, pluginState), meta) : pluginState;
+        }
+        return pluginState;
+      }
+    },
+    view: function view(_view) {
+      // schedule on mount
+      scheduleEditorDisabledUpdate(_view);
       return {
         update: function update(view) {
           scheduleEditorDisabledUpdate(view);
@@ -53,8 +70,23 @@ function createPlugin(dispatch) {
 /**
  * Editor disabled plugin to be added to an `EditorPresetBuilder` and used with `ComposableEditor`
  * from `@atlaskit/editor-core`.
+ *
+ * @param options - Plugin configuration options
+ * @returns EditorDisabledPlugin
+ *
+ * @example
+ * ```typescript
+ * // Basic usage
+ * .add(editorDisabledPlugin)
+ *
+ * // With initial disabled state
+ * .add(editorDisabledPlugin, { initialDisabledState: true })
+ * ```
  */
-var editorDisabledPlugin = exports.editorDisabledPlugin = function editorDisabledPlugin() {
+var editorDisabledPlugin = exports.editorDisabledPlugin = function editorDisabledPlugin(_ref) {
+  var _ref$config = _ref.config,
+    options = _ref$config === void 0 ? {} : _ref$config,
+    api = _ref.api;
   return {
     name: 'editorDisabled',
     getSharedState: function getSharedState(editorState) {
@@ -74,9 +106,9 @@ var editorDisabledPlugin = exports.editorDisabledPlugin = function editorDisable
     pmPlugins: function pmPlugins() {
       return [{
         name: 'editorDisabled',
-        plugin: function plugin(_ref) {
-          var dispatch = _ref.dispatch;
-          return createPlugin(dispatch);
+        plugin: function plugin(_ref2) {
+          var dispatch = _ref2.dispatch;
+          return createPlugin(dispatch, options);
         }
       }];
     }

package/dist/es2019/editorDisabledPlugin.js

@@ -7,31 +7,48 @@ function reducer(_pluginState, meta) {
   return meta;
 }
 const {
-  createPluginState,
   getPluginState
 } = pluginFactory(pluginKey, reducer);
-const scheduleEditorDisabledUpdate = rafSchedule(view => {
-  if (getPluginState(view.state).editorDisabled !== !view.editable) {
-    const tr = view.state.tr.setMeta(pluginKey, {
-      editorDisabled: !view.editable
-    });
-    tr.setMeta('isLocal', true);
-    view.dispatch(tr);
-  }
-});
 
 /*
 Stores the state of the editor enabled/disabled for panel and floating
 toolbar to subscribe to through useSharedPluginState. Otherwise the NodeViews
 won't re-render when it changes.
 */
-function createPlugin(dispatch) {
+function createPlugin(dispatch, options) {
+  const scheduleEditorDisabledUpdate = rafSchedule(view => {
+    if (getPluginState(view.state).editorDisabled !== !view.editable) {
+      const disabledMeta = {
+        editorDisabled: !view.editable
+      };
+      const tr = view.state.tr.setMeta(pluginKey, disabledMeta).setMeta('editorDisabledPlugin', disabledMeta);
+      tr.setMeta('isLocal', true);
+      view.dispatch(tr);
+    }
+  });
   return new SafePlugin({
     key: pluginKey,
-    state: createPluginState(dispatch, {
-      editorDisabled: false
-    }),
-    view: () => {
+    state: {
+      init: () => {
+        var _options$initialDisab;
+        return {
+          editorDisabled: (_options$initialDisab = options === null || options === void 0 ? void 0 : options.initialDisabledState) !== null && _options$initialDisab !== void 0 ? _options$initialDisab : false
+        };
+      },
+      apply: (tr, pluginState) => {
+        const meta = tr.getMeta(pluginKey);
+        if (meta) {
+          return pluginState.editorDisabled !== meta.editorDisabled ? {
+            ...pluginState,
+            ...meta
+          } : pluginState;
+        }
+        return pluginState;
+      }
+    },
+    view: view => {
+      // schedule on mount
+      scheduleEditorDisabledUpdate(view);
       return {
         update(view) {
           scheduleEditorDisabledUpdate(view);
@@ -47,8 +64,23 @@ function createPlugin(dispatch) {
 /**
  * Editor disabled plugin to be added to an `EditorPresetBuilder` and used with `ComposableEditor`
  * from `@atlaskit/editor-core`.
+ *
+ * @param options - Plugin configuration options
+ * @returns EditorDisabledPlugin
+ *
+ * @example
+ * ```typescript
+ * // Basic usage
+ * .add(editorDisabledPlugin)
+ *
+ * // With initial disabled state
+ * .add(editorDisabledPlugin, { initialDisabledState: true })
+ * ```
  */
-export const editorDisabledPlugin = () => ({
+export const editorDisabledPlugin = ({
+  config: options = {},
+  api
+}) => ({
   name: 'editorDisabled',
   getSharedState(editorState) {
     if (!editorState) {
@@ -68,6 +100,6 @@ export const editorDisabledPlugin = () => ({
     name: 'editorDisabled',
     plugin: ({
       dispatch
-    }) => createPlugin(dispatch)
+    }) => createPlugin(dispatch, options)
   }]
 });

package/dist/esm/editorDisabledPlugin.js

@@ -1,3 +1,6 @@
+import _defineProperty from "@babel/runtime/helpers/defineProperty";
+function ownKeys(e, r) { var t = Object.keys(e); if (Object.getOwnPropertySymbols) { var o = Object.getOwnPropertySymbols(e); r && (o = o.filter(function (r) { return Object.getOwnPropertyDescriptor(e, r).enumerable; })), t.push.apply(t, o); } return t; }
+function _objectSpread(e) { for (var r = 1; r < arguments.length; r++) { var t = null != arguments[r] ? arguments[r] : {}; r % 2 ? ownKeys(Object(t), !0).forEach(function (r) { _defineProperty(e, r, t[r]); }) : Object.getOwnPropertyDescriptors ? Object.defineProperties(e, Object.getOwnPropertyDescriptors(t)) : ownKeys(Object(t)).forEach(function (r) { Object.defineProperty(e, r, Object.getOwnPropertyDescriptor(t, r)); }); } return e; }
 import rafSchedule from 'raf-schd';
 import { SafePlugin } from '@atlaskit/editor-common/safe-plugin';
 import { pluginFactory } from '@atlaskit/editor-common/utils';
@@ -7,30 +10,44 @@ function reducer(_pluginState, meta) {
   return meta;
 }
 var _pluginFactory = pluginFactory(pluginKey, reducer),
-  createPluginState = _pluginFactory.createPluginState,
   getPluginState = _pluginFactory.getPluginState;
-var scheduleEditorDisabledUpdate = rafSchedule(function (view) {
-  if (getPluginState(view.state).editorDisabled !== !view.editable) {
-    var tr = view.state.tr.setMeta(pluginKey, {
-      editorDisabled: !view.editable
-    });
-    tr.setMeta('isLocal', true);
-    view.dispatch(tr);
-  }
-});
 
 /*
 Stores the state of the editor enabled/disabled for panel and floating
 toolbar to subscribe to through useSharedPluginState. Otherwise the NodeViews
 won't re-render when it changes.
 */
-function createPlugin(dispatch) {
+function createPlugin(dispatch, options) {
+  var scheduleEditorDisabledUpdate = rafSchedule(function (view) {
+    if (getPluginState(view.state).editorDisabled !== !view.editable) {
+      var disabledMeta = {
+        editorDisabled: !view.editable
+      };
+      var tr = view.state.tr.setMeta(pluginKey, disabledMeta).setMeta('editorDisabledPlugin', disabledMeta);
+      tr.setMeta('isLocal', true);
+      view.dispatch(tr);
+    }
+  });
   return new SafePlugin({
     key: pluginKey,
-    state: createPluginState(dispatch, {
-      editorDisabled: false
-    }),
-    view: function view() {
+    state: {
+      init: function init() {
+        var _options$initialDisab;
+        return {
+          editorDisabled: (_options$initialDisab = options === null || options === void 0 ? void 0 : options.initialDisabledState) !== null && _options$initialDisab !== void 0 ? _options$initialDisab : false
+        };
+      },
+      apply: function apply(tr, pluginState) {
+        var meta = tr.getMeta(pluginKey);
+        if (meta) {
+          return pluginState.editorDisabled !== meta.editorDisabled ? _objectSpread(_objectSpread({}, pluginState), meta) : pluginState;
+        }
+        return pluginState;
+      }
+    },
+    view: function view(_view) {
+      // schedule on mount
+      scheduleEditorDisabledUpdate(_view);
       return {
         update: function update(view) {
           scheduleEditorDisabledUpdate(view);
@@ -46,8 +63,23 @@ function createPlugin(dispatch) {
 /**
  * Editor disabled plugin to be added to an `EditorPresetBuilder` and used with `ComposableEditor`
  * from `@atlaskit/editor-core`.
+ *
+ * @param options - Plugin configuration options
+ * @returns EditorDisabledPlugin
+ *
+ * @example
+ * ```typescript
+ * // Basic usage
+ * .add(editorDisabledPlugin)
+ *
+ * // With initial disabled state
+ * .add(editorDisabledPlugin, { initialDisabledState: true })
+ * ```
  */
-export var editorDisabledPlugin = function editorDisabledPlugin() {
+export var editorDisabledPlugin = function editorDisabledPlugin(_ref) {
+  var _ref$config = _ref.config,
+    options = _ref$config === void 0 ? {} : _ref$config,
+    api = _ref.api;
   return {
     name: 'editorDisabled',
     getSharedState: function getSharedState(editorState) {
@@ -67,9 +99,9 @@ export var editorDisabledPlugin = function editorDisabledPlugin() {
     pmPlugins: function pmPlugins() {
       return [{
         name: 'editorDisabled',
-        plugin: function plugin(_ref) {
-          var dispatch = _ref.dispatch;
-          return createPlugin(dispatch);
+        plugin: function plugin(_ref2) {
+          var dispatch = _ref2.dispatch;
+          return createPlugin(dispatch, options);
         }
       }];
     }

package/dist/types/editorDisabledPlugin.d.ts

@@ -1,6 +1,18 @@
-import { type EditorDisabledPlugin } from './editorDisabledPluginType';
+import type { EditorDisabledPlugin } from './editorDisabledPluginType';
 /**
  * Editor disabled plugin to be added to an `EditorPresetBuilder` and used with `ComposableEditor`
  * from `@atlaskit/editor-core`.
+ *
+ * @param options - Plugin configuration options
+ * @returns EditorDisabledPlugin
+ *
+ * @example
+ * ```typescript
+ * // Basic usage
+ * .add(editorDisabledPlugin)
+ *
+ * // With initial disabled state
+ * .add(editorDisabledPlugin, { initialDisabledState: true })
+ * ```
  */
 export declare const editorDisabledPlugin: EditorDisabledPlugin;

package/dist/types/editorDisabledPluginType.d.ts

@@ -2,6 +2,10 @@ import type { NextEditorPlugin } from '@atlaskit/editor-common/types';
 export type EditorDisabledPluginState = {
     editorDisabled: boolean;
 };
+export interface EditorDisabledPluginOptions {
+    initialDisabledState?: boolean;
+}
 export type EditorDisabledPlugin = NextEditorPlugin<'editorDisabled', {
     sharedState: EditorDisabledPluginState;
+    pluginConfiguration: EditorDisabledPluginOptions | undefined;
 }>;

package/dist/types/index.d.ts

@@ -1,2 +1,2 @@
 export { editorDisabledPlugin } from './editorDisabledPlugin';
-export type { EditorDisabledPluginState, EditorDisabledPlugin } from './editorDisabledPluginType';
+export type { EditorDisabledPluginState, EditorDisabledPlugin, EditorDisabledPluginOptions, } from './editorDisabledPluginType';

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

@@ -1,6 +1,18 @@
-import { type EditorDisabledPlugin } from './editorDisabledPluginType';
+import type { EditorDisabledPlugin } from './editorDisabledPluginType';
 /**
  * Editor disabled plugin to be added to an `EditorPresetBuilder` and used with `ComposableEditor`
  * from `@atlaskit/editor-core`.
+ *
+ * @param options - Plugin configuration options
+ * @returns EditorDisabledPlugin
+ *
+ * @example
+ * ```typescript
+ * // Basic usage
+ * .add(editorDisabledPlugin)
+ *
+ * // With initial disabled state
+ * .add(editorDisabledPlugin, { initialDisabledState: true })
+ * ```
  */
 export declare const editorDisabledPlugin: EditorDisabledPlugin;

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

@@ -2,6 +2,10 @@ import type { NextEditorPlugin } from '@atlaskit/editor-common/types';
 export type EditorDisabledPluginState = {
     editorDisabled: boolean;
 };
+export interface EditorDisabledPluginOptions {
+    initialDisabledState?: boolean;
+}
 export type EditorDisabledPlugin = NextEditorPlugin<'editorDisabled', {
     sharedState: EditorDisabledPluginState;
+    pluginConfiguration: EditorDisabledPluginOptions | undefined;
 }>;

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

@@ -1,2 +1,2 @@
 export { editorDisabledPlugin } from './editorDisabledPlugin';
-export type { EditorDisabledPluginState, EditorDisabledPlugin } from './editorDisabledPluginType';
+export type { EditorDisabledPluginState, EditorDisabledPlugin, EditorDisabledPluginOptions, } from './editorDisabledPluginType';

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@atlaskit/editor-plugin-editor-disabled",
-	"version": "2.0.6",
+	"version": "2.1.0",
 	"description": "Editor disabled plugin for @atlaskit/editor-core",
 	"author": "Atlassian Pty Ltd",
 	"license": "Apache-2.0",
@@ -23,7 +23,7 @@
 		".": "./src/index.ts"
 	},
 	"dependencies": {
-		"@atlaskit/editor-common": "^106.0.0",
+		"@atlaskit/editor-common": "^106.9.0",
 		"@atlaskit/editor-prosemirror": "7.0.0",
 		"@babel/runtime": "^7.0.0",
 		"raf-schd": "^4.0.3"