@minecraft/server-ui 2.1.0-beta.1.26.20-preview.22 → 2.1.0-beta.1.26.20-preview.26

package/index.d.ts

@@ -74,6 +74,39 @@ 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.
@@ -895,6 +928,21 @@ export declare class Observable<T extends string | number | boolean | UIRawMessa
      *
      */
     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

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@minecraft/server-ui",
-  "version": "2.1.0-beta.1.26.20-preview.22",
+  "version": "2.1.0-beta.1.26.20-preview.26",
   "description": "",
   "contributors": [
     {
@@ -14,7 +14,7 @@
   ],
   "peerDependencies": {
     "@minecraft/common": "^1.0.0",
-    "@minecraft/server": "^2.0.0 || ^2.8.0-beta.1.26.20-preview.22"
+    "@minecraft/server": "^2.0.0 || ^2.8.0-beta.1.26.20-preview.26"
   },
   "license": "MIT"
 }