@agent-teams/document-authoring 0.0.0

package/schemas/document-plan/v1.schema.json

@@ -0,0 +1,162 @@
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "$id": "https://agent-teams.ai/schemas/document-plan/v1",
+  "title": "Document Plan",
+  "type": "object",
+  "additionalProperties": false,
+  "required": ["schemaVersion", "protocolVersion", "compiler", "projectId", "intent", "intentDigest", "authority", "selectedOwner", "identityProjection", "referencedDocuments", "destination", "expectedParent", "destinationPrecondition", "output", "requiredAdapterCapabilities", "diagnostics", "planDigest"],
+  "properties": {
+    "schemaVersion": { "const": 1 },
+    "protocolVersion": { "const": 1 },
+    "compiler": { "$ref": "#/$defs/compiler" },
+    "projectId": { "$ref": "#/$defs/lowerId" },
+    "intent": { "$ref": "https://agent-teams.ai/schemas/document-intent/v1" },
+    "intentDigest": { "$ref": "#/$defs/digest" },
+    "authority": { "$ref": "#/$defs/authority" },
+    "selectedOwner": { "$ref": "#/$defs/selectedOwner" },
+    "identityProjection": { "$ref": "#/$defs/identityProjection" },
+    "referencedDocuments": {
+      "type": "array",
+      "maxItems": 128,
+      "items": { "$ref": "#/$defs/referencedDocument" }
+    },
+    "destination": { "$ref": "#/$defs/repositoryPath" },
+    "expectedParent": { "$ref": "#/$defs/expectedParent" },
+    "destinationPrecondition": {
+      "type": "object",
+      "additionalProperties": false,
+      "required": ["state"],
+      "properties": { "state": { "const": "absent" } }
+    },
+    "output": { "$ref": "#/$defs/output" },
+    "requiredAdapterCapabilities": {
+      "type": "array",
+      "prefixItems": [{ "const": "create-file-no-replace/v1" }],
+      "minItems": 1,
+      "maxItems": 1
+    },
+    "diagnostics": { "type": "array", "maxItems": 256, "items": { "$ref": "#/$defs/diagnostic" } },
+    "planDigest": { "$ref": "#/$defs/digest" }
+  },
+  "$defs": {
+    "lowerId": { "type": "string", "minLength": 1, "maxLength": 160, "pattern": "^[a-z0-9][a-z0-9._/-]*$" },
+    "opaqueId": { "type": "string", "minLength": 1, "maxLength": 214, "pattern": "^[A-Za-z0-9@][A-Za-z0-9@._/-]*$" },
+    "digest": { "type": "string", "pattern": "^sha256:[0-9a-f]{64}$" },
+    "semver": { "type": "string", "pattern": "^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)\\.(0|[1-9]\\d*)(?:-((?:0|[1-9]\\d*|\\d*[A-Za-z-][0-9A-Za-z-]*)(?:\\.(?:0|[1-9]\\d*|\\d*[A-Za-z-][0-9A-Za-z-]*))*))?(?:\\+[0-9A-Za-z-]+(?:\\.[0-9A-Za-z-]+)*)?$" },
+    "repositoryPath": {
+      "type": "string",
+      "minLength": 1,
+      "maxLength": 512,
+      "pattern": "^(?!.*(?:^|/)\\.{1,2}(?:/|$))(?!.*\\.(?:/|$))(?!.*(?:^|/)(?:[Cc][Oo][Nn]|[Pp][Rr][Nn]|[Aa][Uu][Xx]|[Nn][Uu][Ll]|[Cc][Oo][Mm][1-9]|[Ll][Pp][Tt][1-9])(?:\\.[A-Za-z0-9._@-]*)?(?:/|$))[A-Za-z0-9._@-]{1,255}(?:/[A-Za-z0-9._@-]{1,255})*$"
+    },
+    "repositoryParentPath": {
+      "oneOf": [
+        { "const": "." },
+        { "$ref": "#/$defs/repositoryPath" }
+      ]
+    },
+    "compiler": {
+      "type": "object",
+      "additionalProperties": false,
+      "required": ["id", "version", "buildIdentity"],
+      "properties": {
+        "id": { "enum": ["@agent-teams/document-authoring", "@agent-teams/engineering-foundation"] },
+        "version": { "$ref": "#/$defs/semver" },
+        "buildIdentity": { "$ref": "#/$defs/digest" }
+      }
+    },
+    "authoritySource": {
+      "type": "object",
+      "additionalProperties": false,
+      "required": ["path", "digest", "size"],
+      "properties": {
+        "path": { "$ref": "#/$defs/repositoryPath" },
+        "digest": { "$ref": "#/$defs/digest" },
+        "size": { "type": "integer", "minimum": 1, "maximum": 1048576 }
+      }
+    },
+    "templateAuthoritySource": {
+      "type": "object",
+      "additionalProperties": false,
+      "required": ["path", "digest", "size"],
+      "properties": {
+        "path": { "$ref": "#/$defs/repositoryPath" },
+        "digest": { "$ref": "#/$defs/digest" },
+        "size": { "type": "integer", "minimum": 1, "maximum": 262144 }
+      }
+    },
+    "authority": {
+      "type": "object",
+      "additionalProperties": false,
+      "required": ["profile", "metadataSchema", "ownerCatalog", "template"],
+      "properties": {
+        "profile": { "$ref": "#/$defs/authoritySource" },
+        "metadataSchema": { "$ref": "#/$defs/authoritySource" },
+        "ownerCatalog": { "$ref": "#/$defs/authoritySource" },
+        "template": { "$ref": "#/$defs/templateAuthoritySource" }
+      }
+    },
+    "selectedOwner": {
+      "type": "object",
+      "additionalProperties": false,
+      "required": ["id", "membershipDigest"],
+      "properties": {
+        "id": { "$ref": "#/$defs/opaqueId" },
+        "membershipDigest": { "$ref": "#/$defs/digest" }
+      }
+    },
+    "identityProjection": {
+      "type": "object",
+      "additionalProperties": false,
+      "required": ["entryCount", "digest"],
+      "properties": {
+        "entryCount": { "type": "integer", "minimum": 0, "maximum": 100000 },
+        "digest": { "$ref": "#/$defs/digest" }
+      }
+    },
+    "referencedDocument": {
+      "type": "object",
+      "additionalProperties": false,
+      "required": ["id", "path", "projectionDigest"],
+      "properties": {
+        "id": { "$ref": "#/$defs/opaqueId" },
+        "path": { "$ref": "#/$defs/repositoryPath" },
+        "projectionDigest": { "$ref": "#/$defs/digest" }
+      }
+    },
+    "expectedParent": {
+      "type": "object",
+      "additionalProperties": false,
+      "required": ["path", "state", "ancestry"],
+      "properties": {
+        "path": { "$ref": "#/$defs/repositoryParentPath" },
+        "state": { "const": "directory" },
+        "ancestry": { "const": "real-directories" }
+      }
+    },
+    "output": {
+      "type": "object",
+      "additionalProperties": false,
+      "required": ["digest", "size", "mode", "mediaType", "contentBase64"],
+      "properties": {
+        "digest": { "$ref": "#/$defs/digest" },
+        "size": { "type": "integer", "minimum": 1, "maximum": 1048576 },
+        "mode": { "const": "0644" },
+        "mediaType": { "const": "text/markdown; charset=utf-8" },
+        "contentBase64": { "type": "string", "minLength": 4, "maxLength": 1398104, "pattern": "^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=)?$" }
+      }
+    },
+    "diagnostic": {
+      "type": "object",
+      "additionalProperties": false,
+      "required": ["ruleId", "severity", "phase", "subject", "message"],
+      "properties": {
+        "ruleId": { "$ref": "#/$defs/opaqueId" },
+        "severity": { "enum": ["error", "info", "warning"] },
+        "phase": { "enum": ["authority", "input", "planning", "policy"] },
+        "subject": { "type": "string", "minLength": 1, "maxLength": 512 },
+        "message": { "type": "string", "minLength": 1, "maxLength": 1000 }
+      }
+    }
+  }
+}

