@minecraft/server-net 1.0.0-beta.1.26.2-stable → 1.0.0-beta.1.26.20-preview.22

package/README.md

@@ -1,9 +1,9 @@
-# `@minecraft/server-net`
-
-The `@minecraft/server-net` module contains types for executing HTTP-based requests. This module can only be used on Bedrock Dedicated Server. These APIs do not function within the Minecraft game client or within Minecraft Realms.
-
-## **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-net`
+
+The `@minecraft/server-net` module contains types for executing HTTP-based requests. This module can only be used on Bedrock Dedicated Server. These APIs do not function within the Minecraft game client or within Minecraft Realms.
+
+## **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-net/minecraft-server-net

package/index.d.ts

@@ -51,6 +51,14 @@ export enum HttpRequestMethod {
      *
      */
     Head = 'Head',
+    /**
+     * @remarks
+     * Represents the method for an HTTP PATCH request. PATCH
+     * requests are commonly used to apply partial modifications to
+     * a resource.
+     *
+     */
+    Patch = 'Patch',
     /**
      * @remarks
      * Represents the method for an HTTP POST request. POST
@@ -107,9 +115,10 @@ export enum PacketId {
     ChangeDimensionPacket = 'ChangeDimensionPacket',
     ChangeMobPropertyPacket = 'ChangeMobPropertyPacket',
     ChunkRadiusUpdatedPacket = 'ChunkRadiusUpdatedPacket',
+    ClientboundAttributeLayerSyncPacket = 'ClientboundAttributeLayerSyncPacket',
     ClientboundCloseFormPacket = 'ClientboundCloseFormPacket',
     ClientboundControlSchemeSetPacket = 'ClientboundControlSchemeSetPacket',
-    ClientboundDataDrivenUICloseAllScreensPacket = 'ClientboundDataDrivenUICloseAllScreensPacket',
+    ClientboundDataDrivenUICloseScreenPacket = 'ClientboundDataDrivenUICloseScreenPacket',
     ClientboundDataDrivenUIReloadPacket = 'ClientboundDataDrivenUIReloadPacket',
     ClientboundDataDrivenUIShowScreenPacket = 'ClientboundDataDrivenUIShowScreenPacket',
     ClientboundDataStorePacket = 'ClientboundDataStorePacket',
@@ -138,7 +147,6 @@ export enum PacketId {
     CreativeContentPacket = 'CreativeContentPacket',
     CurrentStructureFeaturePacket = 'CurrentStructureFeaturePacket',
     DeathInfoPacket = 'DeathInfoPacket',
-    DebugDrawerPacket = 'DebugDrawerPacket',
     DebugInfoPacket = 'DebugInfoPacket',
     DimensionDataPacket = 'DimensionDataPacket',
     DisconnectPacket = 'DisconnectPacket',
@@ -170,6 +178,7 @@ export enum PacketId {
     LevelEventGenericPacket = 'LevelEventGenericPacket',
     LevelEventPacket = 'LevelEventPacket',
     LevelSoundEventPacket = 'LevelSoundEventPacket',
+    LocatorBarPacket = 'LocatorBarPacket',
     LoginPacket = 'LoginPacket',
     MapCreateLockedCopyPacket = 'MapCreateLockedCopyPacket',
     MapInfoRequestPacket = 'MapInfoRequestPacket',
@@ -192,6 +201,7 @@ export enum PacketId {
     OnScreenTextureAnimationPacket = 'OnScreenTextureAnimationPacket',
     OpenSignPacket = 'OpenSignPacket',
     PacketViolationWarningPacket = 'PacketViolationWarningPacket',
+    PartyChangedPacket = 'PartyChangedPacket',
     PhotoTransferPacket = 'PhotoTransferPacket',
     PlayerActionPacket = 'PlayerActionPacket',
     PlayerArmorDamagePacket = 'PlayerArmorDamagePacket',
@@ -209,6 +219,7 @@ export enum PacketId {
     PlayStatusPacket = 'PlayStatusPacket',
     PositionTrackingDBClientRequestPacket = 'PositionTrackingDBClientRequestPacket',
     PositionTrackingDBServerBroadcastPacket = 'PositionTrackingDBServerBroadcastPacket',
+    PrimitiveShapesPacket = 'PrimitiveShapesPacket',
     PurchaseReceiptPacket = 'PurchaseReceiptPacket',
     RefreshEntitlementsPacket = 'RefreshEntitlementsPacket',
     RemoveActorPacket = 'RemoveActorPacket',
@@ -223,17 +234,21 @@ export enum PacketId {
     ResourcePackClientResponsePacket = 'ResourcePackClientResponsePacket',
     ResourcePackDataInfoPacket = 'ResourcePackDataInfoPacket',
     ResourcePacksInfoPacket = 'ResourcePacksInfoPacket',
+    ResourcePacksReadyForValidationPacket = 'ResourcePacksReadyForValidationPacket',
     ResourcePackStackPacket = 'ResourcePackStackPacket',
     RespawnPacket = 'RespawnPacket',
     ScriptMessagePacket = 'ScriptMessagePacket',
+    ServerboundDataDrivenScreenClosedPacket = 'ServerboundDataDrivenScreenClosedPacket',
     ServerboundDataStorePacket = 'ServerboundDataStorePacket',
     ServerboundDiagnosticsPacket = 'ServerboundDiagnosticsPacket',
     ServerboundLoadingScreenPacket = 'ServerboundLoadingScreenPacket',
     ServerboundPackSettingChangePacket = 'ServerboundPackSettingChangePacket',
     ServerPlayerPostMovePositionPacket = 'ServerPlayerPostMovePositionPacket',
+    ServerPresenceInfoPacket = 'ServerPresenceInfoPacket',
     ServerSettingsRequestPacket = 'ServerSettingsRequestPacket',
     ServerSettingsResponsePacket = 'ServerSettingsResponsePacket',
     ServerStatsPacket = 'ServerStatsPacket',
+    ServerStoreInfoPacket = 'ServerStoreInfoPacket',
     ServerToClientHandshakePacket = 'ServerToClientHandshakePacket',
     SetActorDataPacket = 'SetActorDataPacket',
     SetActorLinkPacket = 'SetActorLinkPacket',
@@ -270,6 +285,7 @@ export enum PacketId {
     SubChunkRequestPacket = 'SubChunkRequestPacket',
     SubClientLoginPacket = 'SubClientLoginPacket',
     SyncActorPropertyPacket = 'SyncActorPropertyPacket',
+    SyncWorldClocksPacket = 'SyncWorldClocksPacket',
     TakeItemActorPacket = 'TakeItemActorPacket',
     TextPacket = 'TextPacket',
     TickingAreasLoadStatusPacket = 'TickingAreasLoadStatusPacket',
@@ -292,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);
  * }
  * ```
  */
@@ -352,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);
      * }
      * ```
      */
@@ -379,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);
  * }
  * ```
  */
