structures

type ActiveEmote struct {
	ID              primitive.ObjectID        `json:"id" bson:"id"`
	Name            string                    `json:"name" bson:"name"`
	Flags           BitField[ActiveEmoteFlag] `json:"flags" bson:"flags"`
	Timestamp       time.Time                 `json:"timestamp" bson:"timestamp"`
	TimestampUpdate *time.Time                `json:"timestamp_update,omitempty" bson:"timestamp_update,omitempty"`
	MergedFromID    primitive.ObjectID        `json:"merged_from_id,omitempty" bson:"merged_from_id,omitempty"`
	MergedAt        time.Time                 `json:"merged_at,omitempty" bson:"merged_at,omitempty"`
	ActorID         primitive.ObjectID        `json:"actor_id,omitempty" bson:"actor_id,omitempty"`

	Origin EmoteSetOrigin `json:"-" bson:"-"`
	Emote  *Emote         `json:"emote" bson:"emote,omitempty,skip"`
	Actor  *User          `json:"actor" bson:"actor,omitempty,skip"`
}

type ActiveEmoteFlag int32

type AuditLog struct {
	ID      primitive.ObjectID `json:"id" bson:"_id,omitempty"`
	Kind    AuditLogKind       `json:"kind" bson:"kind"`
	ActorID primitive.ObjectID `json:"actor_id" bson:"actor_id"`

	TargetID   primitive.ObjectID `json:"target_id" bson:"target_id"`
	TargetKind ObjectKind         `json:"target_kind" bson:"target_kind"`
	Changes    []*AuditLogChange  `json:"changes" bson:"changes"`

	Extra  map[string]any `json:"extra,omitempty" bson:"extra,omitempty"`
	Reason string         `json:"reason,omitempty" bson:"reason,omitempty"`
}

type AuditLogBuilder struct {
	Update   UpdateMap
	AuditLog AuditLog
}

type AuditLogChange struct {
	Format AuditLogChangeFormat `json:"format" bson:"format"`
	Key    string               `json:"key" bson:"key"`
	Value  bson.Raw             `json:"value" bson:"value"`
}

type AuditLogChangeArrayChange struct {
	Added   []any                       `json:"added,omitempty" bson:"added,omitempty"`
	Removed []any                       `json:"removed,omitempty" bson:"removed,omitempty"`
	Updated []AuditLogChangeSingleValue `json:"updated,omitempty" bson:"updated,omitempty"`
}

type AuditLogChangeFormat int8

type AuditLogChangeSingleValue struct {
	New      any   `json:"n" bson:"n"`
	Old      any   `json:"o" bson:"o"`
	Position int32 `json:"p" bson:"p"`
}

type AuditLogKind uint8

type Ban struct {
	ID primitive.ObjectID `json:"id" bson:"_id,omitempty"`

	// The user who is affected by this ban
	VictimID primitive.ObjectID `json:"victim_id" bson:"victim_id"`
	// The user who created this ban
	ActorID primitive.ObjectID `json:"actor_id" bson:"actor_id"`
	// The reason for the ban
	Reason string `json:"reason" bson:"reason"`
	// The time at which the ban will expire
	ExpireAt time.Time `json:"expire_at" bson:"expire_at"`
	// The effects that this ban will have
	Effects BanEffect `json:"effects" bson:"effects"`

	Victim *User `json:"victim" bson:"victim,skip,omitempty"`
	Actor  *User `json:"actor" bson:"actor,skip,omitempty"`
}

type BanBuilder struct {
	Ban    Ban
	Update UpdateMap
	// contains filtered or unexported fields
}

type BanEffect uint32

type BitField[T ~int64 | ~int32] int64

type Cosmetic[D CosmeticData] struct {
	ID       primitive.ObjectID   `json:"id" bson:"_id"`
	Kind     CosmeticKind         `json:"kind" bson:"kind"`
	Priority int                  `json:"priority" bson:"priority"`
	Name     string               `json:"name" bson:"name"`
	UserIDs  []primitive.ObjectID `json:"users" bson:"user_ids"`
	Users    []User               `json:"user_objects" bson:"user_objects,skip,omitempty"`
	Data     D                    `json:"data" bson:"data"`

	// User Relationals
	Selected bool `json:"selected" bson:"selected,skip,omitempty"`
}

type CosmeticData interface {
	bson.Raw | CosmeticDataBadge | CosmeticDataPaint
}

type CosmeticDataBadge struct {
	ID      primitive.ObjectID `json:"id" bson:"-"`
	Tag     string             `json:"tag" bson:"tag"`
	Tooltip string             `json:"tooltip" bson:"tooltip"`
	Misc    bool               `json:"misc,omitempty" bson:"misc"`
}

