@openplanr/protocol 0.2.0

package/schemas/v1.6.0/common.schema.json

@@ -0,0 +1,462 @@
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "$id": "https://openplanr.dev/schemas/v1.6.0/common.schema.json",
+  "x-openplanr-contract": {
+    "id": "skill-source-common",
+    "version": "1.6.0"
+  },
+  "$defs": {
+    "digest": {
+      "type": "string",
+      "pattern": "^sha256:[0-9a-f]{64}$"
+    },
+    "semver": {
+      "type": "string",
+      "pattern": "^(0|[1-9][0-9]*)\\.(0|[1-9][0-9]*)\\.(0|[1-9][0-9]*)(?:-((?:0|[1-9][0-9]*|[0-9]*[A-Za-z-][0-9A-Za-z-]*)(?:\\.(?:0|[1-9][0-9]*|[0-9]*[A-Za-z-][0-9A-Za-z-]*))*))?(?:\\+([0-9A-Za-z-]+(?:\\.[0-9A-Za-z-]+)*))?$"
+    },
+    "dateTime": {
+      "type": "string",
+      "format": "date-time"
+    },
+    "nonBlankText": {
+      "type": "string",
+      "minLength": 1,
+      "maxLength": 16384,
+      "pattern": ".*\\S.*"
+    },
+    "identifier": {
+      "type": "string",
+      "pattern": "^[a-z][a-z0-9]*(?:-[a-z0-9]+)*$",
+      "minLength": 1,
+      "maxLength": 128
+    },
+    "capabilityAuthority": {
+      "enum": [
+        "context-gathering",
+        "planning-write",
+        "read",
+        "read-only-view",
+        "write"
+      ]
+    },
+    "operationAuthority": {
+      "enum": [
+        "artifact",
+        "backlog",
+        "checklist",
+        "compile",
+        "config",
+        "context",
+        "diagram",
+        "doctor",
+        "epic",
+        "estimate",
+        "evidence",
+        "export",
+        "feature",
+        "github",
+        "graph",
+        "init",
+        "land",
+        "linear",
+        "operate",
+        "pipeline",
+        "plan",
+        "quick",
+        "refine",
+        "render",
+        "report",
+        "report-linter",
+        "revise",
+        "rules",
+        "runtime",
+        "search",
+        "setup",
+        "spec",
+        "sprint",
+        "status",
+        "story",
+        "sync",
+        "task",
+        "template",
+        "update",
+        "upgrade",
+        "voice"
+      ]
+    },
+    "toolAuthority": {
+      "type": "string",
+      "minLength": 1,
+      "maxLength": 128,
+      "pattern": "^(?:read|edit|shell|Bash|Edit|Glob|Grep|Read|Write)(?:\\([^()]+\\))?$"
+    },
+    "skillId": {
+      "type": "string",
+      "pattern": "^planr-[a-z0-9]+(?:-[a-z0-9]+)*$",
+      "maxLength": 128
+    },
+    "moduleId": {
+      "type": "string",
+      "pattern": "^[a-z][a-z0-9]*(?:-[a-z0-9]+)*$",
+      "minLength": 1,
+      "maxLength": 128
+    },
+    "relativePath": {
+      "type": "string",
+      "minLength": 1,
+      "maxLength": 1024,
+      "pattern": "^(?!/)(?![A-Za-z]:)(?!.*\\\\)(?!.*(?:^|/)\\.{1,2}(?:/|$))(?!.*//).+$"
+    },
+    "host": {
+      "enum": [
+        "claude-code",
+        "codex",
+        "cursor",
+        "pipeline"
+      ]
+    },
+    "runtimeCapability": {
+      "enum": [
+        "attached-terminal",
+        "native-questions",
+        "structured-chat"
+      ]
+    },
+    "interactionSurface": {
+      "enum": [
+        "native",
+        "chat",
+        "terminal",
+        "headless"
+      ]
+    },
+    "protocolInteraction": {
+      "enum": [
+        "native",
+        "chat",
+        "terminal",
+        "none"
+      ]
+    },
+    "interactionBinding": {
+      "type": "object",
+      "additionalProperties": false,
+      "required": [
+        "surface",
+        "protocolInteraction"
+      ],
+      "properties": {
+        "surface": {
+          "$ref": "#/$defs/interactionSurface"
+        },
+        "protocolInteraction": {
+          "$ref": "#/$defs/protocolInteraction"
+        },
+        "capabilityId": {
+          "$ref": "#/$defs/runtimeCapability"
+        }
+      },
+      "oneOf": [
+        {
+          "title": "Native composer surface",
+          "required": [
+            "capabilityId"
+          ],
+          "properties": {
+            "surface": {
+              "const": "native"
+            },
+            "protocolInteraction": {
+              "const": "native"
+            },
+            "capabilityId": {
+              "const": "native-questions"
+            }
+          }
+        },
+        {
+          "title": "Structured chat surface",
+          "required": [
+            "capabilityId"
+          ],
+          "properties": {
+            "surface": {
+              "const": "chat"
+            },
+            "protocolInteraction": {
+              "const": "chat"
+            },
+            "capabilityId": {
+              "const": "structured-chat"
+            }
+          }
+        },
+        {
+          "title": "Attached terminal surface",
+          "required": [
+            "capabilityId"
+          ],
+          "properties": {
+            "surface": {
+              "const": "terminal"
+            },
+            "protocolInteraction": {
+              "const": "terminal"
+            },
+            "capabilityId": {
+              "const": "attached-terminal"
+            }
+          }
+        },
+        {
+          "title": "Non-interactive headless fallback",
+          "properties": {
+            "surface": {
+              "const": "headless"
+            },
+            "protocolInteraction": {
+              "const": "none"
+            }
+          },
+          "not": {
+            "required": [
+              "capabilityId"
+            ]
+          }
+        }
+      ]
+    },
+    "sourceFormat": {
+      "enum": [
+        "markdown-v1",
+        "composed-v1"
+      ]
+    },
+    "contractRef": {
+      "type": "object",
+      "additionalProperties": false,
+      "required": [
+        "id",
+        "version"
+      ],
+      "properties": {
+        "id": {
+          "$ref": "#/$defs/identifier"
+        },
+        "version": {
+          "$ref": "#/$defs/semver"
+        }
+      }
+    },
+    "sourceRef": {
+      "type": "object",
+      "additionalProperties": false,
+      "required": [
+        "path",
+        "digest"
+      ],
+      "properties": {
+        "path": {
+          "$ref": "#/$defs/relativePath"
+        },
+        "digest": {
+          "$ref": "#/$defs/digest"
+        }
+      }
+    },
+    "moduleRef": {
+      "type": "object",
+      "additionalProperties": false,
+      "required": [
+        "moduleId",
+        "moduleVersion",
+        "digest"
+      ],
+      "properties": {
+        "moduleId": {
+          "$ref": "#/$defs/moduleId"
+        },
+        "moduleVersion": {
+          "$ref": "#/$defs/semver"
+        },
+        "digest": {
+          "$ref": "#/$defs/digest"
+        }
+      }
+    },
+    "authorityCeiling": {
+      "type": "object",
+      "additionalProperties": false,
+      "required": [
+        "repositoryAccess",
+        "externalDataAccess",
+        "allowedCapabilities",
+        "allowedTools",
+        "allowedOperations",
+        "allowedOutputClasses",
+        "forbiddenEffects"
+      ],
+      "properties": {
+        "repositoryAccess": {
+          "enum": [
+            "declared-paths",
+            "read-only",
+            "none"
+          ],
+          "description": "Narrowing order declared-paths -> read-only -> none."
+        },
+        "externalDataAccess": {
+          "enum": [
+            "read-only",
+            "none"
+          ],
+          "description": "Narrowing order read-only -> none."
+        },
+        "allowedCapabilities": {
+          "type": "array",
+          "items": {
+            "$ref": "#/$defs/capabilityAuthority"
+          },
+          "minItems": 0,
+          "maxItems": 128,
+          "uniqueItems": true,
+          "description": "Closed ceiling set; overlays may only remove members."
+        },
+        "allowedTools": {
+          "type": "array",
+          "items": {
+            "$ref": "#/$defs/toolAuthority"
+          },
+          "minItems": 0,
+          "maxItems": 128,
+          "uniqueItems": true,
+          "description": "Closed ceiling set; overlays may only remove members."
+        },
+        "allowedOperations": {
+          "type": "array",
+          "items": {
+            "$ref": "#/$defs/operationAuthority"
+          },
+          "minItems": 0,
+          "maxItems": 128,
+          "uniqueItems": true,
+          "description": "Closed ceiling set; overlays may only remove members."
+        },
+        "allowedOutputClasses": {
+          "type": "array",
+          "items": {
+            "enum": [
+              "A",
+              "B",
+              "C",
+              "D"
+            ]
+          },
+          "minItems": 0,
+          "maxItems": 4,
+          "uniqueItems": true,
+          "description": "Ceiling set; overlays may only remove members."
+        },
+        "forbiddenEffects": {
+          "type": "array",
+          "items": {
+            "$ref": "#/$defs/identifier"
+          },
+          "minItems": 0,
+          "maxItems": 64,
+          "uniqueItems": true,
+          "description": "Grows only; overlays may only add members."
+        }
+      }
+    },
+    "sourceMapOwner": {
+      "type": "object",
+      "additionalProperties": false,
+      "required": [
+        "ownerKind",
+        "pointer",
+        "version",
+        "digest"
+      ],
+      "properties": {
+        "ownerKind": {
+          "enum": [
+            "template",
+            "source",
+            "host-profile",
+            "compiler"
+          ]
+        },
+        "pointer": {
+          "$ref": "#/$defs/relativePath"
+        },
+        "version": {
+          "$ref": "#/$defs/semver"
+        },
+        "digest": {
+          "$ref": "#/$defs/digest"
+        }
+      }
+    },
+    "sourceMapRange": {
+      "type": "object",
+      "additionalProperties": false,
+      "required": [
+        "startByte",
+        "endByte",
+        "owner"
+      ],
+      "properties": {
+        "startByte": {
+          "type": "integer",
+          "minimum": 0
+        },
+        "endByte": {
+          "type": "integer",
+          "minimum": 1
+        },
+        "owner": {
+          "$ref": "#/$defs/sourceMapOwner"
+        }
+      }
+    },
+    "envelope": {
+      "type": "object",
+      "additionalProperties": false,
+      "required": [
+        "kind",
+        "schemaVersion",
+        "protocolVersion",
+        "documentVersion",
+        "digestAlgorithm",
+        "canonicalization",
+        "documentDigest"
+      ],
+      "properties": {
+        "kind": {
+          "type": "string",
+          "minLength": 1,
+          "maxLength": 96
+        },
+        "schemaVersion": {
+          "$ref": "common.schema.json#/$defs/semver"
+        },
+        "protocolVersion": {
+          "const": "1.6.0"
+        },
+        "documentVersion": {
+          "$ref": "common.schema.json#/$defs/semver"
+        },
+        "digestAlgorithm": {
+          "const": "sha256"
+        },
+        "canonicalization": {
+          "const": "rfc8785"
+        },
+        "documentDigest": {
+          "$ref": "common.schema.json#/$defs/digest"
+        }
+      }
+    }
+  }
+}

