Plugin SDK v1

The public protocol helper files for plugin development are maintained in docs/public/plugin-sdk/ and published unchanged during the build, shared by all documentation languages. They provide editor assistance and external tool integration; they are not used for runtime plugin loading or CLI validation.

Files

• Manifest Schema: field assistance for plugin.json.
• plugin-v1.d.ts: type declarations for the JavaScript plugin API.

In an editor supporting JSON Schema, associate plugin.json with this schema URL:

https://res.putyy.com/plugin-sdk/plugin-v1.schema.json

For a JavaScript project, download plugin-v1.d.ts into your development directory and enable type hints through editor configuration or /// <reference path="./plugin-v1.d.ts" />. The runtime still executes plain JavaScript; no TypeScript build is required.

Plugin validation follows the Go backend's protocol models and validation logic. Before submitting, run from the res-downloader source root:

go run main.go plugin lint <plugin-directory>
go run main.go plugin replay <plugin-directory> <fixture-file>

When adding or changing the plugin protocol, update the Schema, type declarations, examples, fixtures, and developer guide together.

See Plugin Development and the operation contract for full interface documentation, and Plugin sources and reserved IDs for installation sources and reserved prefixes.