@agentpulselabs/platform-sdk
v0.1.0
Published
Thin, PUBLIC host SDK for AgentPulse feature apps — the Platform.* type contract (generated from platform/appHost.js JSDoc) + the §11A promote-list re-exports. The REAL Platform instance is injected at runtime by the host (register(Platform)); this packag
Readme
@agentpulselabs/platform-sdk
The thin, public AgentPulse platform SDK for feature apps.
This package ships types only + pure forwarding re-exports — it contains no platform runtime implementation. It is:
index.d.ts— thePlatform.*type contract (generated fromplatform/appHost.js's JSDoc) that describes the object every app'sregister(Platform)receives at boot.index.js— a handful of pureexport { X } from '@agentpulse/platform/...'re-exports (the §11A promote-list): base classes / capabilities / route-middleware / helpers apps call directly, so an app never has to deep-import@agentpulse/platform/<internal-path>itself.
How apps consume it
{
"peerDependencies": { "@agentpulselabs/platform-sdk": "^0" },
"devDependencies": { "@agentpulselabs/platform-sdk": "^0" }
}- peerDependency — the real
Platforminstance is host-provided: the AgentPulse platform injects it at runtime viaregister(Platform). Nothing in this package is bundled into an app; installing it only gets you types + the thin re-export shims. - devDependency — for IDE autocomplete / type-checking during local development. Apps never run the platform locally (local = tools; the runtime is the hosted dev-org/staging/prod platform).
import { JobHandler, requireScope, decorateActors } from '@agentpulselabs/platform-sdk';What this is NOT
- Not a runtime. The underlying
@agentpulse/platformpackage that backs every re-export here is host-provided and never published — it is not a dependency an app installs to get working code; the host supplies the implementation at boot. - Not a bundle of platform internals. Only the deliberate §11A promote-list surface is re-exported
(see
scripts/lib/appHostSurface.mjsPROMOTE_LISTin the platform monorepo) — a small, reviewed set of symbols apps legitimately call, not the whole@agentpulse/platformtree.
Regenerate with npm run sdk:generate:app-sdk from the platform monorepo; see
docs/DESIGN_app-sdk-thin-package.md there for the full design.
