@cloudcare/guance-front-tools 1.0.0

package/schemas/session-replay/common/segment-context-schema.json

@@ -0,0 +1,46 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema",
+  "$id": "session-replay/common/segment-context-schema.json",
+  "title": "SegmentContext",
+  "type": "object",
+  "description": "Schema of a Session Replay Segment context.",
+  "required": ["application", "session", "view"],
+  "properties": {
+    "application": {
+      "type": "object",
+      "description": "Application properties",
+      "required": ["id"],
+      "properties": {
+        "id": {
+          "type": "string",
+          "description": "UUID of the application",
+          "pattern": "^[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}$"
+        }
+      }
+    },
+    "session": {
+      "type": "object",
+      "description": "Session properties",
+      "required": ["id"],
+      "properties": {
+        "id": {
+          "type": "string",
+          "description": "UUID of the session",
+          "pattern": "^[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}$"
+        }
+      }
+    },
+    "view": {
+      "type": "object",
+      "description": "View properties",
+      "required": ["id"],
+      "properties": {
+        "id": {
+          "type": "string",
+          "description": "UUID of the view",
+          "pattern": "^[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}$"
+        }
+      }
+    }
+  }
+}

package/schemas/session-replay/common/view-end-record-schema.json

@@ -0,0 +1,23 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema",
+  "$id": "session-replay/common/view-end-record-schema.json",
+  "title": "ViewEndRecord",
+  "type": "object",
+  "description": "Schema of a Record which signifies that view lifecycle ended.",
+  "allOf": [
+    {
+      "$ref": "_slot-supported-common-record-schema.json"
+    },
+    {
+      "required": ["type"],
+      "properties": {
+        "type": {
+          "type": "integer",
+          "description": "The type of this Record.",
+          "const": 7,
+          "readOnly": true
+        }
+      }
+    }
+  ]
+}

package/schemas/session-replay/common/viewport-resize-data-schema.json

@@ -0,0 +1,23 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema",
+  "$id": "session-replay/common/viewport-resize-data-schema.json",
+  "title": "ViewportResizeData",
+  "type": "object",
+  "description": "Schema of a ViewportResizeData.",
+  "allOf": [
+    {
+      "required": ["source"],
+      "properties": {
+        "source": {
+          "type": "integer",
+          "const": 4,
+          "description": "The source of this type of incremental data.",
+          "readOnly": true
+        }
+      }
+    },
+    {
+      "$ref": "viewport-resize-dimension-schema.json"
+    }
+  ]
+}

package/schemas/session-replay/common/viewport-resize-dimension-schema.json

@@ -0,0 +1,18 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema",
+  "$id": "session-replay/common/viewport-resize-dimension-schema.json",
+  "type": "object",
+  "title": "ViewportResizeDimension",
+  "description": "Schema of a ViewportResizeDimension.",
+  "required": ["width", "height"],
+  "properties": {
+    "width": {
+      "type": "integer",
+      "description": "The new width of the screen in pixels, normalized based on the device pixels per inch density (DPI). Example: if a device has a DPI = 2, the width is divided by 2 to get a normalized width."
+    },
+    "height": {
+      "type": "integer",
+      "description": "The new height of the screen in pixels, normalized based on the device pixels per inch density (DPI). Example: if a device has a DPI = 2, the height is divided by 2 to get a normalized height."
+    }
+  }
+}

package/schemas/session-replay/common/visual-viewport-record-schema.json

