@indiegems/gem-web-sdk 7.0.0 → 7.1.1

package/dist/server-api.d.ts

@@ -123,6 +123,7 @@ type AnalyticsRejection = {
     "code": string;
     "index": number;
 };
+type BadgeKind = "platform" | "game";
 type BatchOrderItem = {
     "nonce"?: string | null;
     "operations": OperationRequest[];
@@ -153,6 +154,7 @@ type BucketBalanceResponse = {
     "next_reset_at"?: number | null;
 };
 type CatalogItem = {
+    "category"?: ItemCategory;
     "consumable": boolean;
     "display_name"?: string | null;
     "fungible": boolean;
@@ -172,11 +174,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;
@@ -226,7 +244,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;
@@ -278,16 +296,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 = {
@@ -421,6 +434,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;
@@ -430,6 +444,7 @@ type InventoryChange = {
     "achievement_id": string;
     "outcome": AchievementUnlockOutcome;
     "points": number;
+    "principal"?: null | ReceiptPrincipal;
     "progression_definition_id": string;
     "reason"?: string | null;
     "type": "achievement_unlocked";
@@ -465,6 +480,7 @@ type InventoryScopeResponse = {
     "game_id": string;
     "type": "game";
 };
+type ItemCategory = "cosmetic" | "progression";
 type ItemInstanceResponse = {
     "acquired_at": number;
     "custom_data"?: unknown;
@@ -473,11 +489,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;
@@ -507,6 +519,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;
@@ -656,8 +673,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;
@@ -702,9 +744,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;
@@ -725,6 +770,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[];
 };
@@ -889,6 +945,10 @@ type SuppliedScope = {
     "game_id": string;
     "type": "game";
 };
+type ThemedColors = {
+    "on_dark": string;
+    "on_light": string;
+};
 type TransferCurrencyRequest = {
     "amount": number;
     "currency_id": string;
@@ -934,8 +994,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;
@@ -958,6 +1020,7 @@ type UpdateGameRoomRequest = {
 type UpdateRoomArgsRequest = {
     "room_args": Record<string, unknown>;
 };
+type WindowKind = "daily" | "weekly" | "monthly" | "cron";
 type WindowPreviewResponse = {
     "ends_at": string;
     "starts_at": string;
@@ -1032,9 +1095,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?: {
@@ -1062,12 +1125,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?: {
@@ -1085,9 +1148,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>;
@@ -1126,9 +1196,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>;
@@ -1158,4 +1228,4 @@ declare function updateGameRoomV2(api: GameApi, game_room_id: string, body: Upda
     ifMatch?: string;
     signal?: AbortSignal;
 }): Promise<GameRoomResponseV2>;
-export { type AchievementUnlockOutcome, type ActiveWindowResponse, type AdminActionRequest, type AnalyticsBatchRequest, type AnalyticsBatchResponse, type AnalyticsEventSubmission, type AnalyticsRejection, type BatchOrderItem, type BatchOrderItemResult, type BatchOrderRequest, type BatchOrderResponse, type BucketBalanceResponse, type CatalogItem, type CatalogPrice, type CatalogRecipe, type ClientPlatform, type CreateOrderRequest, type CreateSessionRequest, type CurrencyBalanceResponse, type CurrencyResetOverride, type DropRateEntry, type DropRatesResponse, type EntityLeaderboardEntryResponse, type EntityLeaderboardResponse, type EntityType, type ErrorDetail, type ErrorResponse, type EventDefinitionResponse, type EventListResponse, type EventStatusInfo, type FidelityReport, type GameApi, type GameChannel, type GameRoomMemberResponseV2, type GameRoomResponseV2, type GameRoomSummaryResponse, type GameRoomTemplateListResponse, type GameRoomTemplateResponse, type GameRoomsListResponse, type InitiateTransferRequest, type InventoryChange, type InventoryResponse, type InventoryScopeResponse, type ItemInstanceResponse, type LeaderboardEntryResponse, type LeaderboardResponse, type ListTransfersResponse, type LootRollResultResponse, type MatchType, type OperationRequest, type OrderListResponse, type OrderRecordResponse, type OrderResponse, type OrderSource, type OrderStatus, type OverflowBehavior, type PaginatedCollectionCurrencyBalanceResponse, type PaginatedCollectionItemInstanceResponse, type PaginatedCollectionProgressionStateResponse, type PaginatedResponseSaveDataResponse, type PeriodProgressResponse, type PlatformGrantClamp, type PlatformGrantOutcome, type ProgressionAchievementState, type ProgressionAddRequest, type ProgressionClaimRequest, type ProgressionResetRequest, type ProgressionStateOverride, type ProgressionStateResponse, type PurchaseCatalogResponse, type PutSettingRequest, type RecipeAvailabilityResponse, type RecipeExecuteRequest, type RecipeExecuteResponse, type RecipeUsageListResponse, type RecipeUsageResponse, type RoomArgType, type RoomArgsResponse, type RoomArgsTemplate, type SaveDataResponse, type SaveFinalizeRequest, type SaveUploadUrlRequest, type SaveUploadUrlResponse, type SettingResponse, type SettingsListResponse, type SimulateOrderRequest, type SimulateOrderResponse, type SimulationFailure, type SimulationOutcome, type SimulationOverrides, type SlugOrId, type SuppliedBucketRow, type SuppliedCurrencies, type SuppliedCurrencyRow, type SuppliedInventory, type SuppliedItemRow, type SuppliedItems, type SuppliedPeriodProgressRow, type SuppliedProgressionRow, type SuppliedProgressions, type SuppliedScope, type TransferCurrencyRequest, type TransferItemRequest, type TransferResponse, type UnavailabilityReason, type UpdateGameRoomRequest, type UpdateRoomArgsRequest, type WindowPreviewResponse, acceptTransfer, addEntityProgression, adminAction, cancelInventoryTransfer, claimEntityProgressionRewards, closeGameRoom, createEntityBatchOrder, createEntityOrder, createSession, deleteEntityGameSetting, deleteEntitySave, deleteSession, executeEntityRecipe, finalizeSaveUpload, getDropRates, getEntityCurrency, getEntityGameSetting, getEntityInventory, getEntityInventoryItem, getEntityLeaderboard, getEntityOrder, getEntityProgression, getEntityRecipeAvailability, getEntityRecipeUsage, getEntitySave, getEvent, getGameRoomV2, getLeaderboard, getPurchaseCatalog, getResolvedTemplate, getRoomArgs, getTransferDetails, ingestAnalyticsEvents, initiateInventoryTransfer, kickPlayer, listEntityGameSettings, listEntityOrders, listEntityProgressions, listEntitySaves, listEvents, listGameRooms, listResolvedTemplates, listTransfers, putEntityGameSetting, putRoomArgs, rejectTransfer, requestSaveUploadUrl, resetEntityProgression, simulateEntityOrder, transferHostV2, updateGameRoomV2 };
+export { type AchievementUnlockOutcome, type ActiveWindowResponse, type AdminActionRequest, type AnalyticsBatchRequest, type AnalyticsBatchResponse, type AnalyticsEventSubmission, type AnalyticsRejection, type BadgeKind, type BatchOrderItem, type BatchOrderItemResult, type BatchOrderRequest, type BatchOrderResponse, type BucketBalanceResponse, type CatalogItem, type CatalogPrice, type CatalogRecipe, type ChallengeListResponse, type ChallengePeriodResponse, type ClientPlatform, type CreateOrderRequest, type CreateSessionRequest, type CurrencyBalanceResponse, type CurrencyResetOverride, type DropRateEntry, type DropRatesResponse, type EntityLeaderboardEntryResponse, type EntityLeaderboardResponse, type EntityType, type ErrorDetail, type ErrorResponse, type EventDefinitionResponse, type EventListResponse, type EventStatusInfo, type FidelityReport, type GameApi, type GameChannel, type GameRoomMemberResponseV2, type GameRoomResponseV2, type GameRoomSummaryResponse, type GameRoomTemplateListResponse, type GameRoomTemplateResponse, type GameRoomsListResponse, type InitiateTransferRequest, type InventoryChange, type InventoryResponse, type InventoryScopeResponse, type ItemCategory, type ItemInstanceResponse, type LeaderboardEntryResponse, type LeaderboardResponse, type ListTransfersResponse, type LootRollResultResponse, type MatchType, type NameStyle, type OperationRequest, type OrderListResponse, type OrderRecordResponse, type OrderResponse, type OrderSource, type OrderStatus, type OverflowBehavior, type PaginatedCollectionCurrencyBalanceResponse, type PaginatedCollectionItemInstanceResponse, type PaginatedCollectionProgressionStateResponse, type PaginatedResponseSaveDataResponse, type PeriodProgressResponse, type PlatformGrantClamp, type PlatformGrantOutcome, type PlayerBadge, type PlayerIdentityFields, type PlayerTitle, type PrerequisiteType, type ProgressionAchievementState, type ProgressionAddRequest, type ProgressionClaimRequest, type ProgressionResetRequest, type ProgressionStateOverride, type ProgressionStateResponse, type PurchaseCatalogResponse, type PutSettingRequest, type ReceiptPrincipal, type RecipeAvailabilityResponse, type RecipeExecuteRequest, type RecipeExecuteResponse, type RecipeLockReason, type RecipePrerequisite, type RecipeUsageListResponse, type RecipeUsageResponse, type RoomArgType, type RoomArgsResponse, type RoomArgsTemplate, type SaveDataResponse, type SaveFinalizeRequest, type SaveUploadUrlRequest, type SaveUploadUrlResponse, type SettingResponse, type SettingsListResponse, type SimulateOrderRequest, type SimulateOrderResponse, type SimulationFailure, type SimulationOutcome, type SimulationOverrides, type SlugOrId, type SuppliedBucketRow, type SuppliedCurrencies, type SuppliedCurrencyRow, type SuppliedInventory, type SuppliedItemRow, type SuppliedItems, type SuppliedPeriodProgressRow, type SuppliedProgressionRow, type SuppliedProgressions, type SuppliedScope, type ThemedColors, type TransferCurrencyRequest, type TransferItemRequest, type TransferResponse, type UnavailabilityReason, type UpdateGameRoomRequest, type UpdateRoomArgsRequest, type WindowKind, type WindowPreviewResponse, acceptTransfer, addEntityProgression, adminAction, cancelInventoryTransfer, claimEntityProgressionRewards, closeGameRoom, createEntityBatchOrder, createEntityOrder, createSession, deleteEntityGameSetting, deleteEntitySave, deleteSession, executeEntityRecipe, finalizeSaveUpload, getDropRates, getEntityCurrency, getEntityGameSetting, getEntityInventory, getEntityInventoryItem, getEntityLeaderboard, getEntityOrder, getEntityProgression, getEntityRecipeAvailability, getEntityRecipeUsage, getEntitySave, getEvent, getGameRoomV2, getLeaderboard, getPurchaseCatalog, getResolvedTemplate, getRoomArgs, getTransferDetails, ingestAnalyticsEvents, initiateInventoryTransfer, invokeFunction, kickPlayer, listChallenges, listEntityGameSettings, listEntityOrders, listEntityProgressions, listEntitySaves, listEvents, listGameRooms, listResolvedTemplates, listTransfers, putEntityGameSetting, putRoomArgs, rejectTransfer, requestSaveUploadUrl, resetEntityProgression, simulateEntityOrder, transferHostV2, updateGameRoomV2 };