type CosmeticDataPaint struct {
	ID primitive.ObjectID `json:"id" bson:"-"`
	// The default color of the paint
	Color *utils.Color `json:"color" bson:"color"`
	// A list of gradients. There may be any amount, which can be stacked onto each other
	Gradients []CosmeticPaintGradient `json:"gradients" bson:"gradients"`
	// A list of drop shadows. There may be any amount, which can be stacked onto each other
	DropShadows []CosmeticPaintDropShadow `json:"drop_shadows,omitempty" bson:"drop_shadows,omitempty"`
	// A list of flairs
	Flairs []CosmeticPaintFlair `json:"flairs,omitempty" bson:"flairs,omitempty"`
	// Text properties
	Text *CosmeticPaintText `json:"text,omitempty" bson:"text,omitempty"`
	// Text stroke
	// The function used to generate the paint (i.e gradients or an image)
	Function CosmeticPaintGradientFunction `json:"function" bson:"function"`
	// Gradient stops, a list of positions and colors
	Stops []CosmeticPaintGradientStop `json:"stops" bson:"stops"`
	// Whether or not the gradient repeats outside its original area
	Repeat bool `json:"repeat" bson:"repeat"`
	// Gradient angle in degrees
	Angle int32 `json:"angle" bson:"angle"`
	// Shape of a radial gradient, when the paint is of RADIAL_GRADIENT type
	Shape string `json:"shape,omitempty" bson:"shape,omitempty"`
	// URL of an image, when the paint is of BACKGROUND_IMAGE type
	ImageURL string `json:"image_url,omitempty" bson:"image_url,omitempty"`
}

type CosmeticKind string

type CosmeticPaintDropShadow struct {
	OffsetX float64     `json:"x_offset" bson:"x_offset"`
	OffsetY float64     `json:"y_offset" bson:"y_offset"`
	Radius  float64     `json:"radius" bson:"radius"`
	Color   utils.Color `json:"color" bson:"color"`
}

type CosmeticPaintFlair struct {
	// The kind of sprite
	Kind CosmeticPaintFlairKind `json:"kind" bson:"kind"`
	// The X offset of the flair (%)
	OffsetX float64 `json:"x_offset" bson:"x_offset"`
	// The Y offset of the flair (%)
	OffsetY float64 `json:"y_offset" bson:"y_offset"`
	// The width of the flair
	Width float64 `json:"width" bson:"width"`
	// The height of the flair
	Height float64 `json:"height" bson:"height"`
	// Base64-encoded image or vector data
	Data string `json:"data" bson:"data"`
}

type CosmeticPaintFlairKind string

type CosmeticPaintGradient struct {
	// The function used to generate the paint (i.e gradients or an image)
	Function CosmeticPaintGradientFunction `json:"function" bson:"function"`
	// The repeat mode of the gradient canvas
	CanvasRepeat CosmeticPaintGradientRepeat `json:"canvas_repeat" bson:"canvas_repeat"`
	// The canvas size for the paint
	Size [2]float64 `json:"size" bson:"size"`
	// Gradient position (X/Y % values)
	At [2]float64 `json:"at,omitempty" bson:"at,omitempty"`
	// Gradient stops, a list of positions and colors
	Stops []CosmeticPaintGradientStop `json:"stops" bson:"stops"`
	// For a URL-based paint, the URL to an image
	ImageURL string `json:"image_url,omitempty" bson:"image_url,omitempty"`
	// For a radial gradient, the shape of the gradient
	Shape string `json:"shape,omitempty" bson:"shape,omitempty"`
	// The degree angle of the gradient (does not apply if function is URL)
	Angle int32 `json:"angle,omitempty" bson:"angle,omitempty"`
	// Whether or not the gradient stops repeat after they end
	Repeat bool `json:"repeat" bson:"repeat"`
}

type CosmeticPaintGradientFunction string

type CosmeticPaintGradientRepeat string

type CosmeticPaintGradientStop struct {
	At    float64     `json:"at" bson:"at"`
	Color utils.Color `json:"color" bson:"color"`
	// the center position for the gradient. X/Y % values (for radial gradients only)
	CenterAt [2]float64 `json:"center_at,omitempty" bson:"center_at,omitempty"`
}

type CosmeticPaintStroke struct {
	// Stroke color
	Color utils.Color `json:"color" bson:"color"`
	// Stroke width
	Width float64 `json:"width" bson:"width"`
}

type CosmeticPaintText struct {
	// Weight multiplier for the text. Defaults to 9x is not specified
	Weight uint8 `json:"weight,omitempty" bson:"weight,omitempty"`
	// Shadows applied to the text
	Shadows []CosmeticPaintDropShadow `json:"shadows,omitempty" bson:"shadows,omitempty"`
	// Text tranformation
	Transform CosmeticPaintTextTransform `json:"transform,omitempty" bson:"transform,omitempty"`
	// Text stroke
	Stroke *CosmeticPaintStroke `json:"stroke,omitempty" bson:"stroke,omitempty"`
	// (css) font variant property. non-standard
	Variant string `json:"variant" bson:"variant"`
}

type CosmeticPaintTextTransform string

type Emote struct {
	ID      ObjectID            `json:"id" bson:"_id"`
	OwnerID ObjectID            `json:"owner_id" bson:"owner_id"`
	Name    string              `json:"name" bson:"name"`
	Flags   BitField[EmoteFlag] `json:"flags" bson:"flags"`
	Tags    []string            `json:"tags" bson:"tags"`
	State   EmoteState          `json:"state" bson:"state"`

	Versions    []EmoteVersion       `json:"versions" bson:"versions"`
	ChildrenIDs []primitive.ObjectID `json:"children_ids" bson:"children_ids"`
	ParentID    *primitive.ObjectID  `json:"parent_id" bson:"parent_id"`

	Owner      *User         `json:"owner" bson:"owner_user,skip,omitempty"`
	Channels   []User        `json:"channels" bson:"channels,skip,omitempty"`
	VersionRef *EmoteVersion `json:"version_ref" bson:"version_ref,skip,omitempty"`
}

