@crvouga/atlas 0.0.0-stage → 0.2.0

package/packages/schema/schemas/run-summary.schema.json

@@ -0,0 +1,206 @@
+{
+  "$id": "https://github.com/crvouga/atlas/schemas/run-summary.schema.json",
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "type": "object",
+  "properties": {
+    "id": {
+      "type": "string",
+      "minLength": 1
+    },
+    "startedAt": {
+      "type": "string"
+    },
+    "mode": {
+      "type": "string"
+    },
+    "commit": {
+      "anyOf": [
+        {
+          "type": "string"
+        },
+        {
+          "type": "null"
+        }
+      ]
+    },
+    "branch": {
+      "anyOf": [
+        {
+          "type": "string"
+        },
+        {
+          "type": "null"
+        }
+      ]
+    },
+    "durationMs": {
+      "type": "number",
+      "minimum": 0
+    },
+    "specVersion": {
+      "type": "string"
+    },
+    "progress": {
+      "description": "Absent means complete",
+      "type": "string",
+      "enum": [
+        "running",
+        "complete"
+      ]
+    },
+    "execution": {
+      "type": "object",
+      "properties": {
+        "totalPaths": {
+          "type": "integer",
+          "minimum": 0,
+          "maximum": 9007199254740991
+        },
+        "completedPaths": {
+          "type": "integer",
+          "minimum": 0,
+          "maximum": 9007199254740991
+        },
+        "activePaths": {
+          "type": "array",
+          "items": {
+            "type": "string"
+          }
+        },
+        "updatedAt": {
+          "type": "string"
+        }
+      },
+      "required": [
+        "totalPaths",
+        "completedPaths",
+        "activePaths",
+        "updatedAt"
+      ]
+    },
+    "hasManifest": {
+      "description": "False while the first snapshot has not arrived",
+      "type": "boolean"
+    },
+    "coverage": {
+      "type": "object",
+      "properties": {
+        "states": {
+          "type": "object",
+          "properties": {
+            "total": {
+              "type": "integer",
+              "minimum": 0,
+              "maximum": 9007199254740991
+            },
+            "passed": {
+              "type": "integer",
+              "minimum": 0,
+              "maximum": 9007199254740991
+            },
+            "failed": {
+              "type": "integer",
+              "minimum": 0,
+              "maximum": 9007199254740991
+            },
+            "flaky": {
+              "type": "integer",
+              "minimum": 0,
+              "maximum": 9007199254740991
+            },
+            "notReached": {
+              "type": "integer",
+              "minimum": 0,
+              "maximum": 9007199254740991
+            }
+          },
+          "required": [
+            "total",
+            "passed",
+            "failed",
+            "flaky",
+            "notReached"
+          ]
+        },
+        "transitions": {
+          "type": "object",
+          "properties": {
+            "total": {
+              "type": "integer",
+              "minimum": 0,
+              "maximum": 9007199254740991
+            },
+            "passed": {
+              "type": "integer",
+              "minimum": 0,
+              "maximum": 9007199254740991
+            },
+            "failed": {
+              "type": "integer",
+              "minimum": 0,
+              "maximum": 9007199254740991
+            },
+            "flaky": {
+              "type": "integer",
+              "minimum": 0,
+              "maximum": 9007199254740991
+            },
+            "notReached": {
+              "type": "integer",
+              "minimum": 0,
+              "maximum": 9007199254740991
+            }
+          },
+          "required": [
+            "total",
+            "passed",
+            "failed",
+            "flaky",
+            "notReached"
+          ]
+        }
+      }
+    },
+    "journeys": {
+      "type": "object",
+      "properties": {
+        "total": {
+          "type": "integer",
+          "minimum": 0,
+          "maximum": 9007199254740991
+        },
+        "passed": {
+          "type": "integer",
+          "minimum": 0,
+          "maximum": 9007199254740991
+        },
+        "failed": {
+          "type": "integer",
+          "minimum": 0,
+          "maximum": 9007199254740991
+        },
+        "flaky": {
+          "type": "integer",
+          "minimum": 0,
+          "maximum": 9007199254740991
+        },
+        "notReached": {
+          "type": "integer",
+          "minimum": 0,
+          "maximum": 9007199254740991
+        }
+      },
+      "required": [
+        "total",
+        "passed",
+        "failed",
+        "flaky",
+        "notReached"
+      ]
+    }
+  },
+  "required": [
+    "id",
+    "startedAt"
+  ]
+}

package/packages/schema/schemas/runs-index.schema.json

@@ -0,0 +1,23 @@
+{
+  "$id": "https://github.com/crvouga/atlas/schemas/runs-index.schema.json",
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "type": "object",
+  "properties": {
+    "generatedAt": {
+      "type": "string"
+    },
+    "runs": {
+      "type": "array",
+      "items": {}
+    },
+    "excluded": {
+      "type": "array",
+      "items": {
+        "type": "string"
+      }
+    }
+  },
+  "required": [
+    "runs"
+  ]
+}

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

