@atlaskit/rovo-triggers 10.34.0 → 10.36.0

package/CHANGELOG.md

@@ -1,5 +1,36 @@
 # @atlaskit/rovo-triggers
 
+## 10.36.0
+
+### Minor Changes
+
+- [`fd47723e42634`](https://bitbucket.org/atlassian/atlassian-frontend-monorepo/commits/fd47723e42634) -
+  Add artifacts context type
+
+### Patch Changes
+
+- Updated dependencies
+
+## 10.35.0
+
+### Minor Changes
+
+- [`64dbb5601ed23`](https://bitbucket.org/atlassian/atlassian-frontend-monorepo/commits/64dbb5601ed23) -
+  Ask the product for context when the extension context bridge client mounts.
+
+  `ExtensionContextBridgeClient` now sends a single `request-context` control message once its
+  transport is ready. A product that answers requests replies with the context it has already
+  published, so a chat opened after the page settled is caught up instead of waiting for the next
+  publish.
+
+  This completes the handshake whose two halves shipped separately: the control message itself, and
+  the product-side answer. It exists because the bridge is otherwise fire-and-forget, which suits a
+  publisher that runs continuously, such as the Confluence editor, but not one that publishes once
+  per navigation, such as a Jira view.
+
+  Additive and safe against products that do not answer: the request is sent once per mount, carries
+  no data, and a product that ignores it behaves exactly as before.
+
 ## 10.34.0
 
 ### Minor Changes

package/dist/cjs/common/utils/extension-context-bridge/ExtensionContextBridgeClient.js

@@ -131,6 +131,24 @@ var ExtensionContextBridgeClient = exports.ExtensionContextBridgeClient = functi
     });
   }, [activeTransport, publish]);
 
+  // Handshake: ask the product to re-send its current context.
+  //
+  // The chat only ever sees context published while it is listening, and it mounts long after the
+  // page — the user opens the side panel on a page that settled minutes ago. Products that publish
+  // once per navigation (Jira views) would otherwise never be observed at all. Asking, rather than
+  // having the extension retain context on the chance a panel opens later, keeps page data in the
+  // page until a chat actually exists to receive it.
+  (0, _react.useEffect)(function () {
+    if (!activeTransport) {
+      return;
+    }
+    try {
+      activeTransport.send((0, _defineProperty2.default)((0, _defineProperty2.default)((0, _defineProperty2.default)({}, _constants.BRIDGE_MESSAGE_MARKER, true), "direction", _constants.BRIDGE_TO_PRODUCT), "control", _constants.BRIDGE_CONTROL_REQUEST_CONTEXT));
+    } catch (_unused2) {
+      // Never let bridging break the chat iframe.
+    }
+  }, [activeTransport]);
+
   // Outbound (WRITE, payloads): allowlisted chat actions -> product.
   (0, _main.useSubscribeAll)(function (payload) {
     if (!activeTransport) {
@@ -149,7 +167,7 @@ var ExtensionContextBridgeClient = exports.ExtensionContextBridgeClient = functi
     }
     try {
       activeTransport.send((0, _defineProperty2.default)((0, _defineProperty2.default)((0, _defineProperty2.default)({}, _constants.BRIDGE_MESSAGE_MARKER, true), "direction", _constants.BRIDGE_TO_PRODUCT), "payload", serialized));
-    } catch (_unused2) {
+    } catch (_unused3) {
       // Never let bridging break the chat iframe.
     }
   });

package/dist/cjs/types.js

