types

type AIChatSettings struct {
	ApiKey   *string // the API key if available
	Provider string  // the provider like "ollama" or "openai"
}

type AIEditor struct {
	App          *AppContext     // the underlying application context
	ChatEditor   *tview.TextArea // the chat editor TextArea
	ChatHistory  *tview.List     // the chat history
	CreateButton *tview.Button   // the "create" button
	FileViewer   *tview.TextView // the viewer for file content
	InfoLeft     *tview.TextView // the last info

	OnCreateClick func() error                   // the callback that is executed then "create" button is "clicked"/"pressed"
	OnResetClick  func() error                   // the callback that is executed then "reset" button is "clicked"/"pressed"
	OnSendClick   func(chatMessage string) error // the callback that is executed then "send" button is "clicked"/"pressed"
	ProjectUrl    string                         // the URL of the new project, which is also the module name
	ResetButton   *tview.Button                  // the "reset" button
	Root          tview.Primitive                // the root element in the UI
	SendButton    *tview.Button                  // the "send" button
	Tree          *tview.TreeView                // the file tree
	TreeNodes     []*AIEditorFileTreeNode        // all current file tree nodes
	UI            *tview.Application             // the UI / App
	// contains filtered or unexported fields
}

type AIEditorFileItem struct {
	Content []byte // the content
	Name    string // the name/relative path of the file
}

type AIEditorFileTreeNode struct {
	Content  []byte                  // content
	Children []*AIEditorFileTreeNode // the children
	Name     string                  // the name/relative path of the file
	Node     *tview.TreeNode         // the node in the view
	Parent   *AIEditorFileTreeNode   // the parent
	Type     string                  // the type: `dir`, `file` or `root`
}

type AIPrompts struct {
	Prompt       string  // the prompt
	SystemPrompt *string // the system prompt, if defined
}

type AliasesFile struct {
	Aliases map[string][]string `yaml:"aliases"` // one or more aliases and their sources
}

type AppContext struct {
	AliasesFile      AliasesFile  // aliases.yaml file in home folder
	AliasesFilePath  string       // custom file path of the `aliases.yaml` file from CLI flags
	Clipboard        Clipboard    // clipboard
	Cwd              string       // current working directory
	EnvFiles         []string     // one or more env files
	Environment      string       // the name of the environment
	ErrorOut         io.Writer    // error output
	GpmFile          GpmFile      // the gpm.y(a)ml file
	GpmRootPath      string       // custom app root path from CLI flags
	In               *os.File     // the input stream
	IsCI             bool         // indicates if app runs in CI environment like GitHub action or GitLab runner
	L                *log.Logger  // the logger to use
	Model            string       // custom model from CLI flags
	NoPreScript      bool         // if the command supports "pre scripts" from gpm.yaml file, the flag indicates not to use it, if `true`
	NoPostScript     bool         // if the command supports "post scripts" from gpm.yaml file, the flag indicates not to use it, if `true`
	NoScript         bool         // if the command supports scripts from gpm.yaml file, the flag indicates not to use it, if `true`
	NoSystemPrompt   bool         // do not use system prompt
	Ollama           bool         // use Ollama
	Out              io.Writer    // the output stream
	ProjectsFile     ProjectsFile // projects.yaml file in home folder
	ProjectsFilePath string       // custom file path of the `projects.yaml` file from CLI flags
	Prompt           string       // custom (AI) prompt
	SettingsFile     SettingsFile // settings.yaml file
	SettingsFilePath string       // custom settings file
	SystemPrompt     string       // custom system prompt
	Temperature      float32      // temperature value for AI chats from CLI flags
	Verbose          bool         // output verbose information
}

type BumpProjectVersionOptions struct {
	Arguments *[]string // additional arguments for git command
	Breaking  *bool     // increase major part
	Feature   *bool     // increase minor part
	Fix       *bool     // increase patch part
	Force     *bool     // force bump even if latest version is newer
	Major     *int64    // if defined, the initial value for new major part
	Message   *string   // the custom git message
	Minor     *int64    // if defined, the initial value for minor part
	Patch     *int64    // if defined, the initial value for patch part
}

