@koloseum/types 0.1.0

package/types/database.d.ts

@@ -0,0 +1,314 @@
+import type { Database as DatabaseGenerated } from "./database-generated";
+import type {
+	AccountType,
+	AppRole,
+	BranchAddressObject,
+	BranchAmenitiesObject,
+	CompanyInformationUpdateJson,
+	CompanyVerificationDataObject,
+	GamingSocialsDataObject,
+	GenderIdentity,
+	Institution,
+	InstitutionNameIssue,
+	MinorRelation,
+	PersonVerificationLogDataObject,
+	PersonalDataUpdateRequestJson,
+	PhoneOTPRequestStatus,
+	PhoneOTPSendCodeAttempt,
+	PronounsItem,
+	RegistrationCheckObject,
+	RegistrationStep,
+	Sex,
+	SocialMediaPlatform,
+} from "./public/auth";
+
+import { MergeDeep } from "type-fest";
+
+export type Database = MergeDeep<
+	DatabaseGenerated,
+	{
+		compliance: {
+			Tables: {
+				active_registrations: {
+					Row: {
+						current_step: RegistrationStep<AccountType>;
+						type: AccountType;
+					};
+					Insert: {
+						current_step: RegistrationStep<AccountType>;
+						type: AccountType;
+					};
+					Update: {
+						current_step?: RegistrationStep<AccountType>;
+						type?: AccountType;
+					};
+				};
+				data_update_requests: {
+					Row: {
+						account_type: AccountType;
+						updates: PersonalDataUpdateRequestJson | CompanyInformationUpdateJson;
+					};
+					Insert: {
+						account_type: AccountType;
+						updates: PersonalDataUpdateRequestJson | CompanyInformationUpdateJson;
+					};
+					Update: {
+						account_type: AccountType;
+						updates: PersonalDataUpdateRequestJson | CompanyInformationUpdateJson;
+					};
+				};
+				data_updates: {
+					Row: {
+						account_type: AccountType;
+						updates: PersonalDataUpdateRequestJson | CompanyInformationUpdateJson;
+					};
+					Insert: {
+						account_type: AccountType;
+						updates: PersonalDataUpdateRequestJson | CompanyInformationUpdateJson;
+					};
+					Update: {
+						account_type: AccountType;
+						updates: PersonalDataUpdateRequestJson | CompanyInformationUpdateJson;
+					};
+				};
+				lounge_branches: {
+					Row: {
+						address: BranchAddressObject;
+						amenities: BranchAmenitiesObject | null;
+					};
+					Insert: {
+						address: BranchAddressObject;
+						amenities?: BranchAmenitiesObject | null;
+					};
+					Update: {
+						address?: BranchAddressObject;
+						amenities?: BranchAmenitiesObject | null;
+					};
+				};
+				lounge_company_verification_attempts: {
+					Row: {
+						company_data: Omit<CompanyVerificationDataObject, "companyNumber" | "dateOfDissolution" | "countryCode">;
+					};
+					Insert: {
+						company_data: Omit<CompanyVerificationDataObject, "companyNumber" | "dateOfDissolution" | "countryCode">;
+					};
+					Update: {
+						company_data?: Omit<CompanyVerificationDataObject, "companyNumber" | "dateOfDissolution" | "countryCode">;
+					};
+				};
+				lounge_staff: {
+					Row: {
+						gender_identity: GenderIdentity | null;
+						pronouns: PronounsItem[] | null;
+						role: AppRole;
+						sex: Sex;
+					};
+					Insert: {
+						gender_identity?: GenderIdentity | null;
+						pronouns?: PronounsItem[] | null;
+						role: AppRole;
+						sex?: Sex;
+					};
+					Update: {
+						gender_identity?: GenderIdentity | null;
+						pronouns?: PronounsItem[] | null;
+						role?: AppRole;
+						sex?: Sex;
+					};
+				};
+				lounge_staff_verification_attempts: {
+					Row: {
+						person_data: PersonVerificationLogDataObject | null;
+					};
+					Insert: {
+						person_data: PersonVerificationLogDataObject | null;
+					};
+					Update: {
+						person_data: PersonVerificationLogDataObject | null;
+					};
+				};
+				player_id_verification_attempts: {
+					Row: {
+						person_data: PersonVerificationLogDataObject | null;
+					};
+					Insert: {
+						person_data: PersonVerificationLogDataObject | null;
+					};
+					Update: {
+						person_data: PersonVerificationLogDataObject | null;
+					};
+				};
+				player_minor_rep_personal_details: {
+					Row: {
+						gender_identity: GenderIdentity | null;
+						pronouns: PronounsItem[] | null;
+						sex: Sex;
+					};
+					Insert: {
+						gender_identity?: GenderIdentity | null;
+						pronouns?: PronounsItem[] | null;
+						sex?: Sex;
+					};
+					Update: {
+						gender_identity?: GenderIdentity | null;
+						pronouns?: PronounsItem[] | null;
+						sex?: Sex;
+					};
+				};
+				player_minor_rep_id_verification_attempts: {
+					Row: {
+						person_data: PersonVerificationLogDataObject | null;
+					};
+					Insert: {
+						person_data: PersonVerificationLogDataObject | null;
+					};
+					Update: {
+						person_data: PersonVerificationLogDataObject | null;
+					};
+				};
+				player_minor_rep_phone_verification_attempts: {
+					Row: {
+						send_code_attempts: PhoneOTPSendCodeAttempt[];
+					};
+					Insert: {
+						send_code_attempts: PhoneOTPSendCodeAttempt[];
+						created_at: Date;
+						updated_at: Date;
+					};
+					Update: {
+						updated_at: Date;
+					};
+				};
+				player_minor_reps: {
+					Insert: {
+						relation?: MinorRelation;
+					};
+					Update: {
+						relation?: MinorRelation;
+					};
+				};
+				player_socials: {
+					Row: {
+						platform: SocialMediaPlatform;
+					};
+					Insert: {
+						platform: SocialMediaPlatform;
+					};
+					Update: {
+						platform?: SocialMediaPlatform;
+					};
+				};
+				players: {
+					Row: {
+						gender_identity: GenderIdentity | null;
+						pronouns: PronounsItem[] | null;
+						sex: Sex;
+					};
+					Insert: {
+						gender_identity?: GenderIdentity | null;
+						pronouns?: PronounsItem[] | null;
+						sex?: Sex;
+					};
+					Update: {
+						gender_identity?: GenderIdentity | null;
+						pronouns?: PronounsItem[] | null;
+						sex?: Sex;
+					};
+				};
+			};
+			Functions: {
+				create_lounge_staff: {
+					Args: {
+						p_sex: Sex;
+						p_role?: AppRole;
+						p_gender_identity?: GenderIdentity;
+						p_pronouns?: PronounsItem[];
+					};
+				};
+				create_player: {
+					Args: {
+						p_sex: Sex;
+						p_gender_identity?: GenderIdentity;
+						p_pronouns?: PronounsItem[];
+					};
+				};
+				create_player_minor_rep: {
+					Args: {
+						p_sex: Sex;
+						p_relation: MinorRelation;
+						p_gender_identity?: GenderIdentity;
+						p_pronouns?: PronounsItem[];
+					};
+				};
+				create_varsity_stint: {
+					Args: {
+						p_institution_code: string | null;
+						p_institution_name_issue?: InstitutionNameIssue;
+					};
+				};
+				extract_names: {
+					Returns: {
+						first_name: string;
+						middle_names: string | null;
+						last_name: string;
+					}[];
+				};
+				gen_platform_id: {
+					Args: {
+						account_type: AccountType;
+					};
+				};
+				get_active_registration: {
+					Returns: Omit<RegistrationCheckObject<"player">, "error"> | Omit<RegistrationCheckObject<"lounge">, "error">;
+				};
+				get_player_ids: {
+					Returns: {
+						r_user_id: string | null;
+						r_player_id: string;
+					}[];
+				};
+				link_existing_minor_rep: {
+					Args: {
+						p_minor_relation: MinorRelation;
+						p_other_relation: string | null;
+					};
+				};
+				log_minor_rep_phone_verification: {
+					Args: {
+						p_status: PhoneOTPRequestStatus;
+						p_updated_at: Date;
+						p_send_code_attempts?: PhoneOTPSendCodeAttempt[];
+						p_created_at?: Date;
+					};
+				};
+				minor_rep_phone: {
+					Returns: string | null;
+				};
+				submit_gaming_and_socials_data: {
+					Args: {
+						p_primary_platform: GamingSocialsDataObject["primaryPlatform"];
+						p_consoles: GamingSocialsDataObject["consoles"] | null;
+						p_socials: GamingSocialsDataObject["socials"] | null;
+					};
+				};
+				validate_pronouns: {
+					Args: {
+						pronouns: PronounsItem[];
+					};
+				};
+			};
+			Enums: {
+				registration_step: 1 | 2 | 3 | 4 | 0;
+			};
+		};
+		public: {
+			Tables: {
+				varsity_institutions: {
+					Row: Institution;
+					Insert: Institution;
+					Update: Institution;
+				};
+			};
+		};
+	}
+>;

