satchel-adapter-sdk 1.2.0__tar.gz

satchel_adapter_sdk-1.2.0/.gitignore

@@ -0,0 +1,33 @@
+# Python
+__pycache__/
+*.py[cod]
+.venv/
+venv/
+.env
+.env.*
+!.env.example
+*.egg-info/
+dist/
+build/
+.pytest_cache/
+.mypy_cache/
+.ruff_cache/
+.coverage
+htmlcov/
+
+# Node
+node_modules/
+.next/
+*.log
+
+# Local data
+.satchel/
+*.duckdb
+*.parquet
+
+# OS / editors
+.DS_Store
+.idea/
+.vscode/
+
+# Private design docs (kept local, not pushed)

satchel_adapter_sdk-1.2.0/LICENSE

@@ -0,0 +1,202 @@
+
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

satchel_adapter_sdk-1.2.0/PKG-INFO

@@ -0,0 +1,111 @@
+Metadata-Version: 2.5
+Name: satchel-adapter-sdk
+Version: 1.2.0
+Summary: SDK for writing satchel source adapters: the canonical IR, the adapter protocol and a conformance kit
+License: Apache-2.0
+License-File: LICENSE
+Requires-Python: >=3.12
+Requires-Dist: pydantic>=2
+Requires-Dist: pyyaml
+Description-Content-Type: text/markdown
+
+# satchel-adapter-sdk
+
+The small public contract for Satchel **source adapters**: packages that read an upstream tool's
+metadata (dbt, Cube, SQLMesh, ...) and describe it in Satchel's canonical IR. The Satchel server turns
+that IR into ordinary context items, keeps them in sync, and never lets a sync overwrite what
+analysts added on top.
+
+This distribution depends on `pydantic` and `pyyaml` only. It has no web framework, ORM or
+database driver; an adapter must not need them either.
+
+```python
+from satchel_adapter_sdk import AdapterInfo, SourceAdapter, SourceFiles, SourceSnapshot
+```
+
+## What you write
+
+An adapter is an object with an `info: AdapterInfo` manifest and a pure `load` method:
+
+```python
+class MyAdapter:
+    info = AdapterInfo(kind="mytool", display_name="My tool", version="0.1.0",
+                       maturity="experimental", capabilities=frozenset({"assets"}),
+                       config_model=MyConfig, file_inputs=(FileInput(name="export", required=True),))
+
+    def load(self, config: MyConfig, files: SourceFiles) -> SourceSnapshot: ...
+
+adapter = MyAdapter()
+```
+
+Register it under the `satchel.sources` entry-point group in your `pyproject.toml`:
+
+```toml
+[project.entry-points."satchel.sources"]
+mytool = "satchel_source_mytool:adapter"
+```
+
+`pip install satchel-source-mytool` is then enough; `satchel source list` shows it as *external*.
+Start from [`templates/adapter/`](../templates/adapter) and read
+[`docs/adapters/writing-an-adapter.md`](../docs/adapters/writing-an-adapter.md).
+
+### Rules
+
+* **Pure.** `load(config, files)` is deterministic and does no database access. It does no network
+  access either, unless you declare the `network` capability. The host reads the input files
+  (named by `AdapterInfo.file_inputs`, a path in the config or an upload) and hands you bytes.
+* **No server imports.** Never import `satchel.*`, SQLAlchemy, a database driver or FastAPI. Built-in
+  adapters are held to the same rule by a test.
+* **Folders and optional dependencies.** `FileInput(multiple=True, extensions=...)` lets the path be a
+  folder (read it with `SourceFiles.group(name)`); `AdapterInfo.requires` names the optional modules
+  an adapter imports lazily, so the host can list it as unavailable with an install hint.
+* **Normalised names.** Emit `schema.table` fqns in lower case (`normalise_fqn`). Put the database
+  in `SourceAsset.database`.
+* **Warnings, not failures.** A construct you cannot map goes into `SourceSnapshot.warnings`;
+  one bad node must not fail the sync.
+* **Trust.** Installed adapters run in the Satchel process as trusted code. Install only adapters you
+  would run on the server.
+
+## IR versioning
+
+`satchel_adapter_sdk.IR_VERSION` is a semantic version carried by every snapshot.
+
+| Change                                              | Bump  |
+|-----------------------------------------------------|-------|
+| New optional field, new optional model, new capability | minor |
+| Removed or renamed field, changed meaning, new required field | major |
+
+The server accepts a snapshot whose **major** equals its own SDK's major and refuses others with a
+clear message. Within a major, the server ignores nothing it does not understand and requires
+nothing new, so an adapter written against `1.0.0` keeps working on every `1.x`.
+
+## Conformance kit
+
+```python
+from satchel_adapter_sdk.testing import assert_conformant
+
+def test_conformance(update_golden):
+    assert_conformant(adapter, MyConfig(export="..."), files,
+                      golden=Path(__file__).parent / "golden" / "snapshot.json",
+                      update_golden=update_golden)
+```
+
+It checks the manifest, that the snapshot validates and round-trips, the IR version, determinism
+(two loads equal), a stable fingerprint, normalised fqns and unique keys, valid MDL, declared
+capabilities, no network (unless declared) and no server imports, and compares the snapshot to a
+committed golden file. Add `pytest_plugins = ["satchel_adapter_sdk.pytest_plugin"]` to your
+`conftest.py` for the `--update-golden` flag (or set `SATCHEL_UPDATE_GOLDEN=1`).
+
+## Wren MDL
+
+If your tool has governed metrics, build a Wren MDL manifest with `MdlBuilder` (models over
+warehouse tables plus *cubes* of measures and dimensions) and return it in a
+`SourceSemanticModel`. Satchel serves it through `query_metrics`.
+
+## Develop
+
+```bash
+cd sdk && uv sync && uv run pytest -q && uv run ruff check . && uv run mypy satchel_adapter_sdk
+```
+
+Licence: Apache-2.0.

