entity

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

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

type Artist struct {
	ID       objectuuid.ObjectUUID `gorm:"primaryKey;type:uuid" json:"id"`
	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
}

type Artwork struct {
	// keep ObjectID as 24-hex string
	ID          objectuuid.ObjectUUID `gorm:"primaryKey;type:uuid" json:"id"`
	Title       string                `gorm:"type:text;not null;index:idx_artwork_title,sort:asc" json:"title"`
	Description string                `gorm:"type:text" json:"description"`
	R18         bool                  `gorm:"not null;default:false;index:idx_artwork_r18" json:"r18"`
	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"`
	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"`
	LikeCount   uint                  `gorm:"not null;default:0" json:"like_count"`

	ArtistID objectuuid.ObjectUUID `gorm:"type:uuid;index" json:"artist_id"`
	Artist   *Artist               `gorm:"foreignKey:ArtistID;references:ID;constraint:OnUpdate:CASCADE,OnDelete:SET NULL" json:"artist"`

	// 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"`
}

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 {
	ID        objectuuid.ObjectUUID                  `gorm:"primaryKey;type:uuid" json:"id"`
	SourceURL string                                 `gorm:"type:text;uniqueIndex" json:"source_url"`
	CreatedAt time.Time                              `gorm:"autoCreateTime" json:"created_at"`
	Artwork   datatypes.JSONType[*CachedArtworkData] `gorm:"type:json" json:"artwork"`
	Status    shared.ArtworkStatus                   `gorm:"type:text;index" json:"status"`
}

type CachedArtworkData struct {
	ID          string            `json:"id"`
	Title       string            `json:"title"`
	Description string            `json:"description"`
	R18         bool              `json:"r18"`
	SourceType  shared.SourceType `json:"source_type"`
	SourceURL   string            `json:"source_url"`

	Artist      *CachedArtist       `json:"artist"`
	Tags        []string            `json:"tags"`
	Pictures    []*CachedPicture    `json:"pictures"`
	UgoiraMetas []*CachedUgoiraMeta `json:"ugoira_metas,omitempty"`

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

type CachedPicture struct {
	ID         string `json:"id"`
	ArtworkID  string `json:"artwork_id"`
	OrderIndex uint   `json:"index"`
	Thumbnail  string `json:"thumbnail"`
	Original   string `json:"original"`
	Hidden     bool   `json:"hidden"` // 设为 true 时不发布到 Artwork 中, 但仍在其他接口中返回

	Width     uint   `json:"width"`
	Height    uint   `json:"height"`
	Phash     string `json:"phash"`      // phash
	ThumbHash string `json:"thumb_hash"` // thumbhash

	StorageInfo  shared.StorageInfo  `json:"storage_info"`
	TelegramInfo shared.TelegramInfo `json:"telegram_info"`
}

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

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

type Picture struct {
	ID        objectuuid.ObjectUUID `gorm:"primaryKey;type:uuid" json:"id"`
	ArtworkID objectuuid.ObjectUUID `gorm:"type:uuid;index" json:"artwork_id"`
	Artwork   *Artwork              `gorm:"foreignKey:ArtworkID;references:ID;constraint:OnDelete:CASCADE" json:"-"`

	OrderIndex uint   `gorm:"column:order_index;not null;default:0;index:idx_picture_artwork_index,priority:1" json:"index"`
	Thumbnail  string `gorm:"type:text" json:"thumbnail"`
	Original   string `gorm:"type:text;index" json:"original"`
	Width      uint   `json:"width"`
	Height     uint   `json:"height"`
	Phash      string `gorm:"type:text;index" json:"phash"` // phash
	ThumbHash  string `gorm:"type:text" json:"thumb_hash"`  // thumbhash

	TelegramInfo datatypes.JSONType[shared.TelegramInfo] `json:"telegram_info"`
	StorageInfo  datatypes.JSONType[shared.StorageInfo]  `json:"storage_info"`

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

type Tag struct {
	ID    objectuuid.ObjectUUID `gorm:"primaryKey;type:uuid" json:"id"`
	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:"-"`
}

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

type UgoiraMeta struct {
	ID        objectuuid.ObjectUUID `gorm:"primaryKey;type:uuid" json:"id"`
	ArtworkID objectuuid.ObjectUUID `gorm:"type:uuid;index" json:"artwork_id"`
	Artwork   *Artwork              `gorm:"foreignKey:ArtworkID;references:ID;constraint:OnDelete:CASCADE" json:"-"`

	OrderIndex uint                                      `gorm:"column:order_index;not null;default:0;index:idx_ugoira_artwork_index,priority:1" json:"index"`
	Data       datatypes.JSONType[shared.UgoiraMetaData] `json:"data"`

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

	OriginalStorage datatypes.JSONType[shared.StorageDetail] `json:"original_storage"`
	TelegramInfo    datatypes.JSONType[shared.TelegramInfo]  `json:"telegram_info"`
}

type User struct {
	ID         objectuuid.ObjectUUID `gorm:"primaryKey;type:uuid" json:"id"`
	Username   string                `gorm:"type:text;uniqueIndex" json:"username"`
	Password   string                `gorm:"type:text;not null" json:"password"`
	Email      *string               `gorm:"type:text;uniqueIndex" json:"email"`
	TelegramID *int64                `gorm:"type:bigint;uniqueIndex" json:"telegram_id"`
	Blocked    bool                  `gorm:"not null;default:false;index" json:"blocked"`
	UpdatedAt  time.Time             `gorm:"autoUpdateTime" json:"updated_at"`
	DeletedAt  gorm.DeletedAt        `gorm:"index" json:"deleted_at"`

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

	Settings datatypes.JSONType[*UserSettings] `gorm:"type:json" json:"settings"`
}

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