sdk

type ModuleInstance ¶

type ModuleInstance interface {
	Init() error
	Start(ctx context.Context) error
	Stop(ctx context.Context) error
}

ModuleInstance is a remote module's lifecycle.

type ModuleProvider ¶

type ModuleProvider interface {
	// ModuleTypes returns the module type names this plugin provides.
	ModuleTypes() []string
	// CreateModule creates a module instance of the given type.
	CreateModule(typeName, name string, config map[string]any) (ModuleInstance, error)
}

ModuleProvider is optionally implemented to provide module types.

type PluginManifest ¶

type PluginManifest struct {
	Name        string
	Version     string
	Author      string
	Description string
}

PluginManifest describes the plugin.

type PluginProvider ¶

type PluginProvider interface {
	// Manifest returns the plugin's metadata.
	Manifest() PluginManifest
}

PluginProvider is the main interface plugin authors implement.

type StepInstance ¶

type StepInstance interface {
	Execute(ctx context.Context, triggerData map[string]any, stepOutputs map[string]map[string]any, current map[string]any, metadata map[string]any) (*StepResult, error)
}

StepInstance is a remote pipeline step.

type StepProvider ¶

type StepProvider interface {
	// StepTypes returns the step type names this plugin provides.
	StepTypes() []string
	// CreateStep creates a step instance of the given type.
	CreateStep(typeName, name string, config map[string]any) (StepInstance, error)
}

StepProvider is optionally implemented to provide step types.

type StepResult ¶

type StepResult struct {
	Output       map[string]any
	StopPipeline bool
}

StepResult is the output of a step execution.

type UIProvider ¶ added in v0.1.1

type UIProvider interface {
	// UIManifest returns the UI manifest for this plugin.
	UIManifest() ext.UIManifest
}

UIProvider is an optional interface that PluginProvider implementations can satisfy to declare UI assets and navigation contributions.

If a PluginProvider implements UIProvider, the SDK Serve() function will write a "ui.json" file to the plugin's working directory on first start (if one does not already exist). Alternatively, authors can maintain "ui.json" manually without implementing this interface.

Type aliases ¶

The UI manifest types (UIManifest, UINavItem) are defined in the github.com/GoCodeAlone/workflow/plugin/external package so that both the host engine and plugin processes share the same type definitions without introducing an import cycle.