@bedrock-rbx/ocale 0.3.4 → 0.5.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/README.md +10 -5
- package/dist/assets.d.mts +64 -0
- package/dist/assets.d.mts.map +1 -0
- package/dist/assets.mjs +301 -0
- package/dist/assets.mjs.map +1 -0
- package/dist/badge-insufficient-funds-BLFvQZt1.mjs +91 -0
- package/dist/badge-insufficient-funds-BLFvQZt1.mjs.map +1 -0
- package/dist/badges.d.mts +359 -196
- package/dist/badges.d.mts.map +1 -1
- package/dist/badges.mjs +493 -59
- package/dist/badges.mjs.map +1 -1
- package/dist/capacity-admission-Ce2V9QNb.d.mts +347 -0
- package/dist/capacity-admission-Ce2V9QNb.d.mts.map +1 -0
- package/dist/{data.generated-B2ceLfSn.d.mts → data.generated-B4Fztv_7.d.mts} +23 -25
- package/dist/data.generated-B4Fztv_7.d.mts.map +1 -0
- package/dist/developer-products.d.mts +207 -194
- package/dist/developer-products.d.mts.map +1 -1
- package/dist/developer-products.mjs +125 -39
- package/dist/developer-products.mjs.map +1 -1
- package/dist/game-passes.d.mts +206 -211
- package/dist/game-passes.d.mts.map +1 -1
- package/dist/game-passes.mjs +35 -36
- package/dist/game-passes.mjs.map +1 -1
- package/dist/index.d.mts +947 -366
- package/dist/index.d.mts.map +1 -1
- package/dist/index.mjs +324 -12
- package/dist/index.mjs.map +1 -1
- package/dist/is-date-time-string-C91G44SI.mjs +19 -0
- package/dist/is-date-time-string-C91G44SI.mjs.map +1 -0
- package/dist/locales.d.mts +28 -2
- package/dist/locales.d.mts.map +1 -0
- package/dist/locales.mjs +24 -3
- package/dist/locales.mjs.map +1 -1
- package/dist/luau-execution.d.mts +154 -157
- package/dist/luau-execution.d.mts.map +1 -1
- package/dist/luau-execution.mjs +15 -16
- package/dist/luau-execution.mjs.map +1 -1
- package/dist/{network-error-DR9FX5hb.mjs → network-error-P4An7nUB.mjs} +48 -14
- package/dist/network-error-P4An7nUB.mjs.map +1 -0
- package/dist/places.d.mts +258 -186
- package/dist/places.d.mts.map +1 -1
- package/dist/places.mjs +187 -35
- package/dist/places.mjs.map +1 -1
- package/dist/{poll-timeout-3PXLsabj.mjs → poll-timeout-BCxgN97O.mjs} +4 -6
- package/dist/{poll-timeout-3PXLsabj.mjs.map → poll-timeout-BCxgN97O.mjs.map} +1 -1
- package/dist/{polling-helpers-CoVhsC33.mjs → polling-helpers-BtEYR5dN.mjs} +260 -105
- package/dist/polling-helpers-BtEYR5dN.mjs.map +1 -0
- package/dist/{price-information-B0tkOoAX.mjs → price-information--d6GZAcp.mjs} +3 -4
- package/dist/{price-information-B0tkOoAX.mjs.map → price-information--d6GZAcp.mjs.map} +1 -1
- package/dist/resource-client-CF8SPsV8.d.mts +162 -0
- package/dist/resource-client-CF8SPsV8.d.mts.map +1 -0
- package/dist/{resource-client-rqTMkBeR.mjs → resource-client-Cm_bPcCs.mjs} +589 -197
- package/dist/resource-client-Cm_bPcCs.mjs.map +1 -0
- package/dist/retry-DYxm_eBU.d.mts +225 -0
- package/dist/retry-DYxm_eBU.d.mts.map +1 -0
- package/dist/{retry-BlX4tUnT.mjs → retry-Dv5TsY9O.mjs} +312 -54
- package/dist/retry-Dv5TsY9O.mjs.map +1 -0
- package/dist/{signatures-JF-7Psce.mjs → signatures-CtJ7jfVN.mjs} +2 -3
- package/dist/{signatures-JF-7Psce.mjs.map → signatures-CtJ7jfVN.mjs.map} +1 -1
- package/dist/storage.d.mts +333 -344
- package/dist/storage.d.mts.map +1 -1
- package/dist/storage.mjs +39 -40
- package/dist/storage.mjs.map +1 -1
- package/dist/testing.d.mts +369 -434
- package/dist/testing.d.mts.map +1 -1
- package/dist/testing.mjs +18 -33
- package/dist/testing.mjs.map +1 -1
- package/dist/{to-blob-RPqMBuft.mjs → to-blob-Bqu7bmlE.mjs} +2 -3
- package/dist/{to-blob-RPqMBuft.mjs.map → to-blob-Bqu7bmlE.mjs.map} +1 -1
- package/dist/types-Z4abDJfK.d.mts +501 -0
- package/dist/types-Z4abDJfK.d.mts.map +1 -0
- package/dist/universes.d.mts +619 -436
- package/dist/universes.d.mts.map +1 -1
- package/dist/universes.mjs +432 -79
- package/dist/universes.mjs.map +1 -1
- package/dist/{validation-B_Zs1So2.mjs → validation-kaTLLAD1.mjs} +3 -4
- package/dist/{validation-B_Zs1So2.mjs.map → validation-kaTLLAD1.mjs.map} +1 -1
- package/dist/wire-DDG87I-d.d.mts +39 -0
- package/dist/wire-DDG87I-d.d.mts.map +1 -0
- package/package.json +15 -14
- package/dist/capacity-admission-IDO3fcUC.d.mts +0 -369
- package/dist/capacity-admission-IDO3fcUC.d.mts.map +0 -1
- package/dist/data.generated-B2ceLfSn.d.mts.map +0 -1
- package/dist/network-error-DR9FX5hb.mjs.map +0 -1
- package/dist/polling-helpers-CoVhsC33.mjs.map +0 -1
- package/dist/resource-client-B6NeFXUv.d.mts +0 -164
- package/dist/resource-client-B6NeFXUv.d.mts.map +0 -1
- package/dist/resource-client-rqTMkBeR.mjs.map +0 -1
- package/dist/retry-BlX4tUnT.mjs.map +0 -1
- package/dist/retry-war_-9tb.d.mts +0 -373
- package/dist/retry-war_-9tb.d.mts.map +0 -1
- package/dist/types-CvYh4SPC.d.mts +0 -386
- package/dist/types-CvYh4SPC.d.mts.map +0 -1
- package/dist/wire-D3K-a-UP.d.mts +0 -37
- package/dist/wire-D3K-a-UP.d.mts.map +0 -1
package/dist/universes.d.mts
CHANGED
|
@@ -1,23 +1,21 @@
|
|
|
1
|
-
import {
|
|
2
|
-
import {
|
|
3
|
-
import {
|
|
4
|
-
import {
|
|
5
|
-
|
|
6
|
-
|
|
7
|
-
|
|
8
|
-
*
|
|
9
|
-
|
|
10
|
-
* @since 0.1.0
|
|
11
|
-
*/
|
|
1
|
+
import { i as RobloxLocale, r as RobloxLanguageCode } from "./data.generated-B4Fztv_7.mjs";
|
|
2
|
+
import { n as GameIconState } from "./wire-DDG87I-d.mjs";
|
|
3
|
+
import { c as OpenCloudClientOptions, d as RequestOptions, g as OpenCloudError, m as Result } from "./types-Z4abDJfK.mjs";
|
|
4
|
+
import { t as ResourceClient } from "./resource-client-CF8SPsV8.mjs";
|
|
5
|
+
/**
|
|
6
|
+
* Caller-supplied input for the `get` method on `UniversesClient`.
|
|
7
|
+
*
|
|
8
|
+
* @since 0.1.0
|
|
9
|
+
*/
|
|
12
10
|
interface GetUniverseParameters {
|
|
13
11
|
/** Stringified ID of the universe to fetch. */
|
|
14
12
|
readonly universeId: string;
|
|
15
13
|
}
|
|
16
14
|
/**
|
|
17
|
-
* A social link that may be associated with a universe.
|
|
18
|
-
*
|
|
19
|
-
* @since 0.1.0
|
|
20
|
-
*/
|
|
15
|
+
* A social link that may be associated with a universe.
|
|
16
|
+
*
|
|
17
|
+
* @since 0.1.0
|
|
18
|
+
*/
|
|
21
19
|
interface SocialLink {
|
|
22
20
|
/** Display title of the link. */
|
|
23
21
|
readonly title: string;
|
|
@@ -25,22 +23,22 @@ interface SocialLink {
|
|
|
25
23
|
readonly uri: string;
|
|
26
24
|
}
|
|
27
25
|
/**
|
|
28
|
-
* Public visibility classification.
|
|
29
|
-
*
|
|
30
|
-
* @since 0.1.0
|
|
31
|
-
*/
|
|
26
|
+
* Public visibility classification.
|
|
27
|
+
*
|
|
28
|
+
* @since 0.1.0
|
|
29
|
+
*/
|
|
32
30
|
type UniverseVisibility = "private" | "public" | "unspecified";
|
|
33
31
|
/**
|
|
34
|
-
* Caller-supplied input for the `update` method on `UniversesClient`.
|
|
35
|
-
* Every writable field is optional; presence of a key drives the
|
|
36
|
-
* `updateMask` query string that the server uses as the field-mask for
|
|
37
|
-
* the partial update. Absent keys are left untouched server-side.
|
|
38
|
-
* Setting a key to `undefined` clears the corresponding server-side
|
|
39
|
-
* value (applicable to `privateServerPriceRobux` and each optional
|
|
40
|
-
* social link).
|
|
41
|
-
*
|
|
42
|
-
* @since 0.1.0
|
|
43
|
-
*/
|
|
32
|
+
* Caller-supplied input for the `update` method on `UniversesClient`.
|
|
33
|
+
* Every writable field is optional; presence of a key drives the
|
|
34
|
+
* `updateMask` query string that the server uses as the field-mask for
|
|
35
|
+
* the partial update. Absent keys are left untouched server-side.
|
|
36
|
+
* Setting a key to `undefined` clears the corresponding server-side
|
|
37
|
+
* value (applicable to `privateServerPriceRobux` and each optional
|
|
38
|
+
* social link).
|
|
39
|
+
*
|
|
40
|
+
* @since 0.1.0
|
|
41
|
+
*/
|
|
44
42
|
interface UpdateUniverseParameters {
|
|
45
43
|
/** Whether console players can join. */
|
|
46
44
|
readonly consoleEnabled?: boolean;
|
|
@@ -74,30 +72,30 @@ interface UpdateUniverseParameters {
|
|
|
74
72
|
readonly youtubeSocialLink?: SocialLink | undefined;
|
|
75
73
|
}
|
|
76
74
|
/**
|
|
77
|
-
* Discriminated-union representation of a universe's owner.
|
|
78
|
-
*
|
|
79
|
-
* @since 0.1.0
|
|
80
|
-
*/
|
|
75
|
+
* Discriminated-union representation of a universe's owner.
|
|
76
|
+
*
|
|
77
|
+
* @since 0.1.0
|
|
78
|
+
*/
|
|
81
79
|
interface UniverseOwner {
|
|
82
80
|
/**
|
|
83
|
-
|
|
84
|
-
|
|
85
|
-
|
|
81
|
+
* Stringified numeric owner ID, extracted from the wire
|
|
82
|
+
* `users/{id}` or `groups/{id}` resource path.
|
|
83
|
+
*/
|
|
86
84
|
readonly id: string;
|
|
87
85
|
/** Whether the owner is a user or a group. */
|
|
88
86
|
readonly kind: "group" | "user";
|
|
89
87
|
}
|
|
90
88
|
/**
|
|
91
|
-
* Public age-rating classification.
|
|
92
|
-
*
|
|
93
|
-
* @since 0.1.0
|
|
94
|
-
*/
|
|
89
|
+
* Public age-rating classification.
|
|
90
|
+
*
|
|
91
|
+
* @since 0.1.0
|
|
92
|
+
*/
|
|
95
93
|
type UniverseAgeRating = "9Plus" | "13Plus" | "17Plus" | "all" | "unspecified";
|
|
96
94
|
/**
|
|
97
|
-
* Parsed representation of a Roblox universe's configuration.
|
|
98
|
-
*
|
|
99
|
-
* @since 0.1.0
|
|
100
|
-
*/
|
|
95
|
+
* Parsed representation of a Roblox universe's configuration.
|
|
96
|
+
*
|
|
97
|
+
* @since 0.1.0
|
|
98
|
+
*/
|
|
101
99
|
interface Universe {
|
|
102
100
|
/** Stringified universe ID, extracted from the wire `path`. */
|
|
103
101
|
readonly id: string;
|
|
@@ -128,8 +126,8 @@ interface Universe {
|
|
|
128
126
|
/** Roblox Group social link; `undefined` when absent. */
|
|
129
127
|
readonly robloxGroupSocialLink: SocialLink | undefined;
|
|
130
128
|
/**
|
|
131
|
-
|
|
132
|
-
|
|
129
|
+
* Root place ID; `undefined` when the universe has no resolved root place.
|
|
130
|
+
*/
|
|
133
131
|
readonly rootPlaceId: string | undefined;
|
|
134
132
|
/** Whether tablet players can join. */
|
|
135
133
|
readonly tabletEnabled: boolean;
|
|
@@ -149,194 +147,210 @@ interface Universe {
|
|
|
149
147
|
readonly youtubeSocialLink: SocialLink | undefined;
|
|
150
148
|
}
|
|
151
149
|
/**
|
|
152
|
-
* Caller-supplied input for the `restartServers` method on
|
|
153
|
-
* `UniversesClient`.
|
|
154
|
-
*
|
|
155
|
-
* @since 0.3.3
|
|
156
|
-
*/
|
|
150
|
+
* Caller-supplied input for the `restartServers` method on
|
|
151
|
+
* `UniversesClient`.
|
|
152
|
+
*
|
|
153
|
+
* @since 0.3.3
|
|
154
|
+
*/
|
|
157
155
|
interface RestartUniverseServersParameters {
|
|
158
156
|
/**
|
|
159
|
-
|
|
160
|
-
|
|
161
|
-
|
|
157
|
+
* Minutes (1-60) that selected servers stay up, closed to matchmaking,
|
|
158
|
+
* before they shut down. Omit to shut them down at once.
|
|
159
|
+
*/
|
|
162
160
|
readonly bleedOffDurationMinutes?: number;
|
|
163
161
|
/**
|
|
164
|
-
|
|
165
|
-
|
|
166
|
-
|
|
167
|
-
|
|
162
|
+
* When `true`, restarts servers on every place version. When omitted or
|
|
163
|
+
* `false`, restarts only servers on an older version than the latest
|
|
164
|
+
* published one.
|
|
165
|
+
*/
|
|
168
166
|
readonly closeAllVersions?: boolean;
|
|
169
167
|
/**
|
|
170
|
-
|
|
171
|
-
|
|
172
|
-
|
|
173
|
-
|
|
174
|
-
|
|
168
|
+
* Stringified IDs of the places to restart. Omit to restart every place;
|
|
169
|
+
* an empty list is rejected, since Roblox reads it as every place.
|
|
170
|
+
* Roblox answers 500 when a listed place has no live server and
|
|
171
|
+
* `closeAllVersions` is not `true`; `restarts.restartOutdated` skips
|
|
172
|
+
* such places for you.
|
|
173
|
+
*/
|
|
175
174
|
readonly placeIds?: ReadonlyArray<string>;
|
|
176
175
|
/** Stringified ID of the universe whose servers to restart. */
|
|
177
176
|
readonly universeId: string;
|
|
178
177
|
}
|
|
179
|
-
//#endregion
|
|
180
|
-
//#region src/domains/game-internationalization/game-icon/types.d.ts
|
|
181
178
|
/**
|
|
182
|
-
*
|
|
183
|
-
*
|
|
184
|
-
* @since 0.
|
|
185
|
-
*/
|
|
179
|
+
* Identifies the experience to make public.
|
|
180
|
+
*
|
|
181
|
+
* @since 0.4.0
|
|
182
|
+
*/
|
|
183
|
+
interface ActivateUniverseParameters {
|
|
184
|
+
/** Stringified ID of the universe to activate. */
|
|
185
|
+
readonly universeId: string;
|
|
186
|
+
}
|
|
187
|
+
/**
|
|
188
|
+
* Identifies the experience to make private.
|
|
189
|
+
*
|
|
190
|
+
* @since 0.4.0
|
|
191
|
+
*/
|
|
192
|
+
interface DeactivateUniverseParameters {
|
|
193
|
+
/** Stringified ID of the universe to deactivate. */
|
|
194
|
+
readonly universeId: string;
|
|
195
|
+
}
|
|
196
|
+
/**
|
|
197
|
+
* A localized icon entry returned by listing icons for an experience.
|
|
198
|
+
*
|
|
199
|
+
* @since 0.1.0
|
|
200
|
+
*/
|
|
186
201
|
interface ExperienceIcon {
|
|
187
|
-
/**
|
|
188
|
-
|
|
202
|
+
/**
|
|
203
|
+
* Stringified ID of the uploaded icon image, or `undefined` when the
|
|
204
|
+
* locale is still on the default icon.
|
|
205
|
+
*/
|
|
206
|
+
readonly imageId: string | undefined;
|
|
189
207
|
/** CDN URL the icon can be loaded from. */
|
|
190
208
|
readonly imageUrl: string;
|
|
191
209
|
/**
|
|
192
|
-
|
|
193
|
-
|
|
194
|
-
|
|
195
|
-
|
|
210
|
+
* Roblox wire form the icon is registered against. Either the
|
|
211
|
+
* Language form (e.g. `en`, `fil`, `zh-hans`) or the Locale form
|
|
212
|
+
* (e.g. `en_us`, `pt_br`, `ar_001`).
|
|
213
|
+
*/
|
|
196
214
|
readonly languageCode: string;
|
|
197
215
|
/** Moderation state of the icon. */
|
|
198
216
|
readonly state: GameIconState;
|
|
199
217
|
}
|
|
200
218
|
/**
|
|
201
|
-
* Parameters for uploading or replacing a localized experience icon. A
|
|
202
|
-
* subsequent upload for the same `(universeId, languageCode)` pair replaces
|
|
203
|
-
* the existing icon for that locale.
|
|
204
|
-
*
|
|
205
|
-
* @since 0.1.0
|
|
206
|
-
*/
|
|
219
|
+
* Parameters for uploading or replacing a localized experience icon. A
|
|
220
|
+
* subsequent upload for the same `(universeId, languageCode)` pair replaces
|
|
221
|
+
* the existing icon for that locale.
|
|
222
|
+
*
|
|
223
|
+
* @since 0.1.0
|
|
224
|
+
*/
|
|
207
225
|
interface UploadExperienceIconParameters {
|
|
208
226
|
/** Image bytes to upload. PNG and JPEG are accepted by the server. */
|
|
209
227
|
readonly image: Blob | Uint8Array;
|
|
210
228
|
/**
|
|
211
|
-
|
|
212
|
-
|
|
213
|
-
|
|
214
|
-
|
|
229
|
+
* Roblox wire form the icon is being uploaded for. Either the
|
|
230
|
+
* Language form (e.g. `en`, `fil`, `zh-hans`) or the Locale form
|
|
231
|
+
* (e.g. `en_us`, `pt_br`, `ar_001`).
|
|
232
|
+
*/
|
|
215
233
|
readonly languageCode: RobloxLanguageCode | RobloxLocale;
|
|
216
234
|
/** Stringified ID of the universe whose icon is being uploaded. */
|
|
217
235
|
readonly universeId: string;
|
|
218
236
|
}
|
|
219
237
|
/**
|
|
220
|
-
* Parameters for deleting the localized icon registered against a universe
|
|
221
|
-
* for a given language.
|
|
222
|
-
*
|
|
223
|
-
* @since 0.1.0
|
|
224
|
-
*/
|
|
238
|
+
* Parameters for deleting the localized icon registered against a universe
|
|
239
|
+
* for a given language.
|
|
240
|
+
*
|
|
241
|
+
* @since 0.1.0
|
|
242
|
+
*/
|
|
225
243
|
interface DeleteExperienceIconParameters {
|
|
226
244
|
/**
|
|
227
|
-
|
|
228
|
-
|
|
229
|
-
|
|
230
|
-
|
|
245
|
+
* Roblox wire form of the icon to delete. Either the Language form
|
|
246
|
+
* (e.g. `en`, `fil`, `zh-hans`) or the Locale form (e.g. `en_us`,
|
|
247
|
+
* `pt_br`, `ar_001`).
|
|
248
|
+
*/
|
|
231
249
|
readonly languageCode: RobloxLanguageCode | RobloxLocale;
|
|
232
250
|
/** Stringified ID of the universe whose icon is being deleted. */
|
|
233
251
|
readonly universeId: string;
|
|
234
252
|
}
|
|
235
253
|
/**
|
|
236
|
-
* Parameters for listing every localized icon registered against a universe.
|
|
237
|
-
*
|
|
238
|
-
* @since 0.1.0
|
|
239
|
-
*/
|
|
254
|
+
* Parameters for listing every localized icon registered against a universe.
|
|
255
|
+
*
|
|
256
|
+
* @since 0.1.0
|
|
257
|
+
*/
|
|
240
258
|
interface ListExperienceIconsParameters {
|
|
241
259
|
/** Stringified ID of the universe whose icons are being listed. */
|
|
242
260
|
readonly universeId: string;
|
|
243
261
|
}
|
|
244
|
-
//#endregion
|
|
245
|
-
//#region src/domains/game-internationalization/game-thumbnails/types.d.ts
|
|
246
262
|
/**
|
|
247
|
-
* Result of uploading a localized experience thumbnail.
|
|
248
|
-
*
|
|
249
|
-
* @since 0.1.0
|
|
250
|
-
*/
|
|
263
|
+
* Result of uploading a localized experience thumbnail.
|
|
264
|
+
*
|
|
265
|
+
* @since 0.1.0
|
|
266
|
+
*/
|
|
251
267
|
interface UploadedExperienceThumbnail {
|
|
252
268
|
/** Stringified media asset ID of the uploaded thumbnail. */
|
|
253
269
|
readonly mediaAssetId: string;
|
|
254
270
|
}
|
|
255
271
|
/**
|
|
256
|
-
* Parameters for uploading a new localized experience thumbnail. Each upload
|
|
257
|
-
* appends a new entry to the carousel; reorder via {@link
|
|
258
|
-
* ReorderExperienceThumbnailsParameters} after multiple uploads to set the
|
|
259
|
-
* display order.
|
|
260
|
-
*
|
|
261
|
-
* @since 0.1.0
|
|
262
|
-
*/
|
|
272
|
+
* Parameters for uploading a new localized experience thumbnail. Each upload
|
|
273
|
+
* appends a new entry to the carousel; reorder via {@link
|
|
274
|
+
* ReorderExperienceThumbnailsParameters} after multiple uploads to set the
|
|
275
|
+
* display order.
|
|
276
|
+
*
|
|
277
|
+
* @since 0.1.0
|
|
278
|
+
*/
|
|
263
279
|
interface UploadExperienceThumbnailParameters {
|
|
264
280
|
/** Image bytes to upload. PNG and JPEG are accepted by the server. */
|
|
265
281
|
readonly image: Blob | Uint8Array;
|
|
266
282
|
/**
|
|
267
|
-
|
|
268
|
-
|
|
269
|
-
|
|
270
|
-
|
|
283
|
+
* Roblox wire form the thumbnail is being uploaded for. Either the
|
|
284
|
+
* Language form (e.g. `en`, `fil`, `zh-hans`) or the Locale form
|
|
285
|
+
* (e.g. `en_us`, `pt_br`, `ar_001`).
|
|
286
|
+
*/
|
|
271
287
|
readonly languageCode: RobloxLanguageCode | RobloxLocale;
|
|
272
288
|
/** Stringified ID of the universe whose carousel is being appended to. */
|
|
273
289
|
readonly universeId: string;
|
|
274
290
|
}
|
|
275
291
|
/**
|
|
276
|
-
* Parameters for deleting a single thumbnail by media asset ID.
|
|
277
|
-
*
|
|
278
|
-
* @since 0.1.0
|
|
279
|
-
*/
|
|
292
|
+
* Parameters for deleting a single thumbnail by media asset ID.
|
|
293
|
+
*
|
|
294
|
+
* @since 0.1.0
|
|
295
|
+
*/
|
|
280
296
|
interface DeleteExperienceThumbnailParameters {
|
|
281
297
|
/** Stringified media asset ID of the thumbnail to delete. */
|
|
282
298
|
readonly imageId: string;
|
|
283
299
|
/**
|
|
284
|
-
|
|
285
|
-
|
|
286
|
-
|
|
287
|
-
|
|
300
|
+
* Roblox wire form of the thumbnail to delete. Either the Language
|
|
301
|
+
* form (e.g. `en`, `fil`, `zh-hans`) or the Locale form (e.g.
|
|
302
|
+
* `en_us`, `pt_br`, `ar_001`).
|
|
303
|
+
*/
|
|
288
304
|
readonly languageCode: RobloxLanguageCode | RobloxLocale;
|
|
289
305
|
/** Stringified ID of the universe whose carousel is being modified. */
|
|
290
306
|
readonly universeId: string;
|
|
291
307
|
}
|
|
292
308
|
/**
|
|
293
|
-
* Parameters for reordering the localized thumbnail carousel. The supplied
|
|
294
|
-
* `orderedImageIds` describes the new display order from first to last.
|
|
295
|
-
*
|
|
296
|
-
* @since 0.1.0
|
|
297
|
-
*/
|
|
309
|
+
* Parameters for reordering the localized thumbnail carousel. The supplied
|
|
310
|
+
* `orderedImageIds` describes the new display order from first to last.
|
|
311
|
+
*
|
|
312
|
+
* @since 0.1.0
|
|
313
|
+
*/
|
|
298
314
|
interface ReorderExperienceThumbnailsParameters {
|
|
299
315
|
/**
|
|
300
|
-
|
|
301
|
-
|
|
302
|
-
|
|
303
|
-
|
|
316
|
+
* Roblox wire form of the carousel being reordered. Either the
|
|
317
|
+
* Language form (e.g. `en`, `fil`, `zh-hans`) or the Locale form
|
|
318
|
+
* (e.g. `en_us`, `pt_br`, `ar_001`).
|
|
319
|
+
*/
|
|
304
320
|
readonly languageCode: RobloxLanguageCode | RobloxLocale;
|
|
305
321
|
/** Stringified media asset IDs in the desired display order. */
|
|
306
322
|
readonly orderedImageIds: ReadonlyArray<string>;
|
|
307
323
|
/** Stringified ID of the universe whose carousel is being reordered. */
|
|
308
324
|
readonly universeId: string;
|
|
309
325
|
}
|
|
310
|
-
|
|
311
|
-
|
|
312
|
-
|
|
313
|
-
*
|
|
314
|
-
*
|
|
315
|
-
|
|
316
|
-
* @since 0.3.3
|
|
317
|
-
*/
|
|
326
|
+
/**
|
|
327
|
+
* Caller-supplied input for the `restarts.forecast` method on
|
|
328
|
+
* `UniversesClient`.
|
|
329
|
+
*
|
|
330
|
+
* @since 0.3.3
|
|
331
|
+
*/
|
|
318
332
|
interface ForecastRestartParameters {
|
|
319
333
|
/** Stringified ID of the universe to forecast. */
|
|
320
334
|
readonly universeId: string;
|
|
321
335
|
}
|
|
322
336
|
/**
|
|
323
|
-
* The live servers of one place, and how many of them a restart would
|
|
324
|
-
* close.
|
|
325
|
-
*
|
|
326
|
-
* @since 0.3.3
|
|
327
|
-
*/
|
|
337
|
+
* The live servers of one place, and how many of them a restart would
|
|
338
|
+
* close.
|
|
339
|
+
*
|
|
340
|
+
* @since 0.3.3
|
|
341
|
+
*/
|
|
328
342
|
interface PlaceRestartForecast {
|
|
329
343
|
/**
|
|
330
|
-
|
|
331
|
-
|
|
332
|
-
|
|
344
|
+
* Servers a restart would close. Live captures suggest this counts only
|
|
345
|
+
* servers on an older place version; Roblox does not document it.
|
|
346
|
+
*/
|
|
333
347
|
readonly instancesImpacted: number;
|
|
334
348
|
/** Live server count keyed by place version. */
|
|
335
349
|
readonly instancesPerVersion: Readonly<Record<string, number>>;
|
|
336
350
|
/**
|
|
337
|
-
|
|
338
|
-
|
|
339
|
-
|
|
351
|
+
* `true` when the place has moved to another universe but still has
|
|
352
|
+
* live servers from before the move.
|
|
353
|
+
*/
|
|
340
354
|
readonly isNotInUniverse: boolean;
|
|
341
355
|
/** Most recent place version running on any live server. */
|
|
342
356
|
readonly latestPlaceVersion: string | undefined;
|
|
@@ -354,28 +368,29 @@ interface PlaceRestartForecast {
|
|
|
354
368
|
readonly totalPlayers: number;
|
|
355
369
|
}
|
|
356
370
|
/**
|
|
357
|
-
* Which versions of one place a restart closes. An empty filter closes
|
|
358
|
-
* every version. `versions` and `excludeCurrentVersion` are exclusive:
|
|
359
|
-
* the type enforces what Roblox documents, although the server accepts
|
|
360
|
-
* both together.
|
|
361
|
-
*
|
|
362
|
-
* Roblox answers 500 to `excludeCurrentVersion` on a place with no live
|
|
363
|
-
* server, so forecast first when the place may be empty
|
|
364
|
-
*
|
|
365
|
-
*
|
|
366
|
-
*
|
|
367
|
-
*
|
|
368
|
-
*
|
|
369
|
-
*
|
|
370
|
-
*
|
|
371
|
-
*
|
|
372
|
-
*
|
|
373
|
-
*
|
|
374
|
-
*
|
|
375
|
-
* }
|
|
376
|
-
*
|
|
377
|
-
*
|
|
378
|
-
|
|
371
|
+
* Which versions of one place a restart closes. An empty filter closes
|
|
372
|
+
* every version. `versions` and `excludeCurrentVersion` are exclusive:
|
|
373
|
+
* the type enforces what Roblox documents, although the server accepts
|
|
374
|
+
* both together.
|
|
375
|
+
*
|
|
376
|
+
* Roblox answers 500 to `excludeCurrentVersion` on a place with no live
|
|
377
|
+
* server, so forecast first when the place may be empty, or use
|
|
378
|
+
* `restarts.restartOutdated`.
|
|
379
|
+
*
|
|
380
|
+
* @since 0.3.3
|
|
381
|
+
*
|
|
382
|
+
* @example
|
|
383
|
+
* ```ts
|
|
384
|
+
* import type { RestartPlaceFilter } from "@bedrock-rbx/ocale/universes";
|
|
385
|
+
*
|
|
386
|
+
* const places: Record<string, RestartPlaceFilter> = {
|
|
387
|
+
* 111: {},
|
|
388
|
+
* 222: { versions: [4, 5] },
|
|
389
|
+
* 333: { excludeCurrentVersion: true },
|
|
390
|
+
* };
|
|
391
|
+
* expect(Object.keys(places)).toEqual(["111", "222", "333"]);
|
|
392
|
+
* ```
|
|
393
|
+
*/
|
|
379
394
|
type RestartPlaceFilter = {
|
|
380
395
|
readonly excludeCurrentVersion: boolean;
|
|
381
396
|
readonly versions?: never;
|
|
@@ -387,40 +402,40 @@ type RestartPlaceFilter = {
|
|
|
387
402
|
readonly versions?: never;
|
|
388
403
|
};
|
|
389
404
|
/**
|
|
390
|
-
* Caller-supplied input for the `restarts.launch` method on
|
|
391
|
-
* `UniversesClient`.
|
|
392
|
-
*
|
|
393
|
-
* @since 0.3.3
|
|
394
|
-
*/
|
|
405
|
+
* Caller-supplied input for the `restarts.launch` method on
|
|
406
|
+
* `UniversesClient`.
|
|
407
|
+
*
|
|
408
|
+
* @since 0.3.3
|
|
409
|
+
*/
|
|
395
410
|
interface LaunchRestartParameters {
|
|
396
411
|
/**
|
|
397
|
-
|
|
398
|
-
|
|
399
|
-
|
|
412
|
+
* JSON object (at most 500 bytes serialized) that Roblox sends to the
|
|
413
|
+
* game servers when the restart is scheduled.
|
|
414
|
+
*/
|
|
400
415
|
readonly attributes?: Readonly<Record<string, JSONValue>>;
|
|
401
416
|
/**
|
|
402
|
-
|
|
403
|
-
|
|
404
|
-
|
|
417
|
+
* Minutes (1-240) before servers start to close. Players are not
|
|
418
|
+
* matched into the selected servers during this period.
|
|
419
|
+
*/
|
|
405
420
|
readonly bleedOffDurationMinutes?: number;
|
|
406
421
|
/**
|
|
407
|
-
|
|
408
|
-
|
|
409
|
-
|
|
422
|
+
* Version filter keyed by stringified place ID. Omit to restart every
|
|
423
|
+
* version of every place in the universe.
|
|
424
|
+
*/
|
|
410
425
|
readonly places?: Readonly<Record<string, RestartPlaceFilter>>;
|
|
411
426
|
/** Stringified ID of the universe whose servers to restart. */
|
|
412
427
|
readonly universeId: string;
|
|
413
428
|
}
|
|
414
429
|
/**
|
|
415
|
-
* A restart Roblox accepted, and how much of the universe it reaches.
|
|
416
|
-
*
|
|
417
|
-
* @since 0.3.3
|
|
418
|
-
*/
|
|
430
|
+
* A restart Roblox accepted, and how much of the universe it reaches.
|
|
431
|
+
*
|
|
432
|
+
* @since 0.3.3
|
|
433
|
+
*/
|
|
419
434
|
interface LaunchedRestart {
|
|
420
435
|
/**
|
|
421
|
-
|
|
422
|
-
|
|
423
|
-
|
|
436
|
+
* Restart ID, as reported by `restarts.list`. `undefined` when no live
|
|
437
|
+
* server matched: Roblox then records no restart.
|
|
438
|
+
*/
|
|
424
439
|
readonly id: string | undefined;
|
|
425
440
|
/** Servers the restart will close. */
|
|
426
441
|
readonly instancesImpacted: number;
|
|
@@ -428,34 +443,34 @@ interface LaunchedRestart {
|
|
|
428
443
|
readonly playersImpacted: number;
|
|
429
444
|
}
|
|
430
445
|
/**
|
|
431
|
-
* Caller-supplied input for the `restarts.list` method on
|
|
432
|
-
* `UniversesClient`.
|
|
433
|
-
*
|
|
434
|
-
* @since 0.3.3
|
|
435
|
-
*/
|
|
446
|
+
* Caller-supplied input for the `restarts.list` method on
|
|
447
|
+
* `UniversesClient`.
|
|
448
|
+
*
|
|
449
|
+
* @since 0.3.3
|
|
450
|
+
*/
|
|
436
451
|
interface ListRestartsParameters {
|
|
437
452
|
/** Stringified ID of the universe whose restarts to list. */
|
|
438
453
|
readonly universeId: string;
|
|
439
454
|
}
|
|
440
455
|
/**
|
|
441
|
-
* Progress of a restart in one place: `DELAYING` during the bleed-off
|
|
442
|
-
* period, `RESTARTING` while servers close, then `SUCCEEDED`.
|
|
443
|
-
*
|
|
444
|
-
* @since 0.3.3
|
|
445
|
-
*/
|
|
456
|
+
* Progress of a restart in one place: `DELAYING` during the bleed-off
|
|
457
|
+
* period, `RESTARTING` while servers close, then `SUCCEEDED`.
|
|
458
|
+
*
|
|
459
|
+
* @since 0.3.3
|
|
460
|
+
*/
|
|
446
461
|
type RestartState = "DELAYING" | "RESTARTING" | "SUCCEEDED";
|
|
447
462
|
/**
|
|
448
|
-
* Progress of a restart in one place.
|
|
449
|
-
*
|
|
450
|
-
* @since 0.3.3
|
|
451
|
-
*/
|
|
463
|
+
* Progress of a restart in one place.
|
|
464
|
+
*
|
|
465
|
+
* @since 0.3.3
|
|
466
|
+
*/
|
|
452
467
|
interface PlaceRestartStatus {
|
|
453
468
|
/** When the place restart ended; `undefined` while it runs. */
|
|
454
469
|
readonly endedAt: Date | undefined;
|
|
455
470
|
/**
|
|
456
|
-
|
|
457
|
-
|
|
458
|
-
|
|
471
|
+
* The versions the restart selected. Roblox records a launch without
|
|
472
|
+
* a filter as the versions it found, not as an empty filter.
|
|
473
|
+
*/
|
|
459
474
|
readonly filter: RestartPlaceFilter | undefined;
|
|
460
475
|
/** Latest place version when the restart launched. */
|
|
461
476
|
readonly latestVersion: string | undefined;
|
|
@@ -475,10 +490,52 @@ interface PlaceRestartStatus {
|
|
|
475
490
|
readonly totalPlayers: number;
|
|
476
491
|
}
|
|
477
492
|
/**
|
|
478
|
-
*
|
|
479
|
-
*
|
|
480
|
-
*
|
|
481
|
-
|
|
493
|
+
* Caller-supplied input for the `restarts.restartOutdated` method on
|
|
494
|
+
* `UniversesClient`.
|
|
495
|
+
*
|
|
496
|
+
* @since 0.4.0
|
|
497
|
+
*/
|
|
498
|
+
interface RestartOutdatedParameters {
|
|
499
|
+
/**
|
|
500
|
+
* Stringified IDs of the places to check. Must not be empty. A place
|
|
501
|
+
* with no server on an older version is skipped.
|
|
502
|
+
*/
|
|
503
|
+
readonly placeIds: ReadonlyArray<string>;
|
|
504
|
+
/** Stringified ID of the universe whose servers to restart. */
|
|
505
|
+
readonly universeId: string;
|
|
506
|
+
}
|
|
507
|
+
/**
|
|
508
|
+
* The outcome of a `restarts.restartOutdated` call for one place.
|
|
509
|
+
*
|
|
510
|
+
* @since 0.4.0
|
|
511
|
+
*/
|
|
512
|
+
interface PlaceOutdatedRestart {
|
|
513
|
+
/**
|
|
514
|
+
* Outdated servers the latest forecast counted for the place (0 when
|
|
515
|
+
* absent).
|
|
516
|
+
*/
|
|
517
|
+
readonly instancesImpacted: number;
|
|
518
|
+
/** Stringified ID of the place. */
|
|
519
|
+
readonly placeId: string;
|
|
520
|
+
/** `true` when the place was in the restart call that succeeded. */
|
|
521
|
+
readonly restarted: boolean;
|
|
522
|
+
}
|
|
523
|
+
/**
|
|
524
|
+
* The outcome of a `restarts.restartOutdated` call.
|
|
525
|
+
*
|
|
526
|
+
* @since 0.4.0
|
|
527
|
+
*/
|
|
528
|
+
interface OutdatedRestart {
|
|
529
|
+
/** One entry per requested place (duplicates removed), in request order. */
|
|
530
|
+
readonly places: ReadonlyArray<PlaceOutdatedRestart>;
|
|
531
|
+
/** `true` when at least one place restarted. */
|
|
532
|
+
readonly restarted: boolean;
|
|
533
|
+
}
|
|
534
|
+
/**
|
|
535
|
+
* A restart of a universe's servers and its progress per place.
|
|
536
|
+
*
|
|
537
|
+
* @since 0.3.3
|
|
538
|
+
*/
|
|
482
539
|
interface RestartStatus {
|
|
483
540
|
/** Restart ID, as returned by `restarts.launch`. */
|
|
484
541
|
readonly id: string;
|
|
@@ -489,270 +546,396 @@ interface RestartStatus {
|
|
|
489
546
|
/** When the bleed-off period ends and servers start to close. */
|
|
490
547
|
readonly startsAt: Date;
|
|
491
548
|
}
|
|
492
|
-
//#endregion
|
|
493
|
-
//#region src/resources/universes/restarts-group.d.ts
|
|
494
549
|
/**
|
|
495
|
-
* Operation Group on `UniversesClient` that exposes the server-management
|
|
496
|
-
* restart endpoints: preview a restart, launch one, and track it.
|
|
497
|
-
*
|
|
498
|
-
|
|
550
|
+
* Operation Group on `UniversesClient` that exposes the server-management
|
|
551
|
+
* restart endpoints: preview a restart, launch one, and track it. Its
|
|
552
|
+
* `restartOutdated` also uses the universe `:restartServers` method. The
|
|
553
|
+
* server-management endpoints are BETA on the Roblox side.
|
|
554
|
+
*/
|
|
499
555
|
declare class UniverseRestartsGroup {
|
|
500
556
|
#private;
|
|
501
557
|
/**
|
|
502
|
-
|
|
503
|
-
|
|
504
|
-
|
|
505
|
-
|
|
506
|
-
|
|
507
|
-
|
|
508
|
-
|
|
558
|
+
* Wraps the shared {@link ResourceClient} so the Operation Group
|
|
559
|
+
* routes calls through the same retry, hooks, and rate-limit queues
|
|
560
|
+
* as the rest of the parent client.
|
|
561
|
+
*
|
|
562
|
+
* @param inner - The shared {@link ResourceClient} owned by the
|
|
563
|
+
* parent client.
|
|
564
|
+
*/
|
|
509
565
|
constructor(inner: ResourceClient);
|
|
510
566
|
/**
|
|
511
|
-
|
|
512
|
-
|
|
513
|
-
|
|
514
|
-
|
|
515
|
-
|
|
516
|
-
|
|
517
|
-
|
|
518
|
-
|
|
519
|
-
|
|
567
|
+
* Reads the live servers of every active place in a universe, and how
|
|
568
|
+
* many of them a restart of old place versions would close.
|
|
569
|
+
*
|
|
570
|
+
* @param parameters - The universe identifier.
|
|
571
|
+
* @param options - Optional per-request overrides.
|
|
572
|
+
* @returns A {@link Result} wrapping one {@link PlaceRestartForecast}
|
|
573
|
+
* per active place (empty when no server runs), or the
|
|
574
|
+
* {@link OpenCloudError} that caused the request to fail.
|
|
575
|
+
*/
|
|
520
576
|
forecast(parameters: ForecastRestartParameters, options?: RequestOptions): Promise<Result<ReadonlyArray<PlaceRestartForecast>, OpenCloudError>>;
|
|
521
577
|
/**
|
|
522
|
-
|
|
523
|
-
|
|
524
|
-
|
|
525
|
-
|
|
526
|
-
|
|
527
|
-
|
|
528
|
-
|
|
529
|
-
|
|
530
|
-
|
|
531
|
-
|
|
532
|
-
|
|
533
|
-
|
|
534
|
-
|
|
535
|
-
|
|
536
|
-
|
|
537
|
-
|
|
538
|
-
|
|
539
|
-
|
|
540
|
-
|
|
541
|
-
|
|
542
|
-
|
|
543
|
-
|
|
544
|
-
|
|
545
|
-
|
|
546
|
-
|
|
547
|
-
|
|
548
|
-
|
|
549
|
-
|
|
550
|
-
|
|
551
|
-
|
|
552
|
-
|
|
553
|
-
|
|
554
|
-
|
|
555
|
-
|
|
578
|
+
* Launches a restart of a universe's live servers and returns its ID,
|
|
579
|
+
* which `list` reports while the restart runs. When no live server
|
|
580
|
+
* matches, Roblox records no restart and `id` is `undefined`.
|
|
581
|
+
*
|
|
582
|
+
* @example
|
|
583
|
+
* ```ts
|
|
584
|
+
* import { createFakeHttpClient } from "@bedrock-rbx/ocale/testing";
|
|
585
|
+
* import { UniversesClient } from "@bedrock-rbx/ocale/universes";
|
|
586
|
+
*
|
|
587
|
+
* const httpClient = createFakeHttpClient().mockResponse({
|
|
588
|
+
* body: {
|
|
589
|
+
* id: "00000000-0000-0000-0000-000000000000",
|
|
590
|
+
* instancesImpacted: 0,
|
|
591
|
+
* playersImpacted: 0,
|
|
592
|
+
* },
|
|
593
|
+
* status: 200,
|
|
594
|
+
* });
|
|
595
|
+
* const client = new UniversesClient({
|
|
596
|
+
* credential: { apiKey: "your-key", kind: "apiKey" },
|
|
597
|
+
* httpClient,
|
|
598
|
+
* });
|
|
599
|
+
*
|
|
600
|
+
* return client.restarts
|
|
601
|
+
* .launch({ bleedOffDurationMinutes: 5, universeId: "42" })
|
|
602
|
+
* .then((result) => {
|
|
603
|
+
* expect(result).toEqual({
|
|
604
|
+
* data: { id: undefined, instancesImpacted: 0, playersImpacted: 0 },
|
|
605
|
+
* success: true,
|
|
606
|
+
* });
|
|
607
|
+
* });
|
|
608
|
+
* ```
|
|
609
|
+
*
|
|
610
|
+
* @param parameters - The universe identifier.
|
|
611
|
+
* @param options - Optional per-request overrides.
|
|
612
|
+
* @returns A {@link Result} wrapping the {@link LaunchedRestart}, or
|
|
613
|
+
* the {@link OpenCloudError} that caused the request to fail.
|
|
614
|
+
*/
|
|
556
615
|
launch(parameters: LaunchRestartParameters, options?: RequestOptions): Promise<Result<LaunchedRestart, OpenCloudError>>;
|
|
557
616
|
/**
|
|
558
|
-
|
|
559
|
-
|
|
560
|
-
|
|
561
|
-
|
|
562
|
-
|
|
563
|
-
|
|
564
|
-
|
|
565
|
-
|
|
566
|
-
|
|
567
|
-
|
|
617
|
+
* Lists a universe's restarts with their progress per place. A
|
|
618
|
+
* `:restartServers` call that selected a server appears here too, but
|
|
619
|
+
* only `launch` returns the ID to match it by.
|
|
620
|
+
*
|
|
621
|
+
* @param parameters - The universe identifier.
|
|
622
|
+
* @param options - Optional per-request overrides.
|
|
623
|
+
* @returns A {@link Result} wrapping one {@link RestartStatus} per
|
|
624
|
+
* restart, or the {@link OpenCloudError} that caused the request to
|
|
625
|
+
* fail.
|
|
626
|
+
*/
|
|
568
627
|
list(parameters: ListRestartsParameters, options?: RequestOptions): Promise<Result<ReadonlyArray<RestartStatus>, OpenCloudError>>;
|
|
628
|
+
/**
|
|
629
|
+
* Restarts only the servers that run an older version of the given
|
|
630
|
+
* places, for example after a publish. It reads the forecast
|
|
631
|
+
* (`universe:read`), keeps each place with at least one outdated
|
|
632
|
+
* server, and sends one `:restartServers` call (`universe:write`) for
|
|
633
|
+
* them. When no place has an outdated server, it sends no restart.
|
|
634
|
+
*
|
|
635
|
+
* Roblox answers a 500 when any listed place has no live server, which
|
|
636
|
+
* happens when a place loses its last outdated server between the
|
|
637
|
+
* forecast and the restart. On that 500 it reads the forecast once more
|
|
638
|
+
* and sends one more restart for the places still outdated. A 502, 503
|
|
639
|
+
* or 504 on the restart is retried. The selection relies on the
|
|
640
|
+
* forecast's `instancesImpacted` counting only servers on an older
|
|
641
|
+
* version, which live captures show but Roblox does not document.
|
|
642
|
+
*
|
|
643
|
+
* @example
|
|
644
|
+
* ```ts
|
|
645
|
+
* import { createFakeHttpClient } from "@bedrock-rbx/ocale/testing";
|
|
646
|
+
* import { UniversesClient } from "@bedrock-rbx/ocale/universes";
|
|
647
|
+
*
|
|
648
|
+
* const httpClient = createFakeHttpClient()
|
|
649
|
+
* .mockResponse({
|
|
650
|
+
* body: {
|
|
651
|
+
* placeForecasts: {
|
|
652
|
+
* 111: {
|
|
653
|
+
* instancesImpacted: 2,
|
|
654
|
+
* instancesPerVersion: { 5: 2, 6: 1 },
|
|
655
|
+
* isNotInUniverse: false,
|
|
656
|
+
* latestPlaceVersion: "6",
|
|
657
|
+
* playersImpacted: 4,
|
|
658
|
+
* playersPerVersion: { 5: 4, 6: 1 },
|
|
659
|
+
* publishTime: "2026-04-24T02:36:28.673Z",
|
|
660
|
+
* totalInstances: 3,
|
|
661
|
+
* totalPlayers: 5,
|
|
662
|
+
* },
|
|
663
|
+
* },
|
|
664
|
+
* },
|
|
665
|
+
* status: 200,
|
|
666
|
+
* })
|
|
667
|
+
* .mockResponse({ body: {}, status: 200 });
|
|
668
|
+
* const client = new UniversesClient({
|
|
669
|
+
* credential: { apiKey: "your-key", kind: "apiKey" },
|
|
670
|
+
* httpClient,
|
|
671
|
+
* });
|
|
672
|
+
*
|
|
673
|
+
* return client.restarts
|
|
674
|
+
* .restartOutdated({ placeIds: ["111", "222"], universeId: "42" })
|
|
675
|
+
* .then((result) => {
|
|
676
|
+
* expect(result).toEqual({
|
|
677
|
+
* data: {
|
|
678
|
+
* places: [
|
|
679
|
+
* { instancesImpacted: 2, placeId: "111", restarted: true },
|
|
680
|
+
* { instancesImpacted: 0, placeId: "222", restarted: false },
|
|
681
|
+
* ],
|
|
682
|
+
* restarted: true,
|
|
683
|
+
* },
|
|
684
|
+
* success: true,
|
|
685
|
+
* });
|
|
686
|
+
* });
|
|
687
|
+
* ```
|
|
688
|
+
*
|
|
689
|
+
* @param parameters - The universe and the places to check.
|
|
690
|
+
* @param options - Optional per-request overrides, applied to every
|
|
691
|
+
* request.
|
|
692
|
+
* @returns A {@link Result} wrapping the {@link OutdatedRestart}, or
|
|
693
|
+
* the {@link OpenCloudError} that caused a request to fail.
|
|
694
|
+
*/
|
|
695
|
+
restartOutdated({ placeIds, universeId }: RestartOutdatedParameters, options?: RequestOptions): Promise<Result<OutdatedRestart, OpenCloudError>>;
|
|
569
696
|
}
|
|
570
|
-
//#endregion
|
|
571
|
-
//#region src/resources/universes/client.d.ts
|
|
572
697
|
interface UniverseIconHandle {
|
|
573
698
|
/**
|
|
574
|
-
|
|
575
|
-
|
|
576
|
-
|
|
577
|
-
|
|
578
|
-
|
|
579
|
-
|
|
580
|
-
|
|
581
|
-
|
|
582
|
-
|
|
583
|
-
|
|
584
|
-
|
|
699
|
+
* Deletes the localized icon registered against a universe for a given
|
|
700
|
+
* language. Removing the source-language icon is rejected server-side;
|
|
701
|
+
* consumers must replace it via {@link UniverseIconHandle.upload}
|
|
702
|
+
* instead.
|
|
703
|
+
*
|
|
704
|
+
* @param parameters - Universe and language identifiers of the icon to
|
|
705
|
+
* delete.
|
|
706
|
+
* @param options - Optional per-request overrides.
|
|
707
|
+
* @returns A success {@link Result} with no payload, or the
|
|
708
|
+
* {@link OpenCloudError} that caused the request to fail.
|
|
709
|
+
*/
|
|
585
710
|
delete: (parameters: DeleteExperienceIconParameters, options?: RequestOptions) => Promise<Result<undefined, OpenCloudError>>;
|
|
586
711
|
/**
|
|
587
|
-
|
|
588
|
-
|
|
589
|
-
|
|
590
|
-
|
|
591
|
-
|
|
592
|
-
|
|
593
|
-
|
|
594
|
-
|
|
595
|
-
|
|
712
|
+
* Lists every localized icon registered against an experience. The
|
|
713
|
+
* server returns one entry per locale that has an icon registered.
|
|
714
|
+
*
|
|
715
|
+
* @param parameters - Universe identifier whose icons to list.
|
|
716
|
+
* @param options - Optional per-request overrides.
|
|
717
|
+
* @returns A {@link Result} wrapping the parsed array of
|
|
718
|
+
* {@link ExperienceIcon} entries or the {@link OpenCloudError} that
|
|
719
|
+
* caused the request to fail.
|
|
720
|
+
*/
|
|
596
721
|
list: (parameters: ListExperienceIconsParameters, options?: RequestOptions) => Promise<Result<ReadonlyArray<ExperienceIcon>, OpenCloudError>>;
|
|
597
722
|
/**
|
|
598
|
-
|
|
599
|
-
|
|
600
|
-
|
|
601
|
-
|
|
602
|
-
|
|
603
|
-
|
|
604
|
-
|
|
605
|
-
|
|
606
|
-
|
|
607
|
-
|
|
608
|
-
|
|
609
|
-
|
|
610
|
-
|
|
611
|
-
|
|
723
|
+
* Uploads or replaces the localized icon for an experience. A
|
|
724
|
+
* subsequent upload for the same `(universeId, languageCode)` pair
|
|
725
|
+
* replaces the existing icon for that locale.
|
|
726
|
+
*
|
|
727
|
+
* No default request timeout applies to this upload; pass `options.timeout`
|
|
728
|
+
* to set a per-call deadline.
|
|
729
|
+
*
|
|
730
|
+
* @param parameters - Universe and language identifiers plus the image
|
|
731
|
+
* bytes to upload.
|
|
732
|
+
* @param options - Optional per-request overrides (e.g. A different
|
|
733
|
+
* {@link OpenCloudClientOptions.credential} for this call only).
|
|
734
|
+
* @returns A success {@link Result} with no payload, or the
|
|
735
|
+
* {@link OpenCloudError} that caused the request to fail.
|
|
736
|
+
*/
|
|
612
737
|
upload: (parameters: UploadExperienceIconParameters, options?: RequestOptions) => Promise<Result<undefined, OpenCloudError>>;
|
|
613
738
|
}
|
|
614
739
|
interface UniverseThumbnailsHandle {
|
|
615
740
|
/**
|
|
616
|
-
|
|
617
|
-
|
|
618
|
-
|
|
619
|
-
|
|
620
|
-
|
|
621
|
-
|
|
622
|
-
|
|
623
|
-
|
|
624
|
-
|
|
741
|
+
* Deletes a single thumbnail by media asset ID. Idempotent: deleting an
|
|
742
|
+
* already-removed thumbnail surfaces the server's 404 unchanged.
|
|
743
|
+
*
|
|
744
|
+
* @param parameters - Universe, language, and image identifiers of the
|
|
745
|
+
* thumbnail to delete.
|
|
746
|
+
* @param options - Optional per-request overrides.
|
|
747
|
+
* @returns A success {@link Result} with no payload, or the
|
|
748
|
+
* {@link OpenCloudError} that caused the request to fail.
|
|
749
|
+
*/
|
|
625
750
|
delete: (parameters: DeleteExperienceThumbnailParameters, options?: RequestOptions) => Promise<Result<undefined, OpenCloudError>>;
|
|
626
751
|
/**
|
|
627
|
-
|
|
628
|
-
|
|
629
|
-
|
|
630
|
-
|
|
631
|
-
|
|
632
|
-
|
|
633
|
-
|
|
634
|
-
|
|
635
|
-
|
|
636
|
-
|
|
637
|
-
|
|
752
|
+
* Reorders the localized thumbnail carousel. The supplied
|
|
753
|
+
* `orderedImageIds` describes the desired display order from first to
|
|
754
|
+
* last. Image IDs must be positive integers within the safe-integer
|
|
755
|
+
* range; invalid input is rejected with a {@link OpenCloudError} of
|
|
756
|
+
* kind `ValidationError` before any HTTP round-trip.
|
|
757
|
+
*
|
|
758
|
+
* @param parameters - Universe, language, and the desired display order.
|
|
759
|
+
* @param options - Optional per-request overrides.
|
|
760
|
+
* @returns A success {@link Result} with no payload, or the
|
|
761
|
+
* {@link OpenCloudError} that caused the request to fail.
|
|
762
|
+
*/
|
|
638
763
|
reorder: (parameters: ReorderExperienceThumbnailsParameters, options?: RequestOptions) => Promise<Result<undefined, OpenCloudError>>;
|
|
639
764
|
/**
|
|
640
|
-
|
|
641
|
-
|
|
642
|
-
|
|
643
|
-
|
|
644
|
-
|
|
645
|
-
|
|
646
|
-
|
|
647
|
-
|
|
648
|
-
|
|
649
|
-
|
|
650
|
-
|
|
651
|
-
|
|
652
|
-
|
|
653
|
-
|
|
654
|
-
|
|
765
|
+
* Uploads a new thumbnail and appends it to the localized carousel. Use
|
|
766
|
+
* {@link UniverseThumbnailsHandle.reorder} after multiple uploads to
|
|
767
|
+
* set the display order.
|
|
768
|
+
*
|
|
769
|
+
* No default request timeout applies to this upload; pass `options.timeout`
|
|
770
|
+
* to set a per-call deadline.
|
|
771
|
+
*
|
|
772
|
+
* @param parameters - Universe and language identifiers plus the image
|
|
773
|
+
* bytes to upload.
|
|
774
|
+
* @param options - Optional per-request overrides (e.g. A different
|
|
775
|
+
* {@link OpenCloudClientOptions.credential} for this call only).
|
|
776
|
+
* @returns A {@link Result} wrapping the parsed
|
|
777
|
+
* {@link UploadedExperienceThumbnail} or the {@link OpenCloudError}
|
|
778
|
+
* that caused the request to fail.
|
|
779
|
+
*/
|
|
655
780
|
upload: (parameters: UploadExperienceThumbnailParameters, options?: RequestOptions) => Promise<Result<UploadedExperienceThumbnail, OpenCloudError>>;
|
|
656
781
|
}
|
|
657
782
|
/**
|
|
658
|
-
* Public client for the Roblox Open Cloud `Universe` resource. Wires
|
|
659
|
-
* the request builders, the injected
|
|
660
|
-
* {@link OpenCloudClientOptions.httpClient}, and the response parser
|
|
661
|
-
* into a single ergonomic surface. Every method returns a
|
|
662
|
-
* {@link Result} so callers handle failure explicitly; no thrown
|
|
663
|
-
* {@link OpenCloudError} ever escapes the client.
|
|
664
|
-
*
|
|
665
|
-
* Partial updates use a Google-style `updateMask` query string derived
|
|
666
|
-
* from the keys present on the update parameters. Setting a clearable
|
|
667
|
-
* field (`privateServerPriceRobux` or any social link) to `undefined`
|
|
668
|
-
* sends JSON `null` for that field so the server clears the
|
|
669
|
-
* corresponding value.
|
|
670
|
-
*
|
|
671
|
-
* Localized experience-icon and experience-thumbnail Operations are
|
|
672
|
-
* bound on the {@link UniversesClient.icon} and
|
|
673
|
-
* {@link UniversesClient.thumbnails} Operation Groups so callers reach
|
|
674
|
-
* for one client per universe.
|
|
675
|
-
*
|
|
676
|
-
* @since 0.1.0
|
|
677
|
-
*
|
|
678
|
-
* @example
|
|
679
|
-
*
|
|
680
|
-
* ```ts
|
|
681
|
-
* import { UniversesClient } from "@bedrock-rbx/ocale/universes";
|
|
682
|
-
*
|
|
683
|
-
* const client = new UniversesClient({ apiKey: "your-key" });
|
|
684
|
-
* expect(client).toBeInstanceOf(UniversesClient);
|
|
685
|
-
* ```
|
|
686
|
-
*/
|
|
687
|
-
declare class UniversesClient {
|
|
783
|
+
* Public client for the Roblox Open Cloud `Universe` resource. Wires
|
|
784
|
+
* the request builders, the injected
|
|
785
|
+
* {@link OpenCloudClientOptions.httpClient}, and the response parser
|
|
786
|
+
* into a single ergonomic surface. Every method returns a
|
|
787
|
+
* {@link Result} so callers handle failure explicitly; no thrown
|
|
788
|
+
* {@link OpenCloudError} ever escapes the client.
|
|
789
|
+
*
|
|
790
|
+
* Partial updates use a Google-style `updateMask` query string derived
|
|
791
|
+
* from the keys present on the update parameters. Setting a clearable
|
|
792
|
+
* field (`privateServerPriceRobux` or any social link) to `undefined`
|
|
793
|
+
* sends JSON `null` for that field so the server clears the
|
|
794
|
+
* corresponding value.
|
|
795
|
+
*
|
|
796
|
+
* Localized experience-icon and experience-thumbnail Operations are
|
|
797
|
+
* bound on the {@link UniversesClient.icon} and
|
|
798
|
+
* {@link UniversesClient.thumbnails} Operation Groups so callers reach
|
|
799
|
+
* for one client per universe.
|
|
800
|
+
*
|
|
801
|
+
* @since 0.1.0
|
|
802
|
+
*
|
|
803
|
+
* @example
|
|
804
|
+
*
|
|
805
|
+
* ```ts
|
|
806
|
+
* import { UniversesClient } from "@bedrock-rbx/ocale/universes";
|
|
807
|
+
*
|
|
808
|
+
* const client = new UniversesClient({ credential: { apiKey: "your-key", kind: "apiKey" } });
|
|
809
|
+
* expect(client).toBeInstanceOf(UniversesClient);
|
|
810
|
+
* ```
|
|
811
|
+
*/
|
|
812
|
+
export declare class UniversesClient {
|
|
688
813
|
#private;
|
|
689
814
|
/**
|
|
690
|
-
|
|
691
|
-
|
|
692
|
-
|
|
693
|
-
|
|
694
|
-
|
|
815
|
+
* Operation Group exposing the localized experience-icon
|
|
816
|
+
* Operations (`upload`, `delete`, `list`) backed by the
|
|
817
|
+
* `legacy-game-internationalization` domain. Shares the parent
|
|
818
|
+
* client's HTTP, rate-limit, and retry plumbing.
|
|
819
|
+
*/
|
|
695
820
|
readonly icon: UniverseIconHandle;
|
|
696
821
|
/**
|
|
697
|
-
|
|
698
|
-
|
|
699
|
-
|
|
700
|
-
|
|
822
|
+
* Operation Group exposing the server-management restart Operations
|
|
823
|
+
* (`forecast`, `launch`, `list`, `restartOutdated`). `restartOutdated`
|
|
824
|
+
* also uses the universe `:restartServers` method. Shares the parent
|
|
825
|
+
* client's HTTP, rate-limit, and retry plumbing.
|
|
826
|
+
*/
|
|
701
827
|
readonly restarts: UniverseRestartsGroup;
|
|
702
828
|
/**
|
|
703
|
-
|
|
704
|
-
|
|
705
|
-
|
|
706
|
-
|
|
707
|
-
|
|
708
|
-
|
|
709
|
-
|
|
710
|
-
|
|
829
|
+
* Operation Group exposing the localized experience-thumbnail
|
|
830
|
+
* Operations (`upload`, `delete`, `reorder`) backed by the
|
|
831
|
+
* `legacy-game-internationalization` domain. No list-thumbnails
|
|
832
|
+
* endpoint is bridged; consumers must track uploaded
|
|
833
|
+
* `mediaAssetId`s in their own state store to reconcile against
|
|
834
|
+
* the existing carousel. Shares the parent client's HTTP,
|
|
835
|
+
* rate-limit, and retry plumbing.
|
|
836
|
+
*/
|
|
711
837
|
readonly thumbnails: UniverseThumbnailsHandle;
|
|
712
838
|
/**
|
|
713
|
-
|
|
714
|
-
|
|
715
|
-
|
|
716
|
-
|
|
717
|
-
|
|
718
|
-
|
|
839
|
+
* Creates a new {@link UniversesClient}. Configuration is frozen
|
|
840
|
+
* on construction; per-request overrides are accepted on each
|
|
841
|
+
* method.
|
|
842
|
+
*
|
|
843
|
+
* @param options - Client-level configuration including the API key.
|
|
844
|
+
*/
|
|
719
845
|
constructor(options: OpenCloudClientOptions);
|
|
720
846
|
/**
|
|
721
|
-
|
|
722
|
-
|
|
723
|
-
|
|
724
|
-
|
|
725
|
-
|
|
726
|
-
|
|
727
|
-
|
|
728
|
-
|
|
847
|
+
* Makes an experience public. The API key needs `legacy-universe:manage`.
|
|
848
|
+
* A missing content maturity rating can cause a misleading 403; complete
|
|
849
|
+
* the content questionnaire in Creator Hub before activating.
|
|
850
|
+
* On a 504, reads the universe's visibility and succeeds only if public.
|
|
851
|
+
* This verification needs permission to read the universe. Otherwise the
|
|
852
|
+
* original 504 is returned, leaving the outcome unconfirmed.
|
|
853
|
+
*
|
|
854
|
+
* @since 0.4.0
|
|
855
|
+
* @param parameters - The universe identifier.
|
|
856
|
+
* @param options - Optional per-request overrides.
|
|
857
|
+
* @returns A success Result with no payload, or the Open Cloud error.
|
|
858
|
+
*
|
|
859
|
+
* @example
|
|
860
|
+
*
|
|
861
|
+
* ```ts
|
|
862
|
+
* import { UniversesClient } from "@bedrock-rbx/ocale/universes";
|
|
863
|
+
* import { createFakeHttpClient } from "@bedrock-rbx/ocale/testing";
|
|
864
|
+
* const httpClient = createFakeHttpClient()
|
|
865
|
+
* .mockResponse({ body: {}, status: 200 });
|
|
866
|
+
* const client = new UniversesClient({
|
|
867
|
+
* credential: { apiKey: "your-key", kind: "apiKey" },
|
|
868
|
+
* httpClient,
|
|
869
|
+
* });
|
|
870
|
+
* const result = client.activate({ universeId: "123" });
|
|
871
|
+
* return expect(result).resolves.toEqual({ data: undefined, success: true });
|
|
872
|
+
* ```
|
|
873
|
+
*/
|
|
874
|
+
activate(parameters: ActivateUniverseParameters, options?: RequestOptions): Promise<Result<undefined, OpenCloudError>>;
|
|
875
|
+
/**
|
|
876
|
+
* Makes an experience private, including one that is already private.
|
|
877
|
+
* The API key needs `legacy-universe:manage`.
|
|
878
|
+
* On a 504, reads the universe's visibility and succeeds only if private.
|
|
879
|
+
* This verification needs permission to read the universe. Otherwise the
|
|
880
|
+
* original 504 is returned, leaving the outcome unconfirmed.
|
|
881
|
+
*
|
|
882
|
+
* @since 0.4.0
|
|
883
|
+
* @param parameters - The universe identifier.
|
|
884
|
+
* @param options - Optional per-request overrides.
|
|
885
|
+
* @returns A success Result with no payload, or the Open Cloud error.
|
|
886
|
+
*
|
|
887
|
+
* @example
|
|
888
|
+
*
|
|
889
|
+
* ```ts
|
|
890
|
+
* import { UniversesClient } from "@bedrock-rbx/ocale/universes";
|
|
891
|
+
* import { createFakeHttpClient } from "@bedrock-rbx/ocale/testing";
|
|
892
|
+
*
|
|
893
|
+
* const httpClient = createFakeHttpClient()
|
|
894
|
+
* .mockResponse({ body: {}, status: 200 });
|
|
895
|
+
* const client = new UniversesClient({
|
|
896
|
+
* credential: { apiKey: "your-key", kind: "apiKey" },
|
|
897
|
+
* httpClient,
|
|
898
|
+
* });
|
|
899
|
+
* const result = client.deactivate({ universeId: "123" });
|
|
900
|
+
* return expect(result).resolves.toEqual({ data: undefined, success: true });
|
|
901
|
+
* ```
|
|
902
|
+
*/
|
|
903
|
+
deactivate(parameters: DeactivateUniverseParameters, options?: RequestOptions): Promise<Result<undefined, OpenCloudError>>;
|
|
904
|
+
/**
|
|
905
|
+
* Fetches the current configuration of a universe.
|
|
906
|
+
*
|
|
907
|
+
* @param parameters - The universe identifier.
|
|
908
|
+
* @param options - Optional per-request overrides (e.g. A different
|
|
909
|
+
* {@link OpenCloudClientOptions.credential} for this call only).
|
|
910
|
+
* @returns A {@link Result} wrapping the parsed {@link Universe}
|
|
911
|
+
* or the {@link OpenCloudError} that caused the request to fail.
|
|
912
|
+
*/
|
|
729
913
|
get(parameters: GetUniverseParameters, options?: RequestOptions): Promise<Result<Universe, OpenCloudError>>;
|
|
730
914
|
/**
|
|
731
|
-
|
|
732
|
-
|
|
733
|
-
|
|
734
|
-
|
|
735
|
-
|
|
736
|
-
|
|
737
|
-
|
|
738
|
-
|
|
739
|
-
|
|
915
|
+
* Restarts the live servers of a universe so players move onto the
|
|
916
|
+
* latest published place versions.
|
|
917
|
+
*
|
|
918
|
+
* @param parameters - The universe identifier, plus optional place,
|
|
919
|
+
* version, and bleed-off selection.
|
|
920
|
+
* @param options - Optional per-request overrides.
|
|
921
|
+
* @returns A success {@link Result} with no payload, or the
|
|
922
|
+
* {@link OpenCloudError} that caused the request to fail.
|
|
923
|
+
*/
|
|
740
924
|
restartServers(parameters: RestartUniverseServersParameters, options?: RequestOptions): Promise<Result<undefined, OpenCloudError>>;
|
|
741
925
|
/**
|
|
742
|
-
|
|
743
|
-
|
|
744
|
-
|
|
745
|
-
|
|
746
|
-
|
|
747
|
-
|
|
748
|
-
|
|
749
|
-
|
|
750
|
-
|
|
751
|
-
|
|
752
|
-
|
|
753
|
-
|
|
926
|
+
* Partially updates a universe's configuration. The fields
|
|
927
|
+
* supplied on `parameters` (excluding `universeId`) are forwarded
|
|
928
|
+
* to the server via a Google-style `updateMask`; unmentioned
|
|
929
|
+
* fields are left untouched.
|
|
930
|
+
*
|
|
931
|
+
* @param parameters - The universe identifier and the fields to
|
|
932
|
+
* update. At least one updatable field must be supplied.
|
|
933
|
+
* @param options - Optional per-request overrides (e.g. A different
|
|
934
|
+
* {@link OpenCloudClientOptions.credential} for this call only).
|
|
935
|
+
* @returns A {@link Result} wrapping the parsed {@link Universe}
|
|
936
|
+
* or the {@link OpenCloudError} that caused the request to fail.
|
|
937
|
+
*/
|
|
754
938
|
update(parameters: UpdateUniverseParameters, options?: RequestOptions): Promise<Result<Universe, OpenCloudError>>;
|
|
755
939
|
}
|
|
756
|
-
|
|
757
|
-
export { type DeleteExperienceIconParameters, type DeleteExperienceThumbnailParameters, type ExperienceIcon, type ForecastRestartParameters, type GameIconState, type GetUniverseParameters, type LaunchRestartParameters, type LaunchedRestart, type ListExperienceIconsParameters, type ListRestartsParameters, type PlaceRestartForecast, type PlaceRestartStatus, type ReorderExperienceThumbnailsParameters, type RestartPlaceFilter, type RestartState, type RestartStatus, type RestartUniverseServersParameters, type SocialLink, type Universe, type UniverseAgeRating, type UniverseOwner, type UniverseVisibility, UniversesClient, type UpdateUniverseParameters, type UploadExperienceIconParameters, type UploadExperienceThumbnailParameters, type UploadedExperienceThumbnail };
|
|
940
|
+
export type { ActivateUniverseParameters, DeactivateUniverseParameters, DeleteExperienceIconParameters, DeleteExperienceThumbnailParameters, ExperienceIcon, ForecastRestartParameters, GameIconState, GetUniverseParameters, LaunchRestartParameters, LaunchedRestart, ListExperienceIconsParameters, ListRestartsParameters, OutdatedRestart, PlaceOutdatedRestart, PlaceRestartForecast, PlaceRestartStatus, ReorderExperienceThumbnailsParameters, RestartOutdatedParameters, RestartPlaceFilter, RestartState, RestartStatus, RestartUniverseServersParameters, SocialLink, Universe, UniverseAgeRating, UniverseOwner, UniverseVisibility, UpdateUniverseParameters, UploadExperienceIconParameters, UploadExperienceThumbnailParameters, UploadedExperienceThumbnail };
|
|
758
941
|
//# sourceMappingURL=universes.d.mts.map
|