plugin

package

Go to main page

Versions in this module

v0

v0.2.3

Sep 8, 2026

Changes in this version

+ const BackingCore

+ const BackingRuntime

+ const BundleFormatTarGzip

+ const DefaultInvokeHostCalls

+ const DefaultInvokeStderrBytes

+ const DefaultInvokeStdoutBytes

+ const DefaultInvokeTimeoutMS

+ const HostMaxInvokeHostCalls

+ const HostMaxInvokeStderrBytes

+ const HostMaxInvokeStdoutBytes

+ const HostMaxInvokeTimeoutMS

+ const InterfaceEffectPlan

+ const InterfaceEffectRead

+ const InterfaceEffectWrite

+ const ManifestSchemaV2

+ const RuntimeProtocolStdioJSONV1

+ const RuntimeProtocolStdioJSONV2

+ const RuntimeStateDegraded

+ const RuntimeStateStopping

+ const UIBridgeVersion1

+ const UIRuntimeModeSandbox

+ var ErrRPCOwnerInactive = errors.New("rpc service owner is not active")

+ func BindOperation(ctx context.Context, grant *OperationGrant) (context.Context, error)

+ func BindOperatorTargets(ctx context.Context, targets []string) (context.Context, error)

+ func CanonicalOperationPlan(plan PluginOperationPlan) (string, error)

+ func SHA256Hex(data []byte) string

+ func ValidateInvokeBudgetSpec(b InvokeBudgetSpec) error

+ func ValidateOperationPlan(plan PluginOperationPlan) error

+ func ValidateSystemPoolConfig(cfg SystemPoolConfig) error

+ func VersionInRange(version, rangeExpr string) bool

type Broker

+ func (b *Broker) HTTPOperatorDo(ctx context.Context, req HostHTTPRequest) (HostHTTPResponse, error)

+ func (b *Broker) SecretDelete(ctx context.Context, key string) error

+ func (b *Broker) SecretGet(ctx context.Context, key string) (string, bool, error)

+ func (b *Broker) SecretPut(ctx context.Context, key, value string) error

+ func (b *Broker) TaskEnqueue(ctx context.Context, req HostTaskRequest) (string, error)

+ type BundleFile struct

+ Mode uint32

+ SHA256 string

+ Size int64

+ func ReadVerifiedBundleFile(loaded Loaded, rel string) ([]byte, BundleFile, error)

+ type BundleLimits struct

+ MaxCompressedBytes int64

+ MaxDepth int

+ MaxExpandedBytes int64

+ MaxFileBytes int64

+ MaxFiles int

+ MaxPathBytes int

+ func DefaultBundleLimits() BundleLimits

+ type BundleSpec struct

+ DigestSHA256 string

+ Format string

+ type CompatibilitySpec struct

+ DashboardHost string

+ RuntimeProtocol string

+ Server string

+ type DependencySpec struct

+ ID string

+ Optional bool

+ Version string

+ type ExtractedBundle struct

+ Digest string

+ Inventory map[string]BundleFile

+ Root string

+ RuntimePath string

+ UIEntry string

+ UIRoot string

+ func ExtractBundleV2(cacheDir string, manifest Manifest, artifact []byte, platform string, ...) (ExtractedBundle, error)

+ type GenerationCleanupError struct

+ Authority error

+ Err error

+ Generation uint64

+ PendingStages []string

+ PluginID string

+ RemoveAll error

+ ResidualPGIDs []int

+ Stage string

+ Transport error

+ func (e *GenerationCleanupError) Error() string

+ func (e *GenerationCleanupError) Unwrap() error

+ type GenerationCleanupResult struct

+ Authority error

+ Err error

+ Generation uint64

+ PendingStages []string

+ PluginID string

+ RemoveAll error

+ ResidualPGIDs []int

+ Stage string

+ Transport error

+ type GenerationLeasingRunner interface

+ AcquireInvocation func(pluginID string, generation uint64) (InvocationGenerationLease, error)

+ type HostAccessSpec struct

+ RPC []RPCDependency

type HostServices

+ GuardOperatorURL func(url string) error

+ OperatorHTTP OperatorHTTPHost

+ Secret SecretHost

+ Task TaskHost

+ type HostTaskRequest struct

+ ApprovalID string

+ Interpreter string

+ NodeID string

+ PluginID string

+ Script string

