@indiegems/gem-web-sdk 10.1.0 → 10.2.0

package/dist/server.d.ts

@@ -201,7 +201,16 @@ type AnalyticsRejection$1 = {
     "code": string;
     "index": number;
 };
+type BackfillPolicy = "fill_existing_first" | "prefer_new_match";
+type BackfillSettings = {
+    "enabled": boolean;
+    "policy"?: BackfillPolicy;
+};
 type BadgeKind = "platform" | "game";
+type BadgeLabel = {
+    "lang": string;
+    "text": string;
+};
 type BatchOrderItem = {
     "nonce"?: string | null;
     "operations": OperationRequest[];
@@ -277,6 +286,10 @@ type ChallengePeriodResponse = {
     "window": WindowKind;
 };
 type ClientPlatform = "universal" | "mobile" | "web";
+type ConfigAssignmentNotice = {
+    "code": string;
+    "message": string;
+};
 type ConfigChannelAssignmentResponse = {
     "assigned_at": string;
     "assigned_by": string;
@@ -284,6 +297,7 @@ type ConfigChannelAssignmentResponse = {
     "config_url"?: string | null;
     "config_version": number;
     "content_hash"?: string | null;
+    "notices"?: ConfigAssignmentNotice[];
     "published_at"?: string | null;
 };
 type CreateOrderRequest = {
@@ -415,6 +429,7 @@ type GameRoomResponseV2 = {
     "name": string;
     "room_args"?: Record<string, unknown> | null;
     "room_args_template"?: null | RoomArgsTemplate;
+    "self_hosted"?: boolean;
     "settings"?: unknown;
     "started_at"?: number | null;
     "status": string;
@@ -459,6 +474,7 @@ type GameRoomTemplateResponse = {
     "idle_timeout_seconds"?: number | null;
     "is_active": boolean;
     "match_type": MatchType;
+    "matchmaking"?: null | MatchmakingSettings;
     "max_match_duration_seconds": number;
     "max_players": number;
     "min_players": number;
@@ -629,7 +645,41 @@ type LootRollResultResponse = {
     "roll_number": number;
     "was_replacement": boolean;
 };
+type MatchBackfillRequest = {
+    "open": boolean;
+    "seats"?: number | null;
+};
+type MatchBackfillResponse = {
+    "open": boolean;
+    "seats"?: number | null;
+};
+type MatchPlayerReport$1 = {
+    "player_id": string;
+    "state": MatchPlayerState;
+};
+type MatchPlayerReportOutcome = "recorded" | "removed" | "not_a_member";
+type MatchPlayerReportResult$1 = {
+    "outcome": MatchPlayerReportOutcome;
+    "player_id": string;
+};
+type MatchPlayerState = "connected" | "no_show" | "left";
+type MatchPlayersReportRequest = {
+    "players": MatchPlayerReport$1[];
+};
+type MatchPlayersReportResponse = {
+    "players": MatchPlayerReportResult$1[];
+};
 type MatchType = "dedicated" | "p2p" | "none";
+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 MilestoneMetric = "total_points" | "qualifying_unlocks";
 type NameStyle = {
     "fallback"?: null | ThemedColors;
     "item_id": string;
@@ -723,7 +773,7 @@ type OrderResponse = {
     "order_id": string;
     "status": OrderStatus;
 };
-type OrderSource = "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 = "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 OrderStatus = "completed" | "failed";
 type OverflowBehavior = "fail" | "clamp" | "allow";
 type PaginatedCollectionCurrencyBalanceResponse = {
@@ -752,6 +802,7 @@ type PaginatedCollectionProgressionStateResponse = {
         "achievements"?: ProgressionAchievementState[];
         "achievements_unavailable"?: boolean;
         "completion_count": number;
+        "completion_threshold"?: number | null;
         "current_value": number;
         "is_completed": boolean;
         "progression_definition_id": string;
@@ -793,6 +844,10 @@ type PlayerBadge = {
     "icon_url": string;
     "item_id": string;
     "kind": BadgeKind;
+    "label"?: null | BadgeLabel;
+    "tier"?: number | null;
+    "tier_count"?: number | null;
+    "track"?: null | MilestoneMetric;
 };
 type PlayerGameProfileResponse = SubjectIdentityFields & {
     "achievement_score"?: number | null;
@@ -806,6 +861,7 @@ type PlayerIdentityFields = {
     "discriminator"?: string | null;
     "display_name"?: string | null;
     "display_tag"?: string | null;
+    "is_test_account"?: boolean | null;
     "name_animation"?: null | NameStyle;
     "name_color"?: null | NameStyle;
     "player_id"?: string;
@@ -851,6 +907,9 @@ type ProgressionResetRequest = {
     "reason"?: string | null;
 };
 type ProgressionStateOverride = {
+    "cycle_frozen_at"?: string | null;
+    "cycle_period_id"?: string | null;
+    "cycle_threshold"?: number | null;
     "last_reset_at"?: string | null;
     "last_reset_period_id"?: string | null;
     "last_window_id"?: string | null;
@@ -861,6 +920,7 @@ type ProgressionStateResponse = {
     "achievements"?: ProgressionAchievementState[];
     "achievements_unavailable"?: boolean;
     "completion_count": number;
+    "completion_threshold"?: number | null;
     "current_value": number;
     "is_completed": boolean;
     "progression_definition_id": string;
@@ -1025,6 +1085,7 @@ type SubjectIdentityFields = {
     "discriminator"?: string | null;
     "display_name"?: string | null;
     "display_tag"?: string | null;
+    "is_test_account"?: boolean | null;
     "name_animation"?: null | NameStyle;
     "name_color"?: null | NameStyle;
     "player_id": string;
@@ -1083,6 +1144,7 @@ type SuppliedPeriodProgressRow = {
 };
 type SuppliedProgressionRow = {
     "completion_count": number;
+    "completion_threshold"?: number | null;
     "current_value": number;
     "is_completed": boolean;
     "progression_definition_id": string;
@@ -1393,12 +1455,18 @@ declare function putShowcaseValue(api: GameApi, player_id: string, key: string,
 declare function rejectTransfer(api: GameApi, transfer_id: string, options?: {
     signal?: AbortSignal;
 }): Promise<TransferResponse>;
+declare function reportMatchPlayers(api: GameApi, match_id: string, body: MatchPlayersReportRequest, options?: {
+    signal?: AbortSignal;
+}): Promise<MatchPlayersReportResponse>;
 declare function requestSaveUploadUrl(api: GameApi, entity_type: string, entity_id: string, key: string, body: SaveUploadUrlRequest, options?: {
     signal?: AbortSignal;
 }): Promise<SaveUploadUrlResponse>;
 declare function resetEntityProgression(api: GameApi, entity_type: string, entity_id: string, progression_definition_id: SlugOrId, body: ProgressionResetRequest, options?: {
     signal?: AbortSignal;
 }): Promise<OrderResponse>;
+declare function setMatchBackfill(api: GameApi, match_id: string, body: MatchBackfillRequest, options?: {
+    signal?: AbortSignal;
+}): Promise<MatchBackfillResponse>;
 declare function simulateEntityOrder(api: GameApi, entity_type: string, entity_id: string, body: SimulateOrderRequest, options?: {
     signal?: AbortSignal;
 }): Promise<SimulateOrderResponse>;
@@ -1415,7 +1483,10 @@ type generated_AdminActionRequest = AdminActionRequest;
 type generated_AnalyticsBatchRequest = AnalyticsBatchRequest;
 type generated_AnalyticsBatchResponse = AnalyticsBatchResponse;
 type generated_AnalyticsEventSubmission = AnalyticsEventSubmission;
+type generated_BackfillPolicy = BackfillPolicy;
+type generated_BackfillSettings = BackfillSettings;
 type generated_BadgeKind = BadgeKind;
+type generated_BadgeLabel = BadgeLabel;
 type generated_BatchOrderItem = BatchOrderItem;
 type generated_BatchOrderItemResult = BatchOrderItemResult;
 type generated_BatchOrderRequest = BatchOrderRequest;
@@ -1427,6 +1498,7 @@ type generated_CatalogRecipe = CatalogRecipe;
 type generated_ChallengeListResponse = ChallengeListResponse;
 type generated_ChallengePeriodResponse = ChallengePeriodResponse;
 type generated_ClientPlatform = ClientPlatform;
+type generated_ConfigAssignmentNotice = ConfigAssignmentNotice;
 type generated_ConfigChannelAssignmentResponse = ConfigChannelAssignmentResponse;
 type generated_CreateOrderRequest = CreateOrderRequest;
 type generated_CreateSessionRequest = CreateSessionRequest;
@@ -1464,7 +1536,16 @@ type generated_LeaderboardPeriodFields = LeaderboardPeriodFields;
 type generated_LeaderboardResponse = LeaderboardResponse;
 type generated_ListTransfersResponse = ListTransfersResponse;
 type generated_LootRollResultResponse = LootRollResultResponse;
+type generated_MatchBackfillRequest = MatchBackfillRequest;
+type generated_MatchBackfillResponse = MatchBackfillResponse;
+type generated_MatchPlayerReportOutcome = MatchPlayerReportOutcome;
+type generated_MatchPlayerState = MatchPlayerState;
+type generated_MatchPlayersReportRequest = MatchPlayersReportRequest;
+type generated_MatchPlayersReportResponse = MatchPlayersReportResponse;
 type generated_MatchType = MatchType;
+type generated_MatchmakingSettings = MatchmakingSettings;
+type generated_MatchmakingStrategy = MatchmakingStrategy;
+type generated_MilestoneMetric = MilestoneMetric;
 type generated_NameStyle = NameStyle;
 type generated_OperationRequest = OperationRequest;
 type generated_OrderListResponse = OrderListResponse;
@@ -1594,13 +1675,15 @@ declare const generated_putEntityGameSetting: typeof putEntityGameSetting;
 declare const generated_putRoomArgs: typeof putRoomArgs;
 declare const generated_putShowcaseValue: typeof putShowcaseValue;
 declare const generated_rejectTransfer: typeof rejectTransfer;
+declare const generated_reportMatchPlayers: typeof reportMatchPlayers;
 declare const generated_requestSaveUploadUrl: typeof requestSaveUploadUrl;
 declare const generated_resetEntityProgression: typeof resetEntityProgression;
+declare const generated_setMatchBackfill: typeof setMatchBackfill;
 declare const generated_simulateEntityOrder: typeof simulateEntityOrder;
 declare const generated_transferHostV2: typeof transferHostV2;
 declare const generated_updateGameRoomV2: typeof updateGameRoomV2;
 declare namespace generated {
-    export { type generated_AchievementUnlockOutcome as AchievementUnlockOutcome, type generated_ActiveWindowResponse as ActiveWindowResponse, type generated_AdminActionRequest as AdminActionRequest, type generated_AnalyticsBatchRequest as AnalyticsBatchRequest, type generated_AnalyticsBatchResponse as AnalyticsBatchResponse, type generated_AnalyticsEventSubmission as AnalyticsEventSubmission, type AnalyticsRejection$1 as AnalyticsRejection, type generated_BadgeKind as BadgeKind, type generated_BatchOrderItem as BatchOrderItem, type generated_BatchOrderItemResult as BatchOrderItemResult, type generated_BatchOrderRequest as BatchOrderRequest, type generated_BatchOrderResponse as BatchOrderResponse, type generated_BucketBalanceResponse as BucketBalanceResponse, type generated_CatalogItem as CatalogItem, type generated_CatalogPrice as CatalogPrice, type generated_CatalogRecipe as CatalogRecipe, type generated_ChallengeListResponse as ChallengeListResponse, type generated_ChallengePeriodResponse as ChallengePeriodResponse, type generated_ClientPlatform as ClientPlatform, type generated_ConfigChannelAssignmentResponse as ConfigChannelAssignmentResponse, type generated_CreateOrderRequest as CreateOrderRequest, type generated_CreateSessionRequest as CreateSessionRequest, type generated_CurrencyBalanceResponse as CurrencyBalanceResponse, type generated_CurrencyResetOverride as CurrencyResetOverride, type generated_DropRateEntry as DropRateEntry, type generated_DropRatesResponse as DropRatesResponse, type generated_EarningResetActorKind as EarningResetActorKind, type generated_EarningResetGameFigure as EarningResetGameFigure, type generated_EntityLeaderboardEntryResponse as EntityLeaderboardEntryResponse, type generated_EntityLeaderboardResponse as EntityLeaderboardResponse, type generated_EntityType as EntityType, type generated_ErrorDetail as ErrorDetail, type generated_ErrorResponse as ErrorResponse, type generated_EventDefinitionResponse as EventDefinitionResponse, type generated_EventListResponse as EventListResponse, type generated_EventStatusInfo as EventStatusInfo, type generated_FidelityReport as FidelityReport, type generated_GameApi as GameApi, type generated_GameChannel as GameChannel, type generated_GameRoomMemberResponseV2 as GameRoomMemberResponseV2, type generated_GameRoomResponseV2 as GameRoomResponseV2, type generated_GameRoomSummaryResponse as GameRoomSummaryResponse, type generated_GameRoomTemplateListResponse as GameRoomTemplateListResponse, type generated_GameRoomTemplateResponse as GameRoomTemplateResponse, type generated_GameRoomsListResponse as GameRoomsListResponse, type generated_InitiateTransferRequest as InitiateTransferRequest, type generated_InventoryChange as InventoryChange, type generated_InventoryResponse as InventoryResponse, type generated_InventoryScopeResponse as InventoryScopeResponse, type generated_ItemCategory as ItemCategory, type generated_ItemInstanceResponse as ItemInstanceResponse, type generated_LeaderboardEntryResponse as LeaderboardEntryResponse, type generated_LeaderboardPeriodFields as LeaderboardPeriodFields, type generated_LeaderboardResponse as LeaderboardResponse, type generated_ListTransfersResponse as ListTransfersResponse, type generated_LootRollResultResponse as LootRollResultResponse, type generated_MatchType as MatchType, type generated_NameStyle as NameStyle, type generated_OperationRequest as OperationRequest, type generated_OrderListResponse as OrderListResponse, type generated_OrderRecordResponse as OrderRecordResponse, type generated_OrderResponse as OrderResponse, type generated_OrderSource as OrderSource, type generated_OrderStatus as OrderStatus, type generated_OverflowBehavior as OverflowBehavior, type generated_PaginatedCollectionCurrencyBalanceResponse as PaginatedCollectionCurrencyBalanceResponse, type generated_PaginatedCollectionItemInstanceResponse as PaginatedCollectionItemInstanceResponse, type generated_PaginatedCollectionProgressionStateResponse as PaginatedCollectionProgressionStateResponse, type generated_PaginatedResponseSaveDataResponse as PaginatedResponseSaveDataResponse, type generated_PeriodProgressResponse as PeriodProgressResponse, type generated_PlatformGrantClamp as PlatformGrantClamp, type generated_PlatformGrantOutcome as PlatformGrantOutcome, type generated_PlayerBadge as PlayerBadge, type generated_PlayerGameProfileResponse as PlayerGameProfileResponse, type generated_PlayerIdentityFields as PlayerIdentityFields, type generated_PlayerTitle as PlayerTitle, type generated_PrerequisiteType as PrerequisiteType, type generated_ProfileShowcaseEntry as ProfileShowcaseEntry, type generated_ProgressionAchievementState as ProgressionAchievementState, type generated_ProgressionAddRequest as ProgressionAddRequest, type generated_ProgressionClaimRequest as ProgressionClaimRequest, type generated_ProgressionMaxRequest as ProgressionMaxRequest, type generated_ProgressionResetRequest as ProgressionResetRequest, type generated_ProgressionStateOverride as ProgressionStateOverride, type generated_ProgressionStateResponse as ProgressionStateResponse, type generated_PurchaseCatalogResponse as PurchaseCatalogResponse, type generated_PutSettingRequest as PutSettingRequest, type generated_PutShowcaseRequest as PutShowcaseRequest, type generated_ReceiptPrincipal as ReceiptPrincipal, type generated_RecipeAvailabilityResponse as RecipeAvailabilityResponse, type generated_RecipeExecuteRequest as RecipeExecuteRequest, type generated_RecipeExecuteResponse as RecipeExecuteResponse, type generated_RecipeLockReason as RecipeLockReason, type generated_RecipePrerequisite as RecipePrerequisite, type generated_RecipeUsageListResponse as RecipeUsageListResponse, type generated_RecipeUsageResponse as RecipeUsageResponse, type generated_RoomArgType as RoomArgType, type generated_RoomArgsResponse as RoomArgsResponse, type generated_RoomArgsTemplate as RoomArgsTemplate, type generated_SaveDataResponse as SaveDataResponse, type generated_SaveFinalizeRequest as SaveFinalizeRequest, type generated_SaveUploadUrlRequest as SaveUploadUrlRequest, type generated_SaveUploadUrlResponse as SaveUploadUrlResponse, type generated_SettingResponse as SettingResponse, type generated_SettingsListResponse as SettingsListResponse, type generated_ShowcaseValueResponse as ShowcaseValueResponse, type generated_SimulateOrderRequest as SimulateOrderRequest, type generated_SimulateOrderResponse as SimulateOrderResponse, type generated_SimulationFailure as SimulationFailure, type generated_SimulationOutcome as SimulationOutcome, type generated_SimulationOverrides as SimulationOverrides, type generated_SlugOrId as SlugOrId, type generated_SubjectIdentityFields as SubjectIdentityFields, type generated_SuppliedBucketRow as SuppliedBucketRow, type generated_SuppliedCurrencies as SuppliedCurrencies, type generated_SuppliedCurrencyRow as SuppliedCurrencyRow, type generated_SuppliedInventory as SuppliedInventory, type generated_SuppliedItemRow as SuppliedItemRow, type generated_SuppliedItems as SuppliedItems, type generated_SuppliedPeriodProgressRow as SuppliedPeriodProgressRow, type generated_SuppliedProgressionRow as SuppliedProgressionRow, type generated_SuppliedProgressions as SuppliedProgressions, type generated_SuppliedScope as SuppliedScope, type generated_ThemedColors as ThemedColors, type generated_TransferCurrencyRequest as TransferCurrencyRequest, type generated_TransferItemRequest as TransferItemRequest, type generated_TransferResponse as TransferResponse, type generated_UnavailabilityReason as UnavailabilityReason, type generated_UpdateGameRoomRequest as UpdateGameRoomRequest, type generated_UpdateRoomArgsRequest as UpdateRoomArgsRequest, type generated_WindowKind as WindowKind, type generated_WindowPreviewResponse as WindowPreviewResponse, generated_acceptTransfer as acceptTransfer, generated_addEntityProgression as addEntityProgression, generated_adminAction as adminAction, generated_cancelInventoryTransfer as cancelInventoryTransfer, generated_claimEntityProgressionRewards as claimEntityProgressionRewards, generated_closeGameRoom as closeGameRoom, generated_createEntityBatchOrder as createEntityBatchOrder, generated_createEntityOrder as createEntityOrder, generated_createSession as createSession, generated_deleteEntityGameSetting as deleteEntityGameSetting, generated_deleteEntitySave as deleteEntitySave, generated_deleteSession as deleteSession, generated_deleteShowcaseValue as deleteShowcaseValue, generated_executeEntityRecipe as executeEntityRecipe, generated_finalizeSaveUpload as finalizeSaveUpload, generated_getChannelAssignment as getChannelAssignment, generated_getDropRates as getDropRates, generated_getEntityCurrency as getEntityCurrency, generated_getEntityGameSetting as getEntityGameSetting, generated_getEntityInventory as getEntityInventory, generated_getEntityInventoryItem as getEntityInventoryItem, generated_getEntityLeaderboard as getEntityLeaderboard, generated_getEntityOrder as getEntityOrder, generated_getEntityProgression as getEntityProgression, generated_getEntityRecipeAvailability as getEntityRecipeAvailability, generated_getEntityRecipeUsage as getEntityRecipeUsage, generated_getEntitySave as getEntitySave, generated_getEvent as getEvent, generated_getGameRoomV2 as getGameRoomV2, generated_getLeaderboard as getLeaderboard, generated_getPlayerGameProfile as getPlayerGameProfile, generated_getPurchaseCatalog as getPurchaseCatalog, generated_getResolvedTemplate as getResolvedTemplate, generated_getRoomArgs as getRoomArgs, generated_getShowcaseValue as getShowcaseValue, generated_getTransferDetails as getTransferDetails, generated_ingestAnalyticsEvents as ingestAnalyticsEvents, generated_initiateInventoryTransfer as initiateInventoryTransfer, generated_invokeFunction as invokeFunction, generated_kickPlayer as kickPlayer, generated_listChallenges as listChallenges, generated_listEntityGameSettings as listEntityGameSettings, generated_listEntityOrders as listEntityOrders, generated_listEntityProgressions as listEntityProgressions, generated_listEntitySaves as listEntitySaves, generated_listEvents as listEvents, generated_listGameRooms as listGameRooms, generated_listResolvedTemplates as listResolvedTemplates, generated_listTransfers as listTransfers, generated_maxEntityProgression as maxEntityProgression, generated_putEntityGameSetting as putEntityGameSetting, generated_putRoomArgs as putRoomArgs, generated_putShowcaseValue as putShowcaseValue, generated_rejectTransfer as rejectTransfer, generated_requestSaveUploadUrl as requestSaveUploadUrl, generated_resetEntityProgression as resetEntityProgression, generated_simulateEntityOrder as simulateEntityOrder, generated_transferHostV2 as transferHostV2, generated_updateGameRoomV2 as updateGameRoomV2 };
+    export { type generated_AchievementUnlockOutcome as AchievementUnlockOutcome, type generated_ActiveWindowResponse as ActiveWindowResponse, type generated_AdminActionRequest as AdminActionRequest, type generated_AnalyticsBatchRequest as AnalyticsBatchRequest, type generated_AnalyticsBatchResponse as AnalyticsBatchResponse, type generated_AnalyticsEventSubmission as AnalyticsEventSubmission, type AnalyticsRejection$1 as AnalyticsRejection, type generated_BackfillPolicy as BackfillPolicy, type generated_BackfillSettings as BackfillSettings, type generated_BadgeKind as BadgeKind, type generated_BadgeLabel as BadgeLabel, type generated_BatchOrderItem as BatchOrderItem, type generated_BatchOrderItemResult as BatchOrderItemResult, type generated_BatchOrderRequest as BatchOrderRequest, type generated_BatchOrderResponse as BatchOrderResponse, type generated_BucketBalanceResponse as BucketBalanceResponse, type generated_CatalogItem as CatalogItem, type generated_CatalogPrice as CatalogPrice, type generated_CatalogRecipe as CatalogRecipe, type generated_ChallengeListResponse as ChallengeListResponse, type generated_ChallengePeriodResponse as ChallengePeriodResponse, type generated_ClientPlatform as ClientPlatform, type generated_ConfigAssignmentNotice as ConfigAssignmentNotice, type generated_ConfigChannelAssignmentResponse as ConfigChannelAssignmentResponse, type generated_CreateOrderRequest as CreateOrderRequest, type generated_CreateSessionRequest as CreateSessionRequest, type generated_CurrencyBalanceResponse as CurrencyBalanceResponse, type generated_CurrencyResetOverride as CurrencyResetOverride, type generated_DropRateEntry as DropRateEntry, type generated_DropRatesResponse as DropRatesResponse, type generated_EarningResetActorKind as EarningResetActorKind, type generated_EarningResetGameFigure as EarningResetGameFigure, type generated_EntityLeaderboardEntryResponse as EntityLeaderboardEntryResponse, type generated_EntityLeaderboardResponse as EntityLeaderboardResponse, type generated_EntityType as EntityType, type generated_ErrorDetail as ErrorDetail, type generated_ErrorResponse as ErrorResponse, type generated_EventDefinitionResponse as EventDefinitionResponse, type generated_EventListResponse as EventListResponse, type generated_EventStatusInfo as EventStatusInfo, type generated_FidelityReport as FidelityReport, type generated_GameApi as GameApi, type generated_GameChannel as GameChannel, type generated_GameRoomMemberResponseV2 as GameRoomMemberResponseV2, type generated_GameRoomResponseV2 as GameRoomResponseV2, type generated_GameRoomSummaryResponse as GameRoomSummaryResponse, type generated_GameRoomTemplateListResponse as GameRoomTemplateListResponse, type generated_GameRoomTemplateResponse as GameRoomTemplateResponse, type generated_GameRoomsListResponse as GameRoomsListResponse, type generated_InitiateTransferRequest as InitiateTransferRequest, type generated_InventoryChange as InventoryChange, type generated_InventoryResponse as InventoryResponse, type generated_InventoryScopeResponse as InventoryScopeResponse, type generated_ItemCategory as ItemCategory, type generated_ItemInstanceResponse as ItemInstanceResponse, type generated_LeaderboardEntryResponse as LeaderboardEntryResponse, type generated_LeaderboardPeriodFields as LeaderboardPeriodFields, type generated_LeaderboardResponse as LeaderboardResponse, type generated_ListTransfersResponse as ListTransfersResponse, type generated_LootRollResultResponse as LootRollResultResponse, type generated_MatchBackfillRequest as MatchBackfillRequest, type generated_MatchBackfillResponse as MatchBackfillResponse, type MatchPlayerReport$1 as MatchPlayerReport, type generated_MatchPlayerReportOutcome as MatchPlayerReportOutcome, type MatchPlayerReportResult$1 as MatchPlayerReportResult, type generated_MatchPlayerState as MatchPlayerState, type generated_MatchPlayersReportRequest as MatchPlayersReportRequest, type generated_MatchPlayersReportResponse as MatchPlayersReportResponse, type generated_MatchType as MatchType, type generated_MatchmakingSettings as MatchmakingSettings, type generated_MatchmakingStrategy as MatchmakingStrategy, type generated_MilestoneMetric as MilestoneMetric, type generated_NameStyle as NameStyle, type generated_OperationRequest as OperationRequest, type generated_OrderListResponse as OrderListResponse, type generated_OrderRecordResponse as OrderRecordResponse, type generated_OrderResponse as OrderResponse, type generated_OrderSource as OrderSource, type generated_OrderStatus as OrderStatus, type generated_OverflowBehavior as OverflowBehavior, type generated_PaginatedCollectionCurrencyBalanceResponse as PaginatedCollectionCurrencyBalanceResponse, type generated_PaginatedCollectionItemInstanceResponse as PaginatedCollectionItemInstanceResponse, type generated_PaginatedCollectionProgressionStateResponse as PaginatedCollectionProgressionStateResponse, type generated_PaginatedResponseSaveDataResponse as PaginatedResponseSaveDataResponse, type generated_PeriodProgressResponse as PeriodProgressResponse, type generated_PlatformGrantClamp as PlatformGrantClamp, type generated_PlatformGrantOutcome as PlatformGrantOutcome, type generated_PlayerBadge as PlayerBadge, type generated_PlayerGameProfileResponse as PlayerGameProfileResponse, type generated_PlayerIdentityFields as PlayerIdentityFields, type generated_PlayerTitle as PlayerTitle, type generated_PrerequisiteType as PrerequisiteType, type generated_ProfileShowcaseEntry as ProfileShowcaseEntry, type generated_ProgressionAchievementState as ProgressionAchievementState, type generated_ProgressionAddRequest as ProgressionAddRequest, type generated_ProgressionClaimRequest as ProgressionClaimRequest, type generated_ProgressionMaxRequest as ProgressionMaxRequest, type generated_ProgressionResetRequest as ProgressionResetRequest, type generated_ProgressionStateOverride as ProgressionStateOverride, type generated_ProgressionStateResponse as ProgressionStateResponse, type generated_PurchaseCatalogResponse as PurchaseCatalogResponse, type generated_PutSettingRequest as PutSettingRequest, type generated_PutShowcaseRequest as PutShowcaseRequest, type generated_ReceiptPrincipal as ReceiptPrincipal, type generated_RecipeAvailabilityResponse as RecipeAvailabilityResponse, type generated_RecipeExecuteRequest as RecipeExecuteRequest, type generated_RecipeExecuteResponse as RecipeExecuteResponse, type generated_RecipeLockReason as RecipeLockReason, type generated_RecipePrerequisite as RecipePrerequisite, type generated_RecipeUsageListResponse as RecipeUsageListResponse, type generated_RecipeUsageResponse as RecipeUsageResponse, type generated_RoomArgType as RoomArgType, type generated_RoomArgsResponse as RoomArgsResponse, type generated_RoomArgsTemplate as RoomArgsTemplate, type generated_SaveDataResponse as SaveDataResponse, type generated_SaveFinalizeRequest as SaveFinalizeRequest, type generated_SaveUploadUrlRequest as SaveUploadUrlRequest, type generated_SaveUploadUrlResponse as SaveUploadUrlResponse, type generated_SettingResponse as SettingResponse, type generated_SettingsListResponse as SettingsListResponse, type generated_ShowcaseValueResponse as ShowcaseValueResponse, type generated_SimulateOrderRequest as SimulateOrderRequest, type generated_SimulateOrderResponse as SimulateOrderResponse, type generated_SimulationFailure as SimulationFailure, type generated_SimulationOutcome as SimulationOutcome, type generated_SimulationOverrides as SimulationOverrides, type generated_SlugOrId as SlugOrId, type generated_SubjectIdentityFields as SubjectIdentityFields, type generated_SuppliedBucketRow as SuppliedBucketRow, type generated_SuppliedCurrencies as SuppliedCurrencies, type generated_SuppliedCurrencyRow as SuppliedCurrencyRow, type generated_SuppliedInventory as SuppliedInventory, type generated_SuppliedItemRow as SuppliedItemRow, type generated_SuppliedItems as SuppliedItems, type generated_SuppliedPeriodProgressRow as SuppliedPeriodProgressRow, type generated_SuppliedProgressionRow as SuppliedProgressionRow, type generated_SuppliedProgressions as SuppliedProgressions, type generated_SuppliedScope as SuppliedScope, type generated_ThemedColors as ThemedColors, type generated_TransferCurrencyRequest as TransferCurrencyRequest, type generated_TransferItemRequest as TransferItemRequest, type generated_TransferResponse as TransferResponse, type generated_UnavailabilityReason as UnavailabilityReason, type generated_UpdateGameRoomRequest as UpdateGameRoomRequest, type generated_UpdateRoomArgsRequest as UpdateRoomArgsRequest, type generated_WindowKind as WindowKind, type generated_WindowPreviewResponse as WindowPreviewResponse, generated_acceptTransfer as acceptTransfer, generated_addEntityProgression as addEntityProgression, generated_adminAction as adminAction, generated_cancelInventoryTransfer as cancelInventoryTransfer, generated_claimEntityProgressionRewards as claimEntityProgressionRewards, generated_closeGameRoom as closeGameRoom, generated_createEntityBatchOrder as createEntityBatchOrder, generated_createEntityOrder as createEntityOrder, generated_createSession as createSession, generated_deleteEntityGameSetting as deleteEntityGameSetting, generated_deleteEntitySave as deleteEntitySave, generated_deleteSession as deleteSession, generated_deleteShowcaseValue as deleteShowcaseValue, generated_executeEntityRecipe as executeEntityRecipe, generated_finalizeSaveUpload as finalizeSaveUpload, generated_getChannelAssignment as getChannelAssignment, generated_getDropRates as getDropRates, generated_getEntityCurrency as getEntityCurrency, generated_getEntityGameSetting as getEntityGameSetting, generated_getEntityInventory as getEntityInventory, generated_getEntityInventoryItem as getEntityInventoryItem, generated_getEntityLeaderboard as getEntityLeaderboard, generated_getEntityOrder as getEntityOrder, generated_getEntityProgression as getEntityProgression, generated_getEntityRecipeAvailability as getEntityRecipeAvailability, generated_getEntityRecipeUsage as getEntityRecipeUsage, generated_getEntitySave as getEntitySave, generated_getEvent as getEvent, generated_getGameRoomV2 as getGameRoomV2, generated_getLeaderboard as getLeaderboard, generated_getPlayerGameProfile as getPlayerGameProfile, generated_getPurchaseCatalog as getPurchaseCatalog, generated_getResolvedTemplate as getResolvedTemplate, generated_getRoomArgs as getRoomArgs, generated_getShowcaseValue as getShowcaseValue, generated_getTransferDetails as getTransferDetails, generated_ingestAnalyticsEvents as ingestAnalyticsEvents, generated_initiateInventoryTransfer as initiateInventoryTransfer, generated_invokeFunction as invokeFunction, generated_kickPlayer as kickPlayer, generated_listChallenges as listChallenges, generated_listEntityGameSettings as listEntityGameSettings, generated_listEntityOrders as listEntityOrders, generated_listEntityProgressions as listEntityProgressions, generated_listEntitySaves as listEntitySaves, generated_listEvents as listEvents, generated_listGameRooms as listGameRooms, generated_listResolvedTemplates as listResolvedTemplates, generated_listTransfers as listTransfers, generated_maxEntityProgression as maxEntityProgression, generated_putEntityGameSetting as putEntityGameSetting, generated_putRoomArgs as putRoomArgs, generated_putShowcaseValue as putShowcaseValue, generated_rejectTransfer as rejectTransfer, generated_reportMatchPlayers as reportMatchPlayers, generated_requestSaveUploadUrl as requestSaveUploadUrl, generated_resetEntityProgression as resetEntityProgression, generated_setMatchBackfill as setMatchBackfill, generated_simulateEntityOrder as simulateEntityOrder, generated_transferHostV2 as transferHostV2, generated_updateGameRoomV2 as updateGameRoomV2 };
 }
 type AnalyticsValue = string | number;
 interface AnalyticsRejection {
@@ -1683,12 +1766,29 @@ interface GemServerIdentity {
 type ServerApi = {
     [K in keyof typeof generated as (typeof generated)[K] extends (api: GameApi, ...rest: never[]) => unknown ? K : never]: (typeof generated)[K] extends (api: GameApi, ...rest: infer A) => infer R ? (...args: A) => R : never;
 };
+interface MatchPlayerReport {
+    readonly playerId: string;
+    readonly state: "connected" | "no_show" | "left";
+}
+interface MatchPlayerReportResult {
+    readonly playerId: string;
+    readonly outcome: "recorded" | "removed" | "not_a_member" | (string & {});
+}
+interface MatchBackfillState {
+    readonly open: boolean;
+    readonly seats: number | null;
+}
 interface GemServer {
     readonly identity: GemServerIdentity;
     readonly client: GemClient;
     readonly api: ServerApi;
     readonly match: {
         end(signal?: AbortSignal): Promise<void>;
+        setBackfill(options: {
+            readonly open: boolean;
+            readonly seats?: number;
+        }, signal?: AbortSignal): Promise<MatchBackfillState>;
+        reportPlayers(reports: readonly MatchPlayerReport[], signal?: AbortSignal): Promise<MatchPlayerReportResult[]>;
     };
     readonly analytics: ServerAnalytics;
     readonly functions: FunctionsApi;
@@ -1790,4 +1890,4 @@ interface AchievementReceipt {
     readonly reason?: string;
 }
 declare function achievementReceipts(order: unknown): AchievementReceipt[];
-export { type AchievementReceipt, type AnalyticsFlushResult, type AnalyticsRejection, type AnalyticsValue, AuthError, type AuthFailure, type AuthState, type Base64String, type BroadcastOptions, type BytesResponse, CONDITIONAL_HEADERS, type Challenge, type ChallengeWindow, type ClientOptions, type Clock, type ConditionalRequestHeaders, type FunctionFailure, type FunctionInvokeOptions, type FunctionResult, FunctionsApi, type GameApi, GemApiError, GemClient, type GemErrorReason, GemFunctionError, type GemMatchServer, type GemServer, type GemServerBundle, type GemServerFactory, type GemServerHost, type GemServerHostProfile, type GemServerIdentity, type GemServerLifecycle, type GemServerOptions, type GemServerProfile, type HostTokenSource, type HostTokenSourceOptions, PlayerText, type RequestOptions, type RoomArgValue, type RuntimeShutdownPayload, type SendOptions, type ServerAnalytics, type ServerApi, type ServerBundleHost, type ServerChallenges, type ServerListChallengesOptions, type ServerShutdownInfo, type ServerTokenGrant, type TokenGrant, type Transport, TransportRefusal, type TransportRequest, type TransportResponse, type VersionedGetOptions, type VersionedResponse, achievementReceipts, asPlayerText, createGemServer, createHostTokenSource, createMatchServer, defineServer, systemClock, text, toBase64 };
+export { type AchievementReceipt, type AnalyticsFlushResult, type AnalyticsRejection, type AnalyticsValue, AuthError, type AuthFailure, type AuthState, type Base64String, type BroadcastOptions, type BytesResponse, CONDITIONAL_HEADERS, type Challenge, type ChallengeWindow, type ClientOptions, type Clock, type ConditionalRequestHeaders, type FunctionFailure, type FunctionInvokeOptions, type FunctionResult, FunctionsApi, type GameApi, GemApiError, GemClient, type GemErrorReason, GemFunctionError, type GemMatchServer, type GemServer, type GemServerBundle, type GemServerFactory, type GemServerHost, type GemServerHostProfile, type GemServerIdentity, type GemServerLifecycle, type GemServerOptions, type GemServerProfile, type HostTokenSource, type HostTokenSourceOptions, type MatchBackfillState, type MatchPlayerReport, type MatchPlayerReportResult, PlayerText, type RequestOptions, type RoomArgValue, type RuntimeShutdownPayload, type SendOptions, type ServerAnalytics, type ServerApi, type ServerBundleHost, type ServerChallenges, type ServerListChallengesOptions, type ServerShutdownInfo, type ServerTokenGrant, type TokenGrant, type Transport, TransportRefusal, type TransportRequest, type TransportResponse, type VersionedGetOptions, type VersionedResponse, achievementReceipts, asPlayerText, createGemServer, createHostTokenSource, createMatchServer, defineServer, systemClock, text, toBase64 };

package/docs/api/api-reference-game.md

@@ -1,6 +1,6 @@
 # The browser surface — API reference
 
-Generated from `@indiegems/gem-web-sdk/sdk` v10.1.0, the version of the package this file ships in. Every symbol below carries an explicit anchor, its `anchor` in `reference.json` beside this file.
+Generated from `@indiegems/gem-web-sdk/sdk` v10.2.0, the version of the package this file ships in. Every symbol below carries an explicit anchor, its `anchor` in `reference.json` beside this file.
 
 `@indiegems/gem-web-sdk/sdk` is the one import a game writes, wherever its code runs. `@indiegems/gem-web-sdk/game` exports exactly the symbols on this page and nothing else, for a build that wants only this half.
 
@@ -5198,6 +5198,24 @@ arcade that handles share.
   up, for an arcade that does not handle share, and past this frame's own
   limit of six a minute.
 
+<a id="gemframe-requestavatarpicker"></a>
+
+## GemFrame.requestAvatarPicker
+
+```ts
+requestAvatarPicker(): boolean
+```
+
+Ask the arcade to open its own avatar picker over your game. Nothing comes
+back: a changed portrait arrives as a new `gem.player`, through `onPlayer`.
+
+Prefer `gem.openAvatarPicker`, which documents what a game does with the
+change.
+
+**Returns.** whether the message left the frame — `false` before the bridge is
+  up, for an arcade that has no avatar picker here, and past this frame's
+  own limit of six a minute.
+
 <a id="gemframe-requestvibrate"></a>
 
 ## GemFrame.requestVibrate
@@ -5332,7 +5350,10 @@ The precomposed `Name#0001`. It contains the name, so it is
 readonly avatarIconId?: string
 ```
 
-The id of the player's portrait item, when they have one.
+The id of the player's portrait item, when they have one — what a game
+that draws Arcade avatars keys its own model on. On `gem.player` it
+changes when the player wears another portrait, and `onPlayer` runs again;
+see `gem.openAvatarPicker`.
 
 <a id="friend-avatariconurl"></a>
 
@@ -7137,7 +7158,10 @@ The precomposed `Name#0001`. It contains the name, so it is
 readonly avatarIconId?: string
 ```
 
-The id of the player's portrait item, when they have one.
+The id of the player's portrait item, when they have one — what a game
+that draws Arcade avatars keys its own model on. On `gem.player` it
+changes when the player wears another portrait, and `onPlayer` runs again;
+see `gem.openAvatarPicker`.
 
 <a id="gemplayer-avatariconurl"></a>
 
@@ -8108,6 +8132,63 @@ shareButton.onclick = () => {
 
 **Guides.** [getting-started](../getting-started.md)
 
+<a id="gem-avatarpickeravailable"></a>
+
+## Gem.avatarPickerAvailable
+
+```ts
+readonly avatarPickerAvailable: boolean
+```
+
+Whether the arcade will open its avatar picker for [Gem.openAvatarPicker](#gem-openavatarpicker)
+here. Decide from it whether to show your own "Change avatar" button, and
+read it again in the click handler — it is read live.
+
+`false` outside the arcade, before the bridge is up, after the session
+ends, and under an embedder that has no avatar picker.
+
+<a id="gem-openavatarpicker"></a>
+
+## Gem.openAvatarPicker
+
+```ts
+openAvatarPicker(): boolean
+```
+
+Open the arcade's avatar picker over your game, so the player can change
+the Arcade avatar they wear without leaving it. For a game that draws
+Arcade avatars — whole characters the player owns as Arcade items — put a
+"Change avatar" button in your own UI and call this from it:
+
+```js
+changeAvatar.hidden = !gem.avatarPickerAvailable;
+changeAvatar.onclick = () => {
+  if (!gem.openAvatarPicker()) changeAvatar.hidden = true;
+};
+```
+
+**The change arrives as a new player, not as an answer.** Nothing comes
+back from this call. When the player picks a different avatar, the arcade
+pauses your game while the picker is open, then sends the player again —
+your `onPlayer` callback runs and [Gem.player](#gem-player) holds the new
+[PlayerIdentity.avatarIconId](#playeridentity-avatariconid) — and resumes it. Redraw from
+`onPlayer`, which also runs when the player changes their avatar from the
+arcade's own menu without your game asking. A player who closes the picker
+unchanged produces nothing at all.
+
+**Your server learns it only when it reads the room again.** A
+server-authoritative game reads each member's `avatar_icon_id` from the
+room read (`GET /v1/games/{game_id}/game-rooms/{game_room_id}`, or
+`gem.room.get()` on a dedicated server); nothing tells the server the
+player changed. So when `onPlayer` brings a different `avatarIconId`, have
+your client tell your server, and have the server re-read the room — never
+trust the id the client sends.
+
+**Returns.** `true` when the arcade was asked; `false` when it was not and
+  never will be for this call — outside the arcade, before the bridge is
+  up, under an embedder with no avatar picker, or past six asks a minute.
+  It never throws and never waits.
+
 <a id="gem-vibration"></a>
 
 ## Gem.vibration
@@ -9686,7 +9767,10 @@ The precomposed `Name#0001`. It contains the name, so it is
 readonly avatarIconId?: string
 ```
 
-The id of the player's portrait item, when they have one.
+The id of the player's portrait item, when they have one — what a game
+that draws Arcade avatars keys its own model on. On `gem.player` it
+changes when the player wears another portrait, and `onPlayer` runs again;
+see `gem.openAvatarPicker`.
 
 <a id="playeridentity-avatariconurl"></a>
 
@@ -12239,7 +12323,10 @@ The precomposed `Name#0001`. It contains the name, so it is
 readonly avatarIconId?: string
 ```
 
-The id of the player's portrait item, when they have one.
+The id of the player's portrait item, when they have one — what a game
+that draws Arcade avatars keys its own model on. On `gem.player` it
+changes when the player wears another portrait, and `onPlayer` runs again;
+see `gem.openAvatarPicker`.
 
 <a id="leaderboardentry-avatariconurl"></a>
 
@@ -13681,7 +13768,10 @@ The precomposed `Name#0001`. It contains the name, so it is
 readonly avatarIconId?: string
 ```
 
-The id of the player's portrait item, when they have one.
+The id of the player's portrait item, when they have one — what a game
+that draws Arcade avatars keys its own model on. On `gem.player` it
+changes when the player wears another portrait, and `onPlayer` runs again;
+see `gem.openAvatarPicker`.
 
 <a id="playerprofile-avatariconurl"></a>
 
@@ -15996,7 +16086,10 @@ The precomposed `Name#0001`. It contains the name, so it is
 readonly avatarIconId?: string
 ```
 
-The id of the player's portrait item, when they have one.
+The id of the player's portrait item, when they have one — what a game
+that draws Arcade avatars keys its own model on. On `gem.player` it
+changes when the player wears another portrait, and `onPlayer` runs again;
+see `gem.openAvatarPicker`.
 
 <a id="roommember-avatariconurl"></a>
 
@@ -16761,7 +16854,10 @@ The precomposed `Name#0001`. It contains the name, so it is
 readonly avatarIconId?: string
 ```
 
-The id of the player's portrait item, when they have one.
+The id of the player's portrait item, when they have one — what a game
+that draws Arcade avatars keys its own model on. On `gem.player` it
+changes when the player wears another portrait, and `onPlayer` runs again;
+see `gem.openAvatarPicker`.
 
 <a id="showcasefriendentry-avatariconurl"></a>