@crvouga/atlas 0.0.0-stage → 0.2.0

package/packages/schema/schemas/state-record.schema.json

@@ -0,0 +1,354 @@
+{
+  "$id": "https://github.com/crvouga/atlas/schemas/state-record.schema.json",
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "type": "object",
+  "properties": {
+    "name": {
+      "type": "string"
+    },
+    "chart": {
+      "anyOf": [
+        {
+          "type": "string"
+        },
+        {
+          "type": "null"
+        }
+      ]
+    },
+    "description": {
+      "type": "string"
+    },
+    "snapshot": {
+      "type": "string"
+    },
+    "confidence": {
+      "type": "string",
+      "enum": [
+        "confirmed",
+        "assumed"
+      ]
+    },
+    "source": {
+      "type": "array",
+      "items": {
+        "type": "string"
+      }
+    },
+    "expectedEvents": {
+      "type": "array",
+      "items": {
+        "type": "string"
+      }
+    },
+    "client": {
+      "description": "The client whose screen shows it, in a multi-client run",
+      "type": "string"
+    },
+    "seeds": {
+      "description": "Seeds that start paths with this state active",
+      "type": "array",
+      "items": {
+        "type": "string"
+      }
+    },
+    "status": {
+      "type": "string",
+      "enum": [
+        "passed",
+        "failed",
+        "flaky",
+        "not-reached"
+      ]
+    },
+    "screenshot": {
+      "anyOf": [
+        {
+          "type": "object",
+          "properties": {
+            "png": {
+              "type": "string",
+              "minLength": 1
+            },
+            "webp": {
+              "description": "About 400 px wide, for the map; the original image is used while a thumbnail is unavailable",
+              "type": "string",
+              "minLength": 1
+            },
+            "client": {
+              "description": "Which client's screen it is, in a multi-client run",
+              "type": "string"
+            },
+            "also": {
+              "description": "The other clients' screens at the same moment",
+              "type": "array",
+              "items": {
+                "type": "object",
+                "properties": {
+                  "png": {
+                    "type": "string",
+                    "minLength": 1
+                  },
+                  "webp": {
+                    "description": "About 400 px wide, for the map; the original image is used while a thumbnail is unavailable",
+                    "type": "string",
+                    "minLength": 1
+                  },
+                  "client": {
+                    "description": "Which client's screen it is, in a multi-client run",
+                    "type": "string"
+                  }
+                },
+                "required": [
+                  "png"
+                ]
+              }
+            }
+          },
+          "required": [
+            "png"
+          ]
+        },
+        {
+          "type": "null"
+        }
+      ]
+    },
+    "screenshotState": {
+      "type": "string",
+      "enum": [
+        "ready",
+        "processing",
+        "failed"
+      ]
+    },
+    "thumbnail": {
+      "description": "Proposed: a separate small image for the map",
+      "type": "string"
+    },
+    "screenshotsByPath": {
+      "type": "object",
+      "propertyNames": {
+        "type": "string"
+      },
+      "additionalProperties": {
+        "type": "object",
+        "properties": {
+          "png": {
+            "type": "string",
+            "minLength": 1
+          },
+          "webp": {
+            "description": "About 400 px wide, for the map; the original image is used while a thumbnail is unavailable",
+            "type": "string",
+            "minLength": 1
+          },
+          "client": {
+            "description": "Which client's screen it is, in a multi-client run",
+            "type": "string"
+          },
+          "also": {
+            "description": "The other clients' screens at the same moment",
+            "type": "array",
+            "items": {
+              "type": "object",
+              "properties": {
+                "png": {
+                  "type": "string",
+                  "minLength": 1
+                },
+                "webp": {
+                  "description": "About 400 px wide, for the map; the original image is used while a thumbnail is unavailable",
+                  "type": "string",
+                  "minLength": 1
+                },
+                "client": {
+                  "description": "Which client's screen it is, in a multi-client run",
+                  "type": "string"
+                }
+              },
+              "required": [
+                "png"
+              ]
+            }
+          }
+        },
+        "required": [
+          "png"
+        ]
+      }
+    },
+    "recognizer": {
+      "anyOf": [
+        {
+          "type": "object",
+          "properties": {
+            "matched": {
+              "type": "boolean"
+            },
+            "signals": {
+              "type": "array",
+              "items": {
+                "type": "object",
+                "properties": {
+                  "signal": {
+                    "type": "string"
+                  },
+                  "expected": {
+                    "type": "string"
+                  },
+                  "visible": {
+                    "type": "boolean"
+                  }
+                },
+                "required": [
+                  "signal",
+                  "expected",
+                  "visible"
+                ]
+              }
+            }
+          },
+          "required": [
+            "matched",
+            "signals"
+          ]
+        },
+        {
+          "type": "null"
+        }
+      ]
+    },
+    "looksLike": {
+      "type": "array",
+      "items": {
+        "type": "string"
+      }
+    },
+    "businessEvents": {
+      "anyOf": [
+        {
+          "type": "object",
+          "properties": {
+            "expected": {
+              "type": "array",
+              "items": {
+                "type": "string"
+              }
+            },
+            "observed": {
+              "type": "array",
+              "items": {
+                "type": "string"
+              }
+            },
+            "missing": {
+              "type": "array",
+              "items": {
+                "type": "string"
+              }
+            },
+            "noSignal": {
+              "description": "No observable signal is mapped yet",
+              "type": "array",
+              "items": {
+                "type": "string"
+              }
+            },
+            "events": {
+              "description": "The CloudEvents observed during the step",
+              "type": "array",
+              "items": {
+                "type": "object",
+                "properties": {
+                  "specversion": {
+                    "type": "string",
+                    "const": "1.0"
+                  },
+                  "id": {
+                    "type": "string",
+                    "minLength": 1
+                  },
+                  "source": {
+                    "type": "string",
+                    "minLength": 1
+                  },
+                  "type": {
+                    "type": "string",
+                    "minLength": 1
+                  },
+                  "time": {
+                    "type": "string"
+                  },
+                  "subject": {
+                    "type": "string"
+                  },
+                  "datacontenttype": {
+                    "type": "string"
+                  },
+                  "data": {}
+                },
+                "required": [
+                  "specversion",
+                  "id",
+                  "source",
+                  "type"
+                ],
+                "additionalProperties": {}
+              }
+            }
+          },
+          "required": [
+            "expected",
+            "observed",
+            "missing",
+            "noSignal"
+          ]
+        },
+        {
+          "type": "null"
+        }
+      ]
+    },
+    "checks": {
+      "type": "array",
+      "items": {
+        "type": "object",
+        "properties": {
+          "check": {
+            "type": "string"
+          },
+          "passed": {
+            "type": "boolean"
+          },
+          "expected": {
+            "type": "string"
+          },
+          "actual": {
+            "type": "string"
+          }
+        },
+        "required": [
+          "check",
+          "passed"
+        ]
+      }
+    },
+    "reachedBy": {
+      "type": "array",
+      "items": {
+        "type": "string"
+      }
+    },
+    "notes": {
+      "type": "array",
+      "items": {
+        "type": "string"
+      }
+    }
+  },
+  "required": [
+    "name",
+    "status"
+  ]
+}

