zig-mobile-runner 0.1.0

package/schemas/scenario.schema.json

@@ -0,0 +1,128 @@
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "$id": "https://zmr.dev/schemas/scenario.schema.json",
+  "title": "ZMR Scenario",
+  "type": "object",
+  "additionalProperties": false,
+  "required": ["name", "steps"],
+  "properties": {
+    "name": { "type": "string", "minLength": 1 },
+    "appId": { "type": "string", "minLength": 1 },
+    "steps": {
+      "type": "array",
+      "minItems": 1,
+      "items": { "$ref": "#/$defs/step" }
+    }
+  },
+  "$defs": {
+    "selector": {
+      "type": "object",
+      "additionalProperties": false,
+      "minProperties": 1,
+      "properties": {
+        "id": { "type": "string" },
+        "resourceId": { "type": "string" },
+        "text": { "type": "string" },
+        "textContains": { "type": "string" },
+        "contentDesc": { "type": "string" },
+        "contentDescContains": { "type": "string" },
+        "className": { "type": "string" }
+      }
+    },
+    "step": {
+      "type": "object",
+      "required": ["action"],
+      "properties": {
+        "action": {
+          "enum": [
+            "launch",
+            "stop",
+            "clearState",
+            "snapshot",
+            "openLink",
+            "tap",
+            "typeText",
+            "eraseText",
+            "pressBack",
+            "hideKeyboard",
+            "swipe",
+            "waitVisible",
+            "waitNotVisible",
+            "waitAny",
+            "assertVisible",
+            "assertNotVisible",
+            "assertNoneVisible",
+            "assertHealthy",
+            "optional",
+            "whenVisible",
+            "repeat",
+            "scrollUntilVisible",
+            "sleep"
+          ]
+        },
+        "optional": { "type": "boolean" },
+        "url": { "type": "string", "minLength": 1 },
+        "selector": { "$ref": "#/$defs/selector" },
+        "selectors": {
+          "type": "array",
+          "minItems": 1,
+          "items": { "$ref": "#/$defs/selector" }
+        },
+        "text": { "type": "string" },
+        "maxChars": { "type": "integer", "minimum": 0 },
+        "x1": { "type": "integer" },
+        "y1": { "type": "integer" },
+        "x2": { "type": "integer" },
+        "y2": { "type": "integer" },
+        "durationMs": { "type": "integer", "minimum": 0 },
+        "timeoutMs": { "type": "integer", "minimum": 0 },
+        "direction": { "enum": ["down", "up"] },
+        "times": { "type": "integer", "minimum": 1 },
+        "steps": {
+          "type": "array",
+          "items": { "$ref": "#/$defs/step" }
+        },
+        "step": { "$ref": "#/$defs/step" },
+        "ms": { "type": "integer", "minimum": 0 }
+      },
+      "allOf": [
+        {
+          "if": { "properties": { "action": { "const": "openLink" } } },
+          "then": { "required": ["url"] }
+        },
+        {
+          "if": { "properties": { "action": { "enum": ["tap", "waitVisible", "waitNotVisible", "assertVisible", "assertNotVisible", "scrollUntilVisible"] } } },
+          "then": { "required": ["selector"] }
+        },
+        {
+          "if": { "properties": { "action": { "const": "waitAny" } } },
+          "then": { "required": ["selectors"] }
+        },
+        {
+          "if": { "properties": { "action": { "const": "assertNoneVisible" } } },
+          "then": { "required": ["selectors"] }
+        },
+        {
+          "if": { "properties": { "action": { "const": "typeText" } } },
+          "then": { "required": ["text"] }
+        },
+        {
+          "if": { "properties": { "action": { "const": "swipe" } } },
+          "then": { "required": ["x1", "y1", "x2", "y2"] }
+        },
+        {
+          "if": { "properties": { "action": { "const": "optional" } } },
+          "then": { "required": ["step"] }
+        },
+        {
+          "if": { "properties": { "action": { "const": "whenVisible" } } },
+          "then": { "required": ["selector", "steps"] }
+        },
+        {
+          "if": { "properties": { "action": { "const": "repeat" } } },
+          "then": { "required": ["times", "steps"] }
+        }
+      ]
+    }
+  }
+}

