@indiegems/gem-web-sdk 9.1.3 → 10.0.0

package/dist/sdk.d.ts

@@ -157,6 +157,11 @@ type AffixSelection = {
     "pool": AffixPoolRef;
     "respect_groups"?: boolean;
 };
+type BackfillPolicy = "fill_existing_first" | "prefer_new_match";
+type BackfillSettings = {
+    "enabled": boolean;
+    "policy"?: BackfillPolicy;
+};
 type Boundary = {
     "boundary"?: string;
     "reset_time"?: string;
@@ -230,11 +235,20 @@ type LevelDefinition = {
     "rewards"?: RecipeOperation[];
     "threshold": number;
 };
+type MatchmakingSettings = {
+    "backfill"?: null | BackfillSettings;
+    "cluster_stagger_seconds"?: number;
+    "enabled": boolean;
+    "fill_window_seconds"?: number;
+    "strategy"?: MatchmakingStrategy;
+    "ticket_expiry_seconds"?: number | null;
+};
+type MatchmakingStrategy = "fifo";
 type OrderBySpec = {
     "column": RunValueColumn;
     "direction": SortDirection;
 };
-type OrderSource$1 = "real_money_purchase" | "real_money_refund" | "full_game_purchase" | "full_game_refund" | "platform_purchase" | "reward" | "admin" | "system" | "promo" | "game_consume" | "play" | "recipe" | "transfer" | "platform_funded_game_inventory_purchase" | "earning_reset";
+type OrderSource$1 = "real_money_purchase" | "real_money_refund" | "full_game_purchase" | "full_game_refund" | "platform_purchase" | "reward" | "admin" | "system" | "promo" | "game_consume" | "play" | "recipe" | "transfer" | "platform_funded_game_inventory_purchase" | "earning_reset" | "test_account_provision" | "developer_grant";
 type OverflowBehavior$1 = "fail" | "clamp" | "allow";
 type PityEffect = "guarantee_tier" | {
     "weight_boost": {
@@ -452,6 +466,7 @@ type SnapshotGameRoomTemplate = {
     "id": string;
     "idle_timeout_seconds"?: number | null;
     "match_type": string;
+    "matchmaking"?: null | MatchmakingSettings;
     "max_match_duration_seconds"?: number | null;
     "max_players": number;
     "min_players": number;
@@ -523,6 +538,7 @@ type SnapshotProgression = {
     "display_name"?: string | null;
     "icon_url"?: string | null;
     "id": string;
+    "localized"?: Record<string, unknown>;
     "progression_type": string;
     "slug"?: string | null;
     "sort_order": number;
@@ -560,6 +576,7 @@ type SnapshotRewardedPlacement = {
     "grants": SnapshotRewardGrant[];
     "max_held"?: number | null;
     "max_per_day"?: number | null;
+    "min_watch_secs"?: number | null;
     "placement": string;
     "reward_class": string;
     "without_ads": string;
@@ -1524,26 +1541,6 @@ interface ClusterTarget {
     readonly id: string;
     readonly pressure: string;
 }
-type RoomArgScalar = string | number | boolean;
-type RoomArgValue$1 = RoomArgScalar | readonly RoomArgScalar[];
-type RoomArgs = Readonly<Record<string, RoomArgValue$1>>;
-type RoomArgType$1 = "string" | "int" | "float" | "bool" | (string & {});
-interface RoomArgEntry {
-    readonly name: string;
-    readonly type: RoomArgType$1;
-    readonly list: boolean;
-    readonly required: boolean;
-    readonly mutable: boolean;
-    readonly fixed?: RoomArgValue$1;
-    readonly default?: RoomArgValue$1;
-    readonly description?: string;
-    readonly allowed?: readonly RoomArgScalar[];
-    readonly min?: number;
-    readonly max?: number;
-    readonly minItems?: number;
-    readonly maxItems?: number;
-    readonly maxLength?: number;
-}
 type DedicatedServerFailure = "timeout" | "aborted" | "allocation_failed" | "no_server_ready" | "start_rate_limited" | "p2p_unavailable" | "unsupported_protocol" | "credential_expired" | "credential_reused" | "join_rate_limited" | "signaling_unavailable" | "signaling_failed" | "offer_refused" | "invalid_sdp" | "media_refused" | "connection_failed" | "join_refused" | "match_ended" | "misconfigured";
 declare class DedicatedServerError extends Error {
     readonly reason: DedicatedServerFailure;
@@ -1652,6 +1649,26 @@ interface TransportAdvert {
 declare function readTemplateTransports(value: unknown): readonly TransportKind[] | null;
 declare function readTransportAdvert(settings: unknown, forMatch?: string): TransportAdvert | null;
 declare function webTransportAvailable(): boolean;
+type RoomArgScalar = string | number | boolean;
+type RoomArgValue$1 = RoomArgScalar | readonly RoomArgScalar[];
+type RoomArgs = Readonly<Record<string, RoomArgValue$1>>;
+type RoomArgType$1 = "string" | "int" | "float" | "bool" | (string & {});
+interface RoomArgEntry {
+    readonly name: string;
+    readonly type: RoomArgType$1;
+    readonly list: boolean;
+    readonly required: boolean;
+    readonly mutable: boolean;
+    readonly fixed?: RoomArgValue$1;
+    readonly default?: RoomArgValue$1;
+    readonly description?: string;
+    readonly allowed?: readonly RoomArgScalar[];
+    readonly min?: number;
+    readonly max?: number;
+    readonly minItems?: number;
+    readonly maxItems?: number;
+    readonly maxLength?: number;
+}
 type RoomStatus = "open" | "in_game" | "closed" | (string & {});
 type MatchConnectionState = "disconnected" | "connecting" | "connected" | "suspended";
 type MatchSessionPhase = "none" | "starting" | "ready" | "connected" | "suspended" | "ended" | (string & {});
@@ -1749,6 +1766,38 @@ interface RoomOperationError {
     readonly message: string;
     readonly retryable: boolean;
 }
+interface QueueForMatchOptions {
+    readonly templateSlugs: readonly string[];
+    readonly partyId?: string;
+    readonly signal?: AbortSignal;
+}
+type MatchTicketStatus = "queued" | "matched" | "expired" | "cancelled" | "failed" | "lost" | "unavailable";
+type MatchTicketOutcome = {
+    readonly status: "matched";
+    readonly room: Room;
+} | {
+    readonly status: "expired";
+    readonly reason: string;
+} | {
+    readonly status: "cancelled";
+    readonly reason: string;
+} | {
+    readonly status: "failed";
+    readonly reason: string;
+} | {
+    readonly status: "lost";
+} | {
+    readonly status: "unavailable";
+};
+interface MatchTicket {
+    readonly id: string;
+    readonly status: MatchTicketStatus;
+    readonly partySize: number;
+    readonly queuedAt: number;
+    readonly expiresAt: number;
+    readonly outcome: Promise<MatchTicketOutcome>;
+    cancel(): Promise<MatchTicketOutcome>;
+}
 interface CreateRoomOptions {
     readonly name: string;
     readonly maxPlayers?: number;
@@ -1891,6 +1940,7 @@ interface RoomManager {
     join(roomId: string, options?: JoinRoomOptions): Promise<Room>;
     joinByCode(code: string, options?: JoinRoomOptions): Promise<Room>;
     quickJoin(options: QuickJoinOptions): Promise<Room>;
+    queueForMatch(options: QueueForMatchOptions): Promise<MatchTicket>;
     list(options?: ListRoomsOptions): Promise<RoomPage>;
     myRooms(signal?: AbortSignal): Promise<readonly RoomSummary[]>;
     leave(options?: {
@@ -1916,6 +1966,7 @@ interface RoomManager {
     }): Promise<void>;
     readonly gameId: string | null;
     readonly currentRoom: Room | null;
+    readonly currentTicket: MatchTicket | null;
     readonly currentMatch: ReadyMatch | null;
     readonly matchConnectionState: MatchConnectionState;
     readonly matchSession: MatchSession;