api

type Advice func(*Vars, *Request, *Response, Advice) error

type AdviceConfig struct {
	Before string `yaml:"before"`
	After  string `yaml:"after"`
	Around string `yaml:"around"`
}

type Agent struct {
	Owner string

	// The name of the agent.
	Name        string
	Display     string
	Description string

	Instruction *Instruction

	RawInput *UserInput

	// The model to be used by the agent
	Model *Model

	// Functions that the agent can call
	Tools []*ToolFunc

	Dependencies []string

	Entrypoint Entrypoint

	// advices
	BeforeAdvice Advice
	AfterAdvice  Advice
	AroundAdvice Advice

	// LLM adapter
	Adapter string

	//
	MaxTurns int
	MaxTime  int
	//
	Message string
	Format  string
	New     bool
	// MaxHistory int
	// MaxSpan    int
	LogLevel LogLevel

	//
	Config *AgentsConfig
}

type AgentConfig struct {
	Name        string `yaml:"name"`
	Display     string `yaml:"display"`
	Description string `yaml:"description"`

	//
	Instruction *Instruction `yaml:"instruction"`

	// [alias/]level
	Model string `yaml:"model"`

	// tools defined in tools config
	Functions []string `yaml:"functions"`

	Dependencies []string `yaml:"dependencies"`

	Entrypoint string `yaml:"entrypoint"`

	Advices *AdviceConfig `yaml:"advices"`

	// chat|image-get|docker/aider oh gptr
	Adapter string `yaml:"adapter"`

	//
	//
	MaxTurns int `yaml:"max_turns"`
	MaxTime  int `yaml:"max_time"`

	// user message
	Message string `yaml:"message"`

	// output format: json | text
	Format string `yaml:"format"`

	// memory
	// max history: 0 max span: 0
	New bool `yaml:"new"`

	// logging: quiet | info[rmative] | verbose | trace
	LogLevel string `yaml:"log_level"`

	//
	Store AssetStore `yaml:"-"`
	// relative to root
	BaseDir string `yaml:"-"`
}

type AgentCreator func(*Vars, *Request) (*Agent, error)

type AgentHandler func(*Vars, *Agent) Handler

type AgentResource struct {
	Resources []*Resource `json:"resources"`
}

type AgentsConfig struct {
	// agent app name
	Name string `yaml:"name"`

	// [alias/]level
	Model string `yaml:"model"`

	Agents []*AgentConfig `yaml:"agents"`
	Tools  []*ToolConfig  `yaml:"tools"`
	Models []*ModelConfig `yaml:"models"`

	//
	MaxTurns int `yaml:"max_turns"`
	MaxTime  int `yaml:"max_time"`

	// user message
	Message string `yaml:"message"`

	// output format: json | text
	Format string `yaml:"format"`

	// memory
	// max history: 0 max span: 0
	New bool `yaml:"new"`

	// logging: quiet | informative | verbose
	LogLevel string `yaml:"log_level"`
}

type AppConfig struct {
	Version string

	ConfigFile string

	// rename WebResource?
	AgentResource *AgentResource

	// ToolSystemCommands []string
	SystemTools []*ToolFunc

	Agent string
	// Command string
	Args []string

	// --message takes precedence, skip stdin
	// command line arguments
	Message string

	// editor binary and args. e.g vim [options]
	Editor string

	Clipin   bool
	ClipWait bool

	Clipout    bool
	ClipAppend bool

	IsPiped bool
	Stdin   bool

	Files []string

	// Treated as file
	Screenshot bool

	// Treated as input text
	Voice bool

	// Output format: raw or markdown
	Format string

	// output file for saving response
	Output string

	Me *User

	//
	Template string

	// conversation history
	New        bool
	MaxHistory int
	MaxSpan    int

	// chat id to continue the conersation
	// <config_base>/chat/<id>.json
	ChatID string

	//<config_base>/chat/<id>/*.json
	// History []*Message
	History MemStore

	Models string

	//
	LogLevel string

	DenyList  []string
	AllowList []string
	Unsafe    bool

	//
	Base string

	Workspace string
	Home      string
	Temp      string

	Interactive bool
	Editing     bool
	Shell       string

	Watch     bool
	ClipWatch bool

	MaxTime  int
	MaxTurns int

	//
	Stdout string
	Stderr string

	// dry run
	DryRun        bool
	DryRunContent string
}