type EmoteBuilder struct {
	Update UpdateMap
	Emote  Emote
	// contains filtered or unexported fields
}

type EmoteFlag int32

type EmoteLifecycle int32

type EmoteSet struct {
	ID primitive.ObjectID `json:"-" bson:"_id,omitempty"`
	// The emote set's name
	Name string `json:"name" bson:"name"`
	// Search tags for the emote set
	Tags []string `json:"tags" bson:"tags"`
	// Bit flags for the emote set
	Flags BitField[EmoteSetFlag] `json:"flags" bson:"flags"`
	// Whether or not the emote set can be edited
	//
	// DEPRECATED - use Flags instead
	Immutable bool `json:"immutable" bson:"immutable"`
	// If true, the set is "privileged" and can only be modified by its owner or a super administrator, regardless of the "Edit Any Emote Set" permission
	//
	// DEPRECATED - use Flags instead
	Privileged bool `json:"privilleged" bson:"privileged"`
	// The emotes assigned to this set
	Emotes []ActiveEmote `json:"emotes" bson:"emotes"`
	// The set's emote capacity (slots), the maximum amount of emotes it can hold
	Capacity int32 `json:"capacity" bson:"capacity"`
	// The set's emote capacity using the quota system
	// Experimental - replaces slot capacity
	QuotaCapacity float64 `json:"capacity_experimental,omitempty" bson:"capacity_experimental,omitempty"`
	// Other emote sets that this set is based upon
	Origins []EmoteSetOrigin `json:"origins,omitempty" bson:"origins,omitempty"`
	// The ID of the user who owns this emote set
	OwnerID ObjectID `json:"owner_id" bson:"owner_id"`

	// Conditions governing how this emote set may be utilized
	Condition EmoteSetCondition `json:"condition" bson:"condition"`

	Owner *User `json:"owner,omitempty" bson:"owner_user,skip,omitempty"`
}

type EmoteSetBuilder struct {
	Update   UpdateMap
	EmoteSet EmoteSet
	// contains filtered or unexported fields
}

type EmoteSetCondition struct {
	// If true, this emote set may be entitled on to a user and used globally
	Entitlable bool `json:"entitlable,omitempty" bson:"entitlable,omitempty"`
	// A list of channel IDs (user connections) where this set is allowed to be used. If empty it is unrestricted
	Channels []string `json:"channels,omitempty" bson:"channels,omitempty"`
}

type EmoteSetFlag int32

type EmoteSetOrigin struct {
	// The ID of the referenced emote set
	ID primitive.ObjectID `json:"id" bson:"id"`
	// The weight of this set for serving emotes with names
	Weight int32 `json:"weight" bson:"weight"`
	// Slicing of active emotes inside the origin set
	Slices []uint32 `json:"slices" bson:"slices"`

	Set *EmoteSet
}

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

type EmoteState struct {
	// IDs of users who are eligible to claim ownership of this emote
	Claimants []primitive.ObjectID `json:"claimants" bson:"claimants"`
}

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

type EmoteVersion struct {
	ID          primitive.ObjectID `json:"id" bson:"id"`
	Name        string             `json:"name" bson:"name"`
	Description string             `json:"description" bson:"description"`
	Animated    bool               `json:"animated" bson:"animated"`
	State       EmoteVersionState  `json:"state" bson:"state"`

	InputFile   ImageFile   `json:"input_file" bson:"input_file"`
	ImageFiles  []ImageFile `json:"image_files" bson:"image_files"`
	ArchiveFile ImageFile   `json:"archive_file" bson:"archive_file"`

	CreatedAt   time.Time `json:"created_at" bson:"created_at"`
	StartedAt   time.Time `json:"started_at" bson:"started_at"`
	CompletedAt time.Time `json:"completed_at" bson:"completed_at"`
}

type EmoteVersionState struct {
	// The current life cycle of the emote
	// indicating whether it's processing, live, deleted, etc.
	Lifecycle EmoteLifecycle `json:"lifecycle" bson:"lifecycle"`
	// An error message linked to a failure in the emote's processing stage
	Error string `json:"error,omitempty" bson:"error,omitempty"`
	// ID of a replacing emote (used to redirect merges)
	ReplaceID primitive.ObjectID `json:"replace_id,omitempty" bson:"replace_id,omitempty"`
	// Whether or not the emote is listed
	Listed bool `json:"listed" bson:"listed"`
	// Whether or not the emote is validated for personal use
	AllowPersonal *bool `json:"allow_personal" bson:"allow_personal"`
	// The ranked position for the amount of channels this emote is added on to.
	// This value is to be determined with an external cron job
	ChannelCountRank int32 `json:"-" bson:"channel_count_rank"`
	// The amount of channels this emote is added on to.
	// This value is to be determined with an external cron job
	ChannelCount int32 `json:"-" bson:"channel_count"`
	// The time at which the ChannelCount value was last checked
	ChannelCountCheckAt time.Time `json:"-" bson:"channel_count_check_at"`
	Language            string    `json:"language,omitempty" bson:"language,omitempty"`
}

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

