@atlaskit/editor-plugin-autocomplete 4.1.0 → 4.1.1

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

@@ -208,6 +208,11 @@ export interface AutocompleteContext {
 }
 
 export interface AutocompletePluginOptions {
+	/**
+	 * Product/editor surface where autocomplete runs (e.g. "comment", "chat").
+	 * Added to analytics and UFO metadata for cross-surface reporting.
+	 */
+	surface?: string;
 	/**
 	 * Async function called once on first editor focus to retrieve context for
 	 * word-frequency boosting. Called lazily so the preset can remain synchronous.
@@ -328,6 +333,7 @@ export const createAutocompletePlugin = (
 	options?: AutocompletePluginOptions,
 	api?: ExtractInjectionAPI<AutocompletePlugin>,
 ): SafePlugin<AutocompletePluginState> => {
+	const surface = options?.surface ?? 'editor';
 	const locale =
 		options?.locale ?? (typeof navigator !== 'undefined' ? navigator.language : undefined);
 	const isAutocompleteEnabled = isEnglishLocale(locale);
@@ -375,7 +381,7 @@ export const createAutocompletePlugin = (
 			action: ACTION.SUGGESTION_DISMISSED,
 			actionSubject: ACTION_SUBJECT.CONTEXTUAL_TYPEAHEAD,
 			eventType: EVENT_TYPE.TRACK,
-			attributes: { completionSource: getCompletionSource(), reason },
+			attributes: { completionSource: getCompletionSource(), reason, surface },
 		});
 	};
 
@@ -390,6 +396,7 @@ export const createAutocompletePlugin = (
 				loadDurationMs: info.loadDurationMs,
 				gpuVendor: info.capabilities.vendor,
 				gpuArchitecture: info.capabilities.architecture,
+				surface,
 			},
 		});
 	};
@@ -412,6 +419,7 @@ export const createAutocompletePlugin = (
 				maxStorageBufferBindingSizeMB: capabilities.maxStorageBufferBindingSizeMB,
 				gpuVendor: capabilities.vendor,
 				gpuArchitecture: capabilities.architecture,
+				surface,
 			},
 		});
 	};
@@ -430,6 +438,7 @@ export const createAutocompletePlugin = (
 				suggestionLength,
 				typedLength,
 				kssDelta,
+				surface,
 			},
 		});
 	};
@@ -439,10 +448,12 @@ export const createAutocompletePlugin = (
 				debounceMs: LOCAL_SLOW_LANE_DEBOUNCE_MS,
 				onLoadSuccess: fireLocalModelLoadedAnalytics,
 				onLoadError: fireLocalModelLoadFailedAnalytics,
+				surface,
 			})
 		: createSlowLaneClient({
 				baseUrl: '',
 				debounceMs: NETWORK_SLOW_LANE_DEBOUNCE_MS,
+				surface,
 			});
 	setDefaultSlowLaneClient(slowLaneClient);
 
@@ -632,7 +643,7 @@ export const createAutocompletePlugin = (
 							action: ACTION.SUGGESTION_VIEWED,
 							actionSubject: ACTION_SUBJECT.CONTEXTUAL_TYPEAHEAD,
 							eventType: EVENT_TYPE.TRACK,
-							attributes: { completionSource: getCompletionSource() },
+							attributes: { completionSource: getCompletionSource(), surface },
 						});
 					}
 				}
@@ -778,7 +789,10 @@ export const createAutocompletePlugin = (
 						return false;
 					}
 
-					loadDefaultVocabulary({ isLocalLLM: options?.useLocalModel ?? false }).catch((error) => {
+					loadDefaultVocabulary({
+						isLocalLLM: options?.useLocalModel ?? false,
+						surface,
+					}).catch((error) => {
 						logException(error as Error, {
 							location: 'editor-plugin-autocomplete/loadDefaultVocabulary',
 						});
@@ -786,6 +800,7 @@ export const createAutocompletePlugin = (
 					loadVectorsAsync({
 						getBinaryUrl: options?.getVectorsBinaryUrl,
 						isLocalLLM: options?.useLocalModel ?? false,
+						surface,
 					}).catch((error) => {
 						logException(error as Error, {
 							location: 'editor-plugin-autocomplete/loadVectorsAsync',

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

@@ -81,6 +81,8 @@ export interface LocalSlowLaneClientConfig {
 	onStatus?: (message: string) => void;
 	/** Callback fired when inference returns new results. */
 	onUpdate?: (opts: { hasLmLogits: boolean; hasVector: boolean; textLength: number }) => void;
+	/** Product/editor surface where autocomplete runs. */
+	surface?: string;
 }
 
 // Same return type as createSlowLaneClient for drop-in compatibility
