@atlaskit/rovo-agent-analytics 0.20.0 → 1.1.0

package/CHANGELOG.md

@@ -1,5 +1,20 @@
 # @atlaskit/rovo-agent-analytics
 
+## 1.1.0
+
+### Minor Changes
+
+- [`cffd9dae547c3`](https://bitbucket.org/atlassian/atlassian-frontend-monorepo/commits/cffd9dae547c3) -
+  Update rovo agents analytics funnel
+
+## 1.0.0
+
+### Major Changes
+
+- [`e4034958fc116`](https://bitbucket.org/atlassian/atlassian-frontend-monorepo/commits/e4034958fc116) -
+  Adjust event tracking for agent analytics to use new trackAgentEvent() method. Remove deprecated
+  trackAgentAction() export and exported action const enums
+
 ## 0.20.0
 
 ### Minor Changes

package/README.md

@@ -6,6 +6,18 @@ Rovo Agents analytics library for composing and sending typed analytics events.
 
 ```typescript
 import { useRovoAgentActionAnalytics } from '@atlaskit/rovo-agent-analytics/actions';
+
+const { trackAgentEvent } = useRovoAgentActionAnalytics({});
+
+// Full control over event properties — all fields are type-checked
+trackAgentEvent({
+  action: 'view',
+  actionSubject: 'rovoAgent',
+  attributes: { 
+    agentId: 'agent-123',
+    touchPoint: 'browse-agent-list',
+  },
+});
 ```
 
 Detailed docs and example usage can be found
@@ -13,27 +25,27 @@ Detailed docs and example usage can be found
 
 ## Examples
 
-### Basic usage with `trackAgentAction()` (deprecated)
+### Basic Event Tracking
 
-For simple actions with default `actionSubject: 'rovoAgent'`:
+For fully-typed events with explicit `action`, `actionSubject`, and `attributes`:
 
 ```typescript
-import { useRovoAgentActionAnalytics, AgentCommonActions } from '@atlaskit/rovo-agent-analytics';
+import { useRovoAgentActionAnalytics } from '@atlaskit/rovo-agent-analytics/actions';
 
-const { trackAgentAction } = useRovoAgentActionAnalytics({
-	agentId,
-	touchPoint: 'browse-agent-list',
+const { trackAgentEvent } = useRovoAgentActionAnalytics({
+  agentId,
+  touchPoint: 'browse-agent-list',
 });
 
-// No additional attributes needed - agentId and touchPoint already provided
-trackAgentAction(AgentCommonActions.DUPLICATE, {});
+// Track a user interaction
+trackAgentEvent({
+  action: 'duplicate',
+  actionSubject: 'rovoAgent',
+  attributes: {},
+});
 ```
 
-> **Note:** `trackAgentAction()` is deprecated. Prefer `trackAgentEvent()` for new code.
-
-### Full Event Tracking with `trackAgentEvent()` (recommended)
-
-For fully-typed events with explicit `action`, `actionSubject`, and `attributes`:
+### Event Tracking with Custom Attributes
 
 ```typescript
 import { useRovoAgentActionAnalytics } from '@atlaskit/rovo-agent-analytics/actions';
@@ -52,15 +64,6 @@ trackAgentEvent({
 });
 ```
 
-### When to use `trackAgentEvent()` vs `trackAgentAction()`
-
-| Use Case | Function |
-| --- | --- |
-| New code (recommended) | `trackAgentEvent()` |
-| Events with custom `actionSubject` | `trackAgentEvent()` |
-| Events with `source`, `objectType`, `objectId`, etc. | `trackAgentEvent()` |
-| Legacy code with default `actionSubject: 'rovoAgent'` | `trackAgentAction()` (deprecated) |
-
 ## Payload Types
 
 Each group file in `src/actions/groups/` exports a **discriminated union payload type** that defines all valid event shapes for that group.
@@ -148,13 +151,25 @@ For actions that need additional attributes:
 }
 ```
 
-## Backwards Compatibility
+## Entry Points
+
+| Entry Point | Description |
+| --- | --- |
+| `@atlaskit/rovo-agent-analytics/actions` | Main entry point — exports `useRovoAgentActionAnalytics` hook |
+| `@atlaskit/rovo-agent-analytics/create` | Create agent flow analytics — exports `useRovoAgentCreateAnalytics` hook and `AgentCreateAction` type |
+
+### Create Flow Analytics
+
+The `useRovoAgentCreateAnalytics` hook is used for tracking the agent creation funnel:
 
-The following exports are **deprecated** but still available for existing consumers:
+```typescript
+import { useRovoAgentCreateAnalytics } from '@atlaskit/rovo-agent-analytics/create';
 
-- `trackAgentAction()` — use `trackAgentEvent()` instead
-- `trackAgentActionError()` — use `trackAgentEvent()` instead  
-- Enum exports (e.g. `AgentEditingActions`, `AgentEvalActions`) — use string literals instead
-- `ActionAttributes` type — use `EventPayload` instead
+const [csid, { trackCreateSession, trackCreateSessionStart }] = useRovoAgentCreateAnalytics({
+  touchPoint: 'agent-studio',
+});
 
-These will be removed in a future major version.
+// Track funnel steps using string literal actions
+trackCreateSession('createFlowStart');
+trackCreateSession('createFlowActivate', { agentType: 'custom' });
+```

package/dist/cjs/actions/groups/add-tools-prompt.js

@@ -1,43 +1 @@
-"use strict";
-
-Object.defineProperty(exports, "__esModule", {
-  value: true
-});
-exports.AddToolsPromptActions = exports.ACTION_GROUP = void 0;
-/**
- * Action Group: addToolsPrompt
- *
- * Add tools prompt modal — shown when a user tries to activate/publish an agent that has no tools.
- * The user can browse tools or dismiss and proceed without them.
- *
- * This group is intentionally flow-agnostic so the action values stay stable
- * regardless of whether the prompt fires from the create flow or a future publish flow.
- *
- * ## Adding a new action
- * 1. Add a new variant to the `AddToolsPromptEventPayload` union type below with a data-portal link
- * 2. If this action doesn't fit this group, consider creating a new group file instead
- *    (see other files in this directory for the template)
- */
-
-/**
- * Discriminated union payload type for add tools prompt events.
- * Use with `trackAgentEvent()`.
- */
-
-// ============================================================================
-// BACKWARDS COMPAT (deprecated): Keep enum and attributes for trackAgentAction() consumers
-// ============================================================================
-
-/** @deprecated Use AddToolsPromptEventPayload with trackAgentEvent() instead */
-var ACTION_GROUP = exports.ACTION_GROUP = 'addToolsPrompt';
-
-/** @deprecated Use AddToolsPromptEventPayload with trackAgentEvent() instead */
-var AddToolsPromptActions = exports.AddToolsPromptActions = /*#__PURE__*/function (AddToolsPromptActions) {
-  /* Add tools prompt shown (agent has no tools) - https://data-portal.internal.atlassian.com/analytics/registry/98106 */
-  AddToolsPromptActions["SHOWN"] = "addToolsPromptShown";
-  /* User clicked "Browse skills" on the add tools prompt - https://data-portal.internal.atlassian.com/analytics/registry/98107 */
-  AddToolsPromptActions["BROWSE"] = "addToolsPromptBrowse";
-  /* User dismissed the add tools prompt ("No thanks") and proceeded anyway - https://data-portal.internal.atlassian.com/analytics/registry/98108 */
-  AddToolsPromptActions["DISMISS"] = "addToolsPromptDismiss";
-  return AddToolsPromptActions;
-}({});
+"use strict";

package/dist/cjs/actions/groups/agent-interactions.js

@@ -2,54 +2,4 @@
 
 Object.defineProperty(exports, "__esModule", {
   value: true
-});
-exports.AgentInteractionActions = exports.ACTION_GROUP = void 0;
-/**
- * Action Group: agentInteractions
- *
- * User-initiated interactions with an agent — typically from the overflow menu ("...")
- * or agent profile surfaces (viewing, editing, deleting, duplicating, starring, sharing, verifying).
- *
- * NOTE: This is about UI interactions, not backend "actions" (which are being replaced by "tools").
- *
- * ## Adding a new action
- * 1. Add a new variant to the `AgentInteractionsEventPayload` union type below with a data-portal link
- * 2. If this action doesn't fit user interactions, create a new group file instead
- *    (see other files in this directory for the template)
- */
-
-/**
- * Discriminated union payload type for agent interaction events.
- * Use with `trackAgentEvent()`.
- */
-
-// ============================================================================
-// BACKWARDS COMPAT (deprecated): Keep enum and attributes for trackAgentAction() consumers
-// ============================================================================
-
-/** @deprecated Use AgentInteractionsEventPayload with trackAgentEvent() instead */
-var ACTION_GROUP = exports.ACTION_GROUP = 'agentInteractions';
-
-/** @deprecated Use AgentInteractionsEventPayload with trackAgentEvent() instead */
-var AgentInteractionActions = exports.AgentInteractionActions = /*#__PURE__*/function (AgentInteractionActions) {
-  /* View agent clicked - https://data-portal.internal.atlassian.com/analytics/registry/97125 */
-  AgentInteractionActions["VIEW"] = "view";
-  /* Edit agent clicked - https://data-portal.internal.atlassian.com/analytics/registry/97126 */
-  AgentInteractionActions["EDIT"] = "edit";
-  /* Copy link clicked - https://data-portal.internal.atlassian.com/analytics/registry/97128 */
-  AgentInteractionActions["COPY_LINK"] = "copyLink";
-  /* Delete agent clicked - https://data-portal.internal.atlassian.com/analytics/registry/97129 */
-  AgentInteractionActions["DELETE"] = "delete";
-  /* Duplicate agent clicked - https://data-portal.internal.atlassian.com/analytics/registry/97130 */
-  AgentInteractionActions["DUPLICATE"] = "duplicate";
-  /* Star agent clicked - https://data-portal.internal.atlassian.com/analytics/registry/97133 */
-  AgentInteractionActions["STAR"] = "star";
-  /* Chat with agent clicked - https://data-portal.internal.atlassian.com/analytics/registry/97095 */
-  AgentInteractionActions["CHAT"] = "chat";
-  /* Verify agent clicked - https://data-portal.internal.atlassian.com/analytics/registry/97134 */
-  AgentInteractionActions["VERIFY"] = "verify";
-  /* Unverify agent clicked - https://data-portal.internal.atlassian.com/analytics/registry/97135 */
-  AgentInteractionActions["UNVERIFY"] = "unverify";
-  return AgentInteractionActions;
-}({});
-/** @deprecated Use AgentInteractionsEventPayload with trackAgentEvent() instead */
+});

package/dist/cjs/actions/groups/create-flow.js

@@ -1,51 +1 @@
-"use strict";
-
-Object.defineProperty(exports, "__esModule", {
-  value: true
-});
-exports.CreateFlowActions = exports.ACTION_GROUP = void 0;
-/**
- * Action Group: createFlow
- *
- * Create agent funnel steps — from clicking "Create agent" through to activation or discard,
- *
- * ## Adding a new action
- * 1. Add a new variant to the `CreateFlowEventPayload` union type below with a data-portal link
- * 2. If this action doesn't fit this group, consider creating a new group file instead
- *    (see other files in this directory for the template)
- */
-
-/**
- * Discriminated union payload type for create flow events.
- * Use with `trackAgentEvent()`.
- */
-
-// ============================================================================
-// BACKWARDS COMPAT (deprecated): Keep enum and attributes for trackAgentAction() consumers
-// ============================================================================
-
-/** @deprecated Use CreateFlowEventPayload with trackAgentEvent() instead */
-var ACTION_GROUP = exports.ACTION_GROUP = 'createFlow';
-
-/** @deprecated Use CreateFlowEventPayload with trackAgentEvent() instead */
-var CreateFlowActions = exports.CreateFlowActions = /*#__PURE__*/function (CreateFlowActions) {
-  /* Start create flow when user clicks on "Create agent" button - https://data-portal.internal.atlassian.com/analytics/registry/97089 */
-  CreateFlowActions["START"] = "createFlowStart";
-  /* Skip natural language - https://data-portal.internal.atlassian.com/analytics/registry/97127 */
-  CreateFlowActions["SKIP_NL"] = "createFlowSkipNL";
-  /* Review natural language - https://data-portal.internal.atlassian.com/analytics/registry/97124 */
-  CreateFlowActions["REVIEW_NL"] = "createFlowReviewNL";
-  /* Activate agent - https://data-portal.internal.atlassian.com/analytics/registry/97123 */
-  CreateFlowActions["ACTIVATE"] = "createFlowActivate";
-  /* Restart create flow - https://data-portal.internal.atlassian.com/analytics/registry/97131 */
-  CreateFlowActions["RESTART"] = "createFlowRestart";
-  /* Error occurred - https://data-portal.internal.atlassian.com/analytics/registry/97132 */
-  CreateFlowActions["ERROR"] = "createFlowError";
-  /* Land in studio - https://data-portal.internal.atlassian.com/analytics/registry/97136 */
-  CreateFlowActions["LAND"] = "createLandInStudio";
-  /* Discard agent - https://data-portal.internal.atlassian.com/analytics/registry/97137 */
-  CreateFlowActions["DISCARD"] = "createDiscard";
-  /* Draft created from solution architect plan card - https://data-portal.internal.atlassian.com/analytics/registry/97924 */
-  CreateFlowActions["SA_DRAFT"] = "saDraft";
-  return CreateFlowActions;
-}({});
+"use strict";

package/dist/cjs/actions/groups/debug.js

@@ -1,42 +1 @@
-"use strict";
-
-Object.defineProperty(exports, "__esModule", {
-  value: true
-});
-exports.AgentDebugActions = exports.ACTION_GROUP = void 0;
-/**
- * Action Group: debug
- *
- * Actions related to the agent debug modal (viewing, copying debug data, toggling skill info).
- *
- * ## Adding a new action
- * 1. Add a new variant to the `DebugEventPayload` union type below with a data-portal link
- * 2. If this action doesn't fit this group, consider creating a new group file instead
- *    (see other files in this directory for the template)
- */
-
-/**
- * Discriminated union payload type for debug events.
- * Use with `trackAgentEvent()`.
- */
-
-// ============================================================================
-// BACKWARDS COMPAT (deprecated): Keep enum and attributes for trackAgentAction() consumers
-// ============================================================================
-
-/** @deprecated Use DebugEventPayload with trackAgentEvent() instead */
-var ACTION_GROUP = exports.ACTION_GROUP = 'debug';
-
-/** @deprecated Use DebugEventPayload with trackAgentEvent() instead */
-var AgentDebugActions = exports.AgentDebugActions = /*#__PURE__*/function (AgentDebugActions) {
-  /* View debug modal - https://data-portal.internal.atlassian.com/analytics/registry/97183 */
-  AgentDebugActions["VIEW"] = "debugView";
-  /* Copy all debug data - https://data-portal.internal.atlassian.com/analytics/registry/97186 */
-  AgentDebugActions["COPY_ALL"] = "debugCopyAll";
-  /* Copy debug data - https://data-portal.internal.atlassian.com/analytics/registry/97184 */
-  AgentDebugActions["COPY"] = "debugCopy";
-  /* Toggle skill info - https://data-portal.internal.atlassian.com/analytics/registry/97185 */
-  AgentDebugActions["TOGGLE_SKILL_INFO"] = "debugToggleSkillInfo";
-  return AgentDebugActions;
-}({});
-/** @deprecated Use DebugEventPayload with trackAgentEvent() instead */
+"use strict";

package/dist/cjs/actions/groups/editing.js

@@ -2,31 +2,4 @@
 
 Object.defineProperty(exports, "__esModule", {
   value: true
-});
-exports.AgentEditingActions = exports.ACTION_GROUP = void 0;
-/**
- * Action Group: editing
- *
- * Agent editing/mutation events — fired when an agent's configuration is saved or modified.
- * Unlike agentInteractions (user clicks), these track actual data changes.
- *
- * ## Adding a new action
- * 1. Add a new variant to the `EditingEventPayload` union type below with a data-portal link
- * 2. If this action doesn't fit editing/mutation events, create a new group file instead
- *    (see other files in this directory for the template)
- */
-
-// ============================================================================
-// BACKWARDS COMPAT (deprecated): Keep enum and attributes for trackAgentAction() consumers
-// ============================================================================
-
-/** @deprecated Use EditingEventPayload with trackAgentEvent() instead */
-var ACTION_GROUP = exports.ACTION_GROUP = 'editing';
-
-/** @deprecated Use EditingEventPayload with trackAgentEvent() instead */
-var AgentEditingActions = exports.AgentEditingActions = /*#__PURE__*/function (AgentEditingActions) {
-  /* Agent updated - https://data-portal.internal.atlassian.com/analytics/registry/97122 */
-  AgentEditingActions["UPDATED"] = "updated";
-  return AgentEditingActions;
-}({});
-/** @deprecated Use EditingEventPayload with trackAgentEvent() instead */
+});

package/dist/cjs/actions/groups/tools.js

@@ -2,39 +2,4 @@
 
 Object.defineProperty(exports, "__esModule", {
   value: true
-});
-exports.AgentToolActions = exports.ACTION_GROUP = void 0;
-/**
- * Action Group: tools
- *
- * Actions related to agent tool execution during chat
- * (confirming, streaming, viewing results, errors).
- *
- * ## Adding a new action
- * 1. Add a new variant to the `ToolsEventPayload` union type below with a data-portal link
- * 2. If this action doesn't fit this group, consider creating a new group file instead
- *    (see other files in this directory for the template)
- */
-
-// ============================================================================
-// BACKWARDS COMPAT (deprecated): Keep enum and attributes for trackAgentAction() consumers
-// ============================================================================
-
-/** @deprecated Use ToolsEventPayload with trackAgentEvent() instead */
-var ACTION_GROUP = exports.ACTION_GROUP = 'tools';
-
-/** @deprecated Use ToolsEventPayload with trackAgentEvent() instead */
-var AgentToolActions = exports.AgentToolActions = /*#__PURE__*/function (AgentToolActions) {
-  /* When chatting with an agent, and tools confirmation being shown, then user click proceed with the possible actions (e.g. confirm, dismiss etc) https://data-portal.internal.atlassian.com/analytics/registry/97675 */
-  AgentToolActions["TOOLS_EXECUTION_CONFIRMED"] = "toolsExecutionConfirmed";
-  /* When tools execution result is being streamed and user stops the stream e.g. by clicking stop button https://data-portal.internal.atlassian.com/analytics/registry/97750 */
-  AgentToolActions["TOOLS_EXECUTION_STREAM_STOPPED"] = "toolsExecutionStreamStopped";
-  /* When tools execution result is done streaming and user sees the result https://data-portal.internal.atlassian.com/analytics/registry/97751*/
-  AgentToolActions["TOOLS_EXECUTION_RESULT_VIEWED"] = "toolsExecutionResultViewed";
-  /* When tools execution result streaming fails https://data-portal.internal.atlassian.com/analytics/registry/97752 */
-  AgentToolActions["TOOLS_EXECUTION_RESULT_ERROR"] = "toolsExecutionResultError";
-  return AgentToolActions;
-}({});
-/** @deprecated Use ToolsEventPayload with trackAgentEvent() instead */
-/** @deprecated Use ToolsEventPayload with trackAgentEvent() instead */
-/** @deprecated Use ToolsEventPayload with trackAgentEvent() instead */
+});

package/dist/cjs/actions/index.js

@@ -4,7 +4,7 @@ var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefau
 Object.defineProperty(exports, "__esModule", {
   value: true
 });
-exports.useRovoAgentActionAnalytics = exports.AgentDebugActions = exports.AgentCommonActions = void 0;
+exports.useRovoAgentActionAnalytics = void 0;
 var _objectWithoutProperties2 = _interopRequireDefault(require("@babel/runtime/helpers/objectWithoutProperties"));
 var _defineProperty2 = _interopRequireDefault(require("@babel/runtime/helpers/defineProperty"));
 var _react = require("react");
@@ -12,19 +12,9 @@ var _analyticsNext = require("@atlaskit/analytics-next");
 var _constants = require("../common/constants");
 var _types = require("../common/types");
 var _utils = require("../common/utils");
-var _agentInteractions = require("./groups/agent-interactions");
-var _debug = require("./groups/debug");
-var _editing = require("./groups/editing");
-var _registry = require("./registry");
 var _excluded = ["action", "actionSubject", "attributes"];
 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; }
-// Backward-compatible aliases
-// TODO: migrate consumers to use group-specific imports, then remove
-var AgentCommonActions = exports.AgentCommonActions = _objectSpread(_objectSpread({}, _agentInteractions.AgentInteractionActions), _editing.AgentEditingActions);
-
-// TODO: Remove the alias, will be breaking change, this is just for backward compatibility
-var AgentDebugActions = exports.AgentDebugActions = _debug.AgentDebugActions;
 var globalEventConfig = (0, _utils.getDefaultTrackEventConfig)();
 var useRovoAgentActionAnalytics = exports.useRovoAgentActionAnalytics = function useRovoAgentActionAnalytics(commonAttributes) {
   var analyticsContext = (0, _react.useContext)(_analyticsNext.AnalyticsReactContext);
@@ -41,20 +31,6 @@ var useRovoAgentActionAnalytics = exports.useRovoAgentActionAnalytics = function
   }, [createAnalyticsEvent, analyticsContext] // keep number of dependencies minimal to prevent re-rendering
   );
 
-  /**
-   * Simple tracking of just action + attributes only.
-   * Uses default actionSubject ('rovoAgent').
-   *
-   * @deprecated Use trackAgentEvent() with typed payloads instead
-   */
-  var trackAgentAction = (0, _react.useCallback)(function (action, attributes) {
-    fireAnalyticsEvent({
-      actionSubject: _registry.DefaultActionSubject,
-      action: action,
-      attributes: attributes
-    });
-  }, [fireAnalyticsEvent]);
-
   /**
    * Fully-typed event tracking using discriminated union payload types.
    * The payload type enforces correct action, actionSubject, and attributes.
@@ -71,24 +47,7 @@ var useRovoAgentActionAnalytics = exports.useRovoAgentActionAnalytics = function
       attributes: attributes
     }));
   }, [fireAnalyticsEvent]);
-
-  /**
-   * @deprecated Use trackAgentEvent() with typed payloads instead
-   */
-  var trackAgentActionError = (0, _react.useCallback)(function (action, error, attributes) {
-    fireAnalyticsEvent({
-      actionSubject: 'rovoAgentError',
-      action: action,
-      attributes: _objectSpread(_objectSpread({}, attributes), {}, {
-        error: {
-          message: error.message
-        }
-      })
-    });
-  }, [fireAnalyticsEvent]);
   return {
-    trackAgentAction: trackAgentAction,
-    trackAgentEvent: trackAgentEvent,
-    trackAgentActionError: trackAgentActionError
+    trackAgentEvent: trackAgentEvent
   };
 };

package/dist/cjs/common/csid/index.js

@@ -12,46 +12,35 @@ var CACHED_CSID = null;
 var generateCSID = function generateCSID() {
   return crypto.randomUUID();
 };
-var retrieveCSID = function retrieveCSID() {
-  if (CACHED_CSID) {
-    return CACHED_CSID;
-  }
-  var queryParams = new URLSearchParams(window.location.search);
-  var querySessionId = queryParams.get(_constants.CSID_QUERY_PARAM);
-  return querySessionId !== null && querySessionId !== void 0 ? querySessionId : generateCSID();
-};
 
 /**
- * Hook to get Rovo Agent Create Session ID (CSID) from the query parameters or generate a new one if not found.
- * @returns Rovo Agent CSID as a string.
+ * Hook to manage CSID state for entry point components.
+ * The returned csid is used in href attributes and by trackCreateSessionStart.
+ * After trackCreateSessionStart fires, it calls refresh() to generate a new CSID
+ * for the next session — the component re-renders and the href updates.
  */
 var useRovoAgentCSID = exports.useRovoAgentCSID = function useRovoAgentCSID() {
-  var _useState = (0, _react.useState)(retrieveCSID()),
+  var _useState = (0, _react.useState)(CACHED_CSID || generateCSID()),
     _useState2 = (0, _slicedToArray2.default)(_useState, 2),
-    CSID = _useState2[0],
+    csid = _useState2[0],
     setCSID = _useState2[1];
+  var globalCSID = (0, _react.useMemo)(function () {
+    var queryParams = new URLSearchParams(window.location.search);
+    return queryParams.get(_constants.CSID_QUERY_PARAM);
+  }, []);
   var actions = (0, _react.useMemo)(function () {
     return {
       refresh: function refresh() {
         var newCSID = generateCSID();
         setCSID(newCSID);
+        CACHED_CSID = newCSID;
         return newCSID;
-      },
-      clear: function clear() {
-        // remove CSID query parameter
-        var url = new URL(window.location.href);
-        url.searchParams.delete(_constants.CSID_QUERY_PARAM);
-        window.history.replaceState({}, '', url.toString());
-
-        // reset state
-        setCSID(null);
-        return null;
       }
     };
   }, []);
-  (0, _react.useEffect)(function () {
-    // sync cache on state change
-    CACHED_CSID = CSID;
-  }, [CSID]);
-  return [CSID, actions];
+  return [{
+    csid: csid,
+    // generated CSID to be used in href and createFlowStart events
+    globalCSID: globalCSID // CSID from the URL query parameter
+  }, actions];
 };

package/dist/cjs/common/types.js

@@ -7,6 +7,11 @@ exports.LIBRARY_ATTRIBUTE = void 0;
 /** Common library attribute injected into all events */
 var LIBRARY_ATTRIBUTE = exports.LIBRARY_ATTRIBUTE = 'agents-analytics';
 
+/**
+ * Generic error event payload type.
+ * Use with `trackAgentEvent()` to track error events.
+ */
+
 /**
  * Union of all event payload types.
  * Use with `trackAgentEvent()` for typed event tracking.