type AssetStore interface {
	ReadDir(name string) ([]DirEntry, error)
	ReadFile(name string) ([]byte, error)
	Resolve(parent string, name string) string
}

type Chat struct {
	// uuid
	ID      string    `json:"id"`
	UserID  string    `json:"userId"`
	Created time.Time `json:"created"`

	// data
	Title string `json:"title"`
}

type ClipboardProvider interface {
	Clear() error
	Read() (string, error)
	Get() (string, error)
	Write(string) error
	Append(string) error
}

type ConnectorConfig struct {
	// mcp | ssh ...
	Proto string `yaml:"proto"`

	Provider string `yaml:"provider"`
	BaseUrl  string `yaml:"base_url"`
	// name of api key
	ApiKey string `yaml:"api_key"`

	Extra map[string]string `yaml:"extra"`
}

type DirEntry = fs.DirEntry

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

type EditorProvider interface {
	Launch(string) (string, error)
}

type Entrypoint func(*Vars, *Agent, *UserInput) error

type Feature string

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

type FuncBody struct {
	Language string `yaml:"language"`
	Code     string `yaml:"code"`
	Url      string `yaml:"url"`
}

type Handler interface {
	Serve(*Request, *Response) error
}

type InputType string

type Instruction struct {
	Role string `yaml:"role"`
	// TODO add new field
	// Source ? resource/file/cloud...
	// prefix supported: file: resource:
	Content string `yaml:"content"`
	// template or not
	// tpl
	Type string `yaml:"type"`
}

type Level = string

type LogLevel int

type MemOption struct {
	MaxHistory int
	MaxSpan    int
}

type MemStore interface {
	Save([]*Message) error
	Load(*MemOption) ([]*Message, error)
}

type Message struct {
	ID      string    `json:"id"`
	ChatID  string    `json:"chatId"`
	Created time.Time `json:"created"`

	// data
	ContentType string `json:"contentType"`
	Content     string `json:"content"`

	Role string `json:"role"`

	// agent name
	Sender string `json:"sender"`
}

type Model struct {
	Model string

	Provider string
	BaseUrl  string

	// resolved LLM api key/token
	ApiKey string

	// output
	Type OutputType

	//
	Config *ModelsConfig
}

type ModelAlias = map[string]*Model

type ModelAliasConfig = map[string]*ModelConfig

type ModelConfig struct {
	// LLM model
	Model string `yaml:"model"`

	// LLM service provider: openai | gemini | anthropic
	Provider string `yaml:"provider"`
	BaseUrl  string `yaml:"base_url"`
	// name of api key
	ApiKey string `yaml:"api_key"`
}

type ModelsConfig struct {
	Alias string `yaml:"alias"`

	// default LLM model for ModelConfig
	Model string `yaml:"model"`

	Provider string `yaml:"provider"`
	BaseUrl  string `yaml:"base_url"`
	// name of api key
	ApiKey string `yaml:"api_key"`

	Models ModelAliasConfig `yaml:"models"`
}

type Output struct {
	// Agent icon and name
	Display string `json:"display"`

	Content     string `json:"content"`
	ContentType string `json:"content_type"`
}

type OutputType string

type Request struct {
	// The name/command of the active agent
	Agent string

	Messages []*Message

	RawInput *UserInput
	// contains filtered or unexported fields
}

type Resource struct {
	// web resource base url
	// http://localhost:18080/resource
	// https://ai.dhnt.io/resource
	Base string `json:"base"`

	// access token
	Token string `json:"token"`
}