package/schemas/schemas-output.schema.json

@@ -0,0 +1,26 @@
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "$id": "https://zmr.dev/schemas/schemas-output.schema.json",
+  "title": "ZMR Schemas Output",
+  "type": "object",
+  "additionalProperties": false,
+  "required": ["ok", "count", "schemas"],
+  "properties": {
+    "ok": { "const": true },
+    "count": { "type": "integer", "minimum": 0 },
+    "schemas": {
+      "type": "array",
+      "items": {
+        "type": "object",
+        "additionalProperties": false,
+        "required": ["name", "path", "id", "description"],
+        "properties": {
+          "name": { "type": "string", "minLength": 1 },
+          "path": { "type": "string", "minLength": 1 },
+          "id": { "type": "string", "minLength": 1 },
+          "description": { "type": "string", "minLength": 1 }
+        }
+      }
+    }
+  }
+}

package/schemas/semantic-snapshot.schema.json

@@ -0,0 +1,116 @@
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "$id": "https://zmr.dev/schemas/semantic-snapshot.schema.json",
+  "title": "ZMR Semantic Snapshot",
+  "type": "object",
+  "additionalProperties": false,
+  "required": [
+    "id",
+    "timestampMs",
+    "viewport",
+    "activePackage",
+    "activeActivity",
+    "focusedNodeId",
+    "nodes",
+    "summary"
+  ],
+  "properties": {
+    "id": { "type": "string", "minLength": 1 },
+    "timestampMs": { "type": "integer" },
+    "viewport": {
+      "type": "object",
+      "additionalProperties": false,
+      "required": ["width", "height"],
+      "properties": {
+        "width": { "type": "integer", "minimum": 0 },
+        "height": { "type": "integer", "minimum": 0 }
+      }
+    },
+    "activePackage": { "type": ["string", "null"] },
+    "activeActivity": { "type": ["string", "null"] },
+    "focusedNodeId": { "type": ["string", "null"] },
+    "nodes": {
+      "type": "array",
+      "items": { "$ref": "#/$defs/semanticNode" }
+    },
+    "summary": {
+      "type": "object",
+      "additionalProperties": false,
+      "required": ["nodeCount", "interactiveCount", "visibleText"],
+      "properties": {
+        "nodeCount": { "type": "integer", "minimum": 0 },
+        "interactiveCount": { "type": "integer", "minimum": 0 },
+        "visibleText": {
+          "type": "array",
+          "items": { "type": "string" }
+        }
+      }
+    }
+  },
+  "$defs": {
+    "semanticNode": {
+      "type": "object",
+      "additionalProperties": false,
+      "required": [
+        "id",
+        "role",
+        "name",
+        "selector",
+        "source",
+        "bounds",
+        "enabled",
+        "visible",
+        "selected",
+        "interactive",
+        "recommendedAction"
+      ],
+      "properties": {
+        "id": { "type": "string", "minLength": 1 },
+        "role": {
+          "enum": ["button", "textbox", "switch", "checkbox", "radio", "image", "text", "node"]
+        },
+        "name": { "type": "string" },
+        "selector": {
+          "type": "object",
+          "minProperties": 1,
+          "additionalProperties": false,
+          "properties": {
+            "resourceId": { "type": "string" },
+            "contentDesc": { "type": "string" },
+            "text": { "type": "string" },
+            "stableId": { "type": "string" }
+          }
+        },
+        "source": {
+          "type": "object",
+          "additionalProperties": false,
+          "required": ["className", "resourceId", "text", "contentDesc"],
+          "properties": {
+            "className": { "type": "string" },
+            "resourceId": { "type": ["string", "null"] },
+            "text": { "type": ["string", "null"] },
+            "contentDesc": { "type": ["string", "null"] }
+          }
+        },
+        "bounds": {
+          "type": "object",
+          "additionalProperties": false,
+          "required": ["x", "y", "width", "height", "centerX", "centerY"],
+          "properties": {
+            "x": { "type": "integer" },
+            "y": { "type": "integer" },
+            "width": { "type": "integer" },
+            "height": { "type": "integer" },
+            "centerX": { "type": "integer" },
+            "centerY": { "type": "integer" }
+          }
+        },
+        "enabled": { "type": "boolean" },
+        "visible": { "type": "boolean" },
+        "selected": { "type": "boolean" },
+        "interactive": { "type": "boolean" },
+        "recommendedAction": { "enum": ["tap", "type", null] }
+      }
+    }
+  }
+}

