@atlaskit/editor-plugin-limited-mode 0.0.2 → 1.0.0

package/CHANGELOG.md

@@ -1,5 +1,20 @@
 # @atlaskit/editor-plugin-limited-mode
 
+## 1.0.0
+
+### Patch Changes
+
+- Updated dependencies
+
+## 0.0.3
+
+### Patch Changes
+
+- [`e33be5daddd2b`](https://bitbucket.org/atlassian/atlassian-frontend-monorepo/commits/e33be5daddd2b) -
+  ED-28892 Limited mode: adjust how we're triggering cleanup logic for block control plugin. Hook up
+  banner. Other misc setup.
+- Updated dependencies
+
 ## 0.0.2
 
 ### Patch Changes

package/afm-cc/tsconfig.json

@@ -2,9 +2,9 @@
 	"extends": "../../../../tsconfig.entry-points.confluence.json",
 	"compilerOptions": {
 		"target": "es5",
-		"composite": true,
 		"outDir": "../../../../../confluence/tsDist/@atlaskit__editor-plugin-limited-mode",
-		"rootDir": "../"
+		"rootDir": "../",
+		"composite": true
 	},
 	"include": [
 		"../src/**/*.ts",
@@ -24,4 +24,4 @@
 			"path": "../../editor-common/afm-cc/tsconfig.json"
 		}
 	]
-}
+}

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

@@ -1,38 +1,26 @@
 "use strict";
 
+var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault");
 Object.defineProperty(exports, "__esModule", {
   value: true
 });
 exports.limitedModePluginKey = exports.createPlugin = void 0;
+var _defineProperty2 = _interopRequireDefault(require("@babel/runtime/helpers/defineProperty"));
 var _safePlugin = require("@atlaskit/editor-common/safe-plugin");
 var _state = require("@atlaskit/editor-prosemirror/state");
 var _expVal = require("@atlaskit/tmp-editor-statsig/expVal");