type ChatAI interface {
	// ChatAI.AddToHistory() - adds an entry to history
	AddToHistory(role string, content string)
	// ChatAI.ClearHistory() - clears chat history
	ClearHistory()
	// ChatAI.DescribeImage() - describes an image without adding using history
	DescribeImage(message string, dataURI string) (DescribeImageResponse, error)
	// ChatAI.GetModel() - get the name of the chat model
	GetModel() string
	// ChatAI.GetMoreInfo() - returns additional information, if available
	GetMoreInfo() string
	// ChatAI.GetPromptSuffix() - returns additional suffix for an input prompt, if available
	GetPromptSuffix() string
	// ChatAI.GetProvider() - get the name of the chat provider
	GetProvider() string
	// ChatAI.SendMessage() - sends a new message
	// to the API for the current chat conversation
	SendMessage(message string, onUpdate ChatAIMessageChunkReceiver) error
	// ChatAI.SendPrompt() - sends a single completion prompt
	SendPrompt(prompt string, onUpdate ChatAIMessageChunkReceiver) error
	// ChatAI.SendMessage() - switches the model
	UpdateModel(modelName string)
	// ChatAI.UpdateSystem() - clears chat history and sets the
	// system prompt
	UpdateSystem(systemPromt string)
	// ChatAI.UpdateSystem() - sets up new temperature value
	UpdateTemperature(newValue float32)
	// WithJsonSchema() - sends a message with a JSON schema
	WithJsonSchema(message string, schemaName string, schema map[string]interface{}, onUpdate ChatAIMessageChunkReceiver) error
}

type ChatAIMessageChunkReceiver = func(messageChunk string) error

type ChatWithAIOption struct {
	Model        *string  // custom model
	SystemPrompt *string  // custom system prompt
	Temperature  *float32 // custom temperature
}

type ChromaSettings struct {
	Formatter string // name of the formatter
	Style     string // name of the style
	// contains filtered or unexported fields
}

type Clipboard interface {
	// ReadText() - reads text from clipboard
	ReadText() (string, error)

	// WriteText() - writes text to clipboard
	WriteText(s string) error
}

type CreateAIChatOptions struct {
	Model        *string // custom model
	SystemPrompt *string // custom system prompt
	Temperature  *int    // custom temperature
}

type DescribeImageResponse struct {
	Description string `json:"description" yaml:"description"` // the long description for aria-description maybe
	Label       string `json:"label" yaml:"label"`             // the label for aria-label maybe
}

type GenerateProjectStepsResponse struct {
	// the final summary from the AI
	FinalSummary string `json:"final_summary,omitempty"`
	// The steps
	Steps []map[string]interface{} `json:"steps,omitempty"`
}

type GetSettingOptions struct {
	DoNotTrimEnvValues *bool // `true` if not trimming env values
}

type GoModule struct {
	Indirect *bool   `json:"Indirect,omitempty"` // indirect module or not
	Path     *string `json:"Path,omitempty"`     // the path
	Version  *string `json:"Version,omitempty"`  // the version
}

type GpmFile struct {
	Contributors []GpmFileContributor   `yaml:"contributors,omitempty"` // list of contributors
	Description  string                 `yaml:"description,omitempty"`  // the description
	DisplayName  string                 `yaml:"display_name,omitempty"` // the display name
	Donations    map[string]string      `yaml:"donations,omitempty"`    // one or more donation links
	Environment  map[string]string      `yaml:"environment,omitempty"`  // environment variables
	Files        []string               `yaml:"files,omitempty"`        // whitelist of file patterns which are used by pack command for example
	Homepage     string                 `yaml:"homepage,omitempty"`     // the homepage
	License      string                 `yaml:"license,omitempty"`      // the license
	Name         string                 `yaml:"name,omitempty"`         // the name
	Repositories []GpmFileRepository    `yaml:"repositories,omitempty"` // source code repository information
	Scripts      map[string]string      `yaml:"scripts,omitempty"`      // one or more scripts
	Settings     map[string]interface{} `yaml:"settings,omitempty"`     // custom settings
	// contains filtered or unexported fields
}

type GpmFileContributor struct {
	Homepage string `yaml:"homepage,omitempty"` // the homepage url
	Name     string `yaml:"name,omitempty"`     // the full name
	Role     string `yaml:"role,omitempty"`     // the role
}

type GpmFileRepository struct {
	Name string `yaml:"name,omitempty"` // the full name
	Type string `yaml:"type,omitempty"` // the type
	Url  string `yaml:"url,omitempty"`  // the url
}

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

type OllamaAIChat struct {
	Conversation []OllamaAIChatMessage // the conversation
	Model        string                // the current model
	SystemPrompt string                // the current system prompt
	Temperature  float32               // the current temperature
	Verbose      bool                  // running in verbose mode or not
}

