@atlaskit/rovo-triggers 10.26.2 → 10.28.0

package/CHANGELOG.md

@@ -1,5 +1,26 @@
 # @atlaskit/rovo-triggers
 
+## 10.28.0
+
+### Minor Changes
+
+- [`adcb94adde065`](https://bitbucket.org/atlassian/atlassian-frontend-monorepo/commits/adcb94adde065) -
+  Accept an optional `rovoJourneyId` on the chat-new pub/sub payload and bind it to the Chat
+  conversation created for a Quick Find handoff. Emit it only on `message sent`,
+  `aiMateActions displayed`, `aiInteraction initiated`, `aiResult viewed`, and `aiResult actioned`
+  events, stripping it from every other analytics event even when a caller explicitly supplies it.
+
+## 10.27.0
+
+### Minor Changes
+
+- [`2d5202d1360a6`](https://bitbucket.org/atlassian/atlassian-frontend-monorepo/commits/2d5202d1360a6) -
+  Add an optional `historyMode` option to `updatePageRovoParams` so callers that consume (remove)
+  Rovo URL parameters can replace the current history entry instead of pushing a new one. Adding
+  parameters continues to push, so opening chat still leaves the originating page in history.
+  Consumed `prompt` and `conversationId` cleanup now opts into replacement, so Back returns to the
+  originating page. Gated behind rovo_chat_replace_url_param_history.
+
 ## 10.26.2
 
 ### Patch Changes

package/dist/cjs/common/utils/params/index.js

@@ -7,6 +7,7 @@ Object.defineProperty(exports, "__esModule", {
 exports.updatePageRovoParams = exports.removePrefix = exports.getRovoParams = exports.getListOfRovoParams = exports.firstCharUpper = exports.firstCharLower = exports.encodeRovoParams = exports.assertOnlySpecificFieldsDefined = exports.addRovoParamsToUrl = exports.addPrefix = void 0;
 var _slicedToArray2 = _interopRequireDefault(require("@babel/runtime/helpers/slicedToArray"));
 var _defineProperty2 = _interopRequireDefault(require("@babel/runtime/helpers/defineProperty"));
+var _fg = require("@atlaskit/platform-feature-flags/fg");
 var _constants = require("./constants");
 function ownKeys(e, r) { var t = Object.keys(e); if (Object.getOwnPropertySymbols) { var o = Object.getOwnPropertySymbols(e); r && (o = o.filter(function (r) { return Object.getOwnPropertyDescriptor(e, r).enumerable; })), t.push.apply(t, o); } return t; }
 function _objectSpread(e) { for (var r = 1; r < arguments.length; r++) { var t = null != arguments[r] ? arguments[r] : {}; r % 2 ? ownKeys(Object(t), !0).forEach(function (r) { (0, _defineProperty2.default)(e, r, t[r]); }) : Object.getOwnPropertyDescriptors ? Object.defineProperties(e, Object.getOwnPropertyDescriptors(t)) : ownKeys(Object(t)).forEach(function (r) { Object.defineProperty(e, r, Object.getOwnPropertyDescriptor(t, r)); }); } return e; }
@@ -87,7 +88,15 @@ var getRovoParams = exports.getRovoParams = function getRovoParams(url) {
 
 // Update the address bar without reloading the page
 var updatePageRovoParams = exports.updatePageRovoParams = function updatePageRovoParams(params) {
-  window.history.pushState({}, '', addRovoParamsToUrl(window.location.pathname, params));
+  var _ref = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : {},
+    _ref$historyMode = _ref.historyMode,
+    historyMode = _ref$historyMode === void 0 ? 'push' : _ref$historyMode;
+  var updatedUrl = addRovoParamsToUrl(window.location.pathname, params);
+  if (historyMode === 'replace' && (0, _fg.fg)('rovo_chat_replace_url_param_history')) {
+    window.history.replaceState({}, '', updatedUrl);
+    return;
+  }
+  window.history.pushState({}, '', updatedUrl);
 };
 
 // Add any valid rovoChat params to a URL
@@ -103,31 +112,31 @@ var addRovoParamsToUrl = exports.addRovoParamsToUrl = function addRovoParamsToUr
 };
 var encodeRovoParams = exports.encodeRovoParams = function encodeRovoParams(params, encodeAsObject) {
   if (encodeAsObject) {
-    return Object.entries(params).reduce(function (acc, _ref) {
-      var _ref2 = (0, _slicedToArray2.default)(_ref, 2),
-        key = _ref2[0],
-        value = _ref2[1];
+    return Object.entries(params).reduce(function (acc, _ref2) {
+      var _ref3 = (0, _slicedToArray2.default)(_ref2, 2),
+        key = _ref3[0],
+        value = _ref3[1];
       acc[addPrefix(key)] = encodeURIComponent(value);
       return acc;
     }, {});
   }
-  return Object.entries(params).filter(function (_ref3) {
-    var _ref4 = (0, _slicedToArray2.default)(_ref3, 2),
-      _ = _ref4[0],
-      value = _ref4[1];
+  return Object.entries(params).filter(function (_ref4) {
+    var _ref5 = (0, _slicedToArray2.default)(_ref4, 2),
+      _ = _ref5[0],
+      value = _ref5[1];
     return value !== undefined;
-  }).map(function (_ref5) {
-    var _ref6 = (0, _slicedToArray2.default)(_ref5, 2),
-      key = _ref6[0],
-      value = _ref6[1];
+  }).map(function (_ref6) {
+    var _ref7 = (0, _slicedToArray2.default)(_ref6, 2),
+      key = _ref7[0],
+      value = _ref7[1];
     return "".concat(addPrefix(key), "=").concat(encodeURIComponent(value));
   }).join('&');
 };
 var assertOnlySpecificFieldsDefined = exports.assertOnlySpecificFieldsDefined = function assertOnlySpecificFieldsDefined(params, fields) {
-  return Object.entries(params).every(function (_ref7) {
-    var _ref8 = (0, _slicedToArray2.default)(_ref7, 2),
-      key = _ref8[0],
-      value = _ref8[1];
+  return Object.entries(params).every(function (_ref8) {
+    var _ref9 = (0, _slicedToArray2.default)(_ref8, 2),
+      key = _ref9[0],
+      value = _ref9[1];
     var field = fields.find(function (field) {
       return field === key;
     });
@@ -139,9 +148,9 @@ var assertOnlySpecificFieldsDefined = exports.assertOnlySpecificFieldsDefined =
   });
 };
 var getListOfRovoParams = exports.getListOfRovoParams = function getListOfRovoParams() {
-  var _ref9 = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : {},
-    _ref9$resourceRouterQ = _ref9.resourceRouterQuery,
-    resourceRouterQuery = _ref9$resourceRouterQ === void 0 ? false : _ref9$resourceRouterQ;
+  var _ref0 = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : {},
+    _ref0$resourceRouterQ = _ref0.resourceRouterQuery,
+    resourceRouterQuery = _ref0$resourceRouterQ === void 0 ? false : _ref0$resourceRouterQ;
   /*
   For products using react-resource-router (e.g Atlas) to
   pass as the value of `query` on the route definition. It ensures that our parameters

package/dist/es2019/common/utils/params/index.js

@@ -1,3 +1,4 @@
+import { fg } from '@atlaskit/platform-feature-flags/fg';
 import { ROVO_PARAM_PREFIX, ROVO_VALID_PARAMS } from './constants';
 export const firstCharUpper = str => str.charAt(0).toUpperCase() + str.slice(1);
 export const firstCharLower = str => str.charAt(0).toLowerCase() + str.slice(1);
@@ -64,8 +65,15 @@ export const getRovoParams = url => {
 };
 
 // Update the address bar without reloading the page
-export const updatePageRovoParams = params => {
-  window.history.pushState({}, '', addRovoParamsToUrl(window.location.pathname, params));
+export const updatePageRovoParams = (params, {
+  historyMode = 'push'
+} = {}) => {
+  const updatedUrl = addRovoParamsToUrl(window.location.pathname, params);
+  if (historyMode === 'replace' && fg('rovo_chat_replace_url_param_history')) {
+    window.history.replaceState({}, '', updatedUrl);
+    return;
+  }
+  window.history.pushState({}, '', updatedUrl);
 };
 
 // Add any valid rovoChat params to a URL

package/dist/esm/common/utils/params/index.js

@@ -2,6 +2,7 @@ import _slicedToArray from "@babel/runtime/helpers/slicedToArray";
 import _defineProperty from "@babel/runtime/helpers/defineProperty";
 function ownKeys(e, r) { var t = Object.keys(e); if (Object.getOwnPropertySymbols) { var o = Object.getOwnPropertySymbols(e); r && (o = o.filter(function (r) { return Object.getOwnPropertyDescriptor(e, r).enumerable; })), t.push.apply(t, o); } return t; }
 function _objectSpread(e) { for (var r = 1; r < arguments.length; r++) { var t = null != arguments[r] ? arguments[r] : {}; r % 2 ? ownKeys(Object(t), !0).forEach(function (r) { _defineProperty(e, r, t[r]); }) : Object.getOwnPropertyDescriptors ? Object.defineProperties(e, Object.getOwnPropertyDescriptors(t)) : ownKeys(Object(t)).forEach(function (r) { Object.defineProperty(e, r, Object.getOwnPropertyDescriptor(t, r)); }); } return e; }
+import { fg } from '@atlaskit/platform-feature-flags/fg';
 import { ROVO_PARAM_PREFIX, ROVO_VALID_PARAMS } from './constants';
 export var firstCharUpper = function firstCharUpper(str) {
   return str.charAt(0).toUpperCase() + str.slice(1);
@@ -80,7 +81,15 @@ export var getRovoParams = function getRovoParams(url) {
 
 // Update the address bar without reloading the page
 export var updatePageRovoParams = function updatePageRovoParams(params) {
-  window.history.pushState({}, '', addRovoParamsToUrl(window.location.pathname, params));
+  var _ref = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : {},
+    _ref$historyMode = _ref.historyMode,
+    historyMode = _ref$historyMode === void 0 ? 'push' : _ref$historyMode;
+  var updatedUrl = addRovoParamsToUrl(window.location.pathname, params);
+  if (historyMode === 'replace' && fg('rovo_chat_replace_url_param_history')) {
+    window.history.replaceState({}, '', updatedUrl);
+    return;
+  }
+  window.history.pushState({}, '', updatedUrl);
 };
 
 // Add any valid rovoChat params to a URL
@@ -96,31 +105,31 @@ export var addRovoParamsToUrl = function addRovoParamsToUrl(url, params) {
 };
 export var encodeRovoParams = function encodeRovoParams(params, encodeAsObject) {
   if (encodeAsObject) {
-    return Object.entries(params).reduce(function (acc, _ref) {
-      var _ref2 = _slicedToArray(_ref, 2),
-        key = _ref2[0],
-        value = _ref2[1];
+    return Object.entries(params).reduce(function (acc, _ref2) {
+      var _ref3 = _slicedToArray(_ref2, 2),
+        key = _ref3[0],
+        value = _ref3[1];
       acc[addPrefix(key)] = encodeURIComponent(value);
       return acc;
     }, {});
   }
-  return Object.entries(params).filter(function (_ref3) {
-    var _ref4 = _slicedToArray(_ref3, 2),
-      _ = _ref4[0],
-      value = _ref4[1];
+  return Object.entries(params).filter(function (_ref4) {
+    var _ref5 = _slicedToArray(_ref4, 2),
+      _ = _ref5[0],
+      value = _ref5[1];
     return value !== undefined;
-  }).map(function (_ref5) {
-    var _ref6 = _slicedToArray(_ref5, 2),
-      key = _ref6[0],
-      value = _ref6[1];
+  }).map(function (_ref6) {
+    var _ref7 = _slicedToArray(_ref6, 2),
+      key = _ref7[0],
+      value = _ref7[1];
     return "".concat(addPrefix(key), "=").concat(encodeURIComponent(value));
   }).join('&');
 };
 export var assertOnlySpecificFieldsDefined = function assertOnlySpecificFieldsDefined(params, fields) {
-  return Object.entries(params).every(function (_ref7) {
-    var _ref8 = _slicedToArray(_ref7, 2),
-      key = _ref8[0],
-      value = _ref8[1];
+  return Object.entries(params).every(function (_ref8) {
+    var _ref9 = _slicedToArray(_ref8, 2),
+      key = _ref9[0],
+      value = _ref9[1];
     var field = fields.find(function (field) {
       return field === key;
     });
@@ -132,9 +141,9 @@ export var assertOnlySpecificFieldsDefined = function assertOnlySpecificFieldsDe
   });
 };
 export var getListOfRovoParams = function getListOfRovoParams() {
-  var _ref9 = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : {},
-    _ref9$resourceRouterQ = _ref9.resourceRouterQuery,
-    resourceRouterQuery = _ref9$resourceRouterQ === void 0 ? false : _ref9$resourceRouterQ;
+  var _ref0 = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : {},
+    _ref0$resourceRouterQ = _ref0.resourceRouterQuery,
+    resourceRouterQuery = _ref0$resourceRouterQ === void 0 ? false : _ref0$resourceRouterQ;
   /*
   For products using react-resource-router (e.g Atlas) to
   pass as the value of `query` on the route definition. It ensures that our parameters

package/dist/types/common/utils/params/index.d.ts

@@ -4,7 +4,9 @@ export declare const firstCharLower: (str: string) => string;
 export declare const addPrefix: (param: ValidParam) => string;
 export declare const removePrefix: (param: string) => string;
 export declare const getRovoParams: (url?: string) => RovoChatParams;
-export declare const updatePageRovoParams: (params: RovoChatParams) => void;
+export declare const updatePageRovoParams: (params: RovoChatParams, { historyMode }?: {
+    historyMode?: 'push' | 'replace';
+}) => void;
 export declare const addRovoParamsToUrl: (url: string, params: RovoChatParams) => string;
 export declare const encodeRovoParams: (params: RovoChatParams, encodeAsObject?: boolean) => string | {
     [key: string]: string;

package/dist/types/types.d.ts

@@ -133,6 +133,8 @@ export type ChatNewPayload = PayloadCore<'chat-new', {
     files?: UploadedFile[];
     contentContext?: 'staging-area' | 'global';
     sourceId?: string;
+    /** Correlates a Quick Find journey with the Chat activity it launches. */
+    rovoJourneyId?: string;
     minionAlias?: string;
     skipCreatingSeededConversation?: boolean;
     selectedSpace?: {

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@atlaskit/rovo-triggers",
-	"version": "10.26.2",
+	"version": "10.28.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,9 +44,10 @@
 		"@atlaskit/primitives": "^22.5.0",
 		"@atlaskit/ssr": "workspace:^",
 		"@atlassian/a11y-jest-testing": "^0.17.0",
-		"@atlassian/conversation-assistant-service-api": "^17.5.0",
+		"@atlassian/conversation-assistant-service-api": "^17.7.0",
 		"@atlassian/feature-flags-test-utils": "^1.3.0",
 		"@atlassian/testing-library": "^0.11.0",
+		"@atlassian/workbench": "workspace:*",
 		"@testing-library/react": "^16.3.0",
 		"react": "^18.2.0",
 		"react-dom": "^18.2.0",
@@ -55,6 +56,9 @@
 	"platform-feature-flags": {
 		"rovo-ext_context_bridge": {
 			"type": "boolean"
+		},
+		"rovo_chat_replace_url_param_history": {
+			"type": "boolean"
 		}
 	}
 }