@haystackeditor/cli 0.18.0 → 0.20.0

package/schemas/verify.v1.json

@@ -2,12 +2,33 @@
   "$schema": "https://json-schema.org/draft/2020-12/schema",
   "$id": "https://docs.haystackeditor.com/cli/schemas/verify.v1.json",
   "title": "Haystack verify: the crawl of the current change (CRAWL-V1)",
-  "description": "Machine-readable output of `haystack verify --json`: the caller's crawl of the exact captured checkout (its code and its change title), as GET /api/agent/cloud-verifier/crawls?repository=&workCommit= or, for a crawl the command just submitted, GET /api/agent/cloud-verifier/crawls/:runId?repository= returns it, or null when no crawl of the capture could be started. The crawl shapes mirror infra/lambda/haystack-design-verifier-shared/crawl_contracts.ts (with amendment 1); that file wins where they differ.",
+  "description": "Machine-readable output of `haystack verify --json`: the caller's crawl of the exact captured checkout (its code and its change title), as GET /api/agent/cloud-verifier/crawls?repository=&workCommit= or, for a crawl the command just submitted, GET /api/agent/cloud-verifier/crawls/:runId?repository= returns it, or null when no crawl of the capture could be started. The crawl shapes mirror infra/lambda/haystack-design-verifier-shared/crawl_contracts.ts (with amendments 1, 8, 9, 10 and 11); that file wins where they differ. Crawl amendment 11 (schema 1.0.1): when the capture's base is not onboarded yet, `onboarding` is the base's OnboardingStatusV1 (onboarding_contracts.ts, APP-ONBOARDING-V1) and `crawl` is null until the app is ready; it is null when onboarding was not involved.",
   "type": "object",
   "additionalProperties": false,
   "required": ["schema_version", "crawl"],
   "properties": {
-    "schema_version": { "const": "1.0.0" },
+    "onboarding": {
+      "oneOf": [
+        {
+          "type": "null"
+        },
+        {
+          "$ref": "#/$defs/onboardingStatus"
+        }
+      ]
+    },
+    "schema_version": { "const": "1.0.2" },
+    "change": {
+      "description": "Schema 1.0.2: what this verify checked: the capture's base commit (where HEAD meets origin's default branch), its work commit (committed and uncommitted changes), and the files that differ between them.",
+      "type": "object",
+      "additionalProperties": false,
+      "required": ["baseCommit", "workCommit", "files"],
+      "properties": {
+        "baseCommit": { "$ref": "#/$defs/commit" },
+        "workCommit": { "$ref": "#/$defs/commit" },
+        "files": { "type": "array", "items": { "type": "string" } }
+      }
+    },
     "crawl": {
       "oneOf": [
         { "type": "null" },
@@ -16,6 +37,253 @@
     }
   },
   "$defs": {
+    "onboardingBlock": {
+      "type": "object",
+      "required": [
+        "kind",
+        "stage",
+        "reason",
+        "evidence",
+        "ask"
+      ],
+      "properties": {
+        "kind": {
+          "enum": [
+            "not-enabled",
+            "no-web-app",
+            "unsupported",
+            "question",
+            "outside-credential",
+            "outside-dependency",
+            "evidence-too-large",
+            "budget",
+            "proof-failed"
+          ]
+        },
+        "stage": {
+          "enum": [
+            "admission",
+            "inventory",
+            "plan",
+            "runtime",
+            "boot",
+            "data",
+            "accounts",
+            "workflow",
+            "publish",
+            "cleanup"
+          ]
+        },
+        "reason": {
+          "type": "string"
+        },
+        "evidence": {
+          "$ref": "#/$defs/strings"
+        },
+        "names": {
+          "$ref": "#/$defs/strings"
+        },
+        "ask": {
+          "oneOf": [
+            {
+              "type": "null"
+            },
+            {
+              "type": "object",
+              "required": [
+                "message"
+              ],
+              "properties": {
+                "message": {
+                  "type": "string"
+                },
+                "command": {
+                  "type": "string"
+                },
+                "question": {
+                  "type": "object",
+                  "required": [
+                    "id",
+                    "choices"
+                  ],
+                  "properties": {
+                    "id": {
+                      "type": "string"
+                    },
+                    "choices": {
+                      "$ref": "#/$defs/strings"
+                    }
+                  }
+                }
+              }
+            }
+          ]
+        }
+      }
+    },
+    "onboardingStatus": {
+      "type": "object",
+      "required": [
+        "version",
+        "repository",
+        "baseCommit",
+        "state",
+        "onboardRunId",
+        "recordDigest",
+        "checkpoint",
+        "block",
+        "dataAbsences",
+        "versionChoices"
+      ],
+      "properties": {
+        "version": {
+          "const": "app-onboarding-v1"
+        },
+        "repository": {
+          "type": "string"
+        },
+        "baseCommit": {
+          "$ref": "#/$defs/commit"
+        },
+        "state": {
+          "enum": [
+            "ready",
+            "onboarding",
+            "blocked",
+            "incomplete",
+            "cancelled",
+            "not-started"
+          ]
+        },
+        "onboardRunId": {
+          "oneOf": [
+            {
+              "type": "null"
+            },
+            {
+              "type": "string",
+              "pattern": "^ob_[0-9a-f]{48}$"
+            }
+          ]
+        },
+        "recordDigest": {
+          "oneOf": [
+            {
+              "type": "null"
+            },
+            {
+              "type": "string",
+              "pattern": "^[0-9a-f]{64}$"
+            }
+          ]
+        },
+        "checkpoint": {
+          "oneOf": [
+            {
+              "type": "null"
+            },
+            {
+              "type": "object",
+              "required": [
+                "status",
+                "stage",
+                "execution",
+                "owned"
+              ],
+              "properties": {
+                "status": {
+                  "enum": [
+                    "queued",
+                    "running",
+                    "cleanup-pending",
+                    "published",
+                    "reused",
+                    "blocked",
+                    "incomplete",
+                    "cancelled"
+                  ]
+                },
+                "stage": {
+                  "enum": [
+                    "inventory",
+                    "plan",
+                    "runtime",
+                    "boot",
+                    "data",
+                    "accounts",
+                    "workflow",
+                    "publish",
+                    "cleanup"
+                  ]
+                },
+                "owned": {
+                  "$ref": "#/$defs/strings"
+                },
+                "execution": {
+                  "type": "object",
+                  "required": [
+                    "stages"
+                  ],
+                  "properties": {
+                    "stages": {
+                      "type": "array",
+                      "items": {
+                        "type": "object",
+                        "required": [
+                          "stage",
+                          "status"
+                        ],
+                        "properties": {
+                          "stage": {
+                            "enum": [
+                              "inventory",
+                              "plan",
+                              "runtime",
+                              "boot",
+                              "data",
+                              "accounts",
+                              "workflow",
+                              "publish",
+                              "cleanup"
+                            ]
+                          },
+                          "status": {
+                            "enum": [
+                              "pending",
+                              "running",
+                              "ok",
+                              "reused",
+                              "failed",
+                              "blocked"
+                            ]
+                          }
+                        }
+                      }
+                    }
+                  }
+                }
+              }
+            }
+          ]
+        },
+        "block": {
+          "oneOf": [
+            {
+              "type": "null"
+            },
+            {
+              "$ref": "#/$defs/onboardingBlock"
+            }
+          ]
+        },
+        "dataAbsences": {
+          "$ref": "#/$defs/strings"
+        },
+        "versionChoices": {
+          "$ref": "#/$defs/strings"
+        }
+      }
+    },
     "runId": { "type": "string", "pattern": "^cv_[0-9a-f]{48}$" },
     "commit": { "type": "string", "pattern": "^[0-9a-f]{40}$" },
     "count": { "type": "integer", "minimum": 0 },
@@ -97,8 +365,8 @@
         "findingIds": { "$ref": "#/$defs/strings" }
       }
     },
