types

Documentation

Overview

THIS FILE IS GENERATED BY PYRIN GOGEN CODE GENERATOR

Index

• Constants
• Variables
• type Album
• type ApiError
  • func NewApiError(code int, message string, errors ...any) *ApiError
  • func (err *ApiError) Error() string
• type ApiResponse
  • func NewApiSuccessResponse(data any) ApiResponse
• type Artist
• type Change
• type DeletePlaylistItemsByIdBody
• type GetAlbumById
• type GetAlbumTracksById
• type GetAlbums
• type GetArtistAlbumsById
• type GetArtistById
• type GetArtists
• type GetAuthMe
• type GetPlaylistById
• type GetPlaylists
• type GetSync
• type GetSystemInfo
• type GetTags
• type GetTrackById
• type GetTracks
• type Map
• type Playlist
• type PostAuthSignin
• type PostAuthSigninBody
• type PostAuthSignup
• type PostAuthSignupBody
• type PostPlaylist
• type PostPlaylistBody
• type PostPlaylistItemsByIdBody
• type PostPlaylistsItemMoveByIdBody
• type PostQueue
• type PostSystemSetupBody
• type Tag
• type Track
• type WorkDir
  • func (d WorkDir) DatabaseFile() string
  • func (d WorkDir) ImagesDir() string
  • func (d WorkDir) MobileTracksDir() string
  • func (d WorkDir) OriginalTracksDir() string
  • func (d WorkDir) String() string
  • func (d WorkDir) TranscodeDir() string

Constants

const (
	StatusSuccess = "success"
	StatusError   = "error"
)

Variables

var (
	ErrNoArtist   = NewApiError(http.StatusNotFound, "Artist not found")
	ErrNoAlbum    = NewApiError(http.StatusNotFound, "Album not found")
	ErrNoTrack    = NewApiError(http.StatusNotFound, "Track not found")
	ErrNoPlaylist = NewApiError(http.StatusNotFound, "Playlist not found")

	ErrInvalidAuthHeader = NewApiError(http.StatusUnauthorized, "Invalid Auth Header")
	ErrInvalidToken      = NewApiError(http.StatusUnauthorized, "Invalid Token")
	ErrIncorrectCreds    = NewApiError(http.StatusUnauthorized, "Incorrect credentials")

	ErrEmptyBody = NewApiError(http.StatusBadRequest, "Expected body not to be empty")
)

var DeletePlaylistItemsByIdBodySchema = jio.Object().Keys(jio.K{
	"trackIndices": jio.Array().Items(jio.Number().Integer()).Min(1).Required(),
})

var PostAuthSigninBodySchema = jio.Object().Keys(jio.K{
	"username": jio.String().Required(),
	"password": jio.String().Required(),
})

var PostAuthSignupBodySchema = jio.Object().Keys(jio.K{
	"username":        jio.String().Min(4).Required(),
	"password":        jio.String().Min(8).Required(),
	"passwordConfirm": jio.String().Min(8).Required(),
})

var PostPlaylistBodySchema = jio.Object().Keys(jio.K{
	"name": jio.String().Required(),
})

var PostPlaylistItemsByIdBodySchema = jio.Object().Keys(jio.K{
	"tracks": jio.Array().Items(jio.String()).Min(1).Required(),
})

var PostPlaylistsItemMoveByIdBodySchema = jio.Object().Keys(jio.K{
	"trackId": jio.String().Required(),
	"toIndex": jio.Number().Integer().Required(),
})

var PostSystemSetupBodySchema = jio.Object().Keys(jio.K{
	"username":        jio.String().Required(),
	"password":        jio.String().Required(),
	"passwordConfirm": jio.String().Required(),
})

Types

type Album

type Album struct {
	Id       string `json:"id"`
	Name     string `json:"name"`
	CoverArt string `json:"coverArt"`
	ArtistId string `json:"artistId"`
}

type ApiError

type ApiError struct {
	Code    int    `json:"code"`
	Message string `json:"message"`
	Errors  any    `json:"errors,omitempty"`
}

func NewApiError

func NewApiError(code int, message string, errors ...any) *ApiError

func (*ApiError) Error

func (err *ApiError) Error() string

type ApiResponse

type ApiResponse struct {
	Status string    `json:"status"`
	Data   any       `json:"data,omitempty"`
	Error  *ApiError `json:"error,omitempty"`
}

func NewApiSuccessResponse

func NewApiSuccessResponse(data any) ApiResponse

