@atlaskit/editor-plugin-autocomplete 2.4.0 → 2.5.1

package/dist/esm/pm-plugins/autocomplete-plugin.js

@@ -2,16 +2,20 @@ 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 { ACTION, ACTION_SUBJECT, EVENT_TYPE } from '@atlaskit/editor-common/analytics';
+import { logException } from '@atlaskit/editor-common/monitoring';
 import { SafePlugin } from '@atlaskit/editor-common/safe-plugin';
 import { keydownHandler } from '@atlaskit/editor-prosemirror/keymap';
 import { PluginKey } from '@atlaskit/editor-prosemirror/state';
 import { DecorationSet } from '@atlaskit/editor-prosemirror/view';
 import { createGhostTextDecorationSet } from './ghost-text-decoration';
+import { createLocalSlowLaneClient } from './local-slow-lane-client';
 import { createSlowLaneClient, setDefaultSlowLaneClient, isWordBoundary } from './slow-lane-client';
 import { predict, loadDefaultVocabulary, loadVectorsAsync, incrementSessionFreq, ingestDocumentPage } from './text-predictor';
-var SLOW_LANE_ENDPOINT = '/gateway/api/v1/autocomplete/typeahead-encodings';
 export var autocompletePluginKey = new PluginKey('autocomplete');
 var DEBOUNCE_MS = 150;
