integration

type ActionDescriptor ¶

type ActionDescriptor struct {
	Channel       string      // "slack" | "telegram" | …
	Action        string      // "send_message" | "open_modal" | …
	Name          string      // UI label: "Slack: Send message"
	Description   string      // one-liner shown in palette
	InputType     any         // zero-value sample for input schema
	OutputType    any         // zero-value sample for output schema
	Destructive   bool        // shown with the destructive badge in UI
	Execute       ExecuteFunc // handler — receives args, returns output
	wickdocs.Docs             // opt-in self-documentation for MCP workflow_node_detail
}

ActionDescriptor declares one outbound op a workflow action node can invoke. Same model as connector.Op — typed input/output for schema gen, generic map-based Execute so the engine doesn't need per-type reflection.

func (a ActionDescriptor) Key() string

type EventDescriptor ¶

type EventDescriptor struct {
	Channel       string          // "slack" | "telegram" | …
	Event         string          // "message" | "block_action" | …
	Name          string          // UI label: "Slack: New message"
	Description   string          // one-liner shown in palette
	PayloadType   any             // zero-value sample for schema gen
	MatchSchema   []entity.Config // filter form schema (per event)
	Match         MatchFunc       // optional custom matcher; nil = key-equality
	wickdocs.Docs                 // opt-in self-documentation for MCP workflow_node_detail
}

EventDescriptor declares one inbound event class a channel can fire as a workflow trigger. The (Channel, Event) pair is the canonical key — e.g. ("slack", "message"), ("slack", "block_action"), ("telegram", "callback_query").

PayloadType is a zero-value sample struct used for two purposes:

• schema generation for the editor's payload picker
• documenting the keys downstream nodes can reference via `{{.Event.Payload.<key>}}` template expansion

MatchSchema declares the trigger filter form. Operators set values in the inspector → stored under Trigger.Match → router applies them at dispatch time.

func (e EventDescriptor) Key() string

type ExecuteFunc ¶

type ExecuteFunc func(ctx context.Context, args map[string]any) (any, error)

ExecuteFunc is the action handler signature. args carries the typed input encoded as a generic map (matches the workflow YAML / canvas inspector shape). Implementations decode args themselves; helpers for required-key extraction live in this package.

type MatchFunc ¶

type MatchFunc func(spec map[string]any, payload map[string]any) bool

EventDescriptor declares one inbound event class a channel can fire as a workflow trigger. The (Channel, Event) pair is the canonical key — e.g. ("slack", "message"), ("slack", "block_action"), ("telegram", "callback_query").

PayloadType is a zero-value sample struct used for two purposes:

• schema generation for the editor's payload picker
• documenting the keys downstream nodes can reference via `{{.Event.Payload.<key>}}` template expansion

Channels emit events as map[string]any using the keys declared on PayloadType so the editor and the engine see a stable shape.

MatchSchema declares per-event filter fields the trigger inspector renders as a form (channel id whitelist, user filter, text contains, etc.). Each event owns its own schema since match keys are channel-specific. The router reads stored values from Trigger.Match and skips the run when a non-empty field doesn't match the event payload.

Build via entity.StructToConfigs(MyMatchStruct{}). Empty schema = no filter UI for this event = the trigger always fires (dump-all).

Match evaluation is per-descriptor — supply a MatchFunc when the default key-equality semantics don't fit (regex, set membership, custom transforms). When MatchFunc is nil, the router falls back to a generic "for each spec key, payload[key] must equal spec value (unless spec is empty)" comparison.

type Registry ¶

type Registry struct {
	// contains filtered or unexported fields
}

Registry holds every registered event + action. One instance per wick process — typically constructed in workflow setup and handed to each channel's RegisterAll function.

func New() *Registry

func (r *Registry) Action(key string) (ActionDescriptor, bool)

func (r *Registry) Actions() []ActionDescriptor

func (r *Registry) ActionsByChannel(channel string) []ActionDescriptor

func (r *Registry) Channels() []string

func (r *Registry) Event(key string) (EventDescriptor, bool)

func (r *Registry) Events() []EventDescriptor

func (r *Registry) EventsByChannel(channel string) []EventDescriptor

func (r *Registry) RegisterAction(a ActionDescriptor)

func (r *Registry) RegisterEvent(e EventDescriptor)