@atlaskit/editor-plugin-autocomplete 4.0.0 → 4.0.2

package/CHANGELOG.md

@@ -1,5 +1,23 @@
 # @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
+
+- [`560ddb7a914f6`](https://bitbucket.org/atlassian/atlassian-frontend-monorepo/commits/560ddb7a914f6) -
+  [ux] Fixes a bug where autocomplete suggestions were shown when the cursor was positioned in the
+  middle of an existing word. Suggestions are now suppressed unless the cursor is at the trailing
+  edge of a token.
+- Updated dependencies
+
 ## 4.0.0
 
 ### Major Changes

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

@@ -188,6 +188,38 @@ var buildSlowLaneText = function buildSlowLaneText(docText, context) {
   lines.push("reply ".concat(nextReplyNumber, ": ").concat(docText));
   return lines.join('\n');
 };
+var createMidWordCharacterRegex = function createMidWordCharacterRegex() {
+  try {
+    // string-built regex avoids TS1501 under the package's ES5 build target
+    return new RegExp('[\\p{L}\\p{N}_]', 'u');
+  } catch (_unused) {
+    return null;
+  }
+};
+var midWordCharacterRegex = createMidWordCharacterRegex();
+var isAsciiWordCharacter = function isAsciiWordCharacter(char) {
+  if (char === '_') {
+    return true;
+  }
+  var charCode = char.charCodeAt(0);
+  return charCode >= 48 && charCode <= 57 || charCode >= 65 && charCode <= 90 || charCode >= 97 && charCode <= 122;
+};
+var isMidWordCharacter = function isMidWordCharacter(char) {
+  if (midWordCharacterRegex) {
+    return midWordCharacterRegex.test(char);
+  }
+  if (isAsciiWordCharacter(char)) {
+    return true;
+  }
+  return char.toLocaleLowerCase() !== char.toLocaleUpperCase();
+};
+var getLeadingTextCharacter = function getLeadingTextCharacter(text) {
+  var firstCodePoint = text === null || text === void 0 ? void 0 : text.codePointAt(0);
+  if (firstCodePoint === undefined) {
+    return undefined;
+  }
+  return String.fromCodePoint(firstCodePoint);
+};
 var getTypedLengthForPrediction = function getTypedLengthForPrediction(textBefore) {
   var _textBefore$match$, _textBefore$match;
   if ((0, _slowLaneClient.isWordBoundary)(textBefore)) {
@@ -198,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;
@@ -440,6 +481,19 @@ var createAutocompletePlugin = exports.createAutocompletePlugin = function creat
         if (!selection.empty) {
           return;
         }
+
+        // Suppress suggestions when the cursor is mid-word — only offer
+        // completions when the cursor is at the trailing edge of a token.
+        // nodeAfter correctly handles inline atoms (mentions, emojis) where
+        // parentOffset and textContent indices diverge.
+        var nodeAfter = selection.$from.nodeAfter;
+        var charAfterCursor = nodeAfter !== null && nodeAfter !== void 0 && nodeAfter.isText ? getLeadingTextCharacter(nodeAfter.text) : undefined;
+        // Only suppress for Unicode letters, digits, and underscore — hyphens,
+        // apostrophes, and similar punctuation are valid left-edge boundaries
+        // and should not block suggestions (e.g. cursor before '-' in compound-word).
+        if (charAfterCursor && isMidWordCharacter(charAfterCursor)) {
+          return;
+        }
         var textBefore = getTextBeforeCursor(state);
 
         // Suppress re-showing the same suggestion the user just dismissed.
@@ -575,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);
@@ -584,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) {
@@ -613,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

@@ -176,6 +176,38 @@ const buildSlowLaneText = (docText, context) => {
   lines.push(`reply ${nextReplyNumber}: ${docText}`);
   return lines.join('\n');
 };
+const createMidWordCharacterRegex = () => {
+  try {
+    // string-built regex avoids TS1501 under the package's ES5 build target
+    return new RegExp('[\\p{L}\\p{N}_]', 'u');
+  } catch {
+    return null;
+  }
+};
+const midWordCharacterRegex = createMidWordCharacterRegex();
+const isAsciiWordCharacter = char => {
+  if (char === '_') {
+    return true;
+  }
+  const charCode = char.charCodeAt(0);
+  return charCode >= 48 && charCode <= 57 || charCode >= 65 && charCode <= 90 || charCode >= 97 && charCode <= 122;
+};
+const isMidWordCharacter = char => {
+  if (midWordCharacterRegex) {
+    return midWordCharacterRegex.test(char);
+  }
+  if (isAsciiWordCharacter(char)) {
+    return true;
+  }
+  return char.toLocaleLowerCase() !== char.toLocaleUpperCase();
+};
+const getLeadingTextCharacter = text => {
+  const firstCodePoint = text === null || text === void 0 ? void 0 : text.codePointAt(0);
+  if (firstCodePoint === undefined) {
+    return undefined;
+  }
+  return String.fromCodePoint(firstCodePoint);
+};
 const getTypedLengthForPrediction = textBefore => {
   var _textBefore$match$, _textBefore$match;
   if (isWordBoundary(textBefore)) {
@@ -186,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;
@@ -424,6 +465,19 @@ export const createAutocompletePlugin = (options, api) => {
         if (!selection.empty) {
           return;
         }
+
+        // Suppress suggestions when the cursor is mid-word — only offer
+        // completions when the cursor is at the trailing edge of a token.
+        // nodeAfter correctly handles inline atoms (mentions, emojis) where
+        // parentOffset and textContent indices diverge.
+        const nodeAfter = selection.$from.nodeAfter;
+        const charAfterCursor = nodeAfter !== null && nodeAfter !== void 0 && nodeAfter.isText ? getLeadingTextCharacter(nodeAfter.text) : undefined;
+        // Only suppress for Unicode letters, digits, and underscore — hyphens,
+        // apostrophes, and similar punctuation are valid left-edge boundaries
+        // and should not block suggestions (e.g. cursor before '-' in compound-word).
+        if (charAfterCursor && isMidWordCharacter(charAfterCursor)) {
+          return;
+        }
         const textBefore = getTextBeforeCursor(state);
 
         // Suppress re-showing the same suggestion the user just dismissed.
@@ -562,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);
@@ -571,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 => {
@@ -599,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

@@ -181,6 +181,38 @@ var buildSlowLaneText = function buildSlowLaneText(docText, context) {
   lines.push("reply ".concat(nextReplyNumber, ": ").concat(docText));
   return lines.join('\n');
 };
+var createMidWordCharacterRegex = function createMidWordCharacterRegex() {
+  try {
+    // string-built regex avoids TS1501 under the package's ES5 build target
+    return new RegExp('[\\p{L}\\p{N}_]', 'u');
+  } catch (_unused) {
+    return null;
+  }
+};
+var midWordCharacterRegex = createMidWordCharacterRegex();
+var isAsciiWordCharacter = function isAsciiWordCharacter(char) {
+  if (char === '_') {
+    return true;
+  }
+  var charCode = char.charCodeAt(0);
+  return charCode >= 48 && charCode <= 57 || charCode >= 65 && charCode <= 90 || charCode >= 97 && charCode <= 122;
+};
+var isMidWordCharacter = function isMidWordCharacter(char) {
+  if (midWordCharacterRegex) {
+    return midWordCharacterRegex.test(char);
+  }
+  if (isAsciiWordCharacter(char)) {
+    return true;
+  }
+  return char.toLocaleLowerCase() !== char.toLocaleUpperCase();
+};
+var getLeadingTextCharacter = function getLeadingTextCharacter(text) {
+  var firstCodePoint = text === null || text === void 0 ? void 0 : text.codePointAt(0);
+  if (firstCodePoint === undefined) {
+    return undefined;
+  }
+  return String.fromCodePoint(firstCodePoint);
+};
 var getTypedLengthForPrediction = function getTypedLengthForPrediction(textBefore) {
   var _textBefore$match$, _textBefore$match;
   if (isWordBoundary(textBefore)) {
@@ -191,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;
@@ -433,6 +474,19 @@ export var createAutocompletePlugin = function createAutocompletePlugin(options,
         if (!selection.empty) {
           return;
         }
+
+        // Suppress suggestions when the cursor is mid-word — only offer
+        // completions when the cursor is at the trailing edge of a token.
+        // nodeAfter correctly handles inline atoms (mentions, emojis) where
+        // parentOffset and textContent indices diverge.
+        var nodeAfter = selection.$from.nodeAfter;
+        var charAfterCursor = nodeAfter !== null && nodeAfter !== void 0 && nodeAfter.isText ? getLeadingTextCharacter(nodeAfter.text) : undefined;
+        // Only suppress for Unicode letters, digits, and underscore — hyphens,
+        // apostrophes, and similar punctuation are valid left-edge boundaries
+        // and should not block suggestions (e.g. cursor before '-' in compound-word).
+        if (charAfterCursor && isMidWordCharacter(charAfterCursor)) {
+          return;
+        }
         var textBefore = getTextBeforeCursor(state);
 
         // Suppress re-showing the same suggestion the user just dismissed.
@@ -568,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);
@@ -577,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) {
@@ -606,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.0",
+	"version": "4.0.2",
 	"description": "Client-side text autocomplete plugin for @atlaskit/editor-core",
 	"author": "Atlassian Pty Ltd",
 	"license": "Apache-2.0",
@@ -27,7 +27,7 @@
 		"wink-nlp": "^2.4.0"
 	},
 	"peerDependencies": {
-		"@atlaskit/editor-common": "^116.0.0",
+		"@atlaskit/editor-common": "^116.4.0",
 		"@atlaskit/editor-plugin-analytics": "^12.0.0",
 		"react": "^18.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).
@@ -243,6 +248,52 @@ const buildSlowLaneText = (docText: string, context?: AutocompleteContext): stri
 	return lines.join('\n');
 };
 
+const createMidWordCharacterRegex = (): RegExp | null => {
+	try {
+		// string-built regex avoids TS1501 under the package's ES5 build target
+		return new RegExp('[\\p{L}\\p{N}_]', 'u');
+	} catch {
+		return null;
+	}
+};
+
+const midWordCharacterRegex = createMidWordCharacterRegex();
+
+const isAsciiWordCharacter = (char: string): boolean => {
+	if (char === '_') {
+		return true;
+	}
+
+	const charCode = char.charCodeAt(0);
+	return (
+		(charCode >= 48 && charCode <= 57) ||
+		(charCode >= 65 && charCode <= 90) ||
+		(charCode >= 97 && charCode <= 122)
+	);
+};
+
+const isMidWordCharacter = (char: string): boolean => {
+	if (midWordCharacterRegex) {
+		return midWordCharacterRegex.test(char);
+	}
+
+	if (isAsciiWordCharacter(char)) {
+		return true;
+	}
+
+	return char.toLocaleLowerCase() !== char.toLocaleUpperCase();
+};
+
+const getLeadingTextCharacter = (text?: string): string | undefined => {
+	const firstCodePoint = text?.codePointAt(0);
+
+	if (firstCodePoint === undefined) {
+		return undefined;
+	}
+
+	return String.fromCodePoint(firstCodePoint);
+};
+
 const getTypedLengthForPrediction = (textBefore: string): number => {
 	if (isWordBoundary(textBefore)) {
 		return 0;
@@ -253,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;
@@ -514,6 +577,19 @@ export const createAutocompletePlugin = (
 					return;
 				}
 
+				// Suppress suggestions when the cursor is mid-word — only offer
+				// completions when the cursor is at the trailing edge of a token.
+				// nodeAfter correctly handles inline atoms (mentions, emojis) where
+				// parentOffset and textContent indices diverge.
+				const nodeAfter = selection.$from.nodeAfter;
+				const charAfterCursor = nodeAfter?.isText ? getLeadingTextCharacter(nodeAfter.text) : undefined;
+				// Only suppress for Unicode letters, digits, and underscore — hyphens,
+				// apostrophes, and similar punctuation are valid left-edge boundaries
+				// and should not block suggestions (e.g. cursor before '-' in compound-word).
+				if (charAfterCursor && isMidWordCharacter(charAfterCursor)) {
+					return;
+				}
+
 				const textBefore = getTextBeforeCursor(state);
 
 				// Suppress re-showing the same suggestion the user just dismissed.
@@ -671,6 +747,10 @@ export const createAutocompletePlugin = (
 
 			handleDOMEvents: {
 				blur: (view: EditorView) => {
+					if (!isAutocompleteEnabled) {
+						return false;
+					}
+
 					const pluginState = autocompletePluginKey.getState(view.state) as
 						| AutocompletePluginState
 						| undefined;
@@ -681,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',
@@ -708,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) {