@indiegems/gem-web-sdk 6.0.0 → 7.1.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/brand/ticket-hero-128.png +0 -0
- package/brand/ticket-hero-256.png +0 -0
- package/brand/ticket-hero-384.png +0 -0
- package/brand/ticket-hero-512.png +0 -0
- package/brand/ticket-hero-768.png +0 -0
- package/brand/ticket-icon-20-1.5x.png +0 -0
- package/brand/ticket-icon-20-1x.png +0 -0
- package/brand/ticket-icon-20-2x.png +0 -0
- package/brand/ticket-icon-20-3x.png +0 -0
- package/brand/ticket-icon-32-1.5x.png +0 -0
- package/brand/ticket-icon-32-1x.png +0 -0
- package/brand/ticket-icon-32-2x.png +0 -0
- package/brand/ticket-icon-32-3x.png +0 -0
- package/dist/game.d.ts +87 -2
- package/dist/gem-web-sdk.bridge.js +1 -1
- 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 +37 -0
- package/dist/sdk.d.ts +309 -54
- package/dist/server-api.d.ts +195 -42
- package/dist/server.d.ts +250 -45
- package/package.json +1 -1
- package/schema/bridge.v1.json +87 -2
package/dist/server-api.d.ts
CHANGED
|
@@ -12,6 +12,8 @@ interface TransportRequest {
|
|
|
12
12
|
readonly method: "GET" | "PUT" | "POST" | "PATCH" | "DELETE";
|
|
13
13
|
readonly path: string;
|
|
14
14
|
readonly body?: unknown;
|
|
15
|
+
readonly bytes?: Uint8Array;
|
|
16
|
+
readonly responseType?: "json" | "bytes";
|
|
15
17
|
readonly headers?: ConditionalRequestHeaders;
|
|
16
18
|
readonly signal?: AbortSignal;
|
|
17
19
|
readonly keepalive?: boolean;
|
|
@@ -21,6 +23,7 @@ interface TransportResponse {
|
|
|
21
23
|
readonly body: unknown;
|
|
22
24
|
readonly etag?: string;
|
|
23
25
|
readonly retryAfterSeconds?: number;
|
|
26
|
+
readonly invocationId?: string;
|
|
24
27
|
}
|
|
25
28
|
interface Transport {
|
|
26
29
|
request(request: TransportRequest): Promise<TransportResponse>;
|
|
@@ -50,6 +53,10 @@ type VersionedResponse<T> = {
|
|
|
50
53
|
readonly modified: false;
|
|
51
54
|
readonly etag?: string;
|
|
52
55
|
};
|
|
56
|
+
interface BytesResponse {
|
|
57
|
+
readonly bytes: Uint8Array;
|
|
58
|
+
readonly invocationId?: string;
|
|
59
|
+
}
|
|
53
60
|
declare class GemClient {
|
|
54
61
|
private readonly options;
|
|
55
62
|
constructor(options: ClientOptions);
|
|
@@ -57,6 +64,7 @@ declare class GemClient {
|
|
|
57
64
|
getWithEtag<T>(path: string, options?: VersionedGetOptions): Promise<VersionedResponse<T>>;
|
|
58
65
|
put<T>(path: string, body: unknown, signal?: AbortSignal, options?: RequestOptions): Promise<T>;
|
|
59
66
|
post<T>(path: string, body: unknown, signal?: AbortSignal, options?: RequestOptions): Promise<T>;
|
|
67
|
+
postBytes(path: string, bytes: Uint8Array, signal?: AbortSignal, options?: RequestOptions): Promise<BytesResponse>;
|
|
60
68
|
patch<T>(path: string, body: unknown, signal?: AbortSignal, options?: RequestOptions): Promise<T>;
|
|
61
69
|
delete<T>(path: string, signal?: AbortSignal, options?: RequestOptions): Promise<T>;
|
|
62
70
|
private send;
|
|
@@ -67,6 +75,7 @@ interface GameApi {
|
|
|
67
75
|
readonly client: GemClient;
|
|
68
76
|
gameId(): string;
|
|
69
77
|
}
|
|
78
|
+
type AchievementUnlockOutcome = "unlocked" | "already_unlocked" | "suppressed";
|
|
70
79
|
type ActiveWindowResponse = {
|
|
71
80
|
"ends_at": string;
|
|
72
81
|
"window_id": string;
|
|
@@ -92,6 +101,29 @@ type AdminActionRequest = {
|
|
|
92
101
|
"hearing_radius"?: number | null;
|
|
93
102
|
"max_voices"?: number | null;
|
|
94
103
|
};
|
|
104
|
+
type AnalyticsBatchRequest = {
|
|
105
|
+
"batch_id": string;
|
|
106
|
+
"events": AnalyticsEventSubmission[];
|
|
107
|
+
"sent_at_ms": number;
|
|
108
|
+
};
|
|
109
|
+
type AnalyticsBatchResponse = {
|
|
110
|
+
"accepted": number;
|
|
111
|
+
"duplicate"?: boolean;
|
|
112
|
+
"rejected"?: AnalyticsRejection[];
|
|
113
|
+
};
|
|
114
|
+
type AnalyticsEventSubmission = {
|
|
115
|
+
"dimensions"?: Record<string, unknown>;
|
|
116
|
+
"event_uid": string;
|
|
117
|
+
"measures"?: Record<string, unknown>;
|
|
118
|
+
"name": string;
|
|
119
|
+
"offset_ms": number;
|
|
120
|
+
"player_id"?: string | null;
|
|
121
|
+
};
|
|
122
|
+
type AnalyticsRejection = {
|
|
123
|
+
"code": string;
|
|
124
|
+
"index": number;
|
|
125
|
+
};
|
|
126
|
+
type BadgeKind = "platform" | "game";
|
|
95
127
|
type BatchOrderItem = {
|
|
96
128
|
"nonce"?: string | null;
|
|
97
129
|
"operations": OperationRequest[];
|
|
@@ -118,27 +150,51 @@ type BatchOrderResponse = {
|
|
|
118
150
|
type BucketBalanceResponse = {
|
|
119
151
|
"balance": number;
|
|
120
152
|
"bucket": string;
|
|
153
|
+
"last_reset_at"?: number | null;
|
|
154
|
+
"next_reset_at"?: number | null;
|
|
121
155
|
};
|
|
122
156
|
type CatalogItem = {
|
|
157
|
+
"category"?: ItemCategory;
|
|
123
158
|
"consumable": boolean;
|
|
124
159
|
"display_name"?: string | null;
|
|
125
160
|
"fungible": boolean;
|
|
126
161
|
"icon_url"?: string | null;
|
|
127
162
|
"item_id": string;
|
|
128
|
-
"platform_prices":
|
|
163
|
+
"platform_prices": CatalogPrice[];
|
|
129
164
|
"stack_size"?: number | null;
|
|
130
165
|
};
|
|
166
|
+
type CatalogPrice = {
|
|
167
|
+
"platform_currency_id": string;
|
|
168
|
+
"price": number;
|
|
169
|
+
"unconfirmed_spend": boolean;
|
|
170
|
+
};
|
|
131
171
|
type CatalogRecipe = {
|
|
132
172
|
"availability_end"?: string | null;
|
|
133
173
|
"availability_start"?: string | null;
|
|
134
174
|
"catalog_id": string;
|
|
135
175
|
"cooldown_seconds"?: number | null;
|
|
136
176
|
"display_name"?: string | null;
|
|
177
|
+
"lock_reasons"?: RecipeLockReason[] | null;
|
|
178
|
+
"locked"?: boolean | null;
|
|
137
179
|
"max_uses"?: number | null;
|
|
138
|
-
"platform_prices":
|
|
180
|
+
"platform_prices": CatalogPrice[];
|
|
181
|
+
"prerequisites"?: RecipePrerequisite[];
|
|
139
182
|
"recipe_id": string;
|
|
140
183
|
"recipe_type": string;
|
|
141
184
|
};
|
|
185
|
+
type ChallengeListResponse = {
|
|
186
|
+
"challenges": ChallengePeriodResponse[];
|
|
187
|
+
};
|
|
188
|
+
type ChallengePeriodResponse = {
|
|
189
|
+
"challenge_data"?: string | null;
|
|
190
|
+
"challenge_data_hash"?: string | null;
|
|
191
|
+
"period_ends_at": string;
|
|
192
|
+
"period_start_at": string;
|
|
193
|
+
"progression_definition_id": string;
|
|
194
|
+
"seed": string;
|
|
195
|
+
"slug"?: string | null;
|
|
196
|
+
"window": WindowKind;
|
|
197
|
+
};
|
|
142
198
|
type ClientPlatform = "universal" | "mobile" | "web";
|
|
143
199
|
type CreateOrderRequest = {
|
|
144
200
|
"channel"?: null | GameChannel;
|
|
@@ -188,7 +244,7 @@ type EntityLeaderboardEntryResponse = {
|
|
|
188
244
|
"rank": number;
|
|
189
245
|
"stats"?: Record<string, unknown> | null;
|
|
190
246
|
};
|
|
191
|
-
type EntityLeaderboardResponse = {
|
|
247
|
+
type EntityLeaderboardResponse = PlayerIdentityFields & {
|
|
192
248
|
"bucket_1"?: string | null;
|
|
193
249
|
"bucket_2"?: string | null;
|
|
194
250
|
"entity_id": string;
|
|
@@ -240,19 +296,15 @@ type FidelityReport = {
|
|
|
240
296
|
"defaults_applied": string[];
|
|
241
297
|
};
|
|
242
298
|
type GameChannel = "dev" | "test" | "release";
|
|
243
|
-
type GameRoomMemberResponseV2 = {
|
|
244
|
-
"avatar_icon_id"?: string | null;
|
|
245
|
-
"discriminator"?: string | null;
|
|
246
|
-
"display_name"?: string | null;
|
|
247
|
-
"display_tag"?: string | null;
|
|
299
|
+
type GameRoomMemberResponseV2 = PlayerIdentityFields & {
|
|
248
300
|
"group_id"?: string | null;
|
|
249
301
|
"is_ready": boolean;
|
|
250
302
|
"joined_at": number;
|
|
251
303
|
"platform"?: null | ClientPlatform;
|
|
252
|
-
"player_id": string;
|
|
253
304
|
"role": string;
|
|
254
305
|
};
|
|
255
306
|
type GameRoomResponseV2 = {
|
|
307
|
+
"cluster_target_id"?: string | null;
|
|
256
308
|
"created_at": number;
|
|
257
309
|
"game_channel": string;
|
|
258
310
|
"game_id": string;
|
|
@@ -266,7 +318,6 @@ type GameRoomResponseV2 = {
|
|
|
266
318
|
"member_count": number;
|
|
267
319
|
"members": GameRoomMemberResponseV2[];
|
|
268
320
|
"name": string;
|
|
269
|
-
"region"?: string | null;
|
|
270
321
|
"room_args"?: Record<string, unknown> | null;
|
|
271
322
|
"room_args_template"?: null | RoomArgsTemplate;
|
|
272
323
|
"settings"?: unknown;
|
|
@@ -279,6 +330,7 @@ type GameRoomResponseV2 = {
|
|
|
279
330
|
"version": number;
|
|
280
331
|
};
|
|
281
332
|
type GameRoomSummaryResponse = {
|
|
333
|
+
"cluster_target_id"?: string | null;
|
|
282
334
|
"created_at": number;
|
|
283
335
|
"game_channel": string;
|
|
284
336
|
"game_id": string;
|
|
@@ -381,16 +433,27 @@ type InventoryChange = {
|
|
|
381
433
|
"granted": number;
|
|
382
434
|
"mapping_index": number;
|
|
383
435
|
"outcome": PlatformGrantOutcome;
|
|
436
|
+
"platform_order_id"?: string | null;
|
|
437
|
+
"principal"?: null | ReceiptPrincipal;
|
|
384
438
|
"progression_definition_id": string;
|
|
385
439
|
"reason"?: string | null;
|
|
386
440
|
"requested": number;
|
|
387
441
|
"target_currency_id": string;
|
|
388
442
|
"type": "platform_grant";
|
|
443
|
+
} | {
|
|
444
|
+
"achievement_id": string;
|
|
445
|
+
"outcome": AchievementUnlockOutcome;
|
|
446
|
+
"points": number;
|
|
447
|
+
"principal"?: null | ReceiptPrincipal;
|
|
448
|
+
"progression_definition_id": string;
|
|
449
|
+
"reason"?: string | null;
|
|
450
|
+
"type": "achievement_unlocked";
|
|
389
451
|
} | {
|
|
390
452
|
"balance_after": number;
|
|
391
453
|
"balance_before": number;
|
|
392
454
|
"bucket": string;
|
|
393
455
|
"currency_id": string;
|
|
456
|
+
"synthesized"?: boolean;
|
|
394
457
|
"type": "currency_bucket_reset";
|
|
395
458
|
} | {
|
|
396
459
|
"progression_definition_id": string;
|
|
@@ -406,6 +469,7 @@ type InventoryResponse = {
|
|
|
406
469
|
"entity_id": string;
|
|
407
470
|
"etag": string;
|
|
408
471
|
"items": PaginatedCollectionItemInstanceResponse;
|
|
472
|
+
"period_progress": PeriodProgressResponse[];
|
|
409
473
|
"progressions": PaginatedCollectionProgressionStateResponse;
|
|
410
474
|
"scope": InventoryScopeResponse;
|
|
411
475
|
};
|
|
@@ -416,6 +480,7 @@ type InventoryScopeResponse = {
|
|
|
416
480
|
"game_id": string;
|
|
417
481
|
"type": "game";
|
|
418
482
|
};
|
|
483
|
+
type ItemCategory = "cosmetic" | "progression";
|
|
419
484
|
type ItemInstanceResponse = {
|
|
420
485
|
"acquired_at": number;
|
|
421
486
|
"custom_data"?: unknown;
|
|
@@ -424,10 +489,7 @@ type ItemInstanceResponse = {
|
|
|
424
489
|
"properties": unknown;
|
|
425
490
|
"quantity": number;
|
|
426
491
|
};
|
|
427
|
-
type LeaderboardEntryResponse = {
|
|
428
|
-
"discriminator"?: string | null;
|
|
429
|
-
"display_name"?: string | null;
|
|
430
|
-
"display_tag"?: string | null;
|
|
492
|
+
type LeaderboardEntryResponse = PlayerIdentityFields & {
|
|
431
493
|
"entity_id"?: string | null;
|
|
432
494
|
"entity_type"?: null | EntityType;
|
|
433
495
|
"is_viewer"?: boolean;
|
|
@@ -457,6 +519,11 @@ type LootRollResultResponse = {
|
|
|
457
519
|
"was_replacement": boolean;
|
|
458
520
|
};
|
|
459
521
|
type MatchType = "dedicated" | "p2p" | "none";
|
|
522
|
+
type NameStyle = {
|
|
523
|
+
"fallback"?: null | ThemedColors;
|
|
524
|
+
"item_id": string;
|
|
525
|
+
"preset": string;
|
|
526
|
+
};
|
|
460
527
|
type OperationRequest = {
|
|
461
528
|
"amount": number;
|
|
462
529
|
"bucket"?: string | null;
|
|
@@ -571,10 +638,13 @@ type PaginatedCollectionItemInstanceResponse = {
|
|
|
571
638
|
};
|
|
572
639
|
type PaginatedCollectionProgressionStateResponse = {
|
|
573
640
|
"data": {
|
|
641
|
+
"achievements"?: ProgressionAchievementState[];
|
|
642
|
+
"achievements_unavailable"?: boolean;
|
|
574
643
|
"completion_count": number;
|
|
575
644
|
"current_value": number;
|
|
576
645
|
"is_completed": boolean;
|
|
577
646
|
"progression_definition_id": string;
|
|
647
|
+
"updated_at": number;
|
|
578
648
|
}[];
|
|
579
649
|
"has_more": boolean;
|
|
580
650
|
"next_cursor"?: string | null;
|
|
@@ -594,8 +664,50 @@ type PaginatedResponseSaveDataResponse = {
|
|
|
594
664
|
"has_more": boolean;
|
|
595
665
|
"next_cursor"?: string | null;
|
|
596
666
|
};
|
|
597
|
-
type
|
|
667
|
+
type PeriodProgressResponse = {
|
|
668
|
+
"completed": boolean;
|
|
669
|
+
"current_value": number;
|
|
670
|
+
"period_ends_at": number;
|
|
671
|
+
"period_start_at": number;
|
|
672
|
+
"progression_definition_id": string;
|
|
673
|
+
"target": number;
|
|
674
|
+
"window": string;
|
|
675
|
+
};
|
|
676
|
+
type PlatformGrantClamp = "none" | "max_per_event" | "game_max_per_entity" | "platform_max_per_game_per_entity" | "game_max_per_window" | "platform_max_per_window" | "max_balance" | "holdings_cap";
|
|
598
677
|
type PlatformGrantOutcome = "fired" | "clamped" | "suppressed";
|
|
678
|
+
type PlayerBadge = {
|
|
679
|
+
"icon_url": string;
|
|
680
|
+
"item_id": string;
|
|
681
|
+
"kind": BadgeKind;
|
|
682
|
+
};
|
|
683
|
+
type PlayerIdentityFields = {
|
|
684
|
+
"avatar_icon_id"?: string | null;
|
|
685
|
+
"avatar_icon_url"?: string | null;
|
|
686
|
+
"badges"?: PlayerBadge[];
|
|
687
|
+
"discriminator"?: string | null;
|
|
688
|
+
"display_name"?: string | null;
|
|
689
|
+
"display_tag"?: string | null;
|
|
690
|
+
"name_animation"?: null | NameStyle;
|
|
691
|
+
"name_color"?: null | NameStyle;
|
|
692
|
+
"player_id"?: string;
|
|
693
|
+
"title"?: null | PlayerTitle;
|
|
694
|
+
"title_animation"?: null | NameStyle;
|
|
695
|
+
"title_color"?: null | NameStyle;
|
|
696
|
+
};
|
|
697
|
+
type PlayerTitle = {
|
|
698
|
+
"item_id": string;
|
|
699
|
+
"lang": string;
|
|
700
|
+
"text": string;
|
|
701
|
+
};
|
|
702
|
+
type PrerequisiteType = "owns_item" | "progression_complete" | "min_progression_value" | "progression_level";
|
|
703
|
+
type ProgressionAchievementState = {
|
|
704
|
+
"hidden": boolean;
|
|
705
|
+
"id": string;
|
|
706
|
+
"points": number;
|
|
707
|
+
"revoked"?: boolean;
|
|
708
|
+
"threshold": number;
|
|
709
|
+
"unlocked_at"?: number | null;
|
|
710
|
+
};
|
|
599
711
|
type ProgressionAddRequest = {
|
|
600
712
|
"amount": number;
|
|
601
713
|
"reason"?: string | null;
|
|
@@ -616,26 +728,28 @@ type ProgressionStateOverride = {
|
|
|
616
728
|
"rewards_claimed_through"?: Record<string, unknown> | null;
|
|
617
729
|
};
|
|
618
730
|
type ProgressionStateResponse = {
|
|
731
|
+
"achievements"?: ProgressionAchievementState[];
|
|
732
|
+
"achievements_unavailable"?: boolean;
|
|
619
733
|
"completion_count": number;
|
|
620
734
|
"current_value": number;
|
|
621
735
|
"is_completed": boolean;
|
|
622
736
|
"progression_definition_id": string;
|
|
737
|
+
"updated_at": number;
|
|
623
738
|
};
|
|
624
739
|
type PurchaseCatalogResponse = {
|
|
625
740
|
"config_version": number;
|
|
626
741
|
"items": CatalogItem[];
|
|
627
742
|
"recipes": CatalogRecipe[];
|
|
628
743
|
};
|
|
629
|
-
type PurchasePrice = {
|
|
630
|
-
"platform_currency_id": string;
|
|
631
|
-
"price": number;
|
|
632
|
-
};
|
|
633
744
|
type PutSettingRequest = {
|
|
634
745
|
"value": Base64String;
|
|
635
746
|
};
|
|
747
|
+
type ReceiptPrincipal = "function";
|
|
636
748
|
type RecipeAvailabilityResponse = {
|
|
637
749
|
"can_execute": boolean;
|
|
638
750
|
"cooldown_expires_at"?: string | null;
|
|
751
|
+
"lock_reasons"?: RecipeLockReason[];
|
|
752
|
+
"locked"?: boolean;
|
|
639
753
|
"reasons": UnavailabilityReason[];
|
|
640
754
|
"recipe_id": string;
|
|
641
755
|
"uses_remaining"?: number | null;
|
|
@@ -656,6 +770,17 @@ type RecipeExecuteResponse = {
|
|
|
656
770
|
"order_id": string;
|
|
657
771
|
"status": OrderStatus;
|
|
658
772
|
};
|
|
773
|
+
type RecipeLockReason = {
|
|
774
|
+
"current": number;
|
|
775
|
+
"prerequisite_type": PrerequisiteType;
|
|
776
|
+
"reference_id": string;
|
|
777
|
+
"required": number;
|
|
778
|
+
};
|
|
779
|
+
type RecipePrerequisite = {
|
|
780
|
+
"prerequisite_type": PrerequisiteType;
|
|
781
|
+
"reference_id": string;
|
|
782
|
+
"reference_value": number;
|
|
783
|
+
};
|
|
659
784
|
type RecipeUsageListResponse = {
|
|
660
785
|
"usages": RecipeUsageResponse[];
|
|
661
786
|
};
|
|
@@ -757,6 +882,8 @@ type SlugOrId = string;
|
|
|
757
882
|
type SuppliedBucketRow = {
|
|
758
883
|
"balance": number;
|
|
759
884
|
"bucket": string;
|
|
885
|
+
"last_reset_at"?: number | null;
|
|
886
|
+
"next_reset_at"?: number | null;
|
|
760
887
|
};
|
|
761
888
|
type SuppliedCurrencies = {
|
|
762
889
|
"data"?: SuppliedCurrencyRow[];
|
|
@@ -773,6 +900,7 @@ type SuppliedInventory = {
|
|
|
773
900
|
"entity_id"?: string | null;
|
|
774
901
|
"etag"?: string;
|
|
775
902
|
"items"?: SuppliedItems;
|
|
903
|
+
"period_progress"?: SuppliedPeriodProgressRow[];
|
|
776
904
|
"progressions"?: SuppliedProgressions;
|
|
777
905
|
"scope"?: null | SuppliedScope;
|
|
778
906
|
};
|
|
@@ -789,11 +917,21 @@ type SuppliedItems = {
|
|
|
789
917
|
"has_more"?: boolean;
|
|
790
918
|
"next_cursor"?: string | null;
|
|
791
919
|
};
|
|
920
|
+
type SuppliedPeriodProgressRow = {
|
|
921
|
+
"completed"?: boolean;
|
|
922
|
+
"current_value"?: number;
|
|
923
|
+
"period_ends_at": number;
|
|
924
|
+
"period_start_at": number;
|
|
925
|
+
"progression_definition_id": string;
|
|
926
|
+
"target": number;
|
|
927
|
+
"window": string;
|
|
928
|
+
};
|
|
792
929
|
type SuppliedProgressionRow = {
|
|
793
930
|
"completion_count": number;
|
|
794
931
|
"current_value": number;
|
|
795
932
|
"is_completed": boolean;
|
|
796
933
|
"progression_definition_id": string;
|
|
934
|
+
"updated_at"?: number;
|
|
797
935
|
};
|
|
798
936
|
type SuppliedProgressions = {
|
|
799
937
|
"data"?: SuppliedProgressionRow[];
|
|
@@ -807,6 +945,10 @@ type SuppliedScope = {
|
|
|
807
945
|
"game_id": string;
|
|
808
946
|
"type": "game";
|
|
809
947
|
};
|
|
948
|
+
type ThemedColors = {
|
|
949
|
+
"on_dark": string;
|
|
950
|
+
"on_light": string;
|
|
951
|
+
};
|
|
810
952
|
type TransferCurrencyRequest = {
|
|
811
953
|
"amount": number;
|
|
812
954
|
"currency_id": string;
|
|
@@ -852,8 +994,10 @@ type UnavailabilityReason = {
|
|
|
852
994
|
"max_uses": number;
|
|
853
995
|
"type": "max_uses_reached";
|
|
854
996
|
} | {
|
|
997
|
+
"current"?: number;
|
|
855
998
|
"prerequisite_type": string;
|
|
856
999
|
"reference_id": string;
|
|
1000
|
+
"required"?: number;
|
|
857
1001
|
"type": "prerequisite_not_met";
|
|
858
1002
|
} | {
|
|
859
1003
|
"available": number;
|
|
@@ -876,6 +1020,7 @@ type UpdateGameRoomRequest = {
|
|
|
876
1020
|
type UpdateRoomArgsRequest = {
|
|
877
1021
|
"room_args": Record<string, unknown>;
|
|
878
1022
|
};
|
|
1023
|
+
type WindowKind = "daily" | "weekly" | "monthly" | "cron";
|
|
879
1024
|
type WindowPreviewResponse = {
|
|
880
1025
|
"ends_at": string;
|
|
881
1026
|
"starts_at": string;
|
|
@@ -937,21 +1082,22 @@ declare function getEntityGameSetting(api: GameApi, entity_type: string, entity_
|
|
|
937
1082
|
}): Promise<VersionedResponse<SettingResponse>>;
|
|
938
1083
|
declare function getEntityInventory(api: GameApi, entity_type: string, entity_id: string, options?: {
|
|
939
1084
|
"include_buckets"?: boolean;
|
|
940
|
-
"
|
|
941
|
-
"
|
|
942
|
-
"
|
|
943
|
-
"
|
|
944
|
-
"
|
|
945
|
-
"
|
|
1085
|
+
"include_custom_data"?: boolean;
|
|
1086
|
+
"currency_limit"?: number | null;
|
|
1087
|
+
"currency_cursor"?: string | null;
|
|
1088
|
+
"item_limit"?: number | null;
|
|
1089
|
+
"item_cursor"?: string | null;
|
|
1090
|
+
"progression_limit"?: number | null;
|
|
1091
|
+
"progression_cursor"?: string | null;
|
|
946
1092
|
signal?: AbortSignal;
|
|
947
1093
|
}): Promise<InventoryResponse>;
|
|
948
1094
|
declare function getEntityInventoryItem(api: GameApi, entity_type: string, entity_id: string, item_definition_id: SlugOrId, options?: {
|
|
949
1095
|
signal?: AbortSignal;
|
|
950
1096
|
}): Promise<ItemInstanceResponse[]>;
|
|
951
1097
|
declare function getEntityLeaderboard(api: GameApi, leaderboard_type: string, entity_type: string, entity_id: string, options?: {
|
|
952
|
-
"bucket_1"?: string;
|
|
953
|
-
"bucket_2"?: string;
|
|
954
|
-
"limit"?: number;
|
|
1098
|
+
"bucket_1"?: string | null;
|
|
1099
|
+
"bucket_2"?: string | null;
|
|
1100
|
+
"limit"?: number | null;
|
|
955
1101
|
signal?: AbortSignal;
|
|
956
1102
|
}): Promise<EntityLeaderboardResponse>;
|
|
957
1103
|
declare function getEntityOrder(api: GameApi, entity_type: string, entity_id: string, order_id: string, options?: {
|
|
@@ -964,7 +1110,7 @@ declare function getEntityRecipeAvailability(api: GameApi, entity_type: string,
|
|
|
964
1110
|
signal?: AbortSignal;
|
|
965
1111
|
}): Promise<RecipeAvailabilityResponse>;
|
|
966
1112
|
declare function getEntityRecipeUsage(api: GameApi, entity_type: string, entity_id: string, options?: {
|
|
967
|
-
"limit"?: number;
|
|
1113
|
+
"limit"?: number | null;
|
|
968
1114
|
signal?: AbortSignal;
|
|
969
1115
|
}): Promise<RecipeUsageListResponse>;
|
|
970
1116
|
declare function getEntitySave(api: GameApi, entity_type: string, entity_id: string, key: string, options?: {
|
|
@@ -979,12 +1125,12 @@ declare function getGameRoomV2(api: GameApi, game_room_id: string, options?: {
|
|
|
979
1125
|
signal?: AbortSignal;
|
|
980
1126
|
}): Promise<VersionedResponse<GameRoomResponseV2>>;
|
|
981
1127
|
declare function getLeaderboard(api: GameApi, leaderboard_type: string, options?: {
|
|
982
|
-
"bucket_1"?: string;
|
|
983
|
-
"bucket_2"?: string;
|
|
1128
|
+
"bucket_1"?: string | null;
|
|
1129
|
+
"bucket_2"?: string | null;
|
|
984
1130
|
signal?: AbortSignal;
|
|
985
1131
|
}): Promise<LeaderboardResponse>;
|
|
986
1132
|
declare function getPurchaseCatalog(api: GameApi, options?: {
|
|
987
|
-
"config_version"?: number;
|
|
1133
|
+
"config_version"?: number | null;
|
|
988
1134
|
signal?: AbortSignal;
|
|
989
1135
|
}): Promise<PurchaseCatalogResponse>;
|
|
990
1136
|
declare function getResolvedTemplate(api: GameApi, template_id: string, options?: {
|
|
@@ -996,26 +1142,36 @@ declare function getRoomArgs(api: GameApi, game_room_id: string, options?: {
|
|
|
996
1142
|
declare function getTransferDetails(api: GameApi, transfer_id: string, options?: {
|
|
997
1143
|
signal?: AbortSignal;
|
|
998
1144
|
}): Promise<TransferResponse>;
|
|
1145
|
+
declare function ingestAnalyticsEvents(api: GameApi, body: AnalyticsBatchRequest, options?: {
|
|
1146
|
+
signal?: AbortSignal;
|
|
1147
|
+
}): Promise<AnalyticsBatchResponse>;
|
|
999
1148
|
declare function initiateInventoryTransfer(api: GameApi, body: InitiateTransferRequest, options?: {
|
|
1000
1149
|
signal?: AbortSignal;
|
|
1001
1150
|
}): Promise<TransferResponse>;
|
|
1151
|
+
declare function invokeFunction(api: GameApi, body: Uint8Array, options?: {
|
|
1152
|
+
signal?: AbortSignal;
|
|
1153
|
+
}): Promise<BytesResponse>;
|
|
1002
1154
|
declare function kickPlayer(api: GameApi, game_room_id: string, player_id: string, options?: {
|
|
1003
1155
|
signal?: AbortSignal;
|
|
1004
1156
|
}): Promise<void>;
|
|
1157
|
+
declare function listChallenges(api: GameApi, options?: {
|
|
1158
|
+
"periods_back"?: number;
|
|
1159
|
+
signal?: AbortSignal;
|
|
1160
|
+
}): Promise<ChallengeListResponse>;
|
|
1005
1161
|
declare function listEntityGameSettings(api: GameApi, entity_type: string, entity_id: string, options?: {
|
|
1006
1162
|
signal?: AbortSignal;
|
|
1007
1163
|
}): Promise<SettingsListResponse>;
|
|
1008
1164
|
declare function listEntityOrders(api: GameApi, entity_type: string, entity_id: string, options?: {
|
|
1009
1165
|
"limit"?: number;
|
|
1010
|
-
"cursor"?: string;
|
|
1166
|
+
"cursor"?: string | null;
|
|
1011
1167
|
signal?: AbortSignal;
|
|
1012
1168
|
}): Promise<OrderListResponse>;
|
|
1013
1169
|
declare function listEntityProgressions(api: GameApi, entity_type: string, entity_id: string, options?: {
|
|
1014
1170
|
signal?: AbortSignal;
|
|
1015
1171
|
}): Promise<ProgressionStateResponse[]>;
|
|
1016
1172
|
declare function listEntitySaves(api: GameApi, entity_type: string, entity_id: string, options?: {
|
|
1017
|
-
"limit"?: number;
|
|
1018
|
-
"cursor"?: string;
|
|
1173
|
+
"limit"?: number | null;
|
|
1174
|
+
"cursor"?: string | null;
|
|
1019
1175
|
signal?: AbortSignal;
|
|
1020
1176
|
}): Promise<PaginatedResponseSaveDataResponse>;
|
|
1021
1177
|
declare function listEvents(api: GameApi, options?: {
|
|
@@ -1040,15 +1196,12 @@ declare function listResolvedTemplates(api: GameApi, options?: {
|
|
|
1040
1196
|
declare function listTransfers(api: GameApi, options: {
|
|
1041
1197
|
"entity_type": string;
|
|
1042
1198
|
"entity_id": string;
|
|
1043
|
-
"direction"?: string;
|
|
1044
|
-
"status"?: string;
|
|
1045
|
-
"cursor"?: string;
|
|
1199
|
+
"direction"?: string | null;
|
|
1200
|
+
"status"?: string | null;
|
|
1201
|
+
"cursor"?: string | null;
|
|
1046
1202
|
"limit"?: number;
|
|
1047
1203
|
signal?: AbortSignal;
|
|
1048
1204
|
}): Promise<ListTransfersResponse>;
|
|
1049
|
-
declare function matchEnd(api: GameApi, match_id: string, options?: {
|
|
1050
|
-
signal?: AbortSignal;
|
|
1051
|
-
}): Promise<void>;
|
|
1052
1205
|
declare function putEntityGameSetting(api: GameApi, entity_type: string, entity_id: string, key: string, body: PutSettingRequest, options?: {
|
|
1053
1206
|
ifMatch?: string;
|
|
1054
1207
|
signal?: AbortSignal;
|
|
@@ -1075,4 +1228,4 @@ declare function updateGameRoomV2(api: GameApi, game_room_id: string, body: Upda
|
|
|
1075
1228
|
ifMatch?: string;
|
|
1076
1229
|
signal?: AbortSignal;
|
|
1077
1230
|
}): Promise<GameRoomResponseV2>;
|
|
1078
|
-
export { type ActiveWindowResponse, type AdminActionRequest, type BatchOrderItem, type BatchOrderItemResult, type BatchOrderRequest, type BatchOrderResponse, type BucketBalanceResponse, type CatalogItem, type CatalogRecipe, type ClientPlatform, type CreateOrderRequest, type CreateSessionRequest, type CurrencyBalanceResponse, type CurrencyResetOverride, type DropRateEntry, type DropRatesResponse, type EntityLeaderboardEntryResponse, type EntityLeaderboardResponse, type EntityType, type ErrorDetail, type ErrorResponse, type EventDefinitionResponse, type EventListResponse, type EventStatusInfo, type FidelityReport, type GameApi, type GameChannel, type GameRoomMemberResponseV2, type GameRoomResponseV2, type GameRoomSummaryResponse, type GameRoomTemplateListResponse, type GameRoomTemplateResponse, type GameRoomsListResponse, type InitiateTransferRequest, type InventoryChange, type InventoryResponse, type InventoryScopeResponse, type ItemInstanceResponse, type LeaderboardEntryResponse, type LeaderboardResponse, type ListTransfersResponse, type LootRollResultResponse, type MatchType, type OperationRequest, type OrderListResponse, type OrderRecordResponse, type OrderResponse, type OrderSource, type OrderStatus, type OverflowBehavior, type PaginatedCollectionCurrencyBalanceResponse, type PaginatedCollectionItemInstanceResponse, type PaginatedCollectionProgressionStateResponse, type PaginatedResponseSaveDataResponse, type PlatformGrantClamp, type PlatformGrantOutcome, type ProgressionAddRequest, type ProgressionClaimRequest, type ProgressionResetRequest, type ProgressionStateOverride, type ProgressionStateResponse, type PurchaseCatalogResponse, type
|
|
1231
|
+
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 };
|