@openplanr/protocol 0.2.0

package/schemas/v1.6.0/diagram-type-registry.schema.json

@@ -0,0 +1,373 @@
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "$id": "https://openplanr.dev/schemas/v1.6.0/diagram-type-registry.schema.json",
+  "x-openplanr-contract": {
+    "id": "diagram-type-registry",
+    "version": "1.6.0"
+  },
+  "type": "object",
+  "additionalProperties": false,
+  "required": [
+    "kind",
+    "schemaVersion",
+    "protocolVersion",
+    "documentVersion",
+    "digestAlgorithm",
+    "canonicalization",
+    "documentDigest",
+    "registryVersion",
+    "primitives",
+    "layoutFamilies",
+    "grammars"
+  ],
+  "properties": {
+    "kind": {
+      "const": "diagram-type-registry"
+    },
+    "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"
+    },
+    "registryVersion": {
+      "const": "1.0.0"
+    },
+    "primitives": {
+      "type": "array",
+      "items": {
+        "enum": [
+          "node",
+          "relation",
+          "group",
+          "lane",
+          "event",
+          "series",
+          "axis",
+          "set",
+          "annotation",
+          "emphasis"
+        ]
+      },
+      "minItems": 10,
+      "maxItems": 10,
+      "uniqueItems": true
+    },
+    "layoutFamilies": {
+      "type": "array",
+      "items": {
+        "enum": [
+          "cause-effect",
+          "chart",
+          "chronology",
+          "containment",
+          "entity",
+          "graph",
+          "hierarchy",
+          "lanes",
+          "sankey",
+          "wardley"
+        ]
+      },
+      "minItems": 10,
+      "maxItems": 10,
+      "uniqueItems": true
+    },
+    "grammars": {
+      "type": "array",
+      "items": {
+        "type": "object",
+        "additionalProperties": false,
+        "required": [
+          "grammarId",
+          "grammarVersion",
+          "title",
+          "summary",
+          "layoutFamily",
+          "aliases",
+          "requiredPrimitives",
+          "allowedPrimitives",
+          "directions",
+          "detailLimits",
+          "readability",
+          "projections",
+          "fixture",
+          "reference",
+          "rendererContract",
+          "accessibilityTemplate"
+        ],
+        "properties": {
+          "grammarId": {
+            "$ref": "common.schema.json#/$defs/identifier"
+          },
+          "grammarVersion": {
+            "const": "1.0.0"
+          },
+          "title": {
+            "$ref": "common.schema.json#/$defs/nonBlankText"
+          },
+          "summary": {
+            "$ref": "common.schema.json#/$defs/nonBlankText"
+          },
+          "layoutFamily": {
+            "enum": [
+              "cause-effect",
+              "chart",
+              "chronology",
+              "containment",
+              "entity",
+              "graph",
+              "hierarchy",
+              "lanes",
+              "sankey",
+              "wardley"
+            ]
+          },
+          "aliases": {
+            "type": "array",
+            "items": {
+              "type": "string",
+              "minLength": 2,
+              "maxLength": 128
+            },
+            "minItems": 1,
+            "maxItems": 32,
+            "uniqueItems": true
+          },
+          "requiredPrimitives": {
+            "type": "array",
+            "items": {
+              "enum": [
+                "node",
+                "relation",
+                "group",
+                "lane",
+                "event",
+                "series",
+                "axis",
+                "set",
+                "annotation",
+                "emphasis"
+              ]
+            },
+            "minItems": 1,
+            "maxItems": 10,
+            "uniqueItems": true
+          },
+          "allowedPrimitives": {
+            "type": "array",
+            "items": {
+              "enum": [
+                "node",
+                "relation",
+                "group",
+                "lane",
+                "event",
+                "series",
+                "axis",
+                "set",
+                "annotation",
+                "emphasis"
+              ]
+            },
+            "minItems": 1,
+            "maxItems": 10,
+            "uniqueItems": true
+          },
+          "directions": {
+            "type": "array",
+            "items": {
+              "enum": [
+                "top-down",
+                "left-right",
+                "right-left",
+                "bottom-up",
+                "radial"
+              ]
+            },
+            "minItems": 1,
+            "maxItems": 5,
+            "uniqueItems": true
+          },
+          "detailLimits": {
+            "type": "object",
+            "additionalProperties": false,
+            "required": [
+              "simplified",
+              "balanced",
+              "faithful",
+              "hard"
+            ],
+            "properties": {
+              "simplified": {
+                "type": "integer",
+                "minimum": 1,
+                "maximum": 24
+              },
+              "balanced": {
+                "type": "integer",
+                "minimum": 1,
+                "maximum": 24
+              },
+              "faithful": {
+                "type": "integer",
+                "minimum": 1,
+                "maximum": 48
+              },
+              "hard": {
+                "type": "integer",
+                "minimum": 1,
+                "maximum": 128
+              }
+            }
+          },
+          "readability": {
+            "type": "object",
+            "additionalProperties": false,
+            "required": [
+              "maxLabelCharacters",
+              "maxCrossings",
+              "maxFanIn",
+              "minTextSize",
+              "aspectRatios"
+            ],
+            "properties": {
+              "maxLabelCharacters": {
+                "type": "integer",
+                "minimum": 8,
+                "maximum": 256
+              },
+              "maxCrossings": {
+                "type": "integer",
+                "minimum": 0,
+                "maximum": 256
+              },
+              "maxFanIn": {
+                "type": "integer",
+                "minimum": 1,
+                "maximum": 64
+              },
+              "minTextSize": {
+                "type": "integer",
+                "minimum": 9,
+                "maximum": 24
+              },
+              "aspectRatios": {
+                "type": "array",
+                "items": {
+                  "enum": [
+                    "fit",
+                    "doc-inline",
+                    "doc-wide",
+                    "slide-16x9",
+                    "slide-4x3",
+                    "social-square",
+                    "print-landscape"
+                  ]
+                },
+                "minItems": 1,
+                "maxItems": 8,
+                "uniqueItems": true
+              }
+            }
+          },
+          "projections": {
+            "type": "object",
+            "additionalProperties": false,
+            "required": [
+              "mermaid",
+              "excalidraw"
+            ],
+            "properties": {
+              "mermaid": {
+                "enum": [
+                  "editable",
+                  "render-only",
+                  "partial",
+                  "lossy",
+                  "unsupported"
+                ]
+              },
+              "excalidraw": {
+                "enum": [
+                  "editable",
+                  "render-only",
+                  "partial",
+                  "lossy",
+                  "unsupported"
+                ]
+              }
+            }
+          },
+          "fixture": {
+            "$ref": "common.schema.json#/$defs/relativePath"
+          },
+          "reference": {
+            "$ref": "common.schema.json#/$defs/relativePath"
+          },
+          "rendererContract": {
+            "type": "object",
+            "additionalProperties": false,
+            "required": [
+              "layoutFamily",
+              "contractVersion",
+              "staticByDefault"
+            ],
+            "properties": {
+              "layoutFamily": {
+                "enum": [
+                  "cause-effect",
+                  "chart",
+                  "chronology",
+                  "containment",
+                  "entity",
+                  "graph",
+                  "hierarchy",
+                  "lanes",
+                  "sankey",
+                  "wardley"
+                ]
+              },
+              "contractVersion": {
+                "$ref": "common.schema.json#/$defs/semver"
+              },
+              "staticByDefault": {
+                "const": true
+              }
+            }
+          },
+          "accessibilityTemplate": {
+            "type": "object",
+            "additionalProperties": false,
+            "required": [
+              "title",
+              "description"
+            ],
+            "properties": {
+              "title": {
+                "$ref": "common.schema.json#/$defs/nonBlankText"
+              },
+              "description": {
+                "$ref": "common.schema.json#/$defs/nonBlankText"
+              }
+            }
+          }
+        }
+      },
+      "minItems": 1,
+      "maxItems": 64
+    }
+  }
+}