+var hasDestroy = function hasDestroy(client) {
+  return 'destroy' in client && typeof client.destroy === 'function';
+};
 var createInitialState = function createInitialState() {
   return {
     ghostText: '',
@@ -64,15 +68,21 @@ var setAutocompleteMeta = function setAutocompleteMeta(tr, meta) {
  */
 var lastShownGhostText = '';
 var showGhostText = function showGhostText(view, text, position) {
-  var state = view.state,
-    dispatch = view.dispatch;
-  var decorationSet = createGhostTextDecorationSet(state, position, text);
-  var tr = setAutocompleteMeta(state.tr, {
-    ghostText: text,
-    ghostPosition: position,
-    decorationSet: decorationSet
-  });
-  dispatch(tr);
+  try {
+    var state = view.state,
+      dispatch = view.dispatch;
+    var decorationSet = createGhostTextDecorationSet(state, position, text);
+    var tr = setAutocompleteMeta(state.tr, {
+      ghostText: text,
+      ghostPosition: position,
+      decorationSet: decorationSet
+    });
+    dispatch(tr);
+  } catch (error) {
+    logException(error, {
+      location: 'editor-plugin-autocomplete/showGhostText'
+    });
+  }
 };
 
 /**
@@ -84,12 +94,19 @@ var clearGhostText = function clearGhostText(state, dispatch) {
     return false;
   }
   if (dispatch) {
-    var tr = setAutocompleteMeta(state.tr, {
-      ghostText: '',
-      ghostPosition: -1,
-      decorationSet: DecorationSet.empty
-    });
-    dispatch(tr);
+    try {
+      var tr = setAutocompleteMeta(state.tr, {
+        ghostText: '',
+        ghostPosition: -1,
+        decorationSet: DecorationSet.empty
+      });
+      dispatch(tr);
+    } catch (error) {
+      logException(error, {
+        location: 'editor-plugin-autocomplete/clearGhostText'
+      });
+      return false;
+    }
   }
   return true;
 };
@@ -103,15 +120,22 @@ var acceptGhostText = function acceptGhostText(state, dispatch) {
     return false;
   }
   if (dispatch) {
-    var ghostText = pluginState.ghostText,
-      ghostPosition = pluginState.ghostPosition;
-    var tr = state.tr.insertText(ghostText, ghostPosition);
-    tr = setAutocompleteMeta(tr, {
-      ghostText: '',
-      ghostPosition: -1,
-      decorationSet: DecorationSet.empty
-    });
-    dispatch(tr);
+    try {
+      var ghostText = pluginState.ghostText,
+        ghostPosition = pluginState.ghostPosition;
+      var tr = state.tr.insertText(ghostText, ghostPosition);
+      tr = setAutocompleteMeta(tr, {
+        ghostText: '',
+        ghostPosition: -1,
+        decorationSet: DecorationSet.empty
+      });
+      dispatch(tr);
+    } catch (error) {
+      logException(error, {
+        location: 'editor-plugin-autocomplete/acceptGhostText'
+      });
+      return false;
+    }
   }
   return true;
 };
@@ -170,12 +194,23 @@ export var createAutocompletePlugin = function createAutocompletePlugin(options,
   var dismissedContext = null;
   var lastSuggestionTypedLength = 0;
   var lastSuggestionLength = 0;
-  var fireSuggestionInsertedAnalytics = function fireSuggestionInsertedAnalytics(ghostText) {
+  var fireSuggestionDismissedAnalytics = function fireSuggestionDismissedAnalytics(reason) {
     var _api$analytics;
+    api === null || api === void 0 || (_api$analytics = api.analytics) === null || _api$analytics === void 0 || _api$analytics.actions.fireAnalyticsEvent({
+      action: ACTION.SUGGESTION_DISMISSED,
+      actionSubject: ACTION_SUBJECT.CONTEXTUAL_TYPEAHEAD,
+      eventType: EVENT_TYPE.TRACK,
+      attributes: {
+        reason: reason
+      }
+    });
+  };
+  var fireSuggestionInsertedAnalytics = function fireSuggestionInsertedAnalytics(ghostText) {
+    var _api$analytics2;
     var typedLength = lastSuggestionTypedLength;
     var suggestionLength = lastSuggestionLength || typedLength + ghostText.length;
     var kssDelta = suggestionLength - typedLength;
-    api === null || api === void 0 || (_api$analytics = api.analytics) === null || _api$analytics === void 0 || _api$analytics.actions.fireAnalyticsEvent({
+    api === null || api === void 0 || (_api$analytics2 = api.analytics) === null || _api$analytics2 === void 0 || _api$analytics2.actions.fireAnalyticsEvent({
       action: ACTION.SUGGESTION_INSERTED,
       actionSubject: ACTION_SUBJECT.CONTEXTUAL_TYPEAHEAD,
       eventType: EVENT_TYPE.TRACK,
@@ -186,9 +221,11 @@ export var createAutocompletePlugin = function createAutocompletePlugin(options,
       }
     });
   };
-  var slowLaneClient = createSlowLaneClient({
+  var slowLaneClient = options !== null && options !== void 0 && options.useLocalModel ? createLocalSlowLaneClient({
+    debounceMs: 300
+  }) : createSlowLaneClient({
     baseUrl: '',
-    endpoint: SLOW_LANE_ENDPOINT
+    debounceMs: 300
   });
   setDefaultSlowLaneClient(slowLaneClient);
 
@@ -202,43 +239,49 @@ export var createAutocompletePlugin = function createAutocompletePlugin(options,
       clearTimeout(debounceTimer);
     }
     debounceTimer = setTimeout(function () {
-      var state = view.state;
-      var selection = state.selection;
+      try {
+        var state = view.state;
+        var selection = state.selection;
 
-      // Only predict for cursor selections (not range selections)
-      if (!selection.empty) {
-        return;
-      }
-      var textBefore = getTextBeforeCursor(state);
+        // Only predict for cursor selections (not range selections)
+        if (!selection.empty) {
+          return;
+        }
+        var textBefore = getTextBeforeCursor(state);
 
-      // Suppress re-showing the same suggestion the user just dismissed.
-      // Once the text context changes (user types or deletes), this clears automatically.
-      if (textBefore === dismissedContext) {
-        return;
-      }
-      dismissedContext = null;
+        // Suppress re-showing the same suggestion the user just dismissed.
+        // Once the text context changes (user types or deletes), this clears automatically.
+        if (textBefore === dismissedContext) {
+          return;
+        }
+        dismissedContext = null;
 
-      // Don't predict if there's not enough context
-      if (textBefore.trim().length < 3) {
-        return;
-      }
+        // Don't predict if there's not enough context
+        if (textBefore.trim().length < 3) {
+          return;
+        }
 
-      // Tier 1 prediction is synchronous -- no async needed
-      var prediction = predict(textBefore);
-      if (prediction && prediction.length > 0) {
-        var typedLength = getTypedLengthForPrediction(textBefore);
-        lastSuggestionTypedLength = typedLength;
-        lastSuggestionLength = typedLength + prediction.length;
-        showGhostText(view, prediction, selection.from);
-        if (prediction !== lastShownGhostText) {
-          var _api$analytics2;
-          lastShownGhostText = prediction;
-          api === null || api === void 0 || (_api$analytics2 = api.analytics) === null || _api$analytics2 === void 0 || _api$analytics2.actions.fireAnalyticsEvent({
-            action: ACTION.SUGGESTION_VIEWED,
-            actionSubject: ACTION_SUBJECT.CONTEXTUAL_TYPEAHEAD,
-            eventType: EVENT_TYPE.TRACK
-          });
+        // Tier 1 prediction is synchronous -- no async needed
+        var prediction = predict(textBefore);
+        if (prediction && prediction.length > 0) {
+          var typedLength = getTypedLengthForPrediction(textBefore);
+          lastSuggestionTypedLength = typedLength;
+          lastSuggestionLength = typedLength + prediction.length;
+          showGhostText(view, prediction, selection.from);
+          if (prediction !== lastShownGhostText) {
+            var _api$analytics3;
+            lastShownGhostText = prediction;
+            api === null || api === void 0 || (_api$analytics3 = api.analytics) === null || _api$analytics3 === void 0 || _api$analytics3.actions.fireAnalyticsEvent({
+              action: ACTION.SUGGESTION_VIEWED,
+              actionSubject: ACTION_SUBJECT.CONTEXTUAL_TYPEAHEAD,
+              eventType: EVENT_TYPE.TRACK
+            });
+          }
         }
+      } catch (error) {
+        logException(error, {
+          location: 'editor-plugin-autocomplete/schedulePrediction'
+        });
       }
     }, DEBOUNCE_MS);
   };
@@ -336,6 +379,7 @@ export var createAutocompletePlugin = function createAutocompletePlugin(options,
           var didClear = clearGhostText(state, dispatch);
           if (didClear) {
             dismissedContext = getTextBeforeCursor(state);
+            fireSuggestionDismissedAnalytics('escape');
           }
           return didClear;
         }
@@ -345,14 +389,25 @@ export var createAutocompletePlugin = function createAutocompletePlugin(options,
           var pluginState = autocompletePluginKey.getState(view.state);
           if (pluginState !== null && pluginState !== void 0 && pluginState.ghostText) {
             clearGhostText(view.state, view.dispatch);
+            fireSuggestionDismissedAnalytics('blur');
           }
           return false;
         },
         focus: function focus() {
-          loadDefaultVocabulary();
+          try {
+            loadDefaultVocabulary();
+          } catch (error) {
+            logException(error, {
+              location: 'editor-plugin-autocomplete/loadDefaultVocabulary'
+            });
+          }
           loadVectorsAsync({
             getBinaryUrl: options === null || options === void 0 ? void 0 : options.getVectorsBinaryUrl
-          }).catch(function () {});
+          }).catch(function (error) {
+            logException(error, {
+              location: 'editor-plugin-autocomplete/loadVectorsAsync'
+            });
+          });
           if (!hasIngestedPage) {
             hasIngestedPage = true;
             if (options !== null && options !== void 0 && options.getContext) {
@@ -369,7 +424,11 @@ export var createAutocompletePlugin = function createAutocompletePlugin(options,
                   ingestDocumentPage(context.parentCommentContent);
                 }
                 (_context$siblingComme4 = context.siblingCommentsContents) === null || _context$siblingComme4 === void 0 || _context$siblingComme4.forEach(ingestDocumentPage);
-              }).catch(function () {});
+              }).catch(function (error) {
+                logException(error, {
+                  location: 'editor-plugin-autocomplete/getContext'
+                });
+              });
             }
           }
           return false;
@@ -406,6 +465,9 @@ export var createAutocompletePlugin = function createAutocompletePlugin(options,
           if (debounceTimer) {
             clearTimeout(debounceTimer);
           }
+          if (hasDestroy(slowLaneClient)) {
+            slowLaneClient.destroy();
+          }
           setDefaultSlowLaneClient(null);
         }
       };