models

type Album struct {
	MediaID      *uuid.UUID                   `json:"media_id" db:"media_id,pk,unique"`
	Name         string                       `json:"name" db:"name"`
	AlbumArtists mo.Either[[]Person, []Group] `json:"album_artists" db:"album_artists"`
	ReleaseDate  time.Time                    `json:"release_date" db:"release_date"`
	Genres       []Genre                      `json:"genres,omitempty" db:"genres"`
	Studio       Studio                       `json:"studio,omitempty" db:"studio"`
	Keywords     []string                     `json:"keywords,omitempty" db:"keywords"`
	Duration     time.Duration                `json:"duration" db:"duration"`
	Tracks       []Track                      `json:"tracks" db:"tracks"`
	Languages    []string                     `json:"languages" db:"languages,omitempty"`
}

type Book struct {
	MediaID         *uuid.UUID `json:"media_id" db:"media_id,pk,unique"`
	Title           string     `json:"title" db:"title"`
	Authors         []Person   `json:"author" db:"author"`
	Publisher       string     `json:"publisher" db:"publisher"`
	PublicationDate time.Time  `json:"publication_date" db:"publication_date"`
	Genres          []string   `json:"genres" db:"genres"`
	Keywords        []string   `json:"keywords,omitempty" db:"keywords,omitempty"`
	Languages       []string   `json:"languages" db:"languages"`
	Pages           int16      `json:"pages" db:"pages"`
	ISBN            string     `json:"isbn,omitempty" db:"isbn,unique,omitempty"`
	ASIN            string     `json:"asin,omitempty" db:"asin,unique,omitempty"`
	Cover           string     `json:"cover,omitempty" db:"cover,omitempty"`
	Summary         string     `json:"summary" db:"summary"`
}

type BookValues interface {
	[]string | string | int16 | time.Time | []Person
}

type Cast struct {
	Actors    []Person `json:"actors" db:"actors"`
	Directors []Person `json:"directors" db:"directors"`
}

type CastRating struct {
	ID       int64  `json:"_key" db:"id,pk"`
	Cast     *Cast  `json:"cast" db:"cast_id"`
	NumStars uint8  `json:"numstars" binding:"required" validate:"min=1,max=10" error:"numstars must be between 1 and 10" db:"stars" `
	UserID   uint32 `json:"userid" db:"user_id"`
}

type City struct {
	UUID    uuid.UUID `json:"uuid" db:"uuid,pk"`
	Name    string    `json:"name" db:"name"`
	Lat     float64   `json:"lat" db:"lat"`
	Lng     float64   `json:"lng" db:"lng"`
	Country *Country  `json:"country" db:"country"`
}

type Country struct {
	ID   int16  `json:"id" db:"id,pk"`
	Name string `json:"name" db:"name"`
	Code string `json:"code" db:"code"`
}

type Entity interface {
	GetID() int
}

type Episode struct {
	MediaID   *uuid.UUID    `json:"media_id" db:"media_id,pk,unique"`
	ShowID    *uuid.UUID    `json:"show_id" db:"show_id,pk,unique"`
	SeasonID  *uuid.UUID    `json:"season_id" db:"season_id,pk,unique"`
	Number    uint16        `json:"number" db:"number,autoinc"`
	Title     string        `json:"title" db:"title"`
	Season    uint16        `json:"season" db:"season"`
	Episode   uint16        `json:"episode" db:"episode"`
	AirDate   time.Time     `json:"air_date" db:"air_date"`
	Duration  time.Duration `json:"duration" db:"duration"`
	Languages []string      `json:"languages" db:"languages"`
	Plot      string        `json:"plot" db:"plot"`
}

type Film struct {
	MediaID *uuid.UUID `json:"media_id" db:"media_id,pk,unique"`
	Title   string     `json:"title" db:"title"`
	Cast    Cast       `json:"cast" db:"cast"`
	Year    int        `json:"year" db:"year"`
}

