@atlaskit/editor-plugin-autocomplete 3.4.0 → 3.4.1

package/CHANGELOG.md

@@ -1,5 +1,14 @@
 # @atlaskit/editor-plugin-autocomplete
 
+## 3.4.1
+
+### Patch Changes
+
+- [`4129a00a1ae04`](https://bitbucket.org/atlassian/atlassian-frontend-monorepo/commits/4129a00a1ae04) -
+  Add `completionSource` attribute to contextual typeahead analytics events to distinguish between
+  cold (frequency-only), server slow-lane, and on-device local LLM scoring paths
+- Updated dependencies
+
 ## 3.4.0
 
 ### Minor Changes

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

@@ -223,6 +223,18 @@ var createAutocompletePlugin = exports.createAutocompletePlugin = function creat
   var dismissedContext = null;
   var lastSuggestionTypedLength = 0;
   var lastSuggestionLength = 0;
+
+  /**
+   * cold  → no slow-lane vector received yet; frequency-only trie scoring
+   * server → server slow-lane API returned the context vector
+   * localLlm → on-device WebGPU/MLC model returned the context vector
+   */
+  var getCompletionSource = function getCompletionSource() {
+    if (!slowLaneClient.getContextVector()) {
+      return 'cold';
+    }
+    return options !== null && options !== void 0 && options.useLocalModel ? 'localLlm' : 'server';
+  };
   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({
@@ -230,6 +242,7 @@ var createAutocompletePlugin = exports.createAutocompletePlugin = function creat
       actionSubject: _analytics.ACTION_SUBJECT.CONTEXTUAL_TYPEAHEAD,
       eventType: _analytics.EVENT_TYPE.TRACK,
       attributes: {
+        completionSource: getCompletionSource(),
         reason: reason
       }
     });
@@ -244,6 +257,7 @@ var createAutocompletePlugin = exports.createAutocompletePlugin = function creat
       actionSubject: _analytics.ACTION_SUBJECT.CONTEXTUAL_TYPEAHEAD,
       eventType: _analytics.EVENT_TYPE.TRACK,
       attributes: {
+        completionSource: getCompletionSource(),
         suggestionLength: suggestionLength,
         typedLength: typedLength,
         kssDelta: kssDelta
@@ -410,7 +424,10 @@ var createAutocompletePlugin = exports.createAutocompletePlugin = function creat
             api === null || api === void 0 || (_api$analytics3 = api.analytics) === null || _api$analytics3 === void 0 || _api$analytics3.actions.fireAnalyticsEvent({
               action: _analytics.ACTION.SUGGESTION_VIEWED,
               actionSubject: _analytics.ACTION_SUBJECT.CONTEXTUAL_TYPEAHEAD,
-              eventType: _analytics.EVENT_TYPE.TRACK
+              eventType: _analytics.EVENT_TYPE.TRACK,
+              attributes: {
+                completionSource: getCompletionSource()
+              }
             });
           }
         }

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

