Skip to main content

Crate standard_plugin_manifest

Crate standard_plugin_manifest 

Source
Expand description

The standard-plugin.json manifest and the grant model of Standard Code plugin runtime v2 (standard:plugin@2.0.0).

One crate owns both so the viewer’s host (standard-plugin-host), the standard-plugin CLI and the SDK’s test host agree exactly on what a manifest may say and on what a grant covers.

Re-exports§

pub use grants::CATALOGUE;
pub use grants::GrantDenied;
pub use grants::GrantError;
pub use grants::GrantSpec;
pub use grants::Grants;
pub use grants::Subject;
pub use grants::is_high_risk;
pub use grants::review_order;
pub use manifest::COMMAND_TITLE_MAX_CHARS;
pub use manifest::CardBorder;
pub use manifest::CommandContext;
pub use manifest::CommandDecl;
pub use manifest::DaemonDecl;
pub use manifest::ENDPOINTS_MAX;
pub use manifest::EndpointDecl;
pub use manifest::FooterTab;
pub use manifest::GraphicsRequirement;
pub use manifest::MANIFEST_MAX_BYTES;
pub use manifest::MODULE_MAX_BYTES;
pub use manifest::Manifest;
pub use manifest::ManifestError;
pub use manifest::Model;
pub use manifest::Models;
pub use manifest::PANE_COMMAND_PATHS_MAX;
pub use manifest::PANE_COMMANDS_MAX;
pub use manifest::PaneCommandDecl;
pub use manifest::Placement;
pub use manifest::PluginKind;
pub use manifest::REASON_MAX_CHARS;
pub use manifest::RequiresDecl;
pub use manifest::SurfaceAnchor;
pub use manifest::SurfaceDecl;
pub use manifest::World;
pub use manifest::is_endpoint_env;
pub use manifest::is_identifier;
pub use manifest::is_pane_command_name;
pub use manifest::is_pane_command_path;

Modules§

config_schema
A plugin’s configuration schema: the manifest’s config field, a JSON Schema subset every tool agrees on. standard-plugin check refuses a schema outside it, the Plugins view renders its settings from it, and both halves of a plugin receive their configuration document with the schema’s defaults filled in.
copy_text
Limits for explicit user copies from a plugin surface.
github
GitHub Releases as a plugin source (the SDK’s docs/publishing.md, “GitHub Releases”): which release and which asset a github source means, and which plugins a repository publishes. Pure: whoever fetches the release list (a viewer, the CLI, or a daemon with GitHub access) hands it here.
grant_text
Grants in plain language: the line the install and approval screens show above the plugin’s own reason. The grant itself stays the authority; this only says what it lets the plugin do.
grants
Grants: the capabilities a manifest asks for and the user approved.
graphic
The checks of surface.set-graphic, the same for every host: a graphic is a picture over cells of a cells surface (wit/plugin.wit).
local
A plugin a machine has on disk (a file source): a built plugin directory or a packed .tar, read with the same bounds as a download (the SDK’s docs/publishing.md, “Limits”), and the verification every package passes before it is uploaded.
manifest
standard-plugin.json: what a bundle declares.
package
Account bundles: the tarball the account plugin store keeps, identified by the SHA-256 of its bytes (agents/lib/product-plugins/README.md in the API repository).
pane_create
Bounded viewer pane-create requests, shared by native and browser hosts.
paths
Paths as daemon plugins name them: what a path grant covers (fs.read:<path>, fs.write:<path>, machine.full) and which changes a watch’s exclude globs drop. The host and the SDK’s test host share this code, so a test sees exactly the host’s answers.
slow
The slow-plugin policy (owner decision, docs/plugin-runtime.md): a plugin whose pixel surface keeps overrunning its frame() budget is degraded step by step before it is paused or restarted. The native host and the browser host apply the same rule through this type.
source
Where a plugin comes from (the SDK’s docs/publishing.md): one typed value parsed from what the user types, recorded on the account with the plugin so later versions can be looked up and installed the same way.
url
The URLs url.open accepts, as every host checks them: the native viewer, the browser viewer (again on the main thread) and the SDK’s test host.
version
Plugin versions as sources publish them: semantic versions (a leading v allowed, missing minor or patch read as zero), their order, and the npm-style ranges a source may name (1.2.3, ^1.2, ~1.2.3, 1.x, >=1.2.0, *). Anything that is not a range is a dist-tag or a tag.