+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 limitedModePluginKey = exports.limitedModePluginKey = new _state.PluginKey('limitedModePlugin');
 var createPlugin = exports.createPlugin = function createPlugin() {
-  var _view2;
-  var stateUpdated = false;
-  function updateState(view) {
-    var newState = _state.EditorState.create({
-      schema: view.state.schema,
-      doc: view.state.doc,
-      // remove the state plugin to trigger the view cleanup function
-      // @ts-ignore This plugin interaction is expected to be temporary - we can't pass the key via standard inter plugin communication as that would introduce cyclical dependencies
-      plugins: view.state.plugins.filter(function (p) {
-        return p.key !== 'blockControls$';
-      }) // Filter out the unwanted plugin
-    });
-    view.updateState(newState);
-    stateUpdated = true;
-  }
   return new _safePlugin.SafePlugin({
     key: limitedModePluginKey,
     view: function view(_view) {
-      _view2 = _view;
       return {};
     },
     state: {
       init: function init(config, editorState) {
-        if (editorState.doc.childCount > (0, _expVal.expVal)('cc_editor_limited_mode', 'nodeSize', 100)) {
+        if (editorState.doc.nodeSize > (0, _expVal.expVal)('cc_editor_limited_mode', 'nodeSize', 100)) {
           return {
             documentSizeBreachesThreshold: true
           };
@@ -41,30 +29,17 @@ var createPlugin = exports.createPlugin = function createPlugin() {
           documentSizeBreachesThreshold: false
         };
       },
-      apply: function apply(tr, _currentPluginState) {
-        if (_currentPluginState.documentSizeBreachesThreshold) {
-          if (!stateUpdated) {
-            // when the document size reaches the threshold from the state initialisation there is no existing seam to communicate this
-            // to the controls plug-in without putting in limited mode specific logic inside the controls plug-in as well.
-            // to mitigate this we call the update state here. Which will mean the editor does not have state divergence
-            // between when limited mode kicks in on first load versus mid edit session.
-            updateState(_view2);
-          }
-          return {
-            documentSizeBreachesThreshold: true
-          };
+      apply: function apply(tr, currentPluginState) {
+        // Don't check the document size if we're already in limited mode.
+        if (currentPluginState.documentSizeBreachesThreshold) {
+          return currentPluginState;
         }
-        if (tr.doc.childCount > (0, _expVal.expVal)('cc_editor_limited_mode', 'nodeSize', 100)) {
-          var customEvent = new CustomEvent('limited-mode-activated');
-          document.dispatchEvent(customEvent);
-          updateState(_view2);
-          return {
+        if (tr.doc.nodeSize > (0, _expVal.expVal)('cc_editor_limited_mode', 'nodeSize', 100)) {
+          return _objectSpread(_objectSpread({}, currentPluginState), {}, {
             documentSizeBreachesThreshold: true
-          };
+          });
         }
-        return {
-          documentSizeBreachesThreshold: false
-        };
+        return currentPluginState;
       }
     }
   });

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

@@ -1,30 +1,16 @@
 import { SafePlugin } from '@atlaskit/editor-common/safe-plugin';
-import { EditorState, PluginKey } from '@atlaskit/editor-prosemirror/state';
+import { PluginKey } from '@atlaskit/editor-prosemirror/state';
 import { expVal } from '@atlaskit/tmp-editor-statsig/expVal';
 export const limitedModePluginKey = new PluginKey('limitedModePlugin');
 export const createPlugin = () => {
-  let view;
-  let stateUpdated = false;
-  function updateState(view) {
-    const newState = EditorState.create({
-      schema: view.state.schema,
-      doc: view.state.doc,
-      // remove the state plugin to trigger the view cleanup function
-      // @ts-ignore This plugin interaction is expected to be temporary - we can't pass the key via standard inter plugin communication as that would introduce cyclical dependencies
-      plugins: view.state.plugins.filter(p => p.key !== 'blockControls$') // Filter out the unwanted plugin
-    });
-    view.updateState(newState);
-    stateUpdated = true;
-  }
   return new SafePlugin({
     key: limitedModePluginKey,
     view: _view => {
-      view = _view;
       return {};
     },
     state: {
       init(config, editorState) {
-        if (editorState.doc.childCount > expVal('cc_editor_limited_mode', 'nodeSize', 100)) {
+        if (editorState.doc.nodeSize > expVal('cc_editor_limited_mode', 'nodeSize', 100)) {
           return {
             documentSizeBreachesThreshold: true
           };
@@ -33,30 +19,18 @@ export const createPlugin = () => {
           documentSizeBreachesThreshold: false
         };
       },
-      apply: (tr, _currentPluginState) => {
-        if (_currentPluginState.documentSizeBreachesThreshold) {
-          if (!stateUpdated) {
-            // when the document size reaches the threshold from the state initialisation there is no existing seam to communicate this
-            // to the controls plug-in without putting in limited mode specific logic inside the controls plug-in as well.
-            // to mitigate this we call the update state here. Which will mean the editor does not have state divergence
-            // between when limited mode kicks in on first load versus mid edit session.
-            updateState(view);
-          }
-          return {
-            documentSizeBreachesThreshold: true
-          };
+      apply: (tr, currentPluginState) => {
+        // Don't check the document size if we're already in limited mode.
+        if (currentPluginState.documentSizeBreachesThreshold) {
+          return currentPluginState;
         }
-        if (tr.doc.childCount > expVal('cc_editor_limited_mode', 'nodeSize', 100)) {
-          const customEvent = new CustomEvent('limited-mode-activated');
-          document.dispatchEvent(customEvent);
-          updateState(view);
+        if (tr.doc.nodeSize > expVal('cc_editor_limited_mode', 'nodeSize', 100)) {
           return {
+            ...currentPluginState,
             documentSizeBreachesThreshold: true
           };
         }
-        return {
-          documentSizeBreachesThreshold: false
-        };
+        return currentPluginState;
       }
     }
   });

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

@@ -1,32 +1,19 @@
+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 { SafePlugin } from '@atlaskit/editor-common/safe-plugin';
-import { EditorState, PluginKey } from '@atlaskit/editor-prosemirror/state';
+import { PluginKey } from '@atlaskit/editor-prosemirror/state';
 import { expVal } from '@atlaskit/tmp-editor-statsig/expVal';
 export var limitedModePluginKey = new PluginKey('limitedModePlugin');
 export var createPlugin = function createPlugin() {
-  var _view2;
-  var stateUpdated = false;
-  function updateState(view) {
-    var newState = EditorState.create({
-      schema: view.state.schema,
-      doc: view.state.doc,
-      // remove the state plugin to trigger the view cleanup function
-      // @ts-ignore This plugin interaction is expected to be temporary - we can't pass the key via standard inter plugin communication as that would introduce cyclical dependencies
-      plugins: view.state.plugins.filter(function (p) {
-        return p.key !== 'blockControls$';
-      }) // Filter out the unwanted plugin
-    });
-    view.updateState(newState);
-    stateUpdated = true;
-  }
   return new SafePlugin({
     key: limitedModePluginKey,
     view: function view(_view) {
-      _view2 = _view;
       return {};
     },
     state: {
       init: function init(config, editorState) {
-        if (editorState.doc.childCount > expVal('cc_editor_limited_mode', 'nodeSize', 100)) {
+        if (editorState.doc.nodeSize > expVal('cc_editor_limited_mode', 'nodeSize', 100)) {
           return {
             documentSizeBreachesThreshold: true
           };
@@ -35,30 +22,17 @@ export var createPlugin = function createPlugin() {
           documentSizeBreachesThreshold: false
         };
       },
-      apply: function apply(tr, _currentPluginState) {
-        if (_currentPluginState.documentSizeBreachesThreshold) {
-          if (!stateUpdated) {
-            // when the document size reaches the threshold from the state initialisation there is no existing seam to communicate this
-            // to the controls plug-in without putting in limited mode specific logic inside the controls plug-in as well.
-            // to mitigate this we call the update state here. Which will mean the editor does not have state divergence
-            // between when limited mode kicks in on first load versus mid edit session.
-            updateState(_view2);
-          }
-          return {
-            documentSizeBreachesThreshold: true
-          };
+      apply: function apply(tr, currentPluginState) {
+        // Don't check the document size if we're already in limited mode.
+        if (currentPluginState.documentSizeBreachesThreshold) {
+          return currentPluginState;
         }
-        if (tr.doc.childCount > expVal('cc_editor_limited_mode', 'nodeSize', 100)) {
-          var customEvent = new CustomEvent('limited-mode-activated');
-          document.dispatchEvent(customEvent);
-          updateState(_view2);
-          return {
+        if (tr.doc.nodeSize > expVal('cc_editor_limited_mode', 'nodeSize', 100)) {
+          return _objectSpread(_objectSpread({}, currentPluginState), {}, {
             documentSizeBreachesThreshold: true
-          };
+          });
         }
-        return {
-          documentSizeBreachesThreshold: false
-        };
+        return currentPluginState;
       }
     }
   });

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@atlaskit/editor-plugin-limited-mode",
-	"version": "0.0.2",
+	"version": "1.0.0",
 	"description": "LimitedMode plugin for @atlaskit/editor-core",
 	"author": "Atlassian Pty Ltd",
 	"license": "Apache-2.0",
@@ -27,16 +27,13 @@
 	},
 	"sideEffects": false,
 	"atlaskit:src": "src/index.ts",
-	"af:exports": {
-		".": "./src/index.ts"
-	},
 	"dependencies": {
 		"@atlaskit/editor-prosemirror": "7.0.0",
-		"@atlaskit/tmp-editor-statsig": "^11.0.0",
+		"@atlaskit/tmp-editor-statsig": "^12.0.0",
 		"@babel/runtime": "^7.0.0"
 	},
 	"peerDependencies": {
-		"@atlaskit/editor-common": "^107.25.0",
+		"@atlaskit/editor-common": "^108.0.0",
 		"react": "^18.2.0"
 	},
 	"devDependencies": {