@minecraft/server-net 1.0.0-beta.1.26.20-preview.20 → 1.0.0-beta.1.26.20-preview.23

package/index.d.ts

@@ -244,9 +244,11 @@ export enum PacketId {
     ServerboundLoadingScreenPacket = 'ServerboundLoadingScreenPacket',
     ServerboundPackSettingChangePacket = 'ServerboundPackSettingChangePacket',
     ServerPlayerPostMovePositionPacket = 'ServerPlayerPostMovePositionPacket',
+    ServerPresenceInfoPacket = 'ServerPresenceInfoPacket',
     ServerSettingsRequestPacket = 'ServerSettingsRequestPacket',
     ServerSettingsResponsePacket = 'ServerSettingsResponsePacket',
     ServerStatsPacket = 'ServerStatsPacket',
+    ServerStoreInfoPacket = 'ServerStoreInfoPacket',
     ServerToClientHandshakePacket = 'ServerToClientHandshakePacket',
     SetActorDataPacket = 'SetActorDataPacket',
     SetActorLinkPacket = 'SetActorLinkPacket',
@@ -306,25 +308,42 @@ export enum PacketId {
     VoxelShapesPacket = 'VoxelShapesPacket',
 }
 
+export class CloseAfterEventSignal {
+    private constructor();
+    /**
+     * @remarks
+     * This function can't be called in restricted-execution mode.
+     *
+     * This function can be called in early-execution mode.
+     *
+     */
+    subscribe(callback: (arg0: WebSocketClientCloseAfterEvent) => void): (arg0: WebSocketClientCloseAfterEvent) => void;
+    /**
+     * @remarks
+     * This function can't be called in restricted-execution mode.
+     *
+     * This function can be called in early-execution mode.
+     *
+     */
+    unsubscribe(callback: (arg0: WebSocketClientCloseAfterEvent) => void): void;
+}
+
 /**
  * @example simpleHttpRequest.ts
  * ```typescript
  * import { HttpRequest, HttpHeader, HttpRequestMethod, http } from '@minecraft/server-net';
  *
  * async function updateScore() {
- *     const req = new HttpRequest('http://localhost:3000/updateScore');
+ *   const req = new HttpRequest('http://localhost:3000/updateScore');
  *
- *     req.body = JSON.stringify({
- *         score: 22,
- *     });
+ *   req.body = JSON.stringify({
+ *     score: 22,
+ *   });
  *
- *     req.method = HttpRequestMethod.Post;
- *     req.headers = [
- *         new HttpHeader('Content-Type', 'application/json'),
- *         new HttpHeader('auth', 'my-auth-token'),
- *     ];
+ *   req.method = HttpRequestMethod.Post;
+ *   req.headers = [new HttpHeader('Content-Type', 'application/json'), new HttpHeader('auth', 'my-auth-token')];
  *
- *     await http.request(req);
+ *   await http.request(req);
  * }
  * ```
  */
@@ -366,19 +385,16 @@ export class HttpClient {
      * import { HttpRequest, HttpHeader, HttpRequestMethod, http } from '@minecraft/server-net';
      *
      * async function updateScore() {
-     *     const req = new HttpRequest('http://localhost:3000/updateScore');
+     *   const req = new HttpRequest('http://localhost:3000/updateScore');
      *
-     *     req.body = JSON.stringify({
-     *         score: 22,
-     *     });
+     *   req.body = JSON.stringify({
+     *     score: 22,
+     *   });
      *
-     *     req.method = HttpRequestMethod.Post;
-     *     req.headers = [
-     *         new HttpHeader('Content-Type', 'application/json'),
-     *         new HttpHeader('auth', 'my-auth-token'),
-     *     ];
+     *   req.method = HttpRequestMethod.Post;
+     *   req.headers = [new HttpHeader('Content-Type', 'application/json'), new HttpHeader('auth', 'my-auth-token')];
      *
-     *     await http.request(req);
+     *   await http.request(req);
      * }
      * ```
      */
@@ -393,19 +409,16 @@ export class HttpClient {
  * import { HttpRequest, HttpHeader, HttpRequestMethod, http } from '@minecraft/server-net';
  *
  * async function updateScore() {
- *     const req = new HttpRequest('http://localhost:3000/updateScore');
+ *   const req = new HttpRequest('http://localhost:3000/updateScore');
  *
- *     req.body = JSON.stringify({
- *         score: 22,
- *     });
+ *   req.body = JSON.stringify({
+ *     score: 22,
+ *   });
  *
- *     req.method = HttpRequestMethod.Post;
- *     req.headers = [
- *         new HttpHeader('Content-Type', 'application/json'),
- *         new HttpHeader('auth', 'my-auth-token'),
- *     ];
+ *   req.method = HttpRequestMethod.Post;
+ *   req.headers = [new HttpHeader('Content-Type', 'application/json'), new HttpHeader('auth', 'my-auth-token')];
  *
- *     await http.request(req);
+ *   await http.request(req);
  * }
  * ```
  */
@@ -436,19 +449,16 @@ export class HttpHeader {
  * import { HttpRequest, HttpHeader, HttpRequestMethod, http } from '@minecraft/server-net';
  *
  * async function updateScore() {
- *     const req = new HttpRequest('http://localhost:3000/updateScore');
+ *   const req = new HttpRequest('http://localhost:3000/updateScore');
  *
- *     req.body = JSON.stringify({
- *         score: 22,
- *     });
+ *   req.body = JSON.stringify({
+ *     score: 22,
+ *   });
  *
- *     req.method = HttpRequestMethod.Post;
- *     req.headers = [
- *         new HttpHeader('Content-Type', 'application/json'),
- *         new HttpHeader('auth', 'my-auth-token'),
- *     ];
+ *   req.method = HttpRequestMethod.Post;
+ *   req.headers = [new HttpHeader('Content-Type', 'application/json'), new HttpHeader('auth', 'my-auth-token')];
  *
- *     await http.request(req);
+ *   await http.request(req);
  * }
  * ```
  */
@@ -532,8 +542,13 @@ export class HttpRequest {
     setMethod(method: HttpRequestMethod): HttpRequest;
     /**
      * @remarks
+     * Sets the maximum amount of time, in seconds, before the
+     * request times out and is cancelled.
+     *
      * This function can be called in early-execution mode.
      *
+     * @param timeout
+     * The timeout value, in seconds.
      */
     setTimeout(timeout: number): HttpRequest;
 }
@@ -573,6 +588,28 @@ export class HttpResponse {
     readonly status: number;
 }
 
+export class MessageAfterEventSignal {
+    private constructor();
+    /**
+     * @remarks
+     * This function can't be called in restricted-execution mode.
+     *
+     * This function can be called in early-execution mode.
+     *
+     */
+    subscribe(
+        callback: (arg0: WebSocketClientReceiveAfterEvent) => void,
+    ): (arg0: WebSocketClientReceiveAfterEvent) => void;
+    /**
+     * @remarks
+     * This function can't be called in restricted-execution mode.
+     *
+     * This function can be called in early-execution mode.
+     *
+     */
+    unsubscribe(callback: (arg0: WebSocketClientReceiveAfterEvent) => void): void;
+}
+
 export class NetworkBeforeEvents {
     private constructor();
     /**
@@ -697,6 +734,97 @@ export class PacketSendBeforeEventSignal {
     unsubscribe(callback: (arg0: PacketSendBeforeEvent) => void): void;
 }
 
+/**
+ * Used to manage WebSocket connections.
+ */
+export class WebSocket {
+    private constructor();
+    /**
+     * @remarks
+     * Attempts to connect a WebSocket client.
+     *
+     * This function can't be called in restricted-execution mode.
+     *
+     * @param uri
+     * URL to make connection to.
+     * @returns
+     * An awaitable promise that contains the WebSocket client that
+     * was connected.
+     */
+    connect(uri: string): Promise<WebSocketClient>;
+}
+
+/**
+ * An active WebSocket client.
+ */
+export class WebSocketClient {
+    private constructor();
+    /**
+     * @remarks
+     * Contains a set of events related to this WebSocket client.
+     *
+     */
+    readonly afterEvents: WebSocketClientAfterEvents;
+    /**
+     * @remarks
+     * Set to true if the socket is current connected to the
+     * server.
+     *
+     */
+    readonly isOpen: boolean;
+    /**
+     * @remarks
+     * Closes the connection with the server.
+     *
+     * This function can't be called in restricted-execution mode.
+     *
+     * @throws This function can throw errors.
+     *
+     * {@link WebSocketNotConnectedError}
+     */
+    close(): void;
+    /**
+     * @remarks
+     * Sends the provided payload to the server.
+     *
+     * This function can't be called in restricted-execution mode.
+     *
+     * @param payload
+     * The payload that will be included in the network packet.
+     * @throws This function can throw errors.
+     *
+     * {@link RequestBodyTooLargeError}
+     *
+     * {@link WebSocketNotConnectedError}
+     */
+    send(payload: string): void;
+}
+
+export class WebSocketClientAfterEvents {
+    private constructor();
+    /**
+     * @remarks
+     * This property can be read in early-execution mode.
+     *
+     */
+    readonly close: CloseAfterEventSignal;
+    /**
+     * @remarks
+     * This property can be read in early-execution mode.
+     *
+     */
+    readonly message: MessageAfterEventSignal;
+}
+
+export class WebSocketClientCloseAfterEvent {
+    private constructor();
+}
+
+export class WebSocketClientReceiveAfterEvent {
+    private constructor();
+    readonly message: string;
+}
+
 /**
  * Options for events triggered by network packets.
  */
@@ -753,20 +881,39 @@ export class InternalHttpRequestError extends Error {
     private constructor();
     /**
      * @remarks
-     * The platform-provided numeric error code for the error.
+     * This property can be read in early-execution mode.
      *
+     */
+    readonly errorCode: number;
+    /**
+     * @remarks
      * This property can be read in early-execution mode.
      *
      */
-    readonly code: number;
+    readonly errorMessage: string;
+}
+
+/**
+ * An error thrown when a platform-level WebSocket error
+ * occurs.  Information provided in this class may be useful
+ * for diagnostics purposes but will differ from platform to
+ * platform.
+ */
+// @ts-ignore Class inheritance allowed for native defined classes
+export class InternalWebSocketError extends Error {
+    private constructor();
     /**
      * @remarks
-     * The platform-provided message for the error.
+     * This property can be read in early-execution mode.
      *
+     */
+    readonly errorCode: number;
+    /**
+     * @remarks
      * This property can be read in early-execution mode.
      *
      */
-    readonly message: string;
+    readonly errorMessage: string;
 }
 
 /**
@@ -836,5 +983,73 @@ export class UriNotAllowedError extends Error {
     readonly uri: string;
 }
 
+/**
+ * An error thrown when the connection with the WebSocket
+ * server has failed.
+ */
+// @ts-ignore Class inheritance allowed for native defined classes
+export class WebSocketConnectionFailedError extends Error {
+    private constructor();
+    /**
+     * @remarks
+     * The error code received when attempting to connect with the
+     * server.
+     *
+     * This property can be read in early-execution mode.
+     *
+     */
+    readonly errorCode: number;
+    /**
+     * @remarks
+     * The URI provided to make this connection attempt that
+     * failed.
+     *
+     * This property can be read in early-execution mode.
+     *
+     */
+    readonly uri: string;
+}
+
+/**
+ * An error that is thrown when the maximum number of connected
+ * WebSockets is reached.
+ */
+// @ts-ignore Class inheritance allowed for native defined classes
+export class WebSocketLimitExceededError extends Error {
+    private constructor();
+    /**
+     * @remarks
+     * Number of WebSocket connections already active when
+     * rejected.
+     *
+     * This property can be read in early-execution mode.
+     *
+     */
+    readonly connectedSockets: number;
+    /**
+     * @remarks
+     * Configured maximum active WebSocket connections.
+     *
+     * This property can be read in early-execution mode.
+     *
+     */
+    readonly maxConcurrentConnections: number;
+}
+
+/**
+ * An error thrown when attempting to use a WebSocket while the
+ * socket is not connected to a server.
+ */
+// @ts-ignore Class inheritance allowed for native defined classes
+export class WebSocketNotConnectedError extends Error {
+    private constructor();
+}
+
 export const beforeEvents: NetworkBeforeEvents;
 export const http: HttpClient;
+/**
+ * @remarks
+ * Used to manage WebSocket connections.
+ *
+ */
+export const websocket: WebSocket;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@minecraft/server-net",
-  "version": "1.0.0-beta.1.26.20-preview.20",
+  "version": "1.0.0-beta.1.26.20-preview.23",
   "description": "",
   "contributors": [
     {
@@ -15,7 +15,7 @@
   "peerDependencies": {
     "@minecraft/common": "^1.0.0",
     "@minecraft/server": "^1.17.0 || ^2.0.0",
-    "@minecraft/server-admin": "^1.0.0-beta.1.26.20-preview.20"
+    "@minecraft/server-admin": "^1.0.0-beta.1.26.20-preview.23"
   },
   "license": "MIT"
 }