models

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

type CheckedWeightedModel interface {
	WeightedModel
	CheckCalculateWeightedScore() bool
}

type Developer struct {
	// ID is the ID of the Twitter user that this developer corresponds to.
	ID string
	// Name is the name of the Twitter user that this developer corresponds to.
	Name string
	// Username is the username of the Twitter user that this developer corresponds to.
	Username string
	// Description is the bio of the Twitter user that this developer corresponds to.
	Description string
	// Type denotes whether we found this Developer on Twitter or Reddit.
	Type DeveloperType `gorm:"type:developer_type"`
	// ProfileCreated is when the Developer's Twitter profile was created. Note how we avoid using CreatedAt.
	ProfileCreated time.Time
	// PublicMetrics is the most up-to-date public metrics for this Developer's Twitter profile.
	PublicMetrics *twitter.UserMetricsObj `gorm:"embedded;embeddedPrefix:current_"`
	// RedditPublicMetrics contains the user's karma if they are a RedditDeveloperType Developer.
	RedditPublicMetrics *RedditUserMetrics `gorm:"embedded;embeddedPrefix:current_reddit_"`
	// UpdatedAt is when this developer was updated. So we know up until when the PublicMetrics are fresh to.
	UpdatedAt time.Time
	// TimesHighlighted is the number of times this Developer has been highlighted by the Measure phase.
	TimesHighlighted int32
	// Disabled represents whether this Developer should be included in the Update phase of the Scout procedure.
	Disabled bool
}

type DeveloperMinimal struct {
	// ID is the ID of the Twitter user that this developer corresponds to.
	ID string
	// Type denotes whether we found this Developer on Twitter or Reddit.
	Type DeveloperType
}

type DeveloperSnapshot struct {
	// ID of the snapshot that is automatically generated by postgres.
	ID uuid.UUID `gorm:"type:uuid;default:uuid_generate_v4()"`
	// CreatedAt is automatically set to the time that this record is created.
	CreatedAt time.Time
	// Version is the number of this snapshot out of the set of all DeveloperSnapshot for this Developer.
	Version int32
	// TimesHighlighted is the number of times the Developer for this DeveloperSnapshot has been highlighted by the
	// Measure phase.
	TimesHighlighted int32
	// DeveloperID is the foreign key to the Developer this snapshot is for.
	DeveloperID string
	Developer   *Developer `gorm:"constraint:OnDelete:CASCADE;"`
	// Tweets is the number of tweets/Reddit posts that could be scraped for this Developer for this DeveloperSnapshot.
	Tweets int32
	// TweetIDs is the IDs of the Tweets captured by this DeveloperSnapshot. Using these, we can generate links for each
	// Tweet.
	TweetIDs pq.StringArray `gorm:"type:varchar(64)[];default:'{}'"`
	// RedditPostIDs are subreddit name, post ID pairs captured by this DeveloperSnapshot. I.e. a subreddit name
	// followed by a Reddit post ID. Using these, we can generate links for each post.
	RedditPostIDs pq.StringArray `gorm:"type:varchar(32)[];default:'{}'"`
	// TweetTimeRange is the time.Duration between the Developer's earliest tweet/post (that was scraped) and their
	// latest tweet/post (that was scraped). This is set to nil when only one tweet/post was scraped.
	TweetTimeRange NullDuration
	// LastTweetTime is the time of the last tweet/post that was scraped.
	LastTweetTime time.Time
	// TweetTimeRange is the average time.Duration between all the Developer's tweets/posts that were scraped for this
	// DeveloperSnapshot. This is set to nil when only one tweet/post was scraped.
	AverageDurationBetweenTweets NullDuration
	// TweetsPublicMetrics is the sum of all public metrics for the tweets that were scraped for this Developer for this
	// DeveloperSnapshot.
	TweetsPublicMetrics *twitter.TweetMetricsObj `gorm:"embedded;embeddedPrefix:total_tweet_"`
	// PostPublicMetrics is the sum of all public metrics for the Reddit posts that were scraped for this Developer for
	// this DeveloperSnapshot. This only applies if the Developer is of the RedditDeveloperType.
	PostPublicMetrics *RedditPostMetrics `gorm:"embedded;embeddedPrefix:total_post_"`
	// UserPublicMetrics is the public metrics for the Developer at the time this DeveloperSnapshot was created.
	UserPublicMetrics *twitter.UserMetricsObj `gorm:"embedded;embeddedPrefix:user_"`
	// RedditPublicMetrics contains the Developer's karma at the time this DeveloperSnapshot was created (if they are a
	// RedditDeveloperType Developer).
	RedditPublicMetrics *RedditUserMetrics `gorm:"embedded;embeddedPrefix:reddit_user_"`
	// ContextAnnotationSet is the set of all ContextAnnotations for all tweets that were scraped for this Developer for
	// this DeveloperSnapshot.
	ContextAnnotationSet *myTwitter.ContextAnnotationSet
	// Games is the number of Game that are currently found for this Developer at the time this DeveloperSnapshot was
	// created. This is a computed field, no need to set it before saving.
	Games int32
	// GameWeightedScoresSum is the sum of all Game.WeightedScore values for all the Game that are currently found for
	// this Developer at the time this DeveloperSnapshot was created. This is a computed field, no need to set it before
	// saving.
	GameWeightedScoresSum float64
	// WeightedScore is a weighted average comprised of the values taken from Tweets, TweetTimeRange,
	// AverageDurationBetweenTweets, TweetsPublicMetrics, UserPublicMetrics, ContextAnnotationSet, Games, and
	// GameWeightedScoresSum. This is a computed field, no need to set it before saving.
	WeightedScore float64
}

