@wenathlan/devthink 2.0.15 → 2.0.19

package/schemas/audit.schema.json

@@ -0,0 +1,226 @@
+{
+  "$id": "devthink/protocolv2/audit.schema.json",
+  "version": "1.0.0",
+  "title": "the frozen audit event contract of the api freeze",
+  "description": "freezes the audit trail event shape and the complete audit event name vocabulary: every audit entry carries its id, its event kind of the frozen enum, its epoch, its plain language summary and the optional session, plan and step provenance; the event names join the frozen contract so a log consumer of any release reads the trail of any other release of protocolv2.",
+  "type": "object",
+  "properties": {
+    "id": {
+      "type": "string",
+      "description": "the audit entry id"
+    },
+    "kind": {
+      "type": "string",
+      "description": "the audit event name of the frozen vocabulary",
+      "enum": [
+        "a11y",
+        "action",
+        "adapter",
+        "approval",
+        "arbitrate",
+        "attention",
+        "auth",
+        "backgroundrun",
+        "badge",
+        "batch",
+        "batchquery",
+        "battery",
+        "bridge",
+        "budget",
+        "cache",
+        "call",
+        "cancel",
+        "capability",
+        "capture",
+        "checkpoint",
+        "chunkextract",
+        "cleanup",
+        "clipboard",
+        "compare",
+        "complete",
+        "compress",
+        "configure",
+        "consent",
+        "consentmemory",
+        "control",
+        "correction",
+        "correlate",
+        "datagrid",
+        "debounce",
+        "debugger",
+        "dedupe",
+        "defer",
+        "deny",
+        "dialog",
+        "diff",
+        "discard",
+        "doctor",
+        "download",
+        "dropimport",
+        "emulation",
+        "environment",
+        "error",
+        "escalate",
+        "expiry",
+        "export",
+        "exporttool",
+        "fill",
+        "flowrun",
+        "gate",
+        "gateway",
+        "grant",
+        "ground",
+        "group",
+        "handoff",
+        "headless",
+        "hold",
+        "importexport",
+        "inbound",
+        "incrsnapshot",
+        "intercept",
+        "kill",
+        "lane",
+        "layout",
+        "lazyload",
+        "lesson",
+        "library",
+        "locale",
+        "lock",
+        "logprune",
+        "logstream",
+        "mask",
+        "mcpmode",
+        "media",
+        "minimize",
+        "model",
+        "native",
+        "navigation",
+        "network",
+        "notes",
+        "notify",
+        "observation",
+        "observe",
+        "ocr",
+        "omnibox",
+        "onboarding",
+        "outputcompare",
+        "pagechip",
+        "palette",
+        "pause",
+        "perf",
+        "phish",
+        "picker",
+        "planlint",
+        "platform",
+        "pointer",
+        "poll",
+        "post",
+        "preconnect",
+        "prefetch",
+        "profile",
+        "proposal",
+        "protocol",
+        "provenance",
+        "purge",
+        "quarantine",
+        "queue",
+        "quickaction",
+        "rate",
+        "reap",
+        "recall",
+        "recent",
+        "redact",
+        "redirect",
+        "reopen",
+        "replay",
+        "resume",
+        "retry",
+        "review",
+        "revoke",
+        "rollback",
+        "runcache",
+        "runreplay",
+        "safecheck",
+        "sample",
+        "sandbox",
+        "scaffold",
+        "scale",
+        "schedule",
+        "schema",
+        "scrape",
+        "scratchpad",
+        "seal",
+        "search",
+        "selcache",
+        "session",
+        "sessionreuse",
+        "shortcut",
+        "shotpanel",
+        "siteprofile",
+        "slowmo",
+        "socket",
+        "spawn",
+        "startup",
+        "stop",
+        "stream",
+        "streamparse",
+        "submit",
+        "subscribe",
+        "summary",
+        "surface",
+        "suspend",
+        "swarm",
+        "sync",
+        "syncbridge",
+        "tab",
+        "theme",
+        "thumb",
+        "timelapse",
+        "timeline",
+        "timeout",
+        "toast",
+        "tool",
+        "tour",
+        "transform",
+        "transparency",
+        "trigger",
+        "vault",
+        "virtlist",
+        "vision",
+        "visit",
+        "vote",
+        "warm",
+        "watch",
+        "window",
+        "worker",
+        "workflow"
+      ]
+    },
+    "at": {
+      "type": "number",
+      "description": "the epoch milliseconds of the entry"
+    },
+    "summary": {
+      "type": "string",
+      "description": "the plain language summary of the entry"
+    },
+    "sessionid": {
+      "type": "string",
+      "description": "the session the entry provenance names"
+    },
+    "planid": {
+      "type": "string",
+      "description": "the plan the entry provenance names"
+    },
+    "stepid": {
+      "type": "string",
+      "description": "the step the entry provenance names"
+    }
+  },
+  "required": [
+    "id",
+    "kind",
+    "at",
+    "summary"
+  ]
+}

