@indiegems/gem-web-sdk 7.2.0 → 7.3.1
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/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 +92 -4
- package/dist/server-api.d.ts +67 -1
- package/dist/server.d.ts +104 -2
- package/package.json +1 -1
package/dist/sdk.d.ts
CHANGED
|
@@ -1235,7 +1235,7 @@ declare class PlatformApi {
|
|
|
1235
1235
|
readonly currencies: PlatformCurrenciesApi;
|
|
1236
1236
|
constructor(api: GameApi$1);
|
|
1237
1237
|
}
|
|
1238
|
-
interface ProfileShowcaseEntry {
|
|
1238
|
+
interface ProfileShowcaseEntry$1 {
|
|
1239
1239
|
readonly key: string;
|
|
1240
1240
|
readonly visibility: string;
|
|
1241
1241
|
readonly value: unknown;
|
|
@@ -1243,7 +1243,7 @@ interface ProfileShowcaseEntry {
|
|
|
1243
1243
|
}
|
|
1244
1244
|
interface PlayerProfile extends PlayerIdentity {
|
|
1245
1245
|
readonly playerId: string;
|
|
1246
|
-
readonly showcase: readonly ProfileShowcaseEntry[];
|
|
1246
|
+
readonly showcase: readonly ProfileShowcaseEntry$1[];
|
|
1247
1247
|
readonly generatedAt: number;
|
|
1248
1248
|
}
|
|
1249
1249
|
interface ProfileCallOptions {
|
|
@@ -2496,6 +2496,15 @@ type ChallengePeriodResponse = {
|
|
|
2496
2496
|
"window": WindowKind;
|
|
2497
2497
|
};
|
|
2498
2498
|
type ClientPlatform = "universal" | "mobile" | "web";
|
|
2499
|
+
type ConfigChannelAssignmentResponse = {
|
|
2500
|
+
"assigned_at": string;
|
|
2501
|
+
"assigned_by": string;
|
|
2502
|
+
"channel": GameChannel;
|
|
2503
|
+
"config_url"?: string | null;
|
|
2504
|
+
"config_version": number;
|
|
2505
|
+
"content_hash"?: string | null;
|
|
2506
|
+
"published_at"?: string | null;
|
|
2507
|
+
};
|
|
2499
2508
|
type CreateOrderRequest = {
|
|
2500
2509
|
"channel"?: null | GameChannel;
|
|
2501
2510
|
"game_id"?: string | null;
|
|
@@ -2983,6 +2992,11 @@ type PlayerBadge = {
|
|
|
2983
2992
|
"item_id": string;
|
|
2984
2993
|
"kind": BadgeKind;
|
|
2985
2994
|
};
|
|
2995
|
+
type PlayerGameProfileResponse = SubjectIdentityFields & {
|
|
2996
|
+
"achievement_score"?: number | null;
|
|
2997
|
+
"generated_at": number;
|
|
2998
|
+
"showcase": ProfileShowcaseEntry[];
|
|
2999
|
+
};
|
|
2986
3000
|
type PlayerIdentityFields = {
|
|
2987
3001
|
"avatar_icon_id"?: string | null;
|
|
2988
3002
|
"avatar_icon_url"?: string | null;
|
|
@@ -3003,6 +3017,12 @@ type PlayerTitle = {
|
|
|
3003
3017
|
"text": string;
|
|
3004
3018
|
};
|
|
3005
3019
|
type PrerequisiteType = "owns_item" | "progression_complete" | "min_progression_value" | "progression_level";
|
|
3020
|
+
type ProfileShowcaseEntry = {
|
|
3021
|
+
"key": string;
|
|
3022
|
+
"updated_at": number;
|
|
3023
|
+
"value": unknown;
|
|
3024
|
+
"visibility": string;
|
|
3025
|
+
};
|
|
3006
3026
|
type ProgressionAchievementState = {
|
|
3007
3027
|
"hidden": boolean;
|
|
3008
3028
|
"id": string;
|
|
@@ -3021,6 +3041,10 @@ type ProgressionClaimRequest = {
|
|
|
3021
3041
|
"reason"?: string | null;
|
|
3022
3042
|
"track_id"?: string | null;
|
|
3023
3043
|
};
|
|
3044
|
+
type ProgressionMaxRequest = {
|
|
3045
|
+
"reason"?: string | null;
|
|
3046
|
+
"value": number;
|
|
3047
|
+
};
|
|
3024
3048
|
type ProgressionResetRequest = {
|
|
3025
3049
|
"reason"?: string | null;
|
|
3026
3050
|
};
|
|
@@ -3048,6 +3072,9 @@ type PurchaseCatalogResponse = {
|
|
|
3048
3072
|
type PutSettingRequest = {
|
|
3049
3073
|
"value": Base64String;
|
|
3050
3074
|
};
|
|
3075
|
+
type PutShowcaseRequest = {
|
|
3076
|
+
"value": unknown;
|
|
3077
|
+
};
|
|
3051
3078
|
type ReceiptPrincipal = "function";
|
|
3052
3079
|
type RecipeAvailabilityResponse = {
|
|
3053
3080
|
"can_execute": boolean;
|
|
@@ -3151,6 +3178,12 @@ type SettingResponse = {
|
|
|
3151
3178
|
type SettingsListResponse = {
|
|
3152
3179
|
"settings": SettingResponse[];
|
|
3153
3180
|
};
|
|
3181
|
+
type ShowcaseValueResponse = {
|
|
3182
|
+
"key": string;
|
|
3183
|
+
"player_id": string;
|
|
3184
|
+
"updated_at": number;
|
|
3185
|
+
"value": unknown;
|
|
3186
|
+
};
|
|
3154
3187
|
type SimulateOrderRequest = {
|
|
3155
3188
|
"inventory": SuppliedInventory;
|
|
3156
3189
|
"order": CreateOrderRequest;
|
|
@@ -3183,6 +3216,20 @@ type SimulationOverrides = {
|
|
|
3183
3216
|
"progressions"?: ProgressionStateOverride[];
|
|
3184
3217
|
};
|
|
3185
3218
|
type SlugOrId = string;
|
|
3219
|
+
type SubjectIdentityFields = {
|
|
3220
|
+
"avatar_icon_id"?: string | null;
|
|
3221
|
+
"avatar_icon_url"?: string | null;
|
|
3222
|
+
"badges": PlayerBadge[];
|
|
3223
|
+
"discriminator"?: string | null;
|
|
3224
|
+
"display_name"?: string | null;
|
|
3225
|
+
"display_tag"?: string | null;
|
|
3226
|
+
"name_animation"?: null | NameStyle;
|
|
3227
|
+
"name_color"?: null | NameStyle;
|
|
3228
|
+
"player_id": string;
|
|
3229
|
+
"title"?: null | PlayerTitle;
|
|
3230
|
+
"title_animation"?: null | NameStyle;
|
|
3231
|
+
"title_color"?: null | NameStyle;
|
|
3232
|
+
};
|
|
3186
3233
|
type SuppliedBucketRow = {
|
|
3187
3234
|
"balance": number;
|
|
3188
3235
|
"bucket": string;
|
|
@@ -3369,6 +3416,9 @@ declare function deleteEntitySave(api: GameApi, entity_type: string, entity_id:
|
|
|
3369
3416
|
declare function deleteSession(api: GameApi, session_id: string, options?: {
|
|
3370
3417
|
signal?: AbortSignal;
|
|
3371
3418
|
}): Promise<void>;
|
|
3419
|
+
declare function deleteShowcaseValue(api: GameApi, player_id: string, key: string, options?: {
|
|
3420
|
+
signal?: AbortSignal;
|
|
3421
|
+
}): Promise<void>;
|
|
3372
3422
|
declare function executeEntityRecipe(api: GameApi, entity_type: string, entity_id: string, body: RecipeExecuteRequest, options?: {
|
|
3373
3423
|
ifMatch?: string;
|
|
3374
3424
|
signal?: AbortSignal;
|
|
@@ -3376,6 +3426,10 @@ declare function executeEntityRecipe(api: GameApi, entity_type: string, entity_i
|
|
|
3376
3426
|
declare function finalizeSaveUpload(api: GameApi, entity_type: string, entity_id: string, key: string, body: SaveFinalizeRequest, options?: {
|
|
3377
3427
|
signal?: AbortSignal;
|
|
3378
3428
|
}): Promise<SaveDataResponse>;
|
|
3429
|
+
declare function getChannelAssignment(api: GameApi, channel: GameChannel, options?: {
|
|
3430
|
+
ifNoneMatch?: string;
|
|
3431
|
+
signal?: AbortSignal;
|
|
3432
|
+
}): Promise<VersionedResponse<ConfigChannelAssignmentResponse>>;
|
|
3379
3433
|
declare function getDropRates(api: GameApi, loot_table_id: SlugOrId, options?: {
|
|
3380
3434
|
signal?: AbortSignal;
|
|
3381
3435
|
}): Promise<DropRatesResponse>;
|
|
@@ -3435,6 +3489,9 @@ declare function getLeaderboard(api: GameApi, leaderboard_type: string, options?
|
|
|
3435
3489
|
"bucket_2"?: string | null;
|
|
3436
3490
|
signal?: AbortSignal;
|
|
3437
3491
|
}): Promise<LeaderboardResponse>;
|
|
3492
|
+
declare function getPlayerGameProfile(api: GameApi, player_id: string, options?: {
|
|
3493
|
+
signal?: AbortSignal;
|
|
3494
|
+
}): Promise<PlayerGameProfileResponse>;
|
|
3438
3495
|
declare function getPurchaseCatalog(api: GameApi, options?: {
|
|
3439
3496
|
"config_version"?: number | null;
|
|
3440
3497
|
signal?: AbortSignal;
|
|
@@ -3445,6 +3502,9 @@ declare function getResolvedTemplate(api: GameApi, template_id: string, options?
|
|
|
3445
3502
|
declare function getRoomArgs(api: GameApi, game_room_id: string, options?: {
|
|
3446
3503
|
signal?: AbortSignal;
|
|
3447
3504
|
}): Promise<RoomArgsResponse>;
|
|
3505
|
+
declare function getShowcaseValue(api: GameApi, player_id: string, key: string, options?: {
|
|
3506
|
+
signal?: AbortSignal;
|
|
3507
|
+
}): Promise<ShowcaseValueResponse>;
|
|
3448
3508
|
declare function getTransferDetails(api: GameApi, transfer_id: string, options?: {
|
|
3449
3509
|
signal?: AbortSignal;
|
|
3450
3510
|
}): Promise<TransferResponse>;
|
|
@@ -3509,6 +3569,9 @@ declare function listTransfers(api: GameApi, options: {
|
|
|
3509
3569
|
"limit"?: number;
|
|
3510
3570
|
signal?: AbortSignal;
|
|
3511
3571
|
}): Promise<ListTransfersResponse>;
|
|
3572
|
+
declare function maxEntityProgression(api: GameApi, entity_type: string, entity_id: string, progression_definition_id: SlugOrId, body: ProgressionMaxRequest, options?: {
|
|
3573
|
+
signal?: AbortSignal;
|
|
3574
|
+
}): Promise<OrderResponse>;
|
|
3512
3575
|
declare function putEntityGameSetting(api: GameApi, entity_type: string, entity_id: string, key: string, body: PutSettingRequest, options?: {
|
|
3513
3576
|
ifMatch?: string;
|
|
3514
3577
|
signal?: AbortSignal;
|
|
@@ -3516,6 +3579,9 @@ declare function putEntityGameSetting(api: GameApi, entity_type: string, entity_
|
|
|
3516
3579
|
declare function putRoomArgs(api: GameApi, game_room_id: string, body: UpdateRoomArgsRequest, options?: {
|
|
3517
3580
|
signal?: AbortSignal;
|
|
3518
3581
|
}): Promise<RoomArgsResponse>;
|
|
3582
|
+
declare function putShowcaseValue(api: GameApi, player_id: string, key: string, body: PutShowcaseRequest, options?: {
|
|
3583
|
+
signal?: AbortSignal;
|
|
3584
|
+
}): Promise<ShowcaseValueResponse>;
|
|
3519
3585
|
declare function rejectTransfer(api: GameApi, transfer_id: string, options?: {
|
|
3520
3586
|
signal?: AbortSignal;
|
|
3521
3587
|
}): Promise<TransferResponse>;
|
|
@@ -3554,6 +3620,7 @@ type generated_CatalogRecipe = CatalogRecipe;
|
|
|
3554
3620
|
type generated_ChallengeListResponse = ChallengeListResponse;
|
|
3555
3621
|
type generated_ChallengePeriodResponse = ChallengePeriodResponse;
|
|
3556
3622
|
type generated_ClientPlatform = ClientPlatform;
|
|
3623
|
+
type generated_ConfigChannelAssignmentResponse = ConfigChannelAssignmentResponse;
|
|
3557
3624
|
type generated_CreateOrderRequest = CreateOrderRequest;
|
|
3558
3625
|
type generated_CreateSessionRequest = CreateSessionRequest;
|
|
3559
3626
|
type generated_CurrencyBalanceResponse = CurrencyBalanceResponse;
|
|
@@ -3604,17 +3671,21 @@ type generated_PeriodProgressResponse = PeriodProgressResponse;
|
|
|
3604
3671
|
type generated_PlatformGrantClamp = PlatformGrantClamp;
|
|
3605
3672
|
type generated_PlatformGrantOutcome = PlatformGrantOutcome;
|
|
3606
3673
|
type generated_PlayerBadge = PlayerBadge;
|
|
3674
|
+
type generated_PlayerGameProfileResponse = PlayerGameProfileResponse;
|
|
3607
3675
|
type generated_PlayerIdentityFields = PlayerIdentityFields;
|
|
3608
3676
|
type generated_PlayerTitle = PlayerTitle;
|
|
3609
3677
|
type generated_PrerequisiteType = PrerequisiteType;
|
|
3678
|
+
type generated_ProfileShowcaseEntry = ProfileShowcaseEntry;
|
|
3610
3679
|
type generated_ProgressionAchievementState = ProgressionAchievementState;
|
|
3611
3680
|
type generated_ProgressionAddRequest = ProgressionAddRequest;
|
|
3612
3681
|
type generated_ProgressionClaimRequest = ProgressionClaimRequest;
|
|
3682
|
+
type generated_ProgressionMaxRequest = ProgressionMaxRequest;
|
|
3613
3683
|
type generated_ProgressionResetRequest = ProgressionResetRequest;
|
|
3614
3684
|
type generated_ProgressionStateOverride = ProgressionStateOverride;
|
|
3615
3685
|
type generated_ProgressionStateResponse = ProgressionStateResponse;
|
|
3616
3686
|
type generated_PurchaseCatalogResponse = PurchaseCatalogResponse;
|
|
3617
3687
|
type generated_PutSettingRequest = PutSettingRequest;
|
|
3688
|
+
type generated_PutShowcaseRequest = PutShowcaseRequest;
|
|
3618
3689
|
type generated_ReceiptPrincipal = ReceiptPrincipal;
|
|
3619
3690
|
type generated_RecipeAvailabilityResponse = RecipeAvailabilityResponse;
|
|
3620
3691
|
type generated_RecipeExecuteRequest = RecipeExecuteRequest;
|
|
@@ -3632,12 +3703,14 @@ type generated_SaveUploadUrlRequest = SaveUploadUrlRequest;
|
|
|
3632
3703
|
type generated_SaveUploadUrlResponse = SaveUploadUrlResponse;
|
|
3633
3704
|
type generated_SettingResponse = SettingResponse;
|
|
3634
3705
|
type generated_SettingsListResponse = SettingsListResponse;
|
|
3706
|
+
type generated_ShowcaseValueResponse = ShowcaseValueResponse;
|
|
3635
3707
|
type generated_SimulateOrderRequest = SimulateOrderRequest;
|
|
3636
3708
|
type generated_SimulateOrderResponse = SimulateOrderResponse;
|
|
3637
3709
|
type generated_SimulationFailure = SimulationFailure;
|
|
3638
3710
|
type generated_SimulationOutcome = SimulationOutcome;
|
|
3639
3711
|
type generated_SimulationOverrides = SimulationOverrides;
|
|
3640
3712
|
type generated_SlugOrId = SlugOrId;
|
|
3713
|
+
type generated_SubjectIdentityFields = SubjectIdentityFields;
|
|
3641
3714
|
type generated_SuppliedBucketRow = SuppliedBucketRow;
|
|
3642
3715
|
type generated_SuppliedCurrencies = SuppliedCurrencies;
|
|
3643
3716
|
type generated_SuppliedCurrencyRow = SuppliedCurrencyRow;
|
|
@@ -3669,8 +3742,10 @@ declare const generated_createSession: typeof createSession;
|
|
|
3669
3742
|
declare const generated_deleteEntityGameSetting: typeof deleteEntityGameSetting;
|
|
3670
3743
|
declare const generated_deleteEntitySave: typeof deleteEntitySave;
|
|
3671
3744
|
declare const generated_deleteSession: typeof deleteSession;
|
|
3745
|
+
declare const generated_deleteShowcaseValue: typeof deleteShowcaseValue;
|
|
3672
3746
|
declare const generated_executeEntityRecipe: typeof executeEntityRecipe;
|
|
3673
3747
|
declare const generated_finalizeSaveUpload: typeof finalizeSaveUpload;
|
|
3748
|
+
declare const generated_getChannelAssignment: typeof getChannelAssignment;
|
|
3674
3749
|
declare const generated_getDropRates: typeof getDropRates;
|
|
3675
3750
|
declare const generated_getEntityCurrency: typeof getEntityCurrency;
|
|
3676
3751
|
declare const generated_getEntityGameSetting: typeof getEntityGameSetting;
|
|
@@ -3685,9 +3760,11 @@ declare const generated_getEntitySave: typeof getEntitySave;
|
|
|
3685
3760
|
declare const generated_getEvent: typeof getEvent;
|
|
3686
3761
|
declare const generated_getGameRoomV2: typeof getGameRoomV2;
|
|
3687
3762
|
declare const generated_getLeaderboard: typeof getLeaderboard;
|
|
3763
|
+
declare const generated_getPlayerGameProfile: typeof getPlayerGameProfile;
|
|
3688
3764
|
declare const generated_getPurchaseCatalog: typeof getPurchaseCatalog;
|
|
3689
3765
|
declare const generated_getResolvedTemplate: typeof getResolvedTemplate;
|
|
3690
3766
|
declare const generated_getRoomArgs: typeof getRoomArgs;
|
|
3767
|
+
declare const generated_getShowcaseValue: typeof getShowcaseValue;
|
|
3691
3768
|
declare const generated_getTransferDetails: typeof getTransferDetails;
|
|
3692
3769
|
declare const generated_ingestAnalyticsEvents: typeof ingestAnalyticsEvents;
|
|
3693
3770
|
declare const generated_initiateInventoryTransfer: typeof initiateInventoryTransfer;
|
|
@@ -3702,8 +3779,10 @@ declare const generated_listEvents: typeof listEvents;
|
|
|
3702
3779
|
declare const generated_listGameRooms: typeof listGameRooms;
|
|
3703
3780
|
declare const generated_listResolvedTemplates: typeof listResolvedTemplates;
|
|
3704
3781
|
declare const generated_listTransfers: typeof listTransfers;
|
|
3782
|
+
declare const generated_maxEntityProgression: typeof maxEntityProgression;
|
|
3705
3783
|
declare const generated_putEntityGameSetting: typeof putEntityGameSetting;
|
|
3706
3784
|
declare const generated_putRoomArgs: typeof putRoomArgs;
|
|
3785
|
+
declare const generated_putShowcaseValue: typeof putShowcaseValue;
|
|
3707
3786
|
declare const generated_rejectTransfer: typeof rejectTransfer;
|
|
3708
3787
|
declare const generated_requestSaveUploadUrl: typeof requestSaveUploadUrl;
|
|
3709
3788
|
declare const generated_resetEntityProgression: typeof resetEntityProgression;
|
|
@@ -3711,13 +3790,21 @@ declare const generated_simulateEntityOrder: typeof simulateEntityOrder;
|
|
|
3711
3790
|
declare const generated_transferHostV2: typeof transferHostV2;
|
|
3712
3791
|
declare const generated_updateGameRoomV2: typeof updateGameRoomV2;
|
|
3713
3792
|
declare namespace generated {
|
|
3714
|
-
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 generated_AnalyticsRejection 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 };
|
|
3793
|
+
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 generated_AnalyticsRejection 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 };
|
|
3715
3794
|
}
|
|
3716
3795
|
interface ServerAnalytics {
|
|
3717
3796
|
track(playerId: string, name: string, props?: Readonly<Record<string, AnalyticsValue>>): void;
|
|
3718
3797
|
flush(signal?: AbortSignal): Promise<AnalyticsFlushResult>;
|
|
3719
3798
|
readonly pending: number;
|
|
3720
3799
|
}
|
|
3800
|
+
interface ServerListChallengesOptions {
|
|
3801
|
+
readonly playerId: string;
|
|
3802
|
+
readonly periodsBack?: number;
|
|
3803
|
+
readonly signal?: AbortSignal;
|
|
3804
|
+
}
|
|
3805
|
+
interface ServerChallenges {
|
|
3806
|
+
list(options: ServerListChallengesOptions): Promise<Challenge[]>;
|
|
3807
|
+
}
|
|
3721
3808
|
interface GemServerOptions {
|
|
3722
3809
|
readonly baseUrl?: string;
|
|
3723
3810
|
readonly clock?: Clock;
|
|
@@ -3742,6 +3829,7 @@ interface GemServer {
|
|
|
3742
3829
|
};
|
|
3743
3830
|
readonly analytics: ServerAnalytics;
|
|
3744
3831
|
readonly functions: FunctionsApi;
|
|
3832
|
+
readonly challenges: ServerChallenges;
|
|
3745
3833
|
readonly room?: {
|
|
3746
3834
|
get: (options?: Parameters<ServerApi["getGameRoomV2"]>[1]) => ReturnType<ServerApi["getGameRoomV2"]>;
|
|
3747
3835
|
args: (options?: Parameters<ServerApi["getRoomArgs"]>[1]) => ReturnType<ServerApi["getRoomArgs"]>;
|
|
@@ -4141,4 +4229,4 @@ interface ExitAnalytics {
|
|
|
4141
4229
|
}
|
|
4142
4230
|
declare function leaveAndExit(rooms: ExitRooms, bridge: ExitBridge | null, reason?: string, analytics?: ExitAnalytics): Promise<void>;
|
|
4143
4231
|
declare function createGem(options?: GemOptions): Gem;
|
|
4144
|
-
export { ARCADE_EMBEDDERS, type AccountApi, type AdFormat, type AdOutcome, type AdOutcomeKind, type AdRequest, type AdsApi, AnalyticsApi, type AnalyticsFlushOptions, type AnalyticsFlushResult, type AnalyticsOptions, type AnalyticsRejection$1 as AnalyticsRejection, type AnalyticsValue, AuthError, type AuthFailure, type AuthState, type Base64String, type BootMark, type BootTimeline, type BroadcastOptions, type BytesResponse, CONDITIONAL_HEADERS, type Challenge, type ChallengeWindow, ChallengesApi, type ClientOptions, type Clock, type ConditionalRequestHeaders, type ConfiguredPurchasePayment, type ConfiguredPurchaseRequest, type ConfiguredPurchaseResult, DEVICE_SETTINGS_MAX_BYTES, DedicatedServerError, type DedicatedServerFailure, type DedicatedServerSession, type DevToolsOpener, type DeviceSettings, type DeviceSettingsApi, type DeviceSettingsPutOutcome, type DirectPurchaseRequest, type DirectPurchaseResult, type EntityLeaderboard, type EntityLeaderboardEntry, type EntityLeaderboardOptions, type EntityType$1 as EntityType, type ExitAnalytics, type ExitBridge, type ExitRooms, type FrameState, type Friend, FriendsApi, type FriendsPage, type FunctionFailure, type FunctionInvokeOptions, type FunctionResult, FunctionsApi, type GameApi, type GameConfig, type GameServerLink, type Gem, GemApiError, GemClient, type GemCohort, type GemCohorts, GemConfigError, type GemDevTools, type GemErrorReason, GemFrame, GemFunctionError, type GemIdentity, type GemInsets, type GemMatchApi, type GemMatchServer, type GemMatchServerModule, type GemOptions, type GemPlayer, type GemPrefs, GemSaveError, type GemServer, type GemServerBundle, type GemServerFactory, type GemServerHost, type GemServerHostProfile, type GemServerIdentity, type GemServerLifecycle, type GemServerOptions, type GemServerProfile, type GemTerminationNotice, type GemViewport, type GetLeaderboardOptions, type HostTokenSource, type HostTokenSourceOptions, type JoinWelcome, type Leaderboard, type LeaderboardEntry, LeaderboardsApi, type ListChallengesOptions, type ListFriendsOptions, MAX_PERIODS_BACK, type MatchConnectOptions, type MatchConnection, type MatchHosting, type MatchHostingMode, type MatchServeOptions, type MatchTransport, type MessageMeta, type MultiTransportSession, PLATFORM_EVENTS, PlatformApi, PlatformCurrenciesApi, type PlatformCurrency, type PlatformCurrencyAccess, type PlatformCurrencyPurchasePayment, type PlatformCurrencyPurchaseRequest, type PlatformCurrencyPurchaseResult, type PlatformCurrencyReadOptions, type PlatformEventName, type PlayerBadge$1 as PlayerBadge, type PlayerBoost, type PlayerBoostMultiplier, type PlayerIdentity, type PlayerProfile, PlayerText, type ProfileCallOptions, type ProfileShowcaseEntry, ProfilesApi, type PurchaseApi, type PurchaseOptions, type PurchaseOutcome, PurchaseRefusal, type PurchaseRefusalCode, type PurchaseRequest, type PutBytesOptions, type PutSaveOptions, type RankedRow, type RecipeAvailability, type RecipeLock, type RequestOptions, type RewardCue, type RoomArgValue, type SavePage, type SaveRecord, type SendOptions$1 as SendOptions, type ServerApi, type ServerBundleHost, type ServerTokenGrant, type SessionEndReason, ShowcaseApi, type ShowcaseCallOptions, type ShowcaseFriendEntry, type ShowcaseFriends, type ShowcaseValue, type SignInOutcome, type SignInOutcomeKind, type SnapshotCurrency, type SnapshotItem, type TokenGrant, type Transport, type TransportAdvert, type TransportKind, TransportRefusal, type TransportRequest, type TransportResponse, UNRELIABLE_CHANNEL_LABEL, type VersionedGetOptions, type VersionedResponse, asPlayerText, createBootTimeline, createGem, createGemServer, createHostTokenSource, createMatchServer, defineServer, leaveAndExit, mapIdentity, markOnResolve, platformIconUrl, presentJoinCredential, readTemplateTransports, readTransportAdvert, reportOnResolve, systemClock, text, toBase64, webTransportAvailable };
|
|
4232
|
+
export { ARCADE_EMBEDDERS, type AccountApi, type AdFormat, type AdOutcome, type AdOutcomeKind, type AdRequest, type AdsApi, AnalyticsApi, type AnalyticsFlushOptions, type AnalyticsFlushResult, type AnalyticsOptions, type AnalyticsRejection$1 as AnalyticsRejection, type AnalyticsValue, AuthError, type AuthFailure, type AuthState, type Base64String, type BootMark, type BootTimeline, type BroadcastOptions, type BytesResponse, CONDITIONAL_HEADERS, type Challenge, type ChallengeWindow, ChallengesApi, type ClientOptions, type Clock, type ConditionalRequestHeaders, type ConfiguredPurchasePayment, type ConfiguredPurchaseRequest, type ConfiguredPurchaseResult, DEVICE_SETTINGS_MAX_BYTES, DedicatedServerError, type DedicatedServerFailure, type DedicatedServerSession, type DevToolsOpener, type DeviceSettings, type DeviceSettingsApi, type DeviceSettingsPutOutcome, type DirectPurchaseRequest, type DirectPurchaseResult, type EntityLeaderboard, type EntityLeaderboardEntry, type EntityLeaderboardOptions, type EntityType$1 as EntityType, type ExitAnalytics, type ExitBridge, type ExitRooms, type FrameState, type Friend, FriendsApi, type FriendsPage, type FunctionFailure, type FunctionInvokeOptions, type FunctionResult, FunctionsApi, type GameApi, type GameConfig, type GameServerLink, type Gem, GemApiError, GemClient, type GemCohort, type GemCohorts, GemConfigError, type GemDevTools, type GemErrorReason, GemFrame, GemFunctionError, type GemIdentity, type GemInsets, type GemMatchApi, type GemMatchServer, type GemMatchServerModule, type GemOptions, type GemPlayer, type GemPrefs, GemSaveError, type GemServer, type GemServerBundle, type GemServerFactory, type GemServerHost, type GemServerHostProfile, type GemServerIdentity, type GemServerLifecycle, type GemServerOptions, type GemServerProfile, type GemTerminationNotice, type GemViewport, type GetLeaderboardOptions, type HostTokenSource, type HostTokenSourceOptions, type JoinWelcome, type Leaderboard, type LeaderboardEntry, LeaderboardsApi, type ListChallengesOptions, type ListFriendsOptions, MAX_PERIODS_BACK, type MatchConnectOptions, type MatchConnection, type MatchHosting, type MatchHostingMode, type MatchServeOptions, type MatchTransport, type MessageMeta, type MultiTransportSession, PLATFORM_EVENTS, PlatformApi, PlatformCurrenciesApi, type PlatformCurrency, type PlatformCurrencyAccess, type PlatformCurrencyPurchasePayment, type PlatformCurrencyPurchaseRequest, type PlatformCurrencyPurchaseResult, type PlatformCurrencyReadOptions, type PlatformEventName, type PlayerBadge$1 as PlayerBadge, type PlayerBoost, type PlayerBoostMultiplier, type PlayerIdentity, type PlayerProfile, PlayerText, type ProfileCallOptions, type ProfileShowcaseEntry$1 as ProfileShowcaseEntry, ProfilesApi, type PurchaseApi, type PurchaseOptions, type PurchaseOutcome, PurchaseRefusal, type PurchaseRefusalCode, type PurchaseRequest, type PutBytesOptions, type PutSaveOptions, type RankedRow, type RecipeAvailability, type RecipeLock, type RequestOptions, type RewardCue, type RoomArgValue, type SavePage, type SaveRecord, type SendOptions$1 as SendOptions, type ServerApi, type ServerBundleHost, type ServerTokenGrant, type SessionEndReason, ShowcaseApi, type ShowcaseCallOptions, type ShowcaseFriendEntry, type ShowcaseFriends, type ShowcaseValue, type SignInOutcome, type SignInOutcomeKind, type SnapshotCurrency, type SnapshotItem, type TokenGrant, type Transport, type TransportAdvert, type TransportKind, TransportRefusal, type TransportRequest, type TransportResponse, UNRELIABLE_CHANNEL_LABEL, type VersionedGetOptions, type VersionedResponse, asPlayerText, createBootTimeline, createGem, createGemServer, createHostTokenSource, createMatchServer, defineServer, leaveAndExit, mapIdentity, markOnResolve, platformIconUrl, presentJoinCredential, readTemplateTransports, readTransportAdvert, reportOnResolve, systemClock, text, toBase64, webTransportAvailable };
|
package/dist/server-api.d.ts
CHANGED
|
@@ -199,6 +199,15 @@ type ChallengePeriodResponse = {
|
|
|
199
199
|
"window": WindowKind;
|
|
200
200
|
};
|
|
201
201
|
type ClientPlatform = "universal" | "mobile" | "web";
|
|
202
|
+
type ConfigChannelAssignmentResponse = {
|
|
203
|
+
"assigned_at": string;
|
|
204
|
+
"assigned_by": string;
|
|
205
|
+
"channel": GameChannel;
|
|
206
|
+
"config_url"?: string | null;
|
|
207
|
+
"config_version": number;
|
|
208
|
+
"content_hash"?: string | null;
|
|
209
|
+
"published_at"?: string | null;
|
|
210
|
+
};
|
|
202
211
|
type CreateOrderRequest = {
|
|
203
212
|
"channel"?: null | GameChannel;
|
|
204
213
|
"game_id"?: string | null;
|
|
@@ -686,6 +695,11 @@ type PlayerBadge = {
|
|
|
686
695
|
"item_id": string;
|
|
687
696
|
"kind": BadgeKind;
|
|
688
697
|
};
|
|
698
|
+
type PlayerGameProfileResponse = SubjectIdentityFields & {
|
|
699
|
+
"achievement_score"?: number | null;
|
|
700
|
+
"generated_at": number;
|
|
701
|
+
"showcase": ProfileShowcaseEntry[];
|
|
702
|
+
};
|
|
689
703
|
type PlayerIdentityFields = {
|
|
690
704
|
"avatar_icon_id"?: string | null;
|
|
691
705
|
"avatar_icon_url"?: string | null;
|
|
@@ -706,6 +720,12 @@ type PlayerTitle = {
|
|
|
706
720
|
"text": string;
|
|
707
721
|
};
|
|
708
722
|
type PrerequisiteType = "owns_item" | "progression_complete" | "min_progression_value" | "progression_level";
|
|
723
|
+
type ProfileShowcaseEntry = {
|
|
724
|
+
"key": string;
|
|
725
|
+
"updated_at": number;
|
|
726
|
+
"value": unknown;
|
|
727
|
+
"visibility": string;
|
|
728
|
+
};
|
|
709
729
|
type ProgressionAchievementState = {
|
|
710
730
|
"hidden": boolean;
|
|
711
731
|
"id": string;
|
|
@@ -724,6 +744,10 @@ type ProgressionClaimRequest = {
|
|
|
724
744
|
"reason"?: string | null;
|
|
725
745
|
"track_id"?: string | null;
|
|
726
746
|
};
|
|
747
|
+
type ProgressionMaxRequest = {
|
|
748
|
+
"reason"?: string | null;
|
|
749
|
+
"value": number;
|
|
750
|
+
};
|
|
727
751
|
type ProgressionResetRequest = {
|
|
728
752
|
"reason"?: string | null;
|
|
729
753
|
};
|
|
@@ -751,6 +775,9 @@ type PurchaseCatalogResponse = {
|
|
|
751
775
|
type PutSettingRequest = {
|
|
752
776
|
"value": Base64String;
|
|
753
777
|
};
|
|
778
|
+
type PutShowcaseRequest = {
|
|
779
|
+
"value": unknown;
|
|
780
|
+
};
|
|
754
781
|
type ReceiptPrincipal = "function";
|
|
755
782
|
type RecipeAvailabilityResponse = {
|
|
756
783
|
"can_execute": boolean;
|
|
@@ -854,6 +881,12 @@ type SettingResponse = {
|
|
|
854
881
|
type SettingsListResponse = {
|
|
855
882
|
"settings": SettingResponse[];
|
|
856
883
|
};
|
|
884
|
+
type ShowcaseValueResponse = {
|
|
885
|
+
"key": string;
|
|
886
|
+
"player_id": string;
|
|
887
|
+
"updated_at": number;
|
|
888
|
+
"value": unknown;
|
|
889
|
+
};
|
|
857
890
|
type SimulateOrderRequest = {
|
|
858
891
|
"inventory": SuppliedInventory;
|
|
859
892
|
"order": CreateOrderRequest;
|
|
@@ -886,6 +919,20 @@ type SimulationOverrides = {
|
|
|
886
919
|
"progressions"?: ProgressionStateOverride[];
|
|
887
920
|
};
|
|
888
921
|
type SlugOrId = string;
|
|
922
|
+
type SubjectIdentityFields = {
|
|
923
|
+
"avatar_icon_id"?: string | null;
|
|
924
|
+
"avatar_icon_url"?: string | null;
|
|
925
|
+
"badges": PlayerBadge[];
|
|
926
|
+
"discriminator"?: string | null;
|
|
927
|
+
"display_name"?: string | null;
|
|
928
|
+
"display_tag"?: string | null;
|
|
929
|
+
"name_animation"?: null | NameStyle;
|
|
930
|
+
"name_color"?: null | NameStyle;
|
|
931
|
+
"player_id": string;
|
|
932
|
+
"title"?: null | PlayerTitle;
|
|
933
|
+
"title_animation"?: null | NameStyle;
|
|
934
|
+
"title_color"?: null | NameStyle;
|
|
935
|
+
};
|
|
889
936
|
type SuppliedBucketRow = {
|
|
890
937
|
"balance": number;
|
|
891
938
|
"bucket": string;
|
|
@@ -1072,6 +1119,9 @@ declare function deleteEntitySave(api: GameApi, entity_type: string, entity_id:
|
|
|
1072
1119
|
declare function deleteSession(api: GameApi, session_id: string, options?: {
|
|
1073
1120
|
signal?: AbortSignal;
|
|
1074
1121
|
}): Promise<void>;
|
|
1122
|
+
declare function deleteShowcaseValue(api: GameApi, player_id: string, key: string, options?: {
|
|
1123
|
+
signal?: AbortSignal;
|
|
1124
|
+
}): Promise<void>;
|
|
1075
1125
|
declare function executeEntityRecipe(api: GameApi, entity_type: string, entity_id: string, body: RecipeExecuteRequest, options?: {
|
|
1076
1126
|
ifMatch?: string;
|
|
1077
1127
|
signal?: AbortSignal;
|
|
@@ -1079,6 +1129,10 @@ declare function executeEntityRecipe(api: GameApi, entity_type: string, entity_i
|
|
|
1079
1129
|
declare function finalizeSaveUpload(api: GameApi, entity_type: string, entity_id: string, key: string, body: SaveFinalizeRequest, options?: {
|
|
1080
1130
|
signal?: AbortSignal;
|
|
1081
1131
|
}): Promise<SaveDataResponse>;
|
|
1132
|
+
declare function getChannelAssignment(api: GameApi, channel: GameChannel, options?: {
|
|
1133
|
+
ifNoneMatch?: string;
|
|
1134
|
+
signal?: AbortSignal;
|
|
1135
|
+
}): Promise<VersionedResponse<ConfigChannelAssignmentResponse>>;
|
|
1082
1136
|
declare function getDropRates(api: GameApi, loot_table_id: SlugOrId, options?: {
|
|
1083
1137
|
signal?: AbortSignal;
|
|
1084
1138
|
}): Promise<DropRatesResponse>;
|
|
@@ -1138,6 +1192,9 @@ declare function getLeaderboard(api: GameApi, leaderboard_type: string, options?
|
|
|
1138
1192
|
"bucket_2"?: string | null;
|
|
1139
1193
|
signal?: AbortSignal;
|
|
1140
1194
|
}): Promise<LeaderboardResponse>;
|
|
1195
|
+
declare function getPlayerGameProfile(api: GameApi, player_id: string, options?: {
|
|
1196
|
+
signal?: AbortSignal;
|
|
1197
|
+
}): Promise<PlayerGameProfileResponse>;
|
|
1141
1198
|
declare function getPurchaseCatalog(api: GameApi, options?: {
|
|
1142
1199
|
"config_version"?: number | null;
|
|
1143
1200
|
signal?: AbortSignal;
|
|
@@ -1148,6 +1205,9 @@ declare function getResolvedTemplate(api: GameApi, template_id: string, options?
|
|
|
1148
1205
|
declare function getRoomArgs(api: GameApi, game_room_id: string, options?: {
|
|
1149
1206
|
signal?: AbortSignal;
|
|
1150
1207
|
}): Promise<RoomArgsResponse>;
|
|
1208
|
+
declare function getShowcaseValue(api: GameApi, player_id: string, key: string, options?: {
|
|
1209
|
+
signal?: AbortSignal;
|
|
1210
|
+
}): Promise<ShowcaseValueResponse>;
|
|
1151
1211
|
declare function getTransferDetails(api: GameApi, transfer_id: string, options?: {
|
|
1152
1212
|
signal?: AbortSignal;
|
|
1153
1213
|
}): Promise<TransferResponse>;
|
|
@@ -1212,6 +1272,9 @@ declare function listTransfers(api: GameApi, options: {
|
|
|
1212
1272
|
"limit"?: number;
|
|
1213
1273
|
signal?: AbortSignal;
|
|
1214
1274
|
}): Promise<ListTransfersResponse>;
|
|
1275
|
+
declare function maxEntityProgression(api: GameApi, entity_type: string, entity_id: string, progression_definition_id: SlugOrId, body: ProgressionMaxRequest, options?: {
|
|
1276
|
+
signal?: AbortSignal;
|
|
1277
|
+
}): Promise<OrderResponse>;
|
|
1215
1278
|
declare function putEntityGameSetting(api: GameApi, entity_type: string, entity_id: string, key: string, body: PutSettingRequest, options?: {
|
|
1216
1279
|
ifMatch?: string;
|
|
1217
1280
|
signal?: AbortSignal;
|
|
@@ -1219,6 +1282,9 @@ declare function putEntityGameSetting(api: GameApi, entity_type: string, entity_
|
|
|
1219
1282
|
declare function putRoomArgs(api: GameApi, game_room_id: string, body: UpdateRoomArgsRequest, options?: {
|
|
1220
1283
|
signal?: AbortSignal;
|
|
1221
1284
|
}): Promise<RoomArgsResponse>;
|
|
1285
|
+
declare function putShowcaseValue(api: GameApi, player_id: string, key: string, body: PutShowcaseRequest, options?: {
|
|
1286
|
+
signal?: AbortSignal;
|
|
1287
|
+
}): Promise<ShowcaseValueResponse>;
|
|
1222
1288
|
declare function rejectTransfer(api: GameApi, transfer_id: string, options?: {
|
|
1223
1289
|
signal?: AbortSignal;
|
|
1224
1290
|
}): Promise<TransferResponse>;
|
|
@@ -1238,4 +1304,4 @@ declare function updateGameRoomV2(api: GameApi, game_room_id: string, body: Upda
|
|
|
1238
1304
|
ifMatch?: string;
|
|
1239
1305
|
signal?: AbortSignal;
|
|
1240
1306
|
}): Promise<GameRoomResponseV2>;
|
|
1241
|
-
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 };
|
|
1307
|
+
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 ConfigChannelAssignmentResponse, 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 PlayerGameProfileResponse, type PlayerIdentityFields, type PlayerTitle, type PrerequisiteType, type ProfileShowcaseEntry, type ProgressionAchievementState, type ProgressionAddRequest, type ProgressionClaimRequest, type ProgressionMaxRequest, type ProgressionResetRequest, type ProgressionStateOverride, type ProgressionStateResponse, type PurchaseCatalogResponse, type PutSettingRequest, type PutShowcaseRequest, 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 ShowcaseValueResponse, type SimulateOrderRequest, type SimulateOrderResponse, type SimulationFailure, type SimulationOutcome, type SimulationOverrides, type SlugOrId, type SubjectIdentityFields, 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, deleteShowcaseValue, executeEntityRecipe, finalizeSaveUpload, getChannelAssignment, getDropRates, getEntityCurrency, getEntityGameSetting, getEntityInventory, getEntityInventoryItem, getEntityLeaderboard, getEntityOrder, getEntityProgression, getEntityRecipeAvailability, getEntityRecipeUsage, getEntitySave, getEvent, getGameRoomV2, getLeaderboard, getPlayerGameProfile, getPurchaseCatalog, getResolvedTemplate, getRoomArgs, getShowcaseValue, getTransferDetails, ingestAnalyticsEvents, initiateInventoryTransfer, invokeFunction, kickPlayer, listChallenges, listEntityGameSettings, listEntityOrders, listEntityProgressions, listEntitySaves, listEvents, listGameRooms, listResolvedTemplates, listTransfers, maxEntityProgression, putEntityGameSetting, putRoomArgs, putShowcaseValue, rejectTransfer, requestSaveUploadUrl, resetEntityProgression, simulateEntityOrder, transferHostV2, updateGameRoomV2 };
|