type Entitlement[D EntitlementData] struct {
	ID primitive.ObjectID `json:"id" bson:"_id,omitempty"`
	// Kind represents what item this entitlement grants
	Kind EntitlementKind `json:"kind" bson:"kind"`
	// Data referencing the entitled item
	Data D `json:"data" bson:"data"`
	// The user who is entitled to the item
	UserID primitive.ObjectID `json:"user_id" bson:"user_id"`
	// An optional claim expectation
	Claim *EntitlementClaim `json:"claim" bson:"claim"`
	// Eligibility conditions for this entitlement
	Condition EntitlementCondition `json:"condition" bson:"condition"`
	// Whether this entitlement is currently inactive
	Disabled bool `json:"disabled,omitempty" bson:"disabled,omitempty"`
	// Information about the app that created this entitlement
	App *EntitlementApp `json:"app,omitempty" bson:"app,omitempty"`
}

type EntitlementApp struct {
	Name    string         `json:"name" bson:"name"`
	ActorID string         `json:"actor_id,omitempty" bson:"actor_id"`
	State   map[string]any `json:"state" bson:"state"`
}

type EntitlementBuilder[D EntitlementData] struct {
	Entitlement Entitlement[D]

	User *User
	// contains filtered or unexported fields
}

type EntitlementClaim struct {
	Platform UserConnectionPlatform `json:"platform" bson:"platform"`
	ID       string                 `json:"id" bson:"id"`
}

type EntitlementCondition struct {
	AnyRoles []primitive.ObjectID `json:"any_roles,omitempty" bson:"any_roles,omitempty"`
	AllRoles []primitive.ObjectID `json:"all_roles,omitempty" bson:"all_roles,omitempty"`
	MinDate  time.Time            `json:"min_date,omitempty" bson:"min_date,omitempty"`
	MaxDate  time.Time            `json:"max_date,omitempty" bson:"max_date,omitempty"`
	NoLegacy bool                 `json:"no_legacy,omitempty" bson:"no_legacy,omitempty"`
}

type EntitlementData interface {
	bson.Raw | EntitlementDataBase | EntitlementDataBaseSelectable | EntitlementDataSubscription | EntitlementDataBadge | EntitlementDataPaint | EntitlementDataRole | EntitlementDataEmoteSet
}

type EntitlementDataBadge struct {
	RefID     primitive.ObjectID           `json:"-" bson:"ref"`
	RefObject *Cosmetic[CosmeticDataBadge] `json:"ref_object" bson:"ref_object,skip,omitempty"`
	Selected  bool                         `json:"selected,omitempty" bson:"selected,omitempty"`
}

type EntitlementDataBase struct {
	// The ID of the subscription
	RefID primitive.ObjectID `json:"-" bson:"ref"`
}

type EntitlementDataBaseSelectable struct {
	// The ID of the subscription
	RefID    primitive.ObjectID `json:"-" bson:"ref"`
	Selected bool               `json:"selected" bson:"selected"`
}

type EntitlementDataEmoteSet struct {
	RefID     primitive.ObjectID `json:"-" bson:"ref"`
	RefObject *EmoteSet          `json:"ref_object" bson:"ref_object,skip,omitempty"`
}

type EntitlementDataPaint struct {
	RefID     primitive.ObjectID           `json:"-" bson:"ref"`
	RefObject *Cosmetic[CosmeticDataPaint] `json:"ref_object" bson:"ref_object,skip,omitempty"`
	Selected  bool                         `json:"selected,omitempty" bson:"selected,omitempty"`
}

type EntitlementDataRole struct {
	RefID     primitive.ObjectID `json:"-" bson:"ref"`
	RefObject *Role              `json:"ref_object" bson:"ref_object,skip,omitempty"`
}

type EntitlementDataSubscription struct {
	Interval     int    `json:"interval" bson:"interval"`
	IntervalUnit string `json:"interval_unit" bson:"interval_unit"`
}

type EntitlementKind string

type ImageFile struct {
	Name         string `json:"name" bson:"name"`                         // The name of the file
	Width        int32  `json:"width" bson:"width,omitempty"`             // The pixel width of the emote
	Height       int32  `json:"height" bson:"height,omitempty"`           // The pixel height of the emote
	FrameCount   int32  `json:"frame_count" bson:"frame_count,omitempty"` // Whether or not this file is animated
	Size         int64  `json:"size" bson:"size"`                         // The file size in bytes
	ContentType  string `json:"content_type" bson:"content_type"`
	SHA3         string `json:"sha3" bson:"sha3"`
	Key          string `json:"key" bson:"key"`
	Bucket       string `json:"bucket" bson:"bucket"`
	ACL          string `json:"acl"`
	CacheControl string `json:"cache_control"`
}

type ListItemAction string

type Message[D MessageData] struct {
	ID primitive.ObjectID `json:"id" bson:"_id,omitempty"`

	// The kind of message this is (i.e a comment, or inbox message)
	Kind MessageKind `json:"kind" bson:"kind"`
	// The ID of the user who created this message
	AuthorID primitive.ObjectID `json:"author_id" bson:"author_id,omitempty"`
	// Whether or not the message's author will not be displayed to unprivileged end users
	Anonymous bool `json:"anonymous,omitempty" bson:"anonymous,omitempty"`
	// The date on which this message was cretaed
	CreatedAt time.Time `json:"created_at" bson:"created_at"`
	// Message data
	Data D `json:"data" bson:"data"`

	Author    *User     `json:"author,omitempty" bson:"author,omitempty"`
	Timestamp time.Time `json:"timestamp,omitempty" bson:"timestamp,omitempty"`
	Read      bool      `json:"read,omitempty" bson:"read,omitempty"`
}

type MessageBuilder[D MessageData] struct {
	Message Message[D]
	Update  UpdateMap
	// contains filtered or unexported fields
}

type MessageComponent struct {
	Type    MessageComponentType `json:"type" bson:"type"`                           // the type of component
	Heading uint8                `json:"heading,omitempty" bson:"heading,omitempty"` // component heading level
	Weight  uint8                `json:"weight,omitempty" bson:"weight,omitempty"`   // component font weight (1-9)
	Color   utils.Color          `json:"color" bson:"color"`                         // text color (ineffective on some types)
	Locale  bool                 `json:"locale" bson:"locale"`                       // whether or not the content of this component is a locale string
	Content string               `json:"content" bson:"content"`                     // the content of the component
}

type MessageComponentBuilder struct {
	MessageComponent MessageComponent
	Update           UpdateMap
}

type MessageComponentType string

type MessageData interface {
	bson.Raw | MessageDataEmoteComment | MessageDataInbox | MessageDataPlaceholder | MessageDataModRequest
}

type MessageDataEmoteComment struct {
	EmoteID primitive.ObjectID `json:"emote_id" bson:"emote_id"`
	// Whether or not the comment is an official statement
	// i.e, a warning by a moderator
	Authoritative bool `json:"authoritative,omitempty" bson:"authoritative,omitempty"`
	// Whether or not the comment is pinned.
	// Pinned comments will always appear at the top
	Pinned bool `json:"pinned,omitempty" bson:"pinned,omitempty"`
	// The comment's text contents
	Content string `json:"content" bson:"content"`
}

type MessageDataInbox struct {
	Subject      string             `json:"subject" bson:"subject"`                               // the message's subject
	Components   []MessageComponent `json:"components" bson:"components"`                         // the message's components
	Content      string             `json:"content" bson:"content"`                               // the content of the message
	Important    bool               `json:"important,omitempty" bson:"important,omitempty"`       // whether or not the message is important
	Starred      bool               `json:"starred,omitempty" bson:"starred,omitempty"`           // whether or not the message is started
	Pinned       bool               `json:"pinned,omitempty" bson:"pinned,omitempty"`             // whether or not the message is pinned
	Locked       bool               `json:"locked,omitempty" bson:"locked,omitempty"`             // whether or not replies can be added to this message
	Locale       bool               `json:"locale,omitempty" bson:"locale,omitempty"`             // whether or not this message can use locale strings
	System       bool               `json:"system,omitempty" bson:"system,omitempty"`             // whether or not the message is a system message
	Placeholders map[string]string  `json:"placeholders,omitempty" bson:"placeholders,omitempty"` // placeholders for localization
}

type MessageDataModRequest struct {
	TargetKind       ObjectKind         `json:"target_kind" bson:"target_kind"`
	TargetID         primitive.ObjectID `json:"target_id" bson:"target_id"`
	Wish             string             `json:"wish" bson:"wish"`
	Priority         uint8              `json:"priority" bson:"priority,omitempty"`
	ActorCountryName string             `json:"actor_country_name,omitempty" bson:"actor_country_name,omitempty"`
	ActorCountryCode string             `json:"actor_country_code,omitempty" bson:"actor_country_code,omitempty"`

	Target bson.Raw `json:"target" bson:"target,omitempty"`
}

type MessageDataPlaceholder struct {
	Key   string `json:"key" bson:"key"`
	Value string `json:"value" bson:"value"`
}

type MessageKind int8

type MessageRead struct {
	ID          primitive.ObjectID `json:"id" bson:"_id,omitempty"`
	Kind        MessageKind        `json:"kind" bson:"kind"`
	Timestamp   time.Time          `json:"timestamp" bson:"timestamp"`
	MessageID   primitive.ObjectID `json:"message_id" bson:"message_id"`
	RecipientID primitive.ObjectID `json:"recipient_id,omitempty" bson:"recipient_id,omitempty"`
	Read        bool               `json:"read" bson:"read"`
	ReadAt      time.Time          `json:"read_at,omitempty" bson:"read_at,omitempty"`
	Weight      int32              `json:"weight" bson:"weight"`

	Message *Message[bson.Raw] `json:"message,omitempty" bson:"message,skip,omitempty"`
}

type Object interface {
	AuditLog | Ban | Cosmetic[bson.Raw] | Emote | EmoteSet | Entitlement[bson.Raw] | Message[bson.Raw] | Report | Role | User
}

