packet

type AchievementsPacket struct {
	BasePacket
	Packet              `json:",omitempty"`
	models.Achievements `json:"achievements"`

	// The id of the client who we're getting achievements for
	ID string `json:"id"`
}

type AddEmailPacket struct {
	BasePacket
	Packet `json:",omitempty"`

	// The email address to check and send the code to
	Email string `json:"email"`

	// The role this user is signing up for (see models.Role)
	Role int `json:"role"`

	// The id of the sponsor, if Role == SponsorRep
	SponsorID string `json:"sponsorId"`
}

type BasePacket struct {
	Packet

	// Identifies the type of packet
	Type string `json:"type"`
}

type ChatPacket struct {
	BasePacket
	Packet `json:",omitempty"`

	// The message being sent
	Message string `json:"mssg"`

	// The id of the client who's joining
	ID string `json:"id"`

	// The client's room
	Room string `json:"room"`
}

type DancePacket struct {
	BasePacket
	Packet `json:",omitempty"`

	// The id of the client who is dancing
	ID string `json:"id"`

	// The room that the client is dancing in
	Room string `json:"room"`

	// The client's new x position (0-1)
	Dance int `json:"dance"`
}

type ElementAddPacket struct {
	BasePacket
	Packet `json:",omitempty"`

	// The room being updated
	Room string `json:"room"`

	// The ID of the element being updated
	ID string `json:"id"`

	// The new element
	Element models.Element `json:"element"`
}

type ElementDeletePacket struct {
	BasePacket
	Packet `json:",omitempty"`

	// The room being updated
	Room string `json:"room"`

	// The ID of the element being deleted
	ID string `json:"id"`
}

type ElementTogglePacket struct {
	BasePacket
	Packet `json:",omitempty"`

	// The ID of the element being toggled
	ID string `json:"id"`
}

type ElementUpdatePacket struct {
	BasePacket
	Packet `json:",omitempty"`

	// The room being updated
	Room string `json:"room"`

	// The ID of the element being updated
	ID string `json:"id"`

	// The new element
	Element models.Element `json:"element"`
}

type EmailCodePacket struct {
	BasePacket
	Packet `json:",omitempty"`

	// The email address to check and send the code to
	Email string `json:"email"`

	// The role this user is signing up for (see models.Role)
	Role int `json:"role"`
}

type ErrorPacket struct {
	BasePacket
	Packet `json:",omitempty"`

	Code int `json:"code"`
}

type EventPacket struct {
	BasePacket
	Packet `json:",omitempty"`

	// ID of this event
	ID string `json:"id"`
}

type Friend struct {
	ID       string    `json:"id"`
	Name     string    `json:"name"`
	School   string    `json:"school"`
	Status   int       `json:"status"`
	Teammate bool      `json:"teammate"`
	Pending  bool      `json:"pending"`
	LastSeen time.Time `json:"lastSeen"`
}

type FriendRequestPacket struct {
	BasePacket
	Packet `json:",omitempty"`

	SenderID    string `json:"senderId"`
	RecipientID string `json:"recipientId"`
}

type FriendUpdatePacket struct {
	BasePacket
	Packet `json:",omitempty"`

	Friend Friend `json:"friend"`

	// Server attributes
	RecipientID string `json:"recipientId"`
}

type GetAchievementsPacket struct {
	BasePacket
	Packet `json:",omitempty"`

	ID string `json:"id"`
}

type GetCurrentSongPacket struct {
	BasePacket
}

type GetMapPacket struct {
	BasePacket
}

type GetMessagesPacket struct {
	BasePacket
	Packet `json:",omitempty"`

	Recipient string `json:"recipient"`
}

type GetSongsPacket struct {
	BasePacket
}

type GetSponsorPacket struct {
	BasePacket
	Packet `json:",omitempty"`

	SponsorID string `json:"id"`
}

type HallwayAddPacket struct {
	BasePacket
	Packet `json:",omitempty"`

	// The room being updated
	Room string `json:"room"`

	// The ID of the hallway being updated
	ID string `json:"id"`

	// The new hallway
	Hallway models.Hallway `json:"hallway"`
}