@@ -0,0 +1,50 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema",
+  "$id": "session-replay/common/visual-viewport-record-schema.json",
+  "title": "VisualViewportRecord",
+  "type": "object",
+  "description": "Schema of a Record which signifies that the viewport properties have changed.",
+  "allOf": [
+    {
+      "$ref": "_slot-supported-common-record-schema.json"
+    },
+    {
+      "required": ["data", "type"],
+      "properties": {
+        "data": {
+          "required": ["height", "offsetLeft", "offsetTop", "pageLeft", "pageTop", "scale", "width"],
+          "properties": {
+            "height": {
+              "type": "number"
+            },
+            "offsetLeft": {
+              "type": "number"
+            },
+            "offsetTop": {
+              "type": "number"
+            },
+            "pageLeft": {
+              "type": "number"
+            },
+            "pageTop": {
+              "type": "number"
+            },
+            "scale": {
+              "type": "number"
+            },
+            "width": {
+              "type": "number"
+            }
+          },
+          "type": "object"
+        },
+        "type": {
+          "type": "integer",
+          "description": "The type of this Record.",
+          "const": 8,
+          "readOnly": true
+        }
+      }
+    }
+  ]
+}

package/schemas/session-replay/full-snapshot-record-schema.json

@@ -0,0 +1,14 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema",
+  "$id": "session-replay/full-snapshot-record-schema.json",
+  "title": "FullSnapshotRecord",
+  "description": "Schema of a Record type which contains the full snapshot of a screen.",
+  "oneOf": [
+    {
+      "$ref": "browser/full-snapshot-record-schema.json"
+    },
+    {
+      "$ref": "mobile/full-snapshot-record-schema.json"
+    }
+  ]
+}

package/schemas/session-replay/incremental-data-schema.json

@@ -0,0 +1,14 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema",
+  "$id": "session-replay/incremental-data-schema.json",
+  "title": "IncrementalData",
+  "description": "Schema of a Session Replay IncrementalData type.",
+  "oneOf": [
+    {
+      "$ref": "browser/incremental-data-schema.json"
+    },
+    {
+      "$ref": "mobile/incremental-data-schema.json"
+    }
+  ]
+}

package/schemas/session-replay/incremental-snapshot-record-schema.json

@@ -0,0 +1,14 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema",
+  "$id": "session-replay/incremental-snapshot-record-schema.json",
+  "title": "IncrementalSnapshotRecord",
+  "description": "Schema of a Record type which contains mutations of a screen.",
+  "oneOf": [
+    {
+      "$ref": "browser/incremental-snapshot-record-schema.json"
+    },
+    {
+      "$ref": "mobile/incremental-snapshot-record-schema.json"
+    }
+  ]
+}

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

@@ -0,0 +1,22 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema",
+  "$id": "session-replay/mobile/_common-shape-wireframe-schema.json",
+  "title": "CommonShapeWireframe",
+  "type": "object",
+  "description": "Schema of common properties for ShapeWireframe events type and all its sub - types.",
+  "allOf": [
+    {
+      "$ref": "_common-wireframe-schema.json"
+    },
+    {
+      "properties": {
+        "shapeStyle": {
+          "$ref": "shape-style-schema.json"
+        },
+        "border": {
+          "$ref": "shape-border-schema.json"
+        }
+      }
+    }
+  ]
+}

package/schemas/session-replay/mobile/_common-shape-wireframe-update-schema.json

@@ -0,0 +1,22 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema",
+  "$id": "session-replay/mobile/_common-shape-wireframe-update-schema.json",
+  "title": "CommonShapeWireframeUpdate",
+  "type": "object",
+  "description": "Schema of common properties for ShapeWireframeUpdate events type and all its sub - types.",
+  "allOf": [
+    {
+      "$ref": "_common-wireframe-update-schema.json"
+    },
+    {
+      "properties": {
+        "shapeStyle": {
+          "$ref": "shape-style-schema.json"
+        },
+        "border": {
+          "$ref": "shape-border-schema.json"
+        }
+      }
+    }
+  ]
+}

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