type ObjectID = primitive.ObjectID

type ObjectKind int8

type Report struct {
	ID     primitive.ObjectID `json:"id" bson:"_id"`
	CaseID string             `json:"case_id" bson:"case_id"`
	// The type of the target
	TargetKind ObjectKind `json:"target_kind" bson:"target_kind"`
	// The ID of the target
	TargetID primitive.ObjectID `json:"target_id" bson:"target_id"`
	// The ID of the user who created the report
	ActorID primitive.ObjectID `json:"actor_id" bson:"actor_id"`
	// The report subject (i.e "Stolen Emote")
	Subject string `json:"subject" bson:"subject"`
	// The report body (a user-generated text field with details)
	Body string `json:"body" bson:"body"`
	// Priority of the report
	Priority int32 `json:"priority" bson:"priority"`
	// Whether or not the report is open
	Status ReportStatus `json:"status" bson:"status"`
	// The date on which the report was created
	CreatedAt time.Time `json:"created_at" bson:"created_at"`
	// The date on which the report was closed
	ClosedAt *time.Time `json:"closed_at,omitempty" bson:"closed_at,omitempty"`
	// The date on which the report was last updated
	LastUpdatedAt time.Time `json:"last_updated_at" bson:"last_updated_at"`
	// The IDs of users assigned to this report
	AssigneeIDs []primitive.ObjectID `json:"assignee_ids" bson:"assignee_ids"`
	// Notes (moderator comments)
	Notes []ReportNote `json:"notes" bson:"notes"`

	Target    *User  `json:"target" bson:"target,skip,omitempty"`
	Actor     *User  `json:"reporter" bson:"actor,skip,omitempty"`
	Assignees []User `json:"assignees" bson:"assignees,skip,omitempty"`
}

type ReportBuilder struct {
	Update UpdateMap
	Report Report
}

type ReportNote struct {
	// The time at which the note was created
	Timestamp time.Time `json:"timestamp" bson:"timestamp"`
	// The ID of the user who wrote this note
	AuthorID primitive.ObjectID `json:"author_id" bson:"author_id"`
	// The text content of the note
	Content string `json:"content" bson:"content"`
	// If true, the note is only visible to other privileged users
	// it will not be visible to the reporter
	Internal bool `json:"internal" bson:"internal"`
	// Whether or not the note was read by the reporter
	Read bool `json:"read" bson:"read"`
	// A reply to the note by the reporter
	Reply string `json:"reply" bson:"reply"`
}

type ReportStatus string

type Role struct {
	ID primitive.ObjectID `json:"id" bson:"_id"`
	// the role's name
	Name string `json:"name" bson:"name"`
	// the role's privilege position
	Position int32 `json:"position" bson:"position"`
	// the role's display color
	Color utils.Color `json:"color" bson:"color"`
	// the role's allowed permission bits
	Allowed RolePermission `json:"allowed" bson:"allowed"`
	// the role's denied permission bits
	Denied RolePermission `json:"denied" bson:"denied"`
	// whether or not this role is the default role
	Default bool `json:"default" bson:"default,omitempty"`
	// whether or not the role
	Invisible bool `json:"invisible" bson:"invisible,omitempty"`

	// the id of the linked role on discord
	DiscordID uint64 `json:"discord_id,omitempty" bson:"discord_id,omitempty"`
}

type RoleBuilder struct {
	Update UpdateMap
	Role   Role
	// contains filtered or unexported fields
}

type RolePermission int64

type System struct {
	ID ObjectID `json:"id" bson:"_id"`

	AdminUserID ObjectID `json:"admin_user_id" bson:"admin_user_id"`
	EmoteSetID  ObjectID `json:"emote_set_id" bson:"emote_set_id"`
	Config      struct {
		Extension        SystemConfigExtension `json:"extension" bson:"extension"`
		ExtensionNightly SystemConfigExtension `json:"extension_nightly" bson:"extension_nightly"`
	} `json:"config" bson:"config"`
}

type SystemConfigExtension struct {
	Version       string                        `json:"version" bson:"version"`
	Overrides     []struct{}                    `json:"overrides" bson:"overrides"`
	Compatibility []SystemConfigExtensionCompat `json:"compatibility" bson:"compatibility"`
}

type SystemConfigExtensionCompat struct {
	ID     []string                           `json:"id" bson:"id"`
	Issues []SystemConfigExtensionCompatIssue `json:"issues" bson:"issues"`
}

type SystemConfigExtensionCompatIssue struct {
	Platforms []UserConnectionPlatform                 `json:"platform" bson:"platform"`
	Severity  SystemConfigExtensionCompatIssueSeverity `json:"severity" bson:"severity"`
	Message   string                                   `json:"message" bson:"message"`
}

type SystemConfigExtensionCompatIssueSeverity string

type SystemDefaultObject struct {
	ID         ObjectID `json:"id" bson:"id"`
	Collection string   `json:"collection" bson:"collection"`
}

type UpdateMap bson.M

type UpdateValue interface{}

