@atlaskit/rovo-triggers 10.14.0 → 10.15.0

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

@@ -0,0 +1,43 @@
+import _typeof from "@babel/runtime/helpers/typeof";
+import { bind } from 'bind-event-listener';
+import { BRIDGE_MESSAGE_MARKER } from './constants';
+
+/**
+ * A `rovo-triggers` payload reduced to a structured-clone-safe shape. Functions (e.g.
+ * `set-message-context`'s `setContext`) are resolved to values by `./registry` first.
+ */
+
+/**
+ * Transport abstraction so Host/Client work over any carrier: same-window `postMessage` on the
+ * product side, iframe/side-panel `postMessage` in the chat iframe. Carries `BridgeMessage` only;
+ * `rovo-content-bridge-api` commands travel separately, relayed verbatim by the extension.
+ */
+
+export var isBridgeMessage = function isBridgeMessage(value) {
+  return _typeof(value) === 'object' && value !== null && value[BRIDGE_MESSAGE_MARKER] === true && typeof value.direction === 'string' && _typeof(value.payload) === 'object' && value.payload !== null;
+};
+
+/** `postMessage`-based transport. Callers override `targetWindow`/`self` for the iframe side. */
+export var createWindowTransport = function createWindowTransport(_ref) {
+  var targetWindow = _ref.targetWindow,
+    _ref$self = _ref.self,
+    selfWindow = _ref$self === void 0 ? window : _ref$self,
+    _ref$targetOrigin = _ref.targetOrigin,
+    targetOrigin = _ref$targetOrigin === void 0 ? selfWindow.location.origin : _ref$targetOrigin;
+  return {
+    send: function send(message) {
+      targetWindow.postMessage(message, targetOrigin);
+    },
+    // `bind` returns its own unbind function, which is exactly the `subscribe` contract.
+    subscribe: function subscribe(handler) {
+      return bind(selfWindow, {
+        type: 'message',
+        listener: function listener(event) {
+          if (isBridgeMessage(event.data)) {
+            handler(event.data);
+          }
+        }
+      });
+    }
+  };
+};

package/dist/types/common/utils/extension-context-bridge/ExtensionContextBridgeClient.d.ts

@@ -0,0 +1,19 @@
+import { type Transport } from './transport';
+type Props = {
+    /** Override the transport (tests). Defaults to iframe<->parent `postMessage`. */
+    transport?: Transport;
+};
+/**
+ * Chat-iframe half of the bridge.
+ * - Inbound: deserializes context from the extension transport and re-publishes it onto the
+ *   iframe's own `ai-mate` bus for the existing `ChatContextSubscriber` to consume unchanged.
+ * - Outbound: forwards allowlisted action payloads (e.g. `editor-suggestion`) back to the product,
+ *   via the extension's content script.
+ *
+ * Content writes (`rovo-content-bridge-api` commands) are not handled here — that API already
+ * crosses this boundary on its own, so the extension only relays envelopes for it.
+ *
+ * Headless.
+ */
+export declare const ExtensionContextBridgeClient: ({ transport }: Props) => null;
+export {};

package/dist/types/common/utils/extension-context-bridge/ExtensionContextBridgeHost.d.ts

@@ -0,0 +1,16 @@
+import { type Transport } from './transport';
+type Props = {
+    /** Override the transport (tests). Defaults to same-window `postMessage`. */
+    transport?: Transport;
+    /** Resolves the current content id at relay time (a getter, so the Host reads it lazily). */
+    getContentId?: () => string | undefined;
+};
+/**
+ * Product-window half of the bridge. Observes the `ai-mate` bus and mirrors allowlisted context out
+ * to the extension via same-window `postMessage` (see `./policy` for the allow/deny rules).
+ *
+ * The reverse direction is handled by the sibling `RovoPostMessagePubsubListener` in
+ * `ChatOpenerSubscriber`, not here. Headless; mounts at product root via `ChatOpenerSubscriber`.
+ */
+export declare const ExtensionContextBridgeHost: ({ transport, getContentId }: Props) => null;
+export {};

