@indiegems/gem-web-sdk 5.12.0 → 7.0.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 +62 -2
- package/dist/gem-web-sdk.esm.js +2 -2
- 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/index.d.ts +10 -0
- package/dist/sdk.d.ts +172 -28
- package/dist/server-api.d.ts +105 -22
- package/dist/server.d.ts +144 -25
- package/package.json +1 -1
package/dist/server.d.ts
CHANGED
|
@@ -30,6 +30,8 @@ interface TransportRequest {
|
|
|
30
30
|
readonly method: "GET" | "PUT" | "POST" | "PATCH" | "DELETE";
|
|
31
31
|
readonly path: string;
|
|
32
32
|
readonly body?: unknown;
|
|
33
|
+
readonly bytes?: Uint8Array;
|
|
34
|
+
readonly responseType?: "json" | "bytes";
|
|
33
35
|
readonly headers?: ConditionalRequestHeaders;
|
|
34
36
|
readonly signal?: AbortSignal;
|
|
35
37
|
readonly keepalive?: boolean;
|
|
@@ -39,6 +41,7 @@ interface TransportResponse {
|
|
|
39
41
|
readonly body: unknown;
|
|
40
42
|
readonly etag?: string;
|
|
41
43
|
readonly retryAfterSeconds?: number;
|
|
44
|
+
readonly invocationId?: string;
|
|
42
45
|
}
|
|
43
46
|
interface Transport {
|
|
44
47
|
request(request: TransportRequest): Promise<TransportResponse>;
|
|
@@ -79,6 +82,10 @@ type VersionedResponse<T> = {
|
|
|
79
82
|
readonly modified: false;
|
|
80
83
|
readonly etag?: string;
|
|
81
84
|
};
|
|
85
|
+
interface BytesResponse {
|
|
86
|
+
readonly bytes: Uint8Array;
|
|
87
|
+
readonly invocationId?: string;
|
|
88
|
+
}
|
|
82
89
|
declare class GemClient {
|
|
83
90
|
private readonly options;
|
|
84
91
|
constructor(options: ClientOptions);
|
|
@@ -86,6 +93,7 @@ declare class GemClient {
|
|
|
86
93
|
getWithEtag<T>(path: string, options?: VersionedGetOptions): Promise<VersionedResponse<T>>;
|
|
87
94
|
put<T>(path: string, body: unknown, signal?: AbortSignal, options?: RequestOptions): Promise<T>;
|
|
88
95
|
post<T>(path: string, body: unknown, signal?: AbortSignal, options?: RequestOptions): Promise<T>;
|
|
96
|
+
postBytes(path: string, bytes: Uint8Array, signal?: AbortSignal, options?: RequestOptions): Promise<BytesResponse>;
|
|
89
97
|
patch<T>(path: string, body: unknown, signal?: AbortSignal, options?: RequestOptions): Promise<T>;
|
|
90
98
|
delete<T>(path: string, signal?: AbortSignal, options?: RequestOptions): Promise<T>;
|
|
91
99
|
private send;
|
|
@@ -145,6 +153,7 @@ interface GameApi {
|
|
|
145
153
|
readonly client: GemClient;
|
|
146
154
|
gameId(): string;
|
|
147
155
|
}
|
|
156
|
+
type AchievementUnlockOutcome = "unlocked" | "already_unlocked" | "suppressed";
|
|
148
157
|
type ActiveWindowResponse = {
|
|
149
158
|
"ends_at": string;
|
|
150
159
|
"window_id": string;
|
|
@@ -170,6 +179,28 @@ type AdminActionRequest = {
|
|
|
170
179
|
"hearing_radius"?: number | null;
|
|
171
180
|
"max_voices"?: number | null;
|
|
172
181
|
};
|
|
182
|
+
type AnalyticsBatchRequest = {
|
|
183
|
+
"batch_id": string;
|
|
184
|
+
"events": AnalyticsEventSubmission[];
|
|
185
|
+
"sent_at_ms": number;
|
|
186
|
+
};
|
|
187
|
+
type AnalyticsBatchResponse = {
|
|
188
|
+
"accepted": number;
|
|
189
|
+
"duplicate"?: boolean;
|
|
190
|
+
"rejected"?: AnalyticsRejection$1[];
|
|
191
|
+
};
|
|
192
|
+
type AnalyticsEventSubmission = {
|
|
193
|
+
"dimensions"?: Record<string, unknown>;
|
|
194
|
+
"event_uid": string;
|
|
195
|
+
"measures"?: Record<string, unknown>;
|
|
196
|
+
"name": string;
|
|
197
|
+
"offset_ms": number;
|
|
198
|
+
"player_id"?: string | null;
|
|
199
|
+
};
|
|
200
|
+
type AnalyticsRejection$1 = {
|
|
201
|
+
"code": string;
|
|
202
|
+
"index": number;
|
|
203
|
+
};
|
|
173
204
|
type BatchOrderItem = {
|
|
174
205
|
"nonce"?: string | null;
|
|
175
206
|
"operations": OperationRequest[];
|
|
@@ -196,6 +227,8 @@ type BatchOrderResponse = {
|
|
|
196
227
|
type BucketBalanceResponse = {
|
|
197
228
|
"balance": number;
|
|
198
229
|
"bucket": string;
|
|
230
|
+
"last_reset_at"?: number | null;
|
|
231
|
+
"next_reset_at"?: number | null;
|
|
199
232
|
};
|
|
200
233
|
type CatalogItem = {
|
|
201
234
|
"consumable": boolean;
|
|
@@ -203,9 +236,14 @@ type CatalogItem = {
|
|
|
203
236
|
"fungible": boolean;
|
|
204
237
|
"icon_url"?: string | null;
|
|
205
238
|
"item_id": string;
|
|
206
|
-
"platform_prices":
|
|
239
|
+
"platform_prices": CatalogPrice[];
|
|
207
240
|
"stack_size"?: number | null;
|
|
208
241
|
};
|
|
242
|
+
type CatalogPrice = {
|
|
243
|
+
"platform_currency_id": string;
|
|
244
|
+
"price": number;
|
|
245
|
+
"unconfirmed_spend": boolean;
|
|
246
|
+
};
|
|
209
247
|
type CatalogRecipe = {
|
|
210
248
|
"availability_end"?: string | null;
|
|
211
249
|
"availability_start"?: string | null;
|
|
@@ -213,7 +251,7 @@ type CatalogRecipe = {
|
|
|
213
251
|
"cooldown_seconds"?: number | null;
|
|
214
252
|
"display_name"?: string | null;
|
|
215
253
|
"max_uses"?: number | null;
|
|
216
|
-
"platform_prices":
|
|
254
|
+
"platform_prices": CatalogPrice[];
|
|
217
255
|
"recipe_id": string;
|
|
218
256
|
"recipe_type": string;
|
|
219
257
|
};
|
|
@@ -331,6 +369,7 @@ type GameRoomMemberResponseV2 = {
|
|
|
331
369
|
"role": string;
|
|
332
370
|
};
|
|
333
371
|
type GameRoomResponseV2 = {
|
|
372
|
+
"cluster_target_id"?: string | null;
|
|
334
373
|
"created_at": number;
|
|
335
374
|
"game_channel": string;
|
|
336
375
|
"game_id": string;
|
|
@@ -344,7 +383,6 @@ type GameRoomResponseV2 = {
|
|
|
344
383
|
"member_count": number;
|
|
345
384
|
"members": GameRoomMemberResponseV2[];
|
|
346
385
|
"name": string;
|
|
347
|
-
"region"?: string | null;
|
|
348
386
|
"room_args"?: Record<string, unknown> | null;
|
|
349
387
|
"room_args_template"?: null | RoomArgsTemplate;
|
|
350
388
|
"settings"?: unknown;
|
|
@@ -357,6 +395,7 @@ type GameRoomResponseV2 = {
|
|
|
357
395
|
"version": number;
|
|
358
396
|
};
|
|
359
397
|
type GameRoomSummaryResponse = {
|
|
398
|
+
"cluster_target_id"?: string | null;
|
|
360
399
|
"created_at": number;
|
|
361
400
|
"game_channel": string;
|
|
362
401
|
"game_id": string;
|
|
@@ -459,16 +498,25 @@ type InventoryChange = {
|
|
|
459
498
|
"granted": number;
|
|
460
499
|
"mapping_index": number;
|
|
461
500
|
"outcome": PlatformGrantOutcome;
|
|
501
|
+
"platform_order_id"?: string | null;
|
|
462
502
|
"progression_definition_id": string;
|
|
463
503
|
"reason"?: string | null;
|
|
464
504
|
"requested": number;
|
|
465
505
|
"target_currency_id": string;
|
|
466
506
|
"type": "platform_grant";
|
|
507
|
+
} | {
|
|
508
|
+
"achievement_id": string;
|
|
509
|
+
"outcome": AchievementUnlockOutcome;
|
|
510
|
+
"points": number;
|
|
511
|
+
"progression_definition_id": string;
|
|
512
|
+
"reason"?: string | null;
|
|
513
|
+
"type": "achievement_unlocked";
|
|
467
514
|
} | {
|
|
468
515
|
"balance_after": number;
|
|
469
516
|
"balance_before": number;
|
|
470
517
|
"bucket": string;
|
|
471
518
|
"currency_id": string;
|
|
519
|
+
"synthesized"?: boolean;
|
|
472
520
|
"type": "currency_bucket_reset";
|
|
473
521
|
} | {
|
|
474
522
|
"progression_definition_id": string;
|
|
@@ -484,6 +532,7 @@ type InventoryResponse = {
|
|
|
484
532
|
"entity_id": string;
|
|
485
533
|
"etag": string;
|
|
486
534
|
"items": PaginatedCollectionItemInstanceResponse;
|
|
535
|
+
"period_progress": PeriodProgressResponse[];
|
|
487
536
|
"progressions": PaginatedCollectionProgressionStateResponse;
|
|
488
537
|
"scope": InventoryScopeResponse;
|
|
489
538
|
};
|
|
@@ -503,6 +552,7 @@ type ItemInstanceResponse = {
|
|
|
503
552
|
"quantity": number;
|
|
504
553
|
};
|
|
505
554
|
type LeaderboardEntryResponse = {
|
|
555
|
+
"avatar_icon_url"?: string | null;
|
|
506
556
|
"discriminator"?: string | null;
|
|
507
557
|
"display_name"?: string | null;
|
|
508
558
|
"display_tag"?: string | null;
|
|
@@ -649,10 +699,13 @@ type PaginatedCollectionItemInstanceResponse = {
|
|
|
649
699
|
};
|
|
650
700
|
type PaginatedCollectionProgressionStateResponse = {
|
|
651
701
|
"data": {
|
|
702
|
+
"achievements"?: ProgressionAchievementState[];
|
|
703
|
+
"achievements_unavailable"?: boolean;
|
|
652
704
|
"completion_count": number;
|
|
653
705
|
"current_value": number;
|
|
654
706
|
"is_completed": boolean;
|
|
655
707
|
"progression_definition_id": string;
|
|
708
|
+
"updated_at": number;
|
|
656
709
|
}[];
|
|
657
710
|
"has_more": boolean;
|
|
658
711
|
"next_cursor"?: string | null;
|
|
@@ -672,8 +725,25 @@ type PaginatedResponseSaveDataResponse = {
|
|
|
672
725
|
"has_more": boolean;
|
|
673
726
|
"next_cursor"?: string | null;
|
|
674
727
|
};
|
|
675
|
-
type
|
|
728
|
+
type PeriodProgressResponse = {
|
|
729
|
+
"completed": boolean;
|
|
730
|
+
"current_value": number;
|
|
731
|
+
"period_ends_at": number;
|
|
732
|
+
"period_start_at": number;
|
|
733
|
+
"progression_definition_id": string;
|
|
734
|
+
"target": number;
|
|
735
|
+
"window": string;
|
|
736
|
+
};
|
|
737
|
+
type PlatformGrantClamp = "none" | "max_per_event" | "game_max_per_entity" | "platform_max_per_game_per_entity" | "game_max_per_window" | "platform_max_per_window" | "max_balance";
|
|
676
738
|
type PlatformGrantOutcome = "fired" | "clamped" | "suppressed";
|
|
739
|
+
type ProgressionAchievementState = {
|
|
740
|
+
"hidden": boolean;
|
|
741
|
+
"id": string;
|
|
742
|
+
"points": number;
|
|
743
|
+
"revoked"?: boolean;
|
|
744
|
+
"threshold": number;
|
|
745
|
+
"unlocked_at"?: number | null;
|
|
746
|
+
};
|
|
677
747
|
type ProgressionAddRequest = {
|
|
678
748
|
"amount": number;
|
|
679
749
|
"reason"?: string | null;
|
|
@@ -694,20 +764,19 @@ type ProgressionStateOverride = {
|
|
|
694
764
|
"rewards_claimed_through"?: Record<string, unknown> | null;
|
|
695
765
|
};
|
|
696
766
|
type ProgressionStateResponse = {
|
|
767
|
+
"achievements"?: ProgressionAchievementState[];
|
|
768
|
+
"achievements_unavailable"?: boolean;
|
|
697
769
|
"completion_count": number;
|
|
698
770
|
"current_value": number;
|
|
699
771
|
"is_completed": boolean;
|
|
700
772
|
"progression_definition_id": string;
|
|
773
|
+
"updated_at": number;
|
|
701
774
|
};
|
|
702
775
|
type PurchaseCatalogResponse = {
|
|
703
776
|
"config_version": number;
|
|
704
777
|
"items": CatalogItem[];
|
|
705
778
|
"recipes": CatalogRecipe[];
|
|
706
779
|
};
|
|
707
|
-
type PurchasePrice = {
|
|
708
|
-
"platform_currency_id": string;
|
|
709
|
-
"price": number;
|
|
710
|
-
};
|
|
711
780
|
type PutSettingRequest = {
|
|
712
781
|
"value": Base64String;
|
|
713
782
|
};
|
|
@@ -835,6 +904,8 @@ type SlugOrId = string;
|
|
|
835
904
|
type SuppliedBucketRow = {
|
|
836
905
|
"balance": number;
|
|
837
906
|
"bucket": string;
|
|
907
|
+
"last_reset_at"?: number | null;
|
|
908
|
+
"next_reset_at"?: number | null;
|
|
838
909
|
};
|
|
839
910
|
type SuppliedCurrencies = {
|
|
840
911
|
"data"?: SuppliedCurrencyRow[];
|
|
@@ -851,6 +922,7 @@ type SuppliedInventory = {
|
|
|
851
922
|
"entity_id"?: string | null;
|
|
852
923
|
"etag"?: string;
|
|
853
924
|
"items"?: SuppliedItems;
|
|
925
|
+
"period_progress"?: SuppliedPeriodProgressRow[];
|
|
854
926
|
"progressions"?: SuppliedProgressions;
|
|
855
927
|
"scope"?: null | SuppliedScope;
|
|
856
928
|
};
|
|
@@ -867,11 +939,21 @@ type SuppliedItems = {
|
|
|
867
939
|
"has_more"?: boolean;
|
|
868
940
|
"next_cursor"?: string | null;
|
|
869
941
|
};
|
|
942
|
+
type SuppliedPeriodProgressRow = {
|
|
943
|
+
"completed"?: boolean;
|
|
944
|
+
"current_value"?: number;
|
|
945
|
+
"period_ends_at": number;
|
|
946
|
+
"period_start_at": number;
|
|
947
|
+
"progression_definition_id": string;
|
|
948
|
+
"target": number;
|
|
949
|
+
"window": string;
|
|
950
|
+
};
|
|
870
951
|
type SuppliedProgressionRow = {
|
|
871
952
|
"completion_count": number;
|
|
872
953
|
"current_value": number;
|
|
873
954
|
"is_completed": boolean;
|
|
874
955
|
"progression_definition_id": string;
|
|
956
|
+
"updated_at"?: number;
|
|
875
957
|
};
|
|
876
958
|
type SuppliedProgressions = {
|
|
877
959
|
"data"?: SuppliedProgressionRow[];
|
|
@@ -1015,12 +1097,13 @@ declare function getEntityGameSetting(api: GameApi, entity_type: string, entity_
|
|
|
1015
1097
|
}): Promise<VersionedResponse<SettingResponse>>;
|
|
1016
1098
|
declare function getEntityInventory(api: GameApi, entity_type: string, entity_id: string, options?: {
|
|
1017
1099
|
"include_buckets"?: boolean;
|
|
1018
|
-
"
|
|
1019
|
-
"
|
|
1020
|
-
"
|
|
1021
|
-
"
|
|
1022
|
-
"
|
|
1023
|
-
"
|
|
1100
|
+
"include_custom_data"?: boolean;
|
|
1101
|
+
"currency_limit"?: number | null;
|
|
1102
|
+
"currency_cursor"?: string | null;
|
|
1103
|
+
"item_limit"?: number | null;
|
|
1104
|
+
"item_cursor"?: string | null;
|
|
1105
|
+
"progression_limit"?: number | null;
|
|
1106
|
+
"progression_cursor"?: string | null;
|
|
1024
1107
|
signal?: AbortSignal;
|
|
1025
1108
|
}): Promise<InventoryResponse>;
|
|
1026
1109
|
declare function getEntityInventoryItem(api: GameApi, entity_type: string, entity_id: string, item_definition_id: SlugOrId, options?: {
|
|
@@ -1042,7 +1125,7 @@ declare function getEntityRecipeAvailability(api: GameApi, entity_type: string,
|
|
|
1042
1125
|
signal?: AbortSignal;
|
|
1043
1126
|
}): Promise<RecipeAvailabilityResponse>;
|
|
1044
1127
|
declare function getEntityRecipeUsage(api: GameApi, entity_type: string, entity_id: string, options?: {
|
|
1045
|
-
"limit"?: number;
|
|
1128
|
+
"limit"?: number | null;
|
|
1046
1129
|
signal?: AbortSignal;
|
|
1047
1130
|
}): Promise<RecipeUsageListResponse>;
|
|
1048
1131
|
declare function getEntitySave(api: GameApi, entity_type: string, entity_id: string, key: string, options?: {
|
|
@@ -1074,6 +1157,9 @@ declare function getRoomArgs(api: GameApi, game_room_id: string, options?: {
|
|
|
1074
1157
|
declare function getTransferDetails(api: GameApi, transfer_id: string, options?: {
|
|
1075
1158
|
signal?: AbortSignal;
|
|
1076
1159
|
}): Promise<TransferResponse>;
|
|
1160
|
+
declare function ingestAnalyticsEvents(api: GameApi, body: AnalyticsBatchRequest, options?: {
|
|
1161
|
+
signal?: AbortSignal;
|
|
1162
|
+
}): Promise<AnalyticsBatchResponse>;
|
|
1077
1163
|
declare function initiateInventoryTransfer(api: GameApi, body: InitiateTransferRequest, options?: {
|
|
1078
1164
|
signal?: AbortSignal;
|
|
1079
1165
|
}): Promise<TransferResponse>;
|
|
@@ -1085,15 +1171,15 @@ declare function listEntityGameSettings(api: GameApi, entity_type: string, entit
|
|
|
1085
1171
|
}): Promise<SettingsListResponse>;
|
|
1086
1172
|
declare function listEntityOrders(api: GameApi, entity_type: string, entity_id: string, options?: {
|
|
1087
1173
|
"limit"?: number;
|
|
1088
|
-
"cursor"?: string;
|
|
1174
|
+
"cursor"?: string | null;
|
|
1089
1175
|
signal?: AbortSignal;
|
|
1090
1176
|
}): Promise<OrderListResponse>;
|
|
1091
1177
|
declare function listEntityProgressions(api: GameApi, entity_type: string, entity_id: string, options?: {
|
|
1092
1178
|
signal?: AbortSignal;
|
|
1093
1179
|
}): Promise<ProgressionStateResponse[]>;
|
|
1094
1180
|
declare function listEntitySaves(api: GameApi, entity_type: string, entity_id: string, options?: {
|
|
1095
|
-
"limit"?: number;
|
|
1096
|
-
"cursor"?: string;
|
|
1181
|
+
"limit"?: number | null;
|
|
1182
|
+
"cursor"?: string | null;
|
|
1097
1183
|
signal?: AbortSignal;
|
|
1098
1184
|
}): Promise<PaginatedResponseSaveDataResponse>;
|
|
1099
1185
|
declare function listEvents(api: GameApi, options?: {
|
|
@@ -1124,9 +1210,6 @@ declare function listTransfers(api: GameApi, options: {
|
|
|
1124
1210
|
"limit"?: number;
|
|
1125
1211
|
signal?: AbortSignal;
|
|
1126
1212
|
}): Promise<ListTransfersResponse>;
|
|
1127
|
-
declare function matchEnd(api: GameApi, match_id: string, options?: {
|
|
1128
|
-
signal?: AbortSignal;
|
|
1129
|
-
}): Promise<void>;
|
|
1130
1213
|
declare function putEntityGameSetting(api: GameApi, entity_type: string, entity_id: string, key: string, body: PutSettingRequest, options?: {
|
|
1131
1214
|
ifMatch?: string;
|
|
1132
1215
|
signal?: AbortSignal;
|
|
@@ -1153,14 +1236,19 @@ declare function updateGameRoomV2(api: GameApi, game_room_id: string, body: Upda
|
|
|
1153
1236
|
ifMatch?: string;
|
|
1154
1237
|
signal?: AbortSignal;
|
|
1155
1238
|
}): Promise<GameRoomResponseV2>;
|
|
1239
|
+
type generated_AchievementUnlockOutcome = AchievementUnlockOutcome;
|
|
1156
1240
|
type generated_ActiveWindowResponse = ActiveWindowResponse;
|
|
1157
1241
|
type generated_AdminActionRequest = AdminActionRequest;
|
|
1242
|
+
type generated_AnalyticsBatchRequest = AnalyticsBatchRequest;
|
|
1243
|
+
type generated_AnalyticsBatchResponse = AnalyticsBatchResponse;
|
|
1244
|
+
type generated_AnalyticsEventSubmission = AnalyticsEventSubmission;
|
|
1158
1245
|
type generated_BatchOrderItem = BatchOrderItem;
|
|
1159
1246
|
type generated_BatchOrderItemResult = BatchOrderItemResult;
|
|
1160
1247
|
type generated_BatchOrderRequest = BatchOrderRequest;
|
|
1161
1248
|
type generated_BatchOrderResponse = BatchOrderResponse;
|
|
1162
1249
|
type generated_BucketBalanceResponse = BucketBalanceResponse;
|
|
1163
1250
|
type generated_CatalogItem = CatalogItem;
|
|
1251
|
+
type generated_CatalogPrice = CatalogPrice;
|
|
1164
1252
|
type generated_CatalogRecipe = CatalogRecipe;
|
|
1165
1253
|
type generated_ClientPlatform = ClientPlatform;
|
|
1166
1254
|
type generated_CreateOrderRequest = CreateOrderRequest;
|
|
@@ -1207,15 +1295,16 @@ type generated_PaginatedCollectionCurrencyBalanceResponse = PaginatedCollectionC
|
|
|
1207
1295
|
type generated_PaginatedCollectionItemInstanceResponse = PaginatedCollectionItemInstanceResponse;
|
|
1208
1296
|
type generated_PaginatedCollectionProgressionStateResponse = PaginatedCollectionProgressionStateResponse;
|
|
1209
1297
|
type generated_PaginatedResponseSaveDataResponse = PaginatedResponseSaveDataResponse;
|
|
1298
|
+
type generated_PeriodProgressResponse = PeriodProgressResponse;
|
|
1210
1299
|
type generated_PlatformGrantClamp = PlatformGrantClamp;
|
|
1211
1300
|
type generated_PlatformGrantOutcome = PlatformGrantOutcome;
|
|
1301
|
+
type generated_ProgressionAchievementState = ProgressionAchievementState;
|
|
1212
1302
|
type generated_ProgressionAddRequest = ProgressionAddRequest;
|
|
1213
1303
|
type generated_ProgressionClaimRequest = ProgressionClaimRequest;
|
|
1214
1304
|
type generated_ProgressionResetRequest = ProgressionResetRequest;
|
|
1215
1305
|
type generated_ProgressionStateOverride = ProgressionStateOverride;
|
|
1216
1306
|
type generated_ProgressionStateResponse = ProgressionStateResponse;
|
|
1217
1307
|
type generated_PurchaseCatalogResponse = PurchaseCatalogResponse;
|
|
1218
|
-
type generated_PurchasePrice = PurchasePrice;
|
|
1219
1308
|
type generated_PutSettingRequest = PutSettingRequest;
|
|
1220
1309
|
type generated_RecipeAvailabilityResponse = RecipeAvailabilityResponse;
|
|
1221
1310
|
type generated_RecipeExecuteRequest = RecipeExecuteRequest;
|
|
@@ -1243,6 +1332,7 @@ type generated_SuppliedCurrencyRow = SuppliedCurrencyRow;
|
|
|
1243
1332
|
type generated_SuppliedInventory = SuppliedInventory;
|
|
1244
1333
|
type generated_SuppliedItemRow = SuppliedItemRow;
|
|
1245
1334
|
type generated_SuppliedItems = SuppliedItems;
|
|
1335
|
+
type generated_SuppliedPeriodProgressRow = SuppliedPeriodProgressRow;
|
|
1246
1336
|
type generated_SuppliedProgressionRow = SuppliedProgressionRow;
|
|
1247
1337
|
type generated_SuppliedProgressions = SuppliedProgressions;
|
|
1248
1338
|
type generated_SuppliedScope = SuppliedScope;
|
|
@@ -1285,6 +1375,7 @@ declare const generated_getPurchaseCatalog: typeof getPurchaseCatalog;
|
|
|
1285
1375
|
declare const generated_getResolvedTemplate: typeof getResolvedTemplate;
|
|
1286
1376
|
declare const generated_getRoomArgs: typeof getRoomArgs;
|
|
1287
1377
|
declare const generated_getTransferDetails: typeof getTransferDetails;
|
|
1378
|
+
declare const generated_ingestAnalyticsEvents: typeof ingestAnalyticsEvents;
|
|
1288
1379
|
declare const generated_initiateInventoryTransfer: typeof initiateInventoryTransfer;
|
|
1289
1380
|
declare const generated_kickPlayer: typeof kickPlayer;
|
|
1290
1381
|
declare const generated_listEntityGameSettings: typeof listEntityGameSettings;
|
|
@@ -1295,7 +1386,6 @@ declare const generated_listEvents: typeof listEvents;
|
|
|
1295
1386
|
declare const generated_listGameRooms: typeof listGameRooms;
|
|
1296
1387
|
declare const generated_listResolvedTemplates: typeof listResolvedTemplates;
|
|
1297
1388
|
declare const generated_listTransfers: typeof listTransfers;
|
|
1298
|
-
declare const generated_matchEnd: typeof matchEnd;
|
|
1299
1389
|
declare const generated_putEntityGameSetting: typeof putEntityGameSetting;
|
|
1300
1390
|
declare const generated_putRoomArgs: typeof putRoomArgs;
|
|
1301
1391
|
declare const generated_rejectTransfer: typeof rejectTransfer;
|
|
@@ -1305,7 +1395,7 @@ declare const generated_simulateEntityOrder: typeof simulateEntityOrder;
|
|
|
1305
1395
|
declare const generated_transferHostV2: typeof transferHostV2;
|
|
1306
1396
|
declare const generated_updateGameRoomV2: typeof updateGameRoomV2;
|
|
1307
1397
|
declare namespace generated {
|
|
1308
|
-
export { type generated_ActiveWindowResponse as ActiveWindowResponse, type generated_AdminActionRequest as AdminActionRequest, 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_CatalogRecipe as CatalogRecipe, type generated_ClientPlatform as ClientPlatform, type generated_CreateOrderRequest as CreateOrderRequest, type generated_CreateSessionRequest as CreateSessionRequest, type generated_CurrencyBalanceResponse as CurrencyBalanceResponse, type generated_CurrencyResetOverride as CurrencyResetOverride, type generated_DropRateEntry as DropRateEntry, type generated_DropRatesResponse as DropRatesResponse, type generated_EntityLeaderboardEntryResponse as EntityLeaderboardEntryResponse, type generated_EntityLeaderboardResponse as EntityLeaderboardResponse, type generated_EntityType as EntityType, type generated_ErrorDetail as ErrorDetail, type generated_ErrorResponse as ErrorResponse, type generated_EventDefinitionResponse as EventDefinitionResponse, type generated_EventListResponse as EventListResponse, type generated_EventStatusInfo as EventStatusInfo, type generated_FidelityReport as FidelityReport, type generated_GameApi as GameApi, type generated_GameChannel as GameChannel, type generated_GameRoomMemberResponseV2 as GameRoomMemberResponseV2, type generated_GameRoomResponseV2 as GameRoomResponseV2, type generated_GameRoomSummaryResponse as GameRoomSummaryResponse, type generated_GameRoomTemplateListResponse as GameRoomTemplateListResponse, type generated_GameRoomTemplateResponse as GameRoomTemplateResponse, type generated_GameRoomsListResponse as GameRoomsListResponse, type generated_InitiateTransferRequest as InitiateTransferRequest, type generated_InventoryChange as InventoryChange, type generated_InventoryResponse as InventoryResponse, type generated_InventoryScopeResponse as InventoryScopeResponse, type generated_ItemInstanceResponse as ItemInstanceResponse, type generated_LeaderboardEntryResponse as LeaderboardEntryResponse, type generated_LeaderboardResponse as LeaderboardResponse, type generated_ListTransfersResponse as ListTransfersResponse, type generated_LootRollResultResponse as LootRollResultResponse, type generated_MatchType as MatchType, type generated_OperationRequest as OperationRequest, type generated_OrderListResponse as OrderListResponse, type generated_OrderRecordResponse as OrderRecordResponse, type generated_OrderResponse as OrderResponse, type generated_OrderSource as OrderSource, type generated_OrderStatus as OrderStatus, type generated_OverflowBehavior as OverflowBehavior, type generated_PaginatedCollectionCurrencyBalanceResponse as PaginatedCollectionCurrencyBalanceResponse, type generated_PaginatedCollectionItemInstanceResponse as PaginatedCollectionItemInstanceResponse, type generated_PaginatedCollectionProgressionStateResponse as PaginatedCollectionProgressionStateResponse, type generated_PaginatedResponseSaveDataResponse as PaginatedResponseSaveDataResponse, type generated_PlatformGrantClamp as PlatformGrantClamp, type generated_PlatformGrantOutcome as PlatformGrantOutcome, 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
|
|
1398
|
+
export { type generated_AchievementUnlockOutcome as AchievementUnlockOutcome, type generated_ActiveWindowResponse as ActiveWindowResponse, type generated_AdminActionRequest as AdminActionRequest, type generated_AnalyticsBatchRequest as AnalyticsBatchRequest, type generated_AnalyticsBatchResponse as AnalyticsBatchResponse, type generated_AnalyticsEventSubmission as AnalyticsEventSubmission, type AnalyticsRejection$1 as AnalyticsRejection, type generated_BatchOrderItem as BatchOrderItem, type generated_BatchOrderItemResult as BatchOrderItemResult, type generated_BatchOrderRequest as BatchOrderRequest, type generated_BatchOrderResponse as BatchOrderResponse, type generated_BucketBalanceResponse as BucketBalanceResponse, type generated_CatalogItem as CatalogItem, type generated_CatalogPrice as CatalogPrice, type generated_CatalogRecipe as CatalogRecipe, type generated_ClientPlatform as ClientPlatform, type generated_CreateOrderRequest as CreateOrderRequest, type generated_CreateSessionRequest as CreateSessionRequest, type generated_CurrencyBalanceResponse as CurrencyBalanceResponse, type generated_CurrencyResetOverride as CurrencyResetOverride, type generated_DropRateEntry as DropRateEntry, type generated_DropRatesResponse as DropRatesResponse, type generated_EntityLeaderboardEntryResponse as EntityLeaderboardEntryResponse, type generated_EntityLeaderboardResponse as EntityLeaderboardResponse, type generated_EntityType as EntityType, type generated_ErrorDetail as ErrorDetail, type generated_ErrorResponse as ErrorResponse, type generated_EventDefinitionResponse as EventDefinitionResponse, type generated_EventListResponse as EventListResponse, type generated_EventStatusInfo as EventStatusInfo, type generated_FidelityReport as FidelityReport, type generated_GameApi as GameApi, type generated_GameChannel as GameChannel, type generated_GameRoomMemberResponseV2 as GameRoomMemberResponseV2, type generated_GameRoomResponseV2 as GameRoomResponseV2, type generated_GameRoomSummaryResponse as GameRoomSummaryResponse, type generated_GameRoomTemplateListResponse as GameRoomTemplateListResponse, type generated_GameRoomTemplateResponse as GameRoomTemplateResponse, type generated_GameRoomsListResponse as GameRoomsListResponse, type generated_InitiateTransferRequest as InitiateTransferRequest, type generated_InventoryChange as InventoryChange, type generated_InventoryResponse as InventoryResponse, type generated_InventoryScopeResponse as InventoryScopeResponse, type generated_ItemInstanceResponse as ItemInstanceResponse, type generated_LeaderboardEntryResponse as LeaderboardEntryResponse, type generated_LeaderboardResponse as LeaderboardResponse, type generated_ListTransfersResponse as ListTransfersResponse, type generated_LootRollResultResponse as LootRollResultResponse, type generated_MatchType as MatchType, type generated_OperationRequest as OperationRequest, type generated_OrderListResponse as OrderListResponse, type generated_OrderRecordResponse as OrderRecordResponse, type generated_OrderResponse as OrderResponse, type generated_OrderSource as OrderSource, type generated_OrderStatus as OrderStatus, type generated_OverflowBehavior as OverflowBehavior, type generated_PaginatedCollectionCurrencyBalanceResponse as PaginatedCollectionCurrencyBalanceResponse, type generated_PaginatedCollectionItemInstanceResponse as PaginatedCollectionItemInstanceResponse, type generated_PaginatedCollectionProgressionStateResponse as PaginatedCollectionProgressionStateResponse, type generated_PaginatedResponseSaveDataResponse as PaginatedResponseSaveDataResponse, type generated_PeriodProgressResponse as PeriodProgressResponse, type generated_PlatformGrantClamp as PlatformGrantClamp, type generated_PlatformGrantOutcome as PlatformGrantOutcome, type generated_ProgressionAchievementState as ProgressionAchievementState, type generated_ProgressionAddRequest as ProgressionAddRequest, type generated_ProgressionClaimRequest as ProgressionClaimRequest, type generated_ProgressionResetRequest as ProgressionResetRequest, type generated_ProgressionStateOverride as ProgressionStateOverride, type generated_ProgressionStateResponse as ProgressionStateResponse, type generated_PurchaseCatalogResponse as PurchaseCatalogResponse, type generated_PutSettingRequest as PutSettingRequest, type generated_RecipeAvailabilityResponse as RecipeAvailabilityResponse, type generated_RecipeExecuteRequest as RecipeExecuteRequest, type generated_RecipeExecuteResponse as RecipeExecuteResponse, type generated_RecipeUsageListResponse as RecipeUsageListResponse, type generated_RecipeUsageResponse as RecipeUsageResponse, type generated_RoomArgType as RoomArgType, type generated_RoomArgsResponse as RoomArgsResponse, type generated_RoomArgsTemplate as RoomArgsTemplate, type generated_SaveDataResponse as SaveDataResponse, type generated_SaveFinalizeRequest as SaveFinalizeRequest, type generated_SaveUploadUrlRequest as SaveUploadUrlRequest, type generated_SaveUploadUrlResponse as SaveUploadUrlResponse, type generated_SettingResponse as SettingResponse, type generated_SettingsListResponse as SettingsListResponse, type generated_SimulateOrderRequest as SimulateOrderRequest, type generated_SimulateOrderResponse as SimulateOrderResponse, type generated_SimulationFailure as SimulationFailure, type generated_SimulationOutcome as SimulationOutcome, type generated_SimulationOverrides as SimulationOverrides, type generated_SlugOrId as SlugOrId, type generated_SuppliedBucketRow as SuppliedBucketRow, type generated_SuppliedCurrencies as SuppliedCurrencies, type generated_SuppliedCurrencyRow as SuppliedCurrencyRow, type generated_SuppliedInventory as SuppliedInventory, type generated_SuppliedItemRow as SuppliedItemRow, type generated_SuppliedItems as SuppliedItems, type generated_SuppliedPeriodProgressRow as SuppliedPeriodProgressRow, type generated_SuppliedProgressionRow as SuppliedProgressionRow, type generated_SuppliedProgressions as SuppliedProgressions, type generated_SuppliedScope as SuppliedScope, type generated_TransferCurrencyRequest as TransferCurrencyRequest, type generated_TransferItemRequest as TransferItemRequest, type generated_TransferResponse as TransferResponse, type generated_UnavailabilityReason as UnavailabilityReason, type generated_UpdateGameRoomRequest as UpdateGameRoomRequest, type generated_UpdateRoomArgsRequest as UpdateRoomArgsRequest, type generated_WindowPreviewResponse as WindowPreviewResponse, generated_acceptTransfer as acceptTransfer, generated_addEntityProgression as addEntityProgression, generated_adminAction as adminAction, generated_cancelInventoryTransfer as cancelInventoryTransfer, generated_claimEntityProgressionRewards as claimEntityProgressionRewards, generated_closeGameRoom as closeGameRoom, generated_createEntityBatchOrder as createEntityBatchOrder, generated_createEntityOrder as createEntityOrder, generated_createSession as createSession, generated_deleteEntityGameSetting as deleteEntityGameSetting, generated_deleteEntitySave as deleteEntitySave, generated_deleteSession as deleteSession, generated_executeEntityRecipe as executeEntityRecipe, generated_finalizeSaveUpload as finalizeSaveUpload, generated_getDropRates as getDropRates, generated_getEntityCurrency as getEntityCurrency, generated_getEntityGameSetting as getEntityGameSetting, generated_getEntityInventory as getEntityInventory, generated_getEntityInventoryItem as getEntityInventoryItem, generated_getEntityLeaderboard as getEntityLeaderboard, generated_getEntityOrder as getEntityOrder, generated_getEntityProgression as getEntityProgression, generated_getEntityRecipeAvailability as getEntityRecipeAvailability, generated_getEntityRecipeUsage as getEntityRecipeUsage, generated_getEntitySave as getEntitySave, generated_getEvent as getEvent, generated_getGameRoomV2 as getGameRoomV2, generated_getLeaderboard as getLeaderboard, generated_getPurchaseCatalog as getPurchaseCatalog, generated_getResolvedTemplate as getResolvedTemplate, generated_getRoomArgs as getRoomArgs, generated_getTransferDetails as getTransferDetails, generated_ingestAnalyticsEvents as ingestAnalyticsEvents, generated_initiateInventoryTransfer as initiateInventoryTransfer, generated_kickPlayer as kickPlayer, generated_listEntityGameSettings as listEntityGameSettings, generated_listEntityOrders as listEntityOrders, generated_listEntityProgressions as listEntityProgressions, generated_listEntitySaves as listEntitySaves, generated_listEvents as listEvents, generated_listGameRooms as listGameRooms, generated_listResolvedTemplates as listResolvedTemplates, generated_listTransfers as listTransfers, generated_putEntityGameSetting as putEntityGameSetting, generated_putRoomArgs as putRoomArgs, generated_rejectTransfer as rejectTransfer, generated_requestSaveUploadUrl as requestSaveUploadUrl, generated_resetEntityProgression as resetEntityProgression, generated_simulateEntityOrder as simulateEntityOrder, generated_transferHostV2 as transferHostV2, generated_updateGameRoomV2 as updateGameRoomV2 };
|
|
1309
1399
|
}
|
|
1310
1400
|
type AnalyticsValue = string | number;
|
|
1311
1401
|
interface AnalyticsRejection {
|
|
@@ -1323,6 +1413,34 @@ interface ServerAnalytics {
|
|
|
1323
1413
|
flush(signal?: AbortSignal): Promise<AnalyticsFlushResult>;
|
|
1324
1414
|
readonly pending: number;
|
|
1325
1415
|
}
|
|
1416
|
+
interface FunctionInvokeOptions {
|
|
1417
|
+
readonly signal?: AbortSignal;
|
|
1418
|
+
}
|
|
1419
|
+
interface FunctionResult {
|
|
1420
|
+
readonly bytes: Uint8Array;
|
|
1421
|
+
readonly invocationId?: string;
|
|
1422
|
+
text(): string;
|
|
1423
|
+
json<T = unknown>(): T;
|
|
1424
|
+
}
|
|
1425
|
+
type FunctionFailure = "trap" | "memory_exceeded" | "cpu_budget_exceeded" | "host_call_limit";
|
|
1426
|
+
declare class GemFunctionError extends GemApiError {
|
|
1427
|
+
readonly invocationId?: string;
|
|
1428
|
+
readonly functionMessage?: string;
|
|
1429
|
+
readonly failure?: FunctionFailure | (string & {});
|
|
1430
|
+
constructor(source: GemApiError, extra: {
|
|
1431
|
+
readonly invocationId?: string;
|
|
1432
|
+
readonly functionMessage?: string;
|
|
1433
|
+
readonly failure?: string;
|
|
1434
|
+
});
|
|
1435
|
+
get retryable(): boolean;
|
|
1436
|
+
}
|
|
1437
|
+
declare class FunctionsApi {
|
|
1438
|
+
#private;
|
|
1439
|
+
constructor(invoke: (body: Uint8Array, options?: {
|
|
1440
|
+
signal?: AbortSignal;
|
|
1441
|
+
}) => Promise<BytesResponse>);
|
|
1442
|
+
invoke(input: unknown, options?: FunctionInvokeOptions): Promise<FunctionResult>;
|
|
1443
|
+
}
|
|
1326
1444
|
interface GemServerOptions {
|
|
1327
1445
|
readonly baseUrl?: string;
|
|
1328
1446
|
readonly clock?: Clock;
|
|
@@ -1346,6 +1464,7 @@ interface GemServer {
|
|
|
1346
1464
|
end(signal?: AbortSignal): Promise<void>;
|
|
1347
1465
|
};
|
|
1348
1466
|
readonly analytics: ServerAnalytics;
|
|
1467
|
+
readonly functions: FunctionsApi;
|
|
1349
1468
|
readonly room?: {
|
|
1350
1469
|
get: (options?: Parameters<ServerApi["getGameRoomV2"]>[1]) => ReturnType<ServerApi["getGameRoomV2"]>;
|
|
1351
1470
|
args: (options?: Parameters<ServerApi["getRoomArgs"]>[1]) => ReturnType<ServerApi["getRoomArgs"]>;
|
|
@@ -1443,4 +1562,4 @@ interface AchievementReceipt {
|
|
|
1443
1562
|
readonly reason?: string;
|
|
1444
1563
|
}
|
|
1445
1564
|
declare function achievementReceipts(order: unknown): AchievementReceipt[];
|
|
1446
|
-
export { type AchievementReceipt, type AnalyticsFlushResult, type AnalyticsRejection, type AnalyticsValue, AuthError, type AuthFailure, type AuthState, type Base64String, type BroadcastOptions, CONDITIONAL_HEADERS, type ClientOptions, type Clock, type ConditionalRequestHeaders, type GameApi, GemApiError, GemClient, type GemErrorReason, 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 };
|
|
1565
|
+
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 };
|