@millstone/synapse-schemas 0.1.0

package/frontmatter/reference.schema.json

@@ -0,0 +1,77 @@
+{
+  "$id": "reference.schema.json",
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "allOf": [
+    {
+      "$ref": "base.schema.json"
+    }
+  ],
+  "type": "object",
+  "properties": {
+    "type": {
+      "const": "reference"
+    },
+    "title": {
+      "type": "string",
+      "minLength": 1,
+      "description": "Title of the reference document"
+    },
+    "summary": {
+      "type": "string",
+      "description": "Brief description or excerpt"
+    },
+    "status": {
+      "type": "string",
+      "enum": ["draft", "published", "archived"],
+      "description": "Status of the reference document"
+    },
+    "upstream_url": {
+      "type": "string",
+      "format": "uri",
+      "description": "Source URL where this reference content originates"
+    },
+    "source_prefix": {
+      "type": "string",
+      "pattern": "^[a-z0-9-]+$",
+      "description": "Manual override for source prefix in filename (e.g., 'claude-code', 'dora'). Only needed if automatic extraction from upstream_url fails or needs customization."
+    },
+    "last_synced": {
+      "type": "string",
+      "format": "date-time",
+      "description": "Timestamp of when content was last synchronized from upstream"
+    },
+    "attribution": {
+      "type": "string",
+      "minLength": 1,
+      "description": "Original author or organization"
+    },
+    "license": {
+      "type": "string",
+      "minLength": 1,
+      "description": "License under which the upstream content is distributed"
+    },
+    "upstream_version": {
+      "type": "string",
+      "description": "Version or commit hash from upstream source (optional)"
+    },
+    "category": {
+      "type": "string",
+      "enum": [
+        "documentation",
+        "api-reference",
+        "blog-post",
+        "standard",
+        "specification",
+        "tutorial",
+        "other"
+      ],
+      "description": "Category of external reference"
+    }
+  },
+  "required": [
+    "type",
+    "upstream_url",
+    "last_synced"
+  ],
+  "additionalProperties": false
+}

package/frontmatter/runbook.schema.json

@@ -0,0 +1,19 @@
+{
+  "$id": "runbook.schema.json",
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "allOf": [
+    {
+      "$ref": "base.schema.json"
+    }
+  ],
+  "type": "object",
+  "properties": {
+    "type": {
+      "const": "runbook"
+    }
+  },
+  "required": [
+    "type"
+  ],
+  "additionalProperties": false
+}

package/frontmatter/scorecard.schema.json