type User struct {
	ID ObjectID `json:"id,omitempty" bson:"_id,omitempty"`
	// the type of this user. empty when a regular user, but could also be "BOT" or "SYSTEM"
	UserType UserType `json:"type,omitempty" bson:"type,omitempty"`
	// the user's username
	Username string `json:"username" bson:"username"`
	// the user's display name
	DisplayName string `json:"display_name" bson:"display_name"`
	// the user's discriminatory space
	Discriminator string `json:"discriminator" bson:"discriminator"`
	// the user's email
	Email string `json:"email" bson:"email"`
	// list of role IDs directly bound to the user (not via an entitlement)
	RoleIDs []ObjectID `json:"role_ids" bson:"role_ids"`
	// the user's editors
	Editors []UserEditor `json:"editors" bson:"editors"`
	// the user's avatar URL
	AvatarID string `json:"avatar_id" bson:"avatar_id"`
	// the user's avatar
	Avatar *UserAvatar `json:"avatar" bson:"avatar"`
	// the user's biography
	Biography string `json:"biography" bson:"biography"`
	// token version. When this value changes all existing auth tokens are invalidated
	TokenVersion float64 `json:"token_version" bson:"token_version"`
	// third party connections. Who's the third party now?
	Connections UserConnectionList `json:"connections" bson:"connections"`
	// the ID of users who have been blocked by the user
	BlockedUserIDs []ObjectID `json:"blocked_user_ids,omitempty" bson:"blocked_user_ids,omitempty"`
	// persisted non-structural data that can be used internally for querying
	State UserState `json:"-" bson:"state"`
	// Special treatments attributed to the user;
	// This is used to run experiments
	Treatments []string `json:"treatments" bson:"treatments"`

	Emotes       []Emote                 `json:"emotes" bson:"emotes,skip,omitempty"`
	OwnedEmotes  []Emote                 `json:"owned_emotes" bson:"owned_emotes,skip,omitempty"`
	Bans         []Ban                   `json:"bans" bson:"bans,skip,omitempty"`
	Entitlements []Entitlement[bson.Raw] `json:"entitlements" bson:"entitlements,skip,omitempty"`

	Roles     []Role       `json:"roles" bson:"roles,skip,omitempty"`
	EditorOf  []UserEditor `json:"editor_of" bson:"editor_of,skip,omitempty"`
	AvatarURL string       `json:"avatar_url" bson:"-"`
}

type UserAvatar struct {
	ID         primitive.ObjectID  `json:"id" bson:"id"`
	InputFile  ImageFile           `json:"input_file" bson:"input_file"`
	ImageFiles []ImageFile         `json:"image_files" bson:"image_files"`
	PendingID  *primitive.ObjectID `json:"pending_id,omitempty" bson:"pending_id,omitempty"`
}

type UserBuilder struct {
	Update UpdateMap
	User   User
	// contains filtered or unexported fields
}

type UserConnection[D UserConnectionData] struct {
	ID string `json:"id,omitempty" bson:"id,omitempty"`
	// the platform of this connection
	Platform UserConnectionPlatform `json:"platform" bson:"platform"`
	// the time at which this connection was linked
	LinkedAt time.Time `json:"linked_at" bson:"linked_at"`
	// the maximum amount of emotes this connection may have have enabled, counting the total from active sets
	EmoteSlots int32 `json:"emote_slots" bson:"emote_slots"`
	// emote sets bound to this connection / channel
	EmoteSetID ObjectID `json:"emote_set_id,omitempty" bson:"emote_set_id,omitempty"`
	// third-party connection data
	Data D `json:"data" bson:"data"`
	// a list of different possible connection data objects
	// the user must choose one to confirm the connection
	ChoiceData []bson.Raw `json:"choice_data,omitempty" bson:"choice_data,omitempty"`
	// a full oauth2 token grant
	Grant *UserConnectionGrant `json:"-" bson:"grant,omitempty"`

	EmoteSet *EmoteSet `json:"emote_set" bson:"emote_set,skip,omitempty"`
}

type UserConnectionBuilder[D UserConnectionData] struct {
	Update         UpdateMap
	UserConnection UserConnection[D]
}

type UserConnectionData interface {
	bson.Raw | UserConnectionDataTwitch | UserConnectionDataYoutube | UserConnectionDataDiscord | UserConnectionDataKick
}

type UserConnectionDataDiscord struct {
	ID            string `json:"id" bson:"id"`
	Username      string `json:"username" bson:"username"`
	Discriminator string `json:"discriminator" bson:"discriminator"`
	Avatar        string `json:"avatar" bson:"avatar"`
	Bot           bool   `json:"bot" bson:"bot"`
	System        bool   `json:"system" bson:"system"`
	MFAEnabled    bool   `json:"mfa_enabled" bson:"mfa_enabled"`
	Banner        string `json:"banner" bson:"banner,omitempty"`
	AccentColor   int64  `json:"accent_color" bson:"accent_color,omitempty"`
	Locale        string `json:"locale" bson:"locale,omitempty"`
	Verified      bool   `json:"verified" bson:"verified"`
	Email         string `json:"email" bson:"email,omitempty"`
	Flags         int64  `json:"flags" bson:"flags"`
	PremiumType   uint32 `json:"premium_type" bson:"premium_type"`
	PublicFlags   uint32 `json:"public_flags" bson:"public_flags"`
}

