[RUM-10511] Add user story vital type (#286)

* feat:add user story

* Update lib/cjs/generated/rum.d.ts

Co-authored-by: Benoît <[email protected]>

* fix: naming

* build

* fix: add latest failure reason

* feat: update naming and description

* fix: build

* fix: use update instead of touch

---------

Co-authored-by: Benoît <[email protected]>

Author: cy-moi

lib/cjs/generated/rum.d.ts

@@ -1154,11 +1154,15 @@ export declare type RumVitalEvent = CommonProperties & ViewContainerSchema & {
         /**
          * Type of the vital
          */
-        readonly type: 'duration';
+        readonly type: 'duration' | 'step';
         /**
          * UUID of the vital
          */
         readonly id: string;
+        /**
+         * UUID for linking the step vital to the parent event, if applicable
+         */
+        readonly parent_id?: string;
         /**
          * Name of the vital, as it is also used as facet path for its value, it must contain only letters, digits, or the characters - _ . @ $
          */
@@ -1177,6 +1181,14 @@ export declare type RumVitalEvent = CommonProperties & ViewContainerSchema & {
         readonly custom?: {
             [k: string]: number;
         };
+        /**
+         * Type of the step that triggered the vital, if applicable
+         */
+        readonly step_type?: 'start' | 'update' | 'retry' | 'end';
+        /**
+         * Reason for the failure of the step, if applicable
+         */
+        readonly failure_reason?: 'error' | 'abandoned' | 'other';
         [k: string]: unknown;
     };
     /**

lib/esm/generated/rum.d.ts

@@ -1154,11 +1154,15 @@ export declare type RumVitalEvent = CommonProperties & ViewContainerSchema & {
         /**
          * Type of the vital
          */
-        readonly type: 'duration';
+        readonly type: 'duration' | 'step';
         /**
          * UUID of the vital
          */
         readonly id: string;
+        /**
+         * UUID for linking the step vital to the parent event, if applicable
+         */
+        readonly parent_id?: string;
         /**
          * Name of the vital, as it is also used as facet path for its value, it must contain only letters, digits, or the characters - _ . @ $
          */
@@ -1177,6 +1181,14 @@ export declare type RumVitalEvent = CommonProperties & ViewContainerSchema & {
         readonly custom?: {
             [k: string]: number;
         };
+        /**
+         * Type of the step that triggered the vital, if applicable
+         */
+        readonly step_type?: 'start' | 'update' | 'retry' | 'end';
+        /**
+         * Reason for the failure of the step, if applicable
+         */
+        readonly failure_reason?: 'error' | 'abandoned' | 'other';
         [k: string]: unknown;
     };
     /**

schemas/rum/vital-schema.json

@@ -28,7 +28,7 @@
             "type": {
               "type": "string",
               "description": "Type of the vital",
-              "enum": ["duration"],
+              "enum": ["duration", "step"],
               "readOnly": true
             },
             "id": {
@@ -37,6 +37,12 @@
               "pattern": "^[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}$",
               "readOnly": true
             },
+            "parent_id": {
+              "type": "string",
+              "description": "UUID for linking the step vital to the parent event, if applicable",
+              "pattern": "^[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}$",
+              "readOnly": true
+            },
             "name": {
               "type": "string",
               "description": "Name of the vital, as it is also used as facet path for its value, it must contain only letters, digits, or the characters - _ . @ $",
@@ -61,6 +67,18 @@
                 "readOnly": true
               },
               "readOnly": true
+            },
+            "step_type": {
+              "type": "string",
+              "description": "Type of the step that triggered the vital, if applicable",
+              "enum": ["start", "update", "retry", "end"],
+              "readOnly": true
+            },
+            "failure_reason": {
+              "type": "string",
+              "description": "Reason for the failure of the step, if applicable",
+              "enum": ["error", "abandoned", "other"],
+              "readOnly": true
             }
           },
           "readOnly": true