vo

type About struct {
	Base

	Name      string   `json:"name"`
	Title     string   `json:"title"`
	Copyright string   `json:"copyright"`
	Profile   string   `json:"profile"`
	User      string   `json:"user"`
	Home      string   `json:"home"`
	OS        string   `json:"os"`
	Arch      string   `json:"arch"`
	WebURL    string   `json:"weburl"`
	SHA256SUM util.Hex `json:"sha256sum"`

	// the main module
	Module     string     `json:"module"`
	Version    string     `json:"version"`
	Revision   int        `json:"revision"`
	MainModule dto.Module `json:"main_module"`

	Modules []*dto.Module `json:"modules"`

	CheckUpdate *AboutCheckUpdate `json:"checkupdate"`
}

type AboutCheckUpdate struct {

	// params
	Auto  bool `json:"auto"`  // 自动检查
	Force bool `json:"force"` // 必须检查

	// results
	Current       *dto.SoftwarePackage `json:"current"`         // 当前使用的版本
	Latest        *dto.SoftwarePackage `json:"latest"`          // 最新的版本
	Ignore        *dto.SoftwarePackage `json:"ignore"`          // 已忽略的版本
	HasNewVersion bool                 `json:"has_new_version"` // 检查结果
	HasIgnored    bool                 `json:"has_ignored"`     // 检查结果
}

type Auth struct {
	Base

	UserName   string
	UserSecret string
	Mechanism  string

	Authorized bool
}

type Backup struct {
	Base

	Backups []*dto.Backup `json:"backups"`
}

type Base struct {
	vo.BaseVO

	Head BaseHead `json:"head"`
}

type BaseHead struct {
	URL       string `json:"url"`       // 的所属文档的 URL
	Namespace string `json:"namespace"` // 默认的命名空间名称
	DocType   string `json:"doctype"`   // 该文档的类型
}

type ContentType struct {
	Base

	ContentTypes []*dto.ContentType `json:"content_types"`
}

type ContentTypeImport struct {
	Base

	ContentTypes []*dto.ContentType `json:"content_types"`
}

type Example struct {
	Base

	Examples []*dto.Example `json:"examples"`
}

type Executable struct {
	Base

	OptionSkipFileChecking bool `json:"option_skip_file_checking"`

	Executables []*dto.Executable `json:"executables"`
}

type ExecutableImport struct {
	Base

	Action      ExecutableImportAction `json:"action"`
	Executables []*dto.Executable      `json:"executables"`
}

type ExecutableImportAction string

type FileQuery struct {
	Base

	BaseURL    string                `json:"base"` // 'file:///' or 'repository:///'
	Repository dxo.LocalRepositoryID `json:"repository"`

	Branch string `json:"branch"` // the git branch name
	Commit string `json:"commit"` // the git commit id
	Tag    string `json:"tag"`    // the git tag name
	Path   string `json:"path"`   // the path for filesystem or worktree

	Self dto.File `json:"self"`

	Items []*dto.File `json:"items"`
}

type Init struct {
	Base

	// check-update
	CheckUpdate About

	// check-setup
	Setup Setup

	// fetch Content types
	ContentType ContentType

	// fetch executables
	Executable Executable

	// fetch options
	Option Option
}

type Intent struct {
	Base

	Intents []*dto.Intent `json:"intents"`
}

type IntentTemplate struct {
	Base

	Templates  []*dto.IntentTemplate `json:"intent_templates"`
	MacroProps map[string]string     `json:"macro_properties"`
}

type LocalRepository struct {
	Base

	Repositories []*dto.LocalRepository `json:"local_repositories"`
}

type MIMEType struct {
	Base

	Types []*dto.MIMEType `json:"types"`
}

type MainRepository struct {
	Base

	Repository *dto.MainRepository `json:"main_repository"`
}

type Media struct {
	Base

	Mediae []*dto.Media `json:"mediae"`
}

type Namespace struct {
	Base

	Namespaces []*dto.Namespace `json:"namespaces"`
}

type Online struct {
	Base

	Sources         []*dto.Namespace       `json:"sources"`
	Packages        []*dto.SoftwarePackage `json:"packages"`
	Mediae          []*dto.Media           `json:"mediae"`
	Executables     []*dto.Executable      `json:"executables"`
	ContentTypes    []*dto.ContentType     `json:"contenttypes"`
	IntentTemplates []*dto.IntentTemplate  `json:"intenttemplates"`
}

type Option struct {
	Base

	Options map[string]bool `json:"options"`
}

type Platform struct {
	Base

	Platform *dto.Platform `json:"platform"`
}

type Profile struct {
	Base

	Platform *dto.Platform `json:"platform"`
	Profile  *dto.Profile  `json:"profile"`
}

type Project struct {
	Base

	Projects []*dto.Project `json:"projects"`
}

type ProjectImport struct {
	Base

	Action   ProjectImportAction `json:"action"`
	Projects []*dto.Project      `json:"projects"`
}

type ProjectImportAction string

type RemoteRepository struct {
	Base

	Repositories []*dto.RemoteRepository `json:"remote_repositories"`
}

type RepositoryImport struct {
	Base

	Action RepositoryImportAction `json:"action"`
	Items  []*dto.LocalRepository `json:"local_repositories"`
}

type RepositoryImportAction string

type RepositoryWorktreeProject struct {
	Base

	Path string `json:"path"`

	Repository *dto.LocalRepository `json:"repository"`
	Worktree   *dto.Worktree        `json:"worktree"`
	Project    *dto.Project         `json:"project"`
}

type Settings struct {
	Base

	Settings *dto.Settings `json:"settings"`

	Table map[string]string `json:"table"`
}

type Setup struct {
	Base

	SetupRequired bool `json:"setup_required"`

	SetupItems []*dto.Setup `json:"setup_items"`
}

type SoftwarePackage struct {
	Base

	Packages []*dto.SoftwarePackage `json:"packages"`
}

type SoftwareSet struct {
	Base

	Sets []*dto.SoftwareSet `json:"sets"`
}

type Statistic struct {
	Base

	Statistics dto.Statistic `json:"statistics"`
}

type Trash struct {
	Base

	TrashItems []*entity.Holder `json:"trash_items"`
}

type User struct {
	Base

	Users []*dto.User `json:"users"`
}

type Worktree struct {
	Base

	Worktrees []*dto.Worktree `json:"worktrees"`
}