package/schemas/document-plan/v2.schema.json

@@ -0,0 +1,85 @@
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "$id": "https://agent-teams.ai/schemas/document-plan/v2",
+  "title": "Document Plan v2",
+  "type": "object",
+  "additionalProperties": false,
+  "required": ["schemaVersion", "protocolVersion", "compiler", "projectId", "intent", "intentDigest", "authority", "selectedOwner", "identityProjection", "referencedDocuments", "destination", "expectedParent", "parentMaterialization", "destinationPrecondition", "output", "requiredAdapterCapabilities", "diagnostics", "planDigest"],
+  "properties": {
+    "schemaVersion": { "const": 2 },
+    "protocolVersion": { "const": 2 },
+    "compiler": { "$ref": "https://agent-teams.ai/schemas/document-plan/v1#/$defs/compiler" },
+    "projectId": { "$ref": "https://agent-teams.ai/schemas/document-plan/v1#/$defs/lowerId" },
+    "intent": { "$ref": "https://agent-teams.ai/schemas/document-intent/v1" },
+    "intentDigest": { "$ref": "https://agent-teams.ai/schemas/document-plan/v1#/$defs/digest" },
+    "authority": {
+      "type": "object",
+      "additionalProperties": false,
+      "required": ["profile", "metadataSchema", "ownerCatalog", "template", "profileSemanticDigest", "catalogPreimageSemanticDigest", "expectedCatalogPostimageSemanticDigest"],
+      "properties": {
+        "profile": { "$ref": "https://agent-teams.ai/schemas/document-plan/v1#/$defs/authoritySource" },
+        "metadataSchema": { "$ref": "https://agent-teams.ai/schemas/document-plan/v1#/$defs/authoritySource" },
+        "metadataSidecar": { "$ref": "https://agent-teams.ai/schemas/document-plan/v1#/$defs/authoritySource" },
+        "profileSemanticDigest": { "$ref": "https://agent-teams.ai/schemas/document-plan/v1#/$defs/digest" },
+        "catalogPreimageSemanticDigest": { "$ref": "https://agent-teams.ai/schemas/document-plan/v1#/$defs/digest" },
+        "expectedCatalogPostimageSemanticDigest": { "$ref": "https://agent-teams.ai/schemas/document-plan/v1#/$defs/digest" },
+        "ownerCatalog": { "$ref": "https://agent-teams.ai/schemas/document-plan/v1#/$defs/authoritySource" },
+        "template": { "$ref": "https://agent-teams.ai/schemas/document-plan/v1#/$defs/templateAuthoritySource" }
+      }
+    },
+    "selectedOwner": { "$ref": "https://agent-teams.ai/schemas/document-plan/v1#/$defs/selectedOwner" },
+    "identityProjection": { "$ref": "https://agent-teams.ai/schemas/document-plan/v1#/$defs/identityProjection" },
+    "referencedDocuments": {
+      "type": "array",
+      "maxItems": 128,
+      "items": { "$ref": "https://agent-teams.ai/schemas/document-plan/v1#/$defs/referencedDocument" }
+    },
+    "destination": { "$ref": "https://agent-teams.ai/schemas/document-plan/v1#/$defs/repositoryPath" },
+    "expectedParent": { "$ref": "https://agent-teams.ai/schemas/document-plan/v1#/$defs/expectedParent" },
+    "parentMaterialization": {
+      "type": "object",
+      "additionalProperties": false,
+      "required": ["policy", "deepestExistingDirectory", "missingDirectories", "finalParent"],
+      "properties": {
+        "policy": { "const": "create-missing-real-directories" },
+        "deepestExistingDirectory": { "$ref": "#/$defs/repositoryDirectory" },
+        "missingDirectories": {
+          "type": "array",
+          "maxItems": 128,
+          "items": { "$ref": "https://agent-teams.ai/schemas/document-plan/v1#/$defs/repositoryPath" }
+        },
+        "finalParent": { "$ref": "#/$defs/repositoryDirectory" }
+      }
+    },
+    "destinationPrecondition": {
+      "type": "object",
+      "additionalProperties": false,
+      "required": ["state"],
+      "properties": { "state": { "const": "absent" } }
+    },
+    "output": { "$ref": "https://agent-teams.ai/schemas/document-plan/v1#/$defs/output" },
+    "requiredAdapterCapabilities": {
+      "type": "array",
+      "prefixItems": [
+        { "const": "create-directories-no-replace/v1" },
+        { "const": "create-file-no-replace/v1" }
+      ],
+      "minItems": 2,
+      "maxItems": 2
+    },
+    "diagnostics": {
+      "type": "array",
+      "maxItems": 256,
+      "items": { "$ref": "https://agent-teams.ai/schemas/document-plan/v1#/$defs/diagnostic" }
+    },
+    "planDigest": { "$ref": "https://agent-teams.ai/schemas/document-plan/v1#/$defs/digest" }
+  },
+  "$defs": {
+    "repositoryDirectory": {
+      "oneOf": [
+        { "const": "." },
+        { "$ref": "https://agent-teams.ai/schemas/document-plan/v1#/$defs/repositoryPath" }
+      ]
+    }
+  }
+}