type DeveloperType string

type DisableEnableDeleteStats struct {
	// EnabledDevelopersBefore is the number of enabled developers before the phase.
	EnabledDevelopersBefore int64
	// DisabledDevelopersBefore is the number of disabled developers before the phase.
	DisabledDevelopersBefore int64
	// EnabledDevelopersAfter is the number of enabled developers after the phase.
	EnabledDevelopersAfter int64
	// DisabledDevelopersAfter is the number of enabled developers after the phase.
	DisabledDevelopersAfter int64
	// DeletedDevelopers is the number of developers that were deleted in the phase. Only applies for
	// ScoutResult.DeleteStats.
	DeletedDevelopers int64
	// TotalSampledDevelopers is the total number of developers that were sampled in the phase. Only applies for
	// ScoutResult.EnableStats and ScoutResult.DeleteStats.
	TotalSampledDevelopers int64
	// TotalFinishedSamples the number of Developer samples successfully processed in the phase. Only applies for
	// ScoutResult.EnableStats and ScoutResult.DeleteStats.
	TotalFinishedSamples int64
}

type DiscoveryUpdateSnapshotStats struct {
	// Developers is the number of Developers created when in the DiscoveryPhase, the number of Developers updated when
	// in the UpdatePhase, and the number of Developers that have partial snapshots in the SnapshotPhase.
	Developers int64
	// Games is the number of Game created when in the DiscoveryPhase, the number of Games updated when in the
	// UpdatePhase, and the number of Games within the GameIDs cached field in the SnapshotPhase.
	Games int64
	// TweetsConsumed is the number of Tweets successfully consumed from the Twitter API.
	TweetsConsumed int64
	// PostsConsumed is the number of Reddit posts successfully consumed from the Reddit API.
	PostsConsumed int64
	// TotalSnapshots is the total number of partial DeveloperSnapshot before merging for each developer.
	TotalSnapshots int64
	// SnapshotsCreated is the total number of DeveloperSnapshot created. Only applies for ScoutResult.SnapshotStats.
	SnapshotsCreated int64
}

