introduce webview wireframe

DataDog · Oct 12, 2023 · cd68550 · cd68550
1 parent f693b8d
commit cd68550
Show file tree

Hide file tree

Showing 8 changed files with 174 additions and 8 deletions.
diff --git a/lib/cjs/generated/mobileSessionReplay.d.ts b/lib/cjs/generated/mobileSessionReplay.d.ts
@@ -41,7 +41,7 @@ export declare type MobileFullSnapshotRecord = CommonRecordSchema & {
 /**
  * Schema of a Wireframe type.
  */
-export declare type Wireframe = ShapeWireframe | TextWireframe | ImageWireframe | PlaceholderWireframe;
+export declare type Wireframe = ShapeWireframe | TextWireframe | ImageWireframe | PlaceholderWireframe | WebviewWireframe;
 /**
  * Schema of all properties of a ShapeWireframe.
  */
@@ -187,6 +187,19 @@ export declare type PlaceholderWireframe = CommonWireframe & {
      */
     label?: string;
 };
+/**
+ * Schema of all properties of a WebviewWireframe.
+ */
+export declare type WebviewWireframe = CommonShapeWireframe & {
+    /**
+     * The type of the wireframe.
+     */
+    readonly type: 'webview';
+    /**
+     * Defines the unique ID of the webview.
+     */
+    readonly webViewId: number;
+};
 /**
  * Mobile-specific. Schema of a Record type which contains mutations of a screen.
  */
@@ -241,7 +254,7 @@ export declare type MobileMutationPayload = {
 /**
  * Schema of a WireframeUpdateMutation type.
  */
-export declare type WireframeUpdateMutation = TextWireframeUpdate | ShapeWireframeUpdate | ImageWireframeUpdate | PlaceholderWireframeUpdate;
+export declare type WireframeUpdateMutation = TextWireframeUpdate | ShapeWireframeUpdate | ImageWireframeUpdate | PlaceholderWireframeUpdate | WebviewWireframeUpdate;
 /**
  * Schema of all properties of a TextWireframeUpdate.
  */
@@ -307,6 +320,19 @@ export declare type PlaceholderWireframeUpdate = CommonWireframeUpdate & {
      */
     label?: string;
 };
+/**
+ * Schema of all properties of a WebviewWireframeUpdate.
+ */
+export declare type WebviewWireframeUpdate = CommonShapeWireframeUpdate & {
+    /**
+     * The type of the wireframe.
+     */
+    readonly type: 'webview';
+    /**
+     * Defines the unique ID of the webview.
+     */
+    readonly webViewId: number;
+};
 /**
  * Schema of a TouchData.
  */

diff --git a/lib/cjs/generated/sessionReplay.d.ts b/lib/cjs/generated/sessionReplay.d.ts
@@ -342,7 +342,7 @@ export declare type MobileFullSnapshotRecord = CommonRecordSchema & {
 /**
  * Schema of a Wireframe type.
  */
-export declare type Wireframe = ShapeWireframe | TextWireframe | ImageWireframe | PlaceholderWireframe;
+export declare type Wireframe = ShapeWireframe | TextWireframe | ImageWireframe | PlaceholderWireframe | WebviewWireframe;
 /**
  * Schema of all properties of a ShapeWireframe.
  */
@@ -488,6 +488,19 @@ export declare type PlaceholderWireframe = CommonWireframe & {
      */
     label?: string;
 };
+/**
+ * Schema of all properties of a WebviewWireframe.
+ */
+export declare type WebviewWireframe = CommonShapeWireframe & {
+    /**
+     * The type of the wireframe.
+     */
+    readonly type: 'webview';
+    /**
+     * Defines the unique ID of the webview.
+     */
+    readonly webViewId: number;
+};
 /**
  * Mobile-specific. Schema of a Record type which contains mutations of a screen.
  */
@@ -542,7 +555,7 @@ export declare type MobileMutationPayload = {
 /**
  * Schema of a WireframeUpdateMutation type.
  */
-export declare type WireframeUpdateMutation = TextWireframeUpdate | ShapeWireframeUpdate | ImageWireframeUpdate | PlaceholderWireframeUpdate;
+export declare type WireframeUpdateMutation = TextWireframeUpdate | ShapeWireframeUpdate | ImageWireframeUpdate | PlaceholderWireframeUpdate | WebviewWireframeUpdate;
 /**
  * Schema of all properties of a TextWireframeUpdate.
  */
@@ -608,6 +621,19 @@ export declare type PlaceholderWireframeUpdate = CommonWireframeUpdate & {
      */
     label?: string;
 };
+/**
+ * Schema of all properties of a WebviewWireframeUpdate.
+ */
+export declare type WebviewWireframeUpdate = CommonShapeWireframeUpdate & {
+    /**
+     * The type of the wireframe.
+     */
+    readonly type: 'webview';
+    /**
+     * Defines the unique ID of the webview.
+     */
+    readonly webViewId: number;
+};
 /**
  * Schema of a TouchData.
  */

diff --git a/lib/esm/generated/mobileSessionReplay.d.ts b/lib/esm/generated/mobileSessionReplay.d.ts
@@ -41,7 +41,7 @@ export declare type MobileFullSnapshotRecord = CommonRecordSchema & {
 /**
  * Schema of a Wireframe type.
  */
-export declare type Wireframe = ShapeWireframe | TextWireframe | ImageWireframe | PlaceholderWireframe;
+export declare type Wireframe = ShapeWireframe | TextWireframe | ImageWireframe | PlaceholderWireframe | WebviewWireframe;
 /**
  * Schema of all properties of a ShapeWireframe.
  */
@@ -187,6 +187,19 @@ export declare type PlaceholderWireframe = CommonWireframe & {
      */
     label?: string;
 };
+/**
+ * Schema of all properties of a WebviewWireframe.
+ */
+export declare type WebviewWireframe = CommonShapeWireframe & {
+    /**
+     * The type of the wireframe.
+     */
+    readonly type: 'webview';
+    /**
+     * Defines the unique ID of the webview.
+     */
+    readonly webViewId: number;
+};
 /**
  * Mobile-specific. Schema of a Record type which contains mutations of a screen.
  */
@@ -241,7 +254,7 @@ export declare type MobileMutationPayload = {
 /**
  * Schema of a WireframeUpdateMutation type.
  */
-export declare type WireframeUpdateMutation = TextWireframeUpdate | ShapeWireframeUpdate | ImageWireframeUpdate | PlaceholderWireframeUpdate;
+export declare type WireframeUpdateMutation = TextWireframeUpdate | ShapeWireframeUpdate | ImageWireframeUpdate | PlaceholderWireframeUpdate | WebviewWireframeUpdate;
 /**
  * Schema of all properties of a TextWireframeUpdate.
  */
@@ -307,6 +320,19 @@ export declare type PlaceholderWireframeUpdate = CommonWireframeUpdate & {
      */
     label?: string;
 };
+/**
+ * Schema of all properties of a WebviewWireframeUpdate.
+ */
+export declare type WebviewWireframeUpdate = CommonShapeWireframeUpdate & {
+    /**
+     * The type of the wireframe.
+     */
+    readonly type: 'webview';
+    /**
+     * Defines the unique ID of the webview.
+     */
+    readonly webViewId: number;
+};
 /**
  * Schema of a TouchData.
  */

diff --git a/lib/esm/generated/sessionReplay.d.ts b/lib/esm/generated/sessionReplay.d.ts
@@ -342,7 +342,7 @@ export declare type MobileFullSnapshotRecord = CommonRecordSchema & {
 /**
  * Schema of a Wireframe type.
  */
-export declare type Wireframe = ShapeWireframe | TextWireframe | ImageWireframe | PlaceholderWireframe;
+export declare type Wireframe = ShapeWireframe | TextWireframe | ImageWireframe | PlaceholderWireframe | WebviewWireframe;
 /**
  * Schema of all properties of a ShapeWireframe.
  */
@@ -488,6 +488,19 @@ export declare type PlaceholderWireframe = CommonWireframe & {
      */
     label?: string;
 };
+/**
+ * Schema of all properties of a WebviewWireframe.
+ */
+export declare type WebviewWireframe = CommonShapeWireframe & {
+    /**
+     * The type of the wireframe.
+     */
+    readonly type: 'webview';
+    /**
+     * Defines the unique ID of the webview.
+     */
+    readonly webViewId: number;
+};
 /**
  * Mobile-specific. Schema of a Record type which contains mutations of a screen.
  */
@@ -542,7 +555,7 @@ export declare type MobileMutationPayload = {
 /**
  * Schema of a WireframeUpdateMutation type.
  */
-export declare type WireframeUpdateMutation = TextWireframeUpdate | ShapeWireframeUpdate | ImageWireframeUpdate | PlaceholderWireframeUpdate;
+export declare type WireframeUpdateMutation = TextWireframeUpdate | ShapeWireframeUpdate | ImageWireframeUpdate | PlaceholderWireframeUpdate | WebviewWireframeUpdate;
 /**
  * Schema of all properties of a TextWireframeUpdate.
  */
@@ -608,6 +621,19 @@ export declare type PlaceholderWireframeUpdate = CommonWireframeUpdate & {
      */
     label?: string;
 };
+/**
+ * Schema of all properties of a WebviewWireframeUpdate.
+ */
+export declare type WebviewWireframeUpdate = CommonShapeWireframeUpdate & {
+    /**
+     * The type of the wireframe.
+     */
+    readonly type: 'webview';
+    /**
+     * Defines the unique ID of the webview.
+     */
+    readonly webViewId: number;
+};
 /**
  * Schema of a TouchData.
  */

diff --git a/schemas/session-replay/mobile/webview-wireframe-schema.json b/schemas/session-replay/mobile/webview-wireframe-schema.json
@@ -0,0 +1,28 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema",
+  "$id": "session-replay/mobile/webview-wireframe-schema.json",
+  "title": "WebviewWireframe",
+  "type": "object",
+  "description": "Schema of all properties of a WebviewWireframe.",
+  "allOf": [
+    {
+      "$ref": "_common-shape-wireframe-schema.json"
+    },
+    {
+      "required": ["type", "webViewId"],
+      "properties": {
+        "type": {
+          "type": "string",
+          "description": "The type of the wireframe.",
+          "const": "webview",
+          "readOnly": true
+        },
+        "webViewId": {
+          "type": "integer",
+          "description": "Defines the unique ID of the webview.",
+          "readOnly": true
+        }
+      }
+    }
+  ]
+}
diff --git a/schemas/session-replay/mobile/webview-wireframe-update-schema.json b/schemas/session-replay/mobile/webview-wireframe-update-schema.json
@@ -0,0 +1,28 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema",
+  "$id": "session-replay/mobile/webview-wireframe-update-schema.json",
+  "title": "WebviewWireframeUpdate",
+  "type": "object",
+  "description": "Schema of all properties of a WebviewWireframeUpdate.",
+  "allOf": [
+    {
+      "$ref": "_common-shape-wireframe-update-schema.json"
+    },
+    {
+      "required": ["type", "webViewId"],
+      "properties": {
+        "type": {
+          "type": "string",
+          "description": "The type of the wireframe.",
+          "const": "webview",
+          "readOnly": true
+        },
+        "webViewId": {
+          "type": "integer",
+          "description": "Defines the unique ID of the webview.",
+          "readOnly": true
+        }
+      }
+    }
+  ]
+}
diff --git a/schemas/session-replay/mobile/wireframe-schema.json b/schemas/session-replay/mobile/wireframe-schema.json
@@ -16,6 +16,9 @@
     },
     {
       "$ref": "placeholder-wireframe-schema.json"
+    },
+    {
+      "$ref": "webview-wireframe-schema.json"
     }
   ]
 }
diff --git a/schemas/session-replay/mobile/wireframe-update-mutation-schema.json b/schemas/session-replay/mobile/wireframe-update-mutation-schema.json
@@ -16,6 +16,9 @@
     },
     {
       "$ref": "placeholder-wireframe-update-schema.json"
+    },
+    {
+      "$ref": "webview-wireframe-update-schema.json"
     }
   ]
 }
-Original file line number
+Diff line change
@@ Expand Up / @@ -16,6 +16,9 @@ @@
         },
         {
           "$ref": "placeholder-wireframe-schema.json"
+        },
+        {
+          "$ref": "webview-wireframe-schema.json"
         }
       ]
     }