@agent-teams/docs-protocol 0.1.4 → 0.3.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@agent-teams/docs-protocol",
-  "version": "0.1.4",
+  "version": "0.3.0",
   "description": "Unified deterministic documentation authoring protocol for Agent Teams repositories.",
   "license": "Apache-2.0",
   "type": "module",
@@ -24,10 +24,16 @@
     "dist",
     "schemas/docs-protocol/v1.schema.json",
     "schemas/docs-protocol-profile/v1.schema.json",
+    "schemas/docs-protocol-profile/v2.schema.json",
     "schemas/docs-protocol-command-envelope/v1.schema.json",
+    "schemas/docs-protocol-command-envelope/v2.schema.json",
     "schemas/docs-consumer-integration-execution/v1.schema.json",
     "schemas/docs-consumer-integration-plan/v1.schema.json",
     "schemas/docs-consumer-integration-profile/v1.schema.json",
+    "schemas/docs-consumer-integration-profile/v2.schema.json",
+    "schemas/docs-consumer-upgrade-execution/v1.schema.json",
+    "schemas/docs-protocol-qualification/v2.schema.json",
+    "schemas/docs-protocol-qualification-receipt/v2.schema.json",
     "schemas/docs-consumer-managed-state/v1.schema.json",
     "schemas/qualified-docs-cohort/v1.schema.json",
     "skills/docs/SKILL.md",
@@ -59,7 +65,7 @@
     "ajv-formats": "3.0.1",
     "jsonc-parser": "3.3.1",
     "yaml": "2.9.0",
-    "@agent-teams/engineering-foundation": "0.19.0"
+    "@agent-teams/engineering-foundation": "0.20.0"
   },
   "devDependencies": {
     "@types/node": "24.13.3",

package/schemas/docs-consumer-integration-profile/v2.schema.json

@@ -0,0 +1,283 @@
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "$id": "https://agent-teams.ai/schemas/docs-consumer-integration-profile/v2",
+  "type": "object",
+  "additionalProperties": false,
+  "required": [
+    "schemaVersion",
+    "repository",
+    "integrationRoot",
+    "packageManager",
+    "profilePath",
+    "skillPath",
+    "callerWorkflowPath",
+    "managedStatePath",
+    "cohort",
+    "qualification"
+  ],
+  "properties": {
+    "schemaVersion": {
+      "const": 2
+    },
+    "repository": {
+      "type": "object",
+      "additionalProperties": false,
+      "required": [
+        "provider",
+        "id",
+        "nameWithOwner"
+      ],
+      "properties": {
+        "provider": {
+          "const": "github"
+        },
+        "id": {
+          "type": "string",
+          "pattern": "^[1-9][0-9]*$"
+        },
+        "nameWithOwner": {
+          "type": "string",
+          "pattern": "^[A-Za-z0-9_.-]+/[A-Za-z0-9_.-]+$"
+        }
+      }
+    },
+    "integrationRoot": {
+      "const": "."
+    },
+    "packageManager": {
+      "const": "pnpm"
+    },
+    "profilePath": {
+      "const": "architecture/foundation/docs-protocol.yaml"
+    },
+    "skillPath": {
+      "const": ".agents/skills/docs-authoring/SKILL.md"
+    },
+    "callerWorkflowPath": {
+      "const": ".github/workflows/docs-protocol.yml"
+    },
+    "managedStatePath": {
+      "const": "architecture/foundation/docs-protocol-managed-state.json"
+    },
+    "qualification": {
+      "type": "object",
+      "additionalProperties": false,
+      "required": [
+        "contractPath",
+        "gateCommand"
+      ],
+      "properties": {
+        "contractPath": {
+          "const": "architecture/foundation/docs-protocol-qualification.json"
+        },
+        "gateCommand": {
+          "const": "pnpm docs:protocol:check"
+        }
+      }
+    },
+    "governedDocsRoots": {
+      "type": "array",
+      "minItems": 1,
+      "maxItems": 32,
+      "uniqueItems": true,
+      "items": {
+        "type": "string",
+        "minLength": 1,
+        "maxLength": 512,
+        "pattern": "^(?!.*(?:^|/)\\.{1,2}(?:/|$))[A-Za-z0-9._@-]{1,255}(?:/[A-Za-z0-9._@-]{1,255})*$"
+      }
+    },
+    "cohort": {
+      "$ref": "#/$defs/cohortBinding"
+    }
+  },
+  "$defs": {
+    "cohortBinding": {
+      "type": "object",
+      "additionalProperties": false,
+      "required": [
+        "schemaVersion",
+        "cohortId",
+        "channel",
+        "recordDigest",
+        "qualificationEventDigest",
+        "eligibleAfter",
+        "upgradeFrom",
+        "rollbackTo",
+        "packages",
+        "workflow",
+        "assets",
+        "schemas",
+        "runtime"
+      ],
+      "properties": {
+        "schemaVersion": {
+          "const": 1
+        },
+        "cohortId": {
+          "type": "string",
+          "pattern": "^[a-z0-9]+(?:[._-][a-z0-9]+)*$"
+        },
+        "channel": {
+          "enum": [
+            "rc",
+            "stable"
+          ]
+        },
+        "recordDigest": {
+          "$ref": "#/$defs/nonzeroSha256"
+        },
+        "qualificationEventDigest": {
+          "$ref": "#/$defs/nonzeroSha256"
+        },
+        "eligibleAfter": {
+          "type": "string",
+          "pattern": "^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}Z$"
+        },
+        "upgradeFrom": {
+          "$ref": "#/$defs/cohortIds"
+        },
+        "rollbackTo": {
+          "$ref": "#/$defs/cohortIds"
+        },
+        "packages": {
+          "type": "object",
+          "additionalProperties": false,
+          "required": [
+            "docsProtocol",
+            "engineeringFoundation"
+          ],
+          "properties": {
+            "docsProtocol": {
+              "$ref": "#/$defs/package"
+            },
+            "engineeringFoundation": {
+              "$ref": "#/$defs/package"
+            }
+          }
+        },
+        "workflow": {
+          "type": "object",
+          "additionalProperties": false,
+          "required": [
+            "repository",
+            "path",
+            "revision",
+            "blobSha"
+          ],
+          "properties": {
+            "repository": {
+              "const": "agent-teams-ai/.github"
+            },
+            "path": {
+              "const": ".github/workflows/docs-protocol-check.yml"
+            },
+            "revision": {
+              "type": "string",
+              "pattern": "^(?!0{40}$)[0-9a-f]{40}$"
+            },
+            "blobSha": {
+              "type": "string",
+              "pattern": "^(?!0{40}$)[0-9a-f]{40}$"
+            }
+          }
+        },
+        "assets": {
+          "type": "object",
+          "additionalProperties": false,
+          "required": [
+            "skillDigest",
+            "callerWorkflowDigest",
+            "assetCatalogDigest",
+            "transitionCatalogDigest"
+          ],
+          "properties": {
+            "skillDigest": {
+              "$ref": "#/$defs/nonzeroSha256"
+            },
+            "callerWorkflowDigest": {
+              "$ref": "#/$defs/nonzeroSha256"
+            },
+            "assetCatalogDigest": {
+              "$ref": "#/$defs/nonzeroSha256"
+            },
+            "transitionCatalogDigest": {
+              "$ref": "#/$defs/nonzeroSha256"
+            }
+          }
+        },
+        "schemas": {
+          "type": "object",
+          "additionalProperties": false,
+          "required": [
+            "consumerIntegration",
+            "managedState",
+            "docsProtocol"
+          ],
+          "properties": {
+            "consumerIntegration": {
+              "const": 1
+            },
+            "managedState": {
+              "const": 1
+            },
+            "docsProtocol": {
+              "const": 1
+            }
+          }
+        },
+        "runtime": {
+          "type": "object",
+          "additionalProperties": false,
+          "required": [
+            "node",
+            "pnpm",
+            "runtimeClosureDigest"
+          ],
+          "properties": {
+            "node": {
+              "const": ">=24.18.0 <25"
+            },
+            "pnpm": {
+              "const": ">=11.17.0 <12"
+            },
+            "runtimeClosureDigest": {
+              "$ref": "#/$defs/nonzeroSha256"
+            }
+          }
+        }
+      }
+    },
+    "nonzeroSha256": {
+      "type": "string",
+      "pattern": "^sha256:(?!0{64}$)[0-9a-f]{64}$"
+    },
+    "cohortIds": {
+      "type": "array",
+      "maxItems": 32,
+      "uniqueItems": true,
+      "items": {
+        "type": "string",
+        "pattern": "^[a-z0-9]+(?:[._-][a-z0-9]+)*$"
+      }
+    },
+    "package": {
+      "type": "object",
+      "additionalProperties": false,
+      "required": [
+        "version",
+        "integrity"
+      ],
+      "properties": {
+        "version": {
+          "type": "string",
+          "pattern": "^[0-9]+\\.[0-9]+\\.[0-9]+(?:-[0-9A-Za-z.-]+)?$"
+        },
+        "integrity": {
+          "type": "string",
+          "pattern": "^sha512-[A-Za-z0-9+/]{86}==$"
+        }
+      }
+    }
+  }
+}