@@ -0,0 +1,38 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema",
+  "$id": "session-replay/mobile/_common-wireframe-schema.json",
+  "title": "CommonWireframe",
+  "type": "object",
+  "description": "Schema of common properties for Wireframe events type.",
+  "required": ["id", "x", "y", "width", "height"],
+  "properties": {
+    "id": {
+      "type": "integer",
+      "description": "Defines the unique ID of the wireframe. This is persistent throughout the view lifetime.",
+      "readOnly": true
+    },
+    "x": {
+      "type": "integer",
+      "description": "The position in pixels on X axis of the UI element in absolute coordinates. The anchor point is always the top-left corner of the wireframe.",
+      "readOnly": true
+    },
+    "y": {
+      "type": "integer",
+      "description": "The position in pixels on Y axis of the UI element in absolute coordinates. The anchor point is always the top-left corner of the wireframe.",
+      "readOnly": true
+    },
+    "width": {
+      "type": "integer",
+      "description": "The width in pixels of the UI element, normalized based on the device pixels per inch density (DPI). Example: if a device has a DPI = 2, the width of all UI elements is divided by 2 to get a normalized width.",
+      "readOnly": true
+    },
+    "height": {
+      "type": "integer",
+      "description": "The height in pixels of the UI element, normalized based on the device pixels per inch density (DPI). Example: if a device has a DPI = 2, the height of all UI elements is divided by 2 to get a normalized height.",
+      "readOnly": true
+    },
+    "clip": {
+      "$ref": "wireframe-clip-schema.json"
+    }
+  }
+}

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

@@ -0,0 +1,38 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema",
+  "$id": "session-replay/mobile/_common-wireframe-update-schema.json",
+  "title": "CommonWireframeUpdate",
+  "type": "object",
+  "description": "Schema of common properties for WireframeUpdate events type.",
+  "required": ["id"],
+  "properties": {
+    "id": {
+      "type": "integer",
+      "description": "Defines the unique ID of the wireframe. This is persistent throughout the view lifetime.",
+      "readOnly": true
+    },
+    "x": {
+      "type": "integer",
+      "description": "The position in pixels on X axis of the UI element in absolute coordinates. The anchor point is always the top-left corner of the wireframe.",
+      "readOnly": true
+    },
+    "y": {
+      "type": "integer",
+      "description": "The position in pixels on Y axis of the UI element in absolute coordinates. The anchor point is always the top-left corner of the wireframe.",
+      "readOnly": true
+    },
+    "width": {
+      "type": "integer",
+      "description": "The width in pixels of the UI element, normalized based on the device pixels per inch density (DPI). Example: if a device has a DPI = 2, the width of all UI elements is divided by 2 to get a normalized width.",
+      "readOnly": true
+    },
+    "height": {
+      "type": "integer",
+      "description": "The height in pixels of the UI element, normalized based on the device pixels per inch density (DPI). Example: if a device has a DPI = 2, the height of all UI elements is divided by 2 to get a normalized height.",
+      "readOnly": true
+    },
+    "clip": {
+      "$ref": "wireframe-clip-schema.json"
+    }
+  }
+}

package/schemas/session-replay/mobile/full-snapshot-record-schema.json

@@ -0,0 +1,38 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema",
+  "$id": "session-replay/mobile/full-snapshot-record-schema.json",
+  "title": "MobileFullSnapshotRecord",
+  "type": "object",
+  "description": "Mobile-specific. Schema of a Record type which contains the full snapshot of a screen.",
+  "allOf": [
+    {
+      "$ref": "../common/_common-record-schema.json"
+    },
+    {
+      "required": ["type", "data"],
+      "properties": {
+        "type": {
+          "type": "integer",
+          "description": "The type of this Record.",
+          "const": 10,
+          "readOnly": true
+        },
+        "data": {
+          "type": "object",
+          "readOnly": true,
+          "required": ["wireframes"],
+          "properties": {
+            "wireframes": {
+              "type": "array",
+              "items": {
+                "$ref": "wireframe-schema.json"
+              },
+              "description": "The Wireframes contained by this Record.",
+              "readOnly": true
+            }
+          }
+        }
+      }
+    }
+  ]
+}

