@indiegems/gem-web-sdk 5.12.0 → 7.0.0

package/dist/server-api.d.ts

@@ -12,6 +12,8 @@ interface TransportRequest {
     readonly method: "GET" | "PUT" | "POST" | "PATCH" | "DELETE";
     readonly path: string;
     readonly body?: unknown;
+    readonly bytes?: Uint8Array;
+    readonly responseType?: "json" | "bytes";
     readonly headers?: ConditionalRequestHeaders;
     readonly signal?: AbortSignal;
     readonly keepalive?: boolean;
@@ -21,6 +23,7 @@ interface TransportResponse {
     readonly body: unknown;
     readonly etag?: string;
     readonly retryAfterSeconds?: number;
+    readonly invocationId?: string;
 }
 interface Transport {
     request(request: TransportRequest): Promise<TransportResponse>;
@@ -50,6 +53,10 @@ type VersionedResponse<T> = {
     readonly modified: false;
     readonly etag?: string;
 };
+interface BytesResponse {
+    readonly bytes: Uint8Array;
+    readonly invocationId?: string;
+}
 declare class GemClient {
     private readonly options;
     constructor(options: ClientOptions);
@@ -57,6 +64,7 @@ declare class GemClient {
     getWithEtag<T>(path: string, options?: VersionedGetOptions): Promise<VersionedResponse<T>>;
     put<T>(path: string, body: unknown, signal?: AbortSignal, options?: RequestOptions): Promise<T>;
     post<T>(path: string, body: unknown, signal?: AbortSignal, options?: RequestOptions): Promise<T>;
+    postBytes(path: string, bytes: Uint8Array, signal?: AbortSignal, options?: RequestOptions): Promise<BytesResponse>;
     patch<T>(path: string, body: unknown, signal?: AbortSignal, options?: RequestOptions): Promise<T>;
     delete<T>(path: string, signal?: AbortSignal, options?: RequestOptions): Promise<T>;
     private send;
@@ -67,6 +75,7 @@ interface GameApi {
     readonly client: GemClient;
     gameId(): string;
 }
+type AchievementUnlockOutcome = "unlocked" | "already_unlocked" | "suppressed";
 type ActiveWindowResponse = {
     "ends_at": string;
     "window_id": string;
@@ -92,6 +101,28 @@ type AdminActionRequest = {
     "hearing_radius"?: number | null;
     "max_voices"?: number | null;
 };
+type AnalyticsBatchRequest = {
+    "batch_id": string;
+    "events": AnalyticsEventSubmission[];
+    "sent_at_ms": number;
+};
+type AnalyticsBatchResponse = {
+    "accepted": number;
+    "duplicate"?: boolean;
+    "rejected"?: AnalyticsRejection[];
+};
+type AnalyticsEventSubmission = {
+    "dimensions"?: Record<string, unknown>;
+    "event_uid": string;
+    "measures"?: Record<string, unknown>;
+    "name": string;
+    "offset_ms": number;
+    "player_id"?: string | null;
+};
+type AnalyticsRejection = {
+    "code": string;
+    "index": number;
+};
 type BatchOrderItem = {
     "nonce"?: string | null;
     "operations": OperationRequest[];
@@ -118,6 +149,8 @@ type BatchOrderResponse = {
 type BucketBalanceResponse = {
     "balance": number;
     "bucket": string;
+    "last_reset_at"?: number | null;
+    "next_reset_at"?: number | null;
 };
 type CatalogItem = {
     "consumable": boolean;
@@ -125,9 +158,14 @@ type CatalogItem = {
     "fungible": boolean;
     "icon_url"?: string | null;
     "item_id": string;
-    "platform_prices": PurchasePrice[];
+    "platform_prices": CatalogPrice[];
     "stack_size"?: number | null;
 };
+type CatalogPrice = {
+    "platform_currency_id": string;
+    "price": number;
+    "unconfirmed_spend": boolean;
+};
 type CatalogRecipe = {
     "availability_end"?: string | null;
     "availability_start"?: string | null;
@@ -135,7 +173,7 @@ type CatalogRecipe = {
     "cooldown_seconds"?: number | null;
     "display_name"?: string | null;
     "max_uses"?: number | null;
-    "platform_prices": PurchasePrice[];
+    "platform_prices": CatalogPrice[];
     "recipe_id": string;
     "recipe_type": string;
 };
@@ -253,6 +291,7 @@ type GameRoomMemberResponseV2 = {
     "role": string;
 };
 type GameRoomResponseV2 = {
+    "cluster_target_id"?: string | null;
     "created_at": number;
     "game_channel": string;
     "game_id": string;
@@ -266,7 +305,6 @@ type GameRoomResponseV2 = {
     "member_count": number;
     "members": GameRoomMemberResponseV2[];
     "name": string;
-    "region"?: string | null;
     "room_args"?: Record<string, unknown> | null;
     "room_args_template"?: null | RoomArgsTemplate;
     "settings"?: unknown;
@@ -279,6 +317,7 @@ type GameRoomResponseV2 = {
     "version": number;
 };
 type GameRoomSummaryResponse = {
+    "cluster_target_id"?: string | null;
     "created_at": number;
     "game_channel": string;
     "game_id": string;
@@ -381,16 +420,25 @@ type InventoryChange = {
     "granted": number;
     "mapping_index": number;
     "outcome": PlatformGrantOutcome;
+    "platform_order_id"?: string | null;
     "progression_definition_id": string;
     "reason"?: string | null;
     "requested": number;
     "target_currency_id": string;
     "type": "platform_grant";
+} | {
+    "achievement_id": string;
+    "outcome": AchievementUnlockOutcome;
+    "points": number;
+    "progression_definition_id": string;
+    "reason"?: string | null;
+    "type": "achievement_unlocked";
 } | {
     "balance_after": number;
     "balance_before": number;
     "bucket": string;
     "currency_id": string;
+    "synthesized"?: boolean;
     "type": "currency_bucket_reset";
 } | {
     "progression_definition_id": string;
@@ -406,6 +454,7 @@ type InventoryResponse = {
     "entity_id": string;
     "etag": string;
     "items": PaginatedCollectionItemInstanceResponse;
+    "period_progress": PeriodProgressResponse[];
     "progressions": PaginatedCollectionProgressionStateResponse;
     "scope": InventoryScopeResponse;
 };
@@ -425,6 +474,7 @@ type ItemInstanceResponse = {
     "quantity": number;
 };
 type LeaderboardEntryResponse = {
+    "avatar_icon_url"?: string | null;
     "discriminator"?: string | null;
     "display_name"?: string | null;
     "display_tag"?: string | null;
@@ -571,10 +621,13 @@ type PaginatedCollectionItemInstanceResponse = {
 };
 type PaginatedCollectionProgressionStateResponse = {
     "data": {
+        "achievements"?: ProgressionAchievementState[];
+        "achievements_unavailable"?: boolean;
         "completion_count": number;
         "current_value": number;
         "is_completed": boolean;
         "progression_definition_id": string;
+        "updated_at": number;
     }[];
     "has_more": boolean;
     "next_cursor"?: string | null;
@@ -594,8 +647,25 @@ type PaginatedResponseSaveDataResponse = {
     "has_more": boolean;
     "next_cursor"?: string | null;
 };
-type PlatformGrantClamp = "none" | "max_per_event" | "game_max_per_entity" | "platform_max_per_game_per_entity" | "max_balance";
+type PeriodProgressResponse = {
+    "completed": boolean;
+    "current_value": number;
+    "period_ends_at": number;
+    "period_start_at": number;
+    "progression_definition_id": string;
+    "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 PlatformGrantOutcome = "fired" | "clamped" | "suppressed";
+type ProgressionAchievementState = {
+    "hidden": boolean;
+    "id": string;
+    "points": number;
+    "revoked"?: boolean;
+    "threshold": number;
+    "unlocked_at"?: number | null;
+};
 type ProgressionAddRequest = {
     "amount": number;
     "reason"?: string | null;
@@ -616,20 +686,19 @@ type ProgressionStateOverride = {
     "rewards_claimed_through"?: Record<string, unknown> | null;
 };
 type ProgressionStateResponse = {
+    "achievements"?: ProgressionAchievementState[];
+    "achievements_unavailable"?: boolean;
     "completion_count": number;
     "current_value": number;
     "is_completed": boolean;
     "progression_definition_id": string;
+    "updated_at": number;
 };
 type PurchaseCatalogResponse = {
     "config_version": number;
     "items": CatalogItem[];
     "recipes": CatalogRecipe[];
 };
-type PurchasePrice = {
-    "platform_currency_id": string;
-    "price": number;
-};
 type PutSettingRequest = {
     "value": Base64String;
 };
@@ -757,6 +826,8 @@ type SlugOrId = string;
 type SuppliedBucketRow = {
     "balance": number;
     "bucket": string;
+    "last_reset_at"?: number | null;
+    "next_reset_at"?: number | null;
 };
 type SuppliedCurrencies = {
     "data"?: SuppliedCurrencyRow[];
@@ -773,6 +844,7 @@ type SuppliedInventory = {
     "entity_id"?: string | null;
     "etag"?: string;
     "items"?: SuppliedItems;
+    "period_progress"?: SuppliedPeriodProgressRow[];
     "progressions"?: SuppliedProgressions;
     "scope"?: null | SuppliedScope;
 };
@@ -789,11 +861,21 @@ type SuppliedItems = {
     "has_more"?: boolean;
     "next_cursor"?: string | null;
 };
+type SuppliedPeriodProgressRow = {
+    "completed"?: boolean;
+    "current_value"?: number;
+    "period_ends_at": number;
+    "period_start_at": number;
+    "progression_definition_id": string;
+    "target": number;
+    "window": string;
+};
 type SuppliedProgressionRow = {
     "completion_count": number;
     "current_value": number;
     "is_completed": boolean;
     "progression_definition_id": string;
+    "updated_at"?: number;
 };
 type SuppliedProgressions = {
     "data"?: SuppliedProgressionRow[];
@@ -937,12 +1019,13 @@ declare function getEntityGameSetting(api: GameApi, entity_type: string, entity_
 }): Promise<VersionedResponse<SettingResponse>>;
 declare function getEntityInventory(api: GameApi, entity_type: string, entity_id: string, options?: {
     "include_buckets"?: boolean;
-    "currency_limit"?: number;
-    "currency_cursor"?: string;
-    "item_limit"?: number;
-    "item_cursor"?: string;
-    "progression_limit"?: number;
-    "progression_cursor"?: string;
+    "include_custom_data"?: boolean;
+    "currency_limit"?: number | null;
+    "currency_cursor"?: string | null;
+    "item_limit"?: number | null;
+    "item_cursor"?: string | null;
+    "progression_limit"?: number | null;
+    "progression_cursor"?: string | null;
     signal?: AbortSignal;
 }): Promise<InventoryResponse>;
 declare function getEntityInventoryItem(api: GameApi, entity_type: string, entity_id: string, item_definition_id: SlugOrId, options?: {
@@ -964,7 +1047,7 @@ declare function getEntityRecipeAvailability(api: GameApi, entity_type: string,
     signal?: AbortSignal;
 }): Promise<RecipeAvailabilityResponse>;
 declare function getEntityRecipeUsage(api: GameApi, entity_type: string, entity_id: string, options?: {
-    "limit"?: number;
+    "limit"?: number | null;
     signal?: AbortSignal;
 }): Promise<RecipeUsageListResponse>;
 declare function getEntitySave(api: GameApi, entity_type: string, entity_id: string, key: string, options?: {
@@ -996,6 +1079,9 @@ declare function getRoomArgs(api: GameApi, game_room_id: string, options?: {
 declare function getTransferDetails(api: GameApi, transfer_id: string, options?: {
     signal?: AbortSignal;
 }): Promise<TransferResponse>;
+declare function ingestAnalyticsEvents(api: GameApi, body: AnalyticsBatchRequest, options?: {
+    signal?: AbortSignal;
+}): Promise<AnalyticsBatchResponse>;
 declare function initiateInventoryTransfer(api: GameApi, body: InitiateTransferRequest, options?: {
     signal?: AbortSignal;
 }): Promise<TransferResponse>;
@@ -1007,15 +1093,15 @@ declare function listEntityGameSettings(api: GameApi, entity_type: string, entit
 }): Promise<SettingsListResponse>;
 declare function listEntityOrders(api: GameApi, entity_type: string, entity_id: string, options?: {
     "limit"?: number;
-    "cursor"?: string;
+    "cursor"?: string | null;
     signal?: AbortSignal;
 }): Promise<OrderListResponse>;
 declare function listEntityProgressions(api: GameApi, entity_type: string, entity_id: string, options?: {
     signal?: AbortSignal;
 }): Promise<ProgressionStateResponse[]>;
 declare function listEntitySaves(api: GameApi, entity_type: string, entity_id: string, options?: {
-    "limit"?: number;
-    "cursor"?: string;
+    "limit"?: number | null;
+    "cursor"?: string | null;
     signal?: AbortSignal;
 }): Promise<PaginatedResponseSaveDataResponse>;
 declare function listEvents(api: GameApi, options?: {
@@ -1046,9 +1132,6 @@ declare function listTransfers(api: GameApi, options: {
     "limit"?: number;
     signal?: AbortSignal;
 }): Promise<ListTransfersResponse>;
-declare function matchEnd(api: GameApi, match_id: string, options?: {
-    signal?: AbortSignal;
-}): Promise<void>;
 declare function putEntityGameSetting(api: GameApi, entity_type: string, entity_id: string, key: string, body: PutSettingRequest, options?: {
     ifMatch?: string;
     signal?: AbortSignal;
@@ -1075,4 +1158,4 @@ declare function updateGameRoomV2(api: GameApi, game_room_id: string, body: Upda
     ifMatch?: string;
     signal?: AbortSignal;
 }): Promise<GameRoomResponseV2>;
-export { type ActiveWindowResponse, type AdminActionRequest, type BatchOrderItem, type BatchOrderItemResult, type BatchOrderRequest, type BatchOrderResponse, type BucketBalanceResponse, type CatalogItem, 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 PlatformGrantClamp, type PlatformGrantOutcome, type ProgressionAddRequest, type ProgressionClaimRequest, type ProgressionResetRequest, type ProgressionStateOverride, type ProgressionStateResponse, type PurchaseCatalogResponse, type PurchasePrice, 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 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, initiateInventoryTransfer, kickPlayer, listEntityGameSettings, listEntityOrders, listEntityProgressions, listEntitySaves, listEvents, listGameRooms, listResolvedTemplates, listTransfers, matchEnd, putEntityGameSetting, putRoomArgs, rejectTransfer, requestSaveUploadUrl, resetEntityProgression, simulateEntityOrder, transferHostV2, updateGameRoomV2 };
+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 };