@@ -211,6 +211,18 @@ export const createAutocompletePlugin = (options, api) => {
   let dismissedContext = null;
   let lastSuggestionTypedLength = 0;
   let lastSuggestionLength = 0;
+
+  /**
+   * cold  → no slow-lane vector received yet; frequency-only trie scoring
+   * server → server slow-lane API returned the context vector
+   * localLlm → on-device WebGPU/MLC model returned the context vector
+   */
+  const getCompletionSource = () => {
+    if (!slowLaneClient.getContextVector()) {
+      return 'cold';
+    }
+    return options !== null && options !== void 0 && options.useLocalModel ? 'localLlm' : 'server';
+  };
   const fireSuggestionDismissedAnalytics = reason => {
     var _api$analytics;
     api === null || api === void 0 ? void 0 : (_api$analytics = api.analytics) === null || _api$analytics === void 0 ? void 0 : _api$analytics.actions.fireAnalyticsEvent({
@@ -218,6 +230,7 @@ export const createAutocompletePlugin = (options, api) => {
       actionSubject: ACTION_SUBJECT.CONTEXTUAL_TYPEAHEAD,
       eventType: EVENT_TYPE.TRACK,
       attributes: {
+        completionSource: getCompletionSource(),
         reason
       }
     });
@@ -232,6 +245,7 @@ export const createAutocompletePlugin = (options, api) => {
       actionSubject: ACTION_SUBJECT.CONTEXTUAL_TYPEAHEAD,
       eventType: EVENT_TYPE.TRACK,
       attributes: {
+        completionSource: getCompletionSource(),
         suggestionLength,
         typedLength,
         kssDelta
@@ -392,7 +406,10 @@ export const createAutocompletePlugin = (options, api) => {
             api === null || api === void 0 ? void 0 : (_api$analytics3 = api.analytics) === null || _api$analytics3 === void 0 ? void 0 : _api$analytics3.actions.fireAnalyticsEvent({
               action: ACTION.SUGGESTION_VIEWED,
               actionSubject: ACTION_SUBJECT.CONTEXTUAL_TYPEAHEAD,
-              eventType: EVENT_TYPE.TRACK
+              eventType: EVENT_TYPE.TRACK,
+              attributes: {
+                completionSource: getCompletionSource()
+              }
             });
           }
         }

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

@@ -216,6 +216,18 @@ export var createAutocompletePlugin = function createAutocompletePlugin(options,
   var dismissedContext = null;
   var lastSuggestionTypedLength = 0;
   var lastSuggestionLength = 0;
+
+  /**
+   * cold  → no slow-lane vector received yet; frequency-only trie scoring
+   * server → server slow-lane API returned the context vector
+   * localLlm → on-device WebGPU/MLC model returned the context vector
+   */
+  var getCompletionSource = function getCompletionSource() {
+    if (!slowLaneClient.getContextVector()) {
+      return 'cold';
+    }
+    return options !== null && options !== void 0 && options.useLocalModel ? 'localLlm' : 'server';
+  };
   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({
@@ -223,6 +235,7 @@ export var createAutocompletePlugin = function createAutocompletePlugin(options,
       actionSubject: ACTION_SUBJECT.CONTEXTUAL_TYPEAHEAD,
       eventType: EVENT_TYPE.TRACK,
       attributes: {
+        completionSource: getCompletionSource(),
         reason: reason
       }
     });
@@ -237,6 +250,7 @@ export var createAutocompletePlugin = function createAutocompletePlugin(options,
       actionSubject: ACTION_SUBJECT.CONTEXTUAL_TYPEAHEAD,
       eventType: EVENT_TYPE.TRACK,
       attributes: {
+        completionSource: getCompletionSource(),
         suggestionLength: suggestionLength,
         typedLength: typedLength,
         kssDelta: kssDelta
@@ -403,7 +417,10 @@ export var createAutocompletePlugin = function createAutocompletePlugin(options,
             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
+              eventType: EVENT_TYPE.TRACK,
+              attributes: {
+                completionSource: getCompletionSource()
+              }
             });
           }
         }

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@atlaskit/editor-plugin-autocomplete",
-	"version": "3.4.0",
+	"version": "3.4.1",
 	"description": "Client-side text autocomplete plugin for @atlaskit/editor-core",
 	"author": "Atlassian Pty Ltd",
 	"license": "Apache-2.0",
@@ -35,7 +35,7 @@
 		"wink-nlp": "^2.4.0"
 	},
 	"peerDependencies": {
-		"@atlaskit/editor-common": "^115.7.0",
+		"@atlaskit/editor-common": "^115.8.0",
 		"@atlaskit/editor-plugin-analytics": "^11.0.0",
 		"react": "^18.2.0"
 	},

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

@@ -277,12 +277,24 @@ export const createAutocompletePlugin = (
 	let lastSuggestionTypedLength = 0;
 	let lastSuggestionLength = 0;
 
+	/**
+	 * cold  → no slow-lane vector received yet; frequency-only trie scoring
+	 * server → server slow-lane API returned the context vector
+	 * localLlm → on-device WebGPU/MLC model returned the context vector
+	 */
+	const getCompletionSource = (): 'cold' | 'server' | 'localLlm' => {
+		if (!slowLaneClient.getContextVector()) {
+			return 'cold';
+		}
+		return options?.useLocalModel ? 'localLlm' : 'server';
+	};
+
 	const fireSuggestionDismissedAnalytics = (reason: 'escape' | 'blur'): void => {
 		api?.analytics?.actions.fireAnalyticsEvent({
 			action: ACTION.SUGGESTION_DISMISSED,
 			actionSubject: ACTION_SUBJECT.CONTEXTUAL_TYPEAHEAD,
 			eventType: EVENT_TYPE.TRACK,
-			attributes: { reason },
+			attributes: { completionSource: getCompletionSource(), reason },
 		});
 	};
 
@@ -296,6 +308,7 @@ export const createAutocompletePlugin = (
 			actionSubject: ACTION_SUBJECT.CONTEXTUAL_TYPEAHEAD,
 			eventType: EVENT_TYPE.TRACK,
 			attributes: {
+				completionSource: getCompletionSource(),
 				suggestionLength,
 				typedLength,
 				kssDelta,
@@ -484,6 +497,7 @@ export const createAutocompletePlugin = (
 							action: ACTION.SUGGESTION_VIEWED,
 							actionSubject: ACTION_SUBJECT.CONTEXTUAL_TYPEAHEAD,
 							eventType: EVENT_TYPE.TRACK,
+							attributes: { completionSource: getCompletionSource() },
 						});
 					}
 				}