@voltius/plugin-types

TypeScript definitions for the Voltius plugin API.

npm install --save-dev @voltius/plugin-types

import type { PluginAPI } from "@voltius/plugin-types";

export default function register(api: PluginAPI): () => void {
  const dispose = api.ui.registerRightPanelSection({ /* ... */ });
  return () => dispose();
}

Types only — there is no runtime code. The host provides the implementation.

Versions track the app. @voltius/[email protected] describes the API in Voltius 0.14.1.

ui.d.ts declares the @voltius/ui module (the host components plugins may import). It is included automatically; you do not need to reference it.

Generated from src/plugins/api.ts — see developing plugins and the template repo.

Team connections

connections:read returns team-vault connections alongside personal ones. A team-owned entry is marked team: true and can be read, listed, and used to open a session exactly like a personal connection.

connections.update and connections.delete reject a team-owned connection — team objects are managed through the team vault, not the plugin API. Check team before offering an edit affordance, and expect the rejection if you do not.