type EvaluatorConfig interface {
	EvaluatorModelName() string
	EvaluatorField() string
	EvaluatorExpression() string
	EvaluatorCompiledExpression() *vm.Program
	WeightAndInverse() (float64, bool)
	ModelType() reflect.Type
	ModelField(modelInstance any) any
	Env(modelInstance any) map[string]any
	Eval(modelInstance any) ([]float64, error)
}

type Game struct {
	// ID is an uuid.UUID that is automatically generated by postgres.
	ID uuid.UUID `gorm:"type:uuid;default:uuid_generate_v4()"`
	// MondayItemID is a non-database field that is filled when fetching the Game from Monday using the GetGamesFromMonday
	// monday.Binding.
	MondayItemID int `gorm:"-:all"`
	// MondayBoardID is a non-database field that is filled when fetching the Game from Monday using the
	// GetGamesFromMonday monday.Binding.
	MondayBoardID string `gorm:"-:all"`
	// IsGame is only used for our benefit to check if the software that is being sold on the storepage pointed to by
	// Website is a Game. We only want to store Games within the DB and not DLC, Assets, Software, etc.
	IsGame bool `gorm:"-:all"`
	// Name is the name of the game. If this cannot be found it is set to nil.
	Name null.String
	// Storefront is where this game is sold. If this cannot be found it is set to nil.
	Storefront Storefront `gorm:"type:storefront_type"`
	// Website is the URL for this game's website. Usually a Steam store page.
	Website null.String `gorm:"index:idx_website,where:website is not null,unique"`
	// ImageURL is the URL for this game's cover/header image. For Game's whose Storefront is SteamStorefront this is
	// set to: "https://cdn.cloudflare.steamstatic.com/steam/apps/{{ $appid }}/header.jpg", and for ItchIOStorefront
	// Games this is set to the URL of the header image on the Game's Itch.IO page.
	ImageURL null.String `gorm:"default:null"`
	// Developers are the Twitter/Reddit usernames that could be developers for this Game. Each username is prefixed with
	// their Developer.Type's character (i.e. "T" or "R").
	Developers pq.StringArray `gorm:"type:varchar(21)[];default:'{}'"`
	// VerifiedDeveloperUsernames are the Twitter/Reddit usernames that can be found somewhere on the Game's Website.
	// Each username is prefixed with their Developer.Type's character (i.e. "T" or "R").
	VerifiedDeveloperUsernames pq.StringArray `gorm:"type:varchar(21)[];default:'{}'"`
	// Updates is the number of times this app has been updated. 0 means that the Game has just been created. Please
	// don't set this yourself when creating a Game.
	Updates uint64
	// ReleaseDate is when the game was/is going to be released. If this cannot be found, then it is set to nil.
	ReleaseDate null.Time
	// Publisher is the publisher for this game. Usually found via the Steam store API. If this cannot be found it is
	// set to nil. If this is set then it negatively contributes to the Game's WeightedScore.
	Publisher null.String
	// TotalReviews for this game. Only set when Storefront is SteamStorefront. If this cannot be found it is set to
	// nil.
	TotalReviews null.Int32
	// PositiveReviews for this game. Only set when Storefront is SteamStorefront. If this cannot be found it is set to
	// nil.
	PositiveReviews null.Int32
	// NegativeReviews for this game. Only set when Storefront is SteamStorefront. If this cannot be found it is set to
	// nil.
	NegativeReviews null.Int32
	// ReviewScore for this game (PositiveReviews / TotalReviews). Only set when Storefront is SteamStorefront,
	// PositiveReviews is set, and NegativeReviews is set. This is a computed field, no need to set it before saving.
	ReviewScore null.Float64
	// TotalUpvotes for this game. Only set when Storefront is SteamStorefront.
	TotalUpvotes null.Int32
	// TotalDownvotes for this game. Only set when Storefront is SteamStorefront.
	TotalDownvotes null.Int32
	// TotalComments for this game. Only set when Storefront is SteamStorefront or ItchIOStorefront.
	TotalComments null.Int32
	// TagScore is average value of each tag. Each tag's value is calculated by multiplying the number of upvotes for
	// that tag by the default value/override value for that tag. See TagConfig for more info.
	TagScore null.Float64
	// Watched indicates the Monday.com item Id, from the connected Monday board, for the Game. If this is nil, then it
	// can be assumed that this Game is not being watched.
	Watched *string `gorm:"default:null;type:varchar(32)"`
	// Votes is the number of upvotes for the Game on the linked Monday board/group minus the number of downvotes.
	Votes int32 `gorm:"default:0"`
	// WeightedScore is a weighted average comprised of the values taken from Publisher, TotalReviews, ReviewScore,
	// TotalUpvotes, TotalDownvotes, TotalComments, TagScore, and Updates for this game. If
	// Game.CheckCalculateWeightedScore is false then this will be nil. This is a computed field, no need to set it
	// before saving.
	WeightedScore null.Float64
}

