async-playfab-web-sdk 1.192.250526-3 → 1.192.250526-5
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/Addon.d.ts +179 -39
- package/dist/Addon.js +2 -2
- package/dist/Admin.d.ts +2386 -195
- package/dist/Admin.js +2 -2
- package/dist/Authentication.d.ts +32 -5
- package/dist/Authentication.js +2 -2
- package/dist/Client.d.ts +2235 -321
- package/dist/Client.js +2 -2
- package/dist/CloudScript.d.ts +199 -31
- package/dist/CloudScript.js +2 -2
- package/dist/Data.d.ts +137 -18
- package/dist/Data.js +2 -2
- package/dist/Economy.d.ts +1145 -106
- package/dist/Economy.js +2 -2
- package/dist/Events.d.ts +200 -13
- package/dist/Events.js +2 -2
- package/dist/Experimentation.d.ts +164 -17
- package/dist/Experimentation.js +2 -2
- package/dist/Groups.d.ts +267 -28
- package/dist/Groups.js +2 -2
- package/dist/Insights.d.ts +33 -7
- package/dist/Insights.js +2 -2
- package/dist/Localization.d.ts +5 -2
- package/dist/Localization.js +2 -2
- package/dist/Matchmaker.d.ts +271 -0
- package/dist/Matchmaker.js +8 -0
- package/dist/Matchmaker.js.map +1 -0
- package/dist/Multiplayer.d.ts +2697 -169
- package/dist/Multiplayer.js +2 -2
- package/dist/{PlayFabCommon-BX3jSqGx.d.ts → PlayFabCommon-Dnp_xHg5.d.ts} +3 -5
- package/dist/Profiles.d.ts +163 -19
- package/dist/Profiles.js +2 -2
- package/dist/Progression.d.ts +287 -35
- package/dist/Progression.js +2 -2
- package/dist/Server.d.ts +1904 -242
- package/dist/Server.js +2 -2
- package/dist/chunk-3I6ONUUQ.js +237 -0
- package/dist/chunk-3I6ONUUQ.js.map +1 -0
- package/dist/chunk-3O5QT4SL.js +2477 -0
- package/dist/chunk-3O5QT4SL.js.map +1 -0
- package/dist/chunk-3OBHYLBF.js +2673 -0
- package/dist/chunk-3OBHYLBF.js.map +1 -0
- package/dist/chunk-57KYHGBO.js +421 -0
- package/dist/chunk-57KYHGBO.js.map +1 -0
- package/dist/{chunk-J4QS5VX5.js → chunk-5CWZN75H.js} +6 -3
- package/dist/chunk-5CWZN75H.js.map +1 -0
- package/dist/chunk-73SVDH45.js +197 -0
- package/dist/chunk-73SVDH45.js.map +1 -0
- package/dist/chunk-ADHTNFTN.js +175 -0
- package/dist/chunk-ADHTNFTN.js.map +1 -0
- package/dist/chunk-C7U2JQNZ.js +76 -0
- package/dist/chunk-C7U2JQNZ.js.map +1 -0
- package/dist/{chunk-SGSEOIKS.js → chunk-GAZYZIK2.js} +34 -8
- package/dist/chunk-GAZYZIK2.js.map +1 -0
- package/dist/chunk-J54WY4UN.js +413 -0
- package/dist/chunk-J54WY4UN.js.map +1 -0
- package/dist/chunk-NFWQ4MMZ.js +1048 -0
- package/dist/chunk-NFWQ4MMZ.js.map +1 -0
- package/dist/{chunk-A7VD6ALV.js → chunk-P7UVG26J.js} +167 -32
- package/dist/chunk-P7UVG26J.js.map +1 -0
- package/dist/chunk-PFXZB4UN.js +2387 -0
- package/dist/chunk-PFXZB4UN.js.map +1 -0
- package/dist/{chunk-X34XZJB6.js → chunk-QNGQW3YB.js} +28 -6
- package/dist/chunk-QNGQW3YB.js.map +1 -0
- package/dist/chunk-SQWILU5T.js +270 -0
- package/dist/chunk-SQWILU5T.js.map +1 -0
- package/dist/{chunk-JGDO2ZE3.js → chunk-SR2RIRLX.js} +1482 -175
- package/dist/chunk-SR2RIRLX.js.map +1 -0
- package/dist/{chunk-62SULWOK.js → chunk-XVDYM74A.js} +17 -14
- package/dist/chunk-XVDYM74A.js.map +1 -0
- package/dist/chunk-ZW4TJ3MQ.js +225 -0
- package/dist/chunk-ZW4TJ3MQ.js.map +1 -0
- package/dist/index.d.ts +7 -6
- package/dist/index.js +29 -25
- package/package.json +2 -2
- package/dist/chunk-3FCAP7OZ.js +0 -187
- package/dist/chunk-3FCAP7OZ.js.map +0 -1
- package/dist/chunk-62SULWOK.js.map +0 -1
- package/dist/chunk-A7VD6ALV.js.map +0 -1
- package/dist/chunk-BX65UND2.js +0 -632
- package/dist/chunk-BX65UND2.js.map +0 -1
- package/dist/chunk-J4QS5VX5.js.map +0 -1
- package/dist/chunk-JGDO2ZE3.js.map +0 -1
- package/dist/chunk-POMI7LEF.js +0 -76
- package/dist/chunk-POMI7LEF.js.map +0 -1
- package/dist/chunk-Q3OF3AOJ.js +0 -97
- package/dist/chunk-Q3OF3AOJ.js.map +0 -1
- package/dist/chunk-QUZHVSVZ.js +0 -174
- package/dist/chunk-QUZHVSVZ.js.map +0 -1
- package/dist/chunk-QVLIVSO4.js +0 -1147
- package/dist/chunk-QVLIVSO4.js.map +0 -1
- package/dist/chunk-R7V7DFCF.js +0 -103
- package/dist/chunk-R7V7DFCF.js.map +0 -1
- package/dist/chunk-SGSEOIKS.js.map +0 -1
- package/dist/chunk-UOHHNVCJ.js +0 -119
- package/dist/chunk-UOHHNVCJ.js.map +0 -1
- package/dist/chunk-USKFWNQK.js +0 -384
- package/dist/chunk-USKFWNQK.js.map +0 -1
- package/dist/chunk-UX7LFJCX.js +0 -61
- package/dist/chunk-UX7LFJCX.js.map +0 -1
- package/dist/chunk-X34XZJB6.js.map +0 -1
- package/dist/chunk-YNZF3WXS.js +0 -882
- package/dist/chunk-YNZF3WXS.js.map +0 -1
@@ -0,0 +1,271 @@
|
|
1
|
+
import { I as IPlayFabRequestCommon, a as IPlayFabResultCommon, P as PlayFabCommon } from './PlayFabCommon-Dnp_xHg5.js';
|
2
|
+
|
3
|
+
/** @deprecated Do not use */
|
4
|
+
interface AuthUserRequest extends IPlayFabRequestCommon {
|
5
|
+
/** Session Ticket provided by the client. */
|
6
|
+
AuthorizationTicket: string;
|
7
|
+
}
|
8
|
+
/** @deprecated Do not use */
|
9
|
+
interface AuthUserResponse extends IPlayFabResultCommon {
|
10
|
+
/** Boolean indicating if the user has been authorized to use the external match-making service. */
|
11
|
+
Authorized: boolean;
|
12
|
+
/** PlayFab unique identifier of the account that has been authorized. */
|
13
|
+
PlayFabId?: string;
|
14
|
+
}
|
15
|
+
/** @deprecated Do not use */
|
16
|
+
interface DeregisterGameRequest extends IPlayFabRequestCommon {
|
17
|
+
/** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */
|
18
|
+
CustomTags?: Record<string, string | null>;
|
19
|
+
/** Unique identifier for the Game Server Instance that is being deregistered. */
|
20
|
+
LobbyId: string;
|
21
|
+
}
|
22
|
+
/** @deprecated Do not use */
|
23
|
+
interface DeregisterGameResponse extends IPlayFabResultCommon {
|
24
|
+
}
|
25
|
+
/** @deprecated Do not use */
|
26
|
+
interface ItemInstance {
|
27
|
+
/** Game specific comment associated with this instance when it was added to the user inventory. */
|
28
|
+
Annotation?: string;
|
29
|
+
/** Array of unique items that were awarded when this catalog item was purchased. */
|
30
|
+
BundleContents?: string[];
|
31
|
+
/**
|
32
|
+
* Unique identifier for the parent inventory item, as defined in the catalog, for object which were added from a bundle or
|
33
|
+
* container.
|
34
|
+
*/
|
35
|
+
BundleParent?: string;
|
36
|
+
/** Catalog version for the inventory item, when this instance was created. */
|
37
|
+
CatalogVersion?: string;
|
38
|
+
/**
|
39
|
+
* A set of custom key-value pairs on the instance of the inventory item, which is not to be confused with the catalog
|
40
|
+
* item's custom data.
|
41
|
+
*/
|
42
|
+
CustomData?: Record<string, string | null>;
|
43
|
+
/** CatalogItem.DisplayName at the time this item was purchased. */
|
44
|
+
DisplayName?: string;
|
45
|
+
/** Timestamp for when this instance will expire. */
|
46
|
+
Expiration?: string;
|
47
|
+
/** Class name for the inventory item, as defined in the catalog. */
|
48
|
+
ItemClass?: string;
|
49
|
+
/** Unique identifier for the inventory item, as defined in the catalog. */
|
50
|
+
ItemId?: string;
|
51
|
+
/** Unique item identifier for this specific instance of the item. */
|
52
|
+
ItemInstanceId?: string;
|
53
|
+
/** Timestamp for when this instance was purchased. */
|
54
|
+
PurchaseDate?: string;
|
55
|
+
/** Total number of remaining uses, if this is a consumable item. */
|
56
|
+
RemainingUses?: number;
|
57
|
+
/** Currency type for the cost of the catalog item. Not available when granting items. */
|
58
|
+
UnitCurrency?: string;
|
59
|
+
/** Cost of the catalog item in the given currency. Not available when granting items. */
|
60
|
+
UnitPrice: number;
|
61
|
+
/** The number of uses that were added or removed to this item in this call. */
|
62
|
+
UsesIncrementedBy?: number;
|
63
|
+
}
|
64
|
+
/** @deprecated Do not use */
|
65
|
+
interface PlayerJoinedRequest extends IPlayFabRequestCommon {
|
66
|
+
/** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */
|
67
|
+
CustomTags?: Record<string, string | null>;
|
68
|
+
/**
|
69
|
+
* Unique identifier of the Game Server Instance the user is joining. This must be a Game Server Instance started with the
|
70
|
+
* Matchmaker/StartGame API.
|
71
|
+
*/
|
72
|
+
LobbyId: string;
|
73
|
+
/** PlayFab unique identifier for the player joining. */
|
74
|
+
PlayFabId: string;
|
75
|
+
}
|
76
|
+
/** @deprecated Do not use */
|
77
|
+
interface PlayerJoinedResponse extends IPlayFabResultCommon {
|
78
|
+
}
|
79
|
+
/** @deprecated Do not use */
|
80
|
+
interface PlayerLeftRequest extends IPlayFabRequestCommon {
|
81
|
+
/** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */
|
82
|
+
CustomTags?: Record<string, string | null>;
|
83
|
+
/**
|
84
|
+
* Unique identifier of the Game Server Instance the user is leaving. This must be a Game Server Instance started with the
|
85
|
+
* Matchmaker/StartGame API.
|
86
|
+
*/
|
87
|
+
LobbyId: string;
|
88
|
+
/** PlayFab unique identifier for the player leaving. */
|
89
|
+
PlayFabId: string;
|
90
|
+
}
|
91
|
+
/** @deprecated Do not use */
|
92
|
+
interface PlayerLeftResponse extends IPlayFabResultCommon {
|
93
|
+
}
|
94
|
+
/** @deprecated Do not use */
|
95
|
+
interface RegisterGameRequest extends IPlayFabRequestCommon {
|
96
|
+
/** Unique identifier of the build running on the Game Server Instance. */
|
97
|
+
Build: string;
|
98
|
+
/** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */
|
99
|
+
CustomTags?: Record<string, string | null>;
|
100
|
+
/**
|
101
|
+
* Game Mode the Game Server instance is running. Note that this must be defined in the Game Modes tab in the PlayFab Game
|
102
|
+
* Manager, along with the Build ID (the same Game Mode can be defined for multiple Build IDs).
|
103
|
+
*/
|
104
|
+
GameMode: string;
|
105
|
+
/** Previous lobby id if re-registering an existing game. */
|
106
|
+
LobbyId?: string;
|
107
|
+
/**
|
108
|
+
* Region in which the Game Server Instance is running. For matchmaking using non-AWS region names, set this to any AWS
|
109
|
+
* region and use Tags (below) to specify your custom region.
|
110
|
+
*/
|
111
|
+
Region: string;
|
112
|
+
/**
|
113
|
+
* IPV4 address of the Game Server Instance.
|
114
|
+
* @deprecated Please use ServerIPV4Address instead.
|
115
|
+
*/
|
116
|
+
ServerHost?: string;
|
117
|
+
/** IPV4 address of the game server instance. */
|
118
|
+
ServerIPV4Address?: string;
|
119
|
+
/** IPV6 address (if any) of the game server instance. */
|
120
|
+
ServerIPV6Address?: string;
|
121
|
+
/** Port number for communication with the Game Server Instance. */
|
122
|
+
ServerPort: string;
|
123
|
+
/** Public DNS name (if any) of the server */
|
124
|
+
ServerPublicDNSName?: string;
|
125
|
+
/** Tags for the Game Server Instance */
|
126
|
+
Tags?: Record<string, string | null>;
|
127
|
+
}
|
128
|
+
/** @deprecated Do not use */
|
129
|
+
interface RegisterGameResponse extends IPlayFabResultCommon {
|
130
|
+
/**
|
131
|
+
* Unique identifier generated for the Game Server Instance that is registered. If LobbyId is specified in request and the
|
132
|
+
* game still exists in PlayFab, the LobbyId in request is returned. Otherwise a new lobby id will be returned.
|
133
|
+
*/
|
134
|
+
LobbyId?: string;
|
135
|
+
}
|
136
|
+
/** @deprecated Do not use */
|
137
|
+
interface StartGameRequest extends IPlayFabRequestCommon {
|
138
|
+
/** Unique identifier of the previously uploaded build executable which is to be started. */
|
139
|
+
Build: string;
|
140
|
+
/** Custom command line argument when starting game server process. */
|
141
|
+
CustomCommandLineData?: string;
|
142
|
+
/** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */
|
143
|
+
CustomTags?: Record<string, string | null>;
|
144
|
+
/**
|
145
|
+
* HTTP endpoint URL for receiving game status events, if using an external matchmaker. When the game ends, PlayFab will
|
146
|
+
* make a POST request to this URL with the X-SecretKey header set to the value of the game's secret and an
|
147
|
+
* application/json body of { "EventName": "game_ended", "GameID": "<gameid>" }.
|
148
|
+
*/
|
149
|
+
ExternalMatchmakerEventEndpoint: string;
|
150
|
+
/** Game mode for this Game Server Instance. */
|
151
|
+
GameMode: string;
|
152
|
+
/** Region with which to associate the server, for filtering. */
|
153
|
+
Region: string;
|
154
|
+
}
|
155
|
+
/** @deprecated Do not use */
|
156
|
+
interface StartGameResponse extends IPlayFabResultCommon {
|
157
|
+
/** Unique identifier for the game/lobby in the new Game Server Instance. */
|
158
|
+
GameID?: string;
|
159
|
+
/**
|
160
|
+
* IPV4 address of the new Game Server Instance.
|
161
|
+
* @deprecated Please use ServerIPV4Address instead.
|
162
|
+
*/
|
163
|
+
ServerHostname?: string;
|
164
|
+
/** IPV4 address of the server */
|
165
|
+
ServerIPV4Address?: string;
|
166
|
+
/** IPV6 address of the new Game Server Instance. */
|
167
|
+
ServerIPV6Address?: string;
|
168
|
+
/** Port number for communication with the Game Server Instance. */
|
169
|
+
ServerPort: number;
|
170
|
+
/** Public DNS name (if any) of the server */
|
171
|
+
ServerPublicDNSName?: string;
|
172
|
+
}
|
173
|
+
/** @deprecated Do not use */
|
174
|
+
interface UserInfoRequest extends IPlayFabRequestCommon {
|
175
|
+
/** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */
|
176
|
+
CustomTags?: Record<string, string | null>;
|
177
|
+
/**
|
178
|
+
* Minimum catalog version for which data is requested (filters the results to only contain inventory items which have a
|
179
|
+
* catalog version of this or higher).
|
180
|
+
*/
|
181
|
+
MinCatalogVersion: number;
|
182
|
+
/** PlayFab unique identifier of the user whose information is being requested. */
|
183
|
+
PlayFabId: string;
|
184
|
+
}
|
185
|
+
/** @deprecated Do not use */
|
186
|
+
interface UserInfoResponse extends IPlayFabResultCommon {
|
187
|
+
/** Array of inventory items in the user's current inventory. */
|
188
|
+
Inventory?: ItemInstance[];
|
189
|
+
/** Boolean indicating whether the user is a developer. */
|
190
|
+
IsDeveloper: boolean;
|
191
|
+
/** PlayFab unique identifier of the user whose information was requested. */
|
192
|
+
PlayFabId?: string;
|
193
|
+
/** Steam unique identifier, if the user has an associated Steam account. */
|
194
|
+
SteamId?: string;
|
195
|
+
/** Title specific display name, if set. */
|
196
|
+
TitleDisplayName?: string;
|
197
|
+
/** PlayFab unique user name. */
|
198
|
+
Username?: string;
|
199
|
+
/** Array of virtual currency balance(s) belonging to the user. */
|
200
|
+
VirtualCurrency?: Record<string, number>;
|
201
|
+
/** Array of remaining times and timestamps for virtual currencies. */
|
202
|
+
VirtualCurrencyRechargeTimes?: Record<string, VirtualCurrencyRechargeTime>;
|
203
|
+
}
|
204
|
+
/** @deprecated Do not use */
|
205
|
+
interface VirtualCurrencyRechargeTime {
|
206
|
+
/**
|
207
|
+
* Maximum value to which the regenerating currency will automatically increment. Note that it can exceed this value
|
208
|
+
* through use of the AddUserVirtualCurrency API call. However, it will not regenerate automatically until it has fallen
|
209
|
+
* below this value.
|
210
|
+
*/
|
211
|
+
RechargeMax: number;
|
212
|
+
/** Server timestamp in UTC indicating the next time the virtual currency will be incremented. */
|
213
|
+
RechargeTime: string;
|
214
|
+
/** Time remaining (in seconds) before the next recharge increment of the virtual currency. */
|
215
|
+
SecondsToRecharge: number;
|
216
|
+
}
|
217
|
+
|
218
|
+
declare class PlayFabMatchmakerApi extends PlayFabCommon {
|
219
|
+
/**
|
220
|
+
* Validates a user with the PlayFab service
|
221
|
+
*
|
222
|
+
* {@link https://docs.microsoft.com/rest/api/playfab/matchmaker/matchmaking/authuser Microsoft Documentation}
|
223
|
+
* @deprecated Do not use
|
224
|
+
*/
|
225
|
+
AuthUser(request: AuthUserRequest, extraHeaders?: Record<string, string>): Promise<AuthUserResponse>;
|
226
|
+
/**
|
227
|
+
* Inform the matchmaker that a Game Server Instance is removed.
|
228
|
+
*
|
229
|
+
* {@link https://docs.microsoft.com/rest/api/playfab/matchmaker/matchmaking/deregistergame Microsoft Documentation}
|
230
|
+
* @deprecated Please use Server/DeregisterGame instead.
|
231
|
+
*/
|
232
|
+
DeregisterGame(request: DeregisterGameRequest, extraHeaders?: Record<string, string>): Promise<DeregisterGameResponse>;
|
233
|
+
/**
|
234
|
+
* Informs the PlayFab game server hosting service that the indicated user has joined the Game Server Instance specified
|
235
|
+
*
|
236
|
+
* {@link https://docs.microsoft.com/rest/api/playfab/matchmaker/matchmaking/playerjoined Microsoft Documentation}
|
237
|
+
* @deprecated Do not use
|
238
|
+
*/
|
239
|
+
PlayerJoined(request: PlayerJoinedRequest, extraHeaders?: Record<string, string>): Promise<PlayerJoinedResponse>;
|
240
|
+
/**
|
241
|
+
* Informs the PlayFab game server hosting service that the indicated user has left the Game Server Instance specified
|
242
|
+
*
|
243
|
+
* {@link https://docs.microsoft.com/rest/api/playfab/matchmaker/matchmaking/playerleft Microsoft Documentation}
|
244
|
+
* @deprecated Do not use
|
245
|
+
*/
|
246
|
+
PlayerLeft(request: PlayerLeftRequest, extraHeaders?: Record<string, string>): Promise<PlayerLeftResponse>;
|
247
|
+
/**
|
248
|
+
* Inform the matchmaker that a new Game Server Instance is added.
|
249
|
+
*
|
250
|
+
* {@link https://docs.microsoft.com/rest/api/playfab/matchmaker/matchmaking/registergame Microsoft Documentation}
|
251
|
+
* @deprecated Please use Server/RegisterGame instead.
|
252
|
+
*/
|
253
|
+
RegisterGame(request: RegisterGameRequest, extraHeaders?: Record<string, string>): Promise<RegisterGameResponse>;
|
254
|
+
/**
|
255
|
+
* Instructs the PlayFab game server hosting service to instantiate a new Game Server Instance
|
256
|
+
*
|
257
|
+
* {@link https://docs.microsoft.com/rest/api/playfab/matchmaker/matchmaking/startgame Microsoft Documentation}
|
258
|
+
* @deprecated Do not use
|
259
|
+
*/
|
260
|
+
StartGame(request: StartGameRequest, extraHeaders?: Record<string, string>): Promise<StartGameResponse>;
|
261
|
+
/**
|
262
|
+
* Retrieves the relevant details for a specified user, which the external match-making service can then use to compute
|
263
|
+
* effective matches
|
264
|
+
*
|
265
|
+
* {@link https://docs.microsoft.com/rest/api/playfab/matchmaker/matchmaking/userinfo Microsoft Documentation}
|
266
|
+
* @deprecated Do not use
|
267
|
+
*/
|
268
|
+
UserInfo(request: UserInfoRequest, extraHeaders?: Record<string, string>): Promise<UserInfoResponse>;
|
269
|
+
}
|
270
|
+
|
271
|
+
export { PlayFabMatchmakerApi as default };
|
@@ -0,0 +1 @@
|
|
1
|
+
{"version":3,"sources":[],"sourcesContent":[],"mappings":"","names":[]}
|