PANA-5615: Add mobile ui element identifier (#341)

Author: jonathanmos

lib/cjs/generated/mobileSessionReplay.d.ts

@@ -541,6 +541,10 @@ export interface CommonWireframe {
      */
     readonly height: number;
     clip?: WireframeClip;
+    /**
+     * A globally unique and stable identifier for this UI element, computed as the hash of the element's path (32 lowercase hex characters). Used to correlate wireframes with RUM action events.
+     */
+    readonly permanentId?: string;
 }
 /**
  * Schema of clipping information for a Wireframe.

lib/cjs/generated/rum.d.ts

@@ -131,6 +131,10 @@ export type RumActionEvent = CommonProperties & ViewContainerSchema & {
                  * CSS selector path of the target element
                  */
                 readonly selector?: string;
+                /**
+                 * Mobile-only: a globally unique and stable identifier for this UI element, computed as the hash of the element's path (32 lowercase hex characters). Used to correlate actions with mobile session replay wireframes.
+                 */
+                readonly permanent_id?: string;
                 /**
                  * Width of the target element (in pixels)
                  */

lib/cjs/generated/sessionReplay.d.ts

@@ -1347,6 +1347,10 @@ export interface CommonWireframe {
      */
     readonly height: number;
     clip?: WireframeClip;
+    /**
+     * A globally unique and stable identifier for this UI element, computed as the hash of the element's path (32 lowercase hex characters). Used to correlate wireframes with RUM action events.
+     */
+    readonly permanentId?: string;
 }
 /**
  * Schema of clipping information for a Wireframe.

lib/esm/generated/mobileSessionReplay.d.ts

@@ -541,6 +541,10 @@ export interface CommonWireframe {
      */
     readonly height: number;
     clip?: WireframeClip;
+    /**
+     * A globally unique and stable identifier for this UI element, computed as the hash of the element's path (32 lowercase hex characters). Used to correlate wireframes with RUM action events.
+     */
+    readonly permanentId?: string;
 }
 /**
  * Schema of clipping information for a Wireframe.

lib/esm/generated/rum.d.ts

@@ -131,6 +131,10 @@ export type RumActionEvent = CommonProperties & ViewContainerSchema & {
                  * CSS selector path of the target element
                  */
                 readonly selector?: string;
+                /**
+                 * Mobile-only: a globally unique and stable identifier for this UI element, computed as the hash of the element's path (32 lowercase hex characters). Used to correlate actions with mobile session replay wireframes.
+                 */
+                readonly permanent_id?: string;
                 /**
                  * Width of the target element (in pixels)
                  */

lib/esm/generated/sessionReplay.d.ts

@@ -1347,6 +1347,10 @@ export interface CommonWireframe {
      */
     readonly height: number;
     clip?: WireframeClip;
+    /**
+     * A globally unique and stable identifier for this UI element, computed as the hash of the element's path (32 lowercase hex characters). Used to correlate wireframes with RUM action events.
+     */
+    readonly permanentId?: string;
 }
 /**
  * Schema of clipping information for a Wireframe.

schemas/rum/action-schema.json

@@ -180,6 +180,11 @@
                       "description": "CSS selector path of the target element",
                       "readOnly": true
                     },
+                    "permanent_id": {
+                      "type": "string",
+                      "description": "Mobile-only: a globally unique and stable identifier for this UI element, computed as the hash of the element's path (32 lowercase hex characters). Used to correlate actions with mobile session replay wireframes.",
+                      "readOnly": true
+                    },
                     "width": {
                       "type": "integer",
                       "description": "Width of the target element (in pixels)",

schemas/session-replay/mobile/_common-wireframe-schema.json

@@ -33,6 +33,11 @@
     },
     "clip": {
       "$ref": "wireframe-clip-schema.json"
+    },
+    "permanentId": {
+      "type": "string",
+      "description": "A globally unique and stable identifier for this UI element, computed as the hash of the element's path (32 lowercase hex characters). Used to correlate wireframes with RUM action events.",
+      "readOnly": true
     }
   }
 }