type GameItchIOStorefront GameWrapper

type GameModel[ID comparable] interface {
	// Update will update a game model instance by running the scrape procedures for its GameModelWrapper.
	Update(db *gorm.DB, config ScrapeConfig) error
	// Wrapper returns the GameModelWrapper for this GameModel.
	Wrapper() GameModelWrapper[ID, GameModel[ID]]
	// GetID returns the unique ID value of the GameModel.
	GetID() ID
}

type GameModelStorefrontScraper[ID comparable] interface {
	// Args returns the arguments to be used for the scrape functions for the ScrapableGameSource(s) as well as the
	// arguments for AfterScrape.
	Args(id ID) []any
	// GetStorefront returns the Storefront that this scraper scrapes.
	GetStorefront() Storefront
	ScrapeInfo(config ScrapeConfig, maxTries int, minDelay time.Duration, args ...any) error
	ScrapeReviews(config ScrapeConfig, maxTries int, minDelay time.Duration, args ...any) error
	ScrapeTags(config ScrapeConfig, maxTries int, minDelay time.Duration, args ...any) error
	ScrapeCommunity(config ScrapeConfig, maxTries int, minDelay time.Duration, args ...any) error
	ScrapeExtra(config ScrapeConfig, maxTries int, minDelay time.Duration, args ...any) error
	// AfterScrape is called after all the above methods have completed for a Storefront. It is usually used to set the
	// Storefront and Website of the internal game instance using the given args extracted from Args.
	AfterScrape(args ...any)
}

type GameModelWrapper[ID comparable, GMT GameModel[ID]] interface {
	// Default will set the fields of the internal game model instance to their default values as well as create the
	// internal game model instance if it is nil.
	Default()
	// Nil will set the internal game model instance to nil.
	Nil()
	// Get will return the GameModel instance that is referenced internally.
	Get() GMT
	// StorefrontScraper will return the GameModelStorefrontScraper for the given Storefront. This will allow you to
	// scrape the information for the internal game model instance off of this Storefront.
	StorefrontScraper(storefront Storefront) GameModelStorefrontScraper[ID]
}

type GameSteamStorefront GameWrapper

type GameWrapper struct{ Game *Game }

type MeasureStats struct {
	// SampledTrendingDevelopers is the number of Developer sampled to create the email.Measure email.
	SampledTrendingDevelopers int64
	// EmailSendTimeTaken is the time it took to send the email.Measure email.
	EmailSendTimeTaken time.Duration
	// EmailSize is the generated email.Measure email's size in bytes.
	EmailSize int64
}

type NullDuration struct {
	sql.NullInt64
}

type RedditPostMetrics struct {
	Ups                  int     `json:"ups"`
	Downs                int     `json:"downs"`
	Score                int     `json:"score"`
	UpvoteRatio          float32 `json:"upvote_ratio"`
	NumberOfComments     int     `json:"num_comments"`
	SubredditSubscribers int     `json:"subreddit_subscribers"`
}