@@ -664,6 +666,7 @@ export const createLocalSlowLaneClient = (
 		onLoadSuccess,
 		modelId = LOCAL_MLC_CAUSAL_MODEL_ID,
 		customModelConfig,
+		surface,
 	} = config;
 
 	// ── State ──────────────────────────────────────────────────────────────
@@ -1040,6 +1043,7 @@ export const createLocalSlowLaneClient = (
 			startExp(EXPERIENCE_NAME.SLOW_LANE_FETCH, experienceId, {
 				textLength: text.length,
 				isLocalLLM: true,
+				...(surface ? { surface } : {}),
 			});
 
 			const tStart = performance.now();
@@ -1085,7 +1089,7 @@ export const createLocalSlowLaneClient = (
 					EXPERIENCE_NAME.SLOW_LANE_FETCH,
 					experienceId,
 					destroyed ? 'destroyed' : 'superseded',
-					{ isLocalLLM: true },
+					{ isLocalLLM: true, ...(surface ? { surface } : {}) },
 				);
 				return;
 			}
@@ -1154,6 +1158,7 @@ export const createLocalSlowLaneClient = (
 				hasVector: storedContextVector !== null,
 				hasLmLogits: storedLmLogits !== null,
 				isLocalLLM: true,
+				...(surface ? { surface } : {}),
 			});
 
 			onUpdate?.({
@@ -1168,7 +1173,7 @@ export const createLocalSlowLaneClient = (
 					EXPERIENCE_NAME.SLOW_LANE_FETCH,
 					experienceId,
 					destroyed ? 'destroyed' : 'superseded',
-					{ isLocalLLM: true },
+					{ isLocalLLM: true, ...(surface ? { surface } : {}) },
 				);
 				return;
 			}
@@ -1178,6 +1183,7 @@ export const createLocalSlowLaneClient = (
 			failExp(EXPERIENCE_NAME.SLOW_LANE_FETCH, experienceId, {
 				errorType: 'inference',
 				isLocalLLM: true,
+				...(surface ? { surface } : {}),
 			});
 			onUpdate?.({ textLength: text.length, hasVector: false, hasLmLogits: false });
 

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

@@ -54,6 +54,7 @@ export interface SlowLaneClientConfig {
 	onUpdate?: (opts: { hasLmLogits: boolean; hasVector: boolean; textLength: number }) => void;
 	productKey?: string;
 	sessionId?: string;
+	surface?: string;
 }
 
 export const createSlowLaneClient = (
@@ -70,6 +71,7 @@ export const createSlowLaneClient = (
 		baseUrl,
 		sessionId: configSessionId,
 		productKey = 'confluence',
+		surface,
 		endpoint = '/gateway/api/v1/autocomplete/typeahead-encodings',
 		debounceMs = DEFAULT_DEBOUNCE_MS,
 		fetchFn = fetch,
@@ -105,6 +107,7 @@ export const createSlowLaneClient = (
 		startExp(EXPERIENCE_NAME.SLOW_LANE_FETCH, requestId, {
 			textLength: text.length,
 			isLocalLLM: false,
+			...(surface ? { surface } : {}),
 		});
 
 		if (isAutocompleteDebugEnabled()) {
@@ -136,6 +139,7 @@ export const createSlowLaneClient = (
 					status: res.status,
 					errorType: 'http_error',
 					isLocalLLM: false,
+					...(surface ? { surface } : {}),
 				});
 				if (isAutocompleteDebugEnabled()) {
 					// eslint-disable-next-line no-console
@@ -190,6 +194,7 @@ export const createSlowLaneClient = (
 				hasVector: storedContextVector !== null,
 				hasLmLogits: storedLmLogits !== null,
 				isLocalLLM: false,
+				...(surface ? { surface } : {}),
 			});
 
 			onUpdate?.({
@@ -204,6 +209,7 @@ export const createSlowLaneClient = (
 			failExp(EXPERIENCE_NAME.SLOW_LANE_FETCH, requestId, {
 				errorType: 'network',
 				isLocalLLM: false,
+				...(surface ? { surface } : {}),
 			});
 			if (isAutocompleteDebugEnabled()) {
 				// eslint-disable-next-line no-console
@@ -230,6 +236,7 @@ export const createSlowLaneClient = (
 			if (inflightRequestId !== null) {
 				abortExp(EXPERIENCE_NAME.SLOW_LANE_FETCH, inflightRequestId, 'superseded', {
 					isLocalLLM: false,
+					...(surface ? { surface } : {}),
 				});
 			}
 			const requestId = String(++requestSeq);

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

@@ -751,6 +751,7 @@ function unwrapJsonModule<T>(mod: unknown, shape: 'object' | 'array'): T | null
 export const loadVectorsAsync = async (options?: {
 	getBinaryUrl?: () => Promise<string>;
 	isLocalLLM?: boolean;
+	surface?: string;
 }): Promise<void> => {
 	if (vectorStore || vectorsLoadStarted) {
 		return;
@@ -763,15 +764,23 @@ export const loadVectorsAsync = async (options?: {
 		return;
 	}
 	const isLocalLLM = options?.isLocalLLM ?? false;
+	const surface = options?.surface;
 	vectorsLoadStarted = true;
-	startExp(EXPERIENCE_NAME.LOAD_VECTORS, 'singleton', { isLocalLLM });
+	startExp(EXPERIENCE_NAME.LOAD_VECTORS, 'singleton', {
+		isLocalLLM,
+		...(surface ? { surface } : {}),
+	});
 
 	let url: string;
 	try {
 		url = await options.getBinaryUrl();
 	} catch (e) {
 		vectorsLoadStarted = false;
-		failExp(EXPERIENCE_NAME.LOAD_VECTORS, 'singleton', { isLocalLLM, errorType: 'resolve_url' });
+		failExp(EXPERIENCE_NAME.LOAD_VECTORS, 'singleton', {
+			isLocalLLM,
+			errorType: 'resolve_url',
+			...(surface ? { surface } : {}),
+		});
 		// eslint-disable-next-line no-console
 		console.warn('[text-predictor] Failed to resolve vectors URL:', e);
 		return;
@@ -785,6 +794,7 @@ export const loadVectorsAsync = async (options?: {
 				isLocalLLM,
 				status: res.status,
 				errorType: 'http_error',
+				...(surface ? { surface } : {}),
 			});
 			// eslint-disable-next-line no-console
 			console.warn(`[text-predictor] Failed to load vectors: ${res.status}`);
@@ -819,6 +829,7 @@ export const loadVectorsAsync = async (options?: {
 			wordCount: nWords,
 			dim,
 			sizeBytes: float32.byteLength,
+			...(surface ? { surface } : {}),
 		});
 		if (isAutocompleteDebugEnabled()) {
 			// eslint-disable-next-line no-console
@@ -830,7 +841,11 @@ export const loadVectorsAsync = async (options?: {
 		}
 	} catch (e) {
 		vectorsLoadStarted = false;
-		failExp(EXPERIENCE_NAME.LOAD_VECTORS, 'singleton', { isLocalLLM, errorType: 'network' });
+		failExp(EXPERIENCE_NAME.LOAD_VECTORS, 'singleton', {
+			isLocalLLM,
+			errorType: 'network',
+			...(surface ? { surface } : {}),
+		});
 		// eslint-disable-next-line no-console
 		console.warn('[text-predictor] Failed to load vectors:', e);
 	}
@@ -842,7 +857,10 @@ export const initVectors = (store: VectorStore): void => {
 
 let vocabularyLoadPromise: Promise<void> | undefined;
 
-export const loadDefaultVocabulary = (options?: { isLocalLLM?: boolean }): Promise<void> => {
+export const loadDefaultVocabulary = (options?: {
+	isLocalLLM?: boolean;
+	surface?: string;
+}): Promise<void> => {
 	if (isInitialized) {
 		return Promise.resolve();
 	}
@@ -851,8 +869,12 @@ export const loadDefaultVocabulary = (options?: { isLocalLLM?: boolean }): Promi
 	}
 
 	const isLocalLLM = options?.isLocalLLM ?? false;
+	const surface = options?.surface;
 	vocabularyLoadPromise = (async () => {
-		startExp(EXPERIENCE_NAME.LOAD_VOCABULARY, 'singleton', { isLocalLLM });
+		startExp(EXPERIENCE_NAME.LOAD_VOCABULARY, 'singleton', {
+			isLocalLLM,
+			...(surface ? { surface } : {}),
+		});
 
 		try {
 			// The L2 vocabulary and L3 word list are code-split into their own async
@@ -890,11 +912,13 @@ export const loadDefaultVocabulary = (options?: { isLocalLLM?: boolean }): Promi
 				isLocalLLM,
 				l2WordCount: terms.length,
 				l3WordCount: l3VocabularyData.length,
+				...(surface ? { surface } : {}),
 			});
 		} catch (e) {
 			failExp(EXPERIENCE_NAME.LOAD_VOCABULARY, 'singleton', {
 				isLocalLLM,
 				errorType: 'parse_error',
+				...(surface ? { surface } : {}),
 			});
 			// Allow a later call to retry the load rather than caching the failure.
 			vocabularyLoadPromise = undefined;