@indiegems/gem-web-sdk 7.0.0 → 7.1.0

package/dist/server.d.ts

@@ -201,6 +201,7 @@ type AnalyticsRejection$1 = {
     "code": string;
     "index": number;
 };
+type BadgeKind = "platform" | "game";
 type BatchOrderItem = {
     "nonce"?: string | null;
     "operations": OperationRequest[];
@@ -231,6 +232,7 @@ type BucketBalanceResponse = {
     "next_reset_at"?: number | null;
 };
 type CatalogItem = {
+    "category"?: ItemCategory;
     "consumable": boolean;
     "display_name"?: string | null;
     "fungible": boolean;
@@ -250,11 +252,27 @@ type CatalogRecipe = {
     "catalog_id": string;
     "cooldown_seconds"?: number | null;
     "display_name"?: string | null;
+    "lock_reasons"?: RecipeLockReason[] | null;
+    "locked"?: boolean | null;
     "max_uses"?: number | null;
     "platform_prices": CatalogPrice[];
+    "prerequisites"?: RecipePrerequisite[];
     "recipe_id": string;
     "recipe_type": string;
 };
+type ChallengeListResponse = {
+    "challenges": ChallengePeriodResponse[];
+};
+type ChallengePeriodResponse = {
+    "challenge_data"?: string | null;
+    "challenge_data_hash"?: string | null;
+    "period_ends_at": string;
+    "period_start_at": string;
+    "progression_definition_id": string;
+    "seed": string;
+    "slug"?: string | null;
+    "window": WindowKind;
+};
 type ClientPlatform = "universal" | "mobile" | "web";
 type CreateOrderRequest = {
     "channel"?: null | GameChannel;
@@ -304,7 +322,7 @@ type EntityLeaderboardEntryResponse = {
     "rank": number;
     "stats"?: Record<string, unknown> | null;
 };
-type EntityLeaderboardResponse = {
+type EntityLeaderboardResponse = PlayerIdentityFields & {
     "bucket_1"?: string | null;
     "bucket_2"?: string | null;
     "entity_id": string;
@@ -356,16 +374,11 @@ type FidelityReport = {
     "defaults_applied": string[];
 };
 type GameChannel = "dev" | "test" | "release";
-type GameRoomMemberResponseV2 = {
-    "avatar_icon_id"?: string | null;
-    "discriminator"?: string | null;
-    "display_name"?: string | null;
-    "display_tag"?: string | null;
+type GameRoomMemberResponseV2 = PlayerIdentityFields & {
     "group_id"?: string | null;
     "is_ready": boolean;
     "joined_at": number;
     "platform"?: null | ClientPlatform;
-    "player_id": string;
     "role": string;
 };
 type GameRoomResponseV2 = {
@@ -499,6 +512,7 @@ type InventoryChange = {
     "mapping_index": number;
     "outcome": PlatformGrantOutcome;
     "platform_order_id"?: string | null;
+    "principal"?: null | ReceiptPrincipal;
     "progression_definition_id": string;
     "reason"?: string | null;
     "requested": number;
@@ -508,6 +522,7 @@ type InventoryChange = {
     "achievement_id": string;
     "outcome": AchievementUnlockOutcome;
     "points": number;
+    "principal"?: null | ReceiptPrincipal;
     "progression_definition_id": string;
     "reason"?: string | null;
     "type": "achievement_unlocked";
@@ -543,6 +558,7 @@ type InventoryScopeResponse = {
     "game_id": string;
     "type": "game";
 };
+type ItemCategory = "cosmetic" | "progression";
 type ItemInstanceResponse = {
     "acquired_at": number;
     "custom_data"?: unknown;
@@ -551,11 +567,7 @@ type ItemInstanceResponse = {
     "properties": unknown;
     "quantity": number;
 };
-type LeaderboardEntryResponse = {
-    "avatar_icon_url"?: string | null;
-    "discriminator"?: string | null;
-    "display_name"?: string | null;
-    "display_tag"?: string | null;
+type LeaderboardEntryResponse = PlayerIdentityFields & {
     "entity_id"?: string | null;
     "entity_type"?: null | EntityType;
     "is_viewer"?: boolean;
@@ -585,6 +597,11 @@ type LootRollResultResponse = {
     "was_replacement": boolean;
 };
 type MatchType = "dedicated" | "p2p" | "none";
+type NameStyle = {
+    "fallback"?: null | ThemedColors;
+    "item_id": string;
+    "preset": string;
+};
 type OperationRequest = {
     "amount": number;
     "bucket"?: string | null;
@@ -734,8 +751,33 @@ type PeriodProgressResponse = {
     "target": number;
     "window": string;
 };
-type PlatformGrantClamp = "none" | "max_per_event" | "game_max_per_entity" | "platform_max_per_game_per_entity" | "game_max_per_window" | "platform_max_per_window" | "max_balance";
+type PlatformGrantClamp = "none" | "max_per_event" | "game_max_per_entity" | "platform_max_per_game_per_entity" | "game_max_per_window" | "platform_max_per_window" | "max_balance" | "holdings_cap";
 type PlatformGrantOutcome = "fired" | "clamped" | "suppressed";
+type PlayerBadge = {
+    "icon_url": string;
+    "item_id": string;
+    "kind": BadgeKind;
+};
+type PlayerIdentityFields = {
+    "avatar_icon_id"?: string | null;
+    "avatar_icon_url"?: string | null;
+    "badges"?: PlayerBadge[];
+    "discriminator"?: string | null;
+    "display_name"?: string | null;
+    "display_tag"?: string | null;
+    "name_animation"?: null | NameStyle;
+    "name_color"?: null | NameStyle;
+    "player_id"?: string;
+    "title"?: null | PlayerTitle;
+    "title_animation"?: null | NameStyle;
+    "title_color"?: null | NameStyle;
+};
+type PlayerTitle = {
+    "item_id": string;
+    "lang": string;
+    "text": string;
+};
+type PrerequisiteType = "owns_item" | "progression_complete" | "min_progression_value" | "progression_level";
 type ProgressionAchievementState = {
     "hidden": boolean;
     "id": string;
@@ -780,9 +822,12 @@ type PurchaseCatalogResponse = {
 type PutSettingRequest = {
     "value": Base64String;
 };
+type ReceiptPrincipal = "function";
 type RecipeAvailabilityResponse = {
     "can_execute": boolean;
     "cooldown_expires_at"?: string | null;
+    "lock_reasons"?: RecipeLockReason[];
+    "locked"?: boolean;
     "reasons": UnavailabilityReason[];
     "recipe_id": string;
     "uses_remaining"?: number | null;
@@ -803,6 +848,17 @@ type RecipeExecuteResponse = {
     "order_id": string;
     "status": OrderStatus;
 };
+type RecipeLockReason = {
+    "current": number;
+    "prerequisite_type": PrerequisiteType;
+    "reference_id": string;
+    "required": number;
+};
+type RecipePrerequisite = {
+    "prerequisite_type": PrerequisiteType;
+    "reference_id": string;
+    "reference_value": number;
+};
 type RecipeUsageListResponse = {
     "usages": RecipeUsageResponse[];
 };
@@ -967,6 +1023,10 @@ type SuppliedScope = {
     "game_id": string;
     "type": "game";
 };
+type ThemedColors = {
+    "on_dark": string;
+    "on_light": string;
+};
 type TransferCurrencyRequest = {
     "amount": number;
     "currency_id": string;
@@ -1012,8 +1072,10 @@ type UnavailabilityReason = {
     "max_uses": number;
     "type": "max_uses_reached";
 } | {
+    "current"?: number;
     "prerequisite_type": string;
     "reference_id": string;
+    "required"?: number;
     "type": "prerequisite_not_met";
 } | {
     "available": number;
@@ -1036,6 +1098,7 @@ type UpdateGameRoomRequest = {
 type UpdateRoomArgsRequest = {
     "room_args": Record<string, unknown>;
 };
+type WindowKind = "daily" | "weekly" | "monthly" | "cron";
 type WindowPreviewResponse = {
     "ends_at": string;
     "starts_at": string;
@@ -1110,9 +1173,9 @@ declare function getEntityInventoryItem(api: GameApi, entity_type: string, entit
     signal?: AbortSignal;
 }): Promise<ItemInstanceResponse[]>;
 declare function getEntityLeaderboard(api: GameApi, leaderboard_type: string, entity_type: string, entity_id: string, options?: {
-    "bucket_1"?: string;
-    "bucket_2"?: string;
-    "limit"?: number;
+    "bucket_1"?: string | null;
+    "bucket_2"?: string | null;
+    "limit"?: number | null;
     signal?: AbortSignal;
 }): Promise<EntityLeaderboardResponse>;
 declare function getEntityOrder(api: GameApi, entity_type: string, entity_id: string, order_id: string, options?: {
@@ -1140,12 +1203,12 @@ declare function getGameRoomV2(api: GameApi, game_room_id: string, options?: {
     signal?: AbortSignal;
 }): Promise<VersionedResponse<GameRoomResponseV2>>;
 declare function getLeaderboard(api: GameApi, leaderboard_type: string, options?: {
-    "bucket_1"?: string;
-    "bucket_2"?: string;
+    "bucket_1"?: string | null;
+    "bucket_2"?: string | null;
     signal?: AbortSignal;
 }): Promise<LeaderboardResponse>;
 declare function getPurchaseCatalog(api: GameApi, options?: {
-    "config_version"?: number;
+    "config_version"?: number | null;
     signal?: AbortSignal;
 }): Promise<PurchaseCatalogResponse>;
 declare function getResolvedTemplate(api: GameApi, template_id: string, options?: {
@@ -1163,9 +1226,16 @@ declare function ingestAnalyticsEvents(api: GameApi, body: AnalyticsBatchRequest
 declare function initiateInventoryTransfer(api: GameApi, body: InitiateTransferRequest, options?: {
     signal?: AbortSignal;
 }): Promise<TransferResponse>;
+declare function invokeFunction(api: GameApi, body: Uint8Array, options?: {
+    signal?: AbortSignal;
+}): Promise<BytesResponse>;
 declare function kickPlayer(api: GameApi, game_room_id: string, player_id: string, options?: {
     signal?: AbortSignal;
 }): Promise<void>;
+declare function listChallenges(api: GameApi, options?: {
+    "periods_back"?: number;
+    signal?: AbortSignal;
+}): Promise<ChallengeListResponse>;
 declare function listEntityGameSettings(api: GameApi, entity_type: string, entity_id: string, options?: {
     signal?: AbortSignal;
 }): Promise<SettingsListResponse>;
@@ -1204,9 +1274,9 @@ declare function listResolvedTemplates(api: GameApi, options?: {
 declare function listTransfers(api: GameApi, options: {
     "entity_type": string;
     "entity_id": string;
-    "direction"?: string;
-    "status"?: string;
-    "cursor"?: string;
+    "direction"?: string | null;
+    "status"?: string | null;
+    "cursor"?: string | null;
     "limit"?: number;
     signal?: AbortSignal;
 }): Promise<ListTransfersResponse>;
@@ -1242,6 +1312,7 @@ type generated_AdminActionRequest = AdminActionRequest;
 type generated_AnalyticsBatchRequest = AnalyticsBatchRequest;
 type generated_AnalyticsBatchResponse = AnalyticsBatchResponse;
 type generated_AnalyticsEventSubmission = AnalyticsEventSubmission;
+type generated_BadgeKind = BadgeKind;
 type generated_BatchOrderItem = BatchOrderItem;
 type generated_BatchOrderItemResult = BatchOrderItemResult;
 type generated_BatchOrderRequest = BatchOrderRequest;
@@ -1250,6 +1321,8 @@ type generated_BucketBalanceResponse = BucketBalanceResponse;
 type generated_CatalogItem = CatalogItem;
 type generated_CatalogPrice = CatalogPrice;
 type generated_CatalogRecipe = CatalogRecipe;
+type generated_ChallengeListResponse = ChallengeListResponse;
+type generated_ChallengePeriodResponse = ChallengePeriodResponse;
 type generated_ClientPlatform = ClientPlatform;
 type generated_CreateOrderRequest = CreateOrderRequest;
 type generated_CreateSessionRequest = CreateSessionRequest;
@@ -1278,12 +1351,14 @@ type generated_InitiateTransferRequest = InitiateTransferRequest;
 type generated_InventoryChange = InventoryChange;
 type generated_InventoryResponse = InventoryResponse;
 type generated_InventoryScopeResponse = InventoryScopeResponse;
+type generated_ItemCategory = ItemCategory;
 type generated_ItemInstanceResponse = ItemInstanceResponse;
 type generated_LeaderboardEntryResponse = LeaderboardEntryResponse;
 type generated_LeaderboardResponse = LeaderboardResponse;
 type generated_ListTransfersResponse = ListTransfersResponse;
 type generated_LootRollResultResponse = LootRollResultResponse;
 type generated_MatchType = MatchType;
+type generated_NameStyle = NameStyle;
 type generated_OperationRequest = OperationRequest;
 type generated_OrderListResponse = OrderListResponse;
 type generated_OrderRecordResponse = OrderRecordResponse;
@@ -1298,6 +1373,10 @@ type generated_PaginatedResponseSaveDataResponse = PaginatedResponseSaveDataResp
 type generated_PeriodProgressResponse = PeriodProgressResponse;
 type generated_PlatformGrantClamp = PlatformGrantClamp;
 type generated_PlatformGrantOutcome = PlatformGrantOutcome;
+type generated_PlayerBadge = PlayerBadge;
+type generated_PlayerIdentityFields = PlayerIdentityFields;
+type generated_PlayerTitle = PlayerTitle;
+type generated_PrerequisiteType = PrerequisiteType;
 type generated_ProgressionAchievementState = ProgressionAchievementState;
 type generated_ProgressionAddRequest = ProgressionAddRequest;
 type generated_ProgressionClaimRequest = ProgressionClaimRequest;
@@ -1306,9 +1385,12 @@ type generated_ProgressionStateOverride = ProgressionStateOverride;
 type generated_ProgressionStateResponse = ProgressionStateResponse;
 type generated_PurchaseCatalogResponse = PurchaseCatalogResponse;
 type generated_PutSettingRequest = PutSettingRequest;
+type generated_ReceiptPrincipal = ReceiptPrincipal;
 type generated_RecipeAvailabilityResponse = RecipeAvailabilityResponse;
 type generated_RecipeExecuteRequest = RecipeExecuteRequest;
 type generated_RecipeExecuteResponse = RecipeExecuteResponse;
+type generated_RecipeLockReason = RecipeLockReason;
+type generated_RecipePrerequisite = RecipePrerequisite;
 type generated_RecipeUsageListResponse = RecipeUsageListResponse;
 type generated_RecipeUsageResponse = RecipeUsageResponse;
 type generated_RoomArgType = RoomArgType;
@@ -1336,12 +1418,14 @@ type generated_SuppliedPeriodProgressRow = SuppliedPeriodProgressRow;
 type generated_SuppliedProgressionRow = SuppliedProgressionRow;
 type generated_SuppliedProgressions = SuppliedProgressions;
 type generated_SuppliedScope = SuppliedScope;
+type generated_ThemedColors = ThemedColors;
 type generated_TransferCurrencyRequest = TransferCurrencyRequest;
 type generated_TransferItemRequest = TransferItemRequest;
 type generated_TransferResponse = TransferResponse;
 type generated_UnavailabilityReason = UnavailabilityReason;
 type generated_UpdateGameRoomRequest = UpdateGameRoomRequest;
 type generated_UpdateRoomArgsRequest = UpdateRoomArgsRequest;
+type generated_WindowKind = WindowKind;
 type generated_WindowPreviewResponse = WindowPreviewResponse;
 declare const generated_acceptTransfer: typeof acceptTransfer;
 declare const generated_addEntityProgression: typeof addEntityProgression;
@@ -1377,7 +1461,9 @@ declare const generated_getRoomArgs: typeof getRoomArgs;
 declare const generated_getTransferDetails: typeof getTransferDetails;
 declare const generated_ingestAnalyticsEvents: typeof ingestAnalyticsEvents;
 declare const generated_initiateInventoryTransfer: typeof initiateInventoryTransfer;
+declare const generated_invokeFunction: typeof invokeFunction;
 declare const generated_kickPlayer: typeof kickPlayer;
+declare const generated_listChallenges: typeof listChallenges;
 declare const generated_listEntityGameSettings: typeof listEntityGameSettings;
 declare const generated_listEntityOrders: typeof listEntityOrders;
 declare const generated_listEntityProgressions: typeof listEntityProgressions;
@@ -1395,7 +1481,7 @@ 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_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_ClientPlatform as ClientPlatform, 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_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_ItemInstanceResponse as ItemInstanceResponse, type generated_LeaderboardEntryResponse as LeaderboardEntryResponse, type generated_LeaderboardResponse as LeaderboardResponse, type generated_ListTransfersResponse as ListTransfersResponse, type generated_LootRollResultResponse as LootRollResultResponse, type generated_MatchType as MatchType, 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_ProgressionAchievementState as ProgressionAchievementState, type generated_ProgressionAddRequest as ProgressionAddRequest, type generated_ProgressionClaimRequest as ProgressionClaimRequest, 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_RecipeAvailabilityResponse as RecipeAvailabilityResponse, type generated_RecipeExecuteRequest as RecipeExecuteRequest, type generated_RecipeExecuteResponse as RecipeExecuteResponse, 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_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_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_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_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_executeEntityRecipe as executeEntityRecipe, generated_finalizeSaveUpload as finalizeSaveUpload, 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_getPurchaseCatalog as getPurchaseCatalog, generated_getResolvedTemplate as getResolvedTemplate, generated_getRoomArgs as getRoomArgs, generated_getTransferDetails as getTransferDetails, generated_ingestAnalyticsEvents as ingestAnalyticsEvents, generated_initiateInventoryTransfer as initiateInventoryTransfer, generated_kickPlayer as kickPlayer, 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_putEntityGameSetting as putEntityGameSetting, generated_putRoomArgs as putRoomArgs, 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_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_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_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_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_PlayerIdentityFields as PlayerIdentityFields, type generated_PlayerTitle as PlayerTitle, type generated_PrerequisiteType as PrerequisiteType, type generated_ProgressionAchievementState as ProgressionAchievementState, type generated_ProgressionAddRequest as ProgressionAddRequest, type generated_ProgressionClaimRequest as ProgressionClaimRequest, 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_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_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_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_executeEntityRecipe as executeEntityRecipe, generated_finalizeSaveUpload as finalizeSaveUpload, 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_getPurchaseCatalog as getPurchaseCatalog, generated_getResolvedTemplate as getResolvedTemplate, generated_getRoomArgs as getRoomArgs, 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_putEntityGameSetting as putEntityGameSetting, generated_putRoomArgs as putRoomArgs, generated_rejectTransfer as rejectTransfer, generated_requestSaveUploadUrl as requestSaveUploadUrl, generated_resetEntityProgression as resetEntityProgression, generated_simulateEntityOrder as simulateEntityOrder, generated_transferHostV2 as transferHostV2, generated_updateGameRoomV2 as updateGameRoomV2 };
 }
 type AnalyticsValue = string | number;
 interface AnalyticsRejection {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@indiegems/gem-web-sdk",
-  "version": "7.0.0",
+  "version": "7.1.0",
   "description": "postMessage bridge contract between gem-web and browser-playable games",
   "license": "UNLICENSED",
   "type": "module",

package/schema/bridge.v1.json

@@ -583,6 +583,80 @@
           "format": "url",
           "optional": true,
           "$comment": "LEGACY — the earlier spelling of `avatarIconUrl`, and the same value. Same pin caveat. A current frame reads it only when `avatarIconUrl` is absent."
+        },
+        "boost": {
+          "kind": "object",
+          "optional": true,
+          "$comment": [
+            "The player's Boost, FOR DISPLAY ONLY — a platform rule, not advice. A",
+            "Boost is the Arcade's one real-money product: it",
+            "multiplies what the player EARNS in platform currencies (Gems and",
+            "Tickets) and raises their earning limits. It never touches achievement",
+            "points.",
+            "",
+            "ADVISORY. It may lag: it is pushed on connect and again when the",
+            "parent's copy changes, never on the instant a boost starts or ends. The",
+            "platform applies the real multiplier server-side when it pays, whatever",
+            "a game renders. A game may SHOW it — a \"2x\" badge on a reward screen —",
+            "and must never gate content, difficulty, matchmaking, prices or power on",
+            "it. It is also trivially forgeable inside the game's own realm, which is",
+            "the second reason nothing may key on it.",
+            "",
+            "Platform-assigned numbers only, so it sits on the trusted side of the",
+            "`untrusted` split: currency ids and slugs, multipliers, a day count. NO",
+            "tier, SKU, price, source (paid, comp, trial) or instant: free and paid",
+            "boosts look identical to a game, and `expiresInDays` is whole days",
+            "rounded up because a second-precision expiry is a near-unique",
+            "per-player value two games could join on to link a player's two",
+            "game-scoped identities.",
+            "",
+            "ABSENT MEANS THE PARENT DID NOT SAY — an older parent, a backend without",
+            "boosts, or a read that has not landed. A frame reads absence as 1x",
+            "everywhere, which is also what an unboosted player's message says.",
+            "",
+            "Additive and optional, so no `v` bump, and ungated like the rest of",
+            "`gem.player`: no capability, because a frame that ignores the field",
+            "loses nothing but a badge."
+          ],
+          "fields": {
+            "multipliers": {
+              "kind": "array",
+              "maxItems": 8,
+              "$comment": "One entry per boostable platform currency the parent knows of, in the parent's display order. `multiplierBp` is basis points: 10000 is 1x (not boosted), 20000 is 2x. A currency missing from the list is 1x. A parent drops an entry it cannot fit in these bounds rather than losing the whole message to it.",
+              "items": {
+                "kind": "object",
+                "fields": {
+                  "currencyId": { "kind": "string", "maxLength": 64 },
+                  "currencySlug": {
+                    "kind": "string",
+                    "maxLength": 32,
+                    "$comment": "The currency's slug, e.g. GEMS or ARCADE_TICKETS — the same slug `gem.rewardCue` and `gem.requestPurchase` take."
+                  },
+                  "multiplierBp": { "kind": "int", "min": 10000, "max": 1000000 }
+                }
+              }
+            },
+            "expiresInDays": {
+              "kind": "int",
+              "min": 1,
+              "max": 7,
+              "optional": true,
+              "$comment": [
+                "Whole days until the SOONEST multiplied currency drops back, rounded up",
+                "so a boost with any time left reads at least 1, and CAPPED AT 7: 7 means",
+                "\"7 or more\". Absent when no currency is multiplied. A count of days,",
+                "never an instant.",
+                "",
+                "THE CAP IS A PRIVACY BOUND, not a display choice. An exact count lets a",
+                "game watch it jump by a purchase's term (30 days) and infer that the",
+                "player just paid, and when. Capped, a boost with more than a week left",
+                "looks the same whether it was bought yesterday or a month ago. The",
+                "player's own account surfaces keep the exact figure; only what crosses",
+                "here is capped, and a parent clamps rather than letting a larger value",
+                "cost the frame the whole message."
+              ]
+            }
+          }
         }
       },
       "rateLimit": { "perMinute": 12 }
@@ -2104,11 +2178,22 @@
         "player's one real wallet (gem-api's rule), so a cue confirms the same",
         "way everywhere; a grant the receipt reports suppressed confirms nothing.",
         "",
+        "AT THE DAILY MAXIMUM the platform trims a grant to what is left of the",
+        "player's day across all games, down to 0 once it is spent, and sends the",
+        "parent `platform_daily_maximum_reached`. A parent resolves a cue it holds",
+        "then into its own \"daily max\" state rather than letting it fade, and",
+        "tells the player itself. That event is the player's, never relayed into",
+        "the frame: the game learns nothing from it, and needs to do nothing",
+        "differently.",
+        "",
         "Gated by `rewardCue`: sent only to a parent that advertised it; to any",
         "other, `gem.cueReward` returns false and the game does NOTHING. There is",
         "no fallback celebration: Gems display belongs to the arcade (the",
         "creator's ruling, 2026-09-24), so a game draws no Gems flight, counter or",
-        "celebration of its own. `origin` is the centre of the game's Gems icon."
+        "celebration of its own. The same holds for Tickets (`ARCADE_TICKETS`): the",
+        "arcade's wallet shows Gems and Tickets side by side and flies a payout",
+        "into the one `currencySlug` names. `origin` is the centre of the game's icon for",
+        "that currency — its gem, or its ticket."
       ],
       "fields": {
         "currencySlug": { "kind": "string", "maxLength": 32 },
@@ -2308,7 +2393,7 @@
         "currencySlug": {
           "kind": "string",
           "maxLength": 32,
-          "$comment": "Which platform currency to pay in, e.g. GEMS. The item must carry a price in it; the parent resolves that price itself and refuses when there is none. FRAME-CHOSEN AND UNCONSTRAINED HERE: nothing in this schema limits it to a currency the player earned rather than bought, so the parent checks it against a server-side earned-currency allowlist. See the EARNED CURRENCIES ONLY obligation above - this field is where that whole argument lands."
+          "$comment": "Which platform currency to pay in, e.g. GEMS or ARCADE_TICKETS. The item must carry a price in it; the parent resolves that price itself and refuses when there is none. FRAME-CHOSEN AND UNCONSTRAINED HERE: nothing in this schema limits it to a currency the player earned rather than bought, so the parent checks it against a server-side earned-currency allowlist. See the EARNED CURRENCIES ONLY obligation above - this field is where that whole argument lands."
         },
         "quantity": {
           "kind": "int",