package/schemas/session-replay/mobile/image-wireframe-schema.json

@@ -0,0 +1,43 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema",
+  "$id": "session-replay/mobile/image-wireframe-schema.json",
+  "title": "ImageWireframe",
+  "type": "object",
+  "description": "Schema of all properties of a ImageWireframe.",
+  "allOf": [
+    {
+      "$ref": "_common-shape-wireframe-schema.json"
+    },
+    {
+      "required": ["type"],
+      "properties": {
+        "type": {
+          "type": "string",
+          "description": "The type of the wireframe.",
+          "const": "image",
+          "readOnly": true
+        },
+        "base64": {
+          "type": "string",
+          "description": "base64 representation of the image. Not required as the ImageWireframe can be initialised without any base64",
+          "readOnly": false
+        },
+        "resourceId": {
+          "type": "string",
+          "description": "Unique identifier of the image resource",
+          "readOnly": false
+        },
+        "mimeType": {
+          "type": "string",
+          "description": "MIME type of the image file",
+          "readOnly": false
+        },
+        "isEmpty": {
+          "type": "boolean",
+          "description": "Flag describing an image wireframe that should render an empty state placeholder",
+          "readOnly": false
+        }
+      }
+    }
+  ]
+}

package/schemas/session-replay/mobile/image-wireframe-update-schema.json

@@ -0,0 +1,43 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema",
+  "$id": "session-replay/mobile/image-wireframe-update-schema.json",
+  "title": "ImageWireframeUpdate",
+  "type": "object",
+  "description": "Schema of all properties of a ImageWireframeUpdate.",
+  "allOf": [
+    {
+      "$ref": "_common-shape-wireframe-update-schema.json"
+    },
+    {
+      "required": ["type"],
+      "properties": {
+        "type": {
+          "type": "string",
+          "description": "The type of the wireframe.",
+          "const": "image",
+          "readOnly": true
+        },
+        "base64": {
+          "type": "string",
+          "description": "base64 representation of the image. Not required as the ImageWireframe can be initialised without any base64",
+          "readOnly": false
+        },
+        "resourceId": {
+          "type": "string",
+          "description": "Unique identifier of the image resource",
+          "readOnly": false
+        },
+        "mimeType": {
+          "type": "string",
+          "description": "MIME type of the image file",
+          "readOnly": false
+        },
+        "isEmpty": {
+          "type": "boolean",
+          "description": "Flag describing an image wireframe that should render an empty state placeholder",
+          "readOnly": false
+        }
+      }
+    }
+  ]
+}

package/schemas/session-replay/mobile/incremental-data-schema.json

@@ -0,0 +1,21 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema",
+  "$id": "session-replay/mobile/incremental-data-schema.json",
+  "title": "MobileIncrementalData",
+  "type": "object",
+  "description": "Mobile-specific. Schema of a Session Replay IncrementalData type.",
+  "oneOf": [
+    {
+      "$ref": "mutation-data-schema.json"
+    },
+    {
+      "$ref": "touch-data-schema.json"
+    },
+    {
+      "$ref": "../common/viewport-resize-data-schema.json"
+    },
+    {
+      "$ref": "../common/pointer-interaction-data-schema.json"
+    }
+  ]
+}

package/schemas/session-replay/mobile/incremental-snapshot-record-schema.json

@@ -0,0 +1,26 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema",
+  "$id": "session-replay/mobile/incremental-snapshot-record-schema.json",
+  "title": "MobileIncrementalSnapshotRecord",
+  "type": "object",
+  "description": "Mobile-specific. Schema of a Record type which contains mutations of a screen.",
+  "allOf": [
+    {
+      "$ref": "../common/_common-record-schema.json"
+    },
+    {
+      "required": ["type", "data"],
+      "properties": {
+        "type": {
+          "type": "integer",
+          "description": "The type of this Record.",
+          "const": 11,
+          "readOnly": true
+        },
+        "data": {
+          "$ref": "incremental-data-schema.json"
+        }
+      }
+    }
+  ]
+}

