@indiegems/gem-web-sdk 7.1.1 → 7.3.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/game.d.ts +12 -5
- package/dist/gem-web-sdk.esm.js +1 -1
- package/dist/gem-web-sdk.game.js +2 -2
- package/dist/gem-web-sdk.min.js +2 -2
- package/dist/gem-web-sdk.sdk.js +2 -2
- package/dist/gem-web-sdk.server-api.js +1 -1
- package/dist/gem-web-sdk.server.js +2 -2
- package/dist/sdk.d.ts +114 -9
- package/dist/server-api.d.ts +77 -1
- package/dist/server.d.ts +114 -2
- package/package.json +1 -1
package/dist/server.d.ts
CHANGED
|
@@ -264,16 +264,28 @@ type ChallengeListResponse = {
|
|
|
264
264
|
"challenges": ChallengePeriodResponse[];
|
|
265
265
|
};
|
|
266
266
|
type ChallengePeriodResponse = {
|
|
267
|
+
"boundary": string;
|
|
267
268
|
"challenge_data"?: string | null;
|
|
268
269
|
"challenge_data_hash"?: string | null;
|
|
269
270
|
"period_ends_at": string;
|
|
271
|
+
"period_local_date"?: string | null;
|
|
270
272
|
"period_start_at": string;
|
|
271
273
|
"progression_definition_id": string;
|
|
274
|
+
"reset_time": string;
|
|
272
275
|
"seed": string;
|
|
273
276
|
"slug"?: string | null;
|
|
274
277
|
"window": WindowKind;
|
|
275
278
|
};
|
|
276
279
|
type ClientPlatform = "universal" | "mobile" | "web";
|
|
280
|
+
type ConfigChannelAssignmentResponse = {
|
|
281
|
+
"assigned_at": string;
|
|
282
|
+
"assigned_by": string;
|
|
283
|
+
"channel": GameChannel;
|
|
284
|
+
"config_url"?: string | null;
|
|
285
|
+
"config_version": number;
|
|
286
|
+
"content_hash"?: string | null;
|
|
287
|
+
"published_at"?: string | null;
|
|
288
|
+
};
|
|
277
289
|
type CreateOrderRequest = {
|
|
278
290
|
"channel"?: null | GameChannel;
|
|
279
291
|
"game_id"?: string | null;
|
|
@@ -743,9 +755,12 @@ type PaginatedResponseSaveDataResponse = {
|
|
|
743
755
|
"next_cursor"?: string | null;
|
|
744
756
|
};
|
|
745
757
|
type PeriodProgressResponse = {
|
|
758
|
+
"boundary": string;
|
|
746
759
|
"completed": boolean;
|
|
747
760
|
"current_value": number;
|
|
748
761
|
"period_ends_at": number;
|
|
762
|
+
"period_id": string;
|
|
763
|
+
"period_local_date"?: string | null;
|
|
749
764
|
"period_start_at": number;
|
|
750
765
|
"progression_definition_id": string;
|
|
751
766
|
"target": number;
|
|
@@ -758,6 +773,11 @@ type PlayerBadge = {
|
|
|
758
773
|
"item_id": string;
|
|
759
774
|
"kind": BadgeKind;
|
|
760
775
|
};
|
|
776
|
+
type PlayerGameProfileResponse = SubjectIdentityFields & {
|
|
777
|
+
"achievement_score"?: number | null;
|
|
778
|
+
"generated_at": number;
|
|
779
|
+
"showcase": ProfileShowcaseEntry[];
|
|
780
|
+
};
|
|
761
781
|
type PlayerIdentityFields = {
|
|
762
782
|
"avatar_icon_id"?: string | null;
|
|
763
783
|
"avatar_icon_url"?: string | null;
|
|
@@ -778,6 +798,12 @@ type PlayerTitle = {
|
|
|
778
798
|
"text": string;
|
|
779
799
|
};
|
|
780
800
|
type PrerequisiteType = "owns_item" | "progression_complete" | "min_progression_value" | "progression_level";
|
|
801
|
+
type ProfileShowcaseEntry = {
|
|
802
|
+
"key": string;
|
|
803
|
+
"updated_at": number;
|
|
804
|
+
"value": unknown;
|
|
805
|
+
"visibility": string;
|
|
806
|
+
};
|
|
781
807
|
type ProgressionAchievementState = {
|
|
782
808
|
"hidden": boolean;
|
|
783
809
|
"id": string;
|
|
@@ -796,11 +822,16 @@ type ProgressionClaimRequest = {
|
|
|
796
822
|
"reason"?: string | null;
|
|
797
823
|
"track_id"?: string | null;
|
|
798
824
|
};
|
|
825
|
+
type ProgressionMaxRequest = {
|
|
826
|
+
"reason"?: string | null;
|
|
827
|
+
"value": number;
|
|
828
|
+
};
|
|
799
829
|
type ProgressionResetRequest = {
|
|
800
830
|
"reason"?: string | null;
|
|
801
831
|
};
|
|
802
832
|
type ProgressionStateOverride = {
|
|
803
833
|
"last_reset_at"?: string | null;
|
|
834
|
+
"last_reset_period_id"?: string | null;
|
|
804
835
|
"last_window_id"?: string | null;
|
|
805
836
|
"progression_definition_id": string;
|
|
806
837
|
"rewards_claimed_through"?: Record<string, unknown> | null;
|
|
@@ -822,6 +853,9 @@ type PurchaseCatalogResponse = {
|
|
|
822
853
|
type PutSettingRequest = {
|
|
823
854
|
"value": Base64String;
|
|
824
855
|
};
|
|
856
|
+
type PutShowcaseRequest = {
|
|
857
|
+
"value": unknown;
|
|
858
|
+
};
|
|
825
859
|
type ReceiptPrincipal = "function";
|
|
826
860
|
type RecipeAvailabilityResponse = {
|
|
827
861
|
"can_execute": boolean;
|
|
@@ -925,6 +959,12 @@ type SettingResponse = {
|
|
|
925
959
|
type SettingsListResponse = {
|
|
926
960
|
"settings": SettingResponse[];
|
|
927
961
|
};
|
|
962
|
+
type ShowcaseValueResponse = {
|
|
963
|
+
"key": string;
|
|
964
|
+
"player_id": string;
|
|
965
|
+
"updated_at": number;
|
|
966
|
+
"value": unknown;
|
|
967
|
+
};
|
|
928
968
|
type SimulateOrderRequest = {
|
|
929
969
|
"inventory": SuppliedInventory;
|
|
930
970
|
"order": CreateOrderRequest;
|
|
@@ -957,6 +997,20 @@ type SimulationOverrides = {
|
|
|
957
997
|
"progressions"?: ProgressionStateOverride[];
|
|
958
998
|
};
|
|
959
999
|
type SlugOrId = string;
|
|
1000
|
+
type SubjectIdentityFields = {
|
|
1001
|
+
"avatar_icon_id"?: string | null;
|
|
1002
|
+
"avatar_icon_url"?: string | null;
|
|
1003
|
+
"badges": PlayerBadge[];
|
|
1004
|
+
"discriminator"?: string | null;
|
|
1005
|
+
"display_name"?: string | null;
|
|
1006
|
+
"display_tag"?: string | null;
|
|
1007
|
+
"name_animation"?: null | NameStyle;
|
|
1008
|
+
"name_color"?: null | NameStyle;
|
|
1009
|
+
"player_id": string;
|
|
1010
|
+
"title"?: null | PlayerTitle;
|
|
1011
|
+
"title_animation"?: null | NameStyle;
|
|
1012
|
+
"title_color"?: null | NameStyle;
|
|
1013
|
+
};
|
|
960
1014
|
type SuppliedBucketRow = {
|
|
961
1015
|
"balance": number;
|
|
962
1016
|
"bucket": string;
|
|
@@ -996,9 +1050,11 @@ type SuppliedItems = {
|
|
|
996
1050
|
"next_cursor"?: string | null;
|
|
997
1051
|
};
|
|
998
1052
|
type SuppliedPeriodProgressRow = {
|
|
1053
|
+
"boundary"?: string | null;
|
|
999
1054
|
"completed"?: boolean;
|
|
1000
1055
|
"current_value"?: number;
|
|
1001
1056
|
"period_ends_at": number;
|
|
1057
|
+
"period_id"?: string | null;
|
|
1002
1058
|
"period_start_at": number;
|
|
1003
1059
|
"progression_definition_id": string;
|
|
1004
1060
|
"target": number;
|
|
@@ -1141,6 +1197,9 @@ declare function deleteEntitySave(api: GameApi, entity_type: string, entity_id:
|
|
|
1141
1197
|
declare function deleteSession(api: GameApi, session_id: string, options?: {
|
|
1142
1198
|
signal?: AbortSignal;
|
|
1143
1199
|
}): Promise<void>;
|
|
1200
|
+
declare function deleteShowcaseValue(api: GameApi, player_id: string, key: string, options?: {
|
|
1201
|
+
signal?: AbortSignal;
|
|
1202
|
+
}): Promise<void>;
|
|
1144
1203
|
declare function executeEntityRecipe(api: GameApi, entity_type: string, entity_id: string, body: RecipeExecuteRequest, options?: {
|
|
1145
1204
|
ifMatch?: string;
|
|
1146
1205
|
signal?: AbortSignal;
|
|
@@ -1148,6 +1207,10 @@ declare function executeEntityRecipe(api: GameApi, entity_type: string, entity_i
|
|
|
1148
1207
|
declare function finalizeSaveUpload(api: GameApi, entity_type: string, entity_id: string, key: string, body: SaveFinalizeRequest, options?: {
|
|
1149
1208
|
signal?: AbortSignal;
|
|
1150
1209
|
}): Promise<SaveDataResponse>;
|
|
1210
|
+
declare function getChannelAssignment(api: GameApi, channel: GameChannel, options?: {
|
|
1211
|
+
ifNoneMatch?: string;
|
|
1212
|
+
signal?: AbortSignal;
|
|
1213
|
+
}): Promise<VersionedResponse<ConfigChannelAssignmentResponse>>;
|
|
1151
1214
|
declare function getDropRates(api: GameApi, loot_table_id: SlugOrId, options?: {
|
|
1152
1215
|
signal?: AbortSignal;
|
|
1153
1216
|
}): Promise<DropRatesResponse>;
|
|
@@ -1207,6 +1270,9 @@ declare function getLeaderboard(api: GameApi, leaderboard_type: string, options?
|
|
|
1207
1270
|
"bucket_2"?: string | null;
|
|
1208
1271
|
signal?: AbortSignal;
|
|
1209
1272
|
}): Promise<LeaderboardResponse>;
|
|
1273
|
+
declare function getPlayerGameProfile(api: GameApi, player_id: string, options?: {
|
|
1274
|
+
signal?: AbortSignal;
|
|
1275
|
+
}): Promise<PlayerGameProfileResponse>;
|
|
1210
1276
|
declare function getPurchaseCatalog(api: GameApi, options?: {
|
|
1211
1277
|
"config_version"?: number | null;
|
|
1212
1278
|
signal?: AbortSignal;
|
|
@@ -1217,6 +1283,9 @@ declare function getResolvedTemplate(api: GameApi, template_id: string, options?
|
|
|
1217
1283
|
declare function getRoomArgs(api: GameApi, game_room_id: string, options?: {
|
|
1218
1284
|
signal?: AbortSignal;
|
|
1219
1285
|
}): Promise<RoomArgsResponse>;
|
|
1286
|
+
declare function getShowcaseValue(api: GameApi, player_id: string, key: string, options?: {
|
|
1287
|
+
signal?: AbortSignal;
|
|
1288
|
+
}): Promise<ShowcaseValueResponse>;
|
|
1220
1289
|
declare function getTransferDetails(api: GameApi, transfer_id: string, options?: {
|
|
1221
1290
|
signal?: AbortSignal;
|
|
1222
1291
|
}): Promise<TransferResponse>;
|
|
@@ -1234,6 +1303,7 @@ declare function kickPlayer(api: GameApi, game_room_id: string, player_id: strin
|
|
|
1234
1303
|
}): Promise<void>;
|
|
1235
1304
|
declare function listChallenges(api: GameApi, options?: {
|
|
1236
1305
|
"periods_back"?: number;
|
|
1306
|
+
"player_id"?: string;
|
|
1237
1307
|
signal?: AbortSignal;
|
|
1238
1308
|
}): Promise<ChallengeListResponse>;
|
|
1239
1309
|
declare function listEntityGameSettings(api: GameApi, entity_type: string, entity_id: string, options?: {
|
|
@@ -1280,6 +1350,9 @@ declare function listTransfers(api: GameApi, options: {
|
|
|
1280
1350
|
"limit"?: number;
|
|
1281
1351
|
signal?: AbortSignal;
|
|
1282
1352
|
}): Promise<ListTransfersResponse>;
|
|
1353
|
+
declare function maxEntityProgression(api: GameApi, entity_type: string, entity_id: string, progression_definition_id: SlugOrId, body: ProgressionMaxRequest, options?: {
|
|
1354
|
+
signal?: AbortSignal;
|
|
1355
|
+
}): Promise<OrderResponse>;
|
|
1283
1356
|
declare function putEntityGameSetting(api: GameApi, entity_type: string, entity_id: string, key: string, body: PutSettingRequest, options?: {
|
|
1284
1357
|
ifMatch?: string;
|
|
1285
1358
|
signal?: AbortSignal;
|
|
@@ -1287,6 +1360,9 @@ declare function putEntityGameSetting(api: GameApi, entity_type: string, entity_
|
|
|
1287
1360
|
declare function putRoomArgs(api: GameApi, game_room_id: string, body: UpdateRoomArgsRequest, options?: {
|
|
1288
1361
|
signal?: AbortSignal;
|
|
1289
1362
|
}): Promise<RoomArgsResponse>;
|
|
1363
|
+
declare function putShowcaseValue(api: GameApi, player_id: string, key: string, body: PutShowcaseRequest, options?: {
|
|
1364
|
+
signal?: AbortSignal;
|
|
1365
|
+
}): Promise<ShowcaseValueResponse>;
|
|
1290
1366
|
declare function rejectTransfer(api: GameApi, transfer_id: string, options?: {
|
|
1291
1367
|
signal?: AbortSignal;
|
|
1292
1368
|
}): Promise<TransferResponse>;
|
|
@@ -1324,6 +1400,7 @@ type generated_CatalogRecipe = CatalogRecipe;
|
|
|
1324
1400
|
type generated_ChallengeListResponse = ChallengeListResponse;
|
|
1325
1401
|
type generated_ChallengePeriodResponse = ChallengePeriodResponse;
|
|
1326
1402
|
type generated_ClientPlatform = ClientPlatform;
|
|
1403
|
+
type generated_ConfigChannelAssignmentResponse = ConfigChannelAssignmentResponse;
|
|
1327
1404
|
type generated_CreateOrderRequest = CreateOrderRequest;
|
|
1328
1405
|
type generated_CreateSessionRequest = CreateSessionRequest;
|
|
1329
1406
|
type generated_CurrencyBalanceResponse = CurrencyBalanceResponse;
|
|
@@ -1374,17 +1451,21 @@ type generated_PeriodProgressResponse = PeriodProgressResponse;
|
|
|
1374
1451
|
type generated_PlatformGrantClamp = PlatformGrantClamp;
|
|
1375
1452
|
type generated_PlatformGrantOutcome = PlatformGrantOutcome;
|
|
1376
1453
|
type generated_PlayerBadge = PlayerBadge;
|
|
1454
|
+
type generated_PlayerGameProfileResponse = PlayerGameProfileResponse;
|
|
1377
1455
|
type generated_PlayerIdentityFields = PlayerIdentityFields;
|
|
1378
1456
|
type generated_PlayerTitle = PlayerTitle;
|
|
1379
1457
|
type generated_PrerequisiteType = PrerequisiteType;
|
|
1458
|
+
type generated_ProfileShowcaseEntry = ProfileShowcaseEntry;
|
|
1380
1459
|
type generated_ProgressionAchievementState = ProgressionAchievementState;
|
|
1381
1460
|
type generated_ProgressionAddRequest = ProgressionAddRequest;
|
|
1382
1461
|
type generated_ProgressionClaimRequest = ProgressionClaimRequest;
|
|
1462
|
+
type generated_ProgressionMaxRequest = ProgressionMaxRequest;
|
|
1383
1463
|
type generated_ProgressionResetRequest = ProgressionResetRequest;
|
|
1384
1464
|
type generated_ProgressionStateOverride = ProgressionStateOverride;
|
|
1385
1465
|
type generated_ProgressionStateResponse = ProgressionStateResponse;
|
|
1386
1466
|
type generated_PurchaseCatalogResponse = PurchaseCatalogResponse;
|
|
1387
1467
|
type generated_PutSettingRequest = PutSettingRequest;
|
|
1468
|
+
type generated_PutShowcaseRequest = PutShowcaseRequest;
|
|
1388
1469
|
type generated_ReceiptPrincipal = ReceiptPrincipal;
|
|
1389
1470
|
type generated_RecipeAvailabilityResponse = RecipeAvailabilityResponse;
|
|
1390
1471
|
type generated_RecipeExecuteRequest = RecipeExecuteRequest;
|
|
@@ -1402,12 +1483,14 @@ type generated_SaveUploadUrlRequest = SaveUploadUrlRequest;
|
|
|
1402
1483
|
type generated_SaveUploadUrlResponse = SaveUploadUrlResponse;
|
|
1403
1484
|
type generated_SettingResponse = SettingResponse;
|
|
1404
1485
|
type generated_SettingsListResponse = SettingsListResponse;
|
|
1486
|
+
type generated_ShowcaseValueResponse = ShowcaseValueResponse;
|
|
1405
1487
|
type generated_SimulateOrderRequest = SimulateOrderRequest;
|
|
1406
1488
|
type generated_SimulateOrderResponse = SimulateOrderResponse;
|
|
1407
1489
|
type generated_SimulationFailure = SimulationFailure;
|
|
1408
1490
|
type generated_SimulationOutcome = SimulationOutcome;
|
|
1409
1491
|
type generated_SimulationOverrides = SimulationOverrides;
|
|
1410
1492
|
type generated_SlugOrId = SlugOrId;
|
|
1493
|
+
type generated_SubjectIdentityFields = SubjectIdentityFields;
|
|
1411
1494
|
type generated_SuppliedBucketRow = SuppliedBucketRow;
|
|
1412
1495
|
type generated_SuppliedCurrencies = SuppliedCurrencies;
|
|
1413
1496
|
type generated_SuppliedCurrencyRow = SuppliedCurrencyRow;
|
|
@@ -1439,8 +1522,10 @@ declare const generated_createSession: typeof createSession;
|
|
|
1439
1522
|
declare const generated_deleteEntityGameSetting: typeof deleteEntityGameSetting;
|
|
1440
1523
|
declare const generated_deleteEntitySave: typeof deleteEntitySave;
|
|
1441
1524
|
declare const generated_deleteSession: typeof deleteSession;
|
|
1525
|
+
declare const generated_deleteShowcaseValue: typeof deleteShowcaseValue;
|
|
1442
1526
|
declare const generated_executeEntityRecipe: typeof executeEntityRecipe;
|
|
1443
1527
|
declare const generated_finalizeSaveUpload: typeof finalizeSaveUpload;
|
|
1528
|
+
declare const generated_getChannelAssignment: typeof getChannelAssignment;
|
|
1444
1529
|
declare const generated_getDropRates: typeof getDropRates;
|
|
1445
1530
|
declare const generated_getEntityCurrency: typeof getEntityCurrency;
|
|
1446
1531
|
declare const generated_getEntityGameSetting: typeof getEntityGameSetting;
|
|
@@ -1455,9 +1540,11 @@ declare const generated_getEntitySave: typeof getEntitySave;
|
|
|
1455
1540
|
declare const generated_getEvent: typeof getEvent;
|
|
1456
1541
|
declare const generated_getGameRoomV2: typeof getGameRoomV2;
|
|
1457
1542
|
declare const generated_getLeaderboard: typeof getLeaderboard;
|
|
1543
|
+
declare const generated_getPlayerGameProfile: typeof getPlayerGameProfile;
|
|
1458
1544
|
declare const generated_getPurchaseCatalog: typeof getPurchaseCatalog;
|
|
1459
1545
|
declare const generated_getResolvedTemplate: typeof getResolvedTemplate;
|
|
1460
1546
|
declare const generated_getRoomArgs: typeof getRoomArgs;
|
|
1547
|
+
declare const generated_getShowcaseValue: typeof getShowcaseValue;
|
|
1461
1548
|
declare const generated_getTransferDetails: typeof getTransferDetails;
|
|
1462
1549
|
declare const generated_ingestAnalyticsEvents: typeof ingestAnalyticsEvents;
|
|
1463
1550
|
declare const generated_initiateInventoryTransfer: typeof initiateInventoryTransfer;
|
|
@@ -1472,8 +1559,10 @@ declare const generated_listEvents: typeof listEvents;
|
|
|
1472
1559
|
declare const generated_listGameRooms: typeof listGameRooms;
|
|
1473
1560
|
declare const generated_listResolvedTemplates: typeof listResolvedTemplates;
|
|
1474
1561
|
declare const generated_listTransfers: typeof listTransfers;
|
|
1562
|
+
declare const generated_maxEntityProgression: typeof maxEntityProgression;
|
|
1475
1563
|
declare const generated_putEntityGameSetting: typeof putEntityGameSetting;
|
|
1476
1564
|
declare const generated_putRoomArgs: typeof putRoomArgs;
|
|
1565
|
+
declare const generated_putShowcaseValue: typeof putShowcaseValue;
|
|
1477
1566
|
declare const generated_rejectTransfer: typeof rejectTransfer;
|
|
1478
1567
|
declare const generated_requestSaveUploadUrl: typeof requestSaveUploadUrl;
|
|
1479
1568
|
declare const generated_resetEntityProgression: typeof resetEntityProgression;
|
|
@@ -1481,7 +1570,7 @@ declare const generated_simulateEntityOrder: typeof simulateEntityOrder;
|
|
|
1481
1570
|
declare const generated_transferHostV2: typeof transferHostV2;
|
|
1482
1571
|
declare const generated_updateGameRoomV2: typeof updateGameRoomV2;
|
|
1483
1572
|
declare namespace generated {
|
|
1484
|
-
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 };
|
|
1573
|
+
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_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_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 };
|
|
1485
1574
|
}
|
|
1486
1575
|
type AnalyticsValue = string | number;
|
|
1487
1576
|
interface AnalyticsRejection {
|
|
@@ -1527,6 +1616,28 @@ declare class FunctionsApi {
|
|
|
1527
1616
|
}) => Promise<BytesResponse>);
|
|
1528
1617
|
invoke(input: unknown, options?: FunctionInvokeOptions): Promise<FunctionResult>;
|
|
1529
1618
|
}
|
|
1619
|
+
type ChallengeWindow = "daily" | "weekly" | "monthly" | "cron" | (string & {});
|
|
1620
|
+
interface Challenge {
|
|
1621
|
+
readonly id: string;
|
|
1622
|
+
readonly slug?: string;
|
|
1623
|
+
readonly window: ChallengeWindow;
|
|
1624
|
+
readonly periodStartAt: number;
|
|
1625
|
+
readonly periodEndsAt: number;
|
|
1626
|
+
readonly periodLocalDate?: string;
|
|
1627
|
+
readonly boundary: string;
|
|
1628
|
+
readonly resetTime: string;
|
|
1629
|
+
readonly seed: string;
|
|
1630
|
+
readonly data?: string;
|
|
1631
|
+
readonly dataHash?: string;
|
|
1632
|
+
}
|
|
1633
|
+
interface ServerListChallengesOptions {
|
|
1634
|
+
readonly playerId: string;
|
|
1635
|
+
readonly periodsBack?: number;
|
|
1636
|
+
readonly signal?: AbortSignal;
|
|
1637
|
+
}
|
|
1638
|
+
interface ServerChallenges {
|
|
1639
|
+
list(options: ServerListChallengesOptions): Promise<Challenge[]>;
|
|
1640
|
+
}
|
|
1530
1641
|
interface GemServerOptions {
|
|
1531
1642
|
readonly baseUrl?: string;
|
|
1532
1643
|
readonly clock?: Clock;
|
|
@@ -1551,6 +1662,7 @@ interface GemServer {
|
|
|
1551
1662
|
};
|
|
1552
1663
|
readonly analytics: ServerAnalytics;
|
|
1553
1664
|
readonly functions: FunctionsApi;
|
|
1665
|
+
readonly challenges: ServerChallenges;
|
|
1554
1666
|
readonly room?: {
|
|
1555
1667
|
get: (options?: Parameters<ServerApi["getGameRoomV2"]>[1]) => ReturnType<ServerApi["getGameRoomV2"]>;
|
|
1556
1668
|
args: (options?: Parameters<ServerApi["getRoomArgs"]>[1]) => ReturnType<ServerApi["getRoomArgs"]>;
|
|
@@ -1648,4 +1760,4 @@ interface AchievementReceipt {
|
|
|
1648
1760
|
readonly reason?: string;
|
|
1649
1761
|
}
|
|
1650
1762
|
declare function achievementReceipts(order: unknown): AchievementReceipt[];
|
|
1651
|
-
export { type AchievementReceipt, type AnalyticsFlushResult, type AnalyticsRejection, type AnalyticsValue, AuthError, type AuthFailure, type AuthState, type Base64String, type BroadcastOptions, type BytesResponse, CONDITIONAL_HEADERS, 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 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 };
|
|
1763
|
+
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 };
|