@haystackeditor/cli 0.24.1 → 0.25.1

package/schemas/init.v1.json

@@ -2,12 +2,12 @@
   "$schema": "https://json-schema.org/draft/2020-12/schema",
   "$id": "https://docs.haystackeditor.com/cli/schemas/init.v1.json",
   "title": "Haystack init: this repository's setup for `haystack verify`",
-  "description": "Machine-readable output of `haystack init --json`. `changes` are the project-local changes init planned (made when status is done); `onboarding` is the base's OnboardingStatusV1 (onboarding_contracts.ts, APP-ONBOARDING-V1) as POST /api/agent/cloud-verifier/onboarding returns it, null unless status is done. `notes` says what became of `--notes`: \"written\" (the repository's onboarding notes are now these), \"unchanged\" (they already were), null without `--notes` or when init stopped before writing them. Exit codes: 0 done (onboarding running or ready), 1 failed (the error envelope), 2 planned (nothing written; run with --yes), 3 done but onboarding blocked, 4 login-required, 5 app-required (install the Haystack GitHub App), 6 done but onboarding stopped before finishing (run init again).",
+  "description": "Machine-readable output of `haystack init --json`. `changes` are the project-local changes init planned (made when status is done); `onboarding` is the base's OnboardingStatusV1 (onboarding_contracts.ts, APP-ONBOARDING-V1) as POST /api/agent/cloud-verifier/onboarding returns it, null unless status is done. `notes` says what became of `--notes`: \"written\" (the repository's onboarding notes are now these), \"unchanged\" (they already were), null without `--notes` or when init stopped before writing them. Exit codes: 0 done (onboarding running or ready), 1 failed (the error envelope), 2 planned (nothing written; run with --yes), 3 done but onboarding blocked, 4 login-required, 5 app-required (install the Haystack GitHub App), 6 done but onboarding stopped before finishing (run init again). `telemetry` (CAPTURE-V1 rule 8e, InitTelemetryReport in capture_contracts.ts) is what telemetry does (status done) or will do (planned, login-required: the same report before anything is written, every `received` null because nothing was checked): per part (`capture`, the browser tag; `server`, server telemetry) `installed`, `manual` with the exact `steps`, or `unsupported` with `why`, and `received`, the newest telemetry Haystack holds for this application (null when none; `stale` past 24 hours), plus `dbProfileCommand`, the `haystack db profile` command for the user to run with production read access (null when the app's database is not one it profiles). `telemetrySteps` is what the person does next for telemetry to arrive, in order, including the off switches; [] without telemetry.",
   "type": "object",
   "additionalProperties": false,
-  "required": ["schema_version", "status", "repository", "changes", "notices", "notes", "onboarding"],
+  "required": ["schema_version", "status", "repository", "changes", "notices", "notes", "onboarding", "telemetry", "telemetrySteps"],
   "properties": {
-    "schema_version": { "const": "1.0.1" },
+    "schema_version": { "const": "1.0.2" },
     "status": { "enum": ["done", "planned", "login-required", "app-required"] },
     "repository": { "type": "string" },
     "changes": {
@@ -18,7 +18,7 @@
         "required": ["path", "action", "reason", "diff"],
         "properties": {
           "path": { "type": "string" },
-          "action": { "enum": ["create", "update"] },
+          "action": { "enum": ["create", "update", "delete"] },
           "reason": { "type": "string" },
           "diff": { "type": "array", "items": { "type": "string" } }
         }
@@ -31,6 +31,65 @@
         { "type": "null" },
         { "$ref": "verify.v1.json#/$defs/onboardingStatus" }
       ]
+    },
+    "telemetry": {
+      "oneOf": [
+        { "type": "null" },
+        {
+          "type": "object",
+          "additionalProperties": false,
+          "required": ["capture", "server", "dbProfileCommand"],
+          "properties": {
+            "capture": { "$ref": "#/$defs/telemetryPart" },
+            "server": { "$ref": "#/$defs/telemetryPart" },
+            "dbProfileCommand": { "type": ["string", "null"] }
+          }
+        }
+      ]
+    },
+    "telemetrySteps": { "type": "array", "items": { "type": "string" } }
+  },
+  "$defs": {
+    "telemetryPart": {
+      "oneOf": [
+        {
+          "type": "object",
+          "additionalProperties": false,
+          "required": ["status", "received"],
+          "properties": { "status": { "const": "installed" }, "received": { "$ref": "#/$defs/telemetryReceived" } }
+        },
+        {
+          "type": "object",
+          "additionalProperties": false,
+          "required": ["status", "steps", "received"],
+          "properties": {
+            "status": { "const": "manual" },
+            "steps": { "type": "array", "items": { "type": "string" } },
+            "received": { "$ref": "#/$defs/telemetryReceived" }
+          }
+        },
+        {
+          "type": "object",
+          "additionalProperties": false,
+          "required": ["status", "why"],
+          "properties": { "status": { "const": "unsupported" }, "why": { "type": "string" } }
+        }
+      ]
+    },
+    "telemetryReceived": {
+      "oneOf": [
+        { "type": "null" },
+        {
+          "type": "object",
+          "additionalProperties": false,
+          "required": ["lastSeenAt", "release", "stale"],
+          "properties": {
+            "lastSeenAt": { "type": "string" },
+            "release": { "type": ["string", "null"] },
+            "stale": { "type": "boolean" }
+          }
+        }
+      ]
     }
   }
 }

