@bedrock-rbx/ocale 0.1.0-beta.1

package/dist/universes.d.mts

@@ -0,0 +1,387 @@
+import { d as OpenCloudError, i as OpenCloudClientOptions, l as Result, s as RequestOptions } from "./types-YCTsM8Qd.mjs";
+
+//#region src/domains/cloud-v2/universes/types.d.ts
+/**
+* Caller-supplied input for the `get` method on `UniversesClient`.
+*/
+interface GetUniverseParameters {
+  /** Stringified ID of the universe to fetch. */
+  readonly universeId: string;
+}
+/**
+* A social link that may be associated with a universe.
+*/
+interface SocialLink {
+  /** Display title of the link. */
+  readonly title: string;
+  /** Destination URI. */
+  readonly uri: string;
+}
+/** Public visibility classification. */
+type UniverseVisibility = "private" | "public" | "unspecified";
+/**
+* Caller-supplied input for the `update` method on `UniversesClient`.
+* Every writable field is optional; presence of a key drives the
+* `updateMask` query string that the server uses as the field-mask for
+* the partial update. Absent keys are left untouched server-side.
+* Setting a key to `undefined` clears the corresponding server-side
+* value (applicable to `privateServerPriceRobux` and each optional
+* social link).
+*/
+interface UpdateUniverseParameters {
+  /** Whether console players can join. */
+  readonly consoleEnabled?: boolean;
+  /** Whether desktop players can join. */
+  readonly desktopEnabled?: boolean;
+  /** Discord social link block; `undefined` clears the server value. */
+  readonly discordSocialLink?: SocialLink | undefined;
+  /** Facebook social link block; `undefined` clears the server value. */
+  readonly facebookSocialLink?: SocialLink | undefined;
+  /** Guilded social link block; `undefined` clears the server value. */
+  readonly guildedSocialLink?: SocialLink | undefined;
+  /** Whether mobile players can join. */
+  readonly mobileEnabled?: boolean;
+  /** Private-server price in Robux; `undefined` disables private servers. */
+  readonly privateServerPriceRobux?: number | undefined;
+  /** Roblox Group social link block; `undefined` clears the server value. */
+  readonly robloxGroupSocialLink?: SocialLink | undefined;
+  /** Whether tablet players can join. */
+  readonly tabletEnabled?: boolean;
+  /** Twitch social link block; `undefined` clears the server value. */
+  readonly twitchSocialLink?: SocialLink | undefined;
+  /** Twitter social link block; `undefined` clears the server value. */
+  readonly twitterSocialLink?: SocialLink | undefined;
+  /** Stringified ID of the universe to update. */
+  readonly universeId: string;
+  /** Whether voice chat is enabled. */
+  readonly voiceChatEnabled?: boolean;
+  /** Whether VR players can join. */
+  readonly vrEnabled?: boolean;
+  /** Youtube social link block; `undefined` clears the server value. */
+  readonly youtubeSocialLink?: SocialLink | undefined;
+}
+/**
+* Discriminated-union representation of a universe's owner.
+*/
+interface UniverseOwner {
+  /**
+  * Stringified numeric owner ID, extracted from the wire
+  * `users/{id}` or `groups/{id}` resource path.
+  */
+  readonly id: string;
+  /** Whether the owner is a user or a group. */
+  readonly kind: "group" | "user";
+}
+/** Public age-rating classification. */
+type UniverseAgeRating = "9Plus" | "13Plus" | "17Plus" | "all" | "unspecified";
+/**
+* Parsed representation of a Roblox universe's configuration.
+*/
+interface Universe {
+  /** Stringified universe ID, extracted from the wire `path`. */
+  readonly id: string;
+  /** Age-rating classification. */
+  readonly ageRating: UniverseAgeRating;
+  /** Whether console players can join. */
+  readonly consoleEnabled: boolean;
+  /** Timestamp when the universe was created. */
+  readonly createdAt: Date;
+  /** Long-form description of the universe. */
+  readonly description: string;
+  /** Whether desktop players can join. */
+  readonly desktopEnabled: boolean;
+  /** Discord social link; `undefined` when absent. */
+  readonly discordSocialLink: SocialLink | undefined;
+  /** Display name of the universe. */
+  readonly displayName: string;
+  /** Facebook social link; `undefined` when absent. */
+  readonly facebookSocialLink: SocialLink | undefined;
+  /** Guilded social link; `undefined` when absent. */
+  readonly guildedSocialLink: SocialLink | undefined;
+  /** Whether mobile players can join. */
+  readonly mobileEnabled: boolean;
+  /** Owner of the universe (user or group). */
+  readonly owner: UniverseOwner;
+  /** Private server price in Robux; `undefined` when not supported. */
+  readonly privateServerPriceRobux: number | undefined;
+  /** Roblox Group social link; `undefined` when absent. */
+  readonly robloxGroupSocialLink: SocialLink | undefined;
+  /** Root place ID; `undefined` when the universe has no resolved root place. */
+  readonly rootPlaceId: string | undefined;
+  /** Whether tablet players can join. */
+  readonly tabletEnabled: boolean;
+  /** Twitch social link; `undefined` when absent. */
+  readonly twitchSocialLink: SocialLink | undefined;
+  /** Twitter social link; `undefined` when absent. */
+  readonly twitterSocialLink: SocialLink | undefined;
+  /** Timestamp of the most recent update. */
+  readonly updatedAt: Date;
+  /** Visibility classification. */
+  readonly visibility: UniverseVisibility;
+  /** Whether voice chat is enabled. */
+  readonly voiceChatEnabled: boolean;
+  /** Whether VR players can join. */
+  readonly vrEnabled: boolean;
+  /** Youtube social link; `undefined` when absent. */
+  readonly youtubeSocialLink: SocialLink | undefined;
+}
+//#endregion
+//#region src/domains/game-internationalization/game-icon/wire.d.ts
+/**
+* Image moderation state returned alongside each localized icon.
+*/
+type GameIconState = "Approved" | "Error" | "PendingReview" | "Rejected" | "UnAvailable";
+//#endregion
+//#region src/domains/game-internationalization/game-icon/types.d.ts
+/**
+* A localized icon entry returned by listing icons for an experience.
+*/
+interface ExperienceIcon {
+  /** Stringified ID of the uploaded icon image. */
+  readonly imageId: string;
+  /** CDN URL the icon can be loaded from. */
+  readonly imageUrl: string;
+  /** BCP-47 language code the icon is registered against (e.g. `en-us`). */
+  readonly languageCode: string;
+  /** Moderation state of the icon. */
+  readonly state: GameIconState;
+}
+/**
+* Parameters for uploading or replacing a localized experience icon. A
+* subsequent upload for the same `(universeId, languageCode)` pair replaces
+* the existing icon for that locale.
+*/
+interface UploadExperienceIconParameters {
+  /** Image bytes to upload. PNG and JPEG are accepted by the server. */
+  readonly image: Blob | Uint8Array;
+  /** BCP-47 language code the icon is being uploaded for (e.g. `en-us`). */
+  readonly languageCode: string;
+  /** Stringified ID of the universe whose icon is being uploaded. */
+  readonly universeId: string;
+}
+/**
+* Parameters for deleting the localized icon registered against a universe
+* for a given language.
+*/
+interface DeleteExperienceIconParameters {
+  /** BCP-47 language code of the icon to delete. */
+  readonly languageCode: string;
+  /** Stringified ID of the universe whose icon is being deleted. */
+  readonly universeId: string;
+}
+/**
+* Parameters for listing every localized icon registered against a universe.
+*/
+interface ListExperienceIconsParameters {
+  /** Stringified ID of the universe whose icons are being listed. */
+  readonly universeId: string;
+}
+//#endregion
+//#region src/domains/game-internationalization/game-thumbnails/types.d.ts
+/**
+* Result of uploading a localized experience thumbnail.
+*/
+interface UploadedExperienceThumbnail {
+  /** Stringified media asset ID of the uploaded thumbnail. */
+  readonly mediaAssetId: string;
+}
+/**
+* Parameters for uploading a new localized experience thumbnail. Each upload
+* appends a new entry to the carousel; reorder via {@link ReorderExperienceThumbnailsParameters}
+* after multiple uploads to set the display order.
+*/
+interface UploadExperienceThumbnailParameters {
+  /** Image bytes to upload. PNG and JPEG are accepted by the server. */
+  readonly image: Blob | Uint8Array;
+  /** BCP-47 language code the thumbnail is being uploaded for (e.g. `en-us`). */
+  readonly languageCode: string;
+  /** Stringified ID of the universe whose carousel is being appended to. */
+  readonly universeId: string;
+}
+/**
+* Parameters for deleting a single thumbnail by media asset ID.
+*/
+interface DeleteExperienceThumbnailParameters {
+  /** Stringified media asset ID of the thumbnail to delete. */
+  readonly imageId: string;
+  /** BCP-47 language code of the thumbnail to delete. */
+  readonly languageCode: string;
+  /** Stringified ID of the universe whose carousel is being modified. */
+  readonly universeId: string;
+}
+/**
+* Parameters for reordering the localized thumbnail carousel. The supplied
+* `orderedImageIds` describes the new display order from first to last.
+*/
+interface ReorderExperienceThumbnailsParameters {
+  /** BCP-47 language code of the carousel being reordered. */
+  readonly languageCode: string;
+  /** Stringified media asset IDs in the desired display order. */
+  readonly orderedImageIds: ReadonlyArray<string>;
+  /** Stringified ID of the universe whose carousel is being reordered. */
+  readonly universeId: string;
+}
+//#endregion
+//#region src/resources/universes/client.d.ts
+interface UniverseIconHandle {
+  /**
+  * Deletes the localized icon registered against a universe for a given
+  * language. Removing the source-language icon is rejected server-side;
+  * consumers must replace it via {@link UniverseIconHandle.upload}
+  * instead.
+  *
+  * @param parameters - Universe and language identifiers of the icon to
+  *   delete.
+  * @param options - Optional per-request overrides.
+  * @returns A success {@link Result} with no payload, or the
+  *   {@link OpenCloudError} that caused the request to fail.
+  */
+  delete: (parameters: DeleteExperienceIconParameters, options?: RequestOptions) => Promise<Result<undefined, OpenCloudError>>;
+  /**
+  * Lists every localized icon registered against an experience. The
+  * server returns one entry per locale that has an icon registered.
+  *
+  * @param parameters - Universe identifier whose icons to list.
+  * @param options - Optional per-request overrides.
+  * @returns A {@link Result} wrapping the parsed array of
+  *   {@link ExperienceIcon} entries or the {@link OpenCloudError} that
+  *   caused the request to fail.
+  */
+  list: (parameters: ListExperienceIconsParameters, options?: RequestOptions) => Promise<Result<ReadonlyArray<ExperienceIcon>, OpenCloudError>>;
+  /**
+  * Uploads or replaces the localized icon for an experience. A
+  * subsequent upload for the same `(universeId, languageCode)` pair
+  * replaces the existing icon for that locale.
+  *
+  * @param parameters - Universe and language identifiers plus the image
+  *   bytes to upload.
+  * @param options - Optional per-request overrides (e.g. A different
+  *   {@link OpenCloudClientOptions.apiKey} for this call only).
+  * @returns A success {@link Result} with no payload, or the
+  *   {@link OpenCloudError} that caused the request to fail.
+  */
+  upload: (parameters: UploadExperienceIconParameters, options?: RequestOptions) => Promise<Result<undefined, OpenCloudError>>;
+}
+interface UniverseThumbnailsHandle {
+  /**
+  * Deletes a single thumbnail by media asset ID. Idempotent: deleting an
+  * already-removed thumbnail surfaces the server's 404 unchanged.
+  *
+  * @param parameters - Universe, language, and image identifiers of the
+  *   thumbnail to delete.
+  * @param options - Optional per-request overrides.
+  * @returns A success {@link Result} with no payload, or the
+  *   {@link OpenCloudError} that caused the request to fail.
+  */
+  delete: (parameters: DeleteExperienceThumbnailParameters, options?: RequestOptions) => Promise<Result<undefined, OpenCloudError>>;
+  /**
+  * Reorders the localized thumbnail carousel. The supplied
+  * `orderedImageIds` describes the desired display order from first to
+  * last. Image IDs must be positive integers within the safe-integer
+  * range; invalid input is rejected with a {@link OpenCloudError} of
+  * kind `ValidationError` before any HTTP round-trip.
+  *
+  * @param parameters - Universe, language, and the desired display order.
+  * @param options - Optional per-request overrides.
+  * @returns A success {@link Result} with no payload, or the
+  *   {@link OpenCloudError} that caused the request to fail.
+  */
+  reorder: (parameters: ReorderExperienceThumbnailsParameters, options?: RequestOptions) => Promise<Result<undefined, OpenCloudError>>;
+  /**
+  * Uploads a new thumbnail and appends it to the localized carousel. Use
+  * {@link UniverseThumbnailsHandle.reorder} after multiple uploads to
+  * set the display order.
+  *
+  * @param parameters - Universe and language identifiers plus the image
+  *   bytes to upload.
+  * @param options - Optional per-request overrides (e.g. A different
+  *   {@link OpenCloudClientOptions.apiKey} for this call only).
+  * @returns A {@link Result} wrapping the parsed
+  *   {@link UploadedExperienceThumbnail} or the {@link OpenCloudError}
+  *   that caused the request to fail.
+  */
+  upload: (parameters: UploadExperienceThumbnailParameters, options?: RequestOptions) => Promise<Result<UploadedExperienceThumbnail, OpenCloudError>>;
+}
+/**
+* Public client for the Roblox Open Cloud `Universe` resource. Wires
+* the request builders, the injected
+* {@link OpenCloudClientOptions.httpClient}, and the response parser
+* into a single ergonomic surface. Every method returns a
+* {@link Result} so callers handle failure explicitly; no thrown
+* {@link OpenCloudError} ever escapes the client.
+*
+* Partial updates use a Google-style `updateMask` query string derived
+* from the keys present on the update parameters. Setting a clearable
+* field (`privateServerPriceRobux` or any social link) to `undefined`
+* sends JSON `null` for that field so the server clears the
+* corresponding value.
+*
+* Localized experience-icon and experience-thumbnail Operations are
+* bound on the {@link UniversesClient.icon} and
+* {@link UniversesClient.thumbnails} Operation Groups so callers reach
+* for one client per universe.
+*
+* @example
+*
+* ```ts
+* import { UniversesClient } from "@bedrock-rbx/ocale/universes";
+*
+* const client = new UniversesClient({ apiKey: "your-key" });
+* expect(client).toBeInstanceOf(UniversesClient);
+* ```
+*/
+declare class UniversesClient {
+  #private;
+  /**
+  * Operation Group exposing the localized experience-icon
+  * Operations (`upload`, `delete`, `list`) backed by the
+  * `legacy-game-internationalization` domain. Shares the parent
+  * client's HTTP, rate-limit, and retry plumbing.
+  */
+  readonly icon: UniverseIconHandle;
+  /**
+  * Operation Group exposing the localized experience-thumbnail
+  * Operations (`upload`, `delete`, `reorder`) backed by the
+  * `legacy-game-internationalization` domain. No list-thumbnails
+  * endpoint is bridged; consumers must track uploaded
+  * `mediaAssetId`s in their own state store to reconcile against
+  * the existing carousel. Shares the parent client's HTTP,
+  * rate-limit, and retry plumbing.
+  */
+  readonly thumbnails: UniverseThumbnailsHandle;
+  /**
+  * Creates a new {@link UniversesClient}. Configuration is frozen
+  * on construction; per-request overrides are accepted on each
+  * method.
+  *
+  * @param options - Client-level configuration including the API key.
+  */
+  constructor(options: OpenCloudClientOptions);
+  /**
+  * Fetches the current configuration of a universe.
+  *
+  * @param parameters - The universe identifier.
+  * @param options - Optional per-request overrides (e.g. A different
+  *   {@link OpenCloudClientOptions.apiKey} for this call only).
+  * @returns A {@link Result} wrapping the parsed {@link Universe}
+  *   or the {@link OpenCloudError} that caused the request to fail.
+  */
+  get(parameters: GetUniverseParameters, options?: RequestOptions): Promise<Result<Universe, OpenCloudError>>;
+  /**
+  * Partially updates a universe's configuration. The fields
+  * supplied on `parameters` (excluding `universeId`) are forwarded
+  * to the server via a Google-style `updateMask`; unmentioned
+  * fields are left untouched.
+  *
+  * @param parameters - The universe identifier and the fields to
+  *   update. At least one updatable field must be supplied.
+  * @param options - Optional per-request overrides (e.g. A different
+  *   {@link OpenCloudClientOptions.apiKey} for this call only).
+  * @returns A {@link Result} wrapping the parsed {@link Universe}
+  *   or the {@link OpenCloudError} that caused the request to fail.
+  */
+  update(parameters: UpdateUniverseParameters, options?: RequestOptions): Promise<Result<Universe, OpenCloudError>>;
+}
+//#endregion
+export { type DeleteExperienceIconParameters, type DeleteExperienceThumbnailParameters, type ExperienceIcon, type GameIconState, type GetUniverseParameters, type ListExperienceIconsParameters, type ReorderExperienceThumbnailsParameters, type SocialLink, type Universe, type UniverseAgeRating, type UniverseOwner, type UniverseVisibility, UniversesClient, type UpdateUniverseParameters, type UploadExperienceIconParameters, type UploadExperienceThumbnailParameters, type UploadedExperienceThumbnail };
+//# sourceMappingURL=universes.d.mts.map