type Response struct {
	// A list of message objects generated during the conversation
	// with a sender field indicating which Agent the message originated from.
	Messages []*Message

	// The last agent to handle a message
	Agent *Agent

	Result *Result
}

type Result struct {
	// The result value as a string
	Value string

	// Tool call
	// https://developer.mozilla.org/en-US/docs/Web/HTTP/Guides/MIME_types
	MimeType string
	Message  string

	// The agent state
	State State

	// The agent name to transfer to for StateTransfer
	NextAgent string
}

type State int

type TemplateFuncMap = template.FuncMap

type ToolCaller func(*Vars, *Agent) func(context.Context, string, map[string]any) (*Result, error)

type ToolCondition struct {
	// required env list
	Env []string `yaml:"env"`

	// found on PATH
	Lookup *string `yaml:"lookup"`

	// shell required
	Shell map[string]any `yaml:"shell"`
}

type ToolConfig struct {
	Type string `yaml:"type"`

	Name string `yaml:"name"`

	Description string         `yaml:"description"`
	Parameters  map[string]any `yaml:"parameters"`

	Body *FuncBody `yaml:"body"`

	Condition *ToolCondition `yaml:"condition"`

	//
	Provider string `yaml:"provider"`
	BaseUrl  string `yaml:"base_url"`
	// name of api key
	ApiKey string `yaml:"api_key"`

	Extra map[string]string `yaml:"extra"`
}

type ToolFunc struct {
	Type string

	Kit         string
	Name        string
	Description string
	Parameters  map[string]any

	Body *FuncBody

	//
	State State
	//
	Config *ToolsConfig

	//
	Provider string
	BaseUrl  string
	// name of api key - used to resolve api key/token before tool call
	ApiKey string

	Extra map[string]string
}

type ToolSystem interface {
	Call(context.Context, *Vars, *ToolFunc, map[string]any) (*Result, error)
}

type ToolsConfig struct {
	// kit name
	// Namespace:
	//
	// func class
	// Agent name
	// MCP server name
	// Virtual file system name
	// Container name
	// Virtual machine name
	// Tool/function (Gemini)
	Kit string `yaml:"kit"`

	// func (server) | system (client) | remote
	Type string `yaml:"type"`

	Provider string `yaml:"provider"`
	BaseUrl  string `yaml:"base_url"`
	// name of api key
	ApiKey string `yaml:"api_key"`

	Connector *ConnectorConfig `yaml:"connector"`

	// system commands used by tools
	Commands []string `yaml:"commands"`

	Tools []*ToolConfig `yaml:"tools"`
}

type User struct {
	// uuid
	ID      string    `json:"id"`
	Created time.Time `json:"created"`

	// data
	Username string `json:"username"`
	Display  string `json:"display"`
}

type UserInput struct {
	Agent string `json:"agent"`

	// query - command line args
	Message string `json:"message"`

	// query - clipboard/stdin/editor
	Content string `json:"content"`

	// TODO deprecate
	Template string `json:"template"`

	Files []string `json:"files"`

	Extra map[string]any `json:"extra"`

	// cached file contents
	Messages []*Message `json:"-"`
}

type Vars struct {
	Config *AppConfig `json:"config"`

	OS        string            `json:"os"`
	Arch      string            `json:"arch"`
	ShellInfo map[string]string `json:"shell_info"`
	OSInfo    map[string]string `json:"os_info"`

	UserInfo map[string]string `json:"user_info"`

	UserInput *UserInput `json:"user_input"`

	Workspace string `json:"workspace"`
	// Repo      string `json:"repo"`
	Home string `json:"home"`
	Temp string `json:"temp"`

	// EnvType indicates the environment type where the agent is running
	// It can be "container" for Docker containers or "host" for the host machine
	EnvType string `json:"env_type"`

	Roots []string `json:"roots"`

	//
	Extra map[string]string `json:"extra"`

	// conversation history
	History []*Message
}