service

type AboutService interface {
	GetInfo(ctx context.Context) (*vo.About, error)
}

type AppDataService interface {
	GetAppDataDirectory() string

	GetSQLiteDBFile() string

	GetMainRepositoryPath() string

	GetBackupDirectory() string

	Ready() bool

	Setup() error
}

type AppIconService interface {
}

type CheckUpdateService interface {

	// 检查更新的版本
	Check(ctx context.Context, o *vo.AboutCheckUpdate) error

	// 忽略指定的版本
	Ignore(ctx context.Context, o *vo.AboutCheckUpdate) error
}

type ContentTypeService interface {

	// 根据文件名（或路径）查询对应的mime类型
	GetContentType(name string) (string, error)
}

type DatabaseBackupService interface {
	Export(c context.Context, o *dto.Backup) (*dto.Backup, error)

	Import(c context.Context, o *dto.Backup) (*dto.Backup, error)

	ListAll(c context.Context) ([]*dto.Backup, error)
}

type ExampleService interface {
	Find(ctx context.Context, id dxo.ExampleID) (*dto.Example, error)

	ListAll(ctx context.Context) ([]*dto.Example, error)

	Insert(ctx context.Context, o *dto.Example) (*dto.Example, error)
	Update(ctx context.Context, id dxo.ExampleID, o *dto.Example) (*dto.Example, error)
	Remove(ctx context.Context, id dxo.ExampleID) error
}

type ExecutableImportService interface {
	Save(ctx context.Context, o *vo.ExecutableImport) (*vo.ExecutableImport, error)

	Locate(ctx context.Context, o *vo.ExecutableImport) (*vo.ExecutableImport, error)

	ImportPresets(ctx context.Context) error
}

type ExecutableService interface {
	Find(ctx context.Context, id dxo.ExecutableID) (*dto.Executable, error)
	FindByPath(ctx context.Context, path string) (*dto.Executable, error)
	FindByName(ctx context.Context, name string) (*dto.Executable, error)

	ListAll(ctx context.Context) ([]*dto.Executable, error)

	Insert(ctx context.Context, o *dto.Executable) (*dto.Executable, error)
	Update(ctx context.Context, id dxo.ExecutableID, o *dto.Executable) (*dto.Executable, error)
	Remove(ctx context.Context, id dxo.ExecutableID) error
}

type FileQueryService interface {
	Query(ctx context.Context, q *vo.FileQuery) (*vo.FileQuery, error)
}

type FileSystemService interface {
	FS() afs.FS

	Path(path string) afs.Path
}

type InitService interface {
	InitGet(ctx context.Context) (*vo.Init, error)

	InitSet(ctx context.Context, o *vo.Init) (*vo.Init, error)
}

type IntentHandlerService interface {
	HandleIntent(i *dto.Intent) error
}

type IntentService interface {
	Run(ctx context.Context, o *dto.Intent) (*dto.Intent, error)
}

type IntentTemplateService interface {
	Find(ctx context.Context, id dxo.IntentTemplateID) (*dto.IntentTemplate, error)

	ListAll(ctx context.Context) ([]*dto.IntentTemplate, error)

	ListMacroProperties(ctx context.Context) (map[string]string, error)

	// find items by Action & Executable & Target
	ListByAET(ctx context.Context, sel *dto.IntentTemplate) ([]*dto.IntentTemplate, error)

	Insert(ctx context.Context, o *dto.IntentTemplate) (*dto.IntentTemplate, error)

	Update(ctx context.Context, id dxo.IntentTemplateID, o *dto.IntentTemplate) (*dto.IntentTemplate, error)

	Remove(ctx context.Context, id dxo.IntentTemplateID) error

	ImportPreset(ctx context.Context) error
}

type LocalRepositoryFinder interface {
	Search(ctx context.Context, path string, depthLimit int) ([]*dto.LocalRepository, error)
	Locate(ctx context.Context, path string) (*dto.LocalRepository, error)
}

type LocalRepositoryOptions struct {
	WithFileState bool
	WithGitStatus bool
	WithProjects  bool
	All           bool
}

type LocalRepositoryService interface {
	Find(ctx context.Context, id dxo.LocalRepositoryID, opt *LocalRepositoryOptions) (*dto.LocalRepository, error)
	FindByName(ctx context.Context, name string, opt *LocalRepositoryOptions) (*dto.LocalRepository, error)
	ListAll(ctx context.Context, opt *LocalRepositoryOptions) ([]*dto.LocalRepository, error)
	ListByIds(ctx context.Context, ids []dxo.LocalRepositoryID, opt *LocalRepositoryOptions) ([]*dto.LocalRepository, error)

	Insert(ctx context.Context, o *dto.LocalRepository) (*dto.LocalRepository, error)
	Update(ctx context.Context, id dxo.LocalRepositoryID, o *dto.LocalRepository) (*dto.LocalRepository, error)
	Remove(ctx context.Context, id dxo.LocalRepositoryID) error

	ConvertEntityToDto(e *entity.LocalRepository) (*dto.LocalRepository, error)
	ConvertDtoToEntity(e *dto.LocalRepository) (*entity.LocalRepository, error)
}

type LocalRepositoryStateLoader interface {
	LoadState(ctx context.Context, repo *dto.LocalRepository) error
}

type MainRepositoryService interface {
	GetInfo(ctx context.Context) (*dto.MainRepository, error)

	GetRepository(ctx context.Context) (store.Repository, error)
}