package/schemas/document-receipt/v1.schema.json

@@ -0,0 +1,141 @@
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "$id": "https://agent-teams.ai/schemas/document-receipt/v1",
+  "title": "Document Receipt",
+  "type": "object",
+  "additionalProperties": false,
+  "required": ["schemaVersion", "protocolVersion", "planDigest", "adapter", "destination", "outcome", "commit", "diagnostics", "receiptDigest"],
+  "properties": {
+    "schemaVersion": { "const": 1 },
+    "protocolVersion": { "const": 1 },
+    "planDigest": { "$ref": "#/$defs/digest" },
+    "adapter": {
+      "type": "object",
+      "additionalProperties": false,
+      "required": ["id", "contractVersion"],
+      "properties": {
+        "id": { "const": "foundation.filesystem/v1" },
+        "contractVersion": { "const": 1 }
+      }
+    },
+    "destination": { "$ref": "#/$defs/repositoryPath" },
+    "outcome": { "enum": ["applied", "already-applied", "authority-stale", "rejected", "recovery-required", "manual-recovery-required", "failed-before-publication", "cancelled"] },
+    "resultDigest": { "$ref": "#/$defs/digest" },
+    "commit": { "$ref": "#/$defs/commitObservation" },
+    "diagnostics": { "type": "array", "maxItems": 256, "items": { "$ref": "#/$defs/diagnostic" } },
+    "receiptDigest": { "$ref": "#/$defs/digest" }
+  },
+  "allOf": [
+    { "$ref": "#/$defs/appliedContract" },
+    { "$ref": "#/$defs/alreadyAppliedContract" },
+    { "$ref": "#/$defs/noResultContract" },
+    { "$ref": "#/$defs/recoveryContract" }
+  ],
+  "$defs": {
+    "opaqueId": { "type": "string", "minLength": 1, "maxLength": 214, "pattern": "^[A-Za-z0-9@][A-Za-z0-9@._/-]*$" },
+    "digest": { "type": "string", "pattern": "^sha256:[0-9a-f]{64}$" },
+    "repositoryPath": {
+      "type": "string",
+      "minLength": 1,
+      "maxLength": 512,
+      "pattern": "^(?!.*(?:^|/)\\.{1,2}(?:/|$))(?!.*\\.(?:/|$))(?!.*(?:^|/)(?:[Cc][Oo][Nn]|[Pp][Rr][Nn]|[Aa][Uu][Xx]|[Nn][Uu][Ll]|[Cc][Oo][Mm][1-9]|[Ll][Pp][Tt][1-9])(?:\\.[A-Za-z0-9._@-]*)?(?:/|$))[A-Za-z0-9._@-]{1,255}(?:/[A-Za-z0-9._@-]{1,255})*$"
+    },
+    "commitObservation": {
+      "type": "object",
+      "additionalProperties": false,
+      "required": ["state", "publication", "atomicity", "recoverability"],
+      "properties": {
+        "state": { "enum": ["committed", "not-published", "preserved", "recovery-required", "manual-recovery-required"] },
+        "publication": { "enum": ["none", "preexisting-exact", "published", "unknown"] },
+        "atomicity": { "enum": ["not-applicable", "single-file-atomic-create"] },
+        "recoverability": { "enum": ["not-required", "journaled-recoverable", "preserved-for-recovery"] }
+      }
+    },
+    "appliedContract": {
+      "if": { "type": "object", "properties": { "outcome": { "const": "applied" } }, "required": ["outcome"] },
+      "then": {
+        "type": "object",
+        "required": ["resultDigest"],
+        "properties": {
+          "resultDigest": { "$ref": "#/$defs/digest" },
+          "commit": {
+            "type": "object",
+            "properties": {
+              "state": { "const": "committed" },
+              "publication": { "const": "published" },
+              "atomicity": { "const": "single-file-atomic-create" },
+              "recoverability": { "const": "not-required" }
+            }
+          }
+        }
+      }
+    },
+    "alreadyAppliedContract": {
+      "if": { "type": "object", "properties": { "outcome": { "const": "already-applied" } }, "required": ["outcome"] },
+      "then": {
+        "type": "object",
+        "required": ["resultDigest"],
+        "properties": {
+          "resultDigest": { "$ref": "#/$defs/digest" },
+          "commit": {
+            "type": "object",
+            "properties": {
+              "state": { "const": "committed" },
+              "publication": { "const": "preexisting-exact" },
+              "atomicity": { "const": "not-applicable" },
+              "recoverability": { "const": "not-required" }
+            }
+          }
+        }
+      }
+    },
+    "noResultContract": {
+      "if": { "type": "object", "properties": { "outcome": { "enum": ["authority-stale", "rejected", "failed-before-publication", "cancelled"] } }, "required": ["outcome"] },
+      "then": {
+        "type": "object",
+        "properties": {
+          "resultDigest": false,
+          "commit": {
+            "type": "object",
+            "properties": {
+              "state": { "const": "not-published" },
+              "publication": { "const": "none" },
+              "atomicity": { "const": "not-applicable" },
+              "recoverability": { "const": "not-required" }
+            }
+          }
+        }
+      }
+    },
+    "recoveryContract": {
+      "if": { "type": "object", "properties": { "outcome": { "enum": ["recovery-required", "manual-recovery-required"] } }, "required": ["outcome"] },
+      "then": {
+        "type": "object",
+        "properties": {
+          "resultDigest": false,
+          "commit": {
+            "type": "object",
+            "properties": {
+              "state": { "enum": ["preserved", "recovery-required", "manual-recovery-required"] },
+              "publication": { "enum": ["none", "published", "unknown"] },
+              "atomicity": { "enum": ["not-applicable", "single-file-atomic-create"] },
+              "recoverability": { "const": "preserved-for-recovery" }
+            }
+          }
+        }
+      }
+    },
+    "diagnostic": {
+      "type": "object",
+      "additionalProperties": false,
+      "required": ["ruleId", "severity", "phase", "subject", "message"],
+      "properties": {
+        "ruleId": { "$ref": "#/$defs/opaqueId" },
+        "severity": { "enum": ["error", "info", "warning"] },
+        "phase": { "enum": ["apply", "authority", "input", "recovery"] },
+        "subject": { "type": "string", "minLength": 1, "maxLength": 512 },
+        "message": { "type": "string", "minLength": 1, "maxLength": 1000 }
+      }
+    }
+  }
+}