type RedditUserMetrics struct {
	PostKarma    int
	CommentKarma int
}

type ScoutResult struct {
	// ID of this ScoutResult that is automatically generated by postgres.
	ID uuid.UUID `gorm:"type:uuid;default:uuid_generate_v4()"`
	// CreatedAt is when this ScoutResult was created.
	CreatedAt time.Time
	// Started is when the Scout procedure was started.
	Started time.Time
	// DiscoveryStats is the stats for the DiscoveryPhase.
	DiscoveryStats *DiscoveryUpdateSnapshotStats `gorm:"embedded;embeddedPrefix:discovery_"`
	// UpdateStats is the stats for the UpdatePhase.
	UpdateStats *DiscoveryUpdateSnapshotStats `gorm:"embedded;embeddedPrefix:update_"`
	// SnapshotStats is the stats for the SnapshotPhase.
	SnapshotStats *DiscoveryUpdateSnapshotStats `gorm:"embedded;embeddedPrefix:snapshot_"`
	// DisableStats is the stats for the DisablePhase.
	DisableStats *DisableEnableDeleteStats `gorm:"embedded;embeddedPrefix:disable_"`
	// EnableStats is the stats for the EnablePhase.
	EnableStats *DisableEnableDeleteStats `gorm:"embedded;embeddedPrefix:enable_"`
	// DeleteStats is the stats for the DeletePhase.
	DeleteStats *DisableEnableDeleteStats `gorm:"embedded;embeddedPrefix:delete_"`
	// MeasureStats is the stats for the MeasurePhase.
	MeasureStats *MeasureStats `gorm:"embedded;embeddedPrefix:measure_"`
}

type ScrapableGameSource int

type ScrapeConfig interface {
	ScrapeDebug() bool
	ScrapeStorefronts() []StorefrontConfig
	ScrapeGetStorefront(storefront Storefront) StorefrontConfig
	ScrapeConstants() ScrapeConstants
	ScrapeFieldEvaluatorForWeightedModelField(model any, field string) (evaluator EvaluatorConfig, err error)
	ScrapeEvalForWeightedModelField(modelInstance any, field string) (values []float64, err error)
	ScrapeWeightedModelCalc(modelInstance any) (weightedAverage float64, err error)
}

type ScrapeConstants interface {
	DefaultMaxTries() int
	DefaultMinDelay() time.Duration
}

type SetOrAddFunc int