package/schemas/v1.6.0/generated-asset-manifest.schema.json

@@ -0,0 +1,103 @@
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "$id": "https://openplanr.dev/schemas/v1.6.0/generated-asset-manifest.schema.json",
+  "x-openplanr-contract": {
+    "id": "generated-asset-manifest",
+    "version": "1.6.0"
+  },
+  "type": "object",
+  "additionalProperties": false,
+  "required": [
+    "kind",
+    "schemaVersion",
+    "protocolVersion",
+    "documentVersion",
+    "digestAlgorithm",
+    "canonicalization",
+    "documentDigest",
+    "assetSetId",
+    "sourceFormat",
+    "assets"
+  ],
+  "properties": {
+    "kind": {
+      "const": "generated-asset-manifest"
+    },
+    "schemaVersion": {
+      "const": "1.6.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"
+    },
+    "assetSetId": {
+      "type": "string",
+      "pattern": "^sas_[0-9a-f]{32}$"
+    },
+    "sourceFormat": {
+      "$ref": "common.schema.json#/$defs/sourceFormat"
+    },
+    "assets": {
+      "type": "array",
+      "items": {
+        "type": "object",
+        "additionalProperties": false,
+        "required": [
+          "path",
+          "host",
+          "mediaType",
+          "byteLength",
+          "digest",
+          "sourceMap"
+        ],
+        "properties": {
+          "path": {
+            "$ref": "common.schema.json#/$defs/relativePath"
+          },
+          "host": {
+            "anyOf": [
+              {
+                "$ref": "common.schema.json#/$defs/host"
+              },
+              {
+                "type": "null"
+              }
+            ]
+          },
+          "mediaType": {
+            "type": "string",
+            "pattern": "^[a-z0-9.+-]+/[a-z0-9.+-]+$"
+          },
+          "byteLength": {
+            "type": "integer",
+            "minimum": 0
+          },
+          "digest": {
+            "$ref": "common.schema.json#/$defs/digest"
+          },
+          "sourceMap": {
+            "type": "array",
+            "items": {
+              "$ref": "common.schema.json#/$defs/sourceMapRange"
+            },
+            "minItems": 0,
+            "maxItems": 8192
+          }
+        }
+      },
+      "minItems": 0,
+      "maxItems": 8192
+    }
+  }
+}

package/schemas/v1.6.0/skill-catalog.schema.json

@@ -0,0 +1,84 @@
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "$id": "https://openplanr.dev/schemas/v1.6.0/skill-catalog.schema.json",
+  "x-openplanr-contract": {
+    "id": "skill-catalog",
+    "version": "1.6.0"
+  },
+  "type": "object",
+  "additionalProperties": false,
+  "required": [
+    "kind",
+    "schemaVersion",
+    "protocolVersion",
+    "documentVersion",
+    "digestAlgorithm",
+    "canonicalization",
+    "documentDigest",
+    "catalogVersion",
+    "sources"
+  ],
+  "properties": {
+    "kind": {
+      "const": "skill-catalog"
+    },
+    "schemaVersion": {
+      "const": "1.6.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"
+    },
+    "catalogVersion": {
+      "$ref": "common.schema.json#/$defs/semver"
+    },
+    "sources": {
+      "type": "array",
+      "items": {
+        "type": "object",
+        "additionalProperties": false,
+        "required": [
+          "skillId",
+          "skillVersion",
+          "sourceFormat",
+          "sourceDigest",
+          "moduleGraphDigest",
+          "source"
+        ],
+        "properties": {
+          "skillId": {
+            "$ref": "common.schema.json#/$defs/skillId"
+          },
+          "skillVersion": {
+            "$ref": "common.schema.json#/$defs/semver"
+          },
+          "sourceFormat": {
+            "$ref": "common.schema.json#/$defs/sourceFormat"
+          },
+          "sourceDigest": {
+            "$ref": "common.schema.json#/$defs/digest"
+          },
+          "moduleGraphDigest": {
+            "$ref": "common.schema.json#/$defs/digest"
+          },
+          "source": {
+            "$ref": "common.schema.json#/$defs/sourceRef"
+          }
+        }
+      },
+      "minItems": 0,
+      "maxItems": 256
+    }
+  }
+}

package/schemas/v1.6.0/skill-completion-receipt.schema.json

@@ -0,0 +1,72 @@
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "$id": "https://openplanr.dev/schemas/v1.6.0/skill-completion-receipt.schema.json",
+  "x-openplanr-contract": {
+    "id": "skill-completion-receipt",
+    "version": "1.6.0"
+  },
+  "type": "object",
+  "additionalProperties": false,
+  "required": [
+    "kind",
+    "schemaVersion",
+    "protocolVersion",
+    "documentVersion",
+    "digestAlgorithm",
+    "canonicalization",
+    "documentDigest",
+    "skillId",
+    "skillVersion",
+    "sourceFormat",
+    "completedAt",
+    "summary",
+    "selectedModules"
+  ],
+  "properties": {
+    "kind": {
+      "const": "skill-completion-receipt"
+    },
+    "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"
+    },
+    "skillId": {
+      "$ref": "common.schema.json#/$defs/skillId"
+    },
+    "skillVersion": {
+      "$ref": "common.schema.json#/$defs/semver"
+    },
+    "sourceFormat": {
+      "$ref": "common.schema.json#/$defs/sourceFormat"
+    },
+    "completedAt": {
+      "$ref": "common.schema.json#/$defs/dateTime"
+    },
+    "summary": {
+      "$ref": "common.schema.json#/$defs/nonBlankText"
+    },
+    "selectedModules": {
+      "type": "array",
+      "items": {
+        "$ref": "common.schema.json#/$defs/moduleRef"
+      },
+      "minItems": 0,
+      "maxItems": 256
+    }
+  },
+  "description": "Optional reporting-only summary; never a Plan, Review, Ship, generation, or runtime prerequisite."
+}

package/schemas/v1.6.0/skill-consent-record.schema.json

@@ -0,0 +1,74 @@
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "$id": "https://openplanr.dev/schemas/v1.6.0/skill-consent-record.schema.json",
+  "x-openplanr-contract": {
+    "id": "skill-consent-record",
+    "version": "1.6.0"
+  },
+  "type": "object",
+  "additionalProperties": false,
+  "required": [
+    "kind",
+    "schemaVersion",
+    "protocolVersion",
+    "documentVersion",
+    "digestAlgorithm",
+    "canonicalization",
+    "documentDigest",
+    "consentId",
+    "skillId",
+    "subject",
+    "decision",
+    "recordedAt",
+    "confirmation"
+  ],
+  "properties": {
+    "kind": {
+      "const": "skill-consent-record"
+    },
+    "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"
+    },
+    "consentId": {
+      "$ref": "common.schema.json#/$defs/identifier"
+    },
+    "skillId": {
+      "$ref": "common.schema.json#/$defs/skillId"
+    },
+    "subject": {
+      "enum": [
+        "learning",
+        "telemetry",
+        "external-data"
+      ]
+    },
+    "decision": {
+      "enum": [
+        "granted",
+        "declined",
+        "withdrawn"
+      ]
+    },
+    "recordedAt": {
+      "$ref": "common.schema.json#/$defs/dateTime"
+    },
+    "confirmation": {
+      "$ref": "https://openplanr.dev/schemas/v1.2.0/guided-confirmation.schema.json"
+    }
+  }
+}