@atlaskit/rovo-triggers 3.2.0 → 3.4.0

package/CHANGELOG.md

@@ -1,5 +1,24 @@
 # @atlaskit/rovo-triggers
 
+## 3.4.0
+
+### Minor Changes
+
+- [`cd33693cf4431`](https://bitbucket.org/atlassian/atlassian-frontend-monorepo/commits/cd33693cf4431) -
+  Add new whiteboards context to pass along to llm as needed
+
+## 3.3.0
+
+### Minor Changes
+
+- [#201076](https://bitbucket.org/atlassian/atlassian-frontend-monorepo/pull-requests/201076)
+  [`9c5b61c98daf3`](https://bitbucket.org/atlassian/atlassian-frontend-monorepo/commits/9c5b61c98daf3) -
+  [ux] Add a new package `loom-script-in-confluence-chat-call-to-action-panel` which has a new
+  call-to-action panel for future use in chat history, this component is still not consumed
+  anywhere. Also added a new event in `rovo-triggers` forthe cta being clicked. This change relates
+  to the experiment
+  https://hello.atlassian.net/wiki/spaces/Growth/pages/5129359003/Loom+AI+readtime+prompt+and+script+for+confluence+pages+Project+Poster.
+
 ## 3.2.0
 
 ### Minor Changes

package/dist/cjs/types.js

@@ -16,6 +16,17 @@ var Topics = exports.Topics = {
 // Not using the PayloadCore because the `data: type | undefined` is necessary
 // but `| undefined` will cause `data` to be removed by PayloadCore
 
+// Not using the PayloadCore because the `data: type | undefined` is necessary
+// but `| undefined` will cause `data` to be removed by PayloadCore
+
+/**
+ * Possible `useCaseIds` for when the cta is clicked and sends a {@link ChatCallToActionClickedPayload} event
+ */
+
+/**
+ * Source Ids that will initiate a chat containing a call-to-action from the first assistant message
+ */
+
 /** Inserts a prompt into the chat input - either:
  * - A prompt without a placeholder - sends as a message
  * - A prompt with a placeholder - inserts the prompt into the chat input

package/dist/es2019/types.js

@@ -10,6 +10,17 @@ export const Topics = {
 // Not using the PayloadCore because the `data: type | undefined` is necessary
 // but `| undefined` will cause `data` to be removed by PayloadCore
 
+// Not using the PayloadCore because the `data: type | undefined` is necessary
+// but `| undefined` will cause `data` to be removed by PayloadCore
+
+/**
+ * Possible `useCaseIds` for when the cta is clicked and sends a {@link ChatCallToActionClickedPayload} event
+ */
+
+/**
+ * Source Ids that will initiate a chat containing a call-to-action from the first assistant message
+ */
+
 /** Inserts a prompt into the chat input - either:
  * - A prompt without a placeholder - sends as a message
  * - A prompt with a placeholder - inserts the prompt into the chat input

package/dist/esm/types.js

@@ -10,6 +10,17 @@ export var Topics = {
 // Not using the PayloadCore because the `data: type | undefined` is necessary
 // but `| undefined` will cause `data` to be removed by PayloadCore
 
+// Not using the PayloadCore because the `data: type | undefined` is necessary
+// but `| undefined` will cause `data` to be removed by PayloadCore
+
+/**
+ * Possible `useCaseIds` for when the cta is clicked and sends a {@link ChatCallToActionClickedPayload} event
+ */
+
+/**
+ * Source Ids that will initiate a chat containing a call-to-action from the first assistant message
+ */
+
 /** Inserts a prompt into the chat input - either:
  * - A prompt without a placeholder - sends as a message
  * - A prompt with a placeholder - inserts the prompt into the chat input

package/dist/types/common/utils/post-message-to-pubsub/index.d.ts

@@ -9,7 +9,7 @@ export declare const RovoPostMessagePubsubListener: () => null;
  */
 export declare const useRovoPostMessageToPubsub: () => {
     publishWithPostMessage: ({ targetWindow, payload, onAcknowledgeTimeout, }: {
-        targetWindow?: Window | undefined;
+        targetWindow?: Window;
         payload: Payload;
         onAcknowledgeTimeout: (params: {
             payload: Payload;

package/dist/types/index.d.ts

@@ -1,5 +1,5 @@
 export { usePublish, useSubscribe, useSubscribeAll, Subscriber } from './main';
-export type { Payload, Callback, Topic, WorkflowContextPayloadData, EditorContextPayloadData, BrowserContextPayloadData, AddStatusRovoPayload, UpdateStatusRovoPayload, DeleteStatusRovoPayload, AddNewTransitionRovoPayload, UpdateTransitionRovoPayload, DeleteTransitionRovoPayload, AddRuleRovoPayload, UpdateRuleRovoPayload, DeleteRuleRovoPayload, JiraWorkflowWizardAction, JiraIssueWorkBreakdownAction, DashboardInsightsActionsPayload, DashboardInsightsActionsPayloadData, } from './types';
+export type { Payload, Callback, Topic, WorkflowContextPayloadData, EditorContextPayloadData, WhiteboardContextPayloadData, BrowserContextPayloadData, AddStatusRovoPayload, UpdateStatusRovoPayload, DeleteStatusRovoPayload, AddNewTransitionRovoPayload, UpdateTransitionRovoPayload, DeleteTransitionRovoPayload, AddRuleRovoPayload, UpdateRuleRovoPayload, DeleteRuleRovoPayload, JiraWorkflowWizardAction, JiraIssueWorkBreakdownAction, DashboardInsightsActionsPayload, DashboardInsightsActionsPayloadData, ChatCallToActionClickedPayload, ValidChatCallToActionUseCases, ValidSourceIdsForChatCallToAction, } from './types';
 export { getRovoParams, updatePageRovoParams, addRovoParamsToUrl, assertOnlySpecificFieldsDefined, encodeRovoParams, getListOfRovoParams, } from './common/utils/params';
 export type { RovoChatParams, RovoChatPathway } from './common/utils/params/types';
 export { useRovoPostMessageToPubsub, RovoPostMessagePubsubListener, } from './common/utils/post-message-to-pubsub';

package/dist/types/main.d.ts

@@ -8,8 +8,8 @@ export declare const useSubscribeAll: (callback: Callback) => void;
 export declare const usePublish: (topic: Topic) => (payload: Payload) => void;
 export declare const Subscriber: ({ topic, triggerLatest, onEvent, flushQueueOnUnmount, }: {
     topic: Topic;
-    triggerLatest?: boolean | undefined;
+    triggerLatest?: boolean;
     onEvent: Callback;
-    flushQueueOnUnmount?: boolean | undefined;
+    flushQueueOnUnmount?: boolean;
 }) => null;
 export {};

package/dist/types/types.d.ts

@@ -49,6 +49,11 @@ export type EditorContextPayloadData = {
         content: string;
     };
 } | undefined;
+export type WhiteboardContextPayloadData = {
+    type: 'image/svg+xml' | 'text/plain';
+    content: string;
+    contentId?: string;
+} | undefined;
 export type BrowserContextPayloadData = {
     context: {
         browserUrl: string;
@@ -65,6 +70,9 @@ export type EditorContextPayload = PayloadCore<'editor-context-payload'> & {
 export type BrowserContextPayload = PayloadCore<'browser-context-payload'> & {
     data: BrowserContextPayloadData;
 };
+export type WhiteboardContextPayload = PayloadCore<'whiteboard-context-payload'> & {
+    data: WhiteboardContextPayloadData;
+};
 export type ChatDraftPayload = PayloadCore<'chat-draft'>;
 export type OpenBrowseAgentPayload = PayloadCore<'open-browse-agent-modal'>;
 export type OpenBrowseAgentSidebarPayload = PayloadCore<'open-browse-agent-sidebar'>;
@@ -84,6 +92,17 @@ export type ChatOpenPayload = PayloadCore<'chat-open', {
     channelId: string;
     agentId?: string;
 }>;
+/**
+ * Possible `useCaseIds` for when the cta is clicked and sends a {@link ChatCallToActionClickedPayload} event
+ */
+export type ValidChatCallToActionUseCases = 'loom-confluence-page-script-co-use' | 'loom-confluence-page-script-cross-join';
+/**
+ * Source Ids that will initiate a chat containing a call-to-action from the first assistant message
+ */
+export type ValidSourceIdsForChatCallToAction = 'confluence-page-loom-script-co-use-touchpoint' | 'confluence-page-loom-script-cross-join-touchpoint';
+export type ChatCallToActionClickedPayload = PayloadCore<'chat-cta-clicked', {
+    useCaseId: ValidChatCallToActionUseCases;
+}>;
 export type ForgeAppAuthSuccess = PayloadCore<'forge-auth-success', {
     is3pActionAuth?: boolean;
 }>;
@@ -222,7 +241,7 @@ export type JiraIssueWorkBreakdownActionPayload = PayloadCore<'jira-issue-work-b
     operations: JiraIssueWorkBreakdownAction;
 }>;
 export type SetChatContextPayload = PayloadCore<'set-message-context', ChatContextPayload>;
-export type Payload = MessageSendPayload | ChatClosePayload | ChatNewPayload | ChatDraftPayload | EditorContextPayload | ChatOpenPayload | OpenBrowseAgentPayload | OpenBrowseAgentSidebarPayload | EditorSuggestionPayload | EditorAgentChangedPayload | BrowserContextPayload | ForgeAppAuthSuccess | ForgeAppAuthFailure | JiraWorkflowWizardActionsPayload | InsertPromptPayload | JiraIssueWorkBreakdownActionPayload | DashboardInsightsActionsPayload | SetChatContextPayload;
+export type Payload = MessageSendPayload | ChatClosePayload | ChatNewPayload | ChatDraftPayload | EditorContextPayload | ChatOpenPayload | OpenBrowseAgentPayload | OpenBrowseAgentSidebarPayload | EditorSuggestionPayload | EditorAgentChangedPayload | BrowserContextPayload | WhiteboardContextPayload | ForgeAppAuthSuccess | ForgeAppAuthFailure | JiraWorkflowWizardActionsPayload | InsertPromptPayload | JiraIssueWorkBreakdownActionPayload | DashboardInsightsActionsPayload | SetChatContextPayload | ChatCallToActionClickedPayload;
 export type Callback = (payload: Payload) => void;
 export type TopicEvents = {
     [key in Topic]?: Array<{

package/dist/types-ts4.5/common/utils/post-message-to-pubsub/index.d.ts

@@ -9,7 +9,7 @@ export declare const RovoPostMessagePubsubListener: () => null;
  */
 export declare const useRovoPostMessageToPubsub: () => {
     publishWithPostMessage: ({ targetWindow, payload, onAcknowledgeTimeout, }: {
-        targetWindow?: Window | undefined;
+        targetWindow?: Window;
         payload: Payload;
         onAcknowledgeTimeout: (params: {
             payload: Payload;

package/dist/types-ts4.5/index.d.ts

@@ -1,5 +1,5 @@
 export { usePublish, useSubscribe, useSubscribeAll, Subscriber } from './main';
-export type { Payload, Callback, Topic, WorkflowContextPayloadData, EditorContextPayloadData, BrowserContextPayloadData, AddStatusRovoPayload, UpdateStatusRovoPayload, DeleteStatusRovoPayload, AddNewTransitionRovoPayload, UpdateTransitionRovoPayload, DeleteTransitionRovoPayload, AddRuleRovoPayload, UpdateRuleRovoPayload, DeleteRuleRovoPayload, JiraWorkflowWizardAction, JiraIssueWorkBreakdownAction, DashboardInsightsActionsPayload, DashboardInsightsActionsPayloadData, } from './types';
+export type { Payload, Callback, Topic, WorkflowContextPayloadData, EditorContextPayloadData, WhiteboardContextPayloadData, BrowserContextPayloadData, AddStatusRovoPayload, UpdateStatusRovoPayload, DeleteStatusRovoPayload, AddNewTransitionRovoPayload, UpdateTransitionRovoPayload, DeleteTransitionRovoPayload, AddRuleRovoPayload, UpdateRuleRovoPayload, DeleteRuleRovoPayload, JiraWorkflowWizardAction, JiraIssueWorkBreakdownAction, DashboardInsightsActionsPayload, DashboardInsightsActionsPayloadData, ChatCallToActionClickedPayload, ValidChatCallToActionUseCases, ValidSourceIdsForChatCallToAction, } from './types';
 export { getRovoParams, updatePageRovoParams, addRovoParamsToUrl, assertOnlySpecificFieldsDefined, encodeRovoParams, getListOfRovoParams, } from './common/utils/params';
 export type { RovoChatParams, RovoChatPathway } from './common/utils/params/types';
 export { useRovoPostMessageToPubsub, RovoPostMessagePubsubListener, } from './common/utils/post-message-to-pubsub';

package/dist/types-ts4.5/main.d.ts

@@ -8,8 +8,8 @@ export declare const useSubscribeAll: (callback: Callback) => void;
 export declare const usePublish: (topic: Topic) => (payload: Payload) => void;
 export declare const Subscriber: ({ topic, triggerLatest, onEvent, flushQueueOnUnmount, }: {
     topic: Topic;
-    triggerLatest?: boolean | undefined;
+    triggerLatest?: boolean;
     onEvent: Callback;
-    flushQueueOnUnmount?: boolean | undefined;
+    flushQueueOnUnmount?: boolean;
 }) => null;
 export {};

package/dist/types-ts4.5/types.d.ts

@@ -49,6 +49,11 @@ export type EditorContextPayloadData = {
         content: string;
     };
 } | undefined;
+export type WhiteboardContextPayloadData = {
+    type: 'image/svg+xml' | 'text/plain';
+    content: string;
+    contentId?: string;
+} | undefined;
 export type BrowserContextPayloadData = {
     context: {
         browserUrl: string;
@@ -65,6 +70,9 @@ export type EditorContextPayload = PayloadCore<'editor-context-payload'> & {
 export type BrowserContextPayload = PayloadCore<'browser-context-payload'> & {
     data: BrowserContextPayloadData;
 };
+export type WhiteboardContextPayload = PayloadCore<'whiteboard-context-payload'> & {
+    data: WhiteboardContextPayloadData;
+};
 export type ChatDraftPayload = PayloadCore<'chat-draft'>;
 export type OpenBrowseAgentPayload = PayloadCore<'open-browse-agent-modal'>;
 export type OpenBrowseAgentSidebarPayload = PayloadCore<'open-browse-agent-sidebar'>;
@@ -84,6 +92,17 @@ export type ChatOpenPayload = PayloadCore<'chat-open', {
     channelId: string;
     agentId?: string;
 }>;
+/**
+ * Possible `useCaseIds` for when the cta is clicked and sends a {@link ChatCallToActionClickedPayload} event
+ */
+export type ValidChatCallToActionUseCases = 'loom-confluence-page-script-co-use' | 'loom-confluence-page-script-cross-join';
+/**
+ * Source Ids that will initiate a chat containing a call-to-action from the first assistant message
+ */
+export type ValidSourceIdsForChatCallToAction = 'confluence-page-loom-script-co-use-touchpoint' | 'confluence-page-loom-script-cross-join-touchpoint';
+export type ChatCallToActionClickedPayload = PayloadCore<'chat-cta-clicked', {
+    useCaseId: ValidChatCallToActionUseCases;
+}>;
 export type ForgeAppAuthSuccess = PayloadCore<'forge-auth-success', {
     is3pActionAuth?: boolean;
 }>;
@@ -222,7 +241,7 @@ export type JiraIssueWorkBreakdownActionPayload = PayloadCore<'jira-issue-work-b
     operations: JiraIssueWorkBreakdownAction;
 }>;
 export type SetChatContextPayload = PayloadCore<'set-message-context', ChatContextPayload>;
-export type Payload = MessageSendPayload | ChatClosePayload | ChatNewPayload | ChatDraftPayload | EditorContextPayload | ChatOpenPayload | OpenBrowseAgentPayload | OpenBrowseAgentSidebarPayload | EditorSuggestionPayload | EditorAgentChangedPayload | BrowserContextPayload | ForgeAppAuthSuccess | ForgeAppAuthFailure | JiraWorkflowWizardActionsPayload | InsertPromptPayload | JiraIssueWorkBreakdownActionPayload | DashboardInsightsActionsPayload | SetChatContextPayload;
+export type Payload = MessageSendPayload | ChatClosePayload | ChatNewPayload | ChatDraftPayload | EditorContextPayload | ChatOpenPayload | OpenBrowseAgentPayload | OpenBrowseAgentSidebarPayload | EditorSuggestionPayload | EditorAgentChangedPayload | BrowserContextPayload | WhiteboardContextPayload | ForgeAppAuthSuccess | ForgeAppAuthFailure | JiraWorkflowWizardActionsPayload | InsertPromptPayload | JiraIssueWorkBreakdownActionPayload | DashboardInsightsActionsPayload | SetChatContextPayload | ChatCallToActionClickedPayload;
 export type Callback = (payload: Payload) => void;
 export type TopicEvents = {
     [key in Topic]?: Array<{

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@atlaskit/rovo-triggers",
-	"version": "3.2.0",
+	"version": "3.4.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": {