package/dist/types/common/utils/extension-context-bridge/constants.d.ts

@@ -0,0 +1,13 @@
+/**
+ * Feature gate for the extension context bridge; both Host and Client self-gate on it.
+ * `fg()` requires a static literal, so call sites inline this value rather than importing it;
+ * tests resolve the gate through this constant so the two cannot drift apart.
+ */
+export declare const BRIDGE_FEATURE_GATE = "rovo-ext_context_bridge";
+/** Marker on every bridge `postMessage`, so listeners can ignore unrelated messages. */
+export declare const BRIDGE_MESSAGE_MARKER: '__rovoExtContextBridge';
+/** Read context flows product -> extension; actions flow extension -> product. */
+export declare const BRIDGE_TO_EXTENSION: 'to-extension';
+export declare const BRIDGE_TO_PRODUCT: 'to-product';
+/** Loop-guard sentinel stamped on re-published payloads so they never ping-pong. */
+export declare const BRIDGE_SOURCE: 'rovo-extension-bridge';

package/dist/types/common/utils/extension-context-bridge/policy.d.ts

@@ -0,0 +1,8 @@
+import { type Payload } from '../../../types';
+/** Why a product-bus payload was or was not relayed. */
+type InboundDecision = 'allow' | 'not-allowlisted' | 'denylisted';
+/** Classify a product-bus payload. Relay iff `allow`. */
+export declare const getInboundDecision: (type: Payload['type']) => InboundDecision;
+/** True if a chat-bus payload of this type may be relayed back to the product. */
+export declare const shouldRelayToProduct: (type: Payload['type']) => boolean;
+export {};

package/dist/types/common/utils/extension-context-bridge/registry.d.ts

@@ -0,0 +1,6 @@
+import { type Payload } from '../../../types';
+import { type SerializedPayload } from './transport';
+/** Serialise a payload for the wire, using a shim if one exists, else a generic JSON round-trip. */
+export declare const serializePayload: (payload: Payload) => SerializedPayload | null;
+/** Reconstruct a payload from the wire, stamping the loop-guard sentinel. */
+export declare const deserializePayload: (serialized: SerializedPayload) => Payload | null;

package/dist/types/common/utils/extension-context-bridge/transport.d.ts

@@ -0,0 +1,38 @@
+import { type Payload } from '../../../types';
+import { BRIDGE_MESSAGE_MARKER } from './constants';
+import type { BRIDGE_TO_EXTENSION, BRIDGE_TO_PRODUCT } from './constants';
+type BridgeDirection = typeof BRIDGE_TO_EXTENSION | typeof BRIDGE_TO_PRODUCT;
+/**
+ * A `rovo-triggers` payload reduced to a structured-clone-safe shape. Functions (e.g.
+ * `set-message-context`'s `setContext`) are resolved to values by `./registry` first.
+ */
+export type SerializedPayload = {
+    type: Payload['type'];
+    source?: string;
+    product?: Payload['product'];
+    openChat?: boolean;
+    data: unknown;
+};
+export type BridgeMessage = {
+    [BRIDGE_MESSAGE_MARKER]: true;
+    direction: BridgeDirection;
+    payload: SerializedPayload;
+};
+/**
+ * Transport abstraction so Host/Client work over any carrier: same-window `postMessage` on the
+ * product side, iframe/side-panel `postMessage` in the chat iframe. Carries `BridgeMessage` only;
+ * `rovo-content-bridge-api` commands travel separately, relayed verbatim by the extension.
+ */
+export type Transport = {
+    send: (message: BridgeMessage) => void;
+    /** Returns an unsubscribe function. */
+    subscribe: (handler: (message: BridgeMessage) => void) => () => void;
+};
+export declare const isBridgeMessage: (value: unknown) => value is BridgeMessage;
+/** `postMessage`-based transport. Callers override `targetWindow`/`self` for the iframe side. */
+export declare const createWindowTransport: ({ targetWindow, self: selfWindow, targetOrigin, }: {
+    targetWindow: Window;
+    self?: Window;
+    targetOrigin?: string;
+}) => Transport;
+export {};

