Bring the root README up to date with the shipped runtime#36
Merged
Conversation
The root README still described the v0.5.x era; sync it with the runtime the plugins actually target (0.6.x–0.8.x, sandboxed since v0.6.0, Integration SDK v1). - Security / constraints: plugins run in a sandboxed worker thread (since v0.6.0) with host-gated capabilities and SSRF-guarded ctx.net.fetch — not "in-process with full Node privileges". The worker still has Node APIs, so "install trusted only" stands. - Capabilities table: add ctx.net, ctx.conversations, ctx.handover, ctx.mappings, and ctx.registerWebhook, plus the engine read additions getChatHistory (0.8.5+) and canonicalChatId (0.8.7+), and the net:fetch / conversation:send / webhook:ingress permission gates. - Manifest permissions comment: list all five enforced gates. - Compatibility: target range is 0.6.x–0.8.x (each plugin declares minOpenWAVersion), not 0.5.x. - Roadmap: drop "FAQ / auto-reply bot" (faq-bot shipped). - Status: "Early development" → "Active — a growing catalog".
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
What & why
The root README still described the v0.5.x plugin runtime; this syncs it with what the plugins actually target (0.6.x–0.8.x, sandboxed worker since v0.6.0, Integration SDK v1). Several claims had gone stale and one was actively wrong.
Changes
ctx.net.fetchhost-gated (SSRF guard). Worker still has Node APIs, so "install trusted only" stands.messages,engine,storage,loggerctx.net,ctx.conversations,ctx.handover,ctx.mappings,ctx.registerWebhook, plus the engine additionsgetChatHistory(0.8.5+) andcanonicalChatId(0.8.7+), and thenet:fetch/conversation:send/webhook:ingresspermission gates.minOpenWAVersion.faq-botshipped.Verification
npm run catalog:check— up to date (the generated catalog region is untouched).types/openwa.d.ts(the vendored contract).Notes
HookEventintypes/openwa.d.ts, so it's left as-is.minOpenWAVersionis still a convention OpenWA doesn't hard-enforce; that caveat is kept.