@agent-teams/document-authoring 0.0.0

package/schemas/foundation-transaction-envelope/v3.schema.json

@@ -0,0 +1,169 @@
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "$id": "https://agent-teams.ai/schemas/foundation-transaction-envelope/v3",
+  "title": "Foundation Document Transaction Envelope",
+  "type": "object",
+  "additionalProperties": false,
+  "required": ["schemaVersion", "operationKind", "recoveryHandler", "foundation", "adapterContractVersion", "payloadKind", "journal", "payloadDigest", "state", "envelopeDigest"],
+  "properties": {
+    "schemaVersion": { "const": 3 },
+    "operationKind": { "const": "document-authoring" },
+    "recoveryHandler": {
+      "type": "object",
+      "additionalProperties": false,
+      "required": ["id", "contractVersion"],
+      "properties": {
+        "id": { "enum": ["document-authoring", "foundation.document-authoring"] },
+        "contractVersion": { "const": 2 }
+      }
+    },
+    "foundation": {
+      "type": "object",
+      "additionalProperties": false,
+      "required": ["version", "buildIdentity"],
+      "properties": {
+        "version": { "$ref": "#/$defs/semver" },
+        "buildIdentity": { "$ref": "#/$defs/digest" }
+      }
+    },
+    "adapterContractVersion": { "const": 1 },
+    "payloadKind": { "const": "document-authoring-journal/v2" },
+    "journal": { "$ref": "#/$defs/documentJournalV2" },
+    "payloadDigest": { "$ref": "#/$defs/digest" },
+    "state": { "enum": ["PREPARED", "PUBLISHING", "PUBLISHED"] },
+    "envelopeDigest": { "$ref": "#/$defs/digest" }
+  },
+  "oneOf": [
+    { "$ref": "#/$defs/preparedEnvelope" },
+    { "$ref": "#/$defs/publishingEnvelope" },
+    { "$ref": "#/$defs/publishedEnvelope" }
+  ],
+  "$defs": {
+    "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})*$"
+    },
+    "unsignedDecimal": {
+      "type": "string",
+      "pattern": "^(?:0|[1-9][0-9]*)$",
+      "maxLength": 32
+    },
+    "nonzeroUnsignedDecimal": {
+      "type": "string",
+      "pattern": "^[1-9][0-9]*$",
+      "maxLength": 32
+    },
+    "physicalIdentity": {
+      "type": "object",
+      "additionalProperties": false,
+      "required": ["adapter", "version", "dev", "ino", "birthtimeNs"],
+      "properties": {
+        "adapter": { "const": "node-filesystem" },
+        "version": { "const": 1 },
+        "dev": { "$ref": "#/$defs/unsignedDecimal" },
+        "ino": { "$ref": "#/$defs/unsignedDecimal" },
+        "birthtimeNs": { "$ref": "#/$defs/unsignedDecimal" }
+      }
+    },
+    "nonzeroPhysicalIdentity": {
+      "type": "object",
+      "additionalProperties": false,
+      "required": ["adapter", "version", "dev", "ino", "birthtimeNs"],
+      "properties": {
+        "adapter": { "const": "node-filesystem" },
+        "version": { "const": 1 },
+        "dev": { "$ref": "#/$defs/nonzeroUnsignedDecimal" },
+        "ino": { "$ref": "#/$defs/nonzeroUnsignedDecimal" },
+        "birthtimeNs": { "$ref": "#/$defs/nonzeroUnsignedDecimal" }
+      }
+    },
+    "destination": {
+      "type": "object",
+      "additionalProperties": false,
+      "required": ["path", "state"],
+      "properties": {
+        "path": { "$ref": "#/$defs/repositoryPath" },
+        "state": { "enum": ["pending", "preexisting", "publishing", "published"] }
+      }
+    },
+    "ownedTemporary": {
+      "type": "object",
+      "additionalProperties": false,
+      "required": ["path", "digest", "identity"],
+      "properties": {
+        "path": { "$ref": "#/$defs/repositoryPath" },
+        "digest": { "$ref": "#/$defs/digest" },
+        "identity": { "$ref": "#/$defs/physicalIdentity" }
+      }
+    },
+    "documentJournalV2": {
+      "type": "object",
+      "additionalProperties": false,
+      "required": ["schemaVersion", "plan", "destination"],
+      "properties": {
+        "schemaVersion": { "const": 2 },
+        "plan": { "$ref": "https://agent-teams.ai/schemas/document-plan/v1" },
+        "destination": { "$ref": "#/$defs/destination" },
+        "ownedTemporary": { "$ref": "#/$defs/ownedTemporary" },
+        "publicationIdentity": { "$ref": "#/$defs/nonzeroPhysicalIdentity" }
+      }
+    },
+    "preparedEnvelope": {
+      "type": "object",
+      "properties": {
+        "state": { "const": "PREPARED" },
+        "journal": {
+          "type": "object",
+          "properties": {
+            "destination": {
+              "type": "object",
+              "properties": { "state": { "enum": ["pending", "preexisting"] } }
+            },
+            "ownedTemporary": false,
+            "publicationIdentity": false
+          }
+        }
+      }
+    },
+    "publishingEnvelope": {
+      "type": "object",
+      "properties": {
+        "state": { "const": "PUBLISHING" },
+        "journal": {
+          "type": "object",
+          "required": ["ownedTemporary"],
+          "properties": {
+            "destination": {
+              "type": "object",
+              "properties": { "state": { "const": "publishing" } }
+            },
+            "ownedTemporary": { "$ref": "#/$defs/ownedTemporary" },
+            "publicationIdentity": false
+          }
+        }
+      }
+    },
+    "publishedEnvelope": {
+      "type": "object",
+      "properties": {
+        "state": { "const": "PUBLISHED" },
+        "journal": {
+          "type": "object",
+          "required": ["publicationIdentity"],
+          "properties": {
+            "destination": {
+              "type": "object",
+              "properties": { "state": { "const": "published" } }
+            },
+            "publicationIdentity": { "$ref": "#/$defs/nonzeroPhysicalIdentity" },
+            "ownedTemporary": false
+          }
+        }
+      }
+    }
+  }
+}

