@agent-teams/document-authoring 0.0.0

package/schemas/document-authoring-profile/v1.schema.json

@@ -0,0 +1,265 @@
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "$id": "https://agent-teams.ai/schemas/document-authoring-profile/v1",
+  "title": "Document Authoring Profile",
+  "type": "object",
+  "additionalProperties": false,
+  "required": ["schemaVersion", "projectId", "catalog", "authoring"],
+  "properties": {
+    "schemaVersion": { "const": 1 },
+    "projectId": { "$ref": "#/$defs/lowerId" },
+    "catalog": { "$ref": "#/$defs/catalog" },
+    "authoring": { "$ref": "#/$defs/authoring" }
+  },
+  "$defs": {
+    "lowerId": {
+      "type": "string",
+      "minLength": 1,
+      "maxLength": 160,
+      "pattern": "^[a-z0-9][a-z0-9._/-]*$"
+    },
+    "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})*$"
+    },
+    "catalog": {
+      "type": "object",
+      "additionalProperties": false,
+      "required": ["metadataSchemaPath", "ownerCatalog", "collections"],
+      "properties": {
+        "metadataSchemaPath": { "$ref": "#/$defs/repositoryPath" },
+        "ownerCatalog": {
+          "type": "object",
+          "additionalProperties": false,
+          "required": ["path", "contract"],
+          "properties": {
+            "path": { "$ref": "#/$defs/repositoryPath" },
+            "contract": { "const": "foundation.owner-map/v1" }
+          }
+        },
+        "collections": {
+          "type": "array",
+          "minItems": 1,
+          "maxItems": 32,
+          "items": {
+            "oneOf": [
+              { "$ref": "#/$defs/markdownTreeCollection" },
+              { "$ref": "#/$defs/frontmatterReadmeCollection" }
+            ]
+          }
+        },
+        "excludedPrefixes": {
+          "type": "array",
+          "maxItems": 128,
+          "uniqueItems": true,
+          "items": { "$ref": "#/$defs/repositoryPath" }
+        }
+      }
+    },
+    "markdownTreeCollection": {
+      "type": "object",
+      "additionalProperties": false,
+      "required": ["kind", "root"],
+      "properties": {
+        "kind": { "const": "markdown-tree" },
+        "root": { "$ref": "#/$defs/repositoryPath" }
+      }
+    },
+    "frontmatterReadmeCollection": {
+      "type": "object",
+      "additionalProperties": false,
+      "required": ["kind", "roots"],
+      "properties": {
+        "kind": { "const": "frontmatter-readme" },
+        "roots": {
+          "type": "array",
+          "minItems": 1,
+          "maxItems": 32,
+          "uniqueItems": true,
+          "items": { "$ref": "#/$defs/repositoryPath" }
+        }
+      }
+    },
+    "authoring": {
+      "type": "object",
+      "additionalProperties": false,
+      "required": ["mode", "artifactTypes"],
+      "properties": {
+        "mode": { "const": "create-only" },
+        "artifactTypes": {
+          "type": "array",
+          "minItems": 1,
+          "maxItems": 32,
+          "uniqueItems": true,
+          "items": { "$ref": "#/$defs/artifactType" }
+        }
+      }
+    },
+    "artifactType": {
+      "type": "object",
+      "additionalProperties": false,
+      "required": ["type", "initialStatus", "identity", "placement", "template", "heading"],
+      "properties": {
+        "type": { "$ref": "#/$defs/lowerId" },
+        "initialStatus": { "$ref": "#/$defs/lowerId" },
+        "identity": { "$ref": "#/$defs/identity" },
+        "placement": {
+          "oneOf": [
+            { "$ref": "#/$defs/collectionPlacement" },
+            { "$ref": "#/$defs/qualifiedLeafIndexPlacement" },
+            { "$ref": "#/$defs/explicitPlacement" }
+          ]
+        },
+        "template": {
+          "type": "object",
+          "additionalProperties": false,
+          "required": ["kind", "path"],
+          "properties": {
+            "kind": { "const": "fenced-markdown-body" },
+            "path": { "$ref": "#/$defs/repositoryPath" }
+          }
+        },
+        "heading": {
+          "type": "object",
+          "additionalProperties": false,
+          "required": ["kind"],
+          "properties": { "kind": { "enum": ["id-colon-title", "title"] } }
+        },
+        "reachability": { "$ref": "#/$defs/reachability" }
+      }
+    },
+    "reachability": {
+      "oneOf": [
+        {
+          "type": "object",
+          "additionalProperties": false,
+          "required": ["kind", "indexPath"],
+          "properties": {
+            "kind": { "const": "manual-fixed-index" },
+            "indexPath": { "$ref": "#/$defs/repositoryPath" }
+          }
+        },
+        {
+          "type": "object",
+          "additionalProperties": false,
+          "required": ["kind", "pathPrefix", "indexBasename"],
+          "properties": {
+            "kind": { "const": "manual-colocated-index" },
+            "pathPrefix": { "const": "before-required-segments" },
+            "indexBasename": { "const": "README.md" }
+          }
+        },
+        {
+          "type": "object",
+          "additionalProperties": false,
+          "required": ["kind"],
+          "properties": { "kind": { "const": "not-required" } }
+        }
+      ]
+    },
+    "identity": {
+      "oneOf": [
+        { "$ref": "#/$defs/adrIdentity" },
+        { "$ref": "#/$defs/openDecisionIdentity" },
+        { "$ref": "#/$defs/qualifiedIdentity" }
+      ]
+    },
+    "adrIdentity": {
+      "type": "object",
+      "additionalProperties": false,
+      "required": ["kind", "format"],
+      "properties": {
+        "kind": { "const": "explicit" },
+        "format": { "const": "adr-four-digits" }
+      }
+    },
+    "openDecisionIdentity": {
+      "type": "object",
+      "additionalProperties": false,
+      "required": ["kind", "format"],
+      "properties": {
+        "kind": { "const": "explicit" },
+        "format": { "const": "open-decision-three-digits" }
+      }
+    },
+    "qualifiedIdentity": {
+      "type": "object",
+      "additionalProperties": false,
+      "required": ["kind", "format", "grammar"],
+      "properties": {
+        "kind": { "const": "explicit" },
+        "format": { "const": "qualified" },
+        "grammar": { "$ref": "#/$defs/qualifiedIdentityGrammar" }
+      }
+    },
+    "qualifiedIdentityGrammar": {
+      "type": "object",
+      "additionalProperties": false,
+      "required": ["prefixSegments", "minSuffixSegments", "maxSuffixSegments"],
+      "properties": {
+        "prefixSegments": {
+          "type": "array",
+          "minItems": 1,
+          "maxItems": 8,
+          "items": { "$ref": "#/$defs/qualifiedIdentitySegment" }
+        },
+        "minSuffixSegments": { "type": "integer", "minimum": 1, "maximum": 16 },
+        "maxSuffixSegments": { "type": "integer", "minimum": 1, "maximum": 16 }
+      }
+    },
+    "qualifiedIdentitySegment": {
+      "type": "string",
+      "minLength": 1,
+      "maxLength": 80,
+      "pattern": "^[a-z][a-z0-9-]*$"
+    },
+    "collectionPlacement": {
+      "type": "object",
+      "additionalProperties": false,
+      "required": ["kind", "directory", "filename"],
+      "properties": {
+        "kind": { "const": "collection" },
+        "directory": { "$ref": "#/$defs/repositoryPath" },
+        "filename": { "enum": ["numeric-id-slug", "id-slug", "slug", "README.md"] }
+      }
+    },
+    "qualifiedLeafIndexPlacement": {
+      "type": "object",
+      "additionalProperties": false,
+      "required": ["kind", "root", "requiredBasename"],
+      "properties": {
+        "kind": { "const": "qualified-leaf-index" },
+        "root": { "$ref": "#/$defs/repositoryPath" },
+        "requiredBasename": { "const": "README.md" }
+      }
+    },
+    "explicitPlacement": {
+      "type": "object",
+      "additionalProperties": false,
+      "required": ["kind", "allowedRoots", "requiredSegmentsInOrder", "requiredBasename", "minimumSegmentsBeforeRequired", "minimumSegmentsAfterRequired"],
+      "properties": {
+        "kind": { "const": "explicit" },
+        "allowedRoots": { "$ref": "#/$defs/pathList" },
+        "requiredSegmentsInOrder": { "$ref": "#/$defs/pathSegmentList" },
+        "requiredBasename": { "enum": ["README.md"] },
+        "minimumSegmentsBeforeRequired": { "type": "integer", "minimum": 0, "maximum": 16 },
+        "minimumSegmentsAfterRequired": { "type": "integer", "minimum": 0, "maximum": 16 }
+      }
+    },
+    "pathList": {
+      "type": "array",
+      "minItems": 1,
+      "maxItems": 32,
+      "uniqueItems": true,
+      "items": { "$ref": "#/$defs/repositoryPath" }
+    },
+    "pathSegmentList": {
+      "type": "array",
+      "minItems": 1,
+      "maxItems": 16,
+      "items": { "type": "string", "minLength": 1, "maxLength": 80, "pattern": "^[A-Za-z0-9._@-]+$" }
+    }
+  }
+}