type SteamApp struct {
	// ID directly matches a Steam app's appID.
	ID uint64
	// Name is the current name of the SteamApp.
	Name string
	// MondayItemID is a non-database field that is filled when fetching the SteamApp from Monday using the
	// GetSteamAppsFromMonday monday.Binding.
	MondayItemID int `gorm:"-:all"`
	// MondayBoardID is a non-database field that is filled when fetching the SteamApp from Monday using the
	// GetSteamAppsFromMonday monday.Binding.
	MondayBoardID string `gorm:"-:all"`
	// Type is only used for our benefit to check what type of software this SteamApp is. We do not save it to the
	// database at all, because we only save SteamApp's that are games.
	Type string `gorm:"-:all"`
	// CreatedAt is when this SteamApp was first created. SteamApp's that were CreatedAt closer to the current update
	// time are desired more than SteamApp's that were CreatedAt further in the past.
	CreatedAt time.Time `gorm:"<-:create"`
	// Bare is set when the SteamApp is bare version of the app fetched from SteamGetAppList. When set, the SteamApp
	// will only have ID and Name set to not be default.
	Bare bool
	// Updates is the number of times this SteamApp has been updated in the DB. This is not the number of changelist
	// that have occurred for this title.
	Updates uint64
	// DeveloperID is the foreign key to a Developer on Twitter. This can be nil/null, in case there is no socials
	// linked on the SteamApp's store page.
	DeveloperID *string
	Developer   *Developer `gorm:"constraint:OnDelete:SET NULL;"`
	// ReleaseDate is when this game was/is going to be released on SteamStorefront.
	ReleaseDate time.Time
	// OwnersOnly indicates whether the games details can only be seen by owners of the game. If this is true then it
	// negatively impacts this SteamApp's WeightedScore.
	OwnersOnly bool
	// HasStorepage indicates whether this game has a storepage on Steam. If this is false then it negatively impacts
	// this SteamApp's WeightedScore.
	HasStorepage bool
	// Publisher is the publisher for this game. If this cannot be found it is set to nil. If this is set then it
	// negatively contributes to the SteamApp's WeightedScore.
	Publisher null.String
	// TotalReviews for this SteamApp.
	TotalReviews int32
	// PositiveReviews for this SteamApp.
	PositiveReviews int32
	// NegativeReviews for this SteamApp.
	NegativeReviews int32
	// ReviewScore for this game (PositiveReviews / TotalReviews). This is a computed field, no need to set it before
	// saving.
	ReviewScore float64
	// TotalUpvotes for this SteamApp on news posts from the developer on Steam community.
	TotalUpvotes int32
	// TotalDownvotes for this SteamApp on news posts from the developer on Steam community.
	TotalDownvotes int32
	// TotalComments for this SteamApp on news posts from the developer on Steam community.
	TotalComments int32
	// TagScore is average value of each community voted tag for the SteamApp. Each tag's value is calculated by
	// multiplying the number of upvotes for that tag by the default value/override value for that tag. See TagConfig for
	// more info.
	TagScore float64
	// AssetModifiedTime is the last time an asset was modified on this SteamApp's store page.
	AssetModifiedTime time.Time
	// LastChangelistID is the ID of the last changelist that was read for this title.
	LastChangelistID uint64
	// TimesHighlighted is the number of times this SteamApp has been highlighted by the measure command.
	TimesHighlighted int32
	// Watched indicates the Monday.com item Id, from the connected Monday board, for the SteamApp. If this is nil, then
	// it can be assumed that this SteamApp is not being watched.
	Watched *string `gorm:"default:null;type:varchar(32)"`
	// Votes is the number of upvotes for the SteamApp on the linked Monday board/group minus the number of downvotes.
	Votes int32 `gorm:"default:0"`
	// WeightedScore is a weighted average comprised of the values taken from CreatedAt, Updates, ReleaseDate,
	// Publisher, TotalReviews, ReviewScore, TotalUpvotes, TotalDownvotes, TotalComments, TagScore, AssetModifiedTime,
	// and TimesHighlighted for the SteamApp. If SteamApp.CheckCalculateWeightedScore is false then this will be nil.
	// This is a computed field, no need to set it before saving.
	WeightedScore null.Float64
}

type SteamAppSteamStorefront SteamAppWrapper

type SteamAppWrapper struct{ SteamApp *SteamApp }

type Storefront string

type StorefrontConfig interface {
	StorefrontStorefront() Storefront
	StorefrontTags() TagConfig
}

type StorefrontScrapers[ID comparable] struct {
	Timeout time.Duration
	// contains filtered or unexported fields
}

type TagConfig interface {
	TagDefaultValue() float64
	TagUpvotesThreshold() float64
	TagValues() map[string]float64
}

type Trend struct {
	Model      trendModel
	Regression *regression.Regression
	DataPoints regression.DataPoints
	// contains filtered or unexported fields
}

type TrendingDev struct {
	Developer *Developer
	Snapshots []*DeveloperSnapshot
	Games     []*Game
	Trend     *Trend
	// contains filtered or unexported fields
}

type UnscrapableStorefront[ID comparable] struct {
	Storefront Storefront
	Source     ScrapableGameSource
}

type WeightedModel interface {
	callbacks.BeforeCreateInterface
	callbacks.BeforeUpdateInterface
}