+ TimeoutSec int

type InterfaceContract

+ Backing string

+ MethodSpecs []InterfaceMethod

+ func (c *InterfaceContract) UnmarshalJSON(data []byte) error

+ func (c InterfaceContract) EffectiveBacking() string

+ func (c InterfaceContract) EffectiveMethodScopes(name string) ([]string, bool)

+ func (c InterfaceContract) MarshalJSON() ([]byte, error)

+ func (c InterfaceContract) MethodContract(name string) (InterfaceMethod, bool)

+ func (c InterfaceContract) MethodContracts() []InterfaceMethod

+ func (c InterfaceContract) TypedMethods() bool

+ type InterfaceMethod struct

+ Budget *InvokeBudgetSpec

+ Effect string

+ Name string

+ OperatorTargetFields []string

+ Scopes []string

+ type InvocationGenerationLease interface

+ Invoke func(ctx context.Context, req InvokeRequest) (InvokeResponse, error)

+ Release func()

+ type InvokeBudgetSpec struct

+ HostCalls int

+ StderrBytes int

+ StdoutBytes int

+ TimeoutMS int

+ func DefaultInvokeBudgetSpec() InvokeBudgetSpec

+ func (b *InvokeBudgetSpec) UnmarshalJSON(data []byte) error

+ type InvokeConstraints struct

+ Budget *InvokeBudgetSpec

+ BudgetLabel string

+ Operation *OperationGrant

+ OperatorTargets []string

type InvokeRequest

+ Constraints InvokeConstraints

+ Generation uint64

type InvokeResponse

+ Warnings []string

type Loaded

+ ArtifactDigest string

+ ArtifactPath string

+ BundleLimits BundleLimits

+ ExtractedRoot string

+ Inventory map[string]BundleFile

+ RuntimeEntry string

+ RuntimePath string

+ UIEntry string

+ UIRoot string

type Loader

+ CacheDir string

+ Limits BundleLimits

+ Platform string

type Manifest

+ Bundle *BundleSpec

+ Compatibility *CompatibilitySpec

+ Dependencies []DependencySpec

+ HostAccess *HostAccessSpec

+ MinServer string

+ Runtime *RuntimeSpec

+ Schema string

+ UIRuntime *UIRuntimeSpec

+ func DecodeManifest(manifestBytes []byte) (Manifest, error)

+ func (m Manifest) InterfaceFor(service string) (InterfaceContract, bool)

+ type OperationExecuteRequest struct

+ ApprovalID string

+ Data json.RawMessage

+ Targets []string

+ type OperationGrant struct

+ ApprovalID string

+ PlanSHA256 string

+ PluginID string

+ Remaining int

+ Targets []string

+ func (g *OperationGrant) AllowsTarget(nodeID string) bool

+ type OperatorHTTPHost interface

+ DoOperator func(ctx context.Context, req HostHTTPRequest) (HostHTTPResponse, error)

+ type OwnerActiveFunc func(pluginID string) bool

+ type PluginOperationPlan struct

+ Data json.RawMessage

+ Preview string

+ Rollback string

+ Steps []string

+ Summary string

+ Targets []string

+ func ParseOperationPlan(plan string) (PluginOperationPlan, error)

+ type PoolCleanupResult struct

+ Err error

+ Generation uint64

+ PendingStages []string

+ ResidualPGIDs []int

+ Stage string

+ type RPCDependency struct

+ Methods []string

+ Service string

+ type RPCGrant map[string]map[string]struct

+ type RPCGrantedHost interface

+ CallGranted func(ctx context.Context, caller string, grant RPCGrant, service, method string, ...) ([]byte, error)

type RPCRegistry

+ func (r *RPCRegistry) AllowMethods(callerPluginID, service string, methods []string)

+ func (r *RPCRegistry) CallGranted(ctx context.Context, caller string, grant RPCGrant, service, method string, ...) ([]byte, error)

+ func (r *RPCRegistry) Owns(ownerPluginID, service string) bool

+ func (r *RPCRegistry) SetOwnerActive(fn OwnerActiveFunc)

+ type ResolvedInvokeBudget struct

+ Declared bool

+ HostCalls int

+ StderrBytes int

+ StdoutBytes int

+ Timeout time.Duration

+ func ResolveInvokeBudget(spec *InvokeBudgetSpec, defaults InvokeBudgetSpec) ResolvedInvokeBudget

