@atlaskit/editor-plugin-base 0.3.2 → 0.3.4

package/CHANGELOG.md

@@ -1,5 +1,17 @@
 # @atlaskit/editor-plugin-base
 
+## 0.3.4
+
+### Patch Changes
+
+- [#67690](https://stash.atlassian.com/projects/CONFCLOUD/repos/confluence-frontend/pull-requests/67690) [`2f7dc1629e1c`](https://stash.atlassian.com/projects/CONFCLOUD/repos/confluence-frontend/commits/2f7dc1629e1c) - Cleanup feature flag for scrolling optimisation.
+
+## 0.3.3
+
+### Patch Changes
+
+- Updated dependencies
+
 ## 0.3.2
 
 ### Patch Changes

package/dist/cjs/plugin.js

@@ -11,7 +11,6 @@ var _adfSchema = require("@atlaskit/adf-schema");
 var _keymaps = require("@atlaskit/editor-common/keymaps");
 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"));
@@ -20,7 +19,6 @@ var _frozenEditor = _interopRequireDefault(require("./pm-plugins/frozen-editor")
 var _inlineCursorTarget = _interopRequireDefault(require("./pm-plugins/inline-cursor-target"));
 var _newlinePreserveMarks = _interopRequireDefault(require("./pm-plugins/newline-preserve-marks"));
 var _scrollGutter = _interopRequireWildcard(require("./pm-plugins/scroll-gutter"));
-var _pluginDeprecated = _interopRequireDefault(require("./pm-plugins/scroll-gutter/plugin-deprecated"));
 function _getRequireWildcardCache(nodeInterop) { if (typeof WeakMap !== "function") return null; var cacheBabelInterop = new WeakMap(); var cacheNodeInterop = new WeakMap(); return (_getRequireWildcardCache = function _getRequireWildcardCache(nodeInterop) { return nodeInterop ? cacheNodeInterop : cacheBabelInterop; })(nodeInterop); }
 function _interopRequireWildcard(obj, nodeInterop) { if (!nodeInterop && obj && obj.__esModule) { return obj; } if (obj === null || _typeof(obj) !== "object" && typeof obj !== "function") { return { default: obj }; } var cache = _getRequireWildcardCache(nodeInterop); if (cache && cache.has(obj)) { return cache.get(obj); } var newObj = {}; var hasPropertyDescriptor = Object.defineProperty && Object.getOwnPropertyDescriptor; for (var key in obj) { if (key !== "default" && Object.prototype.hasOwnProperty.call(obj, key)) { var desc = hasPropertyDescriptor ? Object.getOwnPropertyDescriptor(obj, key) : null; if (desc && (desc.get || desc.set)) { Object.defineProperty(newObj, key, desc); } else { newObj[key] = obj[key]; } } } newObj.default = obj; if (cache) { cache.set(obj, newObj); } return newObj; }
 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; }
@@ -108,7 +106,7 @@ var basePlugin = function basePlugin(_ref) {
         plugins.push({
           name: 'scrollGutterPlugin',
           plugin: function plugin() {
-            return (0, _platformFeatureFlags.getBooleanFF)('platform.editor.scroll-gutter.reflow-optimisation') ? (0, _scrollGutter.default)(options.allowScrollGutter) : (0, _pluginDeprecated.default)(options.allowScrollGutter);
+            return (0, _scrollGutter.default)(options.allowScrollGutter);
           }
         });
       }

package/dist/cjs/pm-plugins/scroll-gutter/index.js

@@ -216,7 +216,7 @@ var _default = exports.default = function _default() {
           gutter.addGutter(editorParentElement);
         }
       };
