@atlaskit/rovo-triggers 10.5.0 → 10.6.0

package/CHANGELOG.md

@@ -1,5 +1,34 @@
 # @atlaskit/rovo-triggers
 
+## 10.6.0
+
+### Minor Changes
+
+- [`169859ef13e04`](https://bitbucket.org/atlassian/atlassian-frontend-monorepo/commits/169859ef13e04) -
+  Add an additive `chatEntryPoint` attribution channel to Rovo Chat, so a product can measure chats
+  that originated from its own surfaces.
+
+  A `chat-new` publisher can now pass a `ChatEntryPoint` enum value to record which surface launched
+  the conversation. New entry points must be added to the enum before use. The value is stored on
+  the conversation record — so it also covers launches that carry no `prompt`, and keeps applying
+  past the first turn — and is reported as a new `chatEntryPoint` attribute on the
+  `aiInteraction initiated` and `aiResult viewed` events.
+
+  ```ts
+  import { ChatEntryPoint } from '@atlaskit/rovo-triggers/chat-entry-point';
+
+  publish({
+  	type: 'chat-new',
+  	data: {
+  		chatEntryPoint: ChatEntryPoint.SEARCH_PAGE_AUTO_OPEN_CHAT,
+  	},
+  });
+  ```
+
+  Purely additive: no existing analytics attribute changes value or value space. `source`,
+  `subjectId`, `interactionSource`, `followUpSource`, `invokedFrom`, `entryPoint` and
+  `proactiveAIGenerated` are untouched.
+
 ## 10.5.0
 
 ### Minor Changes

package/chat-entry-point/package.json

@@ -0,0 +1,10 @@
+{
+  "name": "@atlaskit/rovo-triggers/chat-entry-point",
+  "main": "../dist/cjs/chat-entry-point.js",
+  "module": "../dist/esm/chat-entry-point.js",
+  "module:es2019": "../dist/es2019/chat-entry-point.js",
+  "sideEffects": [
+    "*.compiled.css"
+  ],
+  "types": "../dist/types/chat-entry-point.d.ts"
+}

package/dist/cjs/chat-entry-point.js

@@ -0,0 +1,10 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.ChatEntryPoint = void 0;
+var ChatEntryPoint = exports.ChatEntryPoint = /*#__PURE__*/function (ChatEntryPoint) {
+  ChatEntryPoint["SEARCH_PAGE_AUTO_OPEN_CHAT"] = "searchPageAutoOpenChat";
+  return ChatEntryPoint;
+}({});

package/dist/es2019/chat-entry-point.js

@@ -0,0 +1,4 @@
+export let ChatEntryPoint = /*#__PURE__*/function (ChatEntryPoint) {
+  ChatEntryPoint["SEARCH_PAGE_AUTO_OPEN_CHAT"] = "searchPageAutoOpenChat";
+  return ChatEntryPoint;
+}({});

package/dist/esm/chat-entry-point.js

@@ -0,0 +1,4 @@
+export var ChatEntryPoint = /*#__PURE__*/function (ChatEntryPoint) {
+  ChatEntryPoint["SEARCH_PAGE_AUTO_OPEN_CHAT"] = "searchPageAutoOpenChat";
+  return ChatEntryPoint;
+}({});

package/dist/types/chat-entry-point.d.ts

@@ -0,0 +1,3 @@
+export declare enum ChatEntryPoint {
+    SEARCH_PAGE_AUTO_OPEN_CHAT = "searchPageAutoOpenChat"
+}

package/dist/types/types.d.ts

@@ -1,4 +1,5 @@
 import type { DocNode } from '@atlaskit/adf-schema/doc';
+import type { ChatEntryPoint } from './chat-entry-point';
 import type { SolutionDraftAgentUpdatePayload } from './common/types/agent';
 import type { JsmJourneyBuilderActionsPayload } from './common/types/jsm-journey-builder';
 import type { SolutionArchitectAgentActivationFlowStoppedPayload, SolutionArchitectAgentActivationPayload, SolutionArchitectAgentActivationFlowStartedPayload, SolutionArchitectHandoffPayload, SolutionPlanStateUpdatePayload, StudioAutomationBuildUpdatePayload, StudioLandingPageRedirectPayload, UpdateAgentConfigurationPayload } from './common/types/solution-architect';
@@ -139,6 +140,8 @@ export type ChatNewPayload = PayloadCore<'chat-new', {
      */
     agentName?: string;
     agentIdentityAccountId?: string;
+    /** Identifies the product surface that launched the conversation for analytics attribution. */
+    chatEntryPoint?: ChatEntryPoint;
 } & Partial<TargetAgentParam> & PlaceholderParam>;
 export type RovoSpaceEntryPoint = 'leftNav' | 'sidebar' | 'zeroQuery' | 'typeahead' | 'inChatRecommendation';
 /**

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@atlaskit/rovo-triggers",
-	"version": "10.5.0",
+	"version": "10.6.0",
 	"description": "Provides various trigger events to drive Rovo Chat functionality, such as a publish-subscribe and URL parameter hooks",
 	"author": "Atlassian Pty Ltd",
 	"publishConfig": {