@minecraft/server-ui 2.1.0-beta.1.26.3-stable → 2.1.0-beta.1.26.30-preview.21

package/README.md

@@ -1,17 +1,17 @@
-# `@minecraft/server-ui`
-
-The `@minecraft/server-ui` module contains types for expressing simple dialog-based user experiences.
-
-
-
-  * [*@minecraft/server-ui.ActionFormData*](../../../scriptapi/minecraft/server-ui/ActionFormData.md) contain a list of buttons with captions and images that can be used for presenting a set of options to a player.
-
-  * [*@minecraft/server-ui.MessageFormData*](../../../scriptapi/minecraft/server-ui/MessageFormData.md) are simple two-button message experiences that are functional for Yes/No or OK/Cancel questions.
-
-  * [*@minecraft/server-ui.ModalFormData*](../../../scriptapi/minecraft/server-ui/ModalFormData.md) allow for a more flexible "questionnaire-style" list of controls that can be used to take input.
-
-## **NOTE: This version of this module is still in pre-release.  It may change or it may be removed in future releases.**
-
-See full documentation for this module here:
-
+# `@minecraft/server-ui`
+
+The `@minecraft/server-ui` module contains types for expressing simple dialog-based user experiences.
+
+
+
+  * [*@minecraft/server-ui.ActionFormData*](../../../scriptapi/minecraft/server-ui/ActionFormData.md) contain a list of buttons with captions and images that can be used for presenting a set of options to a player.
+
+  * [*@minecraft/server-ui.MessageFormData*](../../../scriptapi/minecraft/server-ui/MessageFormData.md) are simple two-button message experiences that are functional for Yes/No or OK/Cancel questions.
+
+  * [*@minecraft/server-ui.ModalFormData*](../../../scriptapi/minecraft/server-ui/ModalFormData.md) allow for a more flexible "questionnaire-style" list of controls that can be used to take input.
+
+## **NOTE: This version of this module is still in pre-release.  It may change or it may be removed in future releases.**
+
+See full documentation for this module here:
+
 https://learn.microsoft.com/en-us/minecraft/creator/scriptapi/minecraft/server-ui/minecraft-server-ui

package/index.d.ts

@@ -33,6 +33,36 @@
  */
 import * as minecraftcommon from '@minecraft/common';
 import * as minecraftserver from '@minecraft/server';
+/**
+ * @beta
+ * The reason why a data driven screen (i.e. MessageBox or
+ * CustomForm) was closed.
+ */
+export declare enum DataDrivenScreenClosedReason {
+    /**
+     * @remarks
+     * Closed because it was programmatically told by the server to
+     * close using `form.close()`.
+     *
+     */
+    ServerClose = 'ServerClose',
+    /**
+     * @remarks
+     * Closed because the user was busy (i.e. other UI was open).
+     *
+     */
+    UserBusy = 'UserBusy',
+    /**
+     * @remarks
+     * Closed because the client closed the form. This can be with
+     * a close button on the form (i.e. the X in the corner of a
+     * message box, the 'Close' button on a custom form, or either
+     * button in the message box)
+     *
+     */
+    UserClose = 'UserClose',
+}
+
 export enum FormCancelationReason {
     UserBusy = 'UserBusy',
     UserClosed = 'UserClosed',
@@ -44,33 +74,66 @@ export enum FormRejectReason {
     ServerShutdown = 'ServerShutdown',
 }
 
+/**
+ * @beta
+ * An enum representing the errors that can occur during text
+ * filtering. This is used to provide more context about the
+ * filtering process.
+ */
+export declare enum TextFilteringError {
+    /**
+     * @remarks
+     * The text was not filtered because the player disabled text
+     * filtering in their settings.
+     *
+     */
+    DisabledByPlayer = 'DisabledByPlayer',
+    /**
+     * @remarks
+     * The text was not filtered because the service is
+     * unreachable. This can occur if there are network issues or
+     * if the service is down for maintenance.
+     *
+     */
+    TextProcessorServiceUnreachable = 'TextProcessorServiceUnreachable',
+    /**
+     * @remarks
+     * An unknown error occurred during text filtering. This can
+     * occur if there is an unexpected issue with the text
+     * filtering service or if the service returns an error that is
+     * not categorized under the other error types.
+     *
+     */
+    Unknown = 'Unknown',
+}
+
 /**
  * Builds a simple player form with buttons that let the player
  * take action.
  * @example showActionForm.ts
  * ```typescript
- * import { world, DimensionLocation } from "@minecraft/server";
- * import { ActionFormData, ActionFormResponse } from "@minecraft/server-ui";
+ * import { world, DimensionLocation } from '@minecraft/server';
+ * import { ActionFormData, ActionFormResponse } from '@minecraft/server-ui';
  *
  * function showActionForm(log: (message: string, status?: number) => void, targetLocation: DimensionLocation) {
  *   const playerList = world.getPlayers();
  *
  *   if (playerList.length >= 1) {
  *     const form = new ActionFormData()
- *       .title("Test Title")
- *       .body("Body text here!")
- *       .button("btn 1")
- *       .button("btn 2")
- *       .button("btn 3")
- *       .button("btn 4")
- *       .button("btn 5");
+ *       .title('Test Title')
+ *       .body('Body text here!')
+ *       .button('btn 1')
+ *       .button('btn 2')
+ *       .button('btn 3')
+ *       .button('btn 4')
+ *       .button('btn 5');
  *
  *     form.show(playerList[0]).then((result: ActionFormResponse) => {
  *       if (result.canceled) {
- *         log("Player exited out of the dialog. Note that if the chat window is up, dialogs are automatically canceled.");
+ *         log('Player exited out of the dialog. Note that if the chat window is up, dialogs are automatically canceled.');
  *         return -1;
  *       } else {
- *         log("Your result was: " + result.selection);
+ *         log('Your result was: ' + result.selection);
  *       }
  *     });
  *   }
@@ -78,25 +141,25 @@ export enum FormRejectReason {
  * ```
  * @example showFavoriteMonth.ts
  * ```typescript
- * import { world, DimensionLocation } from "@minecraft/server";
- * import { ActionFormData, ActionFormResponse } from "@minecraft/server-ui";
+ * import { world, DimensionLocation } from '@minecraft/server';
+ * import { ActionFormData, ActionFormResponse } from '@minecraft/server-ui';
  *
  * function showFavoriteMonth(log: (message: string, status?: number) => void, targetLocation: DimensionLocation) {
  *   const players = world.getPlayers();
  *
  *   if (players.length >= 1) {
  *     const form = new ActionFormData()
- *       .title("Months")
- *       .body("Choose your favorite month!")
- *       .button("January")
- *       .button("February")
- *       .button("March")
- *       .button("April")
- *       .button("May");
+ *       .title('Months')
+ *       .body('Choose your favorite month!')
+ *       .button('January')
+ *       .button('February')
+ *       .button('March')
+ *       .button('April')
+ *       .button('May');
  *
  *     form.show(players[0]).then((response: ActionFormResponse) => {
  *       if (response.selection === 3) {
- *         log("I like April too!");
+ *         log('I like April too!');
  *         return -1;
  *       }
  *     });
@@ -172,28 +235,28 @@ export class ActionFormData {
  * form.
  * @example showActionForm.ts
  * ```typescript
- * import { world, DimensionLocation } from "@minecraft/server";
- * import { ActionFormData, ActionFormResponse } from "@minecraft/server-ui";
+ * import { world, DimensionLocation } from '@minecraft/server';
+ * import { ActionFormData, ActionFormResponse } from '@minecraft/server-ui';
  *
  * function showActionForm(log: (message: string, status?: number) => void, targetLocation: DimensionLocation) {
  *   const playerList = world.getPlayers();
  *
  *   if (playerList.length >= 1) {
  *     const form = new ActionFormData()
- *       .title("Test Title")
- *       .body("Body text here!")
- *       .button("btn 1")
- *       .button("btn 2")
- *       .button("btn 3")
- *       .button("btn 4")
- *       .button("btn 5");
+ *       .title('Test Title')
+ *       .body('Body text here!')
+ *       .button('btn 1')
+ *       .button('btn 2')
+ *       .button('btn 3')
+ *       .button('btn 4')
+ *       .button('btn 5');
  *
  *     form.show(playerList[0]).then((result: ActionFormResponse) => {
  *       if (result.canceled) {
- *         log("Player exited out of the dialog. Note that if the chat window is up, dialogs are automatically canceled.");
+ *         log('Player exited out of the dialog. Note that if the chat window is up, dialogs are automatically canceled.');
  *         return -1;
  *       } else {
- *         log("Your result was: " + result.selection);
+ *         log('Your result was: ' + result.selection);
  *       }
  *     });
  *   }
@@ -201,25 +264,25 @@ export class ActionFormData {
  * ```
  * @example showFavoriteMonth.ts
  * ```typescript
- * import { world, DimensionLocation } from "@minecraft/server";
- * import { ActionFormData, ActionFormResponse } from "@minecraft/server-ui";
+ * import { world, DimensionLocation } from '@minecraft/server';
+ * import { ActionFormData, ActionFormResponse } from '@minecraft/server-ui';
  *
  * function showFavoriteMonth(log: (message: string, status?: number) => void, targetLocation: DimensionLocation) {
  *   const players = world.getPlayers();
  *
  *   if (players.length >= 1) {
  *     const form = new ActionFormData()
- *       .title("Months")
- *       .body("Choose your favorite month!")
- *       .button("January")
- *       .button("February")
- *       .button("March")
- *       .button("April")
- *       .button("May");
+ *       .title('Months')
+ *       .body('Choose your favorite month!')
+ *       .button('January')
+ *       .button('February')
+ *       .button('March')
+ *       .button('April')
+ *       .button('May');
  *
  *     form.show(players[0]).then((response: ActionFormResponse) => {
  *       if (response.selection === 3) {
- *         log("I like April too!");
+ *         log('I like April too!');
  *         return -1;
  *       }
  *     });
@@ -238,6 +301,153 @@ export class ActionFormResponse extends FormResponse {
     readonly selection?: number;
 }
 
+/**
+ * @beta
+ * A customizable form that lets you put buttons, labels,
+ * toggles, dropdowns, sliders, and more into a form! Built on
+ * top of Observable, the form will update when the
+ * Observables' value changes.
+ */
+export declare class CustomForm {
+    /**
+     * @remarks
+     * Inserts a button into the Custom form. onClick is called
+     * when the button is pressed.
+     *
+     */
+    button(
+        label: Observable<string> | Observable<UIRawMessage> | string | UIRawMessage,
+        onClick: () => void,
+        options?: ButtonOptions,
+    ): CustomForm;
+    /**
+     * @remarks
+     * Tell the client to close the form. Throws an error if the
+     * form is not open.
+     *
+     */
+    close(): void;
+    /**
+     * @remarks
+     * Adds a close "X" button to the form.
+     *
+     */
+    closeButton(): CustomForm;
+    /**
+     * @remarks
+     * Inserts a divider (i.e. a line) into the Custom form.
+     *
+     */
+    divider(options?: DividerOptions): CustomForm;
+    /**
+     * @remarks
+     * Inserts a dropdown into the Custom form with the provided
+     * items. The value is based on the items value that selected.
+     *
+     */
+    dropdown(
+        label: Observable<string> | Observable<UIRawMessage> | string | UIRawMessage,
+        value: Observable<number>,
+        items: DropdownItem[],
+        options?: DropdownOptions,
+    ): CustomForm;
+    /**
+     * @remarks
+     * Inserts a header (i.e. large sized text) into the Custom
+     * form.
+     *
+     */
+    header(
+        text: Observable<string> | Observable<UIRawMessage> | string | UIRawMessage,
+        options?: TextOptions,
+    ): CustomForm;
+    /**
+     * @remarks
+     * Returns true if the form is currently being shown to the
+     * player.
+     *
+     */
+    isShowing(): boolean;
+    /**
+     * @remarks
+     * Inserts a label (i.e. medium sized text) into the Custom
+     * form.
+     *
+     */
+    label(
+        text: Observable<string> | Observable<UIRawMessage> | string | UIRawMessage,
+        options?: TextOptions,
+    ): CustomForm;
+    /**
+     * @remarks
+     * Shows the form to the player. Will return false if the
+     * client was busy (i.e. in another menu or this one is open).
+     * Will throw if the user disconnects.
+     *
+     * @throws
+     *  *
+     */
+    show(): Promise<DataDrivenScreenClosedReason>;
+    /**
+     * @remarks
+     * Creates a slider that lets players pick a number between
+     * minValue and maxValue. value must be client writable.
+     *
+     */
+    slider(
+        label: Observable<string> | Observable<UIRawMessage> | string | UIRawMessage,
+        value: Observable<number>,
+        minValue: Observable<number> | number,
+        maxValue: Observable<number> | number,
+        options?: SliderOptions,
+    ): CustomForm;
+    /**
+     * @remarks
+     * Inserts a space into the Custom form.
+     *
+     */
+    spacer(options?: SpacingOptions): CustomForm;
+    /**
+     * @remarks
+     * Inserts a text field into the Custom for that players can
+     * enter text into.
+     *
+     */
+    textField(
+        label: Observable<string> | Observable<UIRawMessage> | string | UIRawMessage,
+        text: Observable<string>,
+        options?: TextFieldOptions,
+    ): CustomForm;
+    /**
+     * @remarks
+     * Inserts an on/off toggle that players can interact with into
+     * the Custom form.
+     *
+     */
+    toggle(
+        label: Observable<string> | Observable<UIRawMessage> | string | UIRawMessage,
+        toggled: Observable<boolean>,
+        options?: ToggleOptions,
+    ): CustomForm;
+    /**
+     * @remarks
+     * Creates a Custom form to show to the player. Use this
+     * instead of a constructor.
+     *
+     */
+    static create(
+        player: minecraftserver.Player,
+        title: Observable<string> | Observable<UIRawMessage> | string | UIRawMessage,
+    ): CustomForm;
+}
+
+/**
+ * @beta
+ * Thrown when attempting to close a DDUI form that isn't open.
+ */
+// @ts-ignore Class inheritance allowed for native defined classes
+export declare class FormCloseError extends Error {}
+
 /**
  * Base type for a form response.
  */
@@ -258,24 +468,86 @@ export class FormResponse {
     readonly canceled: boolean;
 }
 
+/**
+ * @beta
+ * A simple message form UI, 2 buttons and a text body.
+ */
+export declare class MessageBox {
+    /**
+     * @remarks
+     * Sets the data for the text in the body of the message box.
+     * It is contained within a scroll view to allow for lots of
+     * text.
+     *
+     */
+    body(text: Observable<string> | Observable<UIRawMessage> | string | UIRawMessage): MessageBox;
+    /**
+     * @remarks
+     * Sets the data for the top button in the message box.
+     *
+     */
+    button1(
+        label: Observable<string> | Observable<UIRawMessage> | string | UIRawMessage,
+        tooltip?: Observable<string> | Observable<UIRawMessage> | string | UIRawMessage,
+    ): MessageBox;
+    /**
+     * @remarks
+     * Sets the data for the bottom button in the message box.
+     *
+     */
+    button2(
+        label: Observable<string> | Observable<UIRawMessage> | string | UIRawMessage,
+        tooltip?: Observable<string> | Observable<UIRawMessage> | string | UIRawMessage,
+    ): MessageBox;
+    /**
+     * @remarks
+     * Tell the client to close the message box. Throws {@link
+     * FormCloseError} if the message box is not open.
+     *
+     */
+    close(): void;
+    /**
+     * @remarks
+     * Returns true if the message box is currently being shown to
+     * the player.
+     *
+     */
+    isShowing(): boolean;
+    /**
+     * @remarks
+     * Show this message box to the player. Will return a result
+     * even if the client was busy (i.e. in another menu). Will
+     * throw if the user disconnects.
+     *
+     */
+    show(): Promise<MessageBoxResult>;
+    /**
+     * @remarks
+     * Creates a message box for a certain player. Use this instead
+     * of a constructor.
+     *
+     */
+    static create(
+        player: minecraftserver.Player,
+        title: Observable<string> | Observable<UIRawMessage> | string | UIRawMessage,
+    ): MessageBox;
+}
+
 /**
  * Builds a simple two-button modal dialog.
  * @example showBasicMessageForm.ts
  * ```typescript
- * import { world, DimensionLocation } from "@minecraft/server";
- * import { MessageFormResponse, MessageFormData } from "@minecraft/server-ui";
+ * import { world, DimensionLocation } from '@minecraft/server';
+ * import { MessageFormResponse, MessageFormData } from '@minecraft/server-ui';
  *
- * function showBasicMessageForm(
- *   log: (message: string, status?: number) => void,
- *   targetLocation: DimensionLocation
- * ) {
+ * function showBasicMessageForm(log: (message: string, status?: number) => void, targetLocation: DimensionLocation) {
  *   const players = world.getPlayers();
  *
  *   const messageForm = new MessageFormData()
- *     .title("Message Form Example")
- *     .body("This shows a simple example using §o§7MessageFormData§r.")
- *     .button1("Button 1")
- *     .button2("Button 2");
+ *     .title('Message Form Example')
+ *     .body('This shows a simple example using §o§7MessageFormData§r.')
+ *     .button1('Button 1')
+ *     .button2('Button 2');
  *
  *   messageForm
  *     .show(players[0])
@@ -285,30 +557,27 @@ export class FormResponse {
  *         return;
  *       }
  *
- *       log(`You selected ${formData.selection === 0 ? "Button 1" : "Button 2"}`);
+ *       log(`You selected ${formData.selection === 0 ? 'Button 1' : 'Button 2'}`);
  *     })
  *     .catch((error: Error) => {
- *       log("Failed to show form: " + error);
+ *       log('Failed to show form: ' + error);
  *       return -1;
  *     });
  * }
  * ```
  * @example showTranslatedMessageForm.ts
  * ```typescript
- * import { world, DimensionLocation } from "@minecraft/server";
- * import { MessageFormResponse, MessageFormData } from "@minecraft/server-ui";
+ * import { world, DimensionLocation } from '@minecraft/server';
+ * import { MessageFormResponse, MessageFormData } from '@minecraft/server-ui';
  *
- * function showTranslatedMessageForm(
- *   log: (message: string, status?: number) => void,
- *   targetLocation: DimensionLocation
- * ) {
+ * function showTranslatedMessageForm(log: (message: string, status?: number) => void, targetLocation: DimensionLocation) {
  *   const players = world.getPlayers();
  *
  *   const messageForm = new MessageFormData()
- *     .title({ translate: "permissions.removeplayer" })
- *     .body({ translate: "accessibility.list.or.two", with: ["Player 1", "Player 2"] })
- *     .button1("Player 1")
- *     .button2("Player 2");
+ *     .title({ translate: 'permissions.removeplayer' })
+ *     .body({ translate: 'accessibility.list.or.two', with: ['Player 1', 'Player 2'] })
+ *     .button1('Player 1')
+ *     .button2('Player 2');
  *
  *   messageForm
  *     .show(players[0])
@@ -318,10 +587,10 @@ export class FormResponse {
  *         return;
  *       }
  *
- *       log(`You selected ${formData.selection === 0 ? "Player 1" : "Player 2"}`);
+ *       log(`You selected ${formData.selection === 0 ? 'Player 1' : 'Player 2'}`);
  *     })
  *     .catch((error: Error) => {
- *       log("Failed to show form: " + error);
+ *       log('Failed to show form: ' + error);
  *       return -1;
  *     });
  * }
@@ -380,20 +649,17 @@ export class MessageFormData {
  * form.
  * @example showBasicMessageForm.ts
  * ```typescript
- * import { world, DimensionLocation } from "@minecraft/server";
- * import { MessageFormResponse, MessageFormData } from "@minecraft/server-ui";
+ * import { world, DimensionLocation } from '@minecraft/server';
+ * import { MessageFormResponse, MessageFormData } from '@minecraft/server-ui';
  *
- * function showBasicMessageForm(
- *   log: (message: string, status?: number) => void,
- *   targetLocation: DimensionLocation
- * ) {
+ * function showBasicMessageForm(log: (message: string, status?: number) => void, targetLocation: DimensionLocation) {
  *   const players = world.getPlayers();
  *
  *   const messageForm = new MessageFormData()
- *     .title("Message Form Example")
- *     .body("This shows a simple example using §o§7MessageFormData§r.")
- *     .button1("Button 1")
- *     .button2("Button 2");
+ *     .title('Message Form Example')
+ *     .body('This shows a simple example using §o§7MessageFormData§r.')
+ *     .button1('Button 1')
+ *     .button2('Button 2');
  *
  *   messageForm
  *     .show(players[0])
@@ -403,30 +669,27 @@ export class MessageFormData {
  *         return;
  *       }
  *
- *       log(`You selected ${formData.selection === 0 ? "Button 1" : "Button 2"}`);
+ *       log(`You selected ${formData.selection === 0 ? 'Button 1' : 'Button 2'}`);
  *     })
  *     .catch((error: Error) => {
- *       log("Failed to show form: " + error);
+ *       log('Failed to show form: ' + error);
  *       return -1;
  *     });
  * }
  * ```
  * @example showTranslatedMessageForm.ts
  * ```typescript
- * import { world, DimensionLocation } from "@minecraft/server";
- * import { MessageFormResponse, MessageFormData } from "@minecraft/server-ui";
+ * import { world, DimensionLocation } from '@minecraft/server';
+ * import { MessageFormResponse, MessageFormData } from '@minecraft/server-ui';
  *
- * function showTranslatedMessageForm(
- *   log: (message: string, status?: number) => void,
- *   targetLocation: DimensionLocation
- * ) {
+ * function showTranslatedMessageForm(log: (message: string, status?: number) => void, targetLocation: DimensionLocation) {
  *   const players = world.getPlayers();
  *
  *   const messageForm = new MessageFormData()
- *     .title({ translate: "permissions.removeplayer" })
- *     .body({ translate: "accessibility.list.or.two", with: ["Player 1", "Player 2"] })
- *     .button1("Player 1")
- *     .button2("Player 2");
+ *     .title({ translate: 'permissions.removeplayer' })
+ *     .body({ translate: 'accessibility.list.or.two', with: ['Player 1', 'Player 2'] })
+ *     .button1('Player 1')
+ *     .button2('Player 2');
  *
  *   messageForm
  *     .show(players[0])
@@ -436,10 +699,10 @@ export class MessageFormData {
  *         return;
  *       }
  *
- *       log(`You selected ${formData.selection === 0 ? "Player 1" : "Player 2"}`);
+ *       log(`You selected ${formData.selection === 0 ? 'Player 1' : 'Player 2'}`);
  *     })
  *     .catch((error: Error) => {
- *       log("Failed to show form: " + error);
+ *       log('Failed to show form: ' + error);
  *       return -1;
  *     });
  * }
@@ -461,33 +724,33 @@ export class MessageFormResponse extends FormResponse {
  * player.
  * @example showBasicModalForm.ts
  * ```typescript
- * import { world, DimensionLocation } from "@minecraft/server";
- * import { ModalFormData } from "@minecraft/server-ui";
+ * import { world, DimensionLocation } from '@minecraft/server';
+ * import { ModalFormData } from '@minecraft/server-ui';
  *
  * function showBasicModalForm(log: (message: string, status?: number) => void, targetLocation: DimensionLocation) {
  *   const players = world.getPlayers();
  *
- *   const modalForm = new ModalFormData().title("Example Modal Controls for §o§7ModalFormData§r");
+ *   const modalForm = new ModalFormData().title('Example Modal Controls for §o§7ModalFormData§r');
  *
- *   modalForm.toggle("Toggle w/o default");
- *   modalForm.toggle("Toggle w/ default", true);
+ *   modalForm.toggle('Toggle w/o default');
+ *   modalForm.toggle('Toggle w/ default', true);
  *
- *   modalForm.slider("Slider w/o default", 0, 50, 5);
- *   modalForm.slider("Slider w/ default", 0, 50, 5, 30);
+ *   modalForm.slider('Slider w/o default', 0, 50, 5);
+ *   modalForm.slider('Slider w/ default', 0, 50, 5, 30);
  *
- *   modalForm.dropdown("Dropdown w/o default", ["option 1", "option 2", "option 3"]);
- *   modalForm.dropdown("Dropdown w/ default", ["option 1", "option 2", "option 3"], 2);
+ *   modalForm.dropdown('Dropdown w/o default', ['option 1', 'option 2', 'option 3']);
+ *   modalForm.dropdown('Dropdown w/ default', ['option 1', 'option 2', 'option 3'], 2);
  *
- *   modalForm.textField("Input w/o default", "type text here");
- *   modalForm.textField("Input w/ default", "type text here", "this is default");
+ *   modalForm.textField('Input w/o default', 'type text here');
+ *   modalForm.textField('Input w/ default', 'type text here', 'this is default');
  *
  *   modalForm
  *     .show(players[0])
- *     .then((formData) => {
+ *     .then(formData => {
  *       players[0].sendMessage(`Modal form results: ${JSON.stringify(formData.formValues, undefined, 2)}`);
  *     })
  *     .catch((error: Error) => {
- *       log("Failed to show form: " + error);
+ *       log('Failed to show form: ' + error);
  *       return -1;
  *     });
  * }
@@ -609,33 +872,33 @@ export class ModalFormData {
  * Returns data about player responses to a modal form.
  * @example showBasicModalForm.ts
  * ```typescript
- * import { world, DimensionLocation } from "@minecraft/server";
- * import { ModalFormData } from "@minecraft/server-ui";
+ * import { world, DimensionLocation } from '@minecraft/server';
+ * import { ModalFormData } from '@minecraft/server-ui';
  *
  * function showBasicModalForm(log: (message: string, status?: number) => void, targetLocation: DimensionLocation) {
  *   const players = world.getPlayers();
  *
- *   const modalForm = new ModalFormData().title("Example Modal Controls for §o§7ModalFormData§r");
+ *   const modalForm = new ModalFormData().title('Example Modal Controls for §o§7ModalFormData§r');
  *
- *   modalForm.toggle("Toggle w/o default");
- *   modalForm.toggle("Toggle w/ default", true);
+ *   modalForm.toggle('Toggle w/o default');
+ *   modalForm.toggle('Toggle w/ default', true);
  *
- *   modalForm.slider("Slider w/o default", 0, 50, 5);
- *   modalForm.slider("Slider w/ default", 0, 50, 5, 30);
+ *   modalForm.slider('Slider w/o default', 0, 50, 5);
+ *   modalForm.slider('Slider w/ default', 0, 50, 5, 30);
  *
- *   modalForm.dropdown("Dropdown w/o default", ["option 1", "option 2", "option 3"]);
- *   modalForm.dropdown("Dropdown w/ default", ["option 1", "option 2", "option 3"], 2);
+ *   modalForm.dropdown('Dropdown w/o default', ['option 1', 'option 2', 'option 3']);
+ *   modalForm.dropdown('Dropdown w/ default', ['option 1', 'option 2', 'option 3'], 2);
  *
- *   modalForm.textField("Input w/o default", "type text here");
- *   modalForm.textField("Input w/ default", "type text here", "this is default");
+ *   modalForm.textField('Input w/o default', 'type text here');
+ *   modalForm.textField('Input w/ default', 'type text here', 'this is default');
  *
  *   modalForm
  *     .show(players[0])
- *     .then((formData) => {
+ *     .then(formData => {
  *       players[0].sendMessage(`Modal form results: ${JSON.stringify(formData.formValues, undefined, 2)}`);
  *     })
  *     .catch((error: Error) => {
- *       log("Failed to show form: " + error);
+ *       log('Failed to show form: ' + error);
  *       return -1;
  *     });
  * }
@@ -653,6 +916,84 @@ export class ModalFormResponse extends FormResponse {
     readonly formValues?: (boolean | number | string | undefined)[];
 }
 
+/**
+ * @beta
+ * A class that represents data that can be Observed.
+ * Extensively used for UI.
+ */
+export declare class Observable<T extends string | number | boolean | UIRawMessage> {
+    /**
+     * @remarks
+     * Gets the data from the Observable.
+     *
+     */
+    getData(): T;
+    /**
+     * @remarks
+     * Gets filtered data from the Observable (only available for
+     * strings). In case of failure, it will return an array of
+     * TextFilteringError that can provide more context about the
+     * filtering process. For testing purposes, the options are
+     * available under "Creator -> Text Filtering" settings menu.
+     * This delay is only applied to the getFilteredText function
+     * and can be used to simulate network latency when testing.
+     *
+     */
+    getFilteredText(
+        this: Observable<T & string>,
+        player: minecraftserver.Player,
+    ): Promise<string | TextFilteringError[]>;
+    /**
+     * @remarks
+     * Sets the data on this Observable and notifies the
+     * subscribers.
+     *
+     */
+    setData(data: T): void;
+    /**
+     * @remarks
+     * Subscribes a callback to any changes that occur to the
+     * Observable. The return value can be passed into the
+     * `unsubscribe` function to stop listening to changes.
+     *
+     */
+    subscribe(listener: (newValue: T) => void): (newValue: T) => void;
+    toJSON(): unknown;
+    /**
+     * @remarks
+     * Unsubscribe a callback from any changes that occur to the
+     * Observable. This takes the return value from the `subscribe`
+     * function.
+     *
+     */
+    unsubscribe(listener: (newValue: T) => void): void;
+    /**
+     * @remarks
+     * Creates an Observable, use this instead of a constructor.
+     *
+     */
+    static create<T extends string | number | boolean | UIRawMessage>(
+        data: T,
+        options?: ObservableOptions,
+    ): Observable<T>;
+}
+
+/**
+ * @beta
+ * Thrown when a DDUI screen is rejected because the player
+ * left before responding.
+ */
+// @ts-ignore Class inheritance allowed for native defined classes
+export declare class PlayerLeftError extends Error {}
+
+/**
+ * @beta
+ * Thrown when a DDUI screen is rejected because the server is
+ * shutting down.
+ */
+// @ts-ignore Class inheritance allowed for native defined classes
+export declare class ServerShutdownError extends Error {}
+
 export class UIManager {
     private constructor();
     /**
@@ -664,6 +1005,116 @@ export class UIManager {
     closeAllForms(player: minecraftserver.Player): void;
 }
 
+/**
+ * @beta
+ * The options for including a button in {@link CustomForm}.
+ */
+export interface ButtonOptions {
+    /**
+     * @remarks
+     * Whether or not this button is disabled.
+     *
+     */
+    disabled?: Observable<boolean> | boolean;
+    /**
+     * @remarks
+     * The tooltip for this button, shown when hovering the button.
+     *
+     */
+    tooltip?: Observable<string> | Observable<UIRawMessage> | string | UIRawMessage;
+    /**
+     * @remarks
+     * Whether or not this button is visible.
+     *
+     */
+    visible?: Observable<boolean> | boolean;
+}
+
+/**
+ * @beta
+ * The options for including a spacer in {@link CustomForm}.
+ */
+export interface DividerOptions {
+    /**
+     * @remarks
+     * Whether or not this divider is visible
+     *
+     */
+    visible?: Observable<boolean> | boolean;
+}
+
+/**
+ * @beta
+ * Dropdown data for use in {@link CustomForm}.
+ */
+export interface DropdownItem {
+    /**
+     * @remarks
+     * The description of the dropdown item shown when it is
+     * selected.
+     *
+     */
+    description?: UIRawMessage | string;
+    /**
+     * @remarks
+     * The label of the dropdown item in the dropdown.
+     *
+     */
+    label: UIRawMessage | string;
+    /**
+     * @remarks
+     * The value the dropdown will be set to when this item is
+     * selected.
+     *
+     */
+    value: number;
+}
+
+/**
+ * @beta
+ * The options for including a dropdown in {@link CustomForm}.
+ */
+export interface DropdownOptions {
+    /**
+     * @remarks
+     * The description of the dropdown, shown in the UI.
+     *
+     */
+    description?: Observable<string> | string | UIRawMessage;
+    /**
+     * @remarks
+     * Whether or not this dropdown is disabled.
+     *
+     */
+    disabled?: Observable<boolean> | boolean;
+    /**
+     * @remarks
+     * Whether or not this dropdown is visible.
+     *
+     */
+    visible?: Observable<boolean> | boolean;
+}
+
+/**
+ * @beta
+ * The result when a {@link MessageBox} is closed.
+ */
+export interface MessageBoxResult {
+    /**
+     * @remarks
+     * The reason the message box was closed.
+     *
+     */
+    closeReason: DataDrivenScreenClosedReason;
+    /**
+     * @remarks
+     * The button that was selected, undefined if it was closed
+     * without pressing a button.
+     *
+     */
+    selection?: number;
+}
+
 /**
  * An interface that is passed into {@link
  * @minecraft/Server-ui.ModalFormData.dropdown} to provide
@@ -756,6 +1207,168 @@ export interface ModalFormDataToggleOptions {
     tooltip?: minecraftserver.RawMessage | string;
 }
 
+/**
+ * @beta
+ * An interface passed into `Observable.create`.
+ */
+export interface ObservableOptions {
+    /**
+     * @remarks
+     * If set to true, the client can update this value. This
+     * should be used for things like dropdown values, toggles,
+     * textfields, etc. If unset or false, the client cannot write
+     * to this observable.
+     *
+     */
+    clientWritable?: boolean;
+}
+
+/**
+ * @beta
+ * The options for including a slider in {@link CustomForm}.
+ */
+export interface SliderOptions {
+    /**
+     * @remarks
+     * The description of the slider, shown in the UI.
+     *
+     */
+    description?: Observable<string> | Observable<UIRawMessage> | string | UIRawMessage;
+    /**
+     * @remarks
+     * Whether or not this slider is disabled.
+     *
+     */
+    disabled?: Observable<boolean> | boolean;
+    /**
+     * @remarks
+     * The step size of the slider. For example, if this is 2 and
+     * the min is 0 and the max is 10, the only selectable values
+     * will be 0, 2, 4, 6, 8, 10.
+     *
+     */
+    step?: Observable<number> | number;
+    /**
+     * @remarks
+     * Whether or not this slider is visible.
+     *
+     */
+    visible?: Observable<boolean> | boolean;
+}
+
+/**
+ * @beta
+ * The options for including a spacer in {@link CustomForm}.
+ */
+export interface SpacingOptions {
+    /**
+     * @remarks
+     * Whether or not this spacer is visible
+     *
+     */
+    visible?: Observable<boolean> | boolean;
+}
+
+/**
+ * @beta
+ * The options for including a textfield in {@link CustomForm}.
+ */
+export interface TextFieldOptions {
+    /**
+     * @remarks
+     * The description for this text field, shown in the UI.
+     *
+     */
+    description?: Observable<string> | Observable<UIRawMessage> | string | UIRawMessage;
+    /**
+     * @remarks
+     * Whether or not this text field is disabled.
+     *
+     */
+    disabled?: Observable<boolean> | boolean;
+    /**
+     * @remarks
+     * Whether or not this text field is visible.
+     *
+     */
+    visible?: Observable<boolean> | boolean;
+}
+
+/**
+ * @beta
+ * The options for including a label or header in {@link
+ * CustomForm}.
+ */
+export interface TextOptions {
+    /**
+     * @remarks
+     * Whether or not this label is visible
+     *
+     */
+    visible?: Observable<boolean> | boolean;
+}
+
+/**
+ * @beta
+ * The options for including a toggle in {@link CustomForm}.
+ */
+export interface ToggleOptions {
+    /**
+     * @remarks
+     * The description for this toggle, shown in the UI.
+     *
+     */
+    description?: Observable<string> | Observable<UIRawMessage> | string | UIRawMessage;
+    /**
+     * @remarks
+     * Whether or not this toggle is disabled.
+     *
+     */
+    disabled?: Observable<boolean> | boolean;
+    /**
+     * @remarks
+     * Whether or not this toggle is visible.
+     *
+     */
+    visible?: Observable<boolean> | boolean;
+}
+
+/**
+ * @beta
+ * A message that can be sent to the client. This is a subset
+ * of the RawMessage type, and is used for UI messages.
+ */
+export interface UIRawMessage {
+    /**
+     * @remarks
+     * Provides a raw-text equivalent of the current message.
+     *
+     */
+    rawtext?: UIRawMessage[];
+    /**
+     * @remarks
+     * Provides a string literal value to use.
+     *
+     */
+    text?: string;
+    /**
+     * @remarks
+     * Provides a translation token where, if the client has an
+     * available resource in the players' language which matches
+     * the token, will get translated on the client.
+     *
+     */
+    translate?: string;
+    /**
+     * @remarks
+     * Arguments for the translation token. Can be either an array
+     * of strings or UIRawMessage containing an array of raw text
+     * objects.
+     *
+     */
+    with?: string[] | UIRawMessage;
+}
+
 // @ts-ignore Class inheritance allowed for native defined classes
 export class FormRejectError extends Error {
     private constructor();
@@ -764,7 +1377,7 @@ export class FormRejectError extends Error {
      * This property can be read in early-execution mode.
      *
      */
-    reason: FormRejectReason;
+    readonly reason: FormRejectReason;
 }
 
 export const uiManager: UIManager;

package/package.json

@@ -1,20 +1,20 @@
-{
-  "name": "@minecraft/server-ui",
-  "version": "2.1.0-beta.1.26.3-stable",
-  "description": "",
-  "contributors": [
-    {
-      "name": "Jake Shirley",
-      "email": "jake@xbox.com"
-    },
-    {
-      "name": "Mike Ammerlaan",
-      "email": "mikeam@microsoft.com"
-    }
-  ],
-  "peerDependencies": {
-    "@minecraft/common": "^1.0.0",
-    "@minecraft/server": "^2.0.0 || ^2.6.0-beta.1.26.3-stable"
-  },
-  "license": "MIT"
+{
+  "name": "@minecraft/server-ui",
+  "version": "2.1.0-beta.1.26.30-preview.21",
+  "description": "",
+  "contributors": [
+    {
+      "name": "Jake Shirley",
+      "email": "jake@xbox.com"
+    },
+    {
+      "name": "Mike Ammerlaan",
+      "email": "mikeam@microsoft.com"
+    }
+  ],
+  "peerDependencies": {
+    "@minecraft/common": "^1.0.0",
+    "@minecraft/server": "^2.0.0 || ^2.9.0-beta.1.26.30-preview.21"
+  },
+  "license": "MIT"
 }