package/schemas/capability.schema.json

@@ -0,0 +1,113 @@
+{
+  "$id": "devthink/protocolv2/capability.schema.json",
+  "version": "1.0.0",
+  "title": "the frozen capability report contract of the api freeze",
+  "description": "freezes the capability report the proposal request carries and the surfaces render: the granted optional permissions with the capture, media, network, session, debug, profile, emulation, workflow and vision kind families the grants cover.",
+  "type": "object",
+  "properties": {
+    "tabs": {
+      "type": "boolean",
+      "description": "the optional tabs permission grant"
+    },
+    "downloads": {
+      "type": "boolean",
+      "description": "the optional downloads permission grant"
+    },
+    "clipboardread": {
+      "type": "boolean",
+      "description": "the optional clipboard read permission grant"
+    },
+    "clipboardwrite": {
+      "type": "boolean",
+      "description": "the optional clipboard write permission grant"
+    },
+    "captures": {
+      "type": "array",
+      "description": "the capture kinds the active tab grant already covers",
+      "items": {
+        "type": "string"
+      }
+    },
+    "media": {
+      "type": "array",
+      "description": "the media capture kinds the grants cover",
+      "items": {
+        "type": "string"
+      }
+    },
+    "http": {
+      "type": "array",
+      "description": "the outbound request kinds the granted origins cover",
+      "items": {
+        "type": "string"
+      }
+    },
+    "netwatch": {
+      "type": "array",
+      "description": "the network observation kinds the grants cover",
+      "items": {
+        "type": "string"
+      }
+    },
+    "control": {
+      "type": "array",
+      "description": "the network control kinds the grants cover",
+      "items": {
+        "type": "string"
+      }
+    },
+    "sessions": {
+      "type": "array",
+      "description": "the session memory kinds the grants cover",
+      "items": {
+        "type": "string"
+      }
+    },
+    "debug": {
+      "type": "array",
+      "description": "the debugging kinds the grants cover",
+      "items": {
+        "type": "string"
+      }
+    },
+    "profile": {
+      "type": "array",
+      "description": "the profiling kinds the grants cover",
+      "items": {
+        "type": "string"
+      }
+    },
+    "emulation": {
+      "type": "array",
+      "description": "the emulation kinds the grants cover",
+      "items": {
+        "type": "string"
+      }
+    },
+    "workflow": {
+      "type": "array",
+      "description": "the workflow kinds the plan review gates cover",
+      "items": {
+        "type": "string"
+      }
+    },
+    "vision": {
+      "type": "array",
+      "description": "the vision kinds the grants cover",
+      "items": {
+        "type": "string"
+      }
+    },
+    "reportedat": {
+      "type": "number",
+      "description": "the epoch milliseconds of the report"
+    }
+  },
+  "required": [
+    "tabs",
+    "downloads",
+    "clipboardread",
+    "clipboardwrite",
+    "reportedat"
+  ]
+}

package/schemas/envelope.schema.json