package/schemas/snapshot.schema.json

@@ -0,0 +1,60 @@
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "$id": "https://zmr.dev/schemas/snapshot.schema.json",
+  "title": "ZMR ObservationSnapshot",
+  "type": "object",
+  "additionalProperties": false,
+  "required": ["id", "timestampMs", "viewport", "nodes"],
+  "properties": {
+    "id": { "type": "string" },
+    "timestampMs": { "type": "integer" },
+    "viewport": {
+      "type": "object",
+      "additionalProperties": false,
+      "required": ["width", "height"],
+      "properties": {
+        "width": { "type": "integer", "minimum": 0 },
+        "height": { "type": "integer", "minimum": 0 }
+      }
+    },
+    "displayDensityDpi": { "type": ["integer", "null"], "minimum": 0 },
+    "activePackage": { "type": ["string", "null"] },
+    "activeActivity": { "type": ["string", "null"] },
+    "screenshotArtifact": { "type": ["string", "null"] },
+    "treeArtifact": { "type": ["string", "null"] },
+    "focusedNodeId": { "type": ["string", "null"] },
+    "logDelta": { "type": ["string", "null"] },
+    "nodes": {
+      "type": "array",
+      "items": { "$ref": "#/$defs/uiNode" }
+    }
+  },
+  "$defs": {
+    "uiNode": {
+      "type": "object",
+      "additionalProperties": false,
+      "required": ["stableId", "className", "bounds", "enabled", "visible", "selected"],
+      "properties": {
+        "stableId": { "type": "string" },
+        "className": { "type": "string" },
+        "resourceId": { "type": ["string", "null"] },
+        "text": { "type": ["string", "null"] },
+        "contentDesc": { "type": ["string", "null"] },
+        "bounds": {
+          "type": "object",
+          "additionalProperties": false,
+          "required": ["x", "y", "width", "height"],
+          "properties": {
+            "x": { "type": "integer" },
+            "y": { "type": "integer" },
+            "width": { "type": "integer", "minimum": 0 },
+            "height": { "type": "integer", "minimum": 0 }
+          }
+        },
+        "enabled": { "type": "boolean" },
+        "visible": { "type": "boolean" },
+        "selected": { "type": "boolean" }
+      }
+    }
+  }
+}

package/schemas/trace-event.schema.json

@@ -0,0 +1,14 @@
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "$id": "https://zmr.dev/schemas/trace-event.schema.json",
+  "title": "ZMR Trace Event",
+  "type": "object",
+  "additionalProperties": false,
+  "required": ["seq", "timestampMs", "kind", "payload"],
+  "properties": {
+    "seq": { "type": "integer", "minimum": 1 },
+    "timestampMs": { "type": "integer" },
+    "kind": { "type": "string", "minLength": 1 },
+    "payload": {}
+  }
+}

package/schemas/trace-manifest.schema.json