satchel_adapter_sdk-1.2.0/README.md

@@ -0,0 +1,100 @@
+# satchel-adapter-sdk
+
+The small public contract for Satchel **source adapters**: packages that read an upstream tool's
+metadata (dbt, Cube, SQLMesh, ...) and describe it in Satchel's canonical IR. The Satchel server turns
+that IR into ordinary context items, keeps them in sync, and never lets a sync overwrite what
+analysts added on top.
+
+This distribution depends on `pydantic` and `pyyaml` only. It has no web framework, ORM or
+database driver; an adapter must not need them either.
+
+```python
+from satchel_adapter_sdk import AdapterInfo, SourceAdapter, SourceFiles, SourceSnapshot
+```
+
+## What you write
+
+An adapter is an object with an `info: AdapterInfo` manifest and a pure `load` method:
+
+```python
+class MyAdapter:
+    info = AdapterInfo(kind="mytool", display_name="My tool", version="0.1.0",
+                       maturity="experimental", capabilities=frozenset({"assets"}),
+                       config_model=MyConfig, file_inputs=(FileInput(name="export", required=True),))
+
+    def load(self, config: MyConfig, files: SourceFiles) -> SourceSnapshot: ...
+
+adapter = MyAdapter()
+```
+
+Register it under the `satchel.sources` entry-point group in your `pyproject.toml`:
+
+```toml
+[project.entry-points."satchel.sources"]
+mytool = "satchel_source_mytool:adapter"
+```
+
+`pip install satchel-source-mytool` is then enough; `satchel source list` shows it as *external*.
+Start from [`templates/adapter/`](../templates/adapter) and read
+[`docs/adapters/writing-an-adapter.md`](../docs/adapters/writing-an-adapter.md).
+
+### Rules
+
+* **Pure.** `load(config, files)` is deterministic and does no database access. It does no network
+  access either, unless you declare the `network` capability. The host reads the input files
+  (named by `AdapterInfo.file_inputs`, a path in the config or an upload) and hands you bytes.
+* **No server imports.** Never import `satchel.*`, SQLAlchemy, a database driver or FastAPI. Built-in
+  adapters are held to the same rule by a test.
+* **Folders and optional dependencies.** `FileInput(multiple=True, extensions=...)` lets the path be a
+  folder (read it with `SourceFiles.group(name)`); `AdapterInfo.requires` names the optional modules
+  an adapter imports lazily, so the host can list it as unavailable with an install hint.
+* **Normalised names.** Emit `schema.table` fqns in lower case (`normalise_fqn`). Put the database
+  in `SourceAsset.database`.
+* **Warnings, not failures.** A construct you cannot map goes into `SourceSnapshot.warnings`;
+  one bad node must not fail the sync.
+* **Trust.** Installed adapters run in the Satchel process as trusted code. Install only adapters you
+  would run on the server.
+
+## IR versioning
+
+`satchel_adapter_sdk.IR_VERSION` is a semantic version carried by every snapshot.
+
+| Change                                              | Bump  |
+|-----------------------------------------------------|-------|
+| New optional field, new optional model, new capability | minor |
+| Removed or renamed field, changed meaning, new required field | major |
+
+The server accepts a snapshot whose **major** equals its own SDK's major and refuses others with a
+clear message. Within a major, the server ignores nothing it does not understand and requires
+nothing new, so an adapter written against `1.0.0` keeps working on every `1.x`.
+
+## Conformance kit
+
+```python
+from satchel_adapter_sdk.testing import assert_conformant
+
+def test_conformance(update_golden):
+    assert_conformant(adapter, MyConfig(export="..."), files,
+                      golden=Path(__file__).parent / "golden" / "snapshot.json",
+                      update_golden=update_golden)
+```
+
+It checks the manifest, that the snapshot validates and round-trips, the IR version, determinism
+(two loads equal), a stable fingerprint, normalised fqns and unique keys, valid MDL, declared
+capabilities, no network (unless declared) and no server imports, and compares the snapshot to a
+committed golden file. Add `pytest_plugins = ["satchel_adapter_sdk.pytest_plugin"]` to your
+`conftest.py` for the `--update-golden` flag (or set `SATCHEL_UPDATE_GOLDEN=1`).
+
+## Wren MDL
+
+If your tool has governed metrics, build a Wren MDL manifest with `MdlBuilder` (models over
+warehouse tables plus *cubes* of measures and dimensions) and return it in a
+`SourceSemanticModel`. Satchel serves it through `query_metrics`.
+
+## Develop
+
+```bash
+cd sdk && uv sync && uv run pytest -q && uv run ruff check . && uv run mypy satchel_adapter_sdk
+```
+
+Licence: Apache-2.0.