+ type RunnerCloser interface

+ StopAll func(ctx context.Context) error

type RunnerStartRequest

+ Generation uint64

type RunnerStopRequest

+ Generation uint64

type RuntimeManager

+ func (m *RuntimeManager) Close(ctx context.Context) error

+ func (m *RuntimeManager) InvokeConstrained(ctx context.Context, pluginID, action string, payload json.RawMessage, ...) (InvokeResponse, error)

+ type RuntimeShutdownError struct

+ Err error

+ PendingStages []string

+ PluginID string

+ Stage string

+ func (e *RuntimeShutdownError) Error() string

+ func (e *RuntimeShutdownError) Unwrap() error

+ type RuntimeSpec struct

+ Entrypoints map[string]string

+ Protocol string

+ type SecretHost interface

+ Delete func(ctx context.Context, key string) error

+ Get func(ctx context.Context, key string) (string, bool, error)

+ Put func(ctx context.Context, key, value string) error

+ type SystemPoolCircuitTransition int

+ const SystemPoolCircuitOpened

+ type SystemPoolConfig struct

+ MaxAge time.Duration

+ MaxOverflow int

+ MaxUses int

+ Size int

+ StartTimeout time.Duration

+ type SystemPoolDurationPhase int

+ const SystemPoolDurationHandler

+ const SystemPoolDurationQueue

+ const SystemPoolDurationStart

+ const SystemPoolDurationTotal

+ type SystemPoolLifecycleEvent int

+ const SystemPoolLifecycleInvocationFailure

+ const SystemPoolLifecycleInvocationReusable

+ const SystemPoolLifecycleWorkerStartFailure

+ const SystemPoolLifecycleWorkerStartSuccess

+ type SystemPoolObserver interface

+ ObserveSystemPoolCircuit func(transition SystemPoolCircuitTransition)

+ ObserveSystemPoolDuration func(phase SystemPoolDurationPhase, d time.Duration)

+ ObserveSystemPoolLifecycle func(event SystemPoolLifecycleEvent)

+ ObserveSystemPoolRetirement func(reason SystemPoolRetirementReason)

+ type SystemPoolRetirementReason int

+ const SystemPoolRetirementCircuitOpen

+ const SystemPoolRetirementMaxAge

+ const SystemPoolRetirementMaxUses

+ const SystemPoolRetirementPoisoned

+ const SystemPoolRetirementRejected

+ const SystemPoolRetirementShutdown

type SystemRunner

+ func (r *SystemRunner) AbortGeneration(ctx context.Context, pluginID string, generation uint64) error

+ func (r *SystemRunner) AcquireInvocation(pluginID string, generation uint64) (InvocationGenerationLease, error)

+ func (r *SystemRunner) ActivateGeneration(pluginID string, generation uint64) error

+ func (r *SystemRunner) Prepare(ctx context.Context, req RunnerStartRequest) (RunnerStartResult, error)

+ func (r *SystemRunner) RetireGeneration(ctx context.Context, pluginID string, generation uint64) error

+ func (r *SystemRunner) StopAll(ctx context.Context) error

type SystemRunnerOptions

+ Logf func(format string, args ...any)

+ Pool *SystemPoolConfig

+ PoolObserver SystemPoolObserver

+ type TaskHost interface

+ Enqueue func(ctx context.Context, req HostTaskRequest) (string, error)

+ type TransactionalRunner interface

+ AbortGeneration func(ctx context.Context, pluginID string, generation uint64) error

+ ActivateGeneration func(pluginID string, generation uint64) error

+ Prepare func(ctx context.Context, req RunnerStartRequest) (RunnerStartResult, error)

+ RetireGeneration func(ctx context.Context, pluginID string, generation uint64) error

+ type UIRuntimeSpec struct

+ BridgeVersion string

+ Entrypoint string

+ Mode string

v0.2.1

Jul 10, 2026

v0.2.0

Jul 5, 2026

Changes in this version

+ const RiskHost

+ const RiskRead

+ const RiskWrite

+ const RuntimeStateArmed

+ const RuntimeStateFailed

+ const RuntimeStateStopped

+ const TypeSystem

+ const TypeWasm

+ const TypeWorker

+ var ErrCapabilityDenied = errors.New("plugin capability denied")

