b6d40ed8ac
Bootstrap the plugin-facing SDK module so the fleet migration (P2) becomes a mechanical block/core/X -> block/pluginsdk/X import rewrite. - abi/proto/v1: the single source-of-truth ABI proto tree, copied from the cms authoring source (cms/backend/abi/proto/v1) with go_package retargeted to git.dev.alexdunmow.com/block/pluginsdk/abi/v1;abiv1. Kills the hand-kept cms/core proto duplication (audit gap 4). - abi/v1: generated Go bindings (buf generate); byte-identical to core's abi/v1 save the embedded go_package path. - plugin/ (registration + DI surface), plugin/wasmguest/** (transport shim, caps stubs, bnwasm db driver, testdata fixtures + golden .pb), and the guest-facing type packages: blocks (+builtin/shared/tags), templates (+pongo/bn), auth, settings, content, gating, crypto, rbac, video, ai, subscriptions, menus, datasources. Internal imports rewritten core -> pluginsdk; zero block/core references remain. - README/AGENTS(+CLAUDE symlink)/Makefile: proto is the contract, Go is one binding; no replace directives; templates/bn is a synced copy authored in cms. Spec: cms docs/superpowers/specs/2026-07-07-proto-first-plugin-sdk-design.md Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
47 lines
2.3 KiB
Markdown
47 lines
2.3 KiB
Markdown
# block/pluginsdk
|
|
|
|
The **plugin-facing SDK** for BlockNinja CMS plugins. Plugins import THIS module,
|
|
never `block/core`.
|
|
|
|
## What lives here
|
|
|
|
- **`abi/proto/v1/`** — THE single source-of-truth ABI proto tree for the wasm
|
|
plugin contract. The wire between host and guest is proto-only; any language
|
|
can generate its own bindings from these `.proto` files. (This tree used to be
|
|
duplicated by hand in `cms/backend/abi` and `core/abi`; it now lives here once.)
|
|
- **`abi/v1/`** — the generated Go bindings (`abiv1`). Regenerate with `make proto`.
|
|
- **`plugin/`** — the Go registration + DI surface (`PluginRegistration`,
|
|
`CoreServices`/`ServiceDeps`, block/template registries) and the minimal Go
|
|
wasm transport shim under `plugin/wasmguest/` (exports, dispatch, hostcalls,
|
|
context rehydration), its capability stubs (`plugin/wasmguest/caps/`), and the
|
|
`database/sql` driver over the host DB (`plugin/wasmguest/bnwasm/`).
|
|
- **Guest-facing type packages** plugins consume: `blocks/` (incl. `blocks/builtin`,
|
|
`blocks/shared`, `blocks/tags`), `templates/` (registry + `templates/pongo`),
|
|
`templates/bn/` (the templ chrome — see sync rule below), `auth/`, `settings/`,
|
|
`content/`, `gating/`, `crypto/`, `rbac/`, `video/`, `ai/`, `subscriptions/`,
|
|
`menus/`, `datasources/`.
|
|
|
|
The Go surface here is **one language binding**. The proto tree is the contract:
|
|
a non-Go plugin implements the ABI hooks directly and never sees the Go structs.
|
|
|
|
## `templates/bn` synced-copy rule
|
|
|
|
`templates/bn/*` is **authored in the cms repo** (`cms/backend/templates/bn`) and
|
|
**synced into here** via cms `make sync-templates`. Do not hand-edit the copy in
|
|
this repo — edit it in cms and re-sync. Drift is enforced by check-safety **check 31**
|
|
(`check-safety/check_templatesync.go`), which compares this repo's `templates/bn`
|
|
against the cms authoritative copy. (This chrome is transitional: it is deleted from
|
|
the SDK once host-side head/body injection lands — Phase 3.)
|
|
|
|
## Rules
|
|
|
|
- **NEVER use `replace` directives** in `go.mod`. Module resolution goes through the
|
|
Gitea module proxy — to test local changes, tag and push a version.
|
|
- All consumers are in-house — **no backwards-compatibility shims**.
|
|
- Plugins import `block/pluginsdk/...`, never `block/core/...`.
|
|
|
|
## Design
|
|
|
|
Program spec (in the cms repo):
|
|
`docs/superpowers/specs/2026-07-07-proto-first-plugin-sdk-design.md`.
|