satchel_adapter_sdk-1.2.0/pyproject.toml

@@ -0,0 +1,40 @@
+[project]
+name = "satchel-adapter-sdk"
+version = "1.2.0"
+description = "SDK for writing satchel source adapters: the canonical IR, the adapter protocol and a conformance kit"
+readme = "README.md"
+requires-python = ">=3.12"
+license = { text = "Apache-2.0" }
+dependencies = ["pydantic>=2", "pyyaml"]
+
+[dependency-groups]
+dev = ["pytest", "ruff", "mypy", "types-pyyaml"]
+
+[build-system]
+requires = ["hatchling"]
+build-backend = "hatchling.build"
+
+[tool.hatch.build.targets.wheel]
+packages = ["satchel_adapter_sdk"]
+
+[tool.ruff]
+line-length = 100
+target-version = "py312"
+
+[tool.ruff.lint]
+select = ["E", "F", "I", "UP", "B", "SIM"]
+
+[tool.ruff.lint.per-file-ignores]
+"sdk_tests/*.py" = ["E501"]
+
+[tool.mypy]
+python_version = "3.12"
+plugins = ["pydantic.mypy"]
+strict = true
+
+[tool.pytest.ini_options]
+testpaths = ["sdk_tests"]
+
+[tool.uv]
+# Rebuild the (non-editable) server install of this package when its sources change.
+cache-keys = [{ file = "pyproject.toml" }, { file = "satchel_adapter_sdk/**/*.py" }]

satchel_adapter_sdk-1.2.0/satchel_adapter_sdk/__init__.py

@@ -0,0 +1,53 @@
+"""satchel-adapter-sdk: everything needed to write a satchel source adapter.
+
+    from satchel_adapter_sdk import AdapterInfo, SourceAdapter, SourceFiles, SourceSnapshot
+"""
+
+from satchel_adapter_sdk.adapter import (
+    KIND_PATTERN,
+    AdapterInfo,
+    Capability,
+    FileInput,
+    Maturity,
+    SourceAdapter,
+    SourceFiles,
+)
+from satchel_adapter_sdk.ir import (
+    IR_VERSION,
+    SourceAsset,
+    SourceColumn,
+    SourceQuery,
+    SourceRelationship,
+    SourceSemanticModel,
+    SourceSnapshot,
+    SourceTerm,
+    SourceWarning,
+    fingerprint_bytes,
+    is_compatible,
+    normalise_fqn,
+)
+from satchel_adapter_sdk.mdl import MdlBuilder, validate_mdl
+
+__all__ = [
+    "IR_VERSION",
+    "KIND_PATTERN",
+    "AdapterInfo",
+    "Capability",
+    "FileInput",
+    "Maturity",
+    "MdlBuilder",
+    "SourceAdapter",
+    "SourceAsset",
+    "SourceColumn",
+    "SourceFiles",
+    "SourceQuery",
+    "SourceRelationship",
+    "SourceSemanticModel",
+    "SourceSnapshot",
+    "SourceTerm",
+    "SourceWarning",
+    "fingerprint_bytes",
+    "is_compatible",
+    "normalise_fqn",
+    "validate_mdl",
+]

satchel_adapter_sdk-1.2.0/satchel_adapter_sdk/adapter.py

