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 {
	Adapter string

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

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

	// The role of the agent. default is "system"
	Role string

	RawInput *UserInput

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

	Entrypoint Entrypoint

	Dependencies []string

	// advices
	BeforeAdvice Advice
	AfterAdvice  Advice
	AroundAdvice Advice

	//
	MaxTurns int
	MaxTime  int

	Config *AgentConfig
}

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

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

	Model string `yaml:"model"`

	// model alias
	Models string `yaml:"models"`

	Entrypoint string `yaml:"entrypoint"`

	Functions []string `yaml:"functions"`

	Dependencies []string `yaml:"dependencies"`

	Advices *AdviceConfig `yaml:"advices"`

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

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

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

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

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

	Agents    []*AgentConfig    `yaml:"agents"`
	Functions []*FunctionConfig `yaml:"functions"`
	Models    []*ModelConfig    `yaml:"models"`

	MaxTurns int `yaml:"maxTurns"`
	MaxTime  int `yaml:"maxTime"`
}

type AppConfig struct {
	Version string

	ConfigFile string

	ModelLoader func(string) (*model.Model, error)

	AgentResource *AgentResource

	AgentLister func() map[string]*AgentsConfig
	AgentLoader func(string) (*AgentsConfig, error)

	ToolSystem ToolSystem
	ToolLoader func(string) ([]*ToolFunc, error)

	// 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

	Models string

	Log string

	// TODO change to log level?
	Trace bool
	Debug bool
	Quiet bool

	DenyList  []string
	AllowList []string
	Unsafe    bool

	//
	Base string

	Workspace string
	// Repo      string
	Home string
	Temp string

	Interactive bool
	Editing     bool
	Shell       string

	Watch     bool
	ClipWatch bool

	Hub *HubConfig

	MaxTime  int
	MaxTurns int

	//
	Stdout string
	Stderr string

	// dry run
	DryRun        bool
	DryRunContent string

	// experimental
	// provider -> api-key
	ApiKeys map[string]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"`

	// ssh://user@example.com:2222/user/home
	// git@github.com:owner/repo.git
	// postgres://dbuser:secret@db.example.com:5432/mydb?sslmode=require
	// https://drive.google.com/drive/folders
	// mailto:someone@example.com
	URL string `yaml:"url"`
}

type DBCred struct {
	Host     string `mapstructure:"host"`
	Port     string `mapstructure:"port"`
	Username string `mapstructure:"username"`
	Password string `mapstructure:"password"`
	DBName   string `mapstructure:"name"`
}

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 FileInfo struct {
	// contains filtered or unexported fields
}

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

type FunctionConfig struct {
	Label   string `yaml:"label"`
	Service string `yaml:"service"`

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

type GitConfig struct {
}

type HubConfig struct {
	Enable  bool
	Address string

	Pg        bool
	PgAddress string

	Mysql        bool
	MysqlAddress string

	Redis        bool
	RedisAddress string

	Terminal        bool
	TerminalAddress string

	LLMProxy        bool
	LLMProxyAddress string
	LLMProxySecret  string
	LLMProxyApiKey  string
}

type InstructionConfig 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 LLMConfig struct {
	Provider string
	// Name     string
	BaseUrl string
	ApiKey  string

	// model aliases
	Models map[model.Level]*Model
}

type LLMRequest struct {
	Agent string

	Model *Model

	Messages []*Message

	MaxTurns int
	RunTool  func(ctx context.Context, name string, props map[string]any) (*Result, error)

	Tools []*ToolFunc

	// Experimenal
	Vars *Vars
}

type LLMResponse struct {
	ContentType string
	Content     string

	Agent   string
	Display string
	Role    string

	Result *Result
}

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"`

	// model alias
	Models string `json:"models"`
}

type Model = model.Model

type ModelConfig struct {
	Name        string `yaml:"name"`
	Type        string `yaml:"type"`
	Description string `yaml:"description"`
	Model       string `yaml:"model"`
	BaseUrl     string `yaml:"baseUrl"`
	ApiKey      string `yaml:"apiKey"`
	External    bool   `yaml:"external"`
}

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

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

type Request struct {
	// The name/command of the active agent
	Agent   string
	Command 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 ResponseWriter interface {
	AddMessage(*Response, *Agent)
	SetResult(*Result)
}

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

	// 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 TTSConfig struct {
	Provider string

	Model   string
	BaseUrl string
	ApiKey  string
}

type TemplateFuncMap = template.FuncMap

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 {
	Kit string `yaml:"kit"`

	Type string `yaml:"type"`

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

	Condition *ToolCondition `yaml:"condition"`

	Body string `yaml:"body"`
}

type ToolDescriptor struct {
	Name        string
	Description string
	Parameters  map[string]any

	Body string
}

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

	// func | system | remote
	Type string

	State State

	// func name
	Name        string
	Description string
	Parameters  map[string]any

	Body string

	//
	Config *ToolsConfig
}

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

type ToolsConfig struct {
	// kit name
	Kit string `yaml:"kit"`

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

	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"`
	Command string `json:"command"`

	// 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
}