type OllamaAIChatMessage struct {
	Content string `json:"content,omitempty"` // the message content
	Role    string `json:"role,omitempty"`    // the role like user, assistant or system
}

type OllamaApiChatCompletionResponse struct {
	Message OllamaAIChatMessage `json:"message,omitempty"` // the message
}

type OllamaApiCompletionResponse struct {
	Response string `json:"response,omitempty"` // the message
}

type OllamaGenerateResponse struct {
	Model    string `json:"model"`    // used model
	Response string `json:"response"` // the response
}

type OpenAIChat struct {
	ApiKey       string              // the API key to use
	Conversation []OpenAIChatMessage // the conversation
	Model        string              // the current model
	SystemPrompt string              // the current system prompt
	Temperature  float32             // the current temperature
	TotalTokens  int32               // number of total used tokens in this session
	Verbose      bool                // running in verbose mode or not
}

type OpenAIChatCompletionResponseV1 struct {
	Choices []OpenAIChatCompletionResponseV1Choice `json:"choices"` // list of choices
	Model   string                                 `json:"model"`   // used model
	Usage   OpenAIChatCompletionResponseV1Usage    `json:"usage"`   // the usage
}

type OpenAIChatCompletionResponseV1Choice struct {
	Index   int32                                       `json:"index"`   // the zero-based index
	Message OpenAIChatCompletionResponseV1ChoiceMessage `json:"message"` // the message information
}

type OpenAIChatCompletionResponseV1ChoiceMessage struct {
	Content string `json:"content"` // the message context
	Role    string `json:"role"`    // the role like 'user' or 'assistant'
}

type OpenAIChatCompletionResponseV1Usage struct {
	CompletionTokens int32 `json:"completion_tokens"` // number of completion tokens
	PromptTokens     int32 `json:"prompt_tokens"`     // number of prompt tokens
	TotalTokens      int32 `json:"total_tokens"`      // number of total used tokens
}

type OpenAIChatMessage struct {
	Content string `json:"content,omitempty"` // the message content
	Role    string `json:"role,omitempty"`    // the role like user, assistant or system
}

type OsvDevResponse struct {
	Vulnerabilities *[]OsvDevResponseVulnerabilityItem `json:"vulns,omitempty"` // list of vulnerabilities
}

type OsvDevResponseVulnerabilityItem struct {
	DatabaseSpecific *OsvDevResponseVulnerabilityItemDataSpecificInfo `json:"database_specific,omitempty"` // database specific information
	Details          string                                           `json:"details,omitempty"`           // details
	Id               string                                           `json:"id,omitempty"`                // ID
	ModifiedDate     string                                           `json:"modified,omitempty"`          // modification date
	PublishedDate    string                                           `json:"published,omitempty"`         // publish date
	References       *[]OsvDevResponseVulnerabilityItemReference      `json:"references,omitempty"`        // list of references
	Severity         *[]OsvDevResponseVulnerabilitySeverityItem       `json:"severity,omitempty"`          // list of severities
	Summary          string                                           `json:"summary,omitempty"`           // summary
}

type OsvDevResponseVulnerabilityItemDataSpecificInfo struct {
	Severity string `json:"severity,omitempty"` // the severity
}

type OsvDevResponseVulnerabilityItemReference struct {
	Type string `json:"type,omitempty"` // the type
	Url  string `json:"url,omitempty"`  // the URL
}

type OsvDevResponseVulnerabilitySeverityItem struct {
	Score string `json:"score,omitempty"` // the score
	Type  string `json:"type,omitempty"`  // the type
}

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

type ProjectsFile struct {
	Projects map[string]string `yaml:"projects"` // one or more projects and their sources
}

type ReactRenderer struct {
	BodyClass       string                                 // the className for the body tag
	ContentClass    string                                 // the className for the content wrapper
	ExternalModules map[string]ReactRendererExternalModule // list of external modules
	JsModules       [][]byte                               // list of contents of JavaScript modules to include
	Jsx             [][]byte                               // list of contents of JSX modules to include
	Template        string                                 // the name of the custom template inside resources to use
	Vars            map[string]interface{}                 // variables to inject into the final HTML as JavaScript variables
}

type ReactRendererExternalModule struct {
	Type string // the type, like "module"
	Url  string // the URL
}

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

type SystemClipboard struct {
}

type TidyUpOptions struct {
	Arguments *[]string // additional command line argumuments
	NoScript  *bool     // explicit value that indicates if no `tidy` script should be run
}