unaltraweb 0.3.0

data/src/unaltraweb_mcp/component-contract.json

@@ -0,0 +1,153 @@
+{
+  "$schema": "component-contract.schema.json",
+  "schema_version": 1,
+  "release": {
+    "version": "0.3.0",
+    "tag": "v0.3.0"
+  },
+  "consumer_integration": {
+    "schema_version": 1,
+    "core_repository": "https://github.com/dosquartsdedocs/unaltraweb.git",
+    "core_sha": "c54400927e7223e14e34390ab039ed94b2e974ad",
+    "site_deploy_workflow": "dosquartsdedocs/unaltraweb/.github/workflows/site-deploy.yml",
+    "manual_pdf_image": "ghcr.io/dosquartsdedocs/unaltraweb-manual-pdf@sha256:48a7e17a85d205e4a890b7b7de18c9015eb657c9c12ba10f7cff123ac2b80660",
+    "vegavisuals_sha": "44a2753ffbb7c0694a459db9744342f69c6e78b9"
+  },
+  "receipt_contract": {
+    "schema_version": 1,
+    "path_template": ".unaltraweb/receipts/{provider}.json",
+    "hash_algorithm": "sha256",
+    "input_inventory": "exact",
+    "vegavisuals_dependencies": ["manifest.inputs", "visualizations[].inputs", "spec.data.url"],
+    "diavisuals_dependencies": [],
+    "local_dependency_policy": "project-relative-static-only",
+    "unverifiable_dependency_policy": "error"
+  },
+  "wheel_contract": {
+    "package": "unaltraweb-mcp",
+    "role": "Modular control, scaffolding, and offline inspection plane for unaltraweb sites.",
+    "package_only_commands": ["doctor", "import-calibre", "new-web", "version"],
+    "factory_required_commands": ["factory-dir"],
+    "package_only_mcp": ["bibliography-add-entry", "bibliography-inventory", "build-health", "content-approval-inventory", "content-freshness-check", "content-inventory", "detect-site", "html-audit", "http-check", "initialize-site", "language-policy", "list-tools", "manual-authoring-capabilities", "manual-editorial-quality-check", "manual-source-quality-check", "new-web", "preview-start", "preview-status", "preview-stop", "profile-check", "profile-prune", "profile-prune-plan", "scaffold-sync", "site-context", "site-doctor", "site-source-delete", "site-source-read", "site-source-write", "starter-templates", "translation-plan"],
+    "factory_required_mcp": ["bibliometrics-check", "bibliometrics-fetch-scimago", "bibliometrics-update", "build-site", "manual-computation-check", "manual-computation-render", "manual-computation-render-figures", "manual-computation-status", "manual-pdf-build", "manual-pdf-publish", "manual-pdf-status", "manual-release-check", "manual-release-prepare", "manual-release-status", "prompts", "serve", "site-check", "web-capture-check", "web-capture-render", "web-capture-status"],
+    "not_bundled": ["gem", "runtime", "mcp", "compute_python", "compute_r", "web_capture", "manual_pdf", "diavisuals", "vegavisuals"]
+  },
+  "components": {
+    "gem": {
+      "kind": "gem",
+      "name": "unaltraweb",
+      "version": "0.3.0",
+      "release": "v0.3.0",
+      "release_status": "ready",
+      "reference": "unaltraweb (= 0.3.0)",
+      "repository": "https://github.com/dosquartsdedocs/unaltraweb",
+      "included_in_wheel": false,
+      "features": ["jekyll-core", "site-build"]
+    },
+    "wheel": {
+      "kind": "python-wheel",
+      "name": "unaltraweb-mcp",
+      "version": "0.3.0",
+      "release": "v0.3.0",
+      "release_status": "ready",
+      "reference": "unaltraweb-mcp==0.3.0",
+      "repository": "https://github.com/dosquartsdedocs/unaltraweb",
+      "included_in_wheel": true,
+      "features": ["calibre-import", "doctor", "new-web", "offline-inspection", "mcp-control-plane"]
+    },
+    "runtime": {
+      "kind": "container",
+      "name": "unaltraweb runtime",
+      "version": "0.3.0",
+      "release": "v0.3.0",
+      "release_status": "ready",
+      "reference": "ghcr.io/dosquartsdedocs/unaltraweb:0.3.0",
+      "image_repository": "ghcr.io/dosquartsdedocs/unaltraweb",
+      "repository": "https://github.com/dosquartsdedocs/unaltraweb",
+      "included_in_wheel": false,
+      "features": ["jekyll-runtime"]
+    },
+    "mcp": {
+      "kind": "container",
+      "name": "unaltraweb MCP runtime",
+      "version": "0.3.0",
+      "release": "v0.3.0",
+      "release_status": "ready",
+      "reference": "ghcr.io/dosquartsdedocs/unaltraweb-mcp:0.3.0",
+      "image_repository": "ghcr.io/dosquartsdedocs/unaltraweb-mcp",
+      "repository": "https://github.com/dosquartsdedocs/unaltraweb",
+      "included_in_wheel": false,
+      "features": ["mcp", "consumer-build", "preview"]
+    },
+    "compute_python": {
+      "kind": "container",
+      "name": "unaltraweb Python computation worker",
+      "version": "0.3.0",
+      "release": "v0.3.0",
+      "release_status": "released",
+      "reference": "ghcr.io/dosquartsdedocs/unaltraweb-compute-python@sha256:18cb269811bd4005800382da25a480ec2bca7eac8d0501ad1ef36bad1c0f8cd9",
+      "image_repository": "ghcr.io/dosquartsdedocs/unaltraweb-compute-python",
+      "repository": "https://github.com/dosquartsdedocs/unaltraweb",
+      "included_in_wheel": false,
+      "features": ["manual-computations", "python"]
+    },
+    "compute_r": {
+      "kind": "container",
+      "name": "unaltraweb R computation worker",
+      "version": "0.3.0",
+      "release": "v0.3.0",
+      "release_status": "released",
+      "reference": "ghcr.io/dosquartsdedocs/unaltraweb-compute-r@sha256:928ffb93f221e09e8b929157dee473b838e061915a2eb67224e4124b85f81837",
+      "image_repository": "ghcr.io/dosquartsdedocs/unaltraweb-compute-r",
+      "repository": "https://github.com/dosquartsdedocs/unaltraweb",
+      "included_in_wheel": false,
+      "features": ["manual-computations", "r"]
+    },
+    "web_capture": {
+      "kind": "container",
+      "name": "unaltraweb web capture worker",
+      "version": "0.3.0",
+      "release": "v0.3.0",
+      "release_status": "ready",
+      "reference": "ghcr.io/dosquartsdedocs/unaltraweb-web-capture:0.3.0",
+      "image_repository": "ghcr.io/dosquartsdedocs/unaltraweb-web-capture",
+      "repository": "https://github.com/dosquartsdedocs/unaltraweb",
+      "included_in_wheel": false,
+      "features": ["web-captures"]
+    },
+    "manual_pdf": {
+      "kind": "container",
+      "name": "unaltraweb manual PDF worker",
+      "version": "0.3.0",
+      "release": "v0.3.0",
+      "release_status": "ready",
+      "reference": "ghcr.io/dosquartsdedocs/unaltraweb-manual-pdf:0.3.0",
+      "image_repository": "ghcr.io/dosquartsdedocs/unaltraweb-manual-pdf",
+      "repository": "https://github.com/dosquartsdedocs/unaltraweb",
+      "included_in_wheel": false,
+      "features": ["manual-pdf"]
+    },
+    "diavisuals": {
+      "kind": "companion",
+      "name": "diavisuals",
+      "version": "0.3.1",
+      "release": "v0.3.1",
+      "release_status": "released",
+      "reference": "https://github.com/dosquartsdedocs/diavisuals.git@v0.3.1",
+      "repository": "https://github.com/dosquartsdedocs/diavisuals",
+      "included_in_wheel": false,
+      "features": ["mermaid", "plantuml"]
+    },
+    "vegavisuals": {
+      "kind": "companion",
+      "name": "vegavisuals",
+      "version": "0.3.1",
+      "release": "v0.3.1",
+      "release_status": "released",
+      "reference": "https://github.com/dosquartsdedocs/vegavisuals.git@v0.3.1",
+      "repository": "https://github.com/dosquartsdedocs/vegavisuals",
+      "included_in_wheel": false,
+      "features": ["vega", "vega-lite"]
+    }
+  }
+}