@@ -49,6 +49,9 @@ var Topics = exports.Topics = {
 
 /** Partial database context for iframe updates (e.g. selection-only). */
 
+// Not using PayloadCore because `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
 

package/dist/es2019/common/utils/extension-context-bridge/ExtensionContextBridgeClient.js

@@ -1,7 +1,7 @@
 import { useEffect, useMemo, useRef } from 'react';
 import { fg } from '@atlaskit/platform-feature-flags/fg';
 import { usePublish, useSubscribeAll } from '../../../main';
-import { BRIDGE_MESSAGE_MARKER, BRIDGE_SOURCE, BRIDGE_TO_EXTENSION, BRIDGE_TO_PRODUCT } from './constants';
+import { BRIDGE_CONTROL_REQUEST_CONTEXT, BRIDGE_MESSAGE_MARKER, BRIDGE_SOURCE, BRIDGE_TO_EXTENSION, BRIDGE_TO_PRODUCT } from './constants';
 import { shouldRelayToProduct } from './policy';
 import { deserializePayload, serializePayload } from './registry';
 import { createWindowTransport, isBridgeControlMessage } from './transport';
@@ -125,6 +125,28 @@ export const ExtensionContextBridgeClient = ({
     });
   }, [activeTransport, publish]);
 
+  // Handshake: ask the product to re-send its current context.
+  //
+  // The chat only ever sees context published while it is listening, and it mounts long after the
+  // page — the user opens the side panel on a page that settled minutes ago. Products that publish
+  // once per navigation (Jira views) would otherwise never be observed at all. Asking, rather than
+  // having the extension retain context on the chance a panel opens later, keeps page data in the
+  // page until a chat actually exists to receive it.
+  useEffect(() => {
+    if (!activeTransport) {
+      return;
+    }
+    try {
+      activeTransport.send({
+        [BRIDGE_MESSAGE_MARKER]: true,
+        direction: BRIDGE_TO_PRODUCT,
+        control: BRIDGE_CONTROL_REQUEST_CONTEXT
+      });
+    } catch {
+      // Never let bridging break the chat iframe.
+    }
+  }, [activeTransport]);
+
   // Outbound (WRITE, payloads): allowlisted chat actions -> product.
   useSubscribeAll(payload => {
     if (!activeTransport) {

package/dist/es2019/types.js

@@ -43,6 +43,9 @@ export const Topics = {
 
 /** Partial database context for iframe updates (e.g. selection-only). */
 
+// Not using PayloadCore because `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
 

package/dist/esm/common/utils/extension-context-bridge/ExtensionContextBridgeClient.js

@@ -4,7 +4,7 @@ function _objectSpread(e) { for (var r = 1; r < arguments.length; r++) { var t =
 import { useEffect, useMemo, useRef } from 'react';
 import { fg } from '@atlaskit/platform-feature-flags/fg';
 import { usePublish, useSubscribeAll } from '../../../main';
-import { BRIDGE_MESSAGE_MARKER, BRIDGE_SOURCE, BRIDGE_TO_EXTENSION, BRIDGE_TO_PRODUCT } from './constants';
+import { BRIDGE_CONTROL_REQUEST_CONTEXT, BRIDGE_MESSAGE_MARKER, BRIDGE_SOURCE, BRIDGE_TO_EXTENSION, BRIDGE_TO_PRODUCT } from './constants';
 import { shouldRelayToProduct } from './policy';
 import { deserializePayload, serializePayload } from './registry';
 import { createWindowTransport, isBridgeControlMessage } from './transport';
@@ -125,6 +125,24 @@ export var ExtensionContextBridgeClient = function ExtensionContextBridgeClient(
     });
   }, [activeTransport, publish]);
 
+  // Handshake: ask the product to re-send its current context.
+  //
+  // The chat only ever sees context published while it is listening, and it mounts long after the
+  // page — the user opens the side panel on a page that settled minutes ago. Products that publish
+  // once per navigation (Jira views) would otherwise never be observed at all. Asking, rather than
+  // having the extension retain context on the chance a panel opens later, keeps page data in the
+  // page until a chat actually exists to receive it.
+  useEffect(function () {
+    if (!activeTransport) {
+      return;
+    }
+    try {
+      activeTransport.send(_defineProperty(_defineProperty(_defineProperty({}, BRIDGE_MESSAGE_MARKER, true), "direction", BRIDGE_TO_PRODUCT), "control", BRIDGE_CONTROL_REQUEST_CONTEXT));
+    } catch (_unused2) {
+      // Never let bridging break the chat iframe.
+    }
+  }, [activeTransport]);
+
   // Outbound (WRITE, payloads): allowlisted chat actions -> product.
   useSubscribeAll(function (payload) {
     if (!activeTransport) {
@@ -143,7 +161,7 @@ export var ExtensionContextBridgeClient = function ExtensionContextBridgeClient(
     }
     try {
       activeTransport.send(_defineProperty(_defineProperty(_defineProperty({}, BRIDGE_MESSAGE_MARKER, true), "direction", BRIDGE_TO_PRODUCT), "payload", serialized));
-    } catch (_unused2) {
+    } catch (_unused3) {
       // Never let bridging break the chat iframe.
     }
   });

package/dist/esm/types.js

@@ -43,6 +43,9 @@ export var Topics = {
 
 /** Partial database context for iframe updates (e.g. selection-only). */
 
+// Not using PayloadCore because `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
 

package/dist/types/types.d.ts

@@ -294,6 +294,16 @@ export type JiraCreateContextPayloadData = {
         fields: Record<string, unknown>;
     }[] | null;
 };
+export type ArtifactContextPayloadData = {
+    artifactId: string;
+    mimeType: string;
+    title: string;
+    description: string;
+    url: string;
+};
+export type ArtifactContextPayload = PayloadCore<'artifact-context-payload'> & {
+    data: ArtifactContextPayloadData | undefined;
+};
 export type EditorContextPayload = PayloadCore<'editor-context-payload'> & {
     data: EditorContextPayloadData;
 };
@@ -685,7 +695,7 @@ export type SmartlinksSubscriptionChangedPayload = PayloadCore<'smartlinks-subsc
  * is expected to be open at a time.
  */
 export type CloseInContextAifcModalPayload = PayloadCore<'close-in-context-aifc-modal'>;
-export type Payload = MessageSendPayload | ChatClosePayload | CloseInContextAifcModalPayload | SmartCreationModalOpenPayload | ChatNewPayload | InsightsOpenInChatPayload | InsightsChatExitedPayload | ChatDraftPayload | ChatSmartLink3PPostAuthLaunchPayload | EditorContextPayload | ChatOpenPayload | OpenBrowseAgentPayload | SmartlinksSubscriptionChangedPayload | OpenBrowseAgentSidebarPayload | OpenRovoRemixSidebarPayload | UpdateRovoRemixPresetPayload | SubmitRovoRemixPayload | RovoRemixHandoffFailedPayload | EditorSuggestionPayload | EditorAgentChangedPayload | BrowserContextPayload | WhiteboardContextPayload | JiraCreateContextPayload | JiraInlineAgentCreationAgentAssignedPayload | JiraWorkItemsCreatingPayload | JiraWorkItemsCreatedPayload | JiraWorkItemsCreateFailedPayload | DatabaseContextPayload | ForgeAppAuthSuccess | ForgeAppAuthFailure | JiraWorkflowWizardActionsPayload | InsertPromptPayload | DashboardInsightsActionsPayload | SetChatContextPayload | InsertUrlsPayload | InsertSkillPayload | SelectActionPayload | AddChartToDashboardPayload | GenericExternalActionErrorPayload | OpenChatDebugModalPayload | OpenChatFeedbackModalPayload | JsmJourneyBuilderActionsPayload | StudioAutomationBuildUpdatePayload | SolutionArchitectHandoffPayload | SolutionPlanStateUpdatePayload | SolutionDraftAgentUpdatePayload | SolutionArchitectAgentActivationPayload | SolutionArchitectAgentActivationFlowStartedPayload | SolutionArchitectAgentActivationFlowStoppedPayload | UpdateAgentConfigurationPayload | StudioLandingPageRedirectPayload | UploadAndInsertMediaPayload | SmartLinksContextPayload | SpaceSelectedPayload | SpaceDeselectedPayload | RecommendedSpacesSelectedPayload | RecommendedSpacesFirstTimeSelectedPayload | CustomSkillUpdatePayload | TaskPlanConfirmedPayload | TaskAskQuestionRenderedPayload | TaskPlanRenderedPayload | TaskSkipAllQuestionsPayload | TaskCancelPlanPayload | TaskAskQuestionConfirmedPayload | TaskModifyPlanRequestedPayload | TaskModifyPlanSubmittedPayload | ConfluenceContentFinalizedPayload;
+export type Payload = MessageSendPayload | ChatClosePayload | CloseInContextAifcModalPayload | SmartCreationModalOpenPayload | ChatNewPayload | InsightsOpenInChatPayload | InsightsChatExitedPayload | ChatDraftPayload | ChatSmartLink3PPostAuthLaunchPayload | EditorContextPayload | ChatOpenPayload | OpenBrowseAgentPayload | SmartlinksSubscriptionChangedPayload | OpenBrowseAgentSidebarPayload | OpenRovoRemixSidebarPayload | UpdateRovoRemixPresetPayload | SubmitRovoRemixPayload | RovoRemixHandoffFailedPayload | EditorSuggestionPayload | EditorAgentChangedPayload | BrowserContextPayload | WhiteboardContextPayload | JiraCreateContextPayload | ArtifactContextPayload | JiraInlineAgentCreationAgentAssignedPayload | JiraWorkItemsCreatingPayload | JiraWorkItemsCreatedPayload | JiraWorkItemsCreateFailedPayload | DatabaseContextPayload | ForgeAppAuthSuccess | ForgeAppAuthFailure | JiraWorkflowWizardActionsPayload | InsertPromptPayload | DashboardInsightsActionsPayload | SetChatContextPayload | InsertUrlsPayload | InsertSkillPayload | SelectActionPayload | AddChartToDashboardPayload | GenericExternalActionErrorPayload | OpenChatDebugModalPayload | OpenChatFeedbackModalPayload | JsmJourneyBuilderActionsPayload | StudioAutomationBuildUpdatePayload | SolutionArchitectHandoffPayload | SolutionPlanStateUpdatePayload | SolutionDraftAgentUpdatePayload | SolutionArchitectAgentActivationPayload | SolutionArchitectAgentActivationFlowStartedPayload | SolutionArchitectAgentActivationFlowStoppedPayload | UpdateAgentConfigurationPayload | StudioLandingPageRedirectPayload | UploadAndInsertMediaPayload | SmartLinksContextPayload | SpaceSelectedPayload | SpaceDeselectedPayload | RecommendedSpacesSelectedPayload | RecommendedSpacesFirstTimeSelectedPayload | CustomSkillUpdatePayload | TaskPlanConfirmedPayload | TaskAskQuestionRenderedPayload | TaskPlanRenderedPayload | TaskSkipAllQuestionsPayload | TaskCancelPlanPayload | TaskAskQuestionConfirmedPayload | TaskModifyPlanRequestedPayload | TaskModifyPlanSubmittedPayload | ConfluenceContentFinalizedPayload;
 export type TaskPlanConfirmedPayload = PayloadCore<'task-plan-confirmed', {
     conversationId: string;
     planTitle: string;

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@atlaskit/rovo-triggers",
-	"version": "10.34.0",
+	"version": "10.36.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": {
@@ -44,7 +44,7 @@
 		"@atlaskit/primitives": "^22.5.0",
 		"@atlaskit/ssr": "workspace:^",
 		"@atlassian/a11y-jest-testing": "^0.17.0",
-		"@atlassian/conversation-assistant-service-api": "^17.11.0",
+		"@atlassian/conversation-assistant-service-api": "^17.12.0",
 		"@atlassian/feature-flags-test-utils": "^1.3.0",
 		"@atlassian/testing-library": "^0.11.0",
 		"@atlassian/workbench": "workspace:*",