Ymerflow Plugin SDK (external repo)

The plugin SDK is not part of this repository. It lives in its own git repo and is consumed by this project (and by third-party plugin authors) as a published dependency.

Nothing in this repository depends on a local checkout of the SDK. All consumers resolve it by git URL (Python) or npm (JS). If you keep a working copy under deps/ for local development, that directory is gitignored and is not referenced by any build, test, or dependency here.

Two halves, one repo

Half In the SDK repo Distributed as What it does
Build harness ymerflow_plugin_build/ (repo root) + setup.py pip, via git URL Resolves an npm name@version (server-local dir and/or the public registry) and runs the real npm/vite Module-Federation build, with shared pinned to the host's singleton versions.
Authoring SDK js/ + package.json npm: ymerflow-plugin-sdk The registerHook / hooks / useHook shim (index.js) and the Vite federation preset (ymerflow-plugin-sdk/vite-preset, exporting ymerflowFederation).

The two halves emit the same Module-Federation shared block. The SDK repo's own tests/test_vite_preset_consistency.py asserts they never drift apart — that guard lives in the SDK repo because it needs both source trees on disk.

How this repo consumes it

Python (build harness). Declared as a git-URL dependency in the relevant setup.py files:

install_requires=[
    "ymerflow-plugin-build @ git+https://github.com/SagebrushGeoTools/Ymerflow-plugin-sdk.git",
]

Consumers: - root setup.py (so the backend env can import ymerflow_plugin_build; used by backend/services/job_orchestrator.py to read HOST_SHARED_VERSIONS). - tests/plugins/test-backend-plugin/setup.py (its build_py calls build_frontend at install time). - docker/base-runner/Dockerfile — pip install "git+https://…/Ymerflow-plugin-sdk.git". The repo is public, so https needs no build credentials; for a private repo use a BuildKit ssh mount or a token. The build_frontend_plugin process type then runs python -m ymerflow_plugin_build in-pod.

JavaScript (plugin authors). A plugin's package.json:

"devDependencies": { "ymerflow-plugin-sdk": "^1.0.0" }

import { registerHook } from 'ymerflow-plugin-sdk'
registerHook('widgets', () => [{ name: 'MyWidget', component: MyWidget }])

See the Plugin Author Guide (in the ymerflow-plugin-sdk repo) for the full authoring walkthrough and the complete frontend/backend hook reference.

Host-contract names (intentionally NOT renamed)

The Nagelfluh→Ymerflow rename covered the SDK's package surface only. The runtime bridge and build markers shared between host, plugins, and the build pipeline keep their original spelling, on purpose — renaming them would break the running cluster and already-built plugins:

Releasing / pinning

The git-URL dependencies currently track the default branch. Once the SDK starts cutting tags, pin them (…Ymerflow-plugin-sdk.git@v0.2.0) in the setup.pys and the Dockerfile, and publish the npm half with npm publish from js/.