pluginsdk/AGENTS.md
Alex Dunmow b6d40ed8ac feat: bootstrap block/pluginsdk — the proto-first plugin SDK (P1)
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>
2026-07-07 10:51:00 +08:00

1.8 KiB

Plugin SDK

Go module git.dev.alexdunmow.com/block/pluginsdk.

Purpose: this is the ONE plugin-facing artifact. BlockNinja CMS plugins import this module and nothing else from the internal Go tree. Plugins must NOT import block/core — core exists only for code shared between first-party entities (cms, orchestrator, ninja CLI).

The contract is proto, not Go

  • abi/proto/v1/*.proto is the contract. The host↔guest wire is proto-only; a plugin in ANY language generates its own bindings from these files.
  • abi/v1/ is the Go binding of that contract (abiv1). The rest of the Go surface here — plugin/, plugin/wasmguest/**, and the guest-facing type packages — is one language binding of the SDK. A non-Go plugin implements the ABI hooks directly and never sees these Go structs.

Critical Rules

  • NEVER use replace directives in go.mod — not here, not in any consumer. All 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. Change the API and update consumers.
  • Regenerate Go bindings after editing any .proto: make proto.

templates/bn/ is a synced copy — do not author here

The bn page chrome (head / toolbar / engagement / asset_hooks) is authored in cms/backend/templates/bn and mechanically copied here via cms make sync-templates, solely so guest-side plugin templates can compile it into their wasm. check-safety check 31 fails cms commits while the copies drift. Never edit these files here directly — change them in cms and sync. (This chrome is transitional: it is deleted once host-side head/body injection lands — Phase 3.)

Design

Program spec (in the cms repo): docs/superpowers/specs/2026-07-07-proto-first-plugin-sdk-design.md.