@@ -0,0 +1,59 @@
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "$id": "https://zmr.dev/schemas/trace-manifest.schema.json",
+  "title": "ZMR Trace Manifest",
+  "type": "object",
+  "additionalProperties": false,
+  "required": [
+    "schemaVersion",
+    "runnerVersion",
+    "protocolVersion",
+    "scenarioName",
+    "appId",
+    "status",
+    "startedAtMs",
+    "endedAtMs",
+    "durationMs",
+    "failedStepIndex",
+    "error",
+    "eventsPath",
+    "artifactsDir",
+    "eventCount",
+    "snapshotCount",
+    "partialFailureCount",
+    "reportPath"
+  ],
+  "properties": {
+    "schemaVersion": { "const": 1 },
+    "runnerVersion": { "type": "string", "minLength": 1 },
+    "protocolVersion": { "type": "string", "minLength": 1 },
+    "scenarioName": { "type": "string", "minLength": 1 },
+    "appId": { "type": ["string", "null"] },
+    "status": { "enum": ["running", "passed", "failed", "partial"] },
+    "startedAtMs": { "type": "integer" },
+    "endedAtMs": { "type": ["integer", "null"] },
+    "durationMs": { "type": ["integer", "null"], "minimum": 0 },
+    "failedStepIndex": { "type": ["integer", "null"], "minimum": 0 },
+    "error": { "type": ["string", "null"] },
+    "eventsPath": { "const": "events.jsonl" },
+    "artifactsDir": { "const": "artifacts" },
+    "eventCount": { "type": "integer", "minimum": 0 },
+    "snapshotCount": { "type": "integer", "minimum": 0 },
+    "partialFailureCount": { "type": "integer", "minimum": 0 },
+    "reportPath": { "type": ["string", "null"] },
+    "redaction": {
+      "type": "object",
+      "additionalProperties": false,
+      "required": ["enabled", "screenshots", "screenRecordings", "textArtifacts", "screenshotsOmitted", "screenshotsRedacted", "screenRecordingsOmitted"],
+      "properties": {
+        "enabled": { "type": "boolean" },
+        "screenshots": { "enum": ["included", "omitted", "placeholder"] },
+        "screenRecordings": { "enum": ["included", "omitted"] },
+        "textArtifacts": { "enum": ["raw", "scrubbed"] },
+        "screenshotsOmitted": { "type": "boolean" },
+        "screenshotsRedacted": { "type": "boolean" },
+        "screenRecordingsOmitted": { "type": "boolean" }
+      }
+    }
+  }
+}

package/schemas/validate-output.schema.json

@@ -0,0 +1,42 @@
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "$id": "https://zmr.dev/schemas/validate-output.schema.json",
+  "title": "ZMR Validate Output",
+  "oneOf": [
+    { "$ref": "#/$defs/validScenario" },
+    { "$ref": "#/$defs/invalidScenario" }
+  ],
+  "$defs": {
+    "validScenario": {
+      "type": "object",
+      "additionalProperties": false,
+      "required": ["ok", "path", "name", "stepCount", "nextCommands"],
+      "properties": {
+        "ok": { "const": true },
+        "path": { "type": "string", "minLength": 1 },
+        "name": { "type": "string", "minLength": 1 },
+        "appId": { "type": "string", "minLength": 1 },
+        "stepCount": { "type": "integer", "minimum": 0 },
+        "nextCommands": {
+          "type": "array",
+          "minItems": 1,
+          "items": { "type": "string", "minLength": 1 }
+        }
+      }
+    },
+    "invalidScenario": {
+      "type": "object",
+      "additionalProperties": false,
+      "required": ["ok", "path", "errorCode", "message"],
+      "properties": {
+        "ok": { "const": false },
+        "path": { "type": "string", "minLength": 1 },
+        "errorCode": { "type": "string", "minLength": 1 },
+        "message": { "type": "string", "minLength": 1 },
+        "fieldPath": { "type": "string", "minLength": 1 },
+        "line": { "type": "integer", "minimum": 1 },
+        "column": { "type": "integer", "minimum": 0 }
+      }
+    }
+  }
+}