type Genre struct {
	ID          int16    `json:"id" db:"id,pk,autoinc"`
	Name        string   `json:"name" db:"name"`
	DescShort   string   `json:"desc_short" db:"desc_short"`
	DescLong    string   `json:"desc_long" db:"desc_long"`
	Keywords    []string `json:"keywords" db:"keywords"`
	ParentGenre *Genre   `json:"parent_genre omitempty" db:"parent"`
	Children    []Genre  `json:"children omitempty" db:"children"`
}

type Group struct {
	ID              int32        `json:"id" db:"id"`
	Locations       []Place      `json:"locations,omitempty" db:"locations"`
	Name            string       `json:"name" db:"name"`
	Active          bool         `json:"active" db:"active"`
	Formed          sql.NullTime `json:"formed,omitempty" db:"formed"`
	Disbanded       sql.NullTime `json:"disbanded,omitempty" db:"disbanded"`
	Website         string       `json:"website,omitempty" db:"website"`
	Photos          []string     `json:"photos,omitempty" db:"photos"`
	Works           []*uuid.UUID `json:"works,omitempty" db:"works"`
	Members         []Person     `json:"members,omitempty" db:"members"`
	PrimaryGenre    Genre        `json:"primary_genre,omitempty" db:"primary_genre_id"`
	SecondaryGenres []Genre      `json:"genres,omitempty" db:"genres"`
	Kind            string       `json:"kind,omitempty" db:"kind"` // Orchestra, Choir, Ensemble, Collective, etc.
	Added           time.Time    `json:"added" db:"added"`
	Modified        sql.NullTime `json:"modified,omitempty" db:"modified"`
	Wikipedia       string       `json:"wikipedia,omitempty" db:"wikipedia"`
	Bandcamp        string       `json:"bandcamp,omitempty" db:"bandcamp"`
	Soundcloud      string       `json:"soundcloud,omitempty" db:"soundcloud"`
	Bio             string       `json:"bio,omitempty" db:"bio"`
}

type Image struct {
	ID        int64  `json:"id" db:"id,pk,unique,autoinc"`
	Source    string `json:"source" db:"source"`
	Thumbnail string `json:"thumbnail" db:"thumbnail"`
}

type Keyword struct {
	ID      int32     `json:"_key" db:"id,pk"`
	Keyword string    `json:"keyword" db:"keyword"`
	MediaID uuid.UUID `json:"mediaid" db:"media_id"`
	Stars   uint8     `json:"stars"`
}

type KeywordStorage struct {
	// contains filtered or unexported fields
}

type KeywordStorer interface {
	CastVote(ctx context.Context, k Keyword) error
	RemoveVote(ctx context.Context, k Keyword) error
	AddKeyword(ctx context.Context, k Keyword) error
	GetKeyword(ctx context.Context, mediaID uuid.UUID) (Keyword, error)
	GetKeywords(ctx context.Context, mediaID uuid.UUID) ([]Keyword, error)
}

type LangID int16

type Media struct {
	UUID     uuid.UUID `json:"uuid" db:"uuid,pk,unique"`
	Kind     string    `json:"kind" db:"kind"`
	Name     string    `json:"name" db:"name"`
	Genres   []Genre   `json:"genres,omitempty" db:"genres"`
	Keywords []string  `json:"keywords,omitempty" db:"keywords"` // WARN: should this really be nullable?
	LangIDs  []int16   `json:"lang_ids,omitempty" db:"lang_ids"`
	Creators []Person  `json:"creators,omitempty" db:"creators"`
}

type MediaService interface {
	IsMedia() bool // dummy placeholder so that we can have somewhat idiomatic parametric polymorphism
}

type MediaStorage struct {
	// contains filtered or unexported fields
}

type MediaStorer[T any] interface {
	Get(ctx context.Context, key string) (T, error)
	GetAll() ([]T, error)
	Add(ctx context.Context, key, value T) error
	Update(ctx context.Context, key string, value T) error
	Delete(ctx context.Context, key string) error
}