+ var ErrCircuitOpen = errors.New("plugin circuit breaker open")

+ var ErrHostServiceUnavailable = errors.New("plugin host service unavailable")

+ var ErrRPCDenied = errors.New("rpc call denied")

+ var ErrRPCInvalid = errors.New("invalid rpc registration")

+ var ErrRPCNoMethod = errors.New("rpc method not found")

+ var ErrRPCNoService = errors.New("rpc service not found")

+ func CapabilityRisk(cap string) (string, bool)

+ func DigestSHA256(artifact []byte) string

+ func SigningPayload(m Manifest) []byte

+ func VerifyManifest(m Manifest, artifact []byte, policy TrustPolicy) error

+ type Broker struct

+ func NewBroker(loaded Loaded, services HostServices) (*Broker, error)

+ func (b *Broker) CanExposeRPC() bool

+ func (b *Broker) HTTPDo(ctx context.Context, req HostHTTPRequest) (HostHTTPResponse, error)

+ func (b *Broker) HasCapability(cap string) bool

+ func (b *Broker) KVGet(ctx context.Context, key string) ([]byte, bool, error)

+ func (b *Broker) KVPut(ctx context.Context, key string, value []byte) error

+ func (b *Broker) Log(ctx context.Context, level, message string, fields map[string]string) error

+ func (b *Broker) Notify(ctx context.Context, title, body string) error

+ func (b *Broker) PluginID() string

+ func (b *Broker) RPCCall(ctx context.Context, service, method string, request []byte) ([]byte, error)

+ type CapabilityError struct

+ Capability string

+ PluginID string

+ func (e *CapabilityError) Error() string

+ func (e *CapabilityError) Unwrap() error

+ type HTTPHost interface

+ Do func(ctx context.Context, req HostHTTPRequest) (HostHTTPResponse, error)

+ type HostAudit interface

+ RecordHostCall func(ctx context.Context, event HostCallEvent)

+ type HostCallEvent struct

+ Action string

+ Capability string

+ Decision string

+ PluginID string

+ Reason string

+ type HostHTTPRequest struct

+ Body []byte

+ Header map[string]string

+ Method string

+ URL string

+ type HostHTTPResponse struct

+ Body []byte

+ Header map[string]string

+ StatusCode int

+ type HostLogEntry struct

+ Fields map[string]string

+ Level string

+ Message string

+ PluginID string

+ type HostServices struct

+ Audit HostAudit

+ GuardURL func(url string) error

+ HTTP HTTPHost

+ KV KVHost

+ Log LogHost

+ Notify NotifyHost

+ RPC RPCHost

+ type InterfaceContract struct

+ Methods []string

+ Scopes []string

+ Service string

+ type InvokeRequest struct

+ Action string

+ Payload json.RawMessage

+ PluginID string

+ type InvokeResponse struct

+ Message string

+ OK bool

+ Result json.RawMessage

+ type Invoker interface

+ Invoke func(ctx context.Context, req InvokeRequest) (InvokeResponse, error)

+ type KVHost interface

+ Get func(ctx context.Context, key string) ([]byte, bool, error)

+ Put func(ctx context.Context, key string, value []byte) error

+ type LoadOutcome struct

+ BundlePath string

+ Loaded bool

+ PluginID string

+ Reason string

+ type Loaded struct

+ BundlePath string

+ Capabilities []string

+ Manifest Manifest

+ type Loader struct

+ Dir string

+ Policy TrustPolicy

+ func (l Loader) Load() ([]Loaded, []LoadOutcome, error)

+ type LogHost interface

+ Write func(ctx context.Context, entry HostLogEntry) error

type Manifest

+ DigestSHA256 string

+ Entrypoint string

+ Interfaces []InterfaceContract

+ Publisher string

+ SignatureEd25519 string

+ UI *ManifestUI

+ Version string

+ func VerifyInstallManifest(manifestBytes, artifact []byte, policy TrustPolicy) (Manifest, error)

+ type ManifestUI struct

+ Nav []NavContribution

+ Views []ViewContribution

+ type NavContribution struct

+ Icon string

+ Route string

+ Scopes []string

+ Section string

+ SectionTitle string

+ Title string

+ type NotifyHost interface

+ Send func(ctx context.Context, title, body string) error

+ type RPCHandler func(ctx context.Context, method string, request []byte) ([]byte, error)

