@atlaskit/editor-plugin-autocomplete 2.2.0 → 2.3.0

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

@@ -25,7 +25,7 @@ import {
 
 const SLOW_LANE_ENDPOINT = '/gateway/api/v1/autocomplete/typeahead-encodings';
 
-export const autocompletePluginKey = new PluginKey('autocomplete');
+export const autocompletePluginKey: PluginKey = new PluginKey('autocomplete');
 
 const DEBOUNCE_MS = 150;
 
@@ -202,7 +202,20 @@ const buildSlowLaneText = (docText: string, context?: AutocompleteContext): stri
 	return lines.join('\n');
 };
 
-export const createAutocompletePlugin = (options?: AutocompletePluginOptions, api?: ExtractInjectionAPI<AutocompletePlugin>) => {
+const getTypedLengthForPrediction = (textBefore: string): number => {
+	if (isWordBoundary(textBefore)) {
+		return 0;
+	}
+
+	// eslint-disable-next-line require-unicode-regexp
+	const trailingToken = textBefore.match(/([^\s.,;:!?]*)$/)?.[1] ?? '';
+	return trailingToken.length;
+};
+
+export const createAutocompletePlugin = (
+	options?: AutocompletePluginOptions,
+	api?: ExtractInjectionAPI<AutocompletePlugin>,
+): SafePlugin<AutocompletePluginState> => {
 	let debounceTimer: ReturnType<typeof setTimeout> | null = null;
 	let hasIngestedPage = false;
 	let resolvedContext: AutocompleteContext | undefined;
@@ -219,6 +232,25 @@ export const createAutocompletePlugin = (options?: AutocompletePluginOptions, ap
 	 * re-showing the same suggestion. Resets to null as soon as the text changes.
 	 */
 	let dismissedContext: string | null = null;
+	let lastSuggestionTypedLength = 0;
+	let lastSuggestionLength = 0;
+
+	const fireSuggestionInsertedAnalytics = (ghostText: string): void => {
+		const typedLength = lastSuggestionTypedLength;
+		const suggestionLength = lastSuggestionLength || typedLength + ghostText.length;
+		const kssDelta = suggestionLength - typedLength;
+
+		api?.analytics?.actions.fireAnalyticsEvent({
+			action: ACTION.SUGGESTION_INSERTED,
+			actionSubject: ACTION_SUBJECT.CONTEXTUAL_TYPEAHEAD,
+			eventType: EVENT_TYPE.TRACK,
+			attributes: {
+				suggestionLength,
+				typedLength,
+				kssDelta,
+			},
+		});
+	};
 
 	const slowLaneClient = createSlowLaneClient({
 		baseUrl: '',
@@ -263,6 +295,10 @@ export const createAutocompletePlugin = (options?: AutocompletePluginOptions, ap
 			const prediction = predict(textBefore);
 
 			if (prediction && prediction.length > 0) {
+				const typedLength = getTypedLengthForPrediction(textBefore);
+				lastSuggestionTypedLength = typedLength;
+				lastSuggestionLength = typedLength + prediction.length;
+
 				showGhostText(view, prediction, selection.from);
 				if (prediction !== lastShownGhostText) {
 					lastShownGhostText = prediction;
@@ -359,28 +395,28 @@ export const createAutocompletePlugin = (options?: AutocompletePluginOptions, ap
 
 			handleKeyDown: keydownHandler({
 				Tab: (state: EditorState, dispatch?: (tr: Transaction) => void) => {
+					const pluginState = autocompletePluginKey.getState(state) as
+						| AutocompletePluginState
+						| undefined;
+					const ghostText = pluginState?.ghostText ?? '';
 					const accepted = acceptGhostText(state, dispatch);
 					if (accepted) {
 						justAccepted = true;
 						lastShownGhostText = '';
-						api?.analytics?.actions.fireAnalyticsEvent({
-							action: ACTION.SUGGESTION_INSERTED,
-							actionSubject: ACTION_SUBJECT.CONTEXTUAL_TYPEAHEAD,
-							eventType: EVENT_TYPE.TRACK,
-						});
+						fireSuggestionInsertedAnalytics(ghostText);
 					}
 					return accepted;
 				},
 				ArrowRight: (state: EditorState, dispatch?: (tr: Transaction) => void) => {
+					const pluginState = autocompletePluginKey.getState(state) as
+						| AutocompletePluginState
+						| undefined;
+					const ghostText = pluginState?.ghostText ?? '';
 					const accepted = acceptGhostText(state, dispatch);
 					if (accepted) {
 						justAccepted = true;
 						lastShownGhostText = '';
-						api?.analytics?.actions.fireAnalyticsEvent({
-							action: ACTION.SUGGESTION_INSERTED,
-							actionSubject: ACTION_SUBJECT.CONTEXTUAL_TYPEAHEAD,
-							eventType: EVENT_TYPE.TRACK,
-						});
+						fireSuggestionInsertedAnalytics(ghostText);
 					}
 					return accepted;
 				},

package/src/pm-plugins/debug-mode.ts

@@ -0,0 +1,18 @@
+/**
+ * Contextual Typeahead Completions (CTC) debug logging utility.
+ *
+ * Logs are silent by default. To enable in any environment (dev, staging, prod):
+ *
+ *   localStorage.setItem('atl-ctc-dbg', '1')
+ *
+ * Then reload the page. To disable:
+ *
+ *   localStorage.removeItem('atl-ctc-dbg')
+ */
+export const isAutocompleteDebugEnabled = (): boolean => {
+	try {
+		return typeof localStorage !== 'undefined' && localStorage.getItem('atl-ctc-dbg') === '1';
+	} catch {
+		return false;
+	}
+};

package/src/pm-plugins/slow-lane-client.ts

@@ -7,6 +7,8 @@
  *   Response: { semantic_vector: number[], lm_logits: Record<string, number> }
  */
 
+import { isAutocompleteDebugEnabled } from './debug-mode';
+
 // ─── Types ───────────────────────────────────────────────────────────────────
 
 /** Request payload for typeahead-encodings endpoint. */
@@ -95,19 +97,20 @@ export const createSlowLaneClient = (
 			session_id: sessionId,
 		};
 
-		// Log the exact payload being sent so the comment/reply structure is visible
-		// eslint-disable-next-line no-console
-		console.groupCollapsed(
-			`%c[SlowLane] %c📤 Sending context | ${text.length} chars`,
-			'color: #9c27b0; font-weight: bold;',
-			'color: inherit;',
-		);
-		text.split('\n').forEach((line, i, arr) => {
+		if (isAutocompleteDebugEnabled()) {
+			// eslint-disable-next-line no-console
+			console.groupCollapsed(
+				`%c[SlowLane] %c📤 Sending context | ${text.length} chars`,
+				'color: #9c27b0; font-weight: bold;',
+				'color: inherit;',
+			);
+			text.split('\n').forEach((line, i, arr) => {
+				// eslint-disable-next-line no-console
+				console.log(`  ${i === arr.length - 1 ? '▶' : ' '} ${line}`);
+			});
 			// eslint-disable-next-line no-console
-			console.log(`  ${i === arr.length - 1 ? '▶' : ' '} ${line}`);
-		});
-		// eslint-disable-next-line no-console
-		console.groupEnd();
+			console.groupEnd();
+		}
 
 		try {
 			const res = await fetchFn(url, {
@@ -119,12 +122,14 @@ export const createSlowLaneClient = (
 			if (!res.ok) {
 				storedContextVector = null;
 				storedLmLogits = null;
-				// eslint-disable-next-line no-console
-				console.log(
-					`%c[SlowLane] %c❌ Request failed (${res.status})`,
-					'color: #9c27b0; font-weight: bold;',
-					'color: #f44336;',
-				);
+				if (isAutocompleteDebugEnabled()) {
+					// eslint-disable-next-line no-console
+					console.log(
+						`%c[SlowLane] %c❌ Request failed (${res.status})`,
+						'color: #9c27b0; font-weight: bold;',
+						'color: #f44336;',
+					);
+				}
 				return;
 			}
 
@@ -142,27 +147,28 @@ export const createSlowLaneClient = (
 				storedLmLogits = null;
 			}
 
-			// Log what came back so it can be correlated with the next prediction group
-			// eslint-disable-next-line no-console
-			console.groupCollapsed(
-				`%c[SlowLane] %c📥 Response received`,
-				'color: #9c27b0; font-weight: bold;',
-				'color: inherit;',
-			);
-			// eslint-disable-next-line no-console
-			console.log(
-				storedContextVector
-					? `✅ semantic_vector: ${storedContextVector.length} dims`
-					: '❌ No semantic_vector',
-			);
-			// eslint-disable-next-line no-console
-			console.log(
-				storedLmLogits
-					? `✅ lm_logits: ${Object.keys(storedLmLogits).length} tokens`
-					: '❌ No lm_logits',
-			);
-			// eslint-disable-next-line no-console
-			console.groupEnd();
+			if (isAutocompleteDebugEnabled()) {
+				// eslint-disable-next-line no-console
+				console.groupCollapsed(
+					`%c[SlowLane] %c📥 Response received`,
+					'color: #9c27b0; font-weight: bold;',
+					'color: inherit;',
+				);
+				// eslint-disable-next-line no-console
+				console.log(
+					storedContextVector
+						? `✅ semantic_vector: ${storedContextVector.length} dims`
+						: '❌ No semantic_vector',
+				);
+				// eslint-disable-next-line no-console
+				console.log(
+					storedLmLogits
+						? `✅ lm_logits: ${Object.keys(storedLmLogits).length} tokens`
+						: '❌ No lm_logits',
+				);
+				// eslint-disable-next-line no-console
+				console.groupEnd();
+			}
 
 			onUpdate?.({
 				textLength: text.length,
@@ -173,12 +179,14 @@ export const createSlowLaneClient = (
 		} catch (e) {
 			storedContextVector = null;
 			storedLmLogits = null;
-			// eslint-disable-next-line no-console
-			console.log(
-				'%c[SlowLane] %c❌ Network error — context cleared',
-				'color: #9c27b0; font-weight: bold;',
-				'color: #f44336;',
-			);
+			if (isAutocompleteDebugEnabled()) {
+				// eslint-disable-next-line no-console
+				console.log(
+					'%c[SlowLane] %c❌ Network error — context cleared',
+					'color: #9c27b0; font-weight: bold;',
+					'color: #f44336;',
+				);
+			}
 		}
 	};
 

package/src/pm-plugins/text-predictor.ts

@@ -20,6 +20,7 @@ import l3VocabularyData from './data/l3_vocabulary.json';
 import vocabularyData from './data/vocabulary_10k.json';
 import wordIndexData from './data/word_index_10k.json';
 // import { rankCandidates, isGrammarAllowed } from './scoring-pipeline';
+import { isAutocompleteDebugEnabled } from './debug-mode';
 import { rankCandidates, STAGE1_WEIGHT, STAGE2_WEIGHT, MIN_STAGE1_SCORE } from './scoring-pipeline';
 import type { ScoringCandidate } from './scoring-pipeline';
 import { getStoredContextVector, getStoredLmLogits } from './slow-lane-client';
@@ -183,7 +184,7 @@ export const initL3Vocabulary = (l3Words: string[]): void => {
 		// loses to any domain word in Stage 1, but still scores above 0.
 		l3Trie.insert(word, L3_BASELINE_FREQ, 0, 0);
 	}
-	if (debugMode) {
+	if (isAutocompleteDebugEnabled()) {
 		// eslint-disable-next-line no-console
 		console.log(`[text-predictor] L3 General English loaded: ${l3Words.length} words`);
 	}
@@ -199,8 +200,6 @@ let vectorStore: VectorStore | null = null;
 
 let vectorsLoadStarted = false;
 
-let debugMode = true;
-
 let lastPredictionDebug: {
 	contextWords: string[];
 	currentWord: string;
@@ -216,8 +215,6 @@ let lastPredictionDebug: {
 	}>;
 } | null = null;
 
-let hasLoggedSemanticActive = false;
-
 /** Get vector for a word from the store. */
 const getWordVector = (word: string): Float32Array | null => {
 	if (!vectorStore) {
@@ -306,18 +303,6 @@ const extractPreviousWord = (text: string): string => {
 
 // ─── Debug Helpers ───────────────────────────────────────────────────────────
 
-/** Enable or disable debug logging. Also checks localStorage key `autocomplete-debug`. */
-export const setDebugMode = (enabled: boolean): void => {
-	debugMode = enabled;
-};
-
-/** Check localStorage for autocomplete-debug on first access. */
-const ensureDebugModeFromStorage = (): void => {
-	if (typeof localStorage !== 'undefined' && localStorage.getItem('autocomplete-debug') === '1') {
-		debugMode = true;
-	}
-};
-
 /**
  * Get predictor status for debugging.
  * vectorsLoaded: true when semantic scoring is active
@@ -329,7 +314,6 @@ export const getPredictorStatus = (): {
 	vectorsLoadStarted: boolean;
 	wordCount: number;
 } => {
-	ensureDebugModeFromStorage();
 	return {
 		vectorsLoaded: vectorStore !== null,
 		wordCount: vectorStore ? Object.keys(vectorStore.wordIndex).length : 0,
@@ -356,7 +340,6 @@ export const getLastPredictionDebug = (): {
 		word: string;
 	}>;
 } | null => {
-	ensureDebugModeFromStorage();
 	return lastPredictionDebug;
 };
 
@@ -401,7 +384,7 @@ export const ingestDocumentPage = (pageContent: string | undefined): void => {
 		}
 	}
 
-	if (debugMode && validBoostedWords.size > 0) {
+	if (isAutocompleteDebugEnabled() && validBoostedWords.size > 0) {
 		// eslint-disable-next-line no-console
 		console.groupCollapsed(
 			`%c[L1 Session] %cPrimed ${validBoostedWords.size} valid dictionary words from page`,
@@ -416,8 +399,6 @@ export const ingestDocumentPage = (pageContent: string | undefined): void => {
 };
 
 export const predict = (textBefore: string): string | null => {
-	ensureDebugModeFromStorage();
-
 	if (!isInitialized) {
 		loadDefaultVocabulary();
 	}
@@ -506,7 +487,7 @@ export const predict = (textBefore: string): string | null => {
 	const lmLogits = getStoredLmLogits();
 
 	// Raw LM Output Logger
-	if (debugMode && lmLogits && Object.keys(lmLogits).length > 0) {
+	if (isAutocompleteDebugEnabled() && lmLogits && Object.keys(lmLogits).length > 0) {
 		const rawLmTop = Object.entries(lmLogits)
 			.sort((a, b) => b[1] - a[1])
 			.slice(0, 5)
@@ -520,10 +501,6 @@ export const predict = (textBefore: string): string | null => {
 
 	const mode: 'cold' | 'warm' = contextVector ? 'warm' : 'cold';
 
-	if (debugMode && contextVector && !hasLoggedSemanticActive) {
-		hasLoggedSemanticActive = true;
-	}
-
 	// Build ScoringCandidate array from TrieNodes
 	const scoringCandidates: ScoringCandidate[] = candidates.map(({ word, node }) => ({
 		word,
@@ -556,7 +533,7 @@ export const predict = (textBefore: string): string | null => {
 	const suggestion =
 		best && best.finalScore >= MIN_SCORE_THRESHOLD ? best.word.slice(currentWord.length) : null;
 
-	if (debugMode) {
+	if (isAutocompleteDebugEnabled()) {
 		const latencyMs = performance.now() - t0;
 		const tokens = tokenize(trimmed);
 		const contextWords = tokens.slice(-CONTEXT_WORDS);
@@ -772,8 +749,7 @@ export const loadVectorsAsync = async (options?: {
 		const dim = float32.length / nWords;
 
 		vectorStore = { float32, wordIndex, dim };
-		ensureDebugModeFromStorage();
-		if (debugMode) {
+		if (isAutocompleteDebugEnabled()) {
 			// eslint-disable-next-line no-console
 			console.log('[text-predictor] Vectors loaded:', {
 				wordCount: nWords,

package/tsconfig.app.json

@@ -2,6 +2,7 @@
 	"extends": "../../../tsconfig.base.json",
 	"include": ["./src/**/*.ts", "./src/**/*.tsx", "./src/**/*.json"],
 	"exclude": [
+		"**/*.docs.tsx",
 		"**/docs/**/*",
 		"**/__tests__/**/*",
 		"**/vr-tests/**/*",
@@ -29,7 +30,8 @@
 	"compilerOptions": {
 		"composite": true,
 		"outDir": "../../../tsDist/@atlaskit__editor-plugin-autocomplete/app",
-		"resolveJsonModule": true
+		"resolveJsonModule": true,
+		"isolatedDeclarations": true
 	},
 	"references": [
 		{

package/tsconfig.dev.json

@@ -28,7 +28,8 @@
 	"exclude": ["./dist/**/*", "./build/**/*", "./node_modules/**/*"],
 	"compilerOptions": {
 		"composite": true,
-		"outDir": "../../../tsDist/@atlaskit__editor-plugin-autocomplete/dev"
+		"outDir": "../../../tsDist/@atlaskit__editor-plugin-autocomplete/dev",
+		"isolatedDeclarations": true
 	},
 	"references": [
 		{

package/afm-jira/tsconfig.json

@@ -1,30 +0,0 @@
-{
-	"extends": "../../../../tsconfig.local-consumption.json",
-	"compilerOptions": {
-		"target": "es5",
-		"outDir": "../../../../../jira/tsDist/@atlaskit__editor-plugin-autocomplete/app",
-		"rootDir": "../",
-		"composite": true,
-		"noCheck": true,
-		"resolveJsonModule": true
-	},
-	"include": [
-		"../src/**/*.ts",
-		"../src/**/*.tsx"
-	],
-	"exclude": [
-		"../src/**/__tests__/*",
-		"../src/**/*.test.*",
-		"../src/**/test.*",
-		"../src/**/mocks/*",
-		"../src/**/examples.*"
-	],
-	"references": [
-		{
-			"path": "../../editor-prosemirror/afm-jira/tsconfig.json"
-		},
-		{
-			"path": "../../editor-common/afm-jira/tsconfig.json"
-		}
-	]
-}