@koloseum/types 0.3.5 → 0.3.7

package/dist/database.d.ts

@@ -1,7 +1,8 @@
 import type { Database as DatabaseGenerated } from "./database-generated.js";
 import type { AccountType, DataUpdateRequestStatus, PhoneOTPRequestStatus, PhoneOTPSendCodeAttempt } from "./general.js";
-import type { BranchAddressObject, BranchAmenitiesObject, CompanyInformationUpdateJson, CompanyInformationUpdateRequestJson, CompanyVerificationDataObject, GamingSocialsDataObject, GenderIdentity, Institution, InstitutionNameIssue, MinorRelation, PersonVerificationLogDataObject, PersonalDataUpdateJson, PersonalDataUpdateRequestJson, PlayerRegistrationStep, PronounsItem, RegistrationCheckObject, RegistrationStep, Sex, SocialMediaPlatform } from "./public/auth.js";
+import type { ActiveLounge, ActivePlayer, BranchAddressObject, BranchAmenitiesObject, CompanyInformationUpdateJson, CompanyInformationUpdateRequestJson, CompanyVerificationDataObject, GamingSocialsDataObject, GenderIdentity, Institution, InstitutionNameIssue, MinorRelation, PersonVerificationLogDataObject, PersonalDataUpdateJson, PersonalDataUpdateRequestJson, PlayerRegistrationStep, PronounsItem, RegistrationCheckObject, RegistrationStep, Sex, SocialMediaPlatform } from "./public/auth.js";
 import type { TournamentMetadata } from "./players/competitions.js";
+import type { CurrentSession, LoungeBranchData, LoungeBranchGame, LoungeBranchStation, LoungeBranchWithOpenStatus, LoungeWithBranches, LuggageSlotParam, MinorRepSessionConsentContext, PastSession, PendingSessionInvite, SessionBillCostSnapshot, SessionBillData, SessionData, SessionMemberStatus, SessionStartData } from "./players/sessions.js";
 import { MergeDeep } from "type-fest";
 export type Database = MergeDeep<DatabaseGenerated, {
     competitions: {
@@ -312,6 +313,14 @@ export type Database = MergeDeep<DatabaseGenerated, {
                     p_created_at?: Date;
                 };
             };
+            render_pronouns: {
+                Args: {
+                    p_pronouns: PronounsItem[];
+                    p_sex: Sex;
+                    p_show_pronouns: boolean;
+                };
+                Returns: PronounsItem[];
+            };
             search_players: {
                 Returns: {
                     id: string;
@@ -360,5 +369,136 @@ export type Database = MergeDeep<DatabaseGenerated, {
                 Update: Institution;
             };
         };
+        Functions: {
+            search_active_lounges: {
+                Returns: ActiveLounge[];
+            };
+            search_active_players: {
+                Returns: ActivePlayer[];
+            };
+        };
+    };
+    sessions: {
+        Functions: {
+            accept_session_invite: {
+                Returns: {
+                    session_id: string;
+                    needs_minor_rep_consent: boolean;
+                };
+            };
+            add_eatery_cart_item: {
+                Args: {
+                    p_item_id: string;
+                    p_item_snapshot: Record<string, unknown>;
+                    p_quantity: number;
+                    p_session_id: string;
+                    p_unit_price_cents: number;
+                };
+            };
+            cancel_pending_session: {
+                Returns: string | null;
+            };
+            compute_final_session_cost: {
+                Returns: number;
+            };
+            compute_session_bill_cost: {
+                Returns: SessionBillCostSnapshot;
+            };
+            create_session: {
+                Args: {
+                    p_discount_id?: string;
+                    p_games_consoles_id: string;
+                    p_invited_luggage_slots?: (LuggageSlotParam | null)[];
+                    p_invited_player_ids?: string[];
+                    p_is_reservation?: boolean;
+                    p_lounge_branch_id: string;
+                    p_luggage_slot?: LuggageSlotParam | null;
+                    p_option_id: string;
+                    p_station_id: string;
+                    p_units?: number;
+                };
+            };
+            get_current_session: {
+                Returns: CurrentSession;
+            };
+            get_lounge_branches_with_open_status: {
+                Returns: LoungeBranchWithOpenStatus[];
+            };
+            get_lounge_branch_data: {
+                Returns: LoungeBranchData;
+            };
+            get_lounge_branch_games: {
+                Returns: LoungeBranchGame[];
+            };
+            get_lounge_branch_stations: {
+                Returns: LoungeBranchStation[];
+            };
+            get_lounge_with_branches: {
+                Returns: LoungeWithBranches;
+            };
+            get_minor_rep_consent_context_for_session: {
+                Returns: MinorRepSessionConsentContext;
+            };
+            get_past_sessions: {
+                Returns: PastSession[];
+            };
+            get_pending_invite_for_current_player: {
+                Returns: PendingSessionInvite;
+            };
+            get_session_bill_data: {
+                Returns: SessionBillData;
+            };
+            get_session_data: {
+                Returns: SessionData;
+            };
+            get_session_start_data: {
+                Returns: SessionStartData;
+            };
+            invite_players_to_session: {
+                Args: {
+                    p_capacity?: number;
+                    p_players: {
+                        player_id: string;
+                        luggage_slots: LuggageSlotParam[];
+                    }[];
+                    p_session_id: string;
+                    p_station_id?: string;
+                };
+            };
+            is_game_available_for_session: {
+                Returns: {
+                    code: number;
+                    is_available: boolean;
+                    reason: string | null;
+                };
+            };
+            is_station_available_for_session: {
+                Returns: {
+                    code: number;
+                    is_available: boolean;
+                    reason: string | null;
+                };
+            };
+            is_reservation_available_at_lounge_branch: {
+                Returns: {
+                    code: number;
+                    is_available: boolean;
+                    reason: string | null;
+                };
+            };
+            is_session_member: {
+                Args: {
+                    p_member_statuses?: SessionMemberStatus[];
+                    p_session_id: string;
+                };
+            };
+            request_change_for_session: {
+                Returns: {
+                    session_id: string;
+                    station_request_id: string | null;
+                    game_request_id: string | null;
+                };
+            };
+        };
     };
 }>;

