chore: rename UserActionSeverity to UserActionImportance

.github/workflows/release.yml

@@ -71,6 +71,7 @@ jobs:
         uses: actions/setup-node@v5
         with:
           node-version: 'lts/*'
+          cache: 'none'
 
       - name: Install dependencies
         run: yarn install --frozen-lockfile

packages/core/src/api/index.ts

@@ -23,7 +23,7 @@ export type { MeasurementEvent, MeasurementsAPI, PushMeasurementOptions } from '
 export type { MetaAPI } from './meta';
 
 export {
-  UserActionSeverity,
+  UserActionImportance,
   UserActionState,
   type UserActionInterface,
   type UserActionsAPI,

packages/core/src/api/userActions/const.ts

@@ -2,7 +2,7 @@ export const userActionStartByApiCallEventName = 'faroApiCall';
 
 export const userActionStart = 'user_action_start';
 
-export enum UserActionSeverity {
+export enum UserActionImportance {
   Normal = 'normal',
   Critical = 'critical',
 }

packages/core/src/api/userActions/index.ts

@@ -1,4 +1,4 @@
 export { type UserActionsAPI, UserActionState, type UserActionInterface } from './types';
-export { UserActionSeverity } from './const';
+export { UserActionImportance } from './const';
 
 export { initializeUserActionsAPI, userActionsMessageBus } from './initialize';

packages/core/src/api/userActions/initialize.test.ts

@@ -1,4 +1,4 @@
-import { faro, UserActionSeverity } from '../..';
+import { faro, UserActionImportance } from '../..';
 import { mockConfig, mockInternalLogger } from '../../testUtils';
 import { mockTransports } from '../apiTestHelpers';
 
@@ -28,6 +28,7 @@ describe('initializeUserActionsAPI', () => {
     });
     internalLogger = mockInternalLogger;
     api = initializeUserActionsAPI({ transports, config, internalLogger });
+    jest.resetAllMocks();
   });
 
   it('getActiveUserAction returns undefined before any action is created', () => {
@@ -40,9 +41,9 @@ describe('initializeUserActionsAPI', () => {
     expect(api.getActiveUserAction()).toBe(action);
   });
 
-  it('startUserAction has custom severity and trigger set', () => {
+  it('startUserAction has custom importance and trigger set', () => {
     const action = api.startUserAction('first', undefined, {
-      severity: UserActionSeverity.Critical,
+      importance: UserActionImportance.Critical,
       triggerName: 'foo',
     });
     expect(action).toBeInstanceOf(UserAction);
@@ -55,7 +56,28 @@ describe('initializeUserActionsAPI', () => {
     expect(faro.api.pushEvent).toHaveBeenCalledTimes(1);
     expect(faro.api.pushEvent).toHaveBeenCalledWith(
       expect.any(String),
-      expect.objectContaining({ userActionSeverity: 'critical', userActionTrigger: 'foo' }),
+      expect.objectContaining({ userActionImportance: 'critical', userActionTrigger: 'foo' }),
+      undefined,
+      expect.any(Object)
+    );
+  });
+
+  it('startUserAction has custom severity (converts to importance) and trigger set', () => {
+    const action = api.startUserAction('second', undefined, {
+      severity: UserActionImportance.Critical,
+      triggerName: 'foo',
+    });
+    expect(action).toBeInstanceOf(UserAction);
+
+    const activeAction = api.getActiveUserAction();
+    expect(activeAction).toBe(action);
+
+    activeAction?.end();
+
+    expect(faro.api.pushEvent).toHaveBeenCalledTimes(1);
+    expect(faro.api.pushEvent).toHaveBeenCalledWith(
+      expect.any(String),
+      expect.objectContaining({ userActionImportance: 'critical', userActionTrigger: 'foo' }),
       undefined,
       expect.any(Object)
     );

packages/core/src/api/userActions/initialize.ts

@@ -2,7 +2,7 @@ import { type InternalLogger, type Transports } from '../..';
 import type { Config } from '../../config';
 import { Observable } from '../../utils/reactive';
 
-import { UserActionSeverity, userActionStart, userActionStartByApiCallEventName } from './const';
+import { UserActionImportance, userActionStart, userActionStartByApiCallEventName } from './const';
 import {
   type StartUserActionOptions,
   type UserActionInterface,
@@ -44,7 +44,8 @@ export function initializeUserActionsAPI({
         transports,
         attributes,
         trigger: options?.triggerName || userActionStartByApiCallEventName,
-        severity: options?.severity || UserActionSeverity.Normal,
+        importance: options?.importance || options?.severity || UserActionImportance.Normal,
+        severity: options?.importance || options?.severity || UserActionImportance.Normal,
         trackUserActionsExcludeItem,
       });
       userAction

packages/core/src/api/userActions/types.ts

@@ -1,6 +1,6 @@
 import { type TransportItem } from '../../transports';
 
-import { UserActionSeverity, userActionStartByApiCallEventName } from './const';
+import { UserActionImportance, userActionStartByApiCallEventName } from './const';
 
 export enum UserActionState {
   Started,
@@ -40,7 +40,11 @@ export type EndUserActionProps = {
 
 export type StartUserActionOptions = {
   triggerName?: string;
-  severity?: UserActionSeverity;
+  importance?: UserActionImportance;
+  /**
+   * @deprecated Use importance instead
+   */
+  severity?: UserActionImportance;
 };
 
 export interface UserActionsAPI {

packages/core/src/api/userActions/userAction.ts

@@ -6,7 +6,7 @@ import { ItemBuffer } from '../ItemBuffer';
 import { type MeasurementEvent } from '../measurements';
 import { type APIEvent } from '../types';
 
-import { UserActionSeverity } from './const';
+import { UserActionImportance } from './const';
 import { type HaltPredicate, type UserActionInterface, UserActionState } from './types';
 
 const defaultFollowUpActionTimeRange = 100;
@@ -18,7 +18,11 @@ export default class UserAction extends Observable implements UserActionInterfac
   attributes?: Record<string, string>;
   parentId: string;
   trigger: string;
-  severity: UserActionSeverity;
+  importance: UserActionImportance;
+  /**
+   * @deprecated Use importance instead
+   */
+  severity?: UserActionImportance;
   startTime?: number;
   trackUserActionsExcludeItem?: (item: TransportItem<APIEvent>) => boolean;
   cancelTimeout: number;
@@ -39,7 +43,8 @@ export default class UserAction extends Observable implements UserActionInterfac
     transports,
     attributes,
     trackUserActionsExcludeItem,
-    severity = UserActionSeverity.Normal,
+    importance = UserActionImportance.Normal,
+    severity = UserActionImportance.Normal,
   }: {
     name: string;
     transports: Transports;
@@ -48,7 +53,11 @@ export default class UserAction extends Observable implements UserActionInterfac
     attributes?: Record<string, string>;
     haltTimeout?: number;
     trackUserActionsExcludeItem?: (item: TransportItem<APIEvent>) => boolean;
-    severity?: UserActionSeverity;
+    importance?: UserActionImportance;
+    /**
+     * @deprecated Use importance instead
+     */
+    severity?: UserActionImportance;
   }) {
     super();
     this.name = name;
@@ -59,7 +68,8 @@ export default class UserAction extends Observable implements UserActionInterfac
     this.haltTimeout = haltTimeout ?? defaultHaltTimeout;
     this.parentId = parentId ?? this.id;
     this.trackUserActionsExcludeItem = trackUserActionsExcludeItem;
-    this.severity = severity;
+    this.importance = importance || severity;
+    this.severity = this.importance;
 
     this._itemBuffer = new ItemBuffer<TransportItem>();
     this._transports = transports;
@@ -170,7 +180,7 @@ export default class UserAction extends Observable implements UserActionInterfac
         userActionEndTime: endTime.toString(),
         userActionDuration: duration.toString(),
         userActionTrigger: this.trigger!,
-        userActionSeverity: this.severity,
+        userActionImportance: this.importance,
         ...stringifyObjectValues(this.attributes),
       },
       undefined,

packages/core/src/index.ts

@@ -2,7 +2,11 @@ export {
   defaultExceptionType,
   defaultLogArgsSerializer,
   defaultErrorArgsSerializer,
-  UserActionSeverity,
+  UserActionImportance,
+  /**
+   * @deprecated Use UserActionImportance instead
+   */
+  UserActionImportance as UserActionSeverity,
   UserActionState,
   userActionsMessageBus,
 } from './api';

packages/react/src/index.ts

@@ -193,5 +193,5 @@ export type {
   Transports,
   UnpatchedConsole,
   ExceptionEventExtended,
-  UserActionSeverity,
+  UserActionImportance,
 } from '@grafana/faro-web-sdk';

packages/web-sdk/src/index.ts

@@ -161,7 +161,7 @@ export type {
   TransportItemPayload,
   Transports,
   UnpatchedConsole,
-  UserActionSeverity,
+  UserActionImportance,
 } from '@grafana/faro-core';
 
 export {