@@ -0,0 +1,176 @@
+{
+  "$id": "scorecard.schema.json",
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "allOf": [
+    {
+      "$ref": "base.schema.json"
+    }
+  ],
+  "type": "object",
+  "properties": {
+    "type": {
+      "const": "scorecard"
+    },
+    "dimensions": {
+      "type": "array",
+      "items": {
+        "type": "object",
+        "properties": {
+          "name": {
+            "type": "string",
+            "minLength": 1
+          },
+          "weight": {
+            "type": "number",
+            "minimum": 0,
+            "maximum": 1
+          },
+          "rating": {
+            "type": "number",
+            "minimum": 0,
+            "maximum": 5
+          },
+          "evidence": {
+            "type": "string"
+          },
+          "notes": {
+            "type": "string"
+          }
+        },
+        "required": [
+          "name"
+        ]
+      },
+      "minItems": 1
+    },
+    "weighted_total": {
+      "type": "number",
+      "minimum": 0
+    },
+    "overall_summary": {
+      "type": "string",
+      "minLength": 1
+    },
+    "strengths": {
+      "type": "array",
+      "items": {
+        "type": "string"
+      }
+    },
+    "top_risks": {
+      "type": "array",
+      "items": {
+        "type": "string"
+      }
+    },
+    "recommendation": {
+      "type": "string",
+      "enum": [
+        "Proceed",
+        "Proceed with conditions",
+        "Do not proceed"
+      ]
+    },
+    "metrics": {
+      "type": "object",
+      "additionalProperties": {
+        "type": "string"
+      }
+    },
+    "risks": {
+      "type": "array",
+      "items": {
+        "type": "object",
+        "properties": {
+          "risk": {
+            "type": "string"
+          },
+          "severity": {
+            "type": "string",
+            "enum": [
+              "H",
+              "M",
+              "L"
+            ]
+          },
+          "likelihood": {
+            "type": "string",
+            "enum": [
+              "H",
+              "M",
+              "L"
+            ]
+          },
+          "owner": {
+            "type": "string"
+          },
+          "mitigation": {
+            "type": "string"
+          },
+          "due_date": {
+            "type": "string"
+          },
+          "status": {
+            "type": "string"
+          }
+        },
+        "required": [
+          "risk",
+          "severity",
+          "likelihood"
+        ]
+      }
+    },
+    "action_plan": {
+      "type": "array",
+      "items": {
+        "type": "object",
+        "properties": {
+          "initiative": {
+            "type": "string"
+          },
+          "impact": {
+            "type": "string",
+            "enum": [
+              "H",
+              "M",
+              "L"
+            ]
+          },
+          "effort": {
+            "type": "string",
+            "enum": [
+              "H",
+              "M",
+              "L"
+            ]
+          },
+          "owner": {
+            "type": "string"
+          },
+          "milestones": {
+            "type": "string"
+          },
+          "dependencies": {
+            "type": "string"
+          }
+        },
+        "required": [
+          "initiative"
+        ]
+      }
+    },
+    "related_docs": {
+      "type": "array",
+      "items": {
+        "type": "string"
+      }
+    }
+  },
+  "required": [
+    "type",
+    "dimensions",
+    "overall_summary"
+  ],
+  "additionalProperties": false
+}

package/frontmatter/sop.schema.json

@@ -0,0 +1,42 @@
+{
+  "$id": "sop.schema.json",
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "allOf": [
+    {
+      "$ref": "base.schema.json"
+    }
+  ],
+  "type": "object",
+  "properties": {
+    "type": {
+      "const": "sop"
+    },
+    "related_process": {
+      "type": "string",
+      "minLength": 1
+    },
+    "related_prds": {
+      "type": "array",
+      "items": {
+        "type": "string"
+      }
+    },
+    "related_standards": {
+      "type": "array",
+      "items": {
+        "type": "string"
+      }
+    },
+    "related_systems": {
+      "type": "array",
+      "items": {
+        "type": "string"
+      }
+    }
+  },
+  "required": [
+    "type",
+    "related_process"
+  ],
+  "additionalProperties": false
+}

package/frontmatter/sow.schema.json

@@ -0,0 +1,35 @@
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "$id": "sow.schema.json",
+  "allOf": [
+    {
+      "$ref": "base.schema.json"
+    }
+  ],
+  "title": "Statement of Work Schema",
+  "type": "object",
+  "required": [
+    "type"
+  ],
+  "properties": {
+    "type": {
+      "const": "sow"
+    },
+    "related_prds": {
+      "type": "array",
+      "items": {
+        "type": "string"
+      }
+    },
+    "related_tdds": {
+      "type": "array",
+      "items": {
+        "type": "string"
+      }
+    },
+    "agreement_date": {
+      "type": "string"
+    }
+  },
+  "additionalProperties": false
+}

package/frontmatter/standard.schema.json

@@ -0,0 +1,31 @@
+{
+  "$id": "standard.schema.json",
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "allOf": [
+    {
+      "$ref": "base.schema.json"
+    }
+  ],
+  "type": "object",
+  "properties": {
+    "type": {
+      "const": "standard"
+    },
+    "related_policies": {
+      "type": "array",
+      "items": {
+        "type": "string"
+      }
+    },
+    "related_systems": {
+      "type": "array",
+      "items": {
+        "type": "string"
+      }
+    }
+  },
+  "required": [
+    "type"
+  ],
+  "additionalProperties": false
+}

