core

type Blueprint interface {
	GetID() string
	GetLabels() map[string]string
	SetLabels(labels map[string]string)

	GetNeuron(neuronID string) (Neuron, error)
	HasNeuron(neuronID string) bool
	ListNeurons() []Neuron
	GetSrcNeuron(linkID string) (Neuron, error)
	GetDestNeuron(linkID string) (Neuron, error)

	GetLink(linkID string) (Link, error)
	HasLink(linkID string) bool
	HasEntryLink() bool
	HasEndLink() bool
	ListLinks() []Link
	ListEntryLinks() []Link
	ListEndLinks() []Link
	ListInLinks(neuronID string) []Link
	ListOutLinks(neuronID string) []Link

	AddNeuron(processFn func(bc processor.BrainContext) error, withOpts ...NeuronOption) Neuron
	AddNeuronWithProcessor(processor processor.Processor, withOpts ...NeuronOption) Neuron
	AddLink(from, to Neuron, withOpts ...LinkOption) (Link, error)
	AddEntryLinkTo(neuron Neuron, withOpts ...LinkOption) (Link, error)
	AddEndLinkFrom(neuron Neuron, withOpts ...LinkOption) (Link, error)

	Clone() Blueprint
}

type Brain interface {
	TrigLinks(links ...Link) error
	Entry() error
	EntryWithMemory(keysAndValues ...any) error

	// SetMemory set memories for brain, one key value pair is one memory.
	// memory will lazy initial util `SetMemory` or any link trig
	SetMemory(keysAndValues ...any) error
	// GetMemory get memory by key
	GetMemory(key any) any
	// ExistMemory indicates whether there is a memory in the brain
	ExistMemory(key any) bool
	// DeleteMemory delete one memory by key
	DeleteMemory(key any)
	// ClearMemory clear all memories
	ClearMemory()
	// GetState get brain state
	GetState() BrainState
	// Wait wait util brain maintainer shutdown, which means brain state is `Sleeping`
	Wait()
	// Shutdown the brain
	Shutdown()
}

type BrainState string

type Link interface {
	GetID() string
	GetLabels() map[string]string
	GetSrcNeuronID() string
	GetDestNeuronID() string
	IsEntryLink() bool
	IsEndLink() bool

	SetLabels(labels map[string]string)
}

type LinkOption interface {
	Apply(link Link)
}

type LinkState string

type MultiLangBlueprint interface {
	Blueprint
	// AddNeuronWithPyProcessor add a neuron with a python processor
	AddNeuronWithPyProcessor(pyCodePath, moduleName, processorClassName string, constructorArgs map[string]interface{}, withOpts ...NeuronOption) Neuron
}

type Neuron interface {
	GetID() string
	GetLabels() map[string]string
	GetProcessor() processor.Processor
	GetSelector() processor.Selector
	ListInLinkIDs() []string
	ListOutLinkIDs() []string
	ListTriggerGroups() map[string][]string
	ListCastGroups() map[string][]string

	SetLabels(labels map[string]string)
	AddTriggerGroup(links ...Link) error
	AddCastGroup(groupName string, links ...Link) error
	BindCastGroupSelectFunc(selectFn func(bcr processor.BrainContextReader) string)
	BindCastGroupSelector(selector processor.Selector)
}

type NeuronOption interface {
	Apply(neuron Neuron)
}

type NeuronState string