package/schemas/version-output.schema.json

@@ -0,0 +1,23 @@
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "$id": "https://zmr.dev/schemas/version-output.schema.json",
+  "title": "ZMR Version Output",
+  "type": "object",
+  "additionalProperties": false,
+  "required": [
+    "name",
+    "version",
+    "protocolVersion",
+    "minimumCompatibleProtocolVersion",
+    "stability",
+    "breakingChangePolicy"
+  ],
+  "properties": {
+    "name": { "const": "zmr" },
+    "version": { "type": "string", "minLength": 1 },
+    "protocolVersion": { "type": "string", "minLength": 1 },
+    "minimumCompatibleProtocolVersion": { "type": "string", "minLength": 1 },
+    "stability": { "type": "string", "minLength": 1 },
+    "breakingChangePolicy": { "type": "string", "minLength": 1 }
+  }
+}

package/schemas/zmr-config.schema.json

@@ -0,0 +1,75 @@
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "$id": "https://zmr.dev/schemas/zmr-config.schema.json",
+  "title": "ZMR App Config",
+  "type": "object",
+  "additionalProperties": false,
+  "required": ["schemaVersion"],
+  "properties": {
+    "schemaVersion": { "const": 1 },
+    "appId": { "type": "string", "minLength": 1 },
+    "android": { "$ref": "#/$defs/platformConfig" },
+    "ios": { "$ref": "#/$defs/platformConfig" },
+    "artifacts": {
+      "type": "object",
+      "additionalProperties": false,
+      "properties": {
+        "screenshots": { "type": "boolean", "default": true },
+        "hierarchy": { "type": "boolean", "default": true },
+        "logs": { "type": "boolean", "default": true },
+        "screenRecording": { "type": "boolean", "default": false }
+      }
+    },
+    "redaction": {
+      "type": "object",
+      "additionalProperties": false,
+      "properties": {
+        "denylistText": { "$ref": "#/$defs/stringList" },
+        "allowlistText": { "$ref": "#/$defs/stringList" },
+        "denylistResourceIds": { "$ref": "#/$defs/stringList" },
+        "allowlistResourceIds": { "$ref": "#/$defs/stringList" }
+      }
+    },
+    "tools": {
+      "type": "object",
+      "additionalProperties": false,
+      "properties": {
+        "adbPath": { "type": "string", "minLength": 1 },
+        "emulatorPath": { "type": "string", "minLength": 1 },
+        "avdmanagerPath": { "type": "string", "minLength": 1 },
+        "androidShimPath": { "type": "string", "minLength": 1 },
+        "xcrunPath": { "type": "string", "minLength": 1 },
+        "iosShimPath": { "type": "string", "minLength": 1 },
+        "zigPath": { "type": "string", "minLength": 1 }
+      }
+    },
+    "scripts": {
+      "type": "object",
+      "additionalProperties": { "type": "string", "minLength": 1 }
+    }
+  },
+  "$defs": {
+    "stringList": {
+      "type": "array",
+      "items": { "type": "string", "minLength": 1 },
+      "default": []
+    },
+    "platformConfig": {
+      "type": "object",
+      "additionalProperties": false,
+      "properties": {
+        "enabled": { "type": "boolean" },
+        "defaultDevice": { "type": "string", "minLength": 1 },
+        "smokeScenario": { "type": "string", "minLength": 1 },
+        "traceDir": { "type": "string", "minLength": 1 },
+        "avdName": { "type": "string", "minLength": 1 },
+        "restoreSnapshot": { "type": "string", "minLength": 1 },
+        "createAvdIfMissing": { "type": "boolean", "default": false },
+        "avdSystemImage": { "type": "string", "minLength": 1 },
+        "avdDeviceProfile": { "type": "string", "minLength": 1 },
+        "resetBeforeRun": { "type": "boolean", "default": false },
+        "waitReady": { "type": "boolean", "default": false }
+      }
+    }
+  }
+}