type HallwayDeletePacket struct {
	BasePacket
	Packet `json:",omitempty"`

	// The room being updated
	Room string `json:"room"`

	// The ID of the hallway being deleted
	ID string `json:"id"`
}

type HallwayUpdatePacket struct {
	BasePacket
	Packet `json:",omitempty"`

	// The room being updated
	Room string `json:"room"`

	// The ID of the hallway being updated
	ID string `json:"id"`

	// The updated hallway
	Hallway models.Hallway `json:"hallway"`
}

type InitPacket struct {
	BasePacket
	Packet `json:",omitempty"`

	Character *models.Character `json:"character"`

	// The room that the client is about to join
	Room *models.Room `json:"room"`

	// A token for the client to save for future authentication
	Token string `json:"token,omitempty"`

	// All possible element names
	ElementNames []string `json:"elementNames"`

	// All room names
	RoomNames []string `json:"roomNames"`

	// All of this user's friends
	Friends []Friend `json:"friends"`

	// All of the events happening throughout the weekend
	Events []*models.Event `json:"events"`

	// Projects of the users in this room, if we're in the hacking arena
	Projects []*models.Project `json:"projects"`

	// Settings
	Settings *models.Settings `json:"settings"`

	// True if the feedback window should open
	OpenFeedback bool `json:"openFeedback"`

	// True if the user needs to register
	FirstTime bool `json:"firstTime"`
}

type JoinPacket struct {
	BasePacket
	Packet `json:",omitempty"`

	// Client attributes
	Name       string `json:"name,omitempty"`
	QuillToken string `json:"quillToken,omitempty"`
	Token      string `json:"token,omitempty"`

	Email string `json:"email,omitempty"`
	Code  int    `json:"code,omitempty"`

	// Server attributes
	Character *models.Character `json:"character"`
	ClientID  string            `json:"clientId,omitempty"`
	Project   *models.Project   `json:"project"`
	Room      string            `json:"room"`
}

type JukeboxWarningPacket struct {
	BasePacket
	Packet `json:",omitempty"`
}

type LeavePacket struct {
	BasePacket
	Packet `json:",omitempty"`

	// The character who is leaving
	Character *models.Character `json:"character"`

	// The room that the client is leaving
	Room string `json:"room"`
}

type MapPacket struct {
	BasePacket
	Packet `json:",omitempty"`

	Locations []*models.Location `json:"locations"`
}

type MessagePacket struct {
	BasePacket
	Packet `json:",omitempty"`
	*models.Message
}

type MessagesPacket struct {
	BasePacket
	Packet `json:",omitempty"`

	Messages  []*models.Message `json:"messages"`
	Recipient string            `json:"recipient"`
}

type MovePacket struct {
	BasePacket
	Packet `json:",omitempty"`

	// The id of the client who is moving
	ID string `json:"id"`

	// The room that the client is moving in
	Room string `json:"room"`

	// The client's new x position (0-1)
	X float64 `json:"x"`

	// The client's new y position (0-1)
	Y float64 `json:"y"`
}

type NotificationLevel int

type NotificationPacket struct {
	BasePacket
	Packet `json:",omitempty"`

	NotificationType NotificationType       `json:"notificationType"`
	Data             map[string]interface{} `json:"data"`
	Level            NotificationLevel      `json:"level"`
}

type NotificationType string

type Packet interface {
	PermissionCheck(characterID string, role models.Role) bool
}

type PlaySongPacket struct {
	BasePacket
	Packet `json:",omitempty"`
	Song   *models.Song `json:"song"`
	Start  int          `json:"start"`
	End    int          `json:"end"`
}

type ProjectFormPacket struct {
	BasePacket
	Packet `json:",omitempty"`

	Challenges []string `json:"challenges"`
	Teammates  []string `json:"teammates"`
	*models.Project
}

type QueueJoinPacket struct {
	BasePacket

	SponsorID string   `json:"sponsorId"`
	Interests []string `json:"interests"`
}