package/packages/schema/schemas/timeline-entry.schema.json

@@ -0,0 +1,124 @@
+{
+  "$id": "https://github.com/crvouga/atlas/schemas/timeline-entry.schema.json",
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "type": "object",
+  "properties": {
+    "atMs": {
+      "description": "Milliseconds from the start of the clip",
+      "type": "number",
+      "minimum": 0
+    },
+    "kind": {
+      "type": "string",
+      "enum": [
+        "tap",
+        "type",
+        "system",
+        "screen",
+        "toast",
+        "note",
+        "time",
+        "notification"
+      ]
+    },
+    "label": {
+      "type": "string"
+    },
+    "x": {
+      "description": "Tap position in CSS pixels",
+      "type": "number"
+    },
+    "y": {
+      "type": "number"
+    },
+    "text": {
+      "description": "What was typed",
+      "type": "string"
+    },
+    "system": {
+      "type": "object",
+      "properties": {
+        "source": {
+          "type": "string"
+        },
+        "endpoint": {
+          "type": "string"
+        },
+        "eventType": {
+          "type": "string"
+        },
+        "payload": {},
+        "responseStatus": {
+          "type": "integer",
+          "minimum": -9007199254740991,
+          "maximum": 9007199254740991
+        },
+        "response": {
+          "description": "Proposed: the response body"
+        }
+      }
+    },
+    "time": {
+      "type": "object",
+      "properties": {
+        "from": {
+          "type": "string"
+        },
+        "to": {
+          "type": "string"
+        },
+        "fired": {
+          "type": "array",
+          "items": {
+            "type": "object",
+            "properties": {
+              "at": {
+                "type": "string"
+              },
+              "label": {
+                "type": "string"
+              }
+            },
+            "required": [
+              "at",
+              "label"
+            ]
+          }
+        }
+      },
+      "required": [
+        "from",
+        "to"
+      ]
+    },
+    "notification": {
+      "type": "object",
+      "properties": {
+        "channel": {
+          "type": "string",
+          "enum": [
+            "push",
+            "email",
+            "sms",
+            "in-app"
+          ]
+        },
+        "title": {
+          "type": "string"
+        },
+        "body": {
+          "type": "string"
+        }
+      }
+    },
+    "client": {
+      "description": "The client that did it, in a multi-client run",
+      "type": "string"
+    }
+  },
+  "required": [
+    "atMs",
+    "kind",
+    "label"
+  ]
+}