package/schemas/foundation-transaction-envelope/v4.schema.json

@@ -0,0 +1,164 @@
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "$id": "https://agent-teams.ai/schemas/foundation-transaction-envelope/v4",
+  "title": "Foundation Document Transaction Envelope v4",
+  "type": "object",
+  "additionalProperties": false,
+  "required": ["schemaVersion", "operationKind", "recoveryHandler", "foundation", "adapterContractVersion", "payloadKind", "journal", "payloadDigest", "state", "envelopeDigest"],
+  "properties": {
+    "schemaVersion": { "const": 4 },
+    "operationKind": { "const": "document-authoring" },
+    "recoveryHandler": {
+      "type": "object",
+      "additionalProperties": false,
+      "required": ["id", "contractVersion"],
+      "properties": {
+        "id": { "enum": ["document-authoring", "foundation.document-authoring"] },
+        "contractVersion": { "const": 3 }
+      }
+    },
+    "foundation": {
+      "type": "object",
+      "additionalProperties": false,
+      "required": ["version", "buildIdentity"],
+      "properties": {
+        "version": { "$ref": "https://agent-teams.ai/schemas/foundation-transaction-envelope/v3#/$defs/semver" },
+        "buildIdentity": { "$ref": "https://agent-teams.ai/schemas/foundation-transaction-envelope/v3#/$defs/digest" }
+      }
+    },
+    "adapterContractVersion": { "const": 1 },
+    "payloadKind": { "const": "document-authoring-journal/v3" },
+    "journal": { "$ref": "#/$defs/documentJournalV3" },
+    "payloadDigest": { "$ref": "https://agent-teams.ai/schemas/foundation-transaction-envelope/v3#/$defs/digest" },
+    "state": { "enum": ["PREPARED", "MATERIALIZING", "PUBLISHING", "PUBLISHED"] },
+    "envelopeDigest": { "$ref": "https://agent-teams.ai/schemas/foundation-transaction-envelope/v3#/$defs/digest" }
+  },
+  "oneOf": [
+    { "$ref": "#/$defs/preparedEnvelope" },
+    { "$ref": "#/$defs/materializingEnvelope" },
+    { "$ref": "#/$defs/publishingEnvelope" },
+    { "$ref": "#/$defs/publishedEnvelope" }
+  ],
+  "$defs": {
+    "parentMaterialization": {
+      "type": "object",
+      "additionalProperties": false,
+      "required": ["anchorIdentity", "createdDirectories"],
+      "properties": {
+        "anchorIdentity": { "$ref": "https://agent-teams.ai/schemas/foundation-transaction-envelope/v3#/$defs/nonzeroPhysicalIdentity" },
+        "createdDirectories": {
+          "type": "array",
+          "maxItems": 128,
+          "items": {
+            "type": "object",
+            "additionalProperties": false,
+            "required": ["path", "identity"],
+            "properties": {
+              "path": { "$ref": "https://agent-teams.ai/schemas/foundation-transaction-envelope/v3#/$defs/repositoryPath" },
+              "identity": { "$ref": "https://agent-teams.ai/schemas/foundation-transaction-envelope/v3#/$defs/nonzeroPhysicalIdentity" }
+            }
+          }
+        },
+        "pendingDirectory": { "$ref": "https://agent-teams.ai/schemas/foundation-transaction-envelope/v3#/$defs/repositoryPath" }
+      }
+    },
+    "destination": {
+      "type": "object",
+      "additionalProperties": false,
+      "required": ["path", "state"],
+      "properties": {
+        "path": { "$ref": "https://agent-teams.ai/schemas/foundation-transaction-envelope/v3#/$defs/repositoryPath" },
+        "state": { "enum": ["pending", "preexisting", "materializing", "publishing", "published"] }
+      }
+    },
+    "documentJournalV3": {
+      "type": "object",
+      "additionalProperties": false,
+      "required": ["schemaVersion", "plan", "destination", "parentMaterialization"],
+      "properties": {
+        "schemaVersion": { "const": 3 },
+        "plan": { "$ref": "https://agent-teams.ai/schemas/document-plan/v2" },
+        "destination": { "$ref": "#/$defs/destination" },
+        "parentMaterialization": { "$ref": "#/$defs/parentMaterialization" },
+        "ownedTemporary": { "$ref": "https://agent-teams.ai/schemas/foundation-transaction-envelope/v3#/$defs/ownedTemporary" },
+        "publicationIdentity": { "$ref": "https://agent-teams.ai/schemas/foundation-transaction-envelope/v3#/$defs/nonzeroPhysicalIdentity" }
+      }
+    },
+    "preparedEnvelope": {
+      "type": "object",
+      "properties": {
+        "state": { "const": "PREPARED" },
+        "journal": {
+          "type": "object",
+          "properties": {
+            "destination": { "type": "object", "properties": { "state": { "enum": ["pending", "preexisting"] } } },
+            "parentMaterialization": {
+              "type": "object",
+              "properties": {
+                "createdDirectories": { "type": "array", "maxItems": 0 },
+                "pendingDirectory": false
+              }
+            },
+            "ownedTemporary": false,
+            "publicationIdentity": false
+          }
+        }
+      }
+    },
+    "materializingEnvelope": {
+      "type": "object",
+      "properties": {
+        "state": { "const": "MATERIALIZING" },
+        "journal": {
+          "type": "object",
+          "properties": {
+            "destination": { "type": "object", "properties": { "state": { "const": "materializing" } } },
+            "plan": {
+              "type": "object",
+              "properties": {
+                "parentMaterialization": {
+                  "type": "object",
+                  "properties": {
+                    "missingDirectories": { "type": "array", "minItems": 1 }
+                  }
+                }
+              }
+            },
+            "ownedTemporary": false,
+            "publicationIdentity": false
+          }
+        }
+      }
+    },
+    "publishingEnvelope": {
+      "type": "object",
+      "properties": {
+        "state": { "const": "PUBLISHING" },
+        "journal": {
+          "type": "object",
+          "required": ["ownedTemporary"],
+          "properties": {
+            "destination": { "type": "object", "properties": { "state": { "const": "publishing" } } },
+            "ownedTemporary": { "$ref": "https://agent-teams.ai/schemas/foundation-transaction-envelope/v3#/$defs/ownedTemporary" },
+            "publicationIdentity": false
+          }
+        }
+      }
+    },
+    "publishedEnvelope": {
+      "type": "object",
+      "properties": {
+        "state": { "const": "PUBLISHED" },
+        "journal": {
+          "type": "object",
+          "required": ["publicationIdentity"],
+          "properties": {
+            "destination": { "type": "object", "properties": { "state": { "const": "published" } } },
+            "publicationIdentity": { "$ref": "https://agent-teams.ai/schemas/foundation-transaction-envelope/v3#/$defs/nonzeroPhysicalIdentity" },
+            "ownedTemporary": false
+          }
+        }
+      }
+    }
+  }
+}