data/src/unaltraweb_mcp/component-contract.schema.json

@@ -0,0 +1,87 @@
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "$id": "https://dosquartsdedocs.github.io/unaltraweb/schemas/component-contract-v1.schema.json",
+  "title": "unaltraweb component contract",
+  "type": "object",
+  "additionalProperties": false,
+  "required": ["schema_version", "release", "consumer_integration", "receipt_contract", "wheel_contract", "components"],
+  "properties": {
+    "$schema": {"type": "string"},
+    "schema_version": {"const": 1},
+    "release": {
+      "type": "object",
+      "additionalProperties": false,
+      "required": ["version", "tag"],
+      "properties": {
+        "version": {"type": "string", "pattern": "^[0-9]+\\.[0-9]+\\.[0-9]+$"},
+        "tag": {"type": "string", "pattern": "^v[0-9]+\\.[0-9]+\\.[0-9]+$"}
+      }
+    },
+    "consumer_integration": {
+      "type": "object",
+      "additionalProperties": false,
+      "required": ["schema_version", "core_repository", "core_sha", "site_deploy_workflow", "manual_pdf_image", "vegavisuals_sha"],
+      "properties": {
+        "schema_version": {"const": 1},
+        "core_repository": {"const": "https://github.com/dosquartsdedocs/unaltraweb.git"},
+        "core_sha": {"type": "string", "minLength": 40, "maxLength": 40, "pattern": "^[0-9a-f]{40}$"},
+        "site_deploy_workflow": {"const": "dosquartsdedocs/unaltraweb/.github/workflows/site-deploy.yml"},
+        "manual_pdf_image": {"type": "string", "minLength": 117, "maxLength": 117, "pattern": "^ghcr\\.io/dosquartsdedocs/unaltraweb-manual-pdf@sha256:[0-9a-f]{64}$"},
+        "vegavisuals_sha": {"type": "string", "minLength": 40, "maxLength": 40, "pattern": "^[0-9a-f]{40}$"}
+      }
+    },
+    "receipt_contract": {
+      "type": "object",
+      "additionalProperties": false,
+      "required": ["schema_version", "path_template", "hash_algorithm", "input_inventory", "vegavisuals_dependencies", "diavisuals_dependencies", "local_dependency_policy", "unverifiable_dependency_policy"],
+      "properties": {
+        "schema_version": {"const": 1},
+        "path_template": {"const": ".unaltraweb/receipts/{provider}.json"},
+        "hash_algorithm": {"const": "sha256"},
+        "input_inventory": {"const": "exact"},
+        "vegavisuals_dependencies": {"const": ["manifest.inputs", "visualizations[].inputs", "spec.data.url"]},
+        "diavisuals_dependencies": {"const": []},
+        "local_dependency_policy": {"const": "project-relative-static-only"},
+        "unverifiable_dependency_policy": {"const": "error"}
+      }
+    },
+    "wheel_contract": {
+      "type": "object",
+      "additionalProperties": false,
+      "required": ["package", "role", "package_only_commands", "factory_required_commands", "package_only_mcp", "factory_required_mcp", "not_bundled"],
+      "properties": {
+        "package": {"const": "unaltraweb-mcp"},
+        "role": {"type": "string"},
+        "package_only_commands": {"type": "array", "items": {"type": "string"}, "uniqueItems": true},
+        "factory_required_commands": {"type": "array", "items": {"type": "string"}, "uniqueItems": true},
+        "package_only_mcp": {"type": "array", "items": {"type": "string"}, "uniqueItems": true},
+        "factory_required_mcp": {"type": "array", "items": {"type": "string"}, "uniqueItems": true},
+        "not_bundled": {"type": "array", "items": {"type": "string"}, "uniqueItems": true}
+      }
+    },
+    "components": {
+      "type": "object",
+      "required": ["gem", "wheel", "runtime", "mcp", "compute_python", "compute_r", "web_capture", "manual_pdf", "diavisuals", "vegavisuals"],
+      "additionalProperties": {"$ref": "#/$defs/component"}
+    }
+  },
+  "$defs": {
+    "component": {
+      "type": "object",
+      "additionalProperties": false,
+      "required": ["kind", "name", "version", "release", "release_status", "reference", "repository", "included_in_wheel", "features"],
+      "properties": {
+        "kind": {"enum": ["gem", "python-wheel", "container", "companion"]},
+        "name": {"type": "string"},
+        "version": {"type": "string", "pattern": "^[0-9]+\\.[0-9]+\\.[0-9]+$"},
+        "release": {"type": "string", "pattern": "^v[0-9]+\\.[0-9]+\\.[0-9]+$"},
+        "release_status": {"enum": ["released", "ready", "pending", "unavailable"]},
+        "reference": {"type": "string"},
+        "image_repository": {"type": "string", "pattern": "^ghcr\\.io/dosquartsdedocs/[a-z0-9._-]+$"},
+        "repository": {"type": "string", "pattern": "^https://"},
+        "included_in_wheel": {"type": "boolean"},
+        "features": {"type": "array", "items": {"type": "string"}, "uniqueItems": true}
+      }
+    }
+  }
+}

data/src/unaltraweb_mcp/docker_mount.py

@@ -0,0 +1,19 @@
+from __future__ import annotations
+
+import os
+from pathlib import Path
+
+
+def docker_bind_mount(source: str | os.PathLike[str], target: str | os.PathLike[str], *, readonly: bool = False) -> str:
+    source_value = os.fspath(source)
+    target_value = os.fspath(target)
+    if not Path(source_value).is_absolute() or not Path(target_value).is_absolute():
+        raise ValueError("Docker bind source and target must be absolute paths")
+    if any(character in value for value in (source_value, target_value) for character in "\r\n"):
+        raise ValueError("Docker bind source and target must not contain carriage returns or newlines")
+
+    def csv_field(value: str) -> str:
+        return f'"{value.replace(chr(34), chr(34) * 2)}"'
+
+    mount = f"type=bind,{csv_field(f'source={source_value}')},{csv_field(f'target={target_value}')}"
+    return f"{mount},readonly" if readonly else mount