action

type Action interface {
	// Metadata get the Action's metadata
	Metadata() *Metadata

	// IOMetadata get the Action's IO metadata
	IOMetadata() *data.IOMetadata
}

type AsyncAction interface {
	Action

	// Run this Action
	Run(context context.Context, inputs map[string]*data.Attribute, handler ResultHandler) error
}

type Config struct {
	//inline action
	Ref      string                 `json:"ref"`
	Settings map[string]interface{} `json:"settings"`
	Data     json.RawMessage        `json:"data"`

	//referenced action
	Id string `json:"id"`

	// Deprecated: No longer used
	Metadata *data.IOMetadata `json:"metadata"`
}

type Factory interface {

	// New create a new Action
	New(config *Config) (Action, error)
}

type Metadata struct {
	ID       string `json:"ref"`
	Version  string
	Settings map[string]*data.Attribute
	Input    map[string]*data.Attribute
	Output   map[string]*data.Attribute

	Async    bool `json:"async"`
	Passthru bool `json:"passthru"`
}

type ResultHandler interface {

	// HandleResult is invoked when there are results available
	HandleResult(results map[string]*data.Attribute, err error)

	// Done indicates that the action has completed
	Done()
}

type Runner interface {
	// Deprecated: Use Execute() instead
	Run(context context.Context, act Action, uri string, options interface{}) (code int, data interface{}, err error)

	// Deprecated: Use Execute() instead
	RunAction(ctx context.Context, act Action, options map[string]interface{}) (results map[string]*data.Attribute, err error)

	// Execute the specified Action
	Execute(ctx context.Context, act Action, inputs map[string]*data.Attribute) (results map[string]*data.Attribute, err error)
}

type SyncAction interface {
	Action

	// Run this Action
	Run(context context.Context, inputs map[string]*data.Attribute) (map[string]*data.Attribute, error)
}