package/frontmatter/system.schema.json

@@ -0,0 +1,51 @@
+{
+  "$id": "system.schema.json",
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "allOf": [
+    {
+      "$ref": "base.schema.json"
+    }
+  ],
+  "type": "object",
+  "properties": {
+    "type": {
+      "const": "system"
+    },
+    "owner_team": {
+      "type": "string",
+      "minLength": 1
+    },
+    "repos": {
+      "type": "array",
+      "items": {
+        "type": "string",
+        "minLength": 1
+      }
+    },
+    "runtime": {
+      "type": "string",
+      "minLength": 1
+    },
+    "sla": {
+      "type": "string"
+    },
+    "dependencies": {
+      "type": "array",
+      "items": {
+        "type": "string"
+      }
+    },
+    "runbooks": {
+      "type": "array",
+      "items": {
+        "type": "string"
+      }
+    }
+  },
+  "required": [
+    "type",
+    "owner_team",
+    "runtime"
+  ],
+  "additionalProperties": false
+}

package/frontmatter/tdd.schema.json

@@ -0,0 +1,25 @@
+{
+  "$id": "tdd.schema.json",
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "allOf": [
+    {
+      "$ref": "base.schema.json"
+    }
+  ],
+  "type": "object",
+  "properties": {
+    "type": {
+      "const": "tdd"
+    },
+    "related_adrs": {
+      "type": "array",
+      "items": {
+        "type": "string"
+      }
+    }
+  },
+  "required": [
+    "type"
+  ],
+  "additionalProperties": false
+}

package/index.js

@@ -0,0 +1,9 @@
+import { fileURLToPath } from 'url';
+import { dirname, join } from 'path';
+
+const __dirname = dirname(fileURLToPath(import.meta.url));
+
+export function getSchemaDir() { return __dirname; }
+export function getFrontmatterSchemaDir() { return join(__dirname, 'frontmatter'); }
+export function getBodyGrammarDir() { return join(__dirname, 'body-grammars'); }
+export function getPluginSchemaDir() { return join(__dirname, 'plugins'); }

package/package.json

@@ -0,0 +1,34 @@
+{
+  "name": "@millstone/synapse-schemas",
+  "version": "0.1.0",
+  "description": "JSON Schema definitions for Synapse documentation framework",
+  "type": "module",
+  "main": "index.js",
+  "exports": {
+    ".": "./index.js",
+    "./frontmatter/*": "./frontmatter/*",
+    "./body-grammars/*": "./body-grammars/*",
+    "./plugins/*": "./plugins/*",
+    "./package.json": "./package.json"
+  },
+  "files": [
+    "frontmatter/**/*.json",
+    "body-grammars/**/*",
+    "plugins/**/*.json",
+    "index.js",
+    "README.md"
+  ],
+  "publishConfig": { "access": "public" },
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/millstonehq/synapse.git",
+    "directory": "packages/schemas"
+  },
+  "homepage": "https://github.com/millstonehq/synapse#readme",
+  "bugs": {
+    "url": "https://github.com/millstonehq/synapse/issues"
+  },
+  "keywords": ["synapse", "schemas", "json-schema", "documentation", "validation"],
+  "engines": { "node": ">=20.0.0" },
+  "license": "MIT"
+}

package/plugins/marketplace.schema.json