package/dist/external/suprsend.d.ts

@@ -1,15 +1,11 @@
 /**
- * Notification body for SuprSend workflow. Points to note:
+ * Notification body for SuprSend workflow.
  * - `delay` is the time delay after which the first notification will be sent
  * - `trigger_at` is the date string in ISO 8601 to trigger scheduled notifications
- * - `users` is the array of users to send the notification to
- * - `users[i].distinct_id` is the unique identifier of the user
- * - `users[i].$channels` is the array of channels to send the notification to
- * - `users[i].$email` is the email address to send the notification to
- * - `users[i].$whatsapp` is the WhatsApp number to send the notification to
- * - `delivery` is the delivery instruction for the notification, dictating how should notifications be sent and the success metric
- * - `delivery.time_to_live` and `delivery.mandatory_channels` will only be applicable if `delivery.smart` is true
- * - `data` is the data for the notification, can be any JSON
+ * - `users` is the array of users to send the notification to (legacy shape; API uses `recipients`)
+ * - `users[i]` / recipients: use WorkflowRecipient for type-safe construction
+ * - `delivery` is the delivery instruction for the notification
+ * - `data` is the variable data for the notification template
  * @see https://docs.suprsend.com/docs/node-trigger-workflow-from-api#dynamic-workflow-trigger
  */
 export interface WorkflowBody {
@@ -18,52 +14,96 @@ export interface WorkflowBody {
     notification_category: "transactional" | "promotional" | "system";
     delay?: string;
     trigger_at?: string;
-    users: {
-        distinct_id: string;
-        $channels?: string[];
-        $email?: string[];
-        $whatsapp?: string[];
-        $sms?: string[];
-        $androidpush?: {
-            token: string;
-            provider: string;
-            device_id: string;
-        }[];
-        $iospush?: {
-            token: string;
-            provider: string;
-            device_id: string;
-        }[];
-        $slack?: {
-            email?: string;
-            access_token: string;
-        } | {
-            user_id?: string;
-            access_token: string;
-        } | {
-            channel?: string;
-            access_token: string;
-        } | {
-            incoming_webhook: {
-                url: string;
-            };
-        };
-        $ms_teams?: {
-            tenant_id: string;
-            service_url: string;
-            conversation_id?: string;
-            user_id?: string;
-        } | {
-            incoming_webhook: {
-                url: string;
-            };
-        };
-    }[];
+    users: WorkflowRecipient[];
     delivery?: {
         smart: boolean;
         success: string;
         time_to_live?: string;
         mandatory_channels?: string[];
     };
-    data?: Record<string, any>;
+    data?: Record<string, unknown>;
+}
+/**
+ * One recipient in a SuprSend workflow trigger.
+ * - each item is either a user recipient (WorkflowUserRecipient) or an object recipient (WorkflowObjectRecipient)
+ * - used in the `recipients` array of the workflow trigger body (SuprSend API uses `recipients`; this codebase may alias as `users`)
+ * - custom properties on the recipient are available in templates as `$recipient.<property>`
+ * @see https://docs.suprsend.com/docs/node-trigger-workflow-from-api#identifying-recipients-inline
+ */
+export type WorkflowRecipient = WorkflowUserRecipient | WorkflowObjectRecipient;
+/**
+ * User recipient in a SuprSend workflow trigger.
+ * - `distinct_id` is the unique identifier of the user (e.g. platform user id)
+ * - `$channels` is the array of channels to send the notification to (email, sms, inbox, androidpush, iospush, slack, ms_teams, webpush, whatsapp)
+ * - `$email` is the array of email addresses to send the notification to
+ * - `$sms` is the array of phone numbers for SMS
+ * - `$whatsapp` is the array of WhatsApp numbers
+ * - `$preferred_language` is the recipient language (ISO 639-1 2-letter) for localisation
+ * - `$timezone` is the recipient timezone (IANA TZ identifier) for local-time delivery
+ * - `$skip_create` when true, do not auto-create the user in SuprSend (use when the user is already synced, e.g. from DB triggers)
+ * - additional keys are custom properties and are available in templates as `$recipient.<key>`
+ * @see https://docs.suprsend.com/docs/node-trigger-workflow-from-api#identifying-recipients-inline
+ */
+export interface WorkflowUserRecipient {
+    distinct_id: string;
+    $channels?: string[];
+    $email?: string[];
+    $sms?: string[];
+    $whatsapp?: string[];
+    $preferred_language?: string;
+    $timezone?: string;
+    $skip_create?: boolean;
+    $androidpush?: {
+        token: string;
+        provider: string;
+        device_id: string;
+    }[];
+    $iospush?: {
+        token: string;
+        provider: string;
+        device_id: string;
+    }[];
+    $slack?: {
+        email?: string;
+        access_token: string;
+    } | {
+        user_id?: string;
+        access_token: string;
+    } | {
+        channel?: string;
+        access_token: string;
+    } | {
+        incoming_webhook: {
+            url: string;
+        };
+    };
+    $ms_teams?: {
+        tenant_id: string;
+        service_url: string;
+        conversation_id?: string;
+        user_id?: string;
+    } | {
+        incoming_webhook: {
+            url: string;
+        };
+    };
+    [key: string]: string | string[] | boolean | number | object | undefined;
+}
+/**
+ * Object recipient in a SuprSend workflow trigger (non-user entity, e.g. team, channel, shared inbox). Points to note:
+ * - `object_type` is the type of the object (e.g. teams, departments)
+ * - `id` is the unique identifier of the object within that type
+ * - `$skip_create` when true, do not auto-create the object in SuprSend
+ * - `$email` is the array of email addresses for the object (e.g. shared inbox)
+ * - `$channels` is the array of channels to send the notification to
+ * - additional keys are custom properties and are available in templates as `$recipient.<key>`
+ * @see https://docs.suprsend.com/docs/node-trigger-workflow-from-api#identifying-recipients-inline
+ */
+export interface WorkflowObjectRecipient {
+    object_type: string;
+    id: string;
+    $skip_create?: boolean;
+    $email?: string[];
+    $channels?: string[];
+    [key: string]: string | string[] | boolean | number | object | undefined;
 }

package/dist/external/twilio.d.ts

@@ -0,0 +1,16 @@
+import type { PhoneOTPSendCodeAttempt } from "../general.js";
+export interface TwilioRequestOtpResponse {
+    sid: string;
+    to: string;
+    status: string;
+    sendCodeAttempts: PhoneOTPSendCodeAttempt[];
+    dateCreated: string;
+    dateUpdated: string;
+}
+export interface TwilioVerifyOtpResponse {
+    sid: string;
+    to: string;
+    status: string;
+    dateCreated: string;
+    dateUpdated: string;
+}

package/dist/players/sessions.d.ts

@@ -0,0 +1,230 @@
+import type { Database } from "../database-generated.js";
+import type { BranchAddressObject, BranchAmenitiesObject } from "../public/auth.js";
+export interface AvailableLuggageSlot {
+    id: string;
+    slot_label: string;
+    quantity: number;
+    available_quantity: number;
+}
+export interface CurrentSession {
+    id: string;
+    status: SessionStatus;
+    lounge_branch_id: string;
+    lounge_id: string;
+    branch_name: string;
+    started_at: string;
+    checkout_requested_at: string | null;
+}
+export interface LuggageSlotParam {
+    id: string;
+    quantity: number;
+}
+export interface MinorRepSessionConsentContext {
+    session_role: SessionRole;
+    session_created_at: string;
+    minor_rep_phone: string | null;
+    otp_sent_at: string | null;
+    verified_at: string | null;
+}
+export interface PastSession {
+    id: string;
+    status: SessionStatus;
+    lounge_branch_id: string;
+    lounge_id: string;
+    branch_name: string;
+    started_at: string | null;
+    ended_at: string | null;
+    cancelled_at: string | null;
+    duration_text: string | null;
+}
+export interface PendingSessionInvite {
+    player_id: string;
+    inviter_player_id: string;
+    member_id: string;
+    member_created_at: string;
+    minor_rep_phone: string | null;
+    session_status: SessionStatus;
+    started_at: string;
+}
+export type PlayerSession = Database["sessions"]["Tables"]["player_sessions"]["Row"];
+export type PlayerSessionAssistanceRequest = Database["sessions"]["Tables"]["player_session_assistance_requests"]["Row"];
+export type PlayerSessionBill = Database["sessions"]["Tables"]["player_session_bills"]["Row"];
+export type PlayerSessionEateryCart = Database["sessions"]["Tables"]["player_session_eatery_cart"]["Row"];
+export type PlayerSessionEateryCartItem = Database["sessions"]["Tables"]["player_session_eatery_cart_items"]["Row"];
+export type PlayerSessionEateryOrder = Database["sessions"]["Tables"]["player_session_eatery_orders"]["Row"] & {
+    items: PlayerSessionEateryOrderItem[];
+};
+export type PlayerSessionEateryOrderItem = Database["sessions"]["Tables"]["player_session_eatery_order_items"]["Row"];
+export type PlayerSessionGame = Database["sessions"]["Tables"]["player_session_games"]["Row"];
+export type PlayerSessionMember = Database["sessions"]["Tables"]["player_session_members"]["Row"];
+export type PlayerSessionRatings = Database["sessions"]["Tables"]["player_session_ratings"]["Row"];
+export type PlayerSessionsRegularPreferences = Database["sessions"]["Tables"]["player_sessions_regular_preferences"]["Row"];
+export type PlayerSessionStation = Database["sessions"]["Tables"]["player_session_stations"]["Row"];
+export type SessionBillCostSnapshot = {
+    base_cents: number;
+    final_cents: number;
+    discount_applied: ({
+        name: string;
+    } & (({
+        type: "regular";
+    } & ({
+        amount_cents: number;
+        percentage: null;
+    } | {
+        amount_cents: null;
+        percentage: number;
+    })) | {
+        type: "incremental_time";
+        percentage: number;
+    })) | null;
+    duration_minutes?: number;
+    units?: number;
+};
+export interface SessionBillData {
+    bill_type: SessionBillType;
+    option_id: string;
+    station_id: string;
+    games_consoles_id: string;
+    station_number: string;
+    console_name: string;
+    game_name: string;
+}
+export type SessionBillType = Database["sessions"]["Enums"]["session_bill_type"];
+export interface SessionData {
+    session: PlayerSession & {
+        bill_type: SessionBillType;
+        members: SessionDataMember[];
+        stations: PlayerSessionStation[];
+        games: PlayerSessionGame[];
+        bills: PlayerSessionBill[];
+        assistance_requests: PlayerSessionAssistanceRequest[];
+        eatery: {
+            cart: (PlayerSessionEateryCart & {
+                items: PlayerSessionEateryCartItem[];
+            }) | null;
+            orders: PlayerSessionEateryOrder[];
+        } | null;
+        ratings: PlayerSessionRatings | null;
+    };
+    branch: {
+        info: LoungeBranch;
+        stations: LoungeBranchStation[];
+        games: LoungeBranchGame[];
+        session_bill_options: LoungeBranchSessionBillOption[];
+        payment_options: LoungeBranchPaymentOption[];
+        available_luggage_slots: AvailableLuggageSlot[];
+        eatery: {
+            categories: LoungeBranchEateryCategory[];
+            items: LoungeBranchEateryItem[];
+        } | null;
+    };
+}
+export type SessionDataMember = PlayerSessionMember & {
+    name: string;
+    luggage_slots: SessionMemberLuggageSlot[];
+};
+export type SessionEateryOrderStatus = Database["sessions"]["Enums"]["session_eatery_order_status"];
+export type SessionLuggageSlotStatus = Database["sessions"]["Enums"]["session_luggage_slot_status"];
+export type SessionMemberLuggageSlot = Database["sessions"]["Tables"]["player_session_luggage_slots"]["Row"] & {
+    slot_label: string;
+};
+export type SessionMemberStatus = Database["sessions"]["Enums"]["session_member_status"];
+export type SessionRole = "owner" | "invited";
+export interface SessionStartData {
+    branch: LoungeBranch;
+    open_status: LoungeBranchOpenStatus | null;
+    opening_times: LoungeBranchOpeningTime[];
+    stations: LoungeBranchStation[];
+    games: LoungeBranchGame[];
+    session_bill_options: LoungeBranchSessionBillOption[];
+    payment_options: LoungeBranchPaymentOption[];
+    available_luggage_slots: AvailableLuggageSlot[] | null;
+    average_rating: number | null;
+    is_regular: boolean;
+    regular_preferences: PlayerSessionsRegularPreferences | null;
+    reservation_available: boolean;
+    reservation_reason: string | null;
+}
+export type SessionStatus = Database["sessions"]["Enums"]["session_status"];
+export interface LoungeBranch {
+    id: string;
+    lounge_id: string;
+    name: string;
+    address: BranchAddressObject;
+    amenities: BranchAmenitiesObject | null;
+    phone: string;
+    email: string | null;
+}
+export interface LoungeBranchData {
+    info: LoungeBranch;
+    opening_times: LoungeBranchOpeningTime[];
+    open_status: LoungeBranchOpenStatus | null;
+    stations: LoungeBranchStation[];
+    games: LoungeBranchGame[];
+    session_bill_options: LoungeBranchSessionBillOption[];
+    payment_options: LoungeBranchPaymentOption[];
+    average_rating: number | null;
+}
+export type LoungeBranchEateryCategory = Database["sessions"]["Tables"]["lounge_branch_eatery_categories"]["Row"];
+export type LoungeBranchEateryItem = Database["sessions"]["Tables"]["lounge_branch_eatery_items"]["Row"];
+export type LoungeBranchGame = {
+    game_id: string;
+    name: string;
+    cover_url: string | null;
+    consoles: {
+        id: string;
+        name: string;
+        abbreviation: string | null;
+        quantity: number;
+        games_consoles_id: string;
+    }[];
+};
+export type LoungeBranchOpenStatus = Database["sessions"]["Tables"]["lounge_branch_open_status"]["Row"];
+export interface LoungeBranchOpeningTime {
+    day_of_week: number;
+    start_time: string;
+    end_time: string;
+}
+export type LoungeBranchPaymentOption = Database["sessions"]["Tables"]["lounge_branch_payment_options"]["Row"];
+export type LoungeBranchSessionBillOption = {
+    id: string;
+    lounge_branch_id: string;
+    amount_cents: number;
+    created_at: string;
+    updated_at: string;
+} & ({
+    bill_type: "time";
+    station_id: string;
+    billing_interval_minutes: number;
+} | {
+    bill_type: "unit";
+    games_consoles_id: string;
+    unit_label: string;
+});
+export type LoungeBranchStation = {
+    id: string;
+    name: string;
+    number: string;
+    capacity: number;
+    console_name: string;
+    console_abbreviation: string | null;
+    online_play: boolean;
+    special_controllers: string | null;
+};
+export interface LoungeWithBranches {
+    lounge: {
+        id: string;
+        company_name: string;
+        trade_name: string | null;
+        registration_date: string;
+        phone: string;
+        email: string | null;
+        website: string | null;
+        created_at: string;
+    };
+    branches: LoungeBranchWithOpenStatus[];
+}
+export interface LoungeBranchWithOpenStatus extends LoungeBranch {
+    is_open: boolean;
+    opening_times: LoungeBranchOpeningTime[];
+}

package/dist/public/auth.d.ts

@@ -17,6 +17,17 @@ export interface RegistrationStepObject<AccountType> {
     title: string;
     caption: string;
 }
+export interface ActivePlayer {
+    id: string;
+    first_name: string;
+    middle_names: string | null;
+    last_name: string;
+    pseudonym: string | null;
+    birth_date: string | null;
+    nationality: string;
+    pronouns: PronounsItem[];
+    created_at: string;
+}
 export type PhoneOTPData = PhoneOTPDataGeneral & {
     existingMinorRepData?: ExistingMinorRepDataObject;
 };
@@ -189,6 +200,16 @@ export interface GamingSocialsDataObject {
         handle: string;
     }[];
 }
+export interface ActiveLounge {
+    id: string;
+    name: string;
+    registration_date: string;
+    phone: string;
+    email: string | null;
+    website: string | null;
+    average_rating: number | null;
+    created_at: string;
+}
 export interface CompanyDataObject {
     companyNumber: string;
     countryCode: string;

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@koloseum/types",
-	"version": "0.3.5",
+	"version": "0.3.7",
 	"author": "Koloseum Technologies Limited",
 	"type": "module",
 	"description": "Type definitions for use across web apps (TypeScript)",
@@ -19,8 +19,11 @@
 		"./database": "./dist/database.d.ts",
 		"./database-generated": "./dist/database-generated.d.ts",
 		"./general": "./dist/general.d.ts",
+		"./external/suprsend": "./dist/external/suprsend.d.ts",
+		"./external/twilio": "./dist/external/twilio.d.ts",
 		"./public/auth": "./dist/public/auth.d.ts",
-		"./players/competitions": "./dist/players/competitions.d.ts"
+		"./players/competitions": "./dist/players/competitions.d.ts",
+		"./players/sessions": "./dist/players/sessions.d.ts"
 	},
 	"files": [
 		"./dist/**/*.d.ts"