package/schemas/session-replay/mobile/mutation-data-schema.json

@@ -0,0 +1,23 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema",
+  "$id": "session-replay/mobile/mutation-data-schema.json",
+  "title": "MobileMutationData",
+  "type": "object",
+  "description": "Mobile-specific. Schema of a MutationData.",
+  "allOf": [
+    {
+      "required": ["source"],
+      "properties": {
+        "source": {
+          "type": "integer",
+          "const": 0,
+          "description": "The source of this type of incremental data.",
+          "readOnly": true
+        }
+      }
+    },
+    {
+      "$ref": "mutation-payload-schema.json"
+    }
+  ]
+}

package/schemas/session-replay/mobile/mutation-payload-schema.json

@@ -0,0 +1,55 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema",
+  "$id": "session-replay/mobile/mutation-payload-schema.json",
+  "title": "MobileMutationPayload",
+  "type": "object",
+  "description": "Mobile-specific. Schema of a MutationPayload.",
+  "required": ["adds", "removes", "updates"],
+  "allOf": [
+    {
+      "properties": {
+        "adds": {
+          "type": "array",
+          "readOnly": true,
+          "items": {
+            "type": "object",
+            "required": ["wireframe"],
+            "properties": {
+              "previousId": {
+                "type": "integer",
+                "description": "The previous wireframe id next or after which this new wireframe is drawn or attached to, respectively."
+              },
+              "wireframe": {
+                "$ref": "wireframe-schema.json"
+              }
+            }
+          },
+          "description": "Contains the newly added wireframes."
+        },
+        "removes": {
+          "type": "array",
+          "readOnly": true,
+          "items": {
+            "type": "object",
+            "required": ["id"],
+            "properties": {
+              "id": {
+                "type": "integer",
+                "description": "The id of the wireframe that needs to be removed."
+              }
+            }
+          },
+          "description": "Contains the removed wireframes as an array of ids."
+        },
+        "updates": {
+          "type": "array",
+          "readOnly": true,
+          "items": {
+            "$ref": "wireframe-update-mutation-schema.json"
+          },
+          "description": "Contains the updated wireframes mutations."
+        }
+      }
+    }
+  ]
+}

package/schemas/session-replay/mobile/placeholder-wireframe-schema.json

@@ -0,0 +1,28 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema",
+  "$id": "session-replay/mobile/placeholder-wireframe-schema.json",
+  "title": "PlaceholderWireframe",
+  "type": "object",
+  "description": "Schema of all properties of a PlaceholderWireframe.",
+  "allOf": [
+    {
+      "$ref": "_common-wireframe-schema.json"
+    },
+    {
+      "required": ["type"],
+      "properties": {
+        "type": {
+          "type": "string",
+          "description": "The type of the wireframe.",
+          "const": "placeholder",
+          "readOnly": true
+        },
+        "label": {
+          "type": "string",
+          "description": "Label of the placeholder",
+          "readOnly": false
+        }
+      }
+    }
+  ]
+}

package/schemas/session-replay/mobile/placeholder-wireframe-update-schema.json

@@ -0,0 +1,28 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema",
+  "$id": "session-replay/mobile/placeholder-wireframe-update-schema.json",
+  "title": "PlaceholderWireframeUpdate",
+  "type": "object",
+  "description": "Schema of all properties of a PlaceholderWireframe.",
+  "allOf": [
+    {
+      "$ref": "_common-wireframe-update-schema.json"
+    },
+    {
+      "required": ["type"],
+      "properties": {
+        "type": {
+          "type": "string",
+          "description": "The type of the wireframe.",
+          "const": "placeholder",
+          "readOnly": true
+        },
+        "label": {
+          "type": "string",
+          "description": "Label of the placeholder",
+          "readOnly": false
+        }
+      }
+    }
+  ]
+}