@@ -0,0 +1,126 @@
+{
+  "$id": "marketplace.schema.json",
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "title": "Claude Code Plugin Marketplace Schema",
+  "description": "Schema for validating Claude Code plugin marketplace manifests",
+  "type": "object",
+  "properties": {
+    "$schema": {
+      "type": "string",
+      "format": "uri"
+    },
+    "name": {
+      "type": "string",
+      "pattern": "^[a-z0-9-]+$",
+      "minLength": 1,
+      "description": "Marketplace name in kebab-case"
+    },
+    "owner": {
+      "type": "object",
+      "properties": {
+        "name": {
+          "type": "string",
+          "minLength": 1
+        }
+      },
+      "required": ["name"],
+      "additionalProperties": false
+    },
+    "version": {
+      "type": "string",
+      "pattern": "^\\d+\\.\\d+\\.\\d+(-[a-zA-Z0-9.-]+)?$",
+      "description": "Semver version string"
+    },
+    "description": {
+      "type": "string",
+      "minLength": 10,
+      "maxLength": 500,
+      "description": "Brief description of the marketplace"
+    },
+    "repository": {
+      "type": "object",
+      "properties": {
+        "type": {
+          "type": "string",
+          "enum": ["git"]
+        },
+        "url": {
+          "type": "string",
+          "format": "uri"
+        }
+      },
+      "required": ["type", "url"],
+      "additionalProperties": false
+    },
+    "plugins": {
+      "type": "array",
+      "minItems": 1,
+      "items": {
+        "type": "object",
+        "properties": {
+          "name": {
+            "type": "string",
+            "pattern": "^[a-z0-9-]+$",
+            "minLength": 1,
+            "description": "Plugin name in kebab-case"
+          },
+          "description": {
+            "type": "string",
+            "minLength": 10,
+            "maxLength": 500
+          },
+          "source": {
+            "type": "string",
+            "pattern": "^\\./",
+            "description": "Relative path to plugin directory, must start with ./"
+          },
+          "tags": {
+            "type": "array",
+            "items": {
+              "type": "string",
+              "pattern": "^[a-z0-9-]+$"
+            },
+            "minItems": 1,
+            "uniqueItems": true
+          }
+        },
+        "required": ["name", "description", "source", "tags"],
+        "additionalProperties": false
+      }
+    },
+    "maintainers": {
+      "type": "array",
+      "minItems": 1,
+      "items": {
+        "type": "object",
+        "properties": {
+          "name": {
+            "type": "string",
+            "minLength": 1
+          },
+          "email": {
+            "type": "string",
+            "format": "email"
+          }
+        },
+        "required": ["name"],
+        "additionalProperties": false
+      }
+    },
+    "license": {
+      "type": "string",
+      "minLength": 1,
+      "description": "SPDX license identifier or custom license name"
+    }
+  },
+  "required": [
+    "name",
+    "owner",
+    "version",
+    "description",
+    "repository",
+    "plugins",
+    "license"
+  ],
+  "additionalProperties": false
+}

package/plugins/plugin.schema.json

@@ -0,0 +1,60 @@
+{
+  "$id": "plugin.schema.json",
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "title": "Claude Code Plugin Schema",
+  "description": "Schema for validating individual Claude Code plugin manifests",
+  "type": "object",
+  "properties": {
+    "name": {
+      "type": "string",
+      "pattern": "^[a-z0-9-]+$",
+      "minLength": 1,
+      "description": "Plugin name in kebab-case, must match marketplace entry"
+    },
+    "version": {
+      "type": "string",
+      "pattern": "^\\d+\\.\\d+\\.\\d+(-[a-zA-Z0-9.-]+)?$",
+      "description": "Semver version string"
+    },
+    "description": {
+      "type": "string",
+      "minLength": 10,
+      "maxLength": 500,
+      "description": "Brief description of the plugin's capabilities"
+    },
+    "author": {
+      "type": "object",
+      "properties": {
+        "name": {
+          "type": "string",
+          "minLength": 1
+        },
+        "email": {
+          "type": "string",
+          "format": "email"
+        }
+      },
+      "required": ["name"],
+      "additionalProperties": false
+    },
+    "repository": {
+      "type": "string",
+      "format": "uri",
+      "description": "Repository URL as string"
+    },
+    "license": {
+      "type": "string",
+      "minLength": 1,
+      "description": "SPDX license identifier or custom license name"
+    }
+  },
+  "required": [
+    "name",
+    "version",
+    "description",
+    "author",
+    "repository",
+    "license"
+  ],
+  "additionalProperties": false
+}