sendou.ink/app/db/tables.ts
Kalle d3a825bd57
Some checks failed
Tests and checks on push / run-checks-and-tests (push) Has been cancelled
Updates translation progress / update-translation-progress-issue (push) Has been cancelled
Override tournament bracket destination (#1985)
* Initial

* Progress

* Done?

* Update seeding nth
2024-12-15 12:24:11 +02:00

947 lines
22 KiB
TypeScript

import type {
ColumnType,
GeneratedAlways,
Insertable,
Selectable,
SqlBool,
} from "kysely";
import type { TieredSkill } from "~/features/mmr/tiered.server";
import type { TEAM_MEMBER_ROLES } from "~/features/team";
import type * as Progression from "~/features/tournament-bracket/core/Progression";
import type { ParticipantResult } from "~/modules/brackets-model";
import type {
Ability,
MainWeaponId,
ModeShort,
StageId,
} from "~/modules/in-game-lists";
import type { GroupSkillDifference, UserSkillDifference } from "./types";
export type Generated<T> = T extends ColumnType<infer S, infer I, infer U>
? ColumnType<S, I | undefined, U>
: ColumnType<T, T | undefined, T>;
export type MemberRole = (typeof TEAM_MEMBER_ROLES)[number];
export interface Team {
avatarImgId: number | null;
bannerImgId: number | null;
bio: string | null;
createdAt: Generated<number>;
css: ColumnType<Record<string, string> | null, string | null, string | null>;
customUrl: string;
deletedAt: number | null;
id: GeneratedAlways<number>;
inviteCode: string;
name: string;
twitter: string | null;
bsky: string | null;
}
export interface TeamMember {
createdAt: Generated<number>;
isOwner: Generated<number>;
leftAt: number | null;
role: MemberRole | null;
teamId: number;
userId: number;
isMainTeam: number;
}
export interface Art {
authorId: number;
createdAt: Generated<number>;
description: string | null;
id: GeneratedAlways<number>;
imgId: number;
isShowcase: Generated<number>;
}
export interface ArtTag {
authorId: number;
createdAt: Generated<number>;
id: GeneratedAlways<number>;
name: string;
}
export interface ArtUserMetadata {
artId: number;
userId: number;
}
export interface Badge {
id: GeneratedAlways<number>;
code: string;
displayName: string;
hue: number | null;
/** Who made the badge? If null, a legacy badge. */
authorId: number | null;
}
export interface BadgeManager {
badgeId: number;
userId: number;
}
export type BadgeOwner = {
badgeId: number | null;
userId: number | null;
};
export interface Build {
clothesGearSplId: number;
description: string | null;
headGearSplId: number;
id: GeneratedAlways<number>;
modes: ColumnType<ModeShort[] | null, string | null, string | null>;
ownerId: number;
private: number | null;
shoesGearSplId: number;
title: string;
updatedAt: Generated<number>;
}
export interface BuildAbility {
ability: Ability;
buildId: number;
gearType: string;
slotIndex: number;
}
export interface BuildWeapon {
buildId: number;
weaponSplId: MainWeaponId;
}
/** Image associated with the avatar when the event is showcased on the front page */
export type CalendarEventAvatarMetadata = {
backgroundColor: string;
textColor: string;
};
export interface CalendarEvent {
authorId: number;
bracketUrl: string;
description: string | null;
discordInviteCode: string | null;
id: GeneratedAlways<number>;
discordUrl: GeneratedAlways<string | null>;
name: string;
participantCount: number | null;
tags: string | null;
tournamentId: number | null;
organizationId: number | null;
avatarImgId: number | null;
// TODO: remove in migration
avatarMetadata: ColumnType<
CalendarEventAvatarMetadata | null,
string | null,
string | null
>;
}
export interface CalendarEventBadge {
badgeId: number;
eventId: number;
}
export interface CalendarEventDate {
eventId: number;
id: GeneratedAlways<number>;
startTime: number;
}
export interface CalendarEventResultPlayer {
name: string | null;
teamId: number;
userId: number | null;
}
export interface CalendarEventResultTeam {
eventId: number;
id: GeneratedAlways<number>;
name: string;
placement: number;
}
export interface FreshPlusTier {
tier: number | null;
userId: number;
}
export interface Group {
chatCode: string | null;
createdAt: Generated<number>;
id: GeneratedAlways<number>;
inviteCode: string;
latestActionAt: Generated<number>;
status: "PREPARING" | "ACTIVE" | "INACTIVE";
teamId: number | null;
}
export interface GroupLike {
createdAt: Generated<number>;
likerGroupId: number;
targetGroupId: number;
isRechallenge: number | null;
}
export type ParsedMemento = {
users: Record<
number,
{
plusTier?: PlusTier["tier"];
skill?: TieredSkill | "CALCULATING";
skillDifference?: UserSkillDifference;
}
>;
groups: Record<
number,
{
tier?: TieredSkill["tier"];
skillDifference?: GroupSkillDifference;
}
>;
modePreferences?: Partial<
Record<ModeShort, Array<{ userId: number; preference?: Preference }>>
>;
/** mapPreferences of season 2 */
mapPreferences?: Array<{ userId: number; preference?: Preference }[]>;
pools: Array<{ userId: number; pool: UserMapModePreferences["pool"] }>;
};
export interface GroupMatch {
alphaGroupId: number;
bravoGroupId: number;
chatCode: string | null;
createdAt: Generated<number>;
id: GeneratedAlways<number>;
memento: ColumnType<ParsedMemento | null, string | null, string | null>;
reportedAt: number | null;
reportedByUserId: number | null;
}
export interface GroupMatchMap {
id: GeneratedAlways<number>;
index: number;
matchId: number;
mode: ModeShort;
source: string;
stageId: StageId;
winnerGroupId: number | null;
}
export interface GroupMember {
createdAt: Generated<number>;
groupId: number;
note: string | null;
role: "OWNER" | "MANAGER" | "REGULAR";
userId: number;
}
export interface PrivateUserNote {
authorId: number;
targetId: number;
text: string | null;
sentiment: "POSITIVE" | "NEUTRAL" | "NEGATIVE";
updatedAt: Generated<number>;
}
export interface LogInLink {
code: string;
expiresAt: number;
userId: number;
}
export type LFGType =
| "PLAYER_FOR_TEAM"
| "PLAYER_FOR_COACH"
| "TEAM_FOR_PLAYER"
| "TEAM_FOR_COACH"
| "TEAM_FOR_SCRIM"
| "COACH_FOR_TEAM";
export const LFG_TYPES = [
"PLAYER_FOR_TEAM",
"PLAYER_FOR_COACH",
"TEAM_FOR_PLAYER",
"TEAM_FOR_COACH",
"TEAM_FOR_SCRIM",
"COACH_FOR_TEAM",
] as const;
export interface LFGPost {
id: GeneratedAlways<number>;
type: LFGType;
text: string;
/** e.g. Europe/Helsinki */
timezone: string;
authorId: number;
teamId: number | null;
plusTierVisibility: number | null;
updatedAt: Generated<number>;
createdAt: GeneratedAlways<number>;
}
export interface MapPoolMap {
calendarEventId: number | null;
mode: ModeShort;
stageId: StageId;
tieBreakerCalendarEventId: number | null;
tournamentTeamId: number | null;
}
export interface MapResult {
losses: number;
mode: ModeShort;
season: number;
stageId: StageId;
userId: number;
wins: number;
}
export interface Migrations {
created_at: string;
id: GeneratedAlways<number>;
name: string;
}
export interface PlayerResult {
mapLosses: number;
mapWins: number;
otherUserId: number;
ownerUserId: number;
season: number;
setLosses: number;
setWins: number;
type: string;
}
export interface PlusSuggestion {
authorId: number;
createdAt: GeneratedAlways<number>;
id: GeneratedAlways<number>;
month: number;
suggestedId: number;
text: string;
tier: number;
year: number;
}
export interface PlusTier {
tier: number;
userId: number | null;
}
export interface PlusVote {
authorId: number;
month: number;
score: number;
tier: number;
validAfter: number;
votedId: number;
year: number;
}
export interface PlusVotingResult {
votedId: number;
tier: number;
score: number;
month: number;
year: number;
wasSuggested: number;
passedVoting: number;
}
export interface ReportedWeapon {
groupMatchMapId: number | null;
userId: number;
weaponSplId: number;
}
export interface Skill {
groupMatchId: number | null;
id: GeneratedAlways<number>;
identifier: string | null;
matchesCount: number;
mu: number;
ordinal: number;
sigma: number;
season: number;
tournamentId: number | null;
userId: number | null;
}
export interface SkillTeamUser {
skillId: number;
userId: number;
}
export interface SeedingSkill {
mu: number;
ordinal: number;
sigma: number;
userId: number;
type: "RANKED" | "UNRANKED";
}
export interface SplatoonPlayer {
id: GeneratedAlways<number>;
splId: string;
userId: number | null;
}
export interface TaggedArt {
artId: number;
tagId: number;
}
// AUTO = style where teams pick their map pool ahead of time and the map lists are automatically made for each round
// could also have the traditional style where TO picks the maps later
type TournamentMapPickingStyle =
| "TO"
| "AUTO_ALL"
| "AUTO_SZ"
| "AUTO_TC"
| "AUTO_RM"
| "AUTO_CB";
export interface TournamentSettings {
bracketProgression: Progression.ParsedBracket[];
/** @deprecated use bracketProgression instead */
teamsPerGroup?: number;
/** @deprecated use bracketProgression instead */
thirdPlaceMatch?: boolean;
isRanked?: boolean;
enableNoScreenToggle?: boolean;
/** Enable the subs tab, default true */
enableSubs?: boolean;
deadlines?: "STRICT" | "DEFAULT";
requireInGameNames?: boolean;
isInvitational?: boolean;
/** Can teams add subs on their own while tournament is in progress? */
autonomousSubs?: boolean;
/** Timestamp (SQLite format) when reg closes, if missing then means closes at start time */
regClosesAt?: number;
/** @deprecated use bracketProgression instead */
swiss?: {
groupCount: number;
roundCount: number;
};
minMembersPerTeam?: number;
}
export interface CastedMatchesInfo {
/** Array for match ID's that are locked because they are pending to be casted */
lockedMatches: number[];
/** What matches are streamed currently & where */
castedMatches: { twitchAccount: string; matchId: number }[];
}
export interface Tournament {
settings: ColumnType<TournamentSettings, string, string>;
id: GeneratedAlways<number>;
mapPickingStyle: TournamentMapPickingStyle;
/** Maps prepared ahead of time for rounds. Follows settings.bracketProgression order. Null in the spot if not defined yet for that bracket. */
preparedMaps: ColumnType<
(PreparedMaps | null)[] | null,
string | null,
string | null
>;
castTwitchAccounts: ColumnType<string[] | null, string | null, string | null>;
castedMatchesInfo: ColumnType<
CastedMatchesInfo | null,
string | null,
string | null
>;
rules: string | null;
}
export interface PreparedMaps {
authorId: number;
createdAt: number;
maps: Array<TournamentRoundMaps & { roundId: number; groupId: number }>;
eliminationTeamCount?: number;
}
export interface TournamentBadgeOwner {
badgeId: number;
userId: number;
}
/** A group is a logical structure used to group multiple rounds together.
- In round-robin stages, a group is a pool.
- In swiss, a group is also a pool (can have one or multiple groups)
- In elimination stages, a group is a bracket.
- A single elimination stage can have one or two groups:
- The unique bracket.
- If enabled, the Consolation Final.
- A double elimination stage can have two or three groups:
- Upper and lower brackets.
- If enabled, the Grand Final.
*/
export interface TournamentGroup {
id: GeneratedAlways<number>;
number: number;
stageId: number;
}
export interface TournamentMatch {
// TODO: remove
bestOf: Generated<3 | 5 | 7>;
chatCode: string | null;
groupId: number;
id: GeneratedAlways<number>;
number: number;
opponentOne: ColumnType<ParticipantResult, string, string>;
opponentTwo: ColumnType<ParticipantResult, string, string>;
roundId: number;
stageId: number;
status: number;
// used only for swiss because it's the only stage type where matches are not created in advance
createdAt: Generated<number>;
}
export interface TournamentMatchPickBanEvent {
type: "PICK" | "BAN";
stageId: StageId;
mode: ModeShort;
matchId: number;
authorId: number;
number: number;
createdAt: GeneratedAlways<number>;
}
export interface TournamentMatchGameResult {
createdAt: Generated<number>;
id: GeneratedAlways<number>;
matchId: number;
mode: ModeShort;
number: number;
reporterId: number;
source: string;
stageId: StageId;
winnerTeamId: number;
opponentOnePoints: number | null;
opponentTwoPoints: number | null;
}
export interface TournamentMatchGameResultParticipant {
matchGameResultId: number;
userId: number;
// it only started mattering when we added the possibility to join many teams in a tournament, null for legacy events
tournamentTeamId: number | null;
}
export interface TournamentResult {
isHighlight: Generated<SqlBool>;
participantCount: number;
placement: number;
tournamentId: number;
tournamentTeamId: number;
userId: number;
}
export interface TournamentRoundMaps {
list?: Array<{ mode: ModeShort; stageId: StageId }> | null;
count: number;
type: "BEST_OF" | "PLAY_ALL";
pickBan?: "COUNTERPICK" | "BAN_2" | null;
}
/**
* A round is a logical structure used to group multiple matches together.
- In round-robin stages, a round can be viewed as a list of matches that can be played at the same time.
- In swiss, a round is a list of matches that are played at the same time.
- In elimination stages, a round is a round of a bracket, e.g. 8th finals, semi-finals, etc.
*/
export interface TournamentRound {
groupId: number;
id: GeneratedAlways<number>;
number: number;
stageId: number;
maps: ColumnType<TournamentRoundMaps | null, string | null, string | null>;
}
export interface TournamentStageSettings {
// SE
thirdPlaceMatch?: boolean;
// RR
teamsPerGroup?: number;
// SWISS
groupCount?: number;
// SWISS
roundCount?: number;
}
export const TOURNAMENT_STAGE_TYPES = [
"single_elimination",
"double_elimination",
"round_robin",
"swiss",
] as const;
/** A stage is an intermediate phase in a tournament. In essence a bracket. */
export interface TournamentStage {
id: GeneratedAlways<number>;
name: string;
number: number;
settings: string;
tournamentId: number;
type: (typeof TOURNAMENT_STAGE_TYPES)[number];
// not Generated<> because SQLite doesn't allow altering tables to add columns with default values :(
createdAt: number | null;
}
export interface TournamentSub {
bestWeapons: string;
/** 0 = no, 1 = yes, 2 = listen only */
canVc: number;
createdAt: Generated<number>;
message: string | null;
okWeapons: string | null;
tournamentId: number;
userId: number;
visibility: "+1" | "+2" | "+3" | "ALL";
}
export interface TournamentStaff {
tournamentId: number;
userId: number;
role: "ORGANIZER" | "STREAMER";
}
export interface TournamentTeam {
createdAt: Generated<number>;
id: GeneratedAlways<number>;
inviteCode: string;
name: string;
prefersNotToHost: Generated<number>;
noScreen: Generated<number>;
droppedOut: Generated<number>;
seed: number | null;
activeRosterUserIds: ColumnType<
number[] | null,
string | null,
string | null
>;
tournamentId: number;
teamId: number | null;
avatarImgId: number | null;
}
export interface TournamentTeamCheckIn {
checkedInAt: number;
/** Which bracket checked in for. If missing is check in for the whole event. */
bracketIdx: number | null;
tournamentTeamId: number;
/** Indicates that this bracket defaults to checked in and this team has been explicitly checked out from it */
isCheckOut: Generated<number>;
}
export interface TournamentTeamMember {
createdAt: Generated<number>;
isOwner: Generated<number>;
inGameName: string | null;
tournamentTeamId: number;
userId: number;
}
export interface TournamentOrganization {
id: GeneratedAlways<number>;
name: string;
slug: string;
description: string | null;
socials: ColumnType<string[] | null, string | null, string | null>;
avatarImgId: number | null;
}
export const TOURNAMENT_ORGANIZATION_ROLES = [
"ADMIN",
"MEMBER",
"ORGANIZER",
"STREAMER",
] as const;
type TournamentOrganizationRole =
(typeof TOURNAMENT_ORGANIZATION_ROLES)[number];
export interface TournamentOrganizationMember {
organizationId: number;
userId: number;
role: TournamentOrganizationRole;
roleDisplayName: string | null;
}
export interface TournamentOrganizationBadge {
organizationId: number;
badgeId: number;
}
export interface TournamentOrganizationSeries {
id: GeneratedAlways<number>;
organizationId: number;
name: string;
description: string | null;
substringMatches: ColumnType<string[], string, string>;
showLeaderboard: Generated<number>;
}
export interface TournamentBracketProgressionOverride {
sourceBracketIdx: number;
destinationBracketIdx: number;
tournamentTeamId: number;
tournamentId: number;
}
export interface TrustRelationship {
trustGiverUserId: number;
trustReceiverUserId: number;
lastUsedAt: number;
}
export interface UnvalidatedUserSubmittedImage {
id: GeneratedAlways<number>;
submitterUserId: number;
url: string;
validatedAt: number | null;
}
export interface UnvalidatedVideo {
eventId: number | null;
id: GeneratedAlways<number>;
submitterUserId: number;
title: string;
type: string;
validatedAt: number | null;
youtubeDate: number;
youtubeId: string;
}
// missing means "neutral"
export type Preference = "AVOID" | "PREFER";
export interface UserMapModePreferences {
modes: Array<{
mode: ModeShort;
preference?: Preference;
}>;
pool: Array<{
mode: ModeShort;
stages: StageId[];
}>;
}
export const BUILD_SORT_IDENTIFIERS = [
"UPDATED_AT",
"TOP_500",
"WEAPON_POOL",
"WEAPON_IN_GAME_ORDER",
"ALPHABETICAL_TITLE",
"MODE",
"HEADGEAR_ID",
"CLOTHES_ID",
"SHOES_ID",
"PUBLIC_BUILD",
"PRIVATE_BUILD",
] as const;
export type BuildSort = (typeof BUILD_SORT_IDENTIFIERS)[number];
export interface User {
/** 1 = permabanned, timestamp = ban active till then */
banned: Generated<number | null>;
bannedReason: string | null;
bio: string | null;
commissionsOpen: Generated<number | null>;
commissionText: string | null;
country: string | null;
css: ColumnType<Record<string, string> | null, string | null, string | null>;
customUrl: string | null;
discordAvatar: string | null;
discordId: string;
discordName: string;
customName: string | null;
/** coalesce(customName, discordName) */
username: ColumnType<string, never, never>;
discordUniqueName: string | null;
favoriteBadgeId: number | null;
id: GeneratedAlways<number>;
inGameName: string | null;
isArtist: Generated<number | null>;
isVideoAdder: Generated<number | null>;
isTournamentOrganizer: Generated<number | null>;
languages: string | null;
motionSens: number | null;
patronSince: number | null;
patronTier: number | null;
patronTill: number | null;
showDiscordUniqueName: Generated<number>;
stickSens: number | null;
twitch: string | null;
twitter: string | null;
bsky: string | null;
battlefy: string | null;
vc: Generated<"YES" | "NO" | "LISTEN_ONLY">;
youtubeId: string | null;
mapModePreferences: ColumnType<
UserMapModePreferences | null,
string | null,
string | null
>;
qWeaponPool: ColumnType<MainWeaponId[] | null, string | null, string | null>;
plusSkippedForSeasonNth: number | null;
noScreen: Generated<number>;
buildSorting: ColumnType<BuildSort[] | null, string | null, string | null>;
}
export interface UserResultHighlight {
teamId: number;
userId: number;
}
export interface UserSubmittedImage {
id: GeneratedAlways<number>;
submitterUserId: number | null;
url: string | null;
validatedAt: number | null;
}
export interface UserWeapon {
createdAt: Generated<number>;
isFavorite: Generated<number>;
order: number;
userId: number;
weaponSplId: MainWeaponId;
}
export interface UserFriendCode {
friendCode: string;
userId: number;
submitterUserId: number;
createdAt: GeneratedAlways<number>;
}
export interface Video {
eventId: number | null;
id: GeneratedAlways<number>;
submitterUserId: number | null;
title: string | null;
type: string | null;
validatedAt: number | null;
youtubeDate: number | null;
youtubeId: string | null;
}
export interface VideoMatch {
id: GeneratedAlways<number>;
mode: ModeShort;
stageId: StageId;
startsAt: number;
videoId: number;
}
export interface VideoMatchPlayer {
player: number;
playerName: string | null;
playerUserId: number | null;
videoMatchId: number;
weaponSplId: number;
}
export interface XRankPlacement {
badges: string;
bannerSplId: number;
id: GeneratedAlways<number>;
mode: ModeShort;
month: number;
name: string;
nameDiscriminator: string;
playerId: number;
power: number;
rank: number;
region: string;
title: string;
weaponSplId: MainWeaponId;
year: number;
}
export type Tables = { [P in keyof DB]: Selectable<DB[P]> };
export type TablesInsertable = { [P in keyof DB]: Insertable<DB[P]> };
export interface DB {
AllTeam: Team;
AllTeamMember: TeamMember;
Art: Art;
ArtTag: ArtTag;
ArtUserMetadata: ArtUserMetadata;
Badge: Badge;
BadgeManager: BadgeManager;
BadgeOwner: BadgeOwner;
Build: Build;
BuildAbility: BuildAbility;
BuildWeapon: BuildWeapon;
CalendarEvent: CalendarEvent;
CalendarEventBadge: CalendarEventBadge;
CalendarEventDate: CalendarEventDate;
CalendarEventResultPlayer: CalendarEventResultPlayer;
CalendarEventResultTeam: CalendarEventResultTeam;
FreshPlusTier: FreshPlusTier;
Group: Group;
GroupLike: GroupLike;
GroupMatch: GroupMatch;
GroupMatchMap: GroupMatchMap;
GroupMember: GroupMember;
PrivateUserNote: PrivateUserNote;
LogInLink: LogInLink;
LFGPost: LFGPost;
MapPoolMap: MapPoolMap;
MapResult: MapResult;
PlayerResult: PlayerResult;
PlusSuggestion: PlusSuggestion;
PlusTier: PlusTier;
PlusVote: PlusVote;
PlusVotingResult: PlusVotingResult;
ReportedWeapon: ReportedWeapon;
Skill: Skill;
SkillTeamUser: SkillTeamUser;
SeedingSkill: SeedingSkill;
SplatoonPlayer: SplatoonPlayer;
TaggedArt: TaggedArt;
Team: Team;
TeamMember: TeamMember;
TeamMemberWithSecondary: TeamMember;
Tournament: Tournament;
TournamentStaff: TournamentStaff;
TournamentBadgeOwner: TournamentBadgeOwner;
TournamentGroup: TournamentGroup;
TournamentMatch: TournamentMatch;
TournamentMatchPickBanEvent: TournamentMatchPickBanEvent;
TournamentMatchGameResult: TournamentMatchGameResult;
TournamentMatchGameResultParticipant: TournamentMatchGameResultParticipant;
TournamentResult: TournamentResult;
TournamentRound: TournamentRound;
TournamentStage: TournamentStage;
TournamentSub: TournamentSub;
TournamentTeam: TournamentTeam;
TournamentTeamCheckIn: TournamentTeamCheckIn;
TournamentTeamMember: TournamentTeamMember;
TournamentOrganization: TournamentOrganization;
TournamentOrganizationMember: TournamentOrganizationMember;
TournamentOrganizationBadge: TournamentOrganizationBadge;
TournamentOrganizationSeries: TournamentOrganizationSeries;
TournamentBracketProgressionOverride: TournamentBracketProgressionOverride;
TrustRelationship: TrustRelationship;
UnvalidatedUserSubmittedImage: UnvalidatedUserSubmittedImage;
UnvalidatedVideo: UnvalidatedVideo;
User: User;
UserResultHighlight: UserResultHighlight;
UserSubmittedImage: UserSubmittedImage;
UserWeapon: UserWeapon;
UserFriendCode: UserFriendCode;
Video: Video;
VideoMatch: VideoMatch;
VideoMatchPlayer: VideoMatchPlayer;
XRankPlacement: XRankPlacement;
}