@atlaskit/editor-plugin-base 0.3.3 → 0.3.5

package/dist/es2019/pm-plugins/frozen-editor.js

@@ -5,7 +5,6 @@ import { countNodes, getAnalyticsEventSeverity, isPerformanceAPIAvailable, isPer
 import { PluginKey } from '@atlaskit/editor-prosemirror/state';
 import { setInteractionType } from '../utils/frozen-editor';
 import InputLatencyTracker from '../utils/input-latency-tracking';
-import { getContextIdentifier } from './context-identifier';
 export const frozenEditorPluginKey = new PluginKey('frozenEditor');
 const DEFAULT_KEYSTROKE_SAMPLING_LIMIT = 100;
 const DEFAULT_SLOW_THRESHOLD = 300;
@@ -15,8 +14,8 @@ export const DEGRADED_SEVERITY_THRESHOLD = 3000;
 const DEFAULT_TRACK_SEVERITY_ENABLED = false;
 export const DEFAULT_TRACK_SEVERITY_THRESHOLD_NORMAL = 100;
 export const DEFAULT_TRACK_SEVERITY_THRESHOLD_DEGRADED = 500;
-const dispatchLongTaskEvent = (dispatchAnalyticsEvent, view, time, getNodeCount, interactionType, severity) => {
-  var _getContextIdentifier;
+const dispatchLongTaskEvent = contextIdentifierPlugin => (dispatchAnalyticsEvent, view, time, getNodeCount, interactionType, severity) => {
+  var _contextIdentifierPlu, _contextIdentifierPlu2;
   const {
     state
   } = view;
@@ -25,7 +24,7 @@ const dispatchLongTaskEvent = (dispatchAnalyticsEvent, view, time, getNodeCount,
     action: ACTION.BROWSER_FREEZE,
     actionSubject: ACTION_SUBJECT.EDITOR,
     attributes: {
-      objectId: (_getContextIdentifier = getContextIdentifier(state)) === null || _getContextIdentifier === void 0 ? void 0 : _getContextIdentifier.objectId,
+      objectId: contextIdentifierPlugin === null || contextIdentifierPlugin === void 0 ? void 0 : (_contextIdentifierPlu = contextIdentifierPlugin.sharedState.currentState()) === null || _contextIdentifierPlu === void 0 ? void 0 : (_contextIdentifierPlu2 = _contextIdentifierPlu.contextIdentifierProvider) === null || _contextIdentifierPlu2 === void 0 ? void 0 : _contextIdentifierPlu2.objectId,
       freezeTime: time,
       nodeSize: state.doc.nodeSize,
       ...nodesCount,
@@ -35,7 +34,7 @@ const dispatchLongTaskEvent = (dispatchAnalyticsEvent, view, time, getNodeCount,
     eventType: EVENT_TYPE.OPERATIONAL
   });
 };
-export default ((dispatchAnalyticsEvent, inputTracking, browserFreezeTracking, ufo) => {
+export default (contextIdentifierPlugin => (dispatchAnalyticsEvent, inputTracking, browserFreezeTracking, ufo) => {
   let interactionType;
   let inputLatencyTracker = null;
   let inputLatencySingleKeyTracker = null;
@@ -64,7 +63,7 @@ export default ((dispatchAnalyticsEvent, inputTracking, browserFreezeTracking, u
   const severityThresholdNormal = (inputTracking === null || inputTracking === void 0 ? void 0 : inputTracking.severityNormalThreshold) || DEFAULT_TRACK_SEVERITY_THRESHOLD_NORMAL;
   const severityThresholdDegraded = (inputTracking === null || inputTracking === void 0 ? void 0 : inputTracking.severityDegradedThreshold) || DEFAULT_TRACK_SEVERITY_THRESHOLD_DEGRADED;
   const createDispatchSample = (action, view) => (time, severity) => {
-    var _getContextIdentifier2;
+    var _contextIdentifierPlu3, _contextIdentifierPlu4;
     const {
       state
     } = view;
@@ -76,7 +75,7 @@ export default ((dispatchAnalyticsEvent, inputTracking, browserFreezeTracking, u
         time,
         nodeSize: state.doc.nodeSize,
         ...nodesCount,
-        objectId: (_getContextIdentifier2 = getContextIdentifier(state)) === null || _getContextIdentifier2 === void 0 ? void 0 : _getContextIdentifier2.objectId,
+        objectId: contextIdentifierPlugin === null || contextIdentifierPlugin === void 0 ? void 0 : (_contextIdentifierPlu3 = contextIdentifierPlugin.sharedState.currentState()) === null || _contextIdentifierPlu3 === void 0 ? void 0 : (_contextIdentifierPlu4 = _contextIdentifierPlu3.contextIdentifierProvider) === null || _contextIdentifierPlu4 === void 0 ? void 0 : _contextIdentifierPlu4.objectId,
         severity: shouldTrackSeverity ? severity : undefined
       },
       eventType: EVENT_TYPE.OPERATIONAL
@@ -88,7 +87,7 @@ export default ((dispatchAnalyticsEvent, inputTracking, browserFreezeTracking, u
     median,
     sampleSize
   }, severity) => {
-    var _getContextIdentifier3;
+    var _contextIdentifierPlu5, _contextIdentifierPlu6;
     const {
       state
     } = view;
@@ -103,7 +102,7 @@ export default ((dispatchAnalyticsEvent, inputTracking, browserFreezeTracking, u
         ...nodeCount,
         nodeSize: state.doc.nodeSize,
         severity: shouldTrackSeverity ? severity : undefined,
-        objectId: (_getContextIdentifier3 = getContextIdentifier(state)) === null || _getContextIdentifier3 === void 0 ? void 0 : _getContextIdentifier3.objectId
+        objectId: contextIdentifierPlugin === null || contextIdentifierPlugin === void 0 ? void 0 : (_contextIdentifierPlu5 = contextIdentifierPlugin.sharedState.currentState()) === null || _contextIdentifierPlu5 === void 0 ? void 0 : (_contextIdentifierPlu6 = _contextIdentifierPlu5.contextIdentifierProvider) === null || _contextIdentifierPlu6 === void 0 ? void 0 : _contextIdentifierPlu6.objectId
       },
       eventType: EVENT_TYPE.OPERATIONAL
     };
@@ -167,7 +166,7 @@ export default ((dispatchAnalyticsEvent, inputTracking, browserFreezeTracking, u
             isSlow,
             severity
           }) => {
-            var _getContextIdentifier4;
+            var _contextIdentifierPlu7, _contextIdentifierPlu8;
             const {
               state
             } = view;
@@ -180,7 +179,7 @@ export default ((dispatchAnalyticsEvent, inputTracking, browserFreezeTracking, u
             experienceStore === null || experienceStore === void 0 ? void 0 : experienceStore.success(EditorExperience.typing, {
               nodeSize: state.doc.nodeSize,
               ...nodesCount,
-              objectId: (_getContextIdentifier4 = getContextIdentifier(state)) === null || _getContextIdentifier4 === void 0 ? void 0 : _getContextIdentifier4.objectId,
+              objectId: contextIdentifierPlugin === null || contextIdentifierPlugin === void 0 ? void 0 : (_contextIdentifierPlu7 = contextIdentifierPlugin.sharedState.currentState()) === null || _contextIdentifierPlu7 === void 0 ? void 0 : (_contextIdentifierPlu8 = _contextIdentifierPlu7.contextIdentifierProvider) === null || _contextIdentifierPlu8 === void 0 ? void 0 : _contextIdentifierPlu8.objectId,
               time,
               severity: shouldTrackSeverity ? severity : undefined
             });
@@ -188,7 +187,7 @@ export default ((dispatchAnalyticsEvent, inputTracking, browserFreezeTracking, u
           dispatchSample: createDispatchSample(ACTION.INPUT_PERF_SAMPLING, view),
           dispatchAverage: createDispatchAverage(ACTION.INPUT_PERF_SAMPLING_AVG, view),
           onSlowInput: time => {
-            var _getContextIdentifier5;
+            var _contextIdentifierPlu9, _contextIdentifierPlu10;
             const {
               state
             } = view;
@@ -200,7 +199,7 @@ export default ((dispatchAnalyticsEvent, inputTracking, browserFreezeTracking, u
                 time,
                 nodeSize: state.doc.nodeSize,
                 ...nodesCount,
-                objectId: (_getContextIdentifier5 = getContextIdentifier(state)) === null || _getContextIdentifier5 === void 0 ? void 0 : _getContextIdentifier5.objectId
+                objectId: contextIdentifierPlugin === null || contextIdentifierPlugin === void 0 ? void 0 : (_contextIdentifierPlu9 = contextIdentifierPlugin.sharedState.currentState()) === null || _contextIdentifierPlu9 === void 0 ? void 0 : (_contextIdentifierPlu10 = _contextIdentifierPlu9.contextIdentifierProvider) === null || _contextIdentifierPlu10 === void 0 ? void 0 : _contextIdentifierPlu10.objectId
               },
               eventType: EVENT_TYPE.OPERATIONAL
             });
@@ -236,7 +235,7 @@ export default ((dispatchAnalyticsEvent, inputTracking, browserFreezeTracking, u
               duration
             } = perfEntries[i];
             if (duration > freezeThreshold) {
-              dispatchLongTaskEvent(dispatchAnalyticsEvent, view, duration, getNodeCount, browserFreezeTracking !== null && browserFreezeTracking !== void 0 && browserFreezeTracking.trackInteractionType ? interactionType : undefined, browserFreezeTracking !== null && browserFreezeTracking !== void 0 && browserFreezeTracking.trackSeverity ? getAnalyticsEventSeverity(duration, browserFreezeTracking.severityNormalThreshold || NORMAL_SEVERITY_THRESHOLD, browserFreezeTracking.severityDegradedThreshold || DEGRADED_SEVERITY_THRESHOLD) : undefined);
+              dispatchLongTaskEvent(contextIdentifierPlugin)(dispatchAnalyticsEvent, view, duration, getNodeCount, browserFreezeTracking !== null && browserFreezeTracking !== void 0 && browserFreezeTracking.trackInteractionType ? interactionType : undefined, browserFreezeTracking !== null && browserFreezeTracking !== void 0 && browserFreezeTracking.trackSeverity ? getAnalyticsEventSeverity(duration, browserFreezeTracking.severityNormalThreshold || NORMAL_SEVERITY_THRESHOLD, browserFreezeTracking.severityDegradedThreshold || DEGRADED_SEVERITY_THRESHOLD) : undefined);
             }
           }
         });

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,16 +5,13 @@ 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';
 import filterStepsPlugin from './pm-plugins/filter-steps';
 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,
@@ -24,7 +21,6 @@ var basePlugin = function basePlugin(_ref) {
     name: 'base',
     getSharedState: function getSharedState(editorState) {
       return {
-        contextIdentifier: getContextIdentifier(editorState),
         keyboardHeight: getKeyboardHeight(editorState)
       };
     },
@@ -65,7 +61,7 @@ var basePlugin = function basePlugin(_ref) {
         plugin: function plugin(_ref3) {
           var _options$inputTrackin;
           var dispatchAnalyticsEvent = _ref3.dispatchAnalyticsEvent;
-          return options !== null && options !== void 0 && (_options$inputTrackin = options.inputTracking) !== null && _options$inputTrackin !== void 0 && _options$inputTrackin.enabled || options !== null && options !== void 0 && options.ufo ? frozenEditor(dispatchAnalyticsEvent, options.inputTracking, options.browserFreezeTracking, options.ufo) : undefined;
+          return options !== null && options !== void 0 && (_options$inputTrackin = options.inputTracking) !== null && _options$inputTrackin !== void 0 && _options$inputTrackin.enabled || options !== null && options !== void 0 && options.ufo ? frozenEditor(api === null || api === void 0 ? void 0 : api.contextIdentifier)(dispatchAnalyticsEvent, options.inputTracking, options.browserFreezeTracking, options.ufo) : undefined;
         }
       }, {
         name: 'history',
@@ -86,19 +82,12 @@ var basePlugin = function basePlugin(_ref) {
             }
           }));
         }
-      }, {
-        name: 'contextIdentifier',
-        plugin: function plugin(_ref4) {
-          var dispatch = _ref4.dispatch,
-            providerFactory = _ref4.providerFactory;
-          return contextIdentifierPlugin(dispatch, providerFactory);
-        }
       });
       if (options && options.allowScrollGutter) {
         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);
           }
         });
       }