@@ -422,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);
  * }
  * ```
  */
@@ -559,6 +583,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();
     /**
@@ -683,6 +729,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.
  */
@@ -703,6 +840,31 @@ export interface PacketEventOptions {
     monitoredPacketIds?: PacketId[];
 }
 
+/**
+ * An error thrown when the maximum number of concurrent HTTP
+ * requests has been reached.
+ */
+// @ts-ignore Class inheritance allowed for native defined classes
+export class HttpRequestLimitExceededError extends Error {
+    private constructor();
+    /**
+     * @remarks
+     * Number of requests already in flight when rejected.
+     *
+     * This property can be read in early-execution mode.
+     *
+     */
+    readonly inFlightRequests: number;
+    /**
+     * @remarks
+     * Configured maximum concurrent HTTP requests.
+     *
+     * This property can be read in early-execution mode.
+     *
+     */
+    readonly maxConcurrentRequests: number;
+}
+
 /**
  * An error thrown when a platform-level HTTP error occurs.
  * Information provided in this class may be useful for
@@ -714,30 +876,175 @@ 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 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
+     * This property can be read in early-execution mode.
+     *
+     */
+    readonly errorCode: number;
+    /**
+     * @remarks
+     * This property can be read in early-execution mode.
+     *
+     */
+    readonly errorMessage: string;
+}
+
+/**
+ * An error thrown when a malformed URI is used.
+ */
+// @ts-ignore Class inheritance allowed for native defined classes
+export class MalformedUriError extends Error {
+    private constructor();
+}
+
+/**
+ * An error thrown when an network request body exceeds the
+ * configured size limit.
+ */
+// @ts-ignore Class inheritance allowed for native defined classes
+export class RequestBodyTooLargeError extends Error {
+    private constructor();
+    /**
+     * @remarks
+     * Configured maximum body size in bytes.
+     *
+     * This property can be read in early-execution mode.
+     *
+     */
+    readonly maxBytes: number;
+    /**
+     * @remarks
+     * Request body size in bytes.
+     *
+     * This property can be read in early-execution mode.
+     *
+     */
+    readonly providedBytes: number;
+}
+
+/**
+ * An error thrown when secure URI scheme is required but a
+ * non-secure URI was provided.
+ */
+// @ts-ignore Class inheritance allowed for native defined classes
+export class TLSOnlyError extends Error {
+    private constructor();
+    /**
+     * @remarks
+     * URI that was rejected for not using secure scheme.
      *
      * This property can be read in early-execution mode.
      *
      */
-    code: number;
+    readonly uri: string;
+}
+
+/**
+ * An error thrown when a network request targets a URI that is
+ * not in the configured allow list.
+ */
+// @ts-ignore Class inheritance allowed for native defined classes
+export class UriNotAllowedError extends Error {
+    private constructor();
     /**
      * @remarks
-     * The platform-provided message for the error.
+     * URI that was rejected because it is not allowed.
      *
      * This property can be read in early-execution mode.
      *
      */
-    message: string;
+    readonly uri: string;
 }
 
 /**
- * An error thrown when a malformed HTTP request is attempted
- * to be sent.
+ * An error thrown when the connection with the WebSocket
+ * server has failed.
  */
 // @ts-ignore Class inheritance allowed for native defined classes
-export class MalformedHttpRequestError extends Error {
+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,21 +1,21 @@
-{
-  "name": "@minecraft/server-net",
-  "version": "1.0.0-beta.1.26.2-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": "^1.17.0 || ^2.0.0",
-    "@minecraft/server-admin": "^1.0.0-beta.1.26.2-stable"
-  },
-  "license": "MIT"
+{
+  "name": "@minecraft/server-net",
+  "version": "1.0.0-beta.1.26.20-preview.22",
+  "description": "",
+  "contributors": [
+    {
+      "name": "Jake Shirley",
+      "email": "jake@xbox.com"
+    },
+    {
+      "name": "Mike Ammerlaan",
+      "email": "mikeam@microsoft.com"
+    }
+  ],
+  "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.22"
+  },
+  "license": "MIT"
 }