@@ -0,0 +1,162 @@
+{
+  "$id": "devthink/protocolv2/envelope.schema.json",
+  "version": "1.0.0",
+  "title": "the frozen response envelope contract of the api freeze",
+  "description": "freezes the response envelope and its three outcomes — success, error and cancel — with the stable error code table, the json rpc frame grammar, the servercontract envelope of the site bridge and the stdio and http framing rules; every reply the protocol writes answers in exactly one of the three outcome classes and every error code documents its retry semantics.",
+  "type": "object",
+  "outcomes": {
+    "description": "the frozen outcome classes of the response envelope",
+    "values": [
+      "success",
+      "error",
+      "cancel"
+    ]
+  },
+  "responseenvelope": {
+    "description": "the frozen versioned response envelope fields",
+    "type": "object",
+    "properties": {
+      "version": {
+        "type": "string",
+        "description": "the frozen protocol version of the envelope"
+      },
+      "outcome": {
+        "type": "object",
+        "description": "the step outcome of a successful reply"
+      },
+      "error": {
+        "type": "object",
+        "description": "the error of a failed reply with the code of the stable table"
+      },
+      "cancelled": {
+        "type": "boolean",
+        "description": "the marker of a cancelled reply whose partial result rides the payload"
+      }
+    },
+    "required": [
+      "version"
+    ]
+  },
+  "errorcodetable": {
+    "description": "the stable error code table with the retry semantics of every code",
+    "type": "array",
+    "items": [
+      {
+        "code": "parse",
+        "retry": "never",
+        "type": "string",
+        "description": "the wire frame does not parse as json; the same bytes never parse on a retry"
+      },
+      {
+        "code": "method",
+        "retry": "never",
+        "type": "string",
+        "description": "the server routes no method of the name the frame carries; the method table is frozen"
+      },
+      {
+        "code": "params",
+        "retry": "immediate",
+        "type": "string",
+        "description": "the frame parses but its params fail the frozen schema or the negotiation range; the client may retry immediately once its params carry the reviewed fields"
+      },
+      {
+        "code": "internal",
+        "retry": "afterbackoff",
+        "type": "string",
+        "description": "the handler failed inside the server; the client retries behind the reviewed backoff"
+      },
+      {
+        "code": "consentrefused",
+        "retry": "never",
+        "type": "string",
+        "description": "the consent gates refused the call; no retry passes without a new human decision"
+      }
+    ]
+  },
+  "jsonrpcframe": {
+    "description": "the frozen json rpc frame grammar",
+    "type": "object",
+    "properties": {
+      "jsonrpc": {
+        "type": "string",
+        "description": "the json rpc tag of the frozen wire",
+        "const": "2.0"
+      },
+      "id": {
+        "type": "number",
+        "description": "the request id the reply quotes; a string id or null answers the failure classes"
+      },
+      "method": {
+        "type": "string",
+        "description": "the method name of the frozen routing table"
+      },
+      "params": {
+        "type": "object",
+        "description": "the method parameters"
+      },
+      "result": {
+        "type": "object",
+        "description": "the result of a successful reply"
+      },
+      "error": {
+        "type": "object",
+        "description": "the error of a failed reply with the code, message and optional data"
+      }
+    },
+    "required": [
+      "jsonrpc"
+    ]
+  },
+  "serverenvelope": {
+    "description": "the frozen servercontract envelope of the site bridge",
+    "type": "object",
+    "properties": {
+      "version": {
+        "type": "number",
+        "description": "the negotiated servercontract version of the handshake"
+      },
+      "op": {
+        "type": "string",
+        "description": "the wire operation",
+        "enum": [
+          "sessioncreate",
+          "sessionjoin",
+          "eventpost",
+          "eventstream"
+        ]
+      },
+      "opid": {
+        "type": "string",
+        "description": "the stable operation id every reply quotes for correlation"
+      },
+      "sessionid": {
+        "type": "string",
+        "description": "the session the frame authenticates"
+      },
+      "token": {
+        "type": "string",
+        "description": "the session token that rides frames only"
+      },
+      "at": {
+        "type": "number",
+        "description": "the epoch milliseconds of the frame"
+      },
+      "body": {
+        "type": "object",
+        "description": "the operation payload"
+      }
+    },
+    "required": [
+      "version",
+      "op",
+      "opid",
+      "at"
+    ]
+  },
+  "framingrules": {
+    "description": "the frozen stdio and http framing rules",
+    "type": "object",
+    "stdio": "one newline delimited json frame per block on stdin with one reply frame per line on stdout; the frame size bound stays the user configured limit with no code default",
+    "http": "one json frame per http post body on the localhost listener with the reply in the response body under the same user configured frame size bound; no other verb carries frames"
+  }
+}

package/schemas/memory.schema.json

@@ -0,0 +1,51 @@
+{
+  "$id": "devthink/protocolv2/memory.schema.json",
+  "version": "1.0.0",
+  "title": "the frozen memory record contract of the api freeze",
+  "description": "freezes the memory record field names and the provenance grammar: every memory payload carries its key, its value and its full provenance of origin, runid, stepid and capturedat before the protocol accepts it, while the memoryclass, expiry and encrypted flag stay optional; a payload that carries the version field must carry the frozen protocol version.",
+  "type": "object",
+  "properties": {
+    "version": {
+      "type": "string",
+      "description": "the frozen protocol version of the versioned envelope; an absent version stays the version one tolerance of the deprecation window"
+    },
+    "key": {
+      "type": "string",
+      "description": "the storage key the record family persists under"
+    },
+    "value": {
+      "type": "object",
+      "description": "the record value of any json shape"
+    },
+    "provenance": {
+      "type": "object",
+      "description": "the full provenance block the protocol requires"
+    },
+    "memoryclass": {
+      "type": "string",
+      "description": "the data class of the record family"
+    },
+    "expiresat": {
+      "type": "number",
+      "description": "the epoch milliseconds the user expiry removes the record at"
+    },
+    "encrypted": {
+      "type": "boolean",
+      "description": "the flag that marks a value encrypted at rest"
+    }
+  },
+  "required": [
+    "key",
+    "value",
+    "provenance"
+  ],
+  "provenancefields": {
+    "description": "the frozen provenance field names every memory payload must carry in full",
+    "fields": [
+      "origin",
+      "runid",
+      "stepid",
+      "capturedat"
+    ]
+  }
+}

package/schemas/observation.schema.json

@@ -0,0 +1,113 @@
+{
+  "$id": "devthink/protocolv2/observation.schema.json",
+  "version": "1.0.0",
+  "title": "the frozen observation payload contract of the api freeze",
+  "description": "freezes the observation payload: the schemaversion field stays forward compatible — a consumer accepts every observation whose schemaversion sits at or above its own because additions land inside the reserved fields map, never as a removed or retyped named field; the reserved map carries the future additions the freeze admits without a breaking change.",
+  "type": "object",
+  "properties": {
+    "schemaversion": {
+      "type": "number",
+      "description": "the observation schema version kept forward compatible: additions raise it and never break a consumer of an older version because new fields ride the reserved map"
+    },
+    "url": {
+      "type": "string",
+      "description": "the observed page url"
+    },
+    "title": {
+      "type": "string",
+      "description": "the observed page title"
+    },
+    "textpreview": {
+      "type": "string",
+      "description": "the bounded text preview of the page"
+    },
+    "textlength": {
+      "type": "number",
+      "description": "the full text length the preview abbreviates"
+    },
+    "forms": {
+      "type": "array",
+      "description": "the detected forms with label, type, name and options",
+      "items": {
+        "type": "object"
+      }
+    },
+    "interactive": {
+      "type": "array",
+      "description": "the interactive elements with selector, role and label",
+      "items": {
+        "type": "object"
+      }
+    },
+    "capturedat": {
+      "type": "number",
+      "description": "the epoch milliseconds of the capture"
+    },
+    "environment": {
+      "type": "string",
+      "description": "the execution environment of the capture"
+    },
+    "mode": {
+      "type": "string",
+      "description": "the observation mode",
+      "enum": [
+        "passive",
+        "watching",
+        "diffing"
+      ]
+    },
+    "a11y": {
+      "type": "object",
+      "description": "the accessibility tree section"
+    },
+    "reader": {
+      "type": "object",
+      "description": "the reader view article section"
+    },
+    "listpattern": {
+      "type": "array",
+      "description": "the repeated list patterns detected on the page",
+      "items": {
+        "type": "object"
+      }
+    },
+    "tableshape": {
+      "type": "array",
+      "description": "the data table shapes detected on the page",
+      "items": {
+        "type": "object"
+      }
+    },
+    "diff": {
+      "type": "object",
+      "description": "the snapshot diff section of two compared versions"
+    },
+    "delta": {
+      "type": "boolean",
+      "description": "the flag that marks an incrsnapshot delta payload"
+    },
+    "digest": {
+      "type": "string",
+      "description": "the content digest checkpoints compare against"
+    },
+    "vision": {
+      "type": "object",
+      "description": "the vision block with descriptions, ocr text and groundings"
+    },
+    "reserved": {
+      "type": "object",
+      "description": "the reserved fields map of future additions: reserved entries never refuse a payload and never rename a frozen field, so the observation schema keeps its version field forward compatible"
+    }
+  },
+  "required": [
+    "schemaversion",
+    "url",
+    "title",
+    "textpreview",
+    "textlength",
+    "forms",
+    "interactive",
+    "capturedat"
+  ],
+  "forwardcompatible": "the schemaversion field: a payload of a higher schemaversion stays acceptable to a consumer of a lower one when the new material rides the reserved map"
+}