@omniscribe/plugin-api

@omniscribe/plugin-api

Plugin API contracts for Omniscribe. This package defines the interfaces, types, and base classes that plugins implement to integrate with the Omniscribe platform.

Zero runtime dependencies. Pure TypeScript types and thin abstract classes.

Classes

Class	Description
BaseFrontendPlugin	Frontend plugin interface for UI contributions.
BaseFullPlugin	Frontend plugin interface for UI contributions.
BaseProviderPlugin	AI Provider Plugin interface.

Interfaces

Interface	Description
ActionBarItemRegistration	Registration for an action bar item.
ActivationEventWithMode	Parameterized activation event for mode-specific activation. Used by provider plugins to activate only when their specific AI mode is used.
AiProviderPlugin	AI Provider Plugin interface.
CliCommandConfig	Configuration for a shell command to execute. Used by buildLaunchCommand, buildResumeCommand, and other command builders.
CliDetectionResult	Result of detecting whether a provider's CLI is installed and configured.
Disposable	A resource that can be disposed to free up resources. Follows the VS Code Disposable convention for cleanup management.
FrontendPlugin	Frontend plugin interface for UI contributions.
FrontendPluginContext	Extended plugin context for frontend plugins. Provides registration methods for each UI extension point. Every registerXxx method returns a Disposable that removes the registration.
LaunchContext	Context provided to command builders when launching a new session. Contains all the information a provider needs to construct the CLI command.
ManifestValidationResult	Result of validating a plugin manifest. Contains a list of human-readable error messages when validation fails.
McpConfigContribution	MCP configuration contribution from a provider. Providers that support MCP can contribute configuration that gets written to the appropriate location before session launch.
MoreMenuItemRegistration	Registration for a "More" menu item.
OmniscribePlugin	Base interface for all Omniscribe plugins.
PluginContext	Context provided to a plugin during activation. Contains the plugin's identity, a scoped logger, and a subscriptions array for tracking disposables that should be cleaned up on deactivation.
PluginLogger	Logger interface for plugins. Each plugin receives a scoped logger that prefixes output with the plugin ID.
PluginManifest	Plugin manifest declared in a package's omniscribe field in package.json.
ProviderCapabilities	Declares what optional features a provider supports.
ProviderSessionEntry	A session history entry read from the provider's local storage. Providers that support session history map their native format to this type.
ProviderUsageData	Provider-agnostic usage data. Returned by the optional parseUsage() method on providers that declare supportsUsage: true.
SessionStatusProps	Props passed to session status renderer components.
SessionStatusRendererRegistration	Registration for a custom session status renderer.
SettingsCategoryRegistration	Registration for a settings category (group of sections).
SettingsSectionRegistration	Registration for a settings section within a category.
TerminalActionContext	Context passed to terminal action, action bar, and more menu callbacks.
TerminalHeaderActionRegistration	Registration for a terminal header action button.
ThemeRegistration	Registration for a plugin-provided theme.
UsageMetric	A single named usage metric with percentage and optional reset information.
UsagePanelProps	Props passed to usage panel components.
UsagePanelRegistration	Registration for a usage panel component.

Type Aliases

Type Alias	Description
ActivationEvent	Simple activation event triggers.
PluginActivation	A plugin activation trigger. Can be a simple event string or a parameterized event with additional data.
PluginComponentType	A component type that is compatible with React components without importing React. Plugin authors will use actual React components; this type is the API contract.
PluginType	What a plugin provides.
ProviderPluginContext	Extended plugin context for AI provider plugins. Inherits the base PluginContext with provider-specific additions. Currently identical to PluginContext but provides a dedicated type for future provider-specific context extensions.
ProviderSessionStatus	Normalized session status as reported by a provider.
SessionOperation	Session operations that a provider can support. Each operation is declared individually via supportedOperations.

Variables

Variable	Description
ALLOWED_PROVIDER_INVOKE_METHODS	-

Functions

Function	Description
getCapabilities	Get the full capabilities object from a provider plugin. Simple accessor for consistent capability access patterns.
hasCapability	Check if a provider plugin has a specific capability enabled.
isFrontendPlugin	Check if a plugin is a frontend plugin (type 'frontend' or 'both'). When true, the plugin implements FrontendPlugin with UI registration methods.
isFullPlugin	Check if a plugin is a full plugin (type 'both'). When true, the plugin implements both AiProviderPlugin and FrontendPlugin.
isProviderPlugin	Check if a plugin is a provider plugin (type 'provider' or 'both'). When true, the plugin implements AiProviderPlugin with capabilities, detectCli, buildLaunchCommand, and parseTerminalStatus.
supportsOperation	Check if a provider plugin supports a specific session operation.
validateManifest	Validate a plugin manifest object.