package/dist/universes.d.mts.map

@@ -0,0 +1 @@
+{"version":3,"file":"universes.d.mts","names":[],"sources":["../src/domains/cloud-v2/universes/types.ts","../src/domains/game-internationalization/game-icon/wire.ts","../src/domains/game-internationalization/game-icon/types.ts","../src/domains/game-internationalization/game-thumbnails/types.ts","../src/resources/universes/client.ts"],"mappings":";;;;;;UAGiB,qBAAA;EAAA;EAAA,SAEP,UAAA;AAAA;;AAMV;;UAAiB,UAAA;EAAA;EAAA,SAEP,KAAA;EAMV;EAAA,SAJU,GAAA;AAAA;;KAIE,kBAAA;AAWZ;;;;;;;;;AAAA,UAAiB,wBAAA;;WAEP,cAAA;;WAEA,cAAA;;WAEA,iBAAA,GAAoB,UAAA;;WAEpB,kBAAA,GAAqB,UAAA;;WAErB,iBAAA,GAAoB,UAAA;;WAEpB,aAAA;;WAEA,uBAAA;;WAEA,qBAAA,GAAwB,UAAA;;WAExB,aAAA;;WAEA,gBAAA,GAAmB,UAAA;;WAEnB,iBAAA,GAAoB,UAAA;;WAEpB,UAAA;;WAEA,gBAAA;EAUV;EAAA,SARU,SAAA;;WAEA,iBAAA,GAAoB,UAAA;AAAA;AAiB9B;;;AAAA,UAXiB,aAAA;EAWL;AAKZ;;;EALY,SANF,EAAA;;WAEA,IAAA;AAAA;;KAIE,iBAAA;;;;UAKK,QAAA;;WAEP,EAAA;;WAEA,SAAA,EAAW,iBAAA;;WAEX,cAAA;;WAEA,SAAA,EAAW,IAAA;;WAEX,WAAA;;WAEA,cAAA;;WAEA,iBAAA,EAAmB,UAAA;;WAEnB,WAAA;;WAEA,kBAAA,EAAoB,UAAA;;WAEpB,iBAAA,EAAmB,UAAA;;WAEnB,aAAA;;WAEA,KAAA,EAAO,aAAA;;WAEP,uBAAA;;WAEA,qBAAA,EAAuB,UAAA;;WAEvB,WAAA;;WAEA,aAAA;;WAEA,gBAAA,EAAkB,UAAA;;WAElB,iBAAA,EAAmB,UAAA;;WAEnB,SAAA,EAAW,IAAA;;WAEX,UAAA,EAAY,kBAAA;EAMO;EAAA,SAJnB,gBAAA;;WAEA,SAAA;EC3HV;EAAA,SD6HU,iBAAA,EAAmB,UAAA;AAAA;;;;;;KC7HjB,aAAA;;;;ADAZ;;UEIiB,cAAA;EFJA;EAAA,SEMP,OAAA;EFEV;EAAA,SEAU,QAAA;;WAEA,YAAA;EFEA;EAAA,SEAA,KAAA,EAAO,aAAA;AAAA;;;;AFejB;;UEPiB,8BAAA;;WAEP,KAAA,EAAO,IAAA,GAAO,UAAA;;WAEd,YAAA;;WAEA,UAAA;AAAA;;;;;UAOO,8BAAA;;WAEP,YAAA;;WAEA,UAAA;AAAA;;;;UAMO,6BAAA;;WAEP,UAAA;AAAA;;;;;;UC7CO,2BAAA;EHAA;EAAA,SGEP,YAAA;AAAA;;AHMV;;;;UGEiB,mCAAA;EHMjB;EAAA,SGJU,KAAA,EAAO,IAAA,GAAO,UAAA;;WAEd,YAAA;EHEE;EAAA,SGAF,UAAA;AAAA;;;;UAMO,mCAAA;;WAEP,OAAA;;WAEA,YAAA;;WAEA,UAAA;AAAA;;;;;UAOO,qCAAA;;WAEP,YAAA;;WAEA,eAAA,EAAiB,aAAA;;WAEjB,UAAA;AAAA;;;UC2HA,kBAAA;EJlKA;AAMV;;;;;AAQA;;;;;AAWA;EIsJC,MAAA,GACC,UAAA,EAAY,8BAAA,EACZ,OAAA,GAAU,cAAA,KACN,OAAA,CAAQ,MAAA,YAAkB,cAAA;;;;;;;;;;;EAW/B,IAAA,GACC,UAAA,EAAY,6BAAA,EACZ,OAAA,GAAU,cAAA,KACN,OAAA,CAAQ,MAAA,CAAO,aAAA,CAAc,cAAA,GAAiB,cAAA;;;;;;;;;;;;;EAanD,MAAA,GACC,UAAA,EAAY,8BAAA,EACZ,OAAA,GAAU,cAAA,KACN,OAAA,CAAQ,MAAA,YAAkB,cAAA;AAAA;AAAA,UAGtB,wBAAA;;;;;;;;;AJtJV;;EIiKC,MAAA,GACC,UAAA,EAAY,mCAAA,EACZ,OAAA,GAAU,cAAA,KACN,OAAA,CAAQ,MAAA,YAAkB,cAAA;EJpKf;;AAWjB;;;;;AAKA;;;;;EIiKC,OAAA,GACC,UAAA,EAAY,qCAAA,EACZ,OAAA,GAAU,cAAA,KACN,OAAA,CAAQ,MAAA,YAAkB,cAAA;;;;;;;;;;;;;;EAc/B,MAAA,GACC,UAAA,EAAY,mCAAA,EACZ,OAAA,GAAU,cAAA,KACN,OAAA,CAAQ,MAAA,CAAO,2BAAA,EAA6B,cAAA;AAAA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;cA+BrC,eAAA;EAAA;;;;;;;WASI,IAAA,EAAM,kBAAA;EH5SX;;;;;;;ACIZ;;EDJY,SGsTK,UAAA,EAAY,wBAAA;EF1SZ;;;;;;;EEmThB,WAAA,CAAY,OAAA,EAAS,sBAAA;EF3StB;;;;;;;;;EE0TC,GAAA,CACC,UAAA,EAAY,qBAAA,EACZ,OAAA,GAAU,cAAA,GACR,OAAA,CAAQ,MAAA,CAAO,QAAA,EAAU,cAAA;EFvTnB;AAOV;;;;;AAUA;;;;;;;EEuTC,MAAA,CACC,UAAA,EAAY,wBAAA,EACZ,OAAA,GAAU,cAAA,GACR,OAAA,CAAQ,MAAA,CAAO,QAAA,EAAU,cAAA;AAAA"}