type QueueRemovePacket struct {
	BasePacket

	SponsorID   string `json:"sponsorId"`
	CharacterID string `json:"characterId"`
	Zoom        string `json:"zoom"`
}

type QueueSubscribePacket struct {
	BasePacket

	SponsorID string `json:"sponsorId"`

	Characters []*models.Character `json:"characters"`
}

type QueueUnsubscribePacket struct {
	BasePacket

	SponsorID string `json:"sponsorId"`
}

type QueueUpdateHackerPacket struct {
	BasePacket

	SponsorID string `json:"sponsorId"`
	Position  int    `json:"position"`
	URL       string `json:"url,omitempty"`

	// Server attributes
	CharacterIDs []string `json:"characterIds"`
}

type QueueUpdateSponsorPacket struct {
	BasePacket

	Subscribers []*models.QueueSubscriber `json:"subscribers"`

	// Server attributes
	CharacterIDs []string `json:"characterIds"`
}

type RegisterPacket struct {
	BasePacket
	Packet `json:",omitempty"`

	Name                string                `json:"name"`
	Location            string                `json:"location"`
	Bio                 string                `json:"bio"`
	PhoneNumber         string                `json:"phoneNumber"`
	BrowserSubscription *webpush.Subscription `json:"browserSubscription"`
}

type ReportPacket struct {
	BasePacket
	Packet `json:",omitempty"`

	CharacterID string `json:"characterId"`
	Text        string `json:"text"`
}

type RoomAddPacket struct {
	BasePacket
	Packet `json:",omitempty"`

	// The name of the new room
	ID string `json:"id"`

	// The background path for this room
	Background string `json:"background"`

	// True if this is a sponsor room
	Sponsor bool `json:"sponsor"`
}

type SettingsPacket struct {
	BasePacket
	Packet `json:",omitempty"`

	// The client's new settings
	Settings *models.Settings `json:"settings"`

	CheckTwitter bool `json:"checkTwitter"`

	Location string `json:"location"`
	Bio      string `json:"bio"`
	Zoom     string `json:"zoom"`
}

type SongPacket struct {
	BasePacket
	Packet `json:",omitempty"`
	*models.Song
	RequiresWarning bool `json:"requiresWarning"`
	Remove          bool `json:"remove"`
}

type SongsPacket struct {
	BasePacket

	Songs []*models.Song `json:"songs"`
}

type SponsorPacket struct {
	BasePacket
	Packet `json:",omitempty"`

	Sponsor *models.Sponsor `json:"sponsor"`
}

type StatusPacket struct {
	BasePacket
	Packet `json:",omitempty"`

	// True if the user is online and has the tab open -- false if the window doesn't have focus
	Active bool `json:"active"`

	// True if the user has the tab open, regardless of focus
	Online bool `json:"online"`

	// The ID of the character who this is a status update for
	ID string `json:"id"`

	// Server attributes
	FriendIDs   []string `json:"friendIds"`
	TeammateIDs []string `json:"teammateIds"`
}

type TeleportPacket struct {
	BasePacket
	Packet `json:",omitempty"`

	// The charcater who is teleporting
	Character *models.Character `json:"character"`

	// The room they're moving from
	From string `json:"from"`

	// The room they're moving to
	To string `json:"to"`

	// The resulting X coordinate
	X float64 `json:"x"`

	// The resulting Y coordinate
	Y float64 `json:"y"`
}

type UpdateMapPacket struct {
	BasePacket
	Packet           `json:",omitempty"`
	*models.Location `json:"location"`
}

type UpdateSponsorPacket struct {
	BasePacket
	Packet `json:",omitempty"`
	*models.Sponsor

	SetQueueOpen bool `json:"setQueueOpen"`
}

type WardrobeChangePacket struct {
	BasePacket
	Packet `json:",omitempty"`

	CharacterID string `json:"characterId"`
	Room        string `json:"room"`

	EyeColor   string `json:"eyeColor"`
	SkinColor  string `json:"skinColor"`
	ShirtColor string `json:"shirtColor"`
	PantsColor string `json:"pantsColor"`
}