package/schemas/document-receipt/v2.schema.json

@@ -0,0 +1,108 @@
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "$id": "https://agent-teams.ai/schemas/document-receipt/v2",
+  "title": "Document Receipt v2",
+  "type": "object",
+  "additionalProperties": false,
+  "required": ["schemaVersion", "protocolVersion", "planDigest", "adapter", "destination", "outcome", "commit", "directoryMaterialization", "diagnostics", "receiptDigest"],
+  "properties": {
+    "schemaVersion": { "const": 2 },
+    "protocolVersion": { "const": 2 },
+    "planDigest": { "$ref": "https://agent-teams.ai/schemas/document-receipt/v1#/$defs/digest" },
+    "adapter": {
+      "type": "object",
+      "additionalProperties": false,
+      "required": ["id", "contractVersion"],
+      "properties": {
+        "id": { "const": "foundation.filesystem/v1" },
+        "contractVersion": { "const": 1 }
+      }
+    },
+    "destination": { "$ref": "https://agent-teams.ai/schemas/document-receipt/v1#/$defs/repositoryPath" },
+    "outcome": { "enum": ["applied", "already-applied", "authority-stale", "rejected", "recovery-required", "manual-recovery-required", "failed-before-publication", "cancelled"] },
+    "resultDigest": { "$ref": "https://agent-teams.ai/schemas/document-receipt/v1#/$defs/digest" },
+    "commit": {
+      "type": "object",
+      "additionalProperties": false,
+      "required": ["state", "publication", "fileAtomicity", "recoverability"],
+      "properties": {
+        "state": { "enum": ["committed", "not-published", "recovery-required", "manual-recovery-required"] },
+        "publication": { "enum": ["none", "preexisting-exact", "published", "unknown"] },
+        "fileAtomicity": { "enum": ["not-applicable", "single-file-atomic-create"] },
+        "recoverability": { "enum": ["not-required", "preserved-for-recovery"] }
+      }
+    },
+    "directoryMaterialization": {
+      "type": "object",
+      "additionalProperties": false,
+      "required": ["state", "plannedDirectories", "observedCreatedDirectories"],
+      "properties": {
+        "state": { "enum": ["none-created", "created-and-retained", "preserved-unknown"] },
+        "plannedDirectories": { "type": "array", "maxItems": 128, "items": { "$ref": "https://agent-teams.ai/schemas/document-receipt/v1#/$defs/repositoryPath" } },
+        "observedCreatedDirectories": { "type": "array", "maxItems": 128, "items": { "$ref": "https://agent-teams.ai/schemas/document-receipt/v1#/$defs/repositoryPath" } }
+      }
+    },
+    "diagnostics": { "type": "array", "maxItems": 256, "items": { "$ref": "https://agent-teams.ai/schemas/document-receipt/v1#/$defs/diagnostic" } },
+    "receiptDigest": { "$ref": "https://agent-teams.ai/schemas/document-receipt/v1#/$defs/digest" }
+  },
+  "allOf": [
+    {
+      "if": { "properties": { "outcome": { "enum": ["applied", "already-applied"] } }, "required": ["outcome"] },
+      "then": {
+        "properties": {
+          "resultDigest": { "$ref": "https://agent-teams.ai/schemas/document-receipt/v1#/$defs/digest" }
+        },
+        "required": ["resultDigest"]
+      },
+      "else": { "properties": { "resultDigest": false } }
+    },
+    {
+      "if": {
+        "properties": {
+          "directoryMaterialization": {
+            "type": "object",
+            "properties": { "state": { "const": "none-created" } },
+            "required": ["state"]
+          }
+        },
+        "required": ["directoryMaterialization"]
+      },
+      "then": {
+        "properties": {
+          "directoryMaterialization": {
+            "type": "object",
+            "properties": {
+              "observedCreatedDirectories": { "type": "array", "maxItems": 0 }
+            }
+          }
+        }
+      }
+    },
+    {
+      "if": {
+        "properties": {
+          "directoryMaterialization": {
+            "type": "object",
+            "properties": { "state": { "const": "preserved-unknown" } },
+            "required": ["state"]
+          }
+        },
+        "required": ["directoryMaterialization"]
+      },
+      "then": {
+        "properties": {
+          "outcome": {
+            "enum": ["recovery-required", "manual-recovery-required"]
+          },
+          "commit": {
+            "type": "object",
+            "properties": {
+              "recoverability": { "const": "preserved-for-recovery" }
+            },
+            "required": ["recoverability"]
+          }
+        }
+      }
+    }
+  ]
+}