+ type RPCHost interface

+ Call func(ctx context.Context, caller, service, method string, request []byte) ([]byte, error)

+ type RPCRegistry struct

+ func NewRPCRegistry() *RPCRegistry

+ func (r *RPCRegistry) Allow(callerPluginID, service string)

+ func (r *RPCRegistry) Call(ctx context.Context, caller, service, method string, request []byte) ([]byte, error)

+ func (r *RPCRegistry) CallOperator(ctx context.Context, service, method string, request []byte) ([]byte, error)

+ func (r *RPCRegistry) Register(ownerPluginID, service, version string, methods []string, handler RPCHandler) error

+ func (r *RPCRegistry) Revoke(callerPluginID, service string)

+ func (r *RPCRegistry) Services() []RPCServiceDescriptor

+ func (r *RPCRegistry) Unregister(service string)

+ type RPCServiceDescriptor struct

+ Methods []string

+ Owner string

+ Service string

+ Version string

+ type Runner interface

+ Name func() string

+ Start func(ctx context.Context, req RunnerStartRequest) (RunnerStartResult, error)

+ Stop func(ctx context.Context, req RunnerStopRequest) error

+ type RunnerStartRequest struct

+ Broker *Broker

+ Loaded Loaded

+ PluginID string

+ type RunnerStartResult struct

+ Message string

+ type RunnerStopRequest struct

+ PluginID string

+ Reason string

+ type RuntimeManager struct

+ func NewRuntimeManager(services HostServices) *RuntimeManager

+ func NewRuntimeManagerWithOptions(opts RuntimeManagerOptions) *RuntimeManager

+ func (m *RuntimeManager) Invoke(ctx context.Context, pluginID, action string, payload json.RawMessage) (InvokeResponse, error)

+ func (m *RuntimeManager) IsArmed(pluginID string) bool

+ func (m *RuntimeManager) Snapshot() map[string]RuntimeStatus

+ func (m *RuntimeManager) Start(ctx context.Context, loaded Loaded) (RuntimeStatus, error)

+ func (m *RuntimeManager) Status(pluginID string) (RuntimeStatus, bool)

+ func (m *RuntimeManager) Stop(pluginID, message string) (RuntimeStatus, error)

+ type RuntimeManagerOptions struct

+ Runners map[string]Runner

+ Services HostServices

+ StartTimeout time.Duration

+ type RuntimeStatus struct

+ Message string

+ PluginID string

+ Runner string

+ StartedAt time.Time

+ State string

+ StoppedAt time.Time

+ UpdatedAt time.Time

+ type SystemRunner struct

+ func NewSystemRunner(opts SystemRunnerOptions) *SystemRunner

+ func (r *SystemRunner) Invoke(ctx context.Context, req InvokeRequest) (InvokeResponse, error)

+ func (r *SystemRunner) Name() string

+ func (r *SystemRunner) Start(ctx context.Context, req RunnerStartRequest) (RunnerStartResult, error)

+ func (r *SystemRunner) Stop(ctx context.Context, req RunnerStopRequest) error

+ type SystemRunnerOptions struct

+ CrashThreshold int

+ EnvAllowlist []string

+ InvokeTimeout time.Duration

+ MaxHostCalls int

+ MaxOutputBytes int

+ RuntimeDir string

+ StopGrace time.Duration

+ type TrustPolicy struct

+ AllowUnsignedHostRisk bool

+ TrustedPublishers map[string]ed25519.PublicKey

+ func ParseTrustPolicyJSON(data []byte) (TrustPolicy, error)

+ type ViewAction struct

+ Form []ViewFormField

+ Interface string

+ Label string

+ Method string

+ Scopes []string

+ type ViewColumn struct

+ Key string

+ Label string

+ Render string

+ type ViewContribution struct

+ Actions []ViewAction

+ Columns []ViewColumn

+ ComponentKey string

+ Kind string

+ Route string

+ Source *ViewSource

+ Title string

+ type ViewFormField struct

+ Key string

+ Kind string

+ Label string

+ Options []string

+ type ViewSource struct

+ Interface string

+ Method string

v0.1.0

Jun 11, 2026

Changes in this version

+ func CapabilityList() []string

+ func ValidateManifest(m Manifest) error

+ type Manifest struct

+ Capabilities []string

+ ID string

+ Name string

+ Type string

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL