bdapi_models.go

// These are copied directly from the bd-api repo. I may make the models importable at some point, but
// for now this will do.
package main

import (
	"time"

	"github.com/leighmacdonald/steamid/v4/steamid"
	"github.com/leighmacdonald/steamweb/v2"
)

type Site string

const (
	Skial            Site = "skial"
	GFL              Site = "gfl"
	Spaceship        Site = "spaceship"
	UGC              Site = "ugc"
	SirPlease        Site = "sirplease"
	Vidyagaems       Site = "vidyagaems"
	OWL              Site = "owl"
	ZMBrasil         Site = "zmbrasil"
	Dixigame         Site = "dixigame"
	ScrapTF          Site = "scraptf"
	Wonderland       Site = "wonderland"
	LazyPurple       Site = "lazypurple"
	FirePowered      Site = "firepowered"
	Harpoon          Site = "harpoongaming"
	Panda            Site = "panda"
	NeonHeights      Site = "neonheights"
	Pancakes         Site = "pancakes"
	Loos             Site = "loos"
	PubsTF           Site = "pubstf"
	ServiLiveCl      Site = "servilivecl"
	CutiePie         Site = "cutiepie"
	SGGaming         Site = "sggaming"
	ApeMode          Site = "apemode"
	MaxDB            Site = "maxdb"
	SvdosBrothers    Site = "svdosbrothers"
	Electric         Site = "electric"
	GlobalParadise   Site = "globalparadise"
	SavageServidores Site = "savageservidores"
	CSIServers       Site = "csiservers"
	LBGaming         Site = "lbgaming"
	FluxTF           Site = "fluxtf"
	DarkPyro         Site = "darkpyro"
	OpstOnline       Site = "opstonline"
	BouncyBall       Site = "bouncyball"
	FurryPound       Site = "furrypound"
	RetroServers     Site = "retroservers"
	SwapShop         Site = "swapshop"
	ECJ              Site = "ecj"
	JumpAcademy      Site = "jumpacademy"
	TF2Ro            Site = "tf2ro"
	SameTeem         Site = "sameteem"
	PowerFPS         Site = "powerfps"
	SevenMau         Site = "7mau"
	GhostCap         Site = "ghostcap"
	Spectre          Site = "spectre"
	DreamFire        Site = "dreamfire"
	Setti            Site = "setti"
	GunServer        Site = "gunserver"
	HellClan         Site = "hellclan"
	Sneaks           Site = "sneaks"
	Nide             Site = "nide"
	AstraMania       Site = "astramania"
	TF2Maps          Site = "tf2maps"
	PetrolTF         Site = "petroltf"
	VaticanCity      Site = "vaticancity"
	LazyNeer         Site = "lazyneer"
	TheVille         Site = "theville"
	Oreon            Site = "oreon"
	TriggerHappy     Site = "triggerhappy"
	Defusero         Site = "defusero"
	Tawerna          Site = "tawerna"
	TitanTF          Site = "titan"
	DiscFF           Site = "discff"
	Otaku            Site = "otaku"
	AMSGaming        Site = "amsgaming"
	BaitedCommunity  Site = "baitedcommunity"
	CedaPug          Site = "cedapug"
	GameSites        Site = "gamesites"
	BachuruServas    Site = "bachuruservas"
	Bierwiese        Site = "bierwiese"
	AceKill          Site = "acekill"
	Magyarhns        Site = "magyarhns"
	GamesTown        Site = "gamestown"
	ProGamesZet      Site = "progameszet"
	G44              Site = "g44"
	CuteProject      Site = "cuteproject"
	PhoenixSource    Site = "phoenixsource"
	SlavonServer     Site = "slavonserver"
	GetSome          Site = "getsome"
	Rushy            Site = "rushy"
	MoeVsMachine     Site = "moevsmachine"
	Prwh             Site = "prwh"
	Vortex           Site = "vortex"
	CasualFun        Site = "casualfun"
	RandomTF2        Site = "randomtf2"
	PlayersRo        Site = "playesro"
	EOTLGaming       Site = "eotlgaming"
	BioCrafting      Site = "biocrafting"
	BigBangGamers    Site = "bigbanggamers"
	EpicZone         Site = "epiczone"
	Zubat            Site = "zubat"
	Lunario          Site = "lunario"
)

type EconBanState int

const (
	EconBanNone EconBanState = iota
	EconBanProbation
	EconBanBanned
)

type TimeStamped struct {
	UpdatedOn time.Time `json:"-"`
	CreatedOn time.Time `json:"created_on"`
}

type PlayerNameRecord struct {
	NameID      int64           `json:"name_id"`
	SteamID     steamid.SteamID `json:"steam_id"`
	PersonaName string          `json:"persona_name"`
	CreatedOn   time.Time       `json:"created_on"`
}

type PlayerAvatarRecord struct {
	AvatarID   int64           `json:"avatar_id"`
	SteamID    steamid.SteamID `json:"steam_id"`
	AvatarHash string          `json:"avatar_hash"`
	CreatedOn  time.Time       `json:"created_on"`
}

type PlayerVanityRecord struct {
	VanityID  int64           `json:"vanity_id"`
	SteamID   steamid.SteamID `json:"steam_id"`
	Vanity    string          `json:"vanity"`
	CreatedOn time.Time       `json:"created_on"`
}

type Player struct {
	SteamID                  steamid.SteamID          `json:"steam_id"`
	CommunityVisibilityState steamweb.VisibilityState `json:"community_visibility_state"`
	ProfileState             steamweb.ProfileState    `json:"profile_state"`
	PersonaName              string                   `json:"persona_name"`
	Vanity                   string                   `json:"vanity"`
	AvatarHash               string                   `json:"avatar_hash"`
	PersonaState             steamweb.PersonaState    `json:"persona_state"`
	RealName                 string                   `json:"real_name"`
	TimeCreated              time.Time                `json:"time_created"`
	LocCountryCode           string                   `json:"loc_country_code"`
	LocStateCode             string                   `json:"loc_state_code"`
	LocCityID                int                      `json:"loc_city_id"`
	CommunityBanned          bool                     `json:"community_banned"`
	VacBanned                bool                     `json:"vac_banned"`
	LastBannedOn             time.Time                `json:"last_banned_on"`
	GameBans                 int                      `json:"game_bans"`
	EconomyBanned            EconBanState             `json:"economy_banned"`
	LogsTFCount              int                      `json:"logs_tf_count"`
	UGCUpdatedOn             time.Time                `json:"ugc_updated_on"`
	RGLUpdatedOn             time.Time                `json:"rgl_updated_on"`
	ETF2LUpdatedOn           time.Time                `json:"etf2_l_updated_on"`
	LogsTFUpdatedOn          time.Time                `json:"logs_tf_updated_on"`
	TimeStamped
}

type SbBanRecord struct {
	BanID       int             `json:"ban_id"`
	SiteName    Site            `json:"site_name"`
	SiteID      int             `json:"site_id"`
	PersonaName string          `json:"persona_name"`
	SteamID     steamid.SteamID `json:"steam_id"`
	Reason      string          `json:"reason"`
	Duration    time.Duration   `json:"duration"`
	Permanent   bool            `json:"permanent"`
	TimeStamped
}

type SbSite struct {
	SiteID int  `json:"site_id"`
	Name   Site `json:"name"`
	TimeStamped
}

// Profile is a high level meta profile of several services.
type Profile struct {
	Summary    steamweb.PlayerSummary  `json:"summary"`
	BanState   steamweb.PlayerBanState `json:"ban_state"`
	Seasons    []Season                `json:"seasons"`
	Friends    []steamweb.Friend       `json:"friends"`
	SourceBans []SbBanRecord           `json:"source_bans"`
	LogsCount  int64                   `json:"logs_count"`
}

// Division tries to define a generalized ranked division order.
type Division int

// *Rough* mapping of skill for each division for sorting, 0 being invite.
const (
	RGLRankInvite       Division = 0
	ETF2LPremiership    Division = 0
	UGCRankPlatinum     Division = 1
	ETF2LDiv1           Division = 1
	RGLRankDiv1         Division = 1
	RGLRankDiv2         Division = 1
	ETF2LDiv2           Division = 2
	RGLRankMain         Division = 2
	RGLRankAdvanced     Division = 2
	ETF2LMid            Division = 3
	UGCRankGold         Division = 3
	ETF2LLow            Division = 4
	RGLRankIntermediate Division = 4
	ETF2LOpen           Division = 5
	RGLRankOpen         Division = 5
	UGCRankSilver       Division = 6
	RGLRankAmateur      Division = 6
	UGCRankSteel        Division = 7
	UGCRankIron         Division = 8
	RGLRankFreshMeat    Division = 9
	RGLRankNone         Division = 10
	UGCRankNone         Division = 10
	UnknownDivision     Division = 20
)

// League represents supported leagues.
type League string

//
// const (
//	leagueUGC   League = "ugc"
//	leagueESEA  League = "esea"
//	leagueETF2L League = "etf2l"
//	leagueRGL   League = "rgl"
//)

// Season stores generalized league season data.
type Season struct {
	League      League   `json:"league"`
	Division    string   `json:"division"`
	DivisionInt Division `json:"division_int"`
	Format      string   `json:"format"`
	TeamName    string   `json:"team_name"`
}

type CompMap map[steamid.SteamID][]Season

type FriendMap map[string][]steamweb.Friend

type VacBanState steamweb.PlayerBanState

type Summary steamweb.PlayerSummary

type SourcebansMap map[string][]SbBanRecord

type BDSearchResult struct {
	ListName string      `json:"list_name"`
	Match    TF2BDPlayer `json:"match"`
}

type FileInfo struct {
	Authors     []string `json:"authors"`
	Description string   `json:"description"`
	Title       string   `json:"title"`
	UpdateURL   string   `json:"update_url"`
}

type LastSeen struct {
	PlayerName string `json:"player_name,omitempty"`
	Time       int    `json:"time,omitempty"`
}

type TF2BDPlayer struct {
	Attributes []string `json:"attributes"`
	LastSeen   LastSeen `json:"last_seen,omitempty"`
	Steamid    any      `json:"steamid"`
	Proof      []string `json:"proof"`
}

type TF2BDSchema struct {
	Schema   string        `json:"$schema"` //nolint:tagliatelle
	FileInfo FileInfo      `json:"file_info"`
	Players  []TF2BDPlayer `json:"players"`
}

type BDList struct {
	BDListID    int
	BDListName  string
	URL         string
	Game        string
	TrustWeight int
	Deleted     bool
	CreatedOn   time.Time
	UpdatedOn   time.Time
}

type BDListEntry struct {
	BDListEntryID int64
	BDListID      int
	SteamID       steamid.SteamID
	Attributes    []string
	Proof         []string
	LastSeen      time.Time
	LastName      string
	Deleted       bool
	CreatedOn     time.Time
	UpdatedOn     time.Time
}