type Member struct {
	ID           uint32         `json:"id" db:"id"`
	UUID         string         `json:"_key,omitempty" db:"uuid"`
	PassHash     string         `json:"passhash" db:"passhash"`
	MemberName   string         `json:"membername" db:"nick"` // i.e. @nick@instance
	DisplayName  sql.NullString `json:"displayname:omitempty" db:"display_name"`
	Email        string         `json:"email" db:"email"`
	Bio          sql.NullString `json:"bio:omitempty" db:"bio"`
	Active       bool           `json:"active" db:"active"`
	Roles        []uint8        `json:"roles" db:"roles"`
	RegTimestamp time.Time      `json:"regdate" db:"reg_timestamp"`
	ProfilePic   *Image         `json:"profilepic:omitempty" db:"profilepic_id"`
	Homepage     sql.NullString `json:"homepage:omitempty" db:"homepage"`
	IRC          sql.NullString `json:"irc:omitempty" db:"irc"`
	XMPP         sql.NullString `json:"xmpp:omitempty" db:"xmpp"`
	Matrix       sql.NullString `json:"matrix:omitempty" db:"matrix"`
}

type MemberInput struct {
	MemberName string `json:"membername"`
	Email      string `json:"email"`
	Password   string `json:"password"`
}

type MemberStorage struct {
	// contains filtered or unexported fields
}

type MemberStorer interface {
	Save(ctx context.Context, member *Member) error
	Read(ctx context.Context, member *Member) error
	Update(ctx context.Context, member *Member) error
	Delete(ctx context.Context, member *Member) error
}

type MusicValues interface {
	string | []string | time.Duration | []time.Duration | []uuid.UUID | []Person | []Group | []Genre | []Studio | []Track | time.Time | uuid.UUID
}

type Person struct {
	ID         int32        `json:"id" db:"id,pk,unique,autoincrement"`
	FirstName  string       `json:"first_name" db:"first_name"`
	OtherNames []string     `json:"other_names,omitempty" db:"other_names"`
	LastName   string       `json:"last_name" db:"last_name"`
	NickNames  []string     `json:"nick_name,omitempty" db:"nick_name"`
	Roles      []string     `json:"roles,omitempty" db:"roles"`
	Works      []*uuid.UUID `json:"works" db:"works"`
	Birth      sql.NullTime `json:"birth,omitempty" db:"birth"` // DOB can also be unknown
	Death      sql.NullTime `json:"death,omitempty" db:"death"`
	Website    string       `json:"website,omitempty" db:"website"`
	Bio        string       `json:"bio,omitempty" db:"bio"`
	Photos     []string     `json:"photos,omitempty" db:"photos"`
	Hometown   Place        `json:"hometown,omitempty" db:"hometown"`
	Residence  Place        `json:"residence,omitempty" db:"residence"`
	Added      time.Time    `json:"added" db:"added"`
	Modified   sql.NullTime `json:"modified,omitempty" db:"modified"`
}

type Place struct {
	ID      uint64   `json:"id" db:"id,pk"`
	Kind    string   `json:"kind" db:"kind"`
	Name    string   `json:"name" db:"name"`
	Lat     float64  `json:"lat" db:"lat"`
	Lng     float64  `json:"lng" db:"lng"`
	Country *Country `json:"country" db:"country"`
}

type Rating struct {
	ID          int64     `json:"_key" db:"id,pk"`
	CreatedAt   time.Time `json:"created_at" db:"created_at"`
	NumStars    uint8     `json:"numstars" binding:"required" validate:"min=1,max=10" error:"numstars must be between 1 and 10" db:"stars" `
	Comment     string    `json:"comment,omitempty" db:"comment"`
	Topic       string    `json:"topic,omitempty" db:"topic"`
	Attribution string    `json:"attribution,omitempty" db:"attribution"`
	UserID      uint32    `json:"userid" db:"user_id"`
	MediaID     uuid.UUID `json:"mediaid" db:"media_id"`
	// track/cast/theme
	TrackRatings *TrackRating `json:"trackRatings,omitempty" db:"track_rating"`
	CastRating   *CastRating  `json:"castRating,omitempty" db:"cast_rating"`
}