package/packages/schema/schemas/transition-record.schema.json

@@ -0,0 +1,125 @@
+{
+  "$id": "https://github.com/crvouga/atlas/schemas/transition-record.schema.json",
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "type": "object",
+  "properties": {
+    "id": {
+      "type": "string"
+    },
+    "source": {
+      "type": "string"
+    },
+    "target": {
+      "anyOf": [
+        {
+          "type": "string"
+        },
+        {
+          "type": "null"
+        }
+      ]
+    },
+    "event": {
+      "type": "string"
+    },
+    "kind": {
+      "type": "string",
+      "enum": [
+        "user",
+        "system",
+        "time",
+        "hand-off"
+      ]
+    },
+    "how": {
+      "anyOf": [
+        {
+          "type": "string"
+        },
+        {
+          "type": "null"
+        }
+      ]
+    },
+    "client": {
+      "description": "The client that does it, in a multi-client run",
+      "type": "string"
+    },
+    "status": {
+      "type": "string",
+      "enum": [
+        "passed",
+        "failed",
+        "flaky",
+        "not-reached"
+      ]
+    },
+    "clip": {
+      "anyOf": [
+        {
+          "type": "object",
+          "properties": {
+            "video": {
+              "type": "string",
+              "minLength": 1
+            },
+            "poster": {
+              "type": "string"
+            },
+            "durationMs": {
+              "type": "number",
+              "minimum": 0
+            },
+            "captions": {
+              "description": "Proposed: a WebVTT file",
+              "type": "string"
+            },
+            "client": {
+              "description": "The client whose screen was recorded",
+              "type": "string"
+            },
+            "state": {
+              "type": "string",
+              "enum": [
+                "ready",
+                "processing",
+                "failed"
+              ]
+            }
+          },
+          "required": [
+            "video"
+          ]
+        },
+        {
+          "type": "null"
+        }
+      ]
+    },
+    "timeline": {
+      "type": "array",
+      "items": {}
+    },
+    "reason": {
+      "anyOf": [
+        {
+          "type": "string"
+        },
+        {
+          "type": "null"
+        }
+      ]
+    },
+    "reachedBy": {
+      "type": "array",
+      "items": {
+        "type": "string"
+      }
+    }
+  },
+  "required": [
+    "source",
+    "event",
+    "status"
+  ]
+}