@atlaskit/editor-plugin-autocomplete 4.0.1 → 4.0.2

package/CHANGELOG.md

@@ -1,5 +1,13 @@
 # @atlaskit/editor-plugin-autocomplete
 
+## 4.0.2
+
+### Patch Changes
+
+- [`56263a9d5bb6d`](https://bitbucket.org/atlassian/atlassian-frontend-monorepo/commits/56263a9d5bb6d) -
+  Gate editor autocomplete to English locales so suggestions and model loading are disabled for
+  non-English users.
+
 ## 4.0.1
 
 ### Patch Changes

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

@@ -230,7 +230,16 @@ var getTypedLengthForPrediction = function getTypedLengthForPrediction(textBefor
   var trailingToken = (_textBefore$match$ = (_textBefore$match = textBefore.match(/([^\s.,;:!?]*)$/)) === null || _textBefore$match === void 0 ? void 0 : _textBefore$match[1]) !== null && _textBefore$match$ !== void 0 ? _textBefore$match$ : '';
   return trailingToken.length;
 };
+var isEnglishLocale = function isEnglishLocale(locale) {
+  if (!locale) {
+    return false;
+  }
+  return locale.toLowerCase().startsWith('en');
+};
 var createAutocompletePlugin = exports.createAutocompletePlugin = function createAutocompletePlugin(options, api) {
+  var _options$locale;
+  var locale = (_options$locale = options === null || options === void 0 ? void 0 : options.locale) !== null && _options$locale !== void 0 ? _options$locale : typeof navigator !== 'undefined' ? navigator.language : undefined;
+  var isAutocompleteEnabled = isEnglishLocale(locale);
   var debounceTimer = null;
   var hasIngestedPage = false;
   var resolvedContext;
@@ -620,6 +629,9 @@ var createAutocompletePlugin = exports.createAutocompletePlugin = function creat
       }),
       handleDOMEvents: {
         blur: function blur(view) {
+          if (!isAutocompleteEnabled) {
+            return false;
+          }
           var pluginState = autocompletePluginKey.getState(view.state);
           if (pluginState !== null && pluginState !== void 0 && pluginState.ghostText) {
             clearGhostText(view.state, view.dispatch);
@@ -629,6 +641,9 @@ var createAutocompletePlugin = exports.createAutocompletePlugin = function creat
         },
         focus: function focus() {
           var _options$useLocalMode, _options$useLocalMode2;
+          if (!isAutocompleteEnabled) {
+            return false;
+          }
           (0, _textPredictor.loadDefaultVocabulary)({
             isLocalLLM: (_options$useLocalMode = options === null || options === void 0 ? void 0 : options.useLocalModel) !== null && _options$useLocalMode !== void 0 ? _options$useLocalMode : false
           }).catch(function (error) {
@@ -658,6 +673,9 @@ var createAutocompletePlugin = exports.createAutocompletePlugin = function creat
     view: function view() {
       return {
         update: function update(view, prevState) {
+          if (!isAutocompleteEnabled) {
+            return;
+          }
           currentView = view;
           if (!prevState.doc.eq(view.state.doc)) {
             if (justAccepted) {

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

@@ -218,7 +218,16 @@ const getTypedLengthForPrediction = textBefore => {
   const trailingToken = (_textBefore$match$ = (_textBefore$match = textBefore.match(/([^\s.,;:!?]*)$/)) === null || _textBefore$match === void 0 ? void 0 : _textBefore$match[1]) !== null && _textBefore$match$ !== void 0 ? _textBefore$match$ : '';
   return trailingToken.length;
 };
+const isEnglishLocale = locale => {
+  if (!locale) {
+    return false;
+  }
+  return locale.toLowerCase().startsWith('en');
+};
 export const createAutocompletePlugin = (options, api) => {
+  var _options$locale;
+  const locale = (_options$locale = options === null || options === void 0 ? void 0 : options.locale) !== null && _options$locale !== void 0 ? _options$locale : typeof navigator !== 'undefined' ? navigator.language : undefined;
+  const isAutocompleteEnabled = isEnglishLocale(locale);
   let debounceTimer = null;
   let hasIngestedPage = false;
   let resolvedContext;
@@ -607,6 +616,9 @@ export const createAutocompletePlugin = (options, api) => {
       }),
       handleDOMEvents: {
         blur: view => {
+          if (!isAutocompleteEnabled) {
+            return false;
+          }
           const pluginState = autocompletePluginKey.getState(view.state);
           if (pluginState !== null && pluginState !== void 0 && pluginState.ghostText) {
             clearGhostText(view.state, view.dispatch);
@@ -616,6 +628,9 @@ export const createAutocompletePlugin = (options, api) => {
         },
         focus: () => {
           var _options$useLocalMode, _options$useLocalMode2;
+          if (!isAutocompleteEnabled) {
+            return false;
+          }
           loadDefaultVocabulary({
             isLocalLLM: (_options$useLocalMode = options === null || options === void 0 ? void 0 : options.useLocalModel) !== null && _options$useLocalMode !== void 0 ? _options$useLocalMode : false
           }).catch(error => {
@@ -644,6 +659,9 @@ export const createAutocompletePlugin = (options, api) => {
     },
     view: () => ({
       update: (view, prevState) => {
+        if (!isAutocompleteEnabled) {
+          return;
+        }
         currentView = view;
         if (!prevState.doc.eq(view.state.doc)) {
           if (justAccepted) {

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

@@ -223,7 +223,16 @@ var getTypedLengthForPrediction = function getTypedLengthForPrediction(textBefor
   var trailingToken = (_textBefore$match$ = (_textBefore$match = textBefore.match(/([^\s.,;:!?]*)$/)) === null || _textBefore$match === void 0 ? void 0 : _textBefore$match[1]) !== null && _textBefore$match$ !== void 0 ? _textBefore$match$ : '';
   return trailingToken.length;
 };
+var isEnglishLocale = function isEnglishLocale(locale) {
+  if (!locale) {
+    return false;
+  }
+  return locale.toLowerCase().startsWith('en');
+};
 export var createAutocompletePlugin = function createAutocompletePlugin(options, api) {
+  var _options$locale;
+  var locale = (_options$locale = options === null || options === void 0 ? void 0 : options.locale) !== null && _options$locale !== void 0 ? _options$locale : typeof navigator !== 'undefined' ? navigator.language : undefined;
+  var isAutocompleteEnabled = isEnglishLocale(locale);
   var debounceTimer = null;
   var hasIngestedPage = false;
   var resolvedContext;
@@ -613,6 +622,9 @@ export var createAutocompletePlugin = function createAutocompletePlugin(options,
       }),
       handleDOMEvents: {
         blur: function blur(view) {
+          if (!isAutocompleteEnabled) {
+            return false;
+          }
           var pluginState = autocompletePluginKey.getState(view.state);
           if (pluginState !== null && pluginState !== void 0 && pluginState.ghostText) {
             clearGhostText(view.state, view.dispatch);
@@ -622,6 +634,9 @@ export var createAutocompletePlugin = function createAutocompletePlugin(options,
         },
         focus: function focus() {
           var _options$useLocalMode, _options$useLocalMode2;
+          if (!isAutocompleteEnabled) {
+            return false;
+          }
           loadDefaultVocabulary({
             isLocalLLM: (_options$useLocalMode = options === null || options === void 0 ? void 0 : options.useLocalModel) !== null && _options$useLocalMode !== void 0 ? _options$useLocalMode : false
           }).catch(function (error) {
@@ -651,6 +666,9 @@ export var createAutocompletePlugin = function createAutocompletePlugin(options,
     view: function view() {
       return {
         update: function update(view, prevState) {
+          if (!isAutocompleteEnabled) {
+            return;
+          }
           currentView = view;
           if (!prevState.doc.eq(view.state.doc)) {
             if (justAccepted) {

package/dist/types/pm-plugins/autocomplete-plugin.d.ts

@@ -40,6 +40,11 @@ export interface AutocompletePluginOptions {
      * Use this to serve vectors from a CDN or media service in production.
      */
     getVectorsBinaryUrl?: () => Promise<string>;
+    /**
+     * User locale used to determine whether autocomplete should run.
+     * Defaults to browser locale when omitted.
+     */
+    locale?: string;
     /**
      * When true, uses on-device inference via WebGPU (MLC WebLLM) instead of
      * the network-based slow-lane backend. Defaults to false (network client).

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@atlaskit/editor-plugin-autocomplete",
-	"version": "4.0.1",
+	"version": "4.0.2",
 	"description": "Client-side text autocomplete plugin for @atlaskit/editor-core",
 	"author": "Atlassian Pty Ltd",
 	"license": "Apache-2.0",

package/src/pm-plugins/autocomplete-plugin.ts

@@ -214,6 +214,11 @@ export interface AutocompletePluginOptions {
 	 * Use this to serve vectors from a CDN or media service in production.
 	 */
 	getVectorsBinaryUrl?: () => Promise<string>;
+	/**
+	 * User locale used to determine whether autocomplete should run.
+	 * Defaults to browser locale when omitted.
+	 */
+	locale?: string;
 	/**
 	 * When true, uses on-device inference via WebGPU (MLC WebLLM) instead of
 	 * the network-based slow-lane backend. Defaults to false (network client).
@@ -299,10 +304,22 @@ const getTypedLengthForPrediction = (textBefore: string): number => {
 	return trailingToken.length;
 };
 
+const isEnglishLocale = (locale?: string): boolean => {
+	if (!locale) {
+		return false;
+	}
+
+	return locale.toLowerCase().startsWith('en');
+};
+
 export const createAutocompletePlugin = (
 	options?: AutocompletePluginOptions,
 	api?: ExtractInjectionAPI<AutocompletePlugin>,
 ): SafePlugin<AutocompletePluginState> => {
+	const locale =
+		options?.locale ?? (typeof navigator !== 'undefined' ? navigator.language : undefined);
+	const isAutocompleteEnabled = isEnglishLocale(locale);
+
 	let debounceTimer: ReturnType<typeof setTimeout> | null = null;
 	let hasIngestedPage = false;
 	let resolvedContext: AutocompleteContext | undefined;
@@ -730,6 +747,10 @@ export const createAutocompletePlugin = (
 
 			handleDOMEvents: {
 				blur: (view: EditorView) => {
+					if (!isAutocompleteEnabled) {
+						return false;
+					}
+
 					const pluginState = autocompletePluginKey.getState(view.state) as
 						| AutocompletePluginState
 						| undefined;
@@ -740,6 +761,10 @@ export const createAutocompletePlugin = (
 					return false;
 				},
 				focus: () => {
+					if (!isAutocompleteEnabled) {
+						return false;
+					}
+
 					loadDefaultVocabulary({ isLocalLLM: options?.useLocalModel ?? false }).catch((error) => {
 						logException(error as Error, {
 							location: 'editor-plugin-autocomplete/loadDefaultVocabulary',
@@ -767,6 +792,10 @@ export const createAutocompletePlugin = (
 
 		view: () => ({
 			update: (view: EditorView, prevState: EditorState) => {
+				if (!isAutocompleteEnabled) {
+					return;
+				}
+
 				currentView = view;
 				if (!prevState.doc.eq(view.state.doc)) {
 					if (justAccepted) {