type RatingInput struct {
	// TODO: allow for setting dynamic rating scales
	NumStars    uint8     `json:"numstars" binding:"required" validate:"min=1,max=10" error:"numstars must be between 1 and 10" db:"stars"`
	Comment     string    `json:"comment,omitempty" db:"comment"`
	Topic       string    `json:"topic,omitempty" db:"topic"`
	Attribution string    `json:"attribution,omitempty" db:"attribution"`
	UserID      uint32    `json:"userid" db:"user_id"`
	MediaID     uuid.UUID `json:"mediaid" db:"media_id"`
}

type RatingStorage struct {
	// contains filtered or unexported fields
}

type RatingStorer interface {
	New(ri *RatingInput) error
	Get(ctx context.Context, ID int64) (*Rating, error)
	GetAll() ([]*Rating, error)
	GetByMediaID(ctx context.Context, mediaID uuid.UUID) ([]*Rating, error)
}

type Season struct {
	MediaID  *uuid.UUID `json:"media_id" db:"media_id,pk,unique"`
	ShowID   *uuid.UUID `json:"show_id" db:"show_id,pk,unique"`
	Number   uint8      `json:"number" db:"number"`
	Episodes []Episode  `json:"episodes" db:"episodes"`
}

type Studio struct {
	ID           int32    `json:"id" db:"id,pk,serial,unique"`
	Name         string   `json:"name" db:"name"`
	Active       bool     `json:"active" db:"active"`
	City         *City    `json:"city,omitempty" db:"city"`
	Artists      []Person `json:"artists,omitempty" db:"artists"`
	Works        Media    `json:"works,omitempty" db:"works"`
	IsFilm       bool     `json:"is_film" db:"is_film"`
	IsMusic      bool     `json:"is_music" db:"is_music"`
	IsTV         bool     `json:"is_tv" db:"is_tv"`
	IsPublishing bool     `json:"is_publishing" db:"is_publishing"`
	IsGame       bool     `json:"is_game" db:"is_game"`
}

type TVShow struct {
	MediaID *uuid.UUID `json:"media_id" db:"media_id,pk,unique"`
	Title   string     `json:"title" db:"title"`
	Cast    Cast       `json:"cast" db:"cast"`
	Year    int        `json:"year" db:"year"`
	Active  bool       `json:"active" db:"active"`
	Seasons []Season   `json:"seasons" db:"seasons"`
	Studio  Studio     `json:"studio" db:"studio"`
}

type Track struct {
	MediaID   *uuid.UUID                   `json:"media_id" db:"media_id,pk,unique"`
	Name      string                       `json:"name" db:"name"`
	Artists   mo.Either[[]Person, []Group] `json:"artists" db:"artists"`
	Duration  time.Duration                `json:"duration" db:"duration"`
	Lyrics    string                       `json:"lyrics,omitempty" db:"lyrics"`
	Languages []string                     `json:"languages,omitempty" db:"languages"`
}

type TrackRating struct {
	ID       int64  `json:"_key" db:"id,pk"`
	Track    *Track `json:"track" db:"track"`
	NumStars uint8  `json:"numstars" binding:"required" validate:"min=1,max=10" error:"numstars must be between 1 and 10" db:"stars" `
	UserID   uint32 `json:"userid" db:"user_id"`
}

type UpdateableKeyTypes interface {
	~int | ~uint | string
}

type Venue struct {
	UUID    uuid.UUID `json:"uuid" db:"uuid,pk"`
	Name    string    `json:"name" db:"name"`
	Active  bool      `json:"active" db:"active"`
	Street  string    `json:"street" db:"street"`
	Zip     string    `json:"zip" db:"zip"`
	Unit    string    `json:"unit" db:"unit"`
	City    *City     `json:"city" db:"city"`
	Country *Country  `json:"country" db:"country"`
}