package/extension-context-bridge/client/package.json

@@ -0,0 +1,10 @@
+{
+  "name": "@atlaskit/rovo-triggers/extension-context-bridge/client",
+  "main": "../../dist/cjs/common/utils/extension-context-bridge/ExtensionContextBridgeClient.js",
+  "module": "../../dist/esm/common/utils/extension-context-bridge/ExtensionContextBridgeClient.js",
+  "module:es2019": "../../dist/es2019/common/utils/extension-context-bridge/ExtensionContextBridgeClient.js",
+  "sideEffects": [
+    "*.compiled.css"
+  ],
+  "types": "../../dist/types/common/utils/extension-context-bridge/ExtensionContextBridgeClient.d.ts"
+}

package/extension-context-bridge/constants/package.json

@@ -0,0 +1,10 @@
+{
+  "name": "@atlaskit/rovo-triggers/extension-context-bridge/constants",
+  "main": "../../dist/cjs/common/utils/extension-context-bridge/constants.js",
+  "module": "../../dist/esm/common/utils/extension-context-bridge/constants.js",
+  "module:es2019": "../../dist/es2019/common/utils/extension-context-bridge/constants.js",
+  "sideEffects": [
+    "*.compiled.css"
+  ],
+  "types": "../../dist/types/common/utils/extension-context-bridge/constants.d.ts"
+}

package/extension-context-bridge/host/package.json

@@ -0,0 +1,10 @@
+{
+  "name": "@atlaskit/rovo-triggers/extension-context-bridge/host",
+  "main": "../../dist/cjs/common/utils/extension-context-bridge/ExtensionContextBridgeHost.js",
+  "module": "../../dist/esm/common/utils/extension-context-bridge/ExtensionContextBridgeHost.js",
+  "module:es2019": "../../dist/es2019/common/utils/extension-context-bridge/ExtensionContextBridgeHost.js",
+  "sideEffects": [
+    "*.compiled.css"
+  ],
+  "types": "../../dist/types/common/utils/extension-context-bridge/ExtensionContextBridgeHost.d.ts"
+}

package/extension-context-bridge/transport/package.json

@@ -0,0 +1,10 @@
+{
+  "name": "@atlaskit/rovo-triggers/extension-context-bridge/transport",
+  "main": "../../dist/cjs/common/utils/extension-context-bridge/transport.js",
+  "module": "../../dist/esm/common/utils/extension-context-bridge/transport.js",
+  "module:es2019": "../../dist/es2019/common/utils/extension-context-bridge/transport.js",
+  "sideEffects": [
+    "*.compiled.css"
+  ],
+  "types": "../../dist/types/common/utils/extension-context-bridge/transport.d.ts"
+}

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@atlaskit/rovo-triggers",
-	"version": "10.14.0",
+	"version": "10.15.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": {
@@ -46,6 +46,7 @@
 		"@atlassian/a11y-jest-testing": "^0.15.0",
 		"@atlassian/conversation-assistant-service-api": "^16.4.0",
 		"@atlassian/feature-flags-test-utils": "^1.2.0",
+		"@atlassian/testing-library": "^0.11.0",
 		"@testing-library/react": "^16.3.0",
 		"react": "^18.2.0",
 		"react-dom": "^18.2.0",
@@ -85,5 +86,10 @@
 				"import-no-extraneous-disable-for-examples-and-docs"
 			]
 		}
+	},
+	"platform-feature-flags": {
+		"rovo-ext_context_bridge": {
+			"type": "boolean"
+		}
 	}
 }