-    "manifest": {
-      "description": "Present once the crawl is terminal and published.",
+    "results": {
+      "description": "The published results' shape, shared by the sealed manifest and an answer; each sets its own status.",
       "type": "object",
       "required": ["schemaVersion", "runId", "attemptId", "repository", "baseCommit", "workCommit", "treeSha",
         "changeTitle", "status", "worlds", "reuse", "timings", "bugs", "findings", "reach", "notFinishedInTime", "error"],
@@ -111,7 +379,6 @@
         "workCommit": { "$ref": "#/$defs/commit" },
         "treeSha": { "$ref": "#/$defs/commit" },
         "changeTitle": { "type": "string", "maxLength": 200 },
-        "status": { "enum": ["completed", "incomplete", "cancelled"] },
         "worlds": {
           "oneOf": [
             { "type": "null" },
@@ -157,10 +424,27 @@
         "error": { "oneOf": [{ "type": "null" }, { "$ref": "#/$defs/error" }] }
       }
     },
+    "manifest": {
+      "description": "Present once the crawl is terminal and published.",
+      "allOf": [{ "$ref": "#/$defs/results" }],
+      "properties": {
+        "status": { "enum": ["completed", "incomplete", "cancelled"] }
+      }
+    },
+    "answer": {
+      "description": "CRAWL-V1 amendment 9: the current attempt's latest answer while no sealed manifest exists: what the crawl found so far (exploring), or its answer once its time is up (answered), with the same findings and reach the sealed manifest will carry. Its findings carry no images.",
+      "allOf": [{ "$ref": "#/$defs/results" }],
+      "required": ["n", "atSeconds"],
+      "properties": {
+        "status": { "enum": ["exploring", "answered"] },
+        "n": { "type": "integer", "minimum": 1, "description": "The attempt's answers are numbered from 1." },
+        "atSeconds": { "type": "integer", "minimum": 0, "description": "How far into the crawl stage it was written." }
+      }
+    },
     "crawlView": {
       "type": "object",
-      "required": ["runId", "repository", "baseCommit", "workCommit", "treeSha", "changeTitle", "observedAt",
-        "createdAt", "updatedAt", "supersededBy", "cancelRequested", "manifest", "status", "stage", "clocks",
+      "required": ["runId", "repository", "baseCommit", "workCommit", "treeSha", "changeTitle", "budgetMs", "observedAt",
+        "createdAt", "updatedAt", "supersededBy", "cancelRequested", "manifest", "answer", "status", "stage", "clocks",
         "reuse", "worlds", "totals"],
       "properties": {
         "runId": { "$ref": "#/$defs/runId" },
@@ -169,6 +453,8 @@
         "workCommit": { "$ref": "#/$defs/commit" },
         "treeSha": { "$ref": "#/$defs/commit" },
         "changeTitle": { "type": "string", "maxLength": 200 },
+        "budgetMs": { "description": "The time the crawl was asked for (ms), or null for the service's default.",
+          "oneOf": [{ "type": "null" }, { "type": "integer", "minimum": 60000, "maximum": 1800000 }] },
         "observedAt": { "$ref": "#/$defs/count" },
         "createdAt": { "type": "string", "format": "date-time" },
         "updatedAt": { "type": "string", "format": "date-time" },
@@ -210,7 +496,9 @@
           }
         },
         "error": { "$ref": "#/$defs/error" },
-        "manifest": { "oneOf": [{ "type": "null" }, { "$ref": "#/$defs/manifest" }] }
+        "manifest": { "oneOf": [{ "type": "null" }, { "$ref": "#/$defs/manifest" }] },
+        "answer": { "description": "Null once the sealed manifest exists, and before the crawl's first answer.",
+          "oneOf": [{ "type": "null" }, { "$ref": "#/$defs/answer" }] }
       }
     }
   }