@@ -0,0 +1,125 @@
+"""The adapter contract: what an adapter package must provide."""
+
+from __future__ import annotations
+
+import hashlib
+import json
+from collections.abc import Iterable, Mapping
+from pathlib import Path
+from typing import Any, Literal, Protocol, runtime_checkable
+
+from pydantic import BaseModel, ConfigDict, Field
+
+from satchel_adapter_sdk.ir import SourceSnapshot
+
+Maturity = Literal["experimental", "beta", "stable"]
+Capability = Literal["assets", "semantic", "queries", "glossary", "lineage", "network"]
+KIND_PATTERN = r"^[a-z][a-z0-9_]{1,31}$"
+
+
+class FileInput(BaseModel):
+    """A file the adapter reads. The host loads it (from the path in ``config[name]`` or an
+    upload) so the adapter itself never opens files or sockets."""
+
+    name: str
+    description: str = ""
+    required: bool = False
+    multiple: bool = Field(
+        default=False,
+        description="The path may be a file or a folder (a Cube data model, a SQLMesh project). "
+        "The host reads every matching file under it and hands them over as "
+        "'<name>/<relative path>'; read them with SourceFiles.group(name).",
+    )
+    extensions: tuple[str, ...] = Field(
+        default=(),
+        description="With multiple: only read files with these lower-case suffixes, e.g. "
+        "('.yml', '.yaml'). Empty means every file.",
+    )
+
+
+class AdapterInfo(BaseModel):
+    """The adapter's manifest. Its ``config_model`` JSON schema drives the CLI flags of
+    ``satchel source add`` and the UI form."""
+
+    model_config = ConfigDict(arbitrary_types_allowed=True)
+
+    kind: str = Field(pattern=KIND_PATTERN)
+    display_name: str
+    version: str
+    maturity: Maturity = "experimental"
+    capabilities: frozenset[Capability]
+    config_model: type[BaseModel]
+    file_inputs: tuple[FileInput, ...] = ()
+    extras: tuple[str, ...] = Field(
+        default=(), description="pip extras the adapter needs, e.g. ('cube',)"
+    )
+    requires: tuple[str, ...] = Field(
+        default=(),
+        description="Importable top-level modules the adapter needs at load time (an optional "
+        "dependency). When one is missing the host lists the adapter as unavailable with an "
+        "install hint instead of failing; import them lazily inside load().",
+    )
+    description: str = ""
+    homepage: str | None = None
+
+    def config_schema(self) -> dict[str, Any]:
+        return self.config_model.model_json_schema()
+
+
+class SourceFiles:
+    """Named input files, as bytes. Built by the host; adapters only read."""
+
+    def __init__(self, data: Mapping[str, bytes] | None = None) -> None:
+        self._data = dict(data or {})
+
+    @classmethod
+    def from_paths(cls, paths: Mapping[str, str | Path | None]) -> SourceFiles:
+        return cls({n: Path(p).read_bytes() for n, p in paths.items() if p})
+
+    def has(self, name: str) -> bool:
+        return name in self._data
+
+    def names(self) -> list[str]:
+        return sorted(self._data)
+
+    def read(self, name: str) -> bytes:
+        try:
+            return self._data[name]
+        except KeyError:
+            raise FileNotFoundError(f"input file {name!r} was not provided") from None
+
+    def read_text(self, name: str) -> str:
+        return self.read(name).decode("utf-8")
+
+    def read_json(self, name: str) -> Any:
+        return json.loads(self.read(name))
+
+    def group(self, name: str) -> dict[str, bytes]:
+        """The files of a ``FileInput(multiple=True)``: ``{relative path: bytes}``, sorted by
+        path. A plain file stored under exactly ``name`` is returned as ``{name: bytes}``."""
+        prefix = f"{name}/"
+        out = {k[len(prefix):]: v for k, v in self._data.items() if k.startswith(prefix)}
+        if name in self._data:
+            out[name] = self._data[name]
+        return dict(sorted(out.items()))
+
+    def has_group(self, name: str) -> bool:
+        return bool(self.group(name))
+
+    def fingerprint(self, names: Iterable[str] | None = None) -> str:
+        """sha256 over (name, bytes) of the given inputs (default: all), order independent."""
+        h = hashlib.sha256()
+        for n in sorted(names if names is not None else self._data):
+            if n in self._data:
+                h.update(n.encode() + b"\0" + hashlib.sha256(self._data[n]).digest())
+        return h.hexdigest()
+
+
+@runtime_checkable
+class SourceAdapter(Protocol):
+    """``load`` is pure: deterministic, no database, and no network unless the ``network``
+    capability is declared. Installed adapters run in-process as trusted code."""
+
+    info: AdapterInfo
+
+    def load(self, config: Any, files: SourceFiles) -> SourceSnapshot: ...