type UserConnectionDataKick struct {
	ID          string `json:"id" bson:"id"`
	ChatroomID  string `json:"chatroom_id" bson:"chatroom_id"`
	Username    string `json:"username" bson:"username"`
	DisplayName string `json:"display_name" bson:"display_name"`
	Bio         string `json:"bio" bson:"bio"`
}

type UserConnectionDataTwitch struct {
	ID              string    `json:"id" bson:"id"`
	Login           string    `json:"login" bson:"login"`
	DisplayName     string    `json:"display_name" bson:"display_name"`
	BroadcasterType string    `json:"broadcaster_type" bson:"broadcaster_type"`
	Description     string    `json:"description" bson:"description"`
	ProfileImageURL string    `json:"profile_image_url" bson:"profile_image_url"`
	OfflineImageURL string    `json:"offline_image_url" bson:"offline_image_url"`
	ViewCount       int       `json:"view_count" bson:"view_count"`
	Email           string    `json:"email" bson:"email"`
	CreatedAt       time.Time `json:"created_at" bson:"twitch_created_at"`
}

type UserConnectionDataYoutube struct {
	ID              string `json:"id" bson:"id"`
	Title           string `json:"title" bson:"title"`
	Description     string `json:"description" bson:"description"`
	ViewCount       int64  `json:"view_count" bson:"view_count"`
	SubCount        int64  `json:"sub_count" bson:"sub_count"`
	ProfileImageURL string `json:"profile_image_url" bson:"profile_image_url"`
}

type UserConnectionGrant struct {
	AccessToken  string    `json:"access_token" bson:"access_token"`
	RefreshToken string    `json:"refresh_token" bson:"refresh_token"`
	Scope        []string  `json:"scope" bson:"scope"`
	ExpiresAt    time.Time `json:"expires_at" bson:"expires_at"`
}

type UserConnectionList []UserConnection[bson.Raw]

type UserConnectionPlatform string

type UserDiscriminator uint8

type UserEditor struct {
	ID ObjectID `json:"id" bson:"id"`
	// The permissions this editor has
	Permissions UserEditorPermission `json:"permissions" bson:"permissions"`
	// Whether or not that editor will be visible on the user's profile page
	Visible bool `json:"visible" bson:"visible"`

	AddedAt time.Time `json:"added_at,omitempty" bson:"added_at,omitempty"`

	// Relational
	User *User `json:"user" bson:"user,skip,omitempty"`
}

type UserEditorPermission int32

type UserPresence[T UserPresenceData] struct {
	ID     primitive.ObjectID `json:"id" bson:"_id,omitempty"`
	UserID primitive.ObjectID `json:"user_id" bson:"user_id"`
	// IP is the IP address of the client who initiated this presence
	IP string `json:"ip" bson:"ip"`
	// Authentic is whether or not this presence was authenticated; confirmed that the actor issued this presence
	//
	// If false, such a presence cannot be trusted as truth of a user's location.
	// This may be used for non-sensitive information delivery, for example
	// to allow a client to announce a user as active in a chat room, but not require
	// a full authentication flow to attain this functionality.
	Authentic bool `json:"authentic" bson:"authentic"`
	// Known is whether or not the data in this presence is known
	//
	// If false, it means the data passed wasn't validated to match a real location.
	Known bool `json:"known" bson:"known"`
	// Timestamp is the time at which this presence was issued
	Timestamp time.Time `json:"timestamp" bson:"timestamp"`
	// TTL is how long this presence is valid for, before it expires
	TTL time.Time `json:"ttl" bson:"ttl"`
	// Kind is the type of presence this is
	Kind         UserPresenceKind          `json:"kind" bson:"kind"`
	Data         T                         `json:"data" bson:"data"`
	Entitlements []UserPresenceEntitlement `json:"entitlements,omitempty" bson:"entitlements,omitempty"`
}

type UserPresenceData interface {
	bson.Raw | UserPresenceDataChannel | UserPresenceLocationDataWebPage
}

type UserPresenceDataChannel struct {
	Platform UserConnectionPlatform        `json:"platform" bson:"platform"`
	ID       string                        `json:"id" bson:"id"`
	Filter   UserPresenceDataChannelFilter `json:"filter" bson:"-"`
}

type UserPresenceDataChannelFilter struct {
	Emotes []string `json:"emotes" bson:"-"`
}

type UserPresenceEntitlement struct {
	Kind         EntitlementKind    `json:"kind" bson:"kind"`
	ID           primitive.ObjectID `json:"id" bson:"id"`
	RefID        primitive.ObjectID `json:"ref" bson:"ref"`
	DispatchHash uint32             `json:"dispatch_hash,omitempty" bson:"dispatch_hash,omitempty"`
}

type UserPresenceKind uint8

type UserPresenceLocationDataWebPage struct {
	URL       string `json:"url" bson:"url"`
	UserAgent string `json:"user_agent" bson:"user_agent"`
}

type UserState struct {
	RolePosition  int       `json:"-" bson:"role_position"`
	ClientIP      string    `json:"-" bson:"client_ip"`
	LastLoginDate time.Time `json:"-" bson:"last_login_at"`
	LastVisitDate time.Time `json:"-" bson:"last_visit_at"`
}

type UserType string