-      var toggleGutter = function toggleGutter(viewPortSize, contentSize) {
+      var toggleGutter = function toggleGutter(contentSize, threshold) {
         if (pluginOptions.persistScrollGutter) {
           if (!(0, _utils.isEmptyDocument)(view.state.doc)) {
             addAndObserveGutter();
@@ -229,8 +229,7 @@ var _default = exports.default = function _default() {
         // Add or remove the gutter based on whether the content is about to exceed the viewport height.
         // We do this to ensure there is sufficient white space below the last content node in order to
         // see any UI control elements which may sit beneath it.
-        var gutterThresholdHeight = viewPortSize - gutterSize;
-        if (contentSize >= gutterThresholdHeight) {
+        if (contentSize >= threshold) {
           addAndObserveGutter();
         } else {
           if (gutter.isMounted()) {
@@ -258,7 +257,7 @@ var _default = exports.default = function _default() {
         } finally {
           _iterator.f();
         }
-        toggleGutter(viewportElementHeight, contentElementHeight);
+        toggleGutter(contentElementHeight, viewportElementHeight);
       };
 
       // Subscribe to updates of the height of the viewport and content elements
@@ -288,7 +287,8 @@ var _default = exports.default = function _default() {
             // No need to recheck if the selected node hasn't changed.
             return;
           }
-          toggleGutter(viewportElementHeight, contentElementHeight);
+          var gutterThresholdHeight = viewportElementHeight - gutterSize;
+          toggleGutter(contentElementHeight, gutterThresholdHeight);
         }
       };
     })

package/dist/es2019/plugin.js

@@ -2,7 +2,6 @@ import { doc, paragraph, text } from '@atlaskit/adf-schema';
 import { keymap } from '@atlaskit/editor-common/keymaps';
 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';
@@ -11,7 +10,6 @@ import frozenEditor from './pm-plugins/frozen-editor';
 import inlineCursorTargetPlugin from './pm-plugins/inline-cursor-target';
 import newlinePreserveMarksPlugin from './pm-plugins/newline-preserve-marks';
 import scrollGutter, { getKeyboardHeight } from './pm-plugins/scroll-gutter';
-import deprecatedScrollGutter from './pm-plugins/scroll-gutter/plugin-deprecated';
 const basePlugin = ({
   config: options,
   api
@@ -85,7 +83,7 @@ const basePlugin = ({
       if (options && options.allowScrollGutter) {
         plugins.push({
           name: 'scrollGutterPlugin',
-          plugin: () => getBooleanFF('platform.editor.scroll-gutter.reflow-optimisation') ? scrollGutter(options.allowScrollGutter) : deprecatedScrollGutter(options.allowScrollGutter)
+          plugin: () => scrollGutter(options.allowScrollGutter)
         });
       }
       plugins.push({

package/dist/es2019/pm-plugins/scroll-gutter/index.js

@@ -195,7 +195,7 @@ export default ((pluginOptions = {}) => {
           gutter.addGutter(editorParentElement);
         }
       };
-      const toggleGutter = (viewPortSize, contentSize) => {
+      const toggleGutter = (contentSize, threshold) => {
         if (pluginOptions.persistScrollGutter) {
           if (!isEmptyDocument(view.state.doc)) {
             addAndObserveGutter();
@@ -208,8 +208,7 @@ export default ((pluginOptions = {}) => {
         // Add or remove the gutter based on whether the content is about to exceed the viewport height.
         // We do this to ensure there is sufficient white space below the last content node in order to
         // see any UI control elements which may sit beneath it.
-        const gutterThresholdHeight = viewPortSize - gutterSize;
-        if (contentSize >= gutterThresholdHeight) {
+        if (contentSize >= threshold) {
           addAndObserveGutter();
         } else {
           if (gutter.isMounted()) {
@@ -228,7 +227,7 @@ export default ((pluginOptions = {}) => {
             contentElementHeight = elementHeight - (gutter.isMounted() ? gutterSize : 0);
           }
         }
-        toggleGutter(viewportElementHeight, contentElementHeight);
+        toggleGutter(contentElementHeight, viewportElementHeight);
       };
 
       // Subscribe to updates of the height of the viewport and content elements
@@ -258,7 +257,8 @@ export default ((pluginOptions = {}) => {
             // No need to recheck if the selected node hasn't changed.
             return;
           }
-          toggleGutter(viewportElementHeight, contentElementHeight);
+          const gutterThresholdHeight = viewportElementHeight - gutterSize;
+          toggleGutter(contentElementHeight, gutterThresholdHeight);
         }
       };
     }

package/dist/esm/plugin.js

@@ -5,7 +5,6 @@ import { doc, paragraph, text } from '@atlaskit/adf-schema';
 import { keymap } from '@atlaskit/editor-common/keymaps';
 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';
@@ -14,7 +13,6 @@ import frozenEditor from './pm-plugins/frozen-editor';
 import inlineCursorTargetPlugin from './pm-plugins/inline-cursor-target';
 import newlinePreserveMarksPlugin from './pm-plugins/newline-preserve-marks';
 import scrollGutter, { getKeyboardHeight } from './pm-plugins/scroll-gutter';
-import deprecatedScrollGutter from './pm-plugins/scroll-gutter/plugin-deprecated';
 var basePlugin = function basePlugin(_ref) {
   var _api$featureFlags;
   var options = _ref.config,
@@ -98,7 +96,7 @@ var basePlugin = function basePlugin(_ref) {
         plugins.push({
           name: 'scrollGutterPlugin',
           plugin: function plugin() {
-            return getBooleanFF('platform.editor.scroll-gutter.reflow-optimisation') ? scrollGutter(options.allowScrollGutter) : deprecatedScrollGutter(options.allowScrollGutter);
+            return scrollGutter(options.allowScrollGutter);
           }
         });
       }

package/dist/esm/pm-plugins/scroll-gutter/index.js

@@ -210,7 +210,7 @@ export default (function () {
           gutter.addGutter(editorParentElement);
         }
       };
-      var toggleGutter = function toggleGutter(viewPortSize, contentSize) {
+      var toggleGutter = function toggleGutter(contentSize, threshold) {
         if (pluginOptions.persistScrollGutter) {
           if (!isEmptyDocument(view.state.doc)) {
             addAndObserveGutter();
@@ -223,8 +223,7 @@ export default (function () {
         // Add or remove the gutter based on whether the content is about to exceed the viewport height.
         // We do this to ensure there is sufficient white space below the last content node in order to
         // see any UI control elements which may sit beneath it.
-        var gutterThresholdHeight = viewPortSize - gutterSize;
-        if (contentSize >= gutterThresholdHeight) {
+        if (contentSize >= threshold) {
           addAndObserveGutter();
         } else {
           if (gutter.isMounted()) {
@@ -252,7 +251,7 @@ export default (function () {
         } finally {
           _iterator.f();
         }
-        toggleGutter(viewportElementHeight, contentElementHeight);
+        toggleGutter(contentElementHeight, viewportElementHeight);
       };
 
       // Subscribe to updates of the height of the viewport and content elements
@@ -282,7 +281,8 @@ export default (function () {
             // No need to recheck if the selected node hasn't changed.
             return;
           }
-          toggleGutter(viewportElementHeight, contentElementHeight);
+          var gutterThresholdHeight = viewportElementHeight - gutterSize;
+          toggleGutter(contentElementHeight, gutterThresholdHeight);
         }
       };
     })

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@atlaskit/editor-plugin-base",
-  "version": "0.3.2",
+  "version": "0.3.4",
   "description": "Base plugin for @atlaskit/editor-core",
   "author": "Atlassian Pty Ltd",
   "license": "Apache-2.0",
@@ -13,7 +13,7 @@
     "releaseModel": "continuous",
     "runReact18": false
   },
-  "repository": "https://bitbucket.org/atlassian/atlassian-frontend",
+  "repository": "https://bitbucket.org/atlassian/atlassian-frontend-mirror",
   "main": "dist/cjs/index.js",
   "module": "dist/esm/index.js",
   "module:es2019": "dist/es2019/index.js",
@@ -33,10 +33,9 @@
   },
   "dependencies": {
     "@atlaskit/adf-schema": "^35.3.0",
-    "@atlaskit/editor-common": "^76.35.0",
+    "@atlaskit/editor-common": "^77.0.0",
     "@atlaskit/editor-plugin-feature-flags": "^1.0.1",
     "@atlaskit/editor-prosemirror": "1.1.0",
-    "@atlaskit/platform-feature-flags": "^0.2.0",
     "@babel/runtime": "^7.0.0"
   },
   "devDependencies": {
@@ -44,12 +43,11 @@
     "@atlaskit/editor-plugin-content-insertion": "^0.1.0",
     "@atlaskit/editor-plugin-emoji": "^1.0.0",
     "@atlaskit/editor-plugin-guideline": "^0.5.0",
-    "@atlaskit/editor-plugin-selection": "^0.1.0",
-    "@atlaskit/editor-plugin-table": "^5.7.0",
+    "@atlaskit/editor-plugin-selection": "^0.2.0",
+    "@atlaskit/editor-plugin-table": "^7.0.0",
     "@atlaskit/editor-plugin-type-ahead": "^0.9.0",
     "@atlaskit/editor-plugin-width": "^0.2.0",
     "@atlaskit/util-data-test": "^17.8.0",
-    "@atlaskit/webdriver-runner": "*",
     "@atlassian/atlassian-frontend-prettier-config-1.0.0": "npm:@atlassian/atlassian-frontend-prettier-config@1.0.0",
     "@testing-library/react": "^12.1.5",
     "raf-stub": "^2.0.1"
@@ -87,9 +85,9 @@
     }
   },
   "prettier": "@atlassian/atlassian-frontend-prettier-config-1.0.0",
-  "platform-feature-flags": {
-    "platform.editor.scroll-gutter.reflow-optimisation": {
-      "type": "boolean"
+  "stricter": {
+    "no-unused-dependencies": {
+      "checkDevDependencies": true
     }
   }
 }

package/tsconfig.app.json

@@ -37,9 +37,6 @@
     },
     {
       "path": "../editor-plugin-feature-flags/tsconfig.app.json"
-    },
-    {
-      "path": "../../platform/feature-flags/tsconfig.app.json"
     }
   ]
 }

package/dist/cjs/pm-plugins/scroll-gutter/plugin-deprecated.js

@@ -1,262 +0,0 @@
-"use strict";
-
-Object.defineProperty(exports, "__esModule", {
-  value: true
-});
-exports.getKeyboardHeight = exports.default = void 0;
-var _safePlugin = require("@atlaskit/editor-common/safe-plugin");
-var _utils = require("@atlaskit/editor-common/utils");
-var _pluginKey = require("./plugin-key");
-var getKeyboardHeight = exports.getKeyboardHeight = function getKeyboardHeight(state) {
-  if (state) {
-    var scrollGutterPluginState = (0, _pluginKey.getScrollGutterPluginState)(state);
-    return scrollGutterPluginState ? scrollGutterPluginState.keyboardHeight : undefined;
-  }
-};
-var MIN_TAP_SIZE_IN_PX = 40;
-function supportsIntersectionObserver() {
-  if (typeof window !== 'undefined' && 'IntersectionObserver' in window && 'IntersectionObserverEntry' in window && 'intersectionRatio' in
-  // eslint-disable-next-line @typescript-eslint/no-explicit-any
-  window.IntersectionObserverEntry.prototype) {
-    return true;
-  }
-  return false;
-}
-function listenForGutterVisibilityChanges(scrollElement, gutterIsVisible) {
-  if (supportsIntersectionObserver()) {
-    var observer = new IntersectionObserver(function (entries, _) {
-      entries.forEach(function (entry) {
-        gutterIsVisible(entry.intersectionRatio > 0);
-      });
-    }, {
-      root: scrollElement,
-      rootMargin: '0px',
-      threshold: 0
-    });
-    return observer;
-  }
-  return undefined;
-}
-
-/**
- * Create a gutter element that can be added or removed from the DOM.
- */
-function createGutter(gutterSize) {
-  var gutter = document.createElement('div');
-  gutter.style.paddingBottom = "".concat(gutterSize, "px");
-  gutter.id = _utils.GUTTER_SELECTOR.substr(1);
-  var initialized = false;
-  var mounted = false;
-  var currentParent = null;
-  var observer;
-  var isVisible = false;
-  return {
-    addGutter: function addGutter(parent) {
-      if (parent) {
-        currentParent = parent;
-        parent.appendChild(gutter);
-        mounted = true;
-        if (observer) {
-          observer.observe(gutter);
-        }
-      }
-    },
-    removeGutter: function removeGutter() {
-      if (currentParent && mounted) {
-        mounted = false;
-        currentParent.removeChild(gutter);
-        if (observer) {
-          observer.unobserve(gutter);
-        }
-      }
-    },
-    element: function element() {
-      return gutter;
-    },
-    isMounted: function isMounted() {
-      return mounted;
-    },
-    visible: function visible() {
-      // If we know whether it's visible we can avoid expensive calculations
-      if (observer) {
-        return isVisible;
-      }
-      // Fallback for legacy browsers assumes it's visible (if mounted)
-      return mounted;
-    },
-    observe: function observe(scrollElement) {
-      if (!initialized) {
-        initialized = true;
-        observer = listenForGutterVisibilityChanges(scrollElement, function (visible) {
-          return isVisible = visible;
-        });
-      }
-    },
-    destroy: function destroy() {
-      if (observer) {
-        observer.disconnect();
-      }
-      observer = undefined;
-      this.removeGutter();
-      initialized = mounted = false;
-    }
-  };
-}
-
-/**
- * Get caret top position given the current selection,
- * use start container position as fallback
- */
-function getCaretTopPosition() {
-  var windowSelection = window.getSelection();
-  if (windowSelection && windowSelection.rangeCount > 0) {
-    var range = windowSelection.getRangeAt(0);
-    if (range) {
-      var clientRects = range.getClientRects();
-      // Return client rects
-      if (clientRects && clientRects.length > 0) {
-        return clientRects[0].top;
-      }
-
-      // Return container top
-      var container = range.startContainer;
-      if (container && container.getBoundingClientRect) {
-        return container.getBoundingClientRect().top;
-      }
-    }
-  }
-  return;
-}
-function scrollToGutterElement(scrollContainer, gutterElement, gutterSize) {
-  var viewportHeight = scrollContainer.offsetHeight;
-  var viewportOffsetY = scrollContainer.getBoundingClientRect().top;
-  var caretTopPosition = getCaretTopPosition();
-  if (!caretTopPosition) {
-    return false;
-  }
-  var caretTopFromContainer = caretTopPosition - viewportOffsetY;
-  var gutterThresholdTop = viewportHeight - gutterSize - MIN_TAP_SIZE_IN_PX * 2;
-  if (caretTopFromContainer < gutterThresholdTop) {
-    return false;
-  }
-
-  // Clamp the scroll position to above the scroll gutter element.
-  gutterElement.scrollIntoView(false);
-
-  // Mark scrolling as handled so that other plugin's don't override our position.
-  return true;
-}
-var _default = exports.default = function _default() {
-  var pluginOptions = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : {};
-  var getScrollElement = pluginOptions.getScrollElement,
-    allowCustomScrollHandler = pluginOptions.allowCustomScrollHandler,
-    _pluginOptions$gutter = pluginOptions.gutterSize,
-    gutterSize = _pluginOptions$gutter === void 0 ? _utils.GUTTER_SIZE_IN_PX : _pluginOptions$gutter;
-  if (!getScrollElement) {
-    return undefined;
-  }
-  var gutter = createGutter(gutterSize);
-  var scrollElement = null; // | undefined;
-
-  return new _safePlugin.SafePlugin({
-    key: _pluginKey.scrollGutterPluginKey,
-    state: {
-      init: function init() {
-        return {};
-      },
-      apply: function apply(tr, pluginState) {
-        if (tr.getMeta(_pluginKey.scrollGutterPluginKey)) {
-          return tr.getMeta(_pluginKey.scrollGutterPluginKey);
-        }
-        return pluginState;
-      }
-    },
-    props: {
-      // Determines the distance (in pixels) between the cursor and the end of the visible viewport at which point,
-      // when scrolling the cursor into view, scrolling takes place.
-      // Defaults to 0: https://prosemirror.net/docs/ref/#view.EditorProps.scrollThreshold
-      scrollThreshold: gutterSize / 2,
-      // Determines the extra space (in pixels) that is left above or below the cursor when it is scrolled into view.
-      // Defaults to 5: https://prosemirror.net/docs/ref/#view.EditorProps.scrollMargin
-      scrollMargin: gutterSize,
-      // Called when the view, after updating its state, tries to scroll the selection into view
-      // https://prosemirror.net/docs/ref/#view.EditorProps.handleScrollToSelection
-      handleScrollToSelection: function handleScrollToSelection() {
-        if (allowCustomScrollHandler === false) {
-          return false;
-        }
-        if (!gutter.isMounted() || !gutter.visible() || !scrollElement) {
-          // Avoid scrolling until applicable
-          return false;
-        }
-        return scrollToGutterElement(scrollElement, gutter.element(), gutterSize);
-      }
-    },
-    view: function (_view) {
-      function view(_x) {
-        return _view.apply(this, arguments);
-      }
-      view.toString = function () {
-        return _view.toString();
-      };
-      return view;
-    }(function (view) {
-      // Store references to avoid lookups on successive checks.
-      scrollElement = getScrollElement(view);
-      var editorElement = view.dom;
-      var editorParentElement = editorElement.parentElement;
-      return {
-        destroy: function destroy() {
-          // Remove if it's mounted
-          gutter.destroy();
-          scrollElement = editorParentElement = editorElement = null;
-        },
-        /**
-         * Toggle the Scroll Gutter Element
-         */
-        update: function update(view, prevState) {
-          var _getKeyboardHeight;
-          if (!scrollElement || !editorParentElement) {
-            return;
-          }
-          var state = view.state;
-          if (prevState.selection === state.selection) {
-            // No need to recheck if the selected node hasn't changed.
-            return;
-          }
-          var gutterMounted = gutter.isMounted();
-          var addAndObserveGutter = function addAndObserveGutter() {
-            if (!gutterMounted) {
-              gutter.observe(scrollElement);
-              gutter.addGutter(editorParentElement);
-            }
-          };
-          if (pluginOptions.persistScrollGutter) {
-            if (!(0, _utils.isEmptyDocument)(state.doc)) {
-              addAndObserveGutter();
-            } else {
-              gutter.removeGutter();
-            }
-            return;
-          }
-          // Determine whether we need to consider Keyboard Height
-          var keyboardHeight = (_getKeyboardHeight = getKeyboardHeight(state)) !== null && _getKeyboardHeight !== void 0 ? _getKeyboardHeight : 0;
-          var viewportHeight = scrollElement.offsetHeight - keyboardHeight;
-          var contentHeight = editorParentElement.offsetHeight - (gutterMounted ? gutterSize : 0);
-
-          // Add or remove the gutter based on whether the content is about to exceed the viewport height.
-          // We do this to ensure there is sufficient white space below the last content node in order to
-          // see any UI control elements which may sit beneath it.
-          var gutterThresholdHeight = viewportHeight - gutterSize;
-          if (contentHeight >= gutterThresholdHeight) {
-            addAndObserveGutter();
-          } else {
-            if (gutterMounted) {
-              gutter.removeGutter();
-            }
-          }
-        }
-      };
-    })
-  });
-};

package/dist/es2019/pm-plugins/scroll-gutter/plugin-deprecated.js

@@ -1,244 +0,0 @@
-import { SafePlugin } from '@atlaskit/editor-common/safe-plugin';
-import { GUTTER_SELECTOR, GUTTER_SIZE_IN_PX, isEmptyDocument } from '@atlaskit/editor-common/utils';
-import { getScrollGutterPluginState, scrollGutterPluginKey } from './plugin-key';
-export const getKeyboardHeight = state => {
-  if (state) {
-    const scrollGutterPluginState = getScrollGutterPluginState(state);
-    return scrollGutterPluginState ? scrollGutterPluginState.keyboardHeight : undefined;
-  }
-};
-const MIN_TAP_SIZE_IN_PX = 40;
-function supportsIntersectionObserver() {
-  if (typeof window !== 'undefined' && 'IntersectionObserver' in window && 'IntersectionObserverEntry' in window && 'intersectionRatio' in
-  // eslint-disable-next-line @typescript-eslint/no-explicit-any
-  window.IntersectionObserverEntry.prototype) {
-    return true;
-  }
-  return false;
-}
-function listenForGutterVisibilityChanges(scrollElement, gutterIsVisible) {
-  if (supportsIntersectionObserver()) {
-    const observer = new IntersectionObserver((entries, _) => {
-      entries.forEach(entry => {
-        gutterIsVisible(entry.intersectionRatio > 0);
-      });
-    }, {
-      root: scrollElement,
-      rootMargin: '0px',
-      threshold: 0
-    });
-    return observer;
-  }
-  return undefined;
-}
-
-/**
- * Create a gutter element that can be added or removed from the DOM.
- */
-function createGutter(gutterSize) {
-  const gutter = document.createElement('div');
-  gutter.style.paddingBottom = `${gutterSize}px`;
-  gutter.id = GUTTER_SELECTOR.substr(1);
-  let initialized = false;
-  let mounted = false;
-  let currentParent = null;
-  let observer;
-  let isVisible = false;
-  return {
-    addGutter(parent) {
-      if (parent) {
-        currentParent = parent;
-        parent.appendChild(gutter);
-        mounted = true;
-        if (observer) {
-          observer.observe(gutter);
-        }
-      }
-    },
-    removeGutter() {
-      if (currentParent && mounted) {
-        mounted = false;
-        currentParent.removeChild(gutter);
-        if (observer) {
-          observer.unobserve(gutter);
-        }
-      }
-    },
-    element() {
-      return gutter;
-    },
-    isMounted() {
-      return mounted;
-    },
-    visible() {
-      // If we know whether it's visible we can avoid expensive calculations
-      if (observer) {
-        return isVisible;
-      }
-      // Fallback for legacy browsers assumes it's visible (if mounted)
-      return mounted;
-    },
-    observe(scrollElement) {
-      if (!initialized) {
-        initialized = true;
-        observer = listenForGutterVisibilityChanges(scrollElement, visible => isVisible = visible);
-      }
-    },
-    destroy() {
-      if (observer) {
-        observer.disconnect();
-      }
-      observer = undefined;
-      this.removeGutter();
-      initialized = mounted = false;
-    }
-  };
-}
-
-/**
- * Get caret top position given the current selection,
- * use start container position as fallback
- */
-function getCaretTopPosition() {
-  const windowSelection = window.getSelection();
-  if (windowSelection && windowSelection.rangeCount > 0) {
-    const range = windowSelection.getRangeAt(0);
-    if (range) {
-      const clientRects = range.getClientRects();
-      // Return client rects
-      if (clientRects && clientRects.length > 0) {
-        return clientRects[0].top;
-      }
-
-      // Return container top
-      const container = range.startContainer;
-      if (container && container.getBoundingClientRect) {
-        return container.getBoundingClientRect().top;
-      }
-    }
-  }
-  return;
-}
-function scrollToGutterElement(scrollContainer, gutterElement, gutterSize) {
-  const viewportHeight = scrollContainer.offsetHeight;
-  const viewportOffsetY = scrollContainer.getBoundingClientRect().top;
-  const caretTopPosition = getCaretTopPosition();
-  if (!caretTopPosition) {
-    return false;
-  }
-  const caretTopFromContainer = caretTopPosition - viewportOffsetY;
-  const gutterThresholdTop = viewportHeight - gutterSize - MIN_TAP_SIZE_IN_PX * 2;
-  if (caretTopFromContainer < gutterThresholdTop) {
-    return false;
-  }
-
-  // Clamp the scroll position to above the scroll gutter element.
-  gutterElement.scrollIntoView(false);
-
-  // Mark scrolling as handled so that other plugin's don't override our position.
-  return true;
-}
-export default ((pluginOptions = {}) => {
-  const {
-    getScrollElement,
-    allowCustomScrollHandler,
-    gutterSize = GUTTER_SIZE_IN_PX
-  } = pluginOptions;
-  if (!getScrollElement) {
-    return undefined;
-  }
-  const gutter = createGutter(gutterSize);
-  let scrollElement = null; // | undefined;
-
-  return new SafePlugin({
-    key: scrollGutterPluginKey,
-    state: {
-      init: () => ({}),
-      apply: (tr, pluginState) => {
-        if (tr.getMeta(scrollGutterPluginKey)) {
-          return tr.getMeta(scrollGutterPluginKey);
-        }
-        return pluginState;
-      }
-    },
-    props: {
-      // Determines the distance (in pixels) between the cursor and the end of the visible viewport at which point,
-      // when scrolling the cursor into view, scrolling takes place.
-      // Defaults to 0: https://prosemirror.net/docs/ref/#view.EditorProps.scrollThreshold
-      scrollThreshold: gutterSize / 2,
-      // Determines the extra space (in pixels) that is left above or below the cursor when it is scrolled into view.
-      // Defaults to 5: https://prosemirror.net/docs/ref/#view.EditorProps.scrollMargin
-      scrollMargin: gutterSize,
-      // Called when the view, after updating its state, tries to scroll the selection into view
-      // https://prosemirror.net/docs/ref/#view.EditorProps.handleScrollToSelection
-      handleScrollToSelection: () => {
-        if (allowCustomScrollHandler === false) {
-          return false;
-        }
-        if (!gutter.isMounted() || !gutter.visible() || !scrollElement) {
-          // Avoid scrolling until applicable
-          return false;
-        }
-        return scrollToGutterElement(scrollElement, gutter.element(), gutterSize);
-      }
-    },
-    view(view) {
-      // Store references to avoid lookups on successive checks.
-      scrollElement = getScrollElement(view);
-      let editorElement = view.dom;
-      let editorParentElement = editorElement.parentElement;
-      return {
-        destroy() {
-          // Remove if it's mounted
-          gutter.destroy();
-          scrollElement = editorParentElement = editorElement = null;
-        },
-        /**
-         * Toggle the Scroll Gutter Element
-         */
-        update(view, prevState) {
-          var _getKeyboardHeight;
-          if (!scrollElement || !editorParentElement) {
-            return;
-          }
-          const state = view.state;
-          if (prevState.selection === state.selection) {
-            // No need to recheck if the selected node hasn't changed.
-            return;
-          }
-          const gutterMounted = gutter.isMounted();
-          const addAndObserveGutter = () => {
-            if (!gutterMounted) {
-              gutter.observe(scrollElement);
-              gutter.addGutter(editorParentElement);
-            }
-          };
-          if (pluginOptions.persistScrollGutter) {
-            if (!isEmptyDocument(state.doc)) {
-              addAndObserveGutter();
-            } else {
-              gutter.removeGutter();
-            }
-            return;
-          }
-          // Determine whether we need to consider Keyboard Height
-          const keyboardHeight = (_getKeyboardHeight = getKeyboardHeight(state)) !== null && _getKeyboardHeight !== void 0 ? _getKeyboardHeight : 0;
-          const viewportHeight = scrollElement.offsetHeight - keyboardHeight;
-          const contentHeight = editorParentElement.offsetHeight - (gutterMounted ? gutterSize : 0);
-
-          // Add or remove the gutter based on whether the content is about to exceed the viewport height.
-          // We do this to ensure there is sufficient white space below the last content node in order to
-          // see any UI control elements which may sit beneath it.
-          const gutterThresholdHeight = viewportHeight - gutterSize;
-          if (contentHeight >= gutterThresholdHeight) {
-            addAndObserveGutter();
-          } else {
-            if (gutterMounted) {
-              gutter.removeGutter();
-            }
-          }
-        }
-      };
-    }
-  });
-});

package/dist/esm/pm-plugins/scroll-gutter/plugin-deprecated.js

@@ -1,256 +0,0 @@
-import { SafePlugin } from '@atlaskit/editor-common/safe-plugin';
-import { GUTTER_SELECTOR, GUTTER_SIZE_IN_PX, isEmptyDocument } from '@atlaskit/editor-common/utils';
-import { getScrollGutterPluginState, scrollGutterPluginKey } from './plugin-key';
-export var getKeyboardHeight = function getKeyboardHeight(state) {
-  if (state) {
-    var scrollGutterPluginState = getScrollGutterPluginState(state);
-    return scrollGutterPluginState ? scrollGutterPluginState.keyboardHeight : undefined;
-  }
-};
-var MIN_TAP_SIZE_IN_PX = 40;
-function supportsIntersectionObserver() {
-  if (typeof window !== 'undefined' && 'IntersectionObserver' in window && 'IntersectionObserverEntry' in window && 'intersectionRatio' in
-  // eslint-disable-next-line @typescript-eslint/no-explicit-any
-  window.IntersectionObserverEntry.prototype) {
-    return true;
-  }
-  return false;
-}
-function listenForGutterVisibilityChanges(scrollElement, gutterIsVisible) {
-  if (supportsIntersectionObserver()) {
-    var observer = new IntersectionObserver(function (entries, _) {
-      entries.forEach(function (entry) {
-        gutterIsVisible(entry.intersectionRatio > 0);
-      });
-    }, {
-      root: scrollElement,
-      rootMargin: '0px',
-      threshold: 0
-    });
-    return observer;
-  }
-  return undefined;
-}
-
-/**
- * Create a gutter element that can be added or removed from the DOM.
- */
-function createGutter(gutterSize) {
-  var gutter = document.createElement('div');
-  gutter.style.paddingBottom = "".concat(gutterSize, "px");
-  gutter.id = GUTTER_SELECTOR.substr(1);
-  var initialized = false;
-  var mounted = false;
-  var currentParent = null;
-  var observer;
-  var isVisible = false;
-  return {
-    addGutter: function addGutter(parent) {
-      if (parent) {
-        currentParent = parent;
-        parent.appendChild(gutter);
-        mounted = true;
-        if (observer) {
-          observer.observe(gutter);
-        }
-      }
-    },
-    removeGutter: function removeGutter() {
-      if (currentParent && mounted) {
-        mounted = false;
-        currentParent.removeChild(gutter);
-        if (observer) {
-          observer.unobserve(gutter);
-        }
-      }
-    },
-    element: function element() {
-      return gutter;
-    },
-    isMounted: function isMounted() {
-      return mounted;
-    },
-    visible: function visible() {
-      // If we know whether it's visible we can avoid expensive calculations
-      if (observer) {
-        return isVisible;
-      }
-      // Fallback for legacy browsers assumes it's visible (if mounted)
-      return mounted;
-    },
-    observe: function observe(scrollElement) {
-      if (!initialized) {
-        initialized = true;
-        observer = listenForGutterVisibilityChanges(scrollElement, function (visible) {
-          return isVisible = visible;
-        });
-      }
-    },
-    destroy: function destroy() {
-      if (observer) {
-        observer.disconnect();
-      }
-      observer = undefined;
-      this.removeGutter();
-      initialized = mounted = false;
-    }
-  };
-}
-
-/**
- * Get caret top position given the current selection,
- * use start container position as fallback
- */
-function getCaretTopPosition() {
-  var windowSelection = window.getSelection();
-  if (windowSelection && windowSelection.rangeCount > 0) {
-    var range = windowSelection.getRangeAt(0);
-    if (range) {
-      var clientRects = range.getClientRects();
-      // Return client rects
-      if (clientRects && clientRects.length > 0) {
-        return clientRects[0].top;
-      }
-
-      // Return container top
-      var container = range.startContainer;
-      if (container && container.getBoundingClientRect) {
-        return container.getBoundingClientRect().top;
-      }
-    }
-  }
-  return;
-}
-function scrollToGutterElement(scrollContainer, gutterElement, gutterSize) {
-  var viewportHeight = scrollContainer.offsetHeight;
-  var viewportOffsetY = scrollContainer.getBoundingClientRect().top;
-  var caretTopPosition = getCaretTopPosition();
-  if (!caretTopPosition) {
-    return false;
-  }
-  var caretTopFromContainer = caretTopPosition - viewportOffsetY;
-  var gutterThresholdTop = viewportHeight - gutterSize - MIN_TAP_SIZE_IN_PX * 2;
-  if (caretTopFromContainer < gutterThresholdTop) {
-    return false;
-  }
-
-  // Clamp the scroll position to above the scroll gutter element.
-  gutterElement.scrollIntoView(false);
-
-  // Mark scrolling as handled so that other plugin's don't override our position.
-  return true;
-}
-export default (function () {
-  var pluginOptions = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : {};
-  var getScrollElement = pluginOptions.getScrollElement,
-    allowCustomScrollHandler = pluginOptions.allowCustomScrollHandler,
-    _pluginOptions$gutter = pluginOptions.gutterSize,
-    gutterSize = _pluginOptions$gutter === void 0 ? GUTTER_SIZE_IN_PX : _pluginOptions$gutter;
-  if (!getScrollElement) {
-    return undefined;
-  }
-  var gutter = createGutter(gutterSize);
-  var scrollElement = null; // | undefined;
-
-  return new SafePlugin({
-    key: scrollGutterPluginKey,
-    state: {
-      init: function init() {
-        return {};
-      },
-      apply: function apply(tr, pluginState) {
-        if (tr.getMeta(scrollGutterPluginKey)) {
-          return tr.getMeta(scrollGutterPluginKey);
-        }
-        return pluginState;
-      }
-    },
-    props: {
-      // Determines the distance (in pixels) between the cursor and the end of the visible viewport at which point,
-      // when scrolling the cursor into view, scrolling takes place.
-      // Defaults to 0: https://prosemirror.net/docs/ref/#view.EditorProps.scrollThreshold
-      scrollThreshold: gutterSize / 2,
-      // Determines the extra space (in pixels) that is left above or below the cursor when it is scrolled into view.
-      // Defaults to 5: https://prosemirror.net/docs/ref/#view.EditorProps.scrollMargin
-      scrollMargin: gutterSize,
-      // Called when the view, after updating its state, tries to scroll the selection into view
-      // https://prosemirror.net/docs/ref/#view.EditorProps.handleScrollToSelection
-      handleScrollToSelection: function handleScrollToSelection() {
-        if (allowCustomScrollHandler === false) {
-          return false;
-        }
-        if (!gutter.isMounted() || !gutter.visible() || !scrollElement) {
-          // Avoid scrolling until applicable
-          return false;
-        }
-        return scrollToGutterElement(scrollElement, gutter.element(), gutterSize);
-      }
-    },
-    view: function (_view) {
-      function view(_x) {
-        return _view.apply(this, arguments);
-      }
-      view.toString = function () {
-        return _view.toString();
-      };
-      return view;
-    }(function (view) {
-      // Store references to avoid lookups on successive checks.
-      scrollElement = getScrollElement(view);
-      var editorElement = view.dom;
-      var editorParentElement = editorElement.parentElement;
-      return {
-        destroy: function destroy() {
-          // Remove if it's mounted
-          gutter.destroy();
-          scrollElement = editorParentElement = editorElement = null;
-        },
-        /**
-         * Toggle the Scroll Gutter Element
-         */
-        update: function update(view, prevState) {
-          var _getKeyboardHeight;
-          if (!scrollElement || !editorParentElement) {
-            return;
-          }
-          var state = view.state;
-          if (prevState.selection === state.selection) {
-            // No need to recheck if the selected node hasn't changed.
-            return;
-          }
-          var gutterMounted = gutter.isMounted();
-          var addAndObserveGutter = function addAndObserveGutter() {
-            if (!gutterMounted) {
-              gutter.observe(scrollElement);
-              gutter.addGutter(editorParentElement);
-            }
-          };
-          if (pluginOptions.persistScrollGutter) {
-            if (!isEmptyDocument(state.doc)) {
-              addAndObserveGutter();
-            } else {
-              gutter.removeGutter();
-            }
-            return;
-          }
-          // Determine whether we need to consider Keyboard Height
-          var keyboardHeight = (_getKeyboardHeight = getKeyboardHeight(state)) !== null && _getKeyboardHeight !== void 0 ? _getKeyboardHeight : 0;
-          var viewportHeight = scrollElement.offsetHeight - keyboardHeight;
-          var contentHeight = editorParentElement.offsetHeight - (gutterMounted ? gutterSize : 0);
-
-          // Add or remove the gutter based on whether the content is about to exceed the viewport height.
-          // We do this to ensure there is sufficient white space below the last content node in order to
-          // see any UI control elements which may sit beneath it.
-          var gutterThresholdHeight = viewportHeight - gutterSize;
-          if (contentHeight >= gutterThresholdHeight) {
-            addAndObserveGutter();
-          } else {
-            if (gutterMounted) {
-              gutter.removeGutter();
-            }
-          }
-        }
-      };
-    })
-  });
-});

package/dist/types/pm-plugins/scroll-gutter/plugin-deprecated.d.ts

@@ -1,22 +0,0 @@
-import { SafePlugin } from '@atlaskit/editor-common/safe-plugin';
-import type { EditorState } from '@atlaskit/editor-prosemirror/state';
-import type { EditorView } from '@atlaskit/editor-prosemirror/view';
-export declare const getKeyboardHeight: (state?: EditorState) => number | undefined;
-export type ScrollGutterPluginOptions = {
-    /** Element the page uses for scrolling */
-    getScrollElement?: (view: EditorView) => HTMLElement | null;
-    /**
-     * Whether to allow custom functionality to scroll to gutter element in
-     * plugin's handleScrollToSelection function
-     * Default is true
-     */
-    allowCustomScrollHandler?: boolean;
-    /**
-     * Persist scroll gutter when the mobile appearance is COMPACT
-     * Default is false
-     */
-    persistScrollGutter?: boolean;
-    gutterSize?: number;
-};
-declare const _default: (pluginOptions?: ScrollGutterPluginOptions) => SafePlugin<{}> | undefined;
-export default _default;

package/dist/types-ts4.5/pm-plugins/scroll-gutter/plugin-deprecated.d.ts

@@ -1,22 +0,0 @@
-import { SafePlugin } from '@atlaskit/editor-common/safe-plugin';
-import type { EditorState } from '@atlaskit/editor-prosemirror/state';
-import type { EditorView } from '@atlaskit/editor-prosemirror/view';
-export declare const getKeyboardHeight: (state?: EditorState) => number | undefined;
-export type ScrollGutterPluginOptions = {
-    /** Element the page uses for scrolling */
-    getScrollElement?: (view: EditorView) => HTMLElement | null;
-    /**
-     * Whether to allow custom functionality to scroll to gutter element in
-     * plugin's handleScrollToSelection function
-     * Default is true
-     */
-    allowCustomScrollHandler?: boolean;
-    /**
-     * Persist scroll gutter when the mobile appearance is COMPACT
-     * Default is false
-     */
-    persistScrollGutter?: boolean;
-    gutterSize?: number;
-};
-declare const _default: (pluginOptions?: ScrollGutterPluginOptions) => SafePlugin<{}> | undefined;
-export default _default;