@@ -0,0 +1,238 @@
+{
+  "$id": "https://github.com/crvouga/atlas/schemas/state-node.schema.json",
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "type": "object",
+  "properties": {
+    "id": {
+      "type": "string"
+    },
+    "initial": {
+      "type": "string"
+    },
+    "type": {
+      "type": "string",
+      "enum": [
+        "parallel",
+        "final"
+      ]
+    },
+    "meta": {
+      "type": "object",
+      "properties": {
+        "description": {
+          "type": "string"
+        },
+        "snapshot": {
+          "type": "string"
+        },
+        "events": {
+          "description": "Business events that happen on entering the state",
+          "type": "array",
+          "items": {
+            "type": "string"
+          }
+        },
+        "confidence": {
+          "type": "string",
+          "enum": [
+            "confirmed",
+            "assumed"
+          ]
+        },
+        "source": {
+          "type": "array",
+          "items": {
+            "type": "string"
+          }
+        },
+        "checks": {
+          "type": "array",
+          "items": {
+            "type": "string"
+          }
+        },
+        "childMachine": {
+          "type": "string"
+        },
+        "childFinalEvents": {
+          "type": "object",
+          "propertyNames": {
+            "type": "string"
+          },
+          "additionalProperties": {
+            "type": "string"
+          }
+        },
+        "deadEnd": {
+          "type": "string"
+        },
+        "owner": {
+          "type": "string"
+        },
+        "tier": {
+          "type": "string"
+        },
+        "quint": {
+          "description": "Quint model reference",
+          "type": "string"
+        },
+        "gherkin": {
+          "description": "Feature files or scenarios that cover the state",
+          "type": "array",
+          "items": {
+            "type": "string"
+          }
+        },
+        "contracts": {
+          "description": "Business rules and their exact Given/When/Then examples, copied from the authoritative source",
+          "type": "array",
+          "items": {
+            "type": "object",
+            "properties": {
+              "id": {
+                "type": "string",
+                "minLength": 1
+              },
+              "name": {
+                "type": "string",
+                "minLength": 1
+              },
+              "source": {
+                "type": "string",
+                "minLength": 1
+              },
+              "description": {
+                "type": "string"
+              },
+              "steps": {
+                "type": "array",
+                "items": {
+                  "type": "object",
+                  "properties": {
+                    "keyword": {
+                      "type": "string",
+                      "minLength": 1
+                    },
+                    "text": {
+                      "type": "string"
+                    },
+                    "table": {
+                      "type": "array",
+                      "items": {
+                        "type": "array",
+                        "items": {
+                          "type": "string"
+                        }
+                      }
+                    },
+                    "docString": {
+                      "type": "string"
+                    }
+                  },
+                  "required": [
+                    "keyword",
+                    "text"
+                  ]
+                }
+              }
+            },
+            "required": [
+              "id",
+              "name",
+              "source",
+              "steps"
+            ]
+          }
+        },
+        "design": {
+          "type": "object",
+          "properties": {
+            "image": {
+              "description": "URL or spec-relative path of a design frame",
+              "type": "string",
+              "minLength": 1
+            },
+            "url": {
+              "description": "Where the design lives, for example a Figma frame link",
+              "type": "string"
+            },
+            "label": {
+              "type": "string"
+            }
+          },
+          "required": [
+            "image"
+          ]
+        },
+        "hints": {
+          "description": "What the screen shows, for the placeholder sketch",
+          "type": "array",
+          "items": {
+            "type": "string"
+          }
+        },
+        "eventKinds": {
+          "description": "Chart-level: who or what sends each event; overrides the runner and the guess",
+          "type": "object",
+          "propertyNames": {
+            "type": "string"
+          },
+          "additionalProperties": {
+            "type": "string",
+            "enum": [
+              "user",
+              "system",
+              "time",
+              "hand-off"
+            ]
+          }
+        },
+        "timeEvents": {
+          "description": "Chart-level: time events and the span each one jumps, for example \"5 minutes\"",
+          "type": "object",
+          "propertyNames": {
+            "type": "string"
+          },
+          "additionalProperties": {
+            "type": "string"
+          }
+        }
+      }
+    },
+    "states": {
+      "type": "object",
+      "propertyNames": {
+        "type": "string"
+      },
+      "additionalProperties": {
+        "$ref": "#"
+      }
+    },
+    "on": {
+      "type": "object",
+      "propertyNames": {
+        "type": "string"
+      },
+      "additionalProperties": {
+        "anyOf": [
+          {
+            "type": "string",
+            "minLength": 1
+          },
+          {
+            "type": "object",
+            "properties": {
+              "target": {
+                "type": "string",
+                "minLength": 1
+              }
+            },
+            "required": [
+              "target"
+            ]
+          }
+        ]
+      }
+    }
+  }
+}