shared

type Account interface {
	// Unique ID for account.
	ID() RepositoryID

	// Account remote.
	RemoteName() RemoteName

	// Any text specified by the user so that he can distinguish one account from another.
	Alias() string

	// Set account alias.
	SetAlias(string) error

	// Account auth data like json tokens.
	Auth() string

	// Set account auth.
	SetAuth(string) error

	// Actions from remote account.
	Actions() (AccountActions, error)

	// Account settings.
	Settings() (AccountSettings, error)

	// Time when account was added.
	AddedAt() time.Time

	// Delete account from repository.
	Delete() error

	Repository() (RemoteRepository, error)
}

type AccountActions interface {
	LikedAlbums() LikedActions
	LikedArtists() LikedActions
	LikedTracks() LikedActions
	Playlist() PlaylistActions
}

type AccountSettings interface {
	// Liked albums synchronization.
	LikedAlbums() SynchronizationSettings

	// Liked artists synchronization.
	LikedArtists() SynchronizationSettings

	// Liked tracks synchronization.
	LikedTracks() SynchronizationSettings

	// Playlists synchronization.
	Playlists() SynchronizationSettings

	Playlist(playlistID EntityID) (PlaylistSyncSettings, error)
}

type EntityID RepositoryID

type EntityType string

type ErrAccountNotExists struct {
	Prefix,
	ID string
}

type ErrNoAvailableRemotes struct {
	Prefix string
}

type ErrRemoteNotFound struct {
	Prefix string
	Name   RemoteName
}

type ErrSnapshotNotFound struct {
	Prefix,
	ID string
}

type Event string

type LikedActions interface {
	// Examples: get liked artists.
	Liked(context.Context) (map[RemoteID]RemoteEntity, error)

	// Examples: like artists.
	Like(ctx context.Context, ids []RemoteID) error

	// Examples: unlike artists.
	Unlike(ctx context.Context, ids []RemoteID) error
}

type PlaylistActions interface {
	// Get user playlists.
	MyPlaylists(context.Context) (map[RemoteID]RemotePlaylist, error)

	// Create playlist.
	Create(ctx context.Context, name string, isVisible bool, description *string) (RemotePlaylist, error)

	// Delete my playlists.
	Delete(ctx context.Context, entities []RemoteID) error

	// Get playlist by ID.
	Playlist(context.Context, RemoteID) (RemotePlaylist, error)
}

type PlaylistSyncSettings interface {
	Name() SynchronizationSettings
	Description() SynchronizationSettings
	Visibility() SynchronizationSettings
	Tracks() SynchronizationSettings
}

type Remote interface {
	// Provides repository for interacting with various things.
	//
	// Called once, after starting the program.
	Boot(RemoteRepository) error

	// Unique remote name.
	Name() RemoteName

	// Get repository.
	Repository() RemoteRepository

	// Assign actions for account.
	AssignAccountActions(Account) (AccountActions, error)

	// Get actions for remote.
	//
	// Example: take one of the accounts, and perform this actions from it.
	Actions() (RemoteActions, error)

	// Get url to entity.
	EntityURL(etype EntityType, id RemoteID) url.URL
}

type RemoteActions interface {
	// Get artist by ID.
	Artist(context.Context, RemoteID) (RemoteArtist, error)

	// Get track by ID.
	Track(context.Context, RemoteID) (RemoteTrack, error)

	// Get album by ID.
	Album(context.Context, RemoteID) (RemoteAlbum, error)

	// Search albums.
	SearchAlbums(context.Context, RemoteAlbum) ([10]RemoteAlbum, error)

	// Search artists.
	SearchArtists(context.Context, RemoteArtist) ([10]RemoteArtist, error)

	// Search tracks.
	SearchTracks(context.Context, RemoteTrack) ([10]RemoteTrack, error)
}

type RemoteAlbum interface {
	RemoteEntity

	// https://en.wikipedia.org/wiki/Universal_Product_Code
	UPC() *string

	// https://en.wikipedia.org/wiki/International_Article_Number
	EAN() *string

	Artists() []RemoteArtist

	TrackCount() int

	// Release year.
	Year() int

	// Cover (prefer 100x100).
	CoverURL() *url.URL
}

type RemoteArtist interface {
	RemoteEntity

	// Albums names (oldest first).
	OldestAlbumsNames(ctx context.Context) ([20]string, error)

	// Singles names (oldest first).
	OldestSinglesNames(ctx context.Context) ([20]string, error)
}

type RemoteEntity interface {
	// Example: Spotify.
	RemoteName() RemoteName

	// Example: Spotify artist ID.
	ID() RemoteID

	// Example: Spotify artist name.
	Name() string
}

type RemoteID string

type RemoteIDSlice[T comparable] []RemoteID

type RemoteName string

type RemotePlaylist interface {
	RemoteEntity

	FromAccount() Account

	// Should be nil only if remote doesn't support set descriptions.
	Description() *string

	// Playlist tracks.
	Tracks(context.Context) (map[RemoteID]RemoteTrack, error)

	// Rename playlist.
	Rename(context.Context, string) error

	// Set playlist description.
	SetDescription(context.Context, string) error

	// Add tracks to playlist.
	AddTracks(context.Context, []RemoteID) error

	// Remove tracks from playlist.
	RemoveTracks(context.Context, []RemoteID) error

	// Is playlist visible?
	//
	// Can return error only if remote doesn't support vis.
	IsVisible() (bool, error)

	// Set playlist visibility. True = visible.
	SetIsVisible(context.Context, bool) error
}

type RemoteRepository interface {
	// Unique ID.
	ID() RepositoryID

	// Remote enabled? Not enabled remotes will be excluded from sync/linker/etc.
	Enabled() bool

	SetEnabled(bool) error

	// Remote name.
	Name() RemoteName

	// Alias: any text specified by the user so that he can distinguish one account from another.
	//
	// Auth: any auth like json tokens.
	//
	// After creating the account, the AssignActions method will be called in the remote.
	CreateAccount(alias string, auth string) (Account, error)

	// All accounts in remote.
	Accounts(ctx context.Context) ([]Account, error)

	// Get account by ID. Returns nil, nil if account not found.
	Account(id RepositoryID) (Account, error)

	// Global remote actions.
	Actions() (RemoteActions, error)
}

type RemoteTrack interface {
	RemoteEntity

	// https://en.wikipedia.org/wiki/International_Standard_Recording_Code
	ISRC() *string

	Artists() []RemoteArtist

	Album() (RemoteAlbum, error)

	// Length of track in ms.
	LengthMs() int

	// Release year.
	Year() int

	// Cover (prefer 100x100).
	CoverURL() *url.URL
}

type RepositoryID string

type SynchronizationSettings interface {
	// Synchronization enabled?
	Synchronize() bool

	// Enable/disable synchronization.
	SetSynchronize(bool) error

	// Last account synchronization (nanoseconds).
	LastSynchronization() time.Time

	// Set last account synchronization (nanoseconds).
	//
	// Do not use this method in the UI and similar places. It is only needed for the synchronizer.
	SetLastSynchronization(time.Time) error
}