type MediaOptions struct {
	All           bool
	WithFileState bool
}

type MediaService interface {
	Find(ctx context.Context, id dxo.MediaID, opt *MediaOptions) (*dto.Media, error)

	FindByIDs(ctx context.Context, ids []dxo.MediaID, opt *MediaOptions) ([]*dto.Media, error)

	FindByPath(ctx context.Context, path string, opt *MediaOptions) (*dto.Media, error)

	PrepareForDownload(ctx context.Context, me *dto.Media) (*dto.Media, error)

	ListAll(ctx context.Context, opt *MediaOptions) ([]*dto.Media, error)

	ImportPresets(ctx context.Context) error

	Insert(ctx context.Context, o *dto.Media) (*dto.Media, error)
	Update(ctx context.Context, id dxo.MediaID, o *dto.Media) (*dto.Media, error)
	Remove(ctx context.Context, id dxo.MediaID) error
}

type PlatformProvider interface {
	Accept(p *dto.Platform) bool
	GetProfile(p *dto.Profile) error
}

type PlatformProviderRegistration struct {
	Provider PlatformProvider
}

type PlatformProviderRegistry interface {
	GetRegistration() *PlatformProviderRegistration
}

type PlatformService interface {
	GetPlatform() (*dto.Platform, error)
	GetProvider() (PlatformProvider, error)
}

type ProfileService interface {
	GetProfile() (*dto.Profile, error)
}

type ProjectImportService interface {
	Find(ctx context.Context, o *vo.ProjectImport) (*vo.ProjectImport, error)
	FindOrLocate(ctx context.Context, o *vo.ProjectImport) (*vo.ProjectImport, error)
	Locate(ctx context.Context, o *vo.ProjectImport) (*vo.ProjectImport, error)
	Save(ctx context.Context, o *vo.ProjectImport) (*vo.ProjectImport, error)
}

type ProjectOptions struct {
	All bool

	WithFileState bool
	WithGitStatus bool
}

type ProjectService interface {
	Find(ctx context.Context, id dxo.ProjectID, options *ProjectOptions) (*dto.Project, error)
	FindByOwnerRepository(ctx context.Context, id dxo.LocalRepositoryID, options *ProjectOptions) ([]*dto.Project, error)
	ListAll(ctx context.Context, options *ProjectOptions) ([]*dto.Project, error)
	ListByIds(ctx context.Context, ids []dxo.ProjectID, options *ProjectOptions) ([]*dto.Project, error)

	Insert(ctx context.Context, o *dto.Project) (*dto.Project, error)
	Update(ctx context.Context, id dxo.ProjectID, o *dto.Project) (*dto.Project, error)
	Remove(ctx context.Context, id dxo.ProjectID) error
}

type ProjectTypeImportService interface {
	ImportTypesFromPreset(ctx context.Context) error
}

type ProjectTypeService interface {
	Find(ctx context.Context, id dxo.ProjectTypeID) (*dto.ProjectType, error)

	ListAll(ctx context.Context) ([]*dto.ProjectType, error)

	Insert(ctx context.Context, o *dto.ProjectType) (*dto.ProjectType, error)
	Update(ctx context.Context, id dxo.ProjectTypeID, o *dto.ProjectType) (*dto.ProjectType, error)
	Remove(ctx context.Context, id dxo.ProjectTypeID) error

	// LocateProject: 如果没有给出有效的参数 path，那么就用 o.FullPath 代替
	LocateProject(ctx context.Context, o *dto.Project, path string) error
}

type RemoteRepositoryService interface {
	Find(ctx context.Context, id dxo.RemoteRepositoryID) (*dto.RemoteRepository, error)
	FindByName(ctx context.Context, name string) (*dto.RemoteRepository, error)

	ListAll(ctx context.Context) ([]*dto.RemoteRepository, error)

	Insert(ctx context.Context, o *dto.RemoteRepository) (*dto.RemoteRepository, error)
	Update(ctx context.Context, id dxo.RemoteRepositoryID, o *dto.RemoteRepository) (*dto.RemoteRepository, error)
	Remove(ctx context.Context, id dxo.RemoteRepositoryID) error
}

type RepositoryImportService interface {
	Find(ctx context.Context, o *vo.RepositoryImport) (*vo.RepositoryImport, error)
	Locate(ctx context.Context, o *vo.RepositoryImport) (*vo.RepositoryImport, error)
	FindOrLocate(ctx context.Context, o *vo.RepositoryImport) (*vo.RepositoryImport, error)
	Save(ctx context.Context, o *vo.RepositoryImport) (*vo.RepositoryImport, error)
}

type SettingService interface {
	ListAll() map[string]string

	PutString(name, value string)
	GetString(name, defaultValue string) string

	PutSettings(o *dto.Settings) error
	GetSettings() (*dto.Settings, error)
}

type SetupRegistration struct {
	ID        dxo.SetupID
	Name      string
	Prototype *dto.Setup
	Handler   func(c context.Context, item *dto.Setup) error
}

type SetupService interface {
	IsSetupReqiured(ctx context.Context) (bool, error)

	ListAll(ctx context.Context) ([]*dto.Setup, error)

	Apply(ctx context.Context, items []*dto.Setup) error

	SkipAll(ctx context.Context) error
}

type UUIDGenService interface {
	GenerateUUID(seed string) dxo.UUID
}