package/schemas/pre-verify.v1.json

@@ -4,9 +4,9 @@
   "title": "haystack pre-verify --json",
   "description": "CRAWL-V1 amendment 18: the brief of the current change before any crawl: the functions it touches (the front half's blast radius, nearest first) and, when incident planning ran, Haystack's own ideas of what could break. `run` is the run of this capture that holds or will hold the brief; `brief` is null until it does (or when the run ended without one).",
   "type": "object",
-  "required": ["schema_version", "change", "onboarding", "run", "brief"],
+  "required": ["schema_version", "change", "onboarding", "run", "brief", "capture"],
   "properties": {
-    "schema_version": { "const": "1.0.1" },
+    "schema_version": { "const": "1.0.2" },
     "change": {
       "type": "object",
       "required": ["baseCommit", "workCommit", "files"],
@@ -30,9 +30,66 @@
         }
       ]
     },
-    "brief": { "oneOf": [{ "type": "null" }, { "$ref": "#/$defs/brief" }] }
+    "brief": { "oneOf": [{ "type": "null" }, { "$ref": "#/$defs/brief" }] },
+    "capture": {
+      "description": "CAPTURE-V1 rule 7b (1.0.2): what consenting real users do on the routes this change touches, from Haystack's capture tag; null when the checkout has no .haystack/capture.json (capture not set up). The change's files (the brief's function files and the changed files) are joined to routes through the route manifest's source entries; shares are of distinct captured sessions over the window; sessions on pages no route names are `unmapped`, never counted as zero. A read that fails is `unavailable` and never fails the command.",
+      "oneOf": [
+        { "type": "null" },
+        {
+          "type": "object", "additionalProperties": false, "required": ["applicationId", "state", "window"],
+          "properties": { "applicationId": { "type": "string" }, "state": { "const": "ready" }, "window": { "$ref": "#/$defs/captureWindow" } }
+        },
+        {
+          "type": "object", "additionalProperties": false, "required": ["applicationId", "state"],
+          "properties": { "applicationId": { "type": "string" }, "state": { "const": "no-data" } }
+        },
+        {
+          "type": "object", "additionalProperties": false, "required": ["applicationId", "state", "reason"],
+          "properties": { "applicationId": { "oneOf": [{ "type": "null" }, { "type": "string" }] }, "state": { "const": "unavailable" }, "reason": { "type": "string" } }
+        }
+      ]
+    }
   },
   "$defs": {
+    "captureWindow": {
+      "type": "object",
+      "required": ["applicationId", "days", "newestHour", "ageHours", "stale", "sessions", "routes", "union", "unmapped", "releasesWithoutManifest", "dropped"],
+      "properties": {
+        "applicationId": { "type": "string" },
+        "days": { "description": "The UTC days the window covers, oldest first.", "type": "array", "items": { "type": "string" } },
+        "newestHour": { "description": "The newest receipt hour holding events, yyyy-mm-ddThh (UTC).", "oneOf": [{ "type": "null" }, { "type": "string" }] },
+        "ageHours": { "oneOf": [{ "type": "null" }, { "type": "number", "minimum": 0 }] },
+        "stale": { "description": "Older than 24 hours, or no data.", "type": "boolean" },
+        "sessions": { "description": "Distinct captured sessions in the window.", "type": "integer", "minimum": 0 },
+        "routes": {
+          "description": "The changed routes, most sessions first.",
+          "type": "array",
+          "items": {
+            "type": "object",
+            "required": ["route", "match", "source", "sessions", "share"],
+            "properties": {
+              "route": { "description": "The route id from the app's route manifest.", "type": "string" },
+              "match": { "description": "Its match rule, in the framework adapter's syntax.", "type": "string" },
+              "source": { "description": "The repository file that defines it.", "type": "string" },
+              "sessions": { "type": "integer", "minimum": 0 },
+              "share": { "oneOf": [{ "type": "null" }, { "type": "number", "minimum": 0, "maximum": 1 }] }
+            }
+          }
+        },
+        "union": {
+          "description": "Sessions that visited at least one changed route (exact, not a sum).",
+          "type": "object", "required": ["sessions", "share"],
+          "properties": { "sessions": { "type": "integer", "minimum": 0 }, "share": { "oneOf": [{ "type": "null" }, { "type": "number", "minimum": 0, "maximum": 1 }] } }
+        },
+        "unmapped": {
+          "description": "Sessions on pages no route names: unknown whether they reach the change.",
+          "oneOf": [{ "type": "null" }, { "type": "object", "required": ["sessions", "share"],
+            "properties": { "sessions": { "type": "integer", "minimum": 0 }, "share": { "oneOf": [{ "type": "null" }, { "type": "number", "minimum": 0, "maximum": 1 }] } } }]
+        },
+        "releasesWithoutManifest": { "description": "Releases whose route manifest Haystack does not hold; their pages are unmapped.", "type": "array", "items": { "type": "string" } },
+        "dropped": { "description": "Events dropped at ingest in the window, per reason.", "type": "object", "additionalProperties": { "type": "integer", "minimum": 0 } }
+      }
+    },
     "brief": {
       "type": "object",
       "required": ["functions", "leftOut", "planning"],