entity

type Admin struct {
	Permissions datatypes.JSONSlice[shared.Permission] `json:"permissions"`
	TelegramID  int64                                  `gorm:"index" json:"telegram_id"`
	ID          ouid.OUID                              `gorm:"primaryKey;type:uuid" json:"id"`
}

type ApiKey struct {
	Key         string                                 `gorm:"type:text;not null;uniqueIndex" json:"key"`
	Description string                                 `gorm:"type:text" json:"description"`
	Permissions datatypes.JSONSlice[shared.Permission] `gorm:"type:json" json:"permissions"`
	Quota       int                                    `gorm:"not null;default:0" json:"quota"`
	Used        int                                    `gorm:"not null;default:0" json:"used"`
	ID          ouid.OUID                              `gorm:"primaryKey;type:uuid" json:"id"`
}

type Artist struct {
	Name     string            `gorm:"type:text;not null;index" json:"name"`
	Type     shared.SourceType `gorm:"type:text;not null;index" json:"type"`
	UID      string            `gorm:"type:text;not null;index" json:"uid"`
	Username string            `gorm:"type:text;not null;index" json:"username"`

	// reverse relation
	Artworks []*Artwork `gorm:"foreignKey:ArtistID" json:"-"` // json ignore to avoid circular reference
	ID       ouid.OUID  `gorm:"primaryKey;type:uuid" json:"id"`
}

type Artwork struct {
	CreatedAt time.Time `gorm:"not null;autoCreateTime;index:idx_artwork_created_at,sort:desc" json:"created_at"`
	UpdatedAt time.Time `gorm:"not null;autoUpdateTime" json:"updated_at"`
	Artist    *Artist   `gorm:"foreignKey:ArtistID;references:ID;constraint:OnUpdate:CASCADE,OnDelete:SET NULL" json:"artist"`

	Title       string            `gorm:"type:text;not null;index:idx_artwork_title,sort:asc" json:"title"`
	Description string            `gorm:"type:text" json:"description"`
	SourceType  shared.SourceType `gorm:"type:text;not null;index:idx_artwork_source_type" json:"source_type"`
	SourceURL   string            `gorm:"type:text;not null;uniqueIndex" json:"source_url"`

	// many2many relationship with tags
	Tags []*Tag `gorm:"many2many:artwork_tags;constraint:OnDelete:CASCADE" json:"tags"`
	// one-to-many pictures
	Pictures []*Picture `gorm:"foreignKey:ArtworkID;constraint:OnDelete:CASCADE" json:"pictures"`
	// https://www.pixiv.help/hc/en-us/articles/235584628-What-are-Ugoira
	// one-to-many ugoira meta, usually only one
	UgoiraMetas []*UgoiraMeta `gorm:"foreignKey:ArtworkID;constraint:OnDelete:CASCADE" json:"ugoira_meta,omitempty"`
	// one-to-many videos
	Videos    []*Video `gorm:"foreignKey:ArtworkID;constraint:OnDelete:CASCADE" json:"videos"`
	LikeCount uint     `gorm:"not null;default:0" json:"like_count"`

	// keep ObjectID as 24-hex string
	ID ouid.OUID `gorm:"primaryKey;type:uuid" json:"id"`

	ArtistID ouid.OUID `gorm:"type:uuid;index" json:"artist_id"`
	R18      bool      `gorm:"not null;default:false;index:idx_artwork_r18" json:"r18"`
}

type CachedArtist struct {
	ID       string            `json:"id"`
	Name     string            `json:"name"`
	Type     shared.SourceType `json:"type"`
	UID      string            `json:"uid"`
	Username string            `json:"username"`
}

type CachedArtwork struct {
	CreatedAt time.Time                              `gorm:"autoCreateTime" json:"created_at"`
	Artwork   datatypes.JSONType[*CachedArtworkData] `gorm:"type:json" json:"artwork"`
	SourceURL string                                 `gorm:"type:text;uniqueIndex" json:"source_url"`
	Status    shared.ArtworkStatus                   `gorm:"type:text;index" json:"status"`
	ID        ouid.OUID                              `gorm:"primaryKey;type:uuid" json:"id"`
}

type CachedArtworkData struct {
	Artist      *CachedArtist     `json:"artist"`
	ID          string            `json:"id"`
	Title       string            `json:"title"`
	Description string            `json:"description"`
	SourceType  shared.SourceType `json:"source_type"`
	SourceURL   string            `json:"source_url"`

	Tags        []string            `json:"tags"`
	Pictures    []*CachedPicture    `json:"pictures"`
	UgoiraMetas []*CachedUgoiraMeta `json:"ugoira_metas,omitempty"`
	Videos      []*CachedVideo      `json:"videos,omitempty"`

	Version int  `json:"version"` // for future schema changes
	R18     bool `json:"r18"`
}

type CachedPicture struct {
	StorageInfo  shared.StorageInfo  `json:"storage_info"`
	TelegramInfo shared.TelegramInfo `json:"telegram_info"`
	ID           string              `json:"id"`
	ArtworkID    string              `json:"artwork_id"`
	Thumbnail    string              `json:"thumbnail"`
	Original     string              `json:"original"`
	Phash        string              `json:"phash"`      // phash
	ThumbHash    string              `json:"thumb_hash"` // thumbhash

	OrderIndex uint `json:"index"`

	Width  uint `json:"width"`
	Height uint `json:"height"`
	Hidden bool `json:"hidden"` // 设为 true 时不发布到 Artwork 中, 但仍在其他接口中返回

}

type CachedUgoiraMeta struct {
	TelegramInfo    shared.TelegramInfo   `json:"telegram_info"`
	OriginalStorage shared.StorageDetail  `json:"original_storage"`
	ID              string                `json:"id"`
	ArtworkID       string                `json:"artwork_id"`
	MetaData        shared.UgoiraMetaData `json:"data"`
	OrderIndex      uint                  `json:"index"`
}

type CachedVideo struct {
	TelegramInfo    shared.TelegramInfo  `json:"telegram_info"`
	OriginalStorage shared.StorageDetail `json:"original_storage"`
	ID              string               `json:"id"`
	ArtworkID       string               `json:"artwork_id"`
	Poster          string               `json:"poster"`
	URL             string               `json:"original"`
	MimeType        string               `json:"mime_type"`
	OrderIndex      uint                 `json:"index"`
	Width           uint                 `json:"width"`
	Height          uint                 `json:"height"`
	Duration        uint                 `json:"duration"` // in milliseconds
}

type DeletedRecord struct {
	DeletedAt time.Time `gorm:"not null;autoCreateTime" json:"deleted_at"`
	SourceURL string    `gorm:"type:text;not null;uniqueIndex" json:"source_url"`
	ID        ouid.OUID `gorm:"primaryKey;type:uuid" json:"id"`
}

type Picture struct {
	StorageInfo datatypes.JSONType[shared.StorageInfo] `json:"storage_info"`

	CreatedAt time.Time `gorm:"autoCreateTime" json:"created_at"`
	UpdatedAt time.Time `gorm:"autoUpdateTime" json:"updated_at"`

	TelegramInfo datatypes.JSONType[shared.TelegramInfo] `json:"telegram_info"`
	Artwork      *Artwork                                `gorm:"foreignKey:ArtworkID;references:ID;constraint:OnDelete:CASCADE" json:"-"`

	Thumbnail string `gorm:"type:text" json:"thumbnail"`
	Original  string `gorm:"type:text;index" json:"original"`
	Phash     string `gorm:"type:text;index" json:"phash"` // phash
	ThumbHash string `gorm:"type:text" json:"thumb_hash"`  // thumbhash

	OrderIndex uint      `gorm:"column:order_index;not null;default:0;index:idx_picture_artwork_index,priority:1" json:"index"`
	Width      uint      `json:"width"`
	Height     uint      `json:"height"`
	ID         ouid.OUID `gorm:"primaryKey;type:uuid" json:"id"`
	ArtworkID  ouid.OUID `gorm:"type:uuid;index" json:"artwork_id"`
}

type Tag struct {
	Name  string     `gorm:"type:text;not null;uniqueIndex" json:"name"`
	Alias []TagAlias `gorm:"foreignKey:TagID;constraint:OnDelete:CASCADE" json:"alias"` // one-to-many relation

	// reverse relation via many2many
	Artworks []*Artwork `gorm:"many2many:artwork_tags" json:"-"`
	ID       ouid.OUID  `gorm:"primaryKey;type:uuid" json:"id"`
}

type TagAlias struct {
	Alias string    `gorm:"type:text;not null;index" json:"alias"`
	ID    ouid.OUID `gorm:"primaryKey;type:uuid" json:"id"`
	TagID ouid.OUID `gorm:"type:uuid;index" json:"tag_id"`
}

type UgoiraMeta struct {
	CreatedAt time.Time `gorm:"autoCreateTime" json:"created_at"`
	UpdatedAt time.Time `gorm:"autoUpdateTime" json:"updated_at"`

	TelegramInfo datatypes.JSONType[shared.TelegramInfo] `json:"telegram_info"`
	Artwork      *Artwork                                `gorm:"foreignKey:ArtworkID;references:ID;constraint:OnDelete:CASCADE" json:"-"`

	OriginalStorage datatypes.JSONType[shared.StorageDetail]  `json:"original_storage"`
	Data            datatypes.JSONType[shared.UgoiraMetaData] `json:"data"`

	OrderIndex uint      `gorm:"column:order_index;not null;default:0;index:idx_ugoira_artwork_index,priority:1" json:"index"`
	ID         ouid.OUID `gorm:"primaryKey;type:uuid" json:"id"`
	ArtworkID  ouid.OUID `gorm:"type:uuid;index" json:"artwork_id"`
}

type User struct {
	UpdatedAt  time.Time `gorm:"autoUpdateTime" json:"updated_at"`
	Email      *string   `gorm:"type:text;uniqueIndex" json:"email"`
	TelegramID *int64    `gorm:"type:bigint;uniqueIndex" json:"telegram_id"`

	Settings  datatypes.JSONType[*UserSettings] `gorm:"type:json" json:"settings"`
	DeletedAt gorm.DeletedAt                    `gorm:"index" json:"deleted_at"`

	Username string `gorm:"type:text;uniqueIndex" json:"username"`
	Password string `gorm:"type:text;not null" json:"password"`

	Favorites []*Artwork `gorm:"many2many:user_favorites;constraint:OnDelete:CASCADE" json:"favorites"`

	ID      ouid.OUID `gorm:"primaryKey;type:uuid" json:"id"`
	Blocked bool      `gorm:"not null;default:false;index" json:"blocked"`
}

type UserSettings struct {
	Language string `json:"language"`
	Theme    string `json:"theme"`
	R18      bool   `json:"r18"`
}

type Video struct {
	CreatedAt time.Time `gorm:"autoCreateTime" json:"created_at"`
	UpdatedAt time.Time `gorm:"autoUpdateTime" json:"updated_at"`

	TelegramInfo    datatypes.JSONType[shared.TelegramInfo]  `json:"telegram_info"`
	Artwork         *Artwork                                 `gorm:"foreignKey:ArtworkID;references:ID;constraint:OnDelete:CASCADE" json:"-"`
	OriginalStorage datatypes.JSONType[shared.StorageDetail] `json:"original_storage"`

	Poster   string `gorm:"type:text" json:"poster"` // poster image URL
	MimeType string `gorm:"type:text" json:"mime_type"`
	URL      string `gorm:"type:text;index" json:"url"` // video URL

	OrderIndex uint      `gorm:"column:order_index;not null;default:0;index:idx_video_artwork_index,priority:1" json:"index"`
	Duration   uint      `json:"duration"` // duration in ms
	Width      uint      `json:"width"`
	Height     uint      `json:"height"`
	ID         ouid.OUID `gorm:"primaryKey;type:uuid" json:"id"`
	ArtworkID  ouid.OUID `gorm:"type:uuid;index" json:"artwork_id"`
}