package/schemas/v1.6.0/diagram-consumer-reference.schema.json

@@ -0,0 +1,167 @@
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "$id": "https://openplanr.dev/schemas/v1.6.0/diagram-consumer-reference.schema.json",
+  "x-openplanr-contract": {
+    "id": "diagram-consumer-reference",
+    "version": "1.6.0"
+  },
+  "type": "object",
+  "additionalProperties": false,
+  "required": [
+    "kind",
+    "schemaVersion",
+    "protocolVersion",
+    "documentVersion",
+    "digestAlgorithm",
+    "canonicalization",
+    "documentDigest",
+    "referenceId",
+    "diagramId",
+    "consumer",
+    "manifest",
+    "source",
+    "output",
+    "accessibility"
+  ],
+  "properties": {
+    "kind": {
+      "const": "diagram-consumer-reference"
+    },
+    "schemaVersion": {
+      "const": "1.0.0"
+    },
+    "protocolVersion": {
+      "const": "1.6.0"
+    },
+    "documentVersion": {
+      "$ref": "common.schema.json#/$defs/semver"
+    },
+    "digestAlgorithm": {
+      "const": "sha256"
+    },
+    "canonicalization": {
+      "const": "rfc8785"
+    },
+    "documentDigest": {
+      "$ref": "common.schema.json#/$defs/digest"
+    },
+    "referenceId": {
+      "type": "string",
+      "pattern": "^[a-z][a-z0-9]*(?:-[a-z0-9]+)*$",
+      "maxLength": 128
+    },
+    "diagramId": {
+      "type": "string",
+      "pattern": "^[a-z][a-z0-9]*(?:-[a-z0-9]+)*$",
+      "maxLength": 128
+    },
+    "consumer": {
+      "type": "object",
+      "additionalProperties": false,
+      "required": [
+        "kind",
+        "path"
+      ],
+      "properties": {
+        "kind": {
+          "enum": [
+            "specification",
+            "documentation",
+            "pdf"
+          ]
+        },
+        "path": {
+          "anyOf": [
+            {
+              "$ref": "common.schema.json#/$defs/relativePath"
+            },
+            {
+              "type": "null"
+            }
+          ]
+        }
+      }
+    },
+    "manifest": {
+      "type": "object",
+      "additionalProperties": false,
+      "required": [
+        "path",
+        "digest"
+      ],
+      "properties": {
+        "path": {
+          "$ref": "common.schema.json#/$defs/relativePath"
+        },
+        "digest": {
+          "$ref": "common.schema.json#/$defs/digest"
+        }
+      }
+    },
+    "source": {
+      "type": "object",
+      "additionalProperties": false,
+      "required": [
+        "path",
+        "digest"
+      ],
+      "properties": {
+        "path": {
+          "$ref": "common.schema.json#/$defs/relativePath"
+        },
+        "digest": {
+          "$ref": "common.schema.json#/$defs/digest"
+        }
+      }
+    },
+    "output": {
+      "type": "object",
+      "additionalProperties": false,
+      "required": [
+        "path",
+        "mediaType",
+        "digest",
+        "fidelity"
+      ],
+      "properties": {
+        "path": {
+          "$ref": "common.schema.json#/$defs/relativePath"
+        },
+        "mediaType": {
+          "enum": [
+            "image/svg+xml; charset=utf-8",
+            "image/png"
+          ]
+        },
+        "digest": {
+          "$ref": "common.schema.json#/$defs/digest"
+        },
+        "fidelity": {
+          "enum": [
+            "editable",
+            "render-only",
+            "partial",
+            "lossy",
+            "unsupported"
+          ]
+        }
+      }
+    },
+    "accessibility": {
+      "type": "object",
+      "additionalProperties": false,
+      "required": [
+        "title",
+        "description"
+      ],
+      "properties": {
+        "title": {
+          "$ref": "common.schema.json#/$defs/nonBlankText"
+        },
+        "description": {
+          "$ref": "common.schema.json#/$defs/nonBlankText"
+        }
+      }
+    }
+  }
+}