package/types/public/auth.d.ts

@@ -0,0 +1,371 @@
+import type { User } from "@supabase/supabase-js";
+import type { Database } from "../database";
+
+/* GENERAL */
+export type AccountType = "player" | "lounge";
+
+export type AppRole = Database["compliance"]["Enums"]["app_role"] | null;
+
+export interface AuthenticationJWT {
+	aud: string;
+	exp: number;
+	iat: number;
+	sub: string;
+	email: string;
+	phone: string;
+	app_metadata: {
+		provider: string;
+		providers: string[];
+		role: AppRole;
+	};
+	user_metadata: {
+		email_verified: boolean;
+		phone_verified: boolean;
+		sub: string;
+	};
+	role: string;
+	aal: string;
+	amr: [{ method: string; timestamp: number }];
+	session_id: string;
+	is_anonymous: boolean;
+}
+
+export type AuthenticationType = "login" | "register" | "otp";
+
+export interface CustomError {
+	code: number;
+	message: string;
+}
+
+export interface IGDBPlatformsResponse {
+	id: number;
+	abbreviation: string;
+	category: number;
+	generation: number;
+	name: string;
+	platform_family: number;
+}
+
+export type UserWithRole = User & { app_metadata: { role: AppRole } };
+
+/* REGISTRATION */
+export type PlayerRegistrationStep = Database["compliance"]["Enums"]["registration_step"];
+
+export type LoungeRegistrationStep = Exclude<Database["compliance"]["Enums"]["registration_step"], 4>;
+
+export type RegistrationStep<AccountType> = AccountType extends "player" ? PlayerRegistrationStep : LoungeRegistrationStep;
+
+export interface RegistrationCheckObject<AccountType> {
+	type?: AccountType;
+	currentStep?: RegistrationStep<AccountType>;
+	verifiedData?: AccountType extends "player" ? PersonVerificationDataObject : CompanyVerificationDataObject;
+	superuserData?: AccountType extends "player" ? undefined : PlayerInformationObject;
+	completed?: boolean;
+	error?: CustomError;
+}
+
+export interface RegistrationStepObject<AccountType> {
+	number: RegistrationStep<AccountType>;
+	label: string;
+	title: string;
+	caption: string;
+}
+
+/* PLAYER */
+// OTP verification
+export interface PhoneOTPData {
+	awaitingOTP: boolean;
+	dateUpdated?: Date;
+	phoneToVerify?: string;
+	existingMinorRepData?: ExistingMinorRepDataObject;
+	verifiedPhone?: string;
+}
+
+export interface OTPInputProperties {
+	name: string;
+	type: string;
+	label: string;
+	placeholder: string;
+	autocomplete: string;
+	buttonLabel: string;
+}
+
+export type PhoneOTPRequestStatus = Database["compliance"]["Enums"]["twilio_verification_status"];
+
+export interface PhoneOTPSendCodeAttempt {
+	attempt_sid: string;
+	channel: string;
+	time: string;
+}
+
+// ID verification
+export interface IdentityCountry {
+	name: string;
+	code: string;
+}
+
+export interface IdentityTitleData {
+	currentStep: PlayerRegistrationStep;
+	title: string;
+	caption: string;
+}
+
+export type IdentityType = Database["compliance"]["Enums"]["id_type"];
+
+export interface IdentityTypeObject {
+	type: IdentityType;
+	label: string;
+}
+
+export interface IdentityDataObject {
+	country: string;
+	type: IdentityType;
+	number: string;
+	isForMinorRep: boolean;
+}
+
+export type IdentityVerificationRequestObject = Omit<IdentityDataObject, "isForMinorRep">;
+
+export interface RawPersonVerificationDataObject {
+	firstName: string;
+	middleNames: string;
+	lastName: string;
+	dateOfBirth: string;
+	dateOfIssue: string;
+	dateOfExpiry?: string;
+	phone?: string;
+	minorRepPhone?: string;
+	identityType: IdentityType;
+	identityCountry: string;
+}
+
+export type PersonVerificationLogDataObject = Omit<RawPersonVerificationDataObject, "phone" | "minorRepPhone" | "identityType" | "identityCountry">;
+
+export type PersonVerificationDataObject = Omit<RawPersonVerificationDataObject, "dateOfIssue" | "dateOfExpiry">;
+
+export type PersonInformationObject = Omit<PersonVerificationDataObject, "phone" | "minorRepPhone">;
+
+export type PlayerInformationObject = Omit<PersonInformationObject, "dateOfIssue" | "dateOfExpiry">;
+
+export interface ExistingMinorRepDataObject {
+	userId: string;
+	playerId?: string;
+	relation: MinorRelation;
+	otherRelation?: string;
+}
+
+// Personal information
+export type GenderIdentity = Database["compliance"]["Enums"]["gender_identity"];
+
+export interface GenderIdentityObject {
+	name: GenderIdentity;
+	info: string;
+}
+
+export type MinorRelation = Database["compliance"]["Enums"]["minor_relation"];
+
+export type PronounsCheckboxes = {
+	[key in PronounsType]?: HTMLInputElement;
+};
+
+export type PronounsItem = Database["compliance"]["Enums"]["pronouns"];
+
+export interface PronounsObject {
+	type: PronounsType;
+	value: PronounsItem;
+}
+
+export type PronounsType = "male" | "female" | "neutral" | "none";
+
+export type Sex = Database["compliance"]["Enums"]["sex"] | null;
+
+export interface SexObject {
+	value: Sex;
+	label: string;
+}
+
+// Varsity
+export interface Institution {
+	code: string;
+	name: string;
+}
+
+export type InstitutionNameIssue = Database["compliance"]["Enums"]["institution_name_issue"];
+
+// Validation
+export interface PersonalDataFormattingObject {
+	formattedFirstName?: string;
+	formattedMiddleNames?: string;
+	formattedLastName?: string;
+	formattedBirthDate?: string;
+	scannedIdCopy?: File;
+}
+
+export interface PersonalDataObject {
+	firstName: string;
+	middleNames?: string;
+	lastName: string;
+	pseudonym?: string;
+	dateOfBirth: string;
+	showDateOfBirth: boolean;
+	nationality: string;
+	sex: Sex;
+	genderIdentity?: GenderIdentity;
+	pronouns?: PronounsItem[];
+	showPronouns?: boolean;
+	relation?: MinorRelation;
+	otherRelation?: string;
+}
+
+export interface PersonalDataUpdateRequestJson {
+	firstName?: { old: string; new: string };
+	middleNames?: { old: string | null; new: string | null };
+	lastName?: { old: string; new: string };
+	dateOfBirth?: { old: string; new: string };
+}
+
+export interface VarsityDataObject {
+	institutionCode?: string;
+	institutionNameIssue?: InstitutionNameIssue;
+	formattedInstitutionName?: string;
+	enrollmentYear?: number;
+	graduationYear?: number;
+}
+
+// Gaming and socials
+export interface GameConsole {
+	id: string;
+	name: string;
+	quantity?: number;
+	platformShorthand: string;
+}
+
+export interface GamePlatform {
+	name: string;
+	shorthand: string;
+	onlineName: string | null;
+}
+
+export type SocialMediaPlatform = Database["public"]["Enums"]["social_media_platform"];
+
+export interface SocialMediaPlatformObject {
+	value: SocialMediaPlatform;
+	linkPrefix: string;
+}
+
+export interface PlayerSocialsObject {
+	platform: SocialMediaPlatformObject;
+	handle: string;
+}
+
+export interface GamingSocialsDataObject {
+	primaryPlatform: {
+		platformShorthand: string;
+		username: string | null;
+	};
+	consoles?: {
+		consoleId: string;
+		quantity: number;
+		isPrimary: boolean;
+	}[];
+	socials?: {
+		platform: SocialMediaPlatform;
+		handle: string;
+	}[];
+}
+
+/* LOUNGE */
+// Company registration //
+export interface CompanyDataObject {
+	companyNumber: string;
+	countryCode: string;
+}
+
+export interface CompanyPerson {
+	firstName: string;
+	middleNames?: string;
+	lastName: string;
+	number: string;
+}
+
+export interface CompanyVerificationDataObject {
+	companyName: string;
+	companyNumber: string;
+	companyType: string;
+	dateOfRegistration: string;
+	dateOfDissolution?: string;
+	countryCode: string;
+	persons: CompanyPerson[];
+}
+
+export interface CompanyInformationObject {
+	companyName: string;
+	dateOfRegistration: string;
+	tradeName?: string;
+	website?: string;
+}
+
+export interface CompanyInformationFormattingObject {
+	formattedCompanyName?: string;
+	formattedRegistrationDate?: string;
+	registrationCertificateCopy?: File;
+}
+
+export interface CompanyInformationUpdateJson {
+	companyName?: { old: string; new: string };
+	dateOfRegistration?: { old: string; new: string };
+	tradeName?: { old: string | null; new: string | null };
+}
+
+// Superuser registration
+export type SuperuserIdentityDataObject = Omit<IdentityDataObject, "isForMinorRep">;
+
+export type SuperuserPersonalDataObject = Omit<PersonalDataObject, "showDateOfBirth" | "relation" | "otherRelation">;
+
+// Branch information
+export interface County {
+	name: string;
+	code: number;
+	subCounties: string[];
+}
+
+export type LuggageDepositType = Database["compliance"]["Enums"]["luggage_deposit_type"];
+
+export interface LuggageDepositObject {
+	type: LuggageDepositType;
+	slots: number;
+}
+
+export interface FibreInternetObject {
+	provider: string;
+	speed: number;
+}
+
+export interface BranchAddressObject {
+	buildingName: string;
+	unitNumber?: string;
+	streetName: string;
+	boxNumber?: string;
+	postalCode?: string;
+	town: string;
+	subCounty: string;
+	county: string;
+}
+
+export interface BranchAmenitiesObject {
+	washrooms?: string;
+	luggageDeposit?: LuggageDepositObject;
+	internet?: FibreInternetObject;
+	cctvCameras?: number;
+	fireExits?: number;
+	parking?: string;
+	eatery?: boolean;
+}
+
+export interface BranchInformationObject {
+	name: string;
+	address: BranchAddressObject;
+	amenities: BranchAmenitiesObject | null;
+	phone: string;
+	email?: string;
+}