package/schemas/document-authoring-profile/v2.schema.json

@@ -0,0 +1,168 @@
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "$id": "https://agent-teams.ai/schemas/document-authoring-profile/v2",
+  "title": "Document Authoring Profile v2",
+  "type": "object",
+  "additionalProperties": false,
+  "required": ["schemaVersion", "projectId", "catalog", "authoring"],
+  "properties": {
+    "schemaVersion": { "const": 2 },
+    "projectId": { "$ref": "https://agent-teams.ai/schemas/document-authoring-profile/v1#/$defs/lowerId" },
+    "catalog": { "$ref": "#/$defs/catalog" },
+    "authoring": { "$ref": "#/$defs/authoring" }
+  },
+  "$defs": {
+    "catalog": {
+      "type": "object",
+      "additionalProperties": false,
+      "required": ["metadataSchemaPath", "ownerCatalog", "collections"],
+      "properties": {
+        "metadataSchemaPath": { "$ref": "https://agent-teams.ai/schemas/document-authoring-profile/v1#/$defs/repositoryPath" },
+        "ownerCatalog": {
+          "type": "object",
+          "additionalProperties": false,
+          "required": ["path", "contract"],
+          "properties": {
+            "path": { "$ref": "https://agent-teams.ai/schemas/document-authoring-profile/v1#/$defs/repositoryPath" },
+            "contract": { "const": "foundation.owner-map/v1" }
+          }
+        },
+        "collections": {
+          "type": "array",
+          "minItems": 1,
+          "maxItems": 32,
+          "items": {
+            "oneOf": [
+              { "$ref": "https://agent-teams.ai/schemas/document-authoring-profile/v1#/$defs/markdownTreeCollection" },
+              { "$ref": "https://agent-teams.ai/schemas/document-authoring-profile/v1#/$defs/frontmatterReadmeCollection" }
+            ]
+          }
+        },
+        "excludedPrefixes": {
+          "type": "array",
+          "maxItems": 128,
+          "uniqueItems": true,
+          "items": { "$ref": "https://agent-teams.ai/schemas/document-authoring-profile/v1#/$defs/repositoryPath" }
+        },
+        "metadataSidecar": { "$ref": "#/$defs/metadataSidecar" }
+      }
+    },
+    "metadataSidecar": {
+      "type": "object",
+      "additionalProperties": false,
+      "required": ["kind", "path"],
+      "properties": {
+        "kind": { "const": "path-metadata-map" },
+        "path": { "$ref": "https://agent-teams.ai/schemas/document-authoring-profile/v1#/$defs/repositoryPath" }
+      }
+    },
+    "authoring": {
+      "type": "object",
+      "additionalProperties": false,
+      "required": ["mode", "artifactTypes"],
+      "properties": {
+        "mode": { "const": "create-only" },
+        "artifactTypes": {
+          "type": "array",
+          "minItems": 1,
+          "maxItems": 32,
+          "items": { "$ref": "#/$defs/artifactType" }
+        }
+      }
+    },
+    "artifactType": {
+      "type": "object",
+      "additionalProperties": false,
+      "required": [
+        "type",
+        "initialStatus",
+        "identity",
+        "placement",
+        "template",
+        "heading",
+        "reachability",
+        "allowedOwnerIds"
+      ],
+      "properties": {
+        "type": { "$ref": "https://agent-teams.ai/schemas/document-authoring-profile/v1#/$defs/lowerId" },
+        "initialStatus": { "$ref": "https://agent-teams.ai/schemas/document-authoring-profile/v1#/$defs/lowerId" },
+        "identity": { "$ref": "https://agent-teams.ai/schemas/document-authoring-profile/v1#/$defs/identity" },
+        "placement": {
+          "oneOf": [
+            { "$ref": "https://agent-teams.ai/schemas/document-authoring-profile/v1#/$defs/collectionPlacement" },
+            { "$ref": "https://agent-teams.ai/schemas/document-authoring-profile/v1#/$defs/qualifiedLeafIndexPlacement" },
+            { "$ref": "https://agent-teams.ai/schemas/document-authoring-profile/v1#/$defs/explicitPlacement" }
+          ]
+        },
+        "template": {
+          "type": "object",
+          "additionalProperties": false,
+          "required": ["kind", "path"],
+          "properties": {
+            "kind": { "const": "fenced-markdown-body" },
+            "path": { "$ref": "https://agent-teams.ai/schemas/document-authoring-profile/v1#/$defs/repositoryPath" }
+          }
+        },
+        "heading": {
+          "type": "object",
+          "additionalProperties": false,
+          "required": ["kind"],
+          "properties": {
+            "kind": { "enum": ["id-colon-title", "title"] }
+          }
+        },
+        "reachability": { "$ref": "#/$defs/reachability" },
+        "allowedOwnerIds": { "$ref": "#/$defs/allowedOwnerIds" }
+      }
+    },
+    "allowedOwnerIds": {
+      "type": "array",
+      "minItems": 1,
+      "maxItems": 4096,
+      "uniqueItems": true,
+      "items": {
+        "type": "string",
+        "minLength": 1,
+        "maxLength": 214,
+        "pattern": "^[A-Za-z0-9@][A-Za-z0-9@._/-]*$"
+      }
+    },
+    "reachability": {
+      "oneOf": [
+        {
+          "type": "object",
+          "additionalProperties": false,
+          "required": ["kind", "indexPath"],
+          "properties": {
+            "kind": { "const": "manual-fixed-index" },
+            "indexPath": { "$ref": "https://agent-teams.ai/schemas/document-authoring-profile/v1#/$defs/repositoryPath" }
+          }
+        },
+        {
+          "type": "object",
+          "additionalProperties": false,
+          "required": ["kind", "pathPrefix", "indexBasename"],
+          "properties": {
+            "kind": { "const": "manual-colocated-index" },
+            "pathPrefix": { "const": "before-required-segments" },
+            "indexBasename": { "const": "README.md" }
+          }
+        },
+        {
+          "type": "object",
+          "additionalProperties": false,
+          "required": ["kind", "reason"],
+          "properties": {
+            "kind": { "const": "not-required" },
+            "reason": {
+              "type": "string",
+              "minLength": 1,
+              "maxLength": 500,
+              "pattern": "^[^\\u0000-\\u001F\\u007F]+$"
+            }
+          }
+        }
+      ]
+    }
+  }
+}

