models

type AdditionalInfo map[string]any

type Backend interface {
	// Return the name of the interface
	Name() string

	// Initialize the backend from a config.
	InitConfig(config *config.ServiceConfig) error

	// Return configuration options
	Options() []BackendOption

	// Free all resources of the backend
	Close()
}

type BackendOption struct {
	Name        string
	Label       string
	Type        OptionType
	Default     string
	Validate    func(string) error
	MigrateFrom string
}

type Entity string

type ExportResult[T LovesList | ListensList] struct {
	Items           T
	Total           int
	OldestTimestamp time.Time
	Error           error
}

type ImportBackend interface {
	Backend

	// If the backend needs to setup resources before starting to import,
	// this can be done here.
	StartImport() error

	// The implementation can perform all steps here to finalize the
	// export/import and free used resources.
	FinishImport(result *ImportResult) error
}

type ImportResult struct {
	TotalCount    int
	ImportCount   int
	LastTimestamp time.Time
	ImportLog     []LogEntry

	// Error is only set if an unrecoverable import error occurred
	Error error
}

type JSONLFile[T any] struct {
	File archive.OpenableFile
}

type Listen struct {
	Track
	ListenedAt       time.Time
	PlaybackDuration time.Duration
	UserName         string
	Skipped          bool
}

type ListensExport interface {
	Backend

	// Returns a list of all listens newer then oldestTimestamp.
	// The returned list of listens is supposed to be ordered by the
	// Listen.ListenedAt timestamp, with the oldest entry first.
	ExportListens(ctx context.Context, oldestTimestamp time.Time, results chan ListensResult, progress chan TransferProgress)
}

type ListensImport interface {
	ImportBackend

	// Imports the given list of listens.
	ImportListens(ctx context.Context, export ListensResult, importResult ImportResult, progress chan TransferProgress) (ImportResult, error)
}

type ListensList []Listen

type ListensResult ExportResult[ListensList]

type LogEntry struct {
	Type    LogEntryType
	Message string
}

type LogEntryType string

type Love struct {
	Track
	Created       time.Time
	UserName      string
	RecordingMBID mbtypes.MBID
	RecordingMSID mbtypes.MBID
}

type LovesExport interface {
	Backend

	// Returns a list of all loves newer then oldestTimestamp.
	// The returned list of listens is supposed to be ordered by the
	// Love.Created timestamp, with the oldest entry first.
	ExportLoves(ctx context.Context, oldestTimestamp time.Time, results chan LovesResult, progress chan TransferProgress)
}

type LovesImport interface {
	ImportBackend

	// Imports the given list of loves.
	ImportLoves(ctx context.Context, export LovesResult, importResult ImportResult, progress chan TransferProgress) (ImportResult, error)
}

type LovesList []Love

type LovesResult ExportResult[LovesList]

type OptionType string

type Progress struct {
	TotalItems int
	Total      int64
	Elapsed    int64
	Completed  bool
	Aborted    bool
}

type Track struct {
	TrackName        string
	ReleaseName      string
	ArtistNames      []string
	TrackNumber      int
	DiscNumber       int
	Duration         time.Duration
	ISRC             mbtypes.ISRC
	RecordingMBID    mbtypes.MBID
	ReleaseMBID      mbtypes.MBID
	ReleaseGroupMBID mbtypes.MBID
	ArtistMBIDs      []mbtypes.MBID
	WorkMBIDs        []mbtypes.MBID
	Tags             []string
	AdditionalInfo   AdditionalInfo
}

type TransferProgress struct {
	Export *Progress
	Import *Progress
}