type Artist

type Artist struct {
	Id      string `json:"id"`
	Name    string `json:"name"`
	Picture string `json:"picture"`
}

type Change

type Change[T any] struct {
	Value   T
	Changed bool
}

type DeletePlaylistItemsByIdBody

type DeletePlaylistItemsByIdBody struct {
	TrackIndices []int `json:"trackIndices"`
}

type GetAlbumById

type GetAlbumById struct {
	Album
}

type GetAlbumTracksById

type GetAlbumTracksById struct {
	Tracks []Track `json:"tracks"`
}

type GetAlbums

type GetAlbums struct {
	Albums []Album `json:"albums"`
}

type GetArtistAlbumsById

type GetArtistAlbumsById struct {
	Albums []Album `json:"albums"`
}

type GetArtistById

type GetArtistById struct {
	Artist
}

type GetArtists

type GetArtists struct {
	Artists []Artist `json:"artists"`
}

type GetAuthMe

type GetAuthMe struct {
	Id       string `json:"id"`
	Username string `json:"username"`
}

type GetPlaylistById

type GetPlaylistById struct {
	Playlist

	Items []Track `json:"items"`
}

type GetPlaylists

type GetPlaylists struct {
	Playlists []Playlist `json:"playlists"`
}

type GetSync

type GetSync struct {
	IsSyncing bool `json:"isSyncing"`
}

type GetSystemInfo

type GetSystemInfo struct {
	Version string `json:"version"`
	IsSetup bool   `json:"isSetup"`
}

type GetTags

type GetTags struct {
	Tags []Tag `json:"tags"`
}

type GetTrackById

type GetTrackById struct {
	Track
}

type GetTracks

type GetTracks struct {
	Tracks []Track `json:"tracks"`
}

type Map

type Map map[string]any

type Playlist

type Playlist struct {
	Id   string `json:"id"`
	Name string `json:"name"`
}

type PostAuthSignin

type PostAuthSignin struct {
	Token string `json:"token"`
}

type PostAuthSigninBody

type PostAuthSigninBody struct {
	Username string `json:"username"`
	Password string `json:"password"`
}

type PostAuthSignup

type PostAuthSignup struct {
	Id       string `json:"id"`
	Username string `json:"username"`
}

type PostAuthSignupBody

type PostAuthSignupBody struct {
	Username        string `json:"username"`
	Password        string `json:"password"`
	PasswordConfirm string `json:"passwordConfirm"`
}

type PostPlaylist

type PostPlaylist struct {
	Playlist
}

type PostPlaylistBody

type PostPlaylistBody struct {
	Name string `json:"name"`
}

type PostPlaylistItemsByIdBody

type PostPlaylistItemsByIdBody struct {
	Tracks []string `json:"tracks"`
}

type PostPlaylistsItemMoveByIdBody

type PostPlaylistsItemMoveByIdBody struct {
	TrackId string `json:"trackId"`
	ToIndex int    `json:"toIndex"`
}

type PostQueue

type PostQueue struct {
	Tracks []Track `json:"tracks"`
}

type PostSystemSetupBody

type PostSystemSetupBody struct {
	Username        string `json:"username"`
	Password        string `json:"password"`
	PasswordConfirm string `json:"passwordConfirm"`
}

type Tag

type Tag struct {
	Id   string `json:"id"`
	Name string `json:"name"`
}

type Track

type Track struct {
	Id                string `json:"id"`
	Number            int    `json:"number"`
	Name              string `json:"name"`
	CoverArt          string `json:"coverArt"`
	Duration          int    `json:"duration"`
	BestQualityFile   string `json:"bestQualityFile"`
	MobileQualityFile string `json:"mobileQualityFile"`
	AlbumId           string `json:"albumId"`
	ArtistId          string `json:"artistId"`
	AlbumName         string `json:"albumName"`
	ArtistName        string `json:"artistName"`
}

type WorkDir

type WorkDir string

func (WorkDir) DatabaseFile

func (d WorkDir) DatabaseFile() string

func (WorkDir) ImagesDir

func (d WorkDir) ImagesDir() string

func (WorkDir) MobileTracksDir

func (d WorkDir) MobileTracksDir() string

func (WorkDir) OriginalTracksDir

func (d WorkDir) OriginalTracksDir() string

func (WorkDir) String

func (d WorkDir) String() string

func (WorkDir) TranscodeDir

func (d WorkDir) TranscodeDir() string