package/schemas/document-authoring-profile/v3.schema.json

@@ -0,0 +1,200 @@
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "$id": "https://agent-teams.ai/schemas/document-authoring-profile/v3",
+  "title": "Document Authoring Profile v3",
+  "type": "object",
+  "additionalProperties": false,
+  "required": ["schemaVersion", "projectId", "catalog", "authoring"],
+  "properties": {
+    "schemaVersion": { "const": 3 },
+    "projectId": { "$ref": "https://agent-teams.ai/schemas/document-authoring-profile/v1#/$defs/lowerId" },
+    "catalog": { "$ref": "#/$defs/catalog" },
+    "authoring": { "$ref": "#/$defs/authoring" }
+  },
+  "$defs": {
+    "catalog": {
+      "type": "object",
+      "additionalProperties": false,
+      "required": ["metadataSchemaPath", "ownerCatalog", "collections"],
+      "properties": {
+        "metadataSchemaPath": { "$ref": "https://agent-teams.ai/schemas/document-authoring-profile/v1#/$defs/repositoryPath" },
+        "ownerCatalog": {
+          "type": "object",
+          "additionalProperties": false,
+          "required": ["path", "contract"],
+          "properties": {
+            "path": { "$ref": "https://agent-teams.ai/schemas/document-authoring-profile/v1#/$defs/repositoryPath" },
+            "contract": { "const": "foundation.owner-map/v1" }
+          }
+        },
+        "collections": {
+          "type": "array",
+          "minItems": 1,
+          "maxItems": 32,
+          "items": {
+            "oneOf": [
+              { "$ref": "https://agent-teams.ai/schemas/document-authoring-profile/v1#/$defs/markdownTreeCollection" },
+              { "$ref": "https://agent-teams.ai/schemas/document-authoring-profile/v1#/$defs/frontmatterReadmeCollection" }
+            ]
+          }
+        },
+        "excludedPrefixes": {
+          "type": "array",
+          "maxItems": 128,
+          "uniqueItems": true,
+          "items": { "$ref": "https://agent-teams.ai/schemas/document-authoring-profile/v1#/$defs/repositoryPath" }
+        },
+        "metadataSidecar": { "$ref": "#/$defs/metadataSidecar" }
+      }
+    },
+    "metadataSidecar": {
+      "type": "object",
+      "additionalProperties": false,
+      "required": ["kind", "path"],
+      "properties": {
+        "kind": { "const": "path-metadata-map" },
+        "path": { "$ref": "https://agent-teams.ai/schemas/document-authoring-profile/v1#/$defs/repositoryPath" }
+      }
+    },
+    "authoring": {
+      "type": "object",
+      "additionalProperties": false,
+      "required": ["mode", "artifactTypes"],
+      "properties": {
+        "mode": { "const": "create-only" },
+        "ownerSets": { "$ref": "#/$defs/ownerSets" },
+        "artifactTypes": {
+          "type": "array",
+          "minItems": 1,
+          "maxItems": 32,
+          "items": { "$ref": "#/$defs/artifactType" }
+        }
+      }
+    },
+    "artifactType": {
+      "type": "object",
+      "additionalProperties": false,
+      "required": [
+        "type",
+        "initialStatus",
+        "identity",
+        "placement",
+        "template",
+        "heading",
+        "reachability"
+      ],
+      "oneOf": [
+        {
+          "required": ["allowedOwnerIds"],
+          "properties": { "allowedOwnerIds": true }
+        },
+        {
+          "required": ["ownerSetId"],
+          "properties": { "ownerSetId": true }
+        }
+      ],
+      "properties": {
+        "type": { "$ref": "https://agent-teams.ai/schemas/document-authoring-profile/v1#/$defs/lowerId" },
+        "initialStatus": { "$ref": "https://agent-teams.ai/schemas/document-authoring-profile/v1#/$defs/lowerId" },
+        "identity": { "$ref": "https://agent-teams.ai/schemas/document-authoring-profile/v1#/$defs/identity" },
+        "placement": {
+          "oneOf": [
+            { "$ref": "https://agent-teams.ai/schemas/document-authoring-profile/v1#/$defs/collectionPlacement" },
+            { "$ref": "https://agent-teams.ai/schemas/document-authoring-profile/v1#/$defs/qualifiedLeafIndexPlacement" },
+            { "$ref": "https://agent-teams.ai/schemas/document-authoring-profile/v1#/$defs/explicitPlacement" }
+          ]
+        },
+        "template": {
+          "type": "object",
+          "additionalProperties": false,
+          "required": ["kind", "path"],
+          "properties": {
+            "kind": { "const": "fenced-markdown-body" },
+            "path": { "$ref": "https://agent-teams.ai/schemas/document-authoring-profile/v1#/$defs/repositoryPath" }
+          }
+        },
+        "heading": {
+          "type": "object",
+          "additionalProperties": false,
+          "required": ["kind"],
+          "properties": {
+            "kind": { "enum": ["id-colon-title", "title"] }
+          }
+        },
+        "reachability": { "$ref": "#/$defs/reachability" },
+        "allowedOwnerIds": { "$ref": "#/$defs/allowedOwnerIds" },
+        "ownerSetId": { "$ref": "#/$defs/ownerSetId" }
+      }
+    },
+    "ownerSetId": {
+      "type": "string",
+      "minLength": 1,
+      "maxLength": 160,
+      "pattern": "^[a-z0-9][a-z0-9._/-]*$"
+    },
+    "ownerSets": {
+      "type": "object",
+      "additionalProperties": false,
+      "required": ["schemaVersion", "sets"],
+      "properties": {
+        "schemaVersion": { "const": 1 },
+        "sets": {
+          "type": "object",
+          "minProperties": 1,
+          "maxProperties": 128,
+          "propertyNames": { "$ref": "#/$defs/ownerSetId" },
+          "additionalProperties": { "$ref": "#/$defs/allowedOwnerIds" }
+        }
+      }
+    },
+    "allowedOwnerIds": {
+      "type": "array",
+      "minItems": 1,
+      "maxItems": 4096,
+      "uniqueItems": true,
+      "items": {
+        "type": "string",
+        "minLength": 1,
+        "maxLength": 214,
+        "pattern": "^[A-Za-z0-9@][A-Za-z0-9@._/-]*$"
+      }
+    },
+    "reachability": {
+      "oneOf": [
+        {
+          "type": "object",
+          "additionalProperties": false,
+          "required": ["kind", "indexPath"],
+          "properties": {
+            "kind": { "const": "manual-fixed-index" },
+            "indexPath": { "$ref": "https://agent-teams.ai/schemas/document-authoring-profile/v1#/$defs/repositoryPath" }
+          }
+        },
+        {
+          "type": "object",
+          "additionalProperties": false,
+          "required": ["kind", "pathPrefix", "indexBasename"],
+          "properties": {
+            "kind": { "const": "manual-colocated-index" },
+            "pathPrefix": { "const": "before-required-segments" },
+            "indexBasename": { "const": "README.md" }
+          }
+        },
+        {
+          "type": "object",
+          "additionalProperties": false,
+          "required": ["kind", "reason"],
+          "properties": {
+            "kind": { "const": "not-required" },
+            "reason": {
+              "type": "string",
+              "minLength": 1,
+              "maxLength": 500,
+              "pattern": "^[^\\u0000-\\u001F\\u007F]+$"
+            }
+          }
+        }
+      ]
+    }
+  }
+}