package/schemas/docs-consumer-upgrade-execution/v1.schema.json

@@ -0,0 +1,44 @@
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "$id": "https://agent-teams.ai/schemas/docs-consumer-upgrade-execution/v1",
+  "type": "object",
+  "additionalProperties": false,
+  "required": ["schemaVersion", "command", "outcome", "issues"],
+  "properties": {
+    "schemaVersion": { "const": 1 },
+    "command": { "const": "consumer.upgrade" },
+    "outcome": { "enum": ["blocked", "current", "upgraded"] },
+    "issues": {
+      "type": "array",
+      "maxItems": 64,
+      "items": {
+        "type": "object",
+        "additionalProperties": false,
+        "required": ["code", "severity", "subject", "message"],
+        "properties": {
+          "code": { "type": "string", "pattern": "^[A-Z0-9_]+$", "maxLength": 128 },
+          "severity": { "enum": ["error", "warning"] },
+          "subject": { "type": "string", "maxLength": 2048 },
+          "message": { "type": "string", "maxLength": 4096 }
+        }
+      }
+    },
+    "authority": {
+      "type": "object",
+      "additionalProperties": false,
+      "required": ["repository", "path", "revision", "cohortId", "recordDigest", "qualificationEventDigest"],
+      "properties": {
+        "repository": { "const": "agent-teams-ai/.github" },
+        "path": { "const": "governance/docs-qualified-cohorts.json" },
+        "revision": { "type": "string", "pattern": "^(?!0{40}$)[0-9a-f]{40}$" },
+        "cohortId": { "type": "string", "pattern": "^[a-z0-9]+(?:[._-][a-z0-9]+)*$" },
+        "recordDigest": { "$ref": "#/$defs/sha256" },
+        "qualificationEventDigest": { "$ref": "#/$defs/sha256" }
+      }
+    },
+    "receipt": { "$ref": "https://agent-teams.ai/schemas/known-file-transaction-receipt/v1" }
+  },
+  "$defs": {
+    "sha256": { "type": "string", "pattern": "^sha256:[0-9a-f]{64}$" }
+  }
+}