@minecraft/server-net 1.0.0-beta.00001b50 → 1.0.0-beta.1.19.60-preview.23

package/index.d.ts

@@ -1,175 +1,186 @@
-// Type definitions for Minecraft Bedrock Edition script APIs
-// Project: https://docs.microsoft.com/minecraft/creator/
-// Definitions by: Jake Shirley <https://github.com/JakeShirley>
-//                 Mike Ammerlaan <https://github.com/mammerla>
-
-/* *****************************************************************************
-   Copyright (c) Microsoft Corporation.
-   ***************************************************************************** */
-/**
- * @packageDocumentation
- * The `@minecraft/server-net` module contains types for
- * executing HTTP-based requests. This module can only be used
- * on Bedrock Dedicated Server.
- *
- * Manifest Details
- * ```json
- * {
- *   "module_name": "@minecraft/server-net",
- *   "version": "1.0.0-beta.00001b50"
- * }
- * ```
- *
- */
-import * as minecraftserveradmin from '@minecraft/server-admin';
-export enum HttpRequestMethod {
-    /**
-     * Represents the method for an HTTP HEAD request. HEAD
-     * requests are similar to a GET request, but are commonly used
-     * to retrieve just the HTTP response headers from the
-     * specified URI, and not the body contents.
-     */
-    DELETE = 'DELETE',
-    /**
-     * Represents the method for an HTTP PUT request. POST requests
-     * are commonly used to create a new resource that is a
-     * subordinate of the specified URI.
-     */
-    GET = 'GET',
-    /**
-     * Represents the method for an HTTP PUT request. GET requests
-     * are commonly used to retrieve information about a resource
-     * at the specified URI.
-     */
-    HEAD = 'HEAD',
-    /**
-     * Represents the method for an HTTP PUT request. GET requests
-     * are commonly used to retrieve information about a resource
-     * at the specified URI.
-     */
-    POST = 'POST',
-    /**
-     * Represents the method for an HTTP PUT request. PUT requests
-     * are commonly used to update a single resource that already
-     * exists in a resource collection.
-     */
-    PUT = 'PUT',
-}
-export class HttpClient {
-    /**
-     * @remarks
-     * Cancels all pending requests.
-     * @param reason
-     */
-    cancelAll(reason: string): void;
-    /**
-     * @remarks
-     * Performs a simple HTTP get request.
-     * @param uri
-     * URL to make an HTTP Request to.
-     * @returns
-     * An awaitable promise that contains the HTTP response.
-     */
-    get(uri: string): Promise<HttpResponse>;
-    /**
-     * @remarks
-     * Performs an HTTP request.
-     * @param config
-     * Contains an HTTP Request object with configuration data on
-     * the HTTP request.
-     * @returns
-     * An awaitable promise that contains the HTTP response.
-     */
-    request(config: HttpRequest): Promise<HttpResponse>;
-    testOnly_fulfillRequest(requestId: number, headers: HttpHeader[], body: string, status: number): void;
-    testOnly_getRequests(): number[];
-    testOnly_rejectRequest(requestId: number, reason: string): void;
-    protected constructor();
-}
-/**
- * Represents an HTTP header - a key/value pair of
- * meta-information about a request.
- */
-export class HttpHeader {
-    /**
-     * Key of the HTTP header.
-     */
-    key: string;
-    /**
-     * Value of the HTTP header.
-     */
-    value: minecraftserveradmin.SecretString | string;
-    constructor(key: string, value: minecraftserveradmin.SecretString | string);
-}
-/**
- * Main object for structuring a request.
- */
-export class HttpRequest {
-    /**
-     * Content of the body of the HTTP request.
-     */
-    body: string;
-    /**
-     * A collection of HTTP headers to add to the outbound request.
-     */
-    headers: HttpHeader[];
-    /**
-     * HTTP method (e.g., GET or PUT or PATCH) to use for making
-     * the request.
-     */
-    method: HttpRequestMethod;
-    /**
-     * Amount of time, in seconds, before the request times out and
-     * is abandoned.
-     */
-    timeout: number;
-    /**
-     * The HTTP resource to access.
-     */
-    uri: string;
-    /**
-     * @remarks
-     * Adds an additional header to the overall list of headers
-     * used in the corresponding HTTP request.
-     * @param key
-     * @param value
-     */
-    addHeader(key: string, value: minecraftserveradmin.SecretString | string): HttpRequest;
-    constructor(uri: string);
-    setBody(body: string): HttpRequest;
-    /**
-     * @remarks
-     * Replaces and applies a set of HTTP Headers for the request.
-     * @param headers
-     */
-    setHeaders(headers: HttpHeader[]): HttpRequest;
-    setMethod(method: HttpRequestMethod): HttpRequest;
-    setTimeout(timeout: number): HttpRequest;
-}
-/**
- * Main object that contains result information from a request.
- */
-export class HttpResponse {
-    /**
-     * Body content of the HTTP response.
-     */
-    readonly body: string;
-    /**
-     * A collection of HTTP response headers returned from the
-     * request.
-     */
-    readonly headers: HttpHeader[];
-    /**
-     * Information that was used to formulate the HTTP response
-     * that this object represents.
-     */
-    readonly request: HttpRequest;
-    /**
-     * HTTP response code for the request. For example, 404
-     * represents resource not found, and 500 represents an
-     * internal server error.
-     */
-    readonly status: number;
-    protected constructor();
-}
-export const http: HttpClient;
+// Type definitions for Minecraft Bedrock Edition script APIs
+// Project: https://docs.microsoft.com/minecraft/creator/
+// Definitions by: Jake Shirley <https://github.com/JakeShirley>
+//                 Mike Ammerlaan <https://github.com/mammerla>
+
+/* *****************************************************************************
+   Copyright (c) Microsoft Corporation.
+   ***************************************************************************** */
+/**
+ * @packageDocumentation
+ * The `@minecraft/server-net` module contains types for
+ * executing HTTP-based requests. This module can only be used
+ * on Bedrock Dedicated Server.
+ *
+ * Manifest Details
+ * ```json
+ * {
+ *   "module_name": "@minecraft/server-net",
+ *   "version": "1.0.0-beta.1.19.60-preview.23"
+ * }
+ * ```
+ *
+ */
+import * as minecraftserveradmin from '@minecraft/server-admin';
+export enum HttpRequestMethod {
+    /**
+     * Represents the method for an HTTP HEAD request. HEAD
+     * requests are similar to a GET request, but are commonly used
+     * to retrieve just the HTTP response headers from the
+     * specified URI, and not the body contents.
+     */
+    DELETE = 'DELETE',
+    /**
+     * Represents the method for an HTTP PUT request. POST requests
+     * are commonly used to create a new resource that is a
+     * subordinate of the specified URI.
+     */
+    GET = 'GET',
+    /**
+     * Represents the method for an HTTP PUT request. GET requests
+     * are commonly used to retrieve information about a resource
+     * at the specified URI.
+     */
+    HEAD = 'HEAD',
+    /**
+     * Represents the method for an HTTP PUT request. GET requests
+     * are commonly used to retrieve information about a resource
+     * at the specified URI.
+     */
+    POST = 'POST',
+    /**
+     * Represents the method for an HTTP PUT request. PUT requests
+     * are commonly used to update a single resource that already
+     * exists in a resource collection.
+     */
+    PUT = 'PUT',
+}
+export class HttpClient {
+    protected constructor();
+    /**
+     * @remarks
+     * Cancels all pending requests.
+     * @param reason
+     */
+    cancelAll(reason: string): void;
+    /**
+     * @remarks
+     * Performs a simple HTTP get request.
+     * @param uri
+     * URL to make an HTTP Request to.
+     * @returns
+     * An awaitable promise that contains the HTTP response.
+     */
+    get(uri: string): Promise<HttpResponse>;
+    /**
+     * @remarks
+     * Performs an HTTP request.
+     * @param config
+     * Contains an HTTP Request object with configuration data on
+     * the HTTP request.
+     * @returns
+     * An awaitable promise that contains the HTTP response.
+     */
+    request(config: HttpRequest): Promise<HttpResponse>;
+    testOnly_fulfillRequest(requestId: number, headers: HttpHeader[], body: string, status: number): void;
+    testOnly_getRequests(): number[];
+    testOnly_rejectRequest(requestId: number, reason: string): void;
+}
+/**
+ * Represents an HTTP header - a key/value pair of
+ * meta-information about a request.
+ */
+export class HttpHeader {
+    /**
+     * Key of the HTTP header.
+     */
+    key: string;
+    /**
+     * Value of the HTTP header.
+     */
+    value: minecraftserveradmin.SecretString | string;
+    constructor(key: string, value: minecraftserveradmin.SecretString | string);
+}
+/**
+ * Main object for structuring a request.
+ */
+export class HttpRequest {
+    /**
+     * Content of the body of the HTTP request.
+     */
+    body: string;
+    /**
+     * A collection of HTTP headers to add to the outbound request.
+     */
+    headers: HttpHeader[];
+    /**
+     * HTTP method (e.g., GET or PUT or PATCH) to use for making
+     * the request.
+     */
+    method: HttpRequestMethod;
+    /**
+     * Amount of time, in seconds, before the request times out and
+     * is abandoned.
+     */
+    timeout: number;
+    /**
+     * The HTTP resource to access.
+     */
+    uri: string;
+    constructor(uri: string);
+    /**
+     * @remarks
+     * Adds an additional header to the overall list of headers
+     * used in the corresponding HTTP request.
+     * @param key
+     * @param value
+     */
+    addHeader(key: string, value: minecraftserveradmin.SecretString | string): HttpRequest;
+    /**
+     * @remarks
+     * Updates the content of the body of the HTTP request.
+     * @param body
+     */
+    setBody(body: string): HttpRequest;
+    /**
+     * @remarks
+     * Replaces and applies a set of HTTP Headers for the request.
+     * @param headers
+     */
+    setHeaders(headers: HttpHeader[]): HttpRequest;
+    /**
+     * @remarks
+     * Sets the desired HTTP method (e.g., GET or PUT or PATCH) to
+     * use for making the request.
+     * @param method
+     */
+    setMethod(method: HttpRequestMethod): HttpRequest;
+    setTimeout(timeout: number): HttpRequest;
+}
+/**
+ * Main object that contains result information from a request.
+ */
+export class HttpResponse {
+    protected constructor();
+    /**
+     * Body content of the HTTP response.
+     */
+    readonly body: string;
+    /**
+     * A collection of HTTP response headers returned from the
+     * request.
+     */
+    readonly headers: HttpHeader[];
+    /**
+     * Information that was used to formulate the HTTP response
+     * that this object represents.
+     */
+    readonly request: HttpRequest;
+    /**
+     * HTTP response code for the request. For example, 404
+     * represents resource not found, and 500 represents an
+     * internal server error.
+     */
+    readonly status: number;
+}
+export const http: HttpClient;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@minecraft/server-net",
-  "version": "1.0.0-beta.00001b50",
+  "version": "1.0.0-beta.1.19.60-preview.23",
   "description": "",
   "contributors": [
     {
@@ -13,7 +13,7 @@
     }
   ],
   "dependencies": {
-    "@minecraft/server-admin": "1.0.0-beta.00001b50"
+    "@minecraft/server-admin": "1.0.0-beta.1.19.60-preview.23"
   },
   "license": "MIT"
 }

package/tests.ts

@@ -1,127 +1,139 @@
-import * as mc from '@minecraft/server';
-import * as mcnet from '@minecraft/server-net';
-
-export async function updateScore() {
-    const req = new mcnet.HttpRequest('http://localhost:3000/updateScore');
-
-    req.body = JSON.stringify({
-        score: 22,
-    });
-
-    req.method = mcnet.HttpRequestMethod.POST;
-    req.headers = [
-        new mcnet.HttpHeader('Content-Type', 'application/json'),
-        new mcnet.HttpHeader('auth', 'my-auth-token'),
-    ];
-
-    await mcnet.http.request(req);
-}
-
-export default class SampleManager {
-    tickCount = 0;
-
-    _availableFuncs: {
-        [name: string]: Array<(log: (message: string, status?: number) => void, location: mc.Location) => void>;
-    };
-
-    pendingFuncs: Array<{
-        name: string;
-        func: (log: (message: string, status?: number) => void, location: mc.Location) => void;
-        location: mc.Location;
-    }> = [];
-
-    gameplayLogger(message: string, status?: number) {
-        if (status !== undefined && status > 0) {
-            message = 'SUCCESS: ' + message;
-        } else if (status !== undefined && status < 0) {
-            message = 'FAIL: ' + message;
-        }
-
-        this.say(message);
-    }
-    say(message: string) {
-        mc.world.getDimension('overworld').runCommand('say ' + message);
-    }
-
-    newChatMessage(chatEvent: mc.ChatEvent) {
-        const message = chatEvent.message.toLowerCase();
-
-        if (message.startsWith('howto') && chatEvent.sender) {
-            const nearbyBlock = chatEvent.sender.getBlockFromViewVector();
-            if (!nearbyBlock) {
-                this.gameplayLogger('Please look at the block where you want me to run this.');
-                return;
-            }
-
-            const nearbyBlockLoc = nearbyBlock.location;
-            const nearbyLoc = new mc.Location(nearbyBlockLoc.x, nearbyBlockLoc.y + 1, nearbyBlockLoc.z);
-
-            const sampleId = message.substring(5).trim();
-
-            if (sampleId.length < 2) {
-                let availableFuncStr = 'Here is my list of available samples:';
-
-                for (const sampleFuncKey in this._availableFuncs) {
-                    availableFuncStr += ' ' + sampleFuncKey;
-                }
-
-                this.say(availableFuncStr);
-            } else {
-                for (const sampleFuncKey in this._availableFuncs) {
-                    if (sampleFuncKey.toLowerCase() === sampleId) {
-                        const sampleFunc = this._availableFuncs[sampleFuncKey];
-
-                        this.runSample(sampleFuncKey + this.tickCount, sampleFunc, nearbyLoc);
-
-                        return;
-                    }
-                }
-
-                this.say(`I couldn't find the sample '${sampleId}"'`);
-            }
-        }
-    }
-
-    runSample(
-        sampleId: string,
-        snippetFunctions: Array<(log: (message: string, status?: number) => void, location: mc.Location) => void>,
-        targetLocation: mc.Location,
-    ) {
-        for (let i = snippetFunctions.length - 1; i >= 0; i--) {
-            this.pendingFuncs.push({ name: sampleId, func: snippetFunctions[i], location: targetLocation });
-        }
-    }
-
-    worldTick() {
-        if (this.tickCount % 10 === 0) {
-            if (this.pendingFuncs.length > 0) {
-                const funcSet = this.pendingFuncs.pop();
-
-                if (funcSet) {
-                    funcSet.func(this.gameplayLogger, funcSet.location);
-                }
-            }
-        }
-
-        this.tickCount++;
-    }
-
-    constructor() {
-        this._availableFuncs = {};
-
-        this.gameplayLogger = this.gameplayLogger.bind(this);
-
-        mc.world.events.tick.subscribe(this.worldTick.bind(this));
-        mc.world.events.chat.subscribe(this.newChatMessage.bind(this));
-    }
-
-    registerSamples(sampleSet: {
-        [name: string]: Array<(log: (message: string, status?: number) => void, location: mc.Location) => void>;
-    }) {
-        for (const sampleKey in sampleSet) {
-            if (sampleKey.length > 1 && sampleSet[sampleKey]) {
-                this._availableFuncs[sampleKey] = sampleSet[sampleKey];
-            }
-        }
-    }
-}
+/* eslint-disable  @typescript-eslint/no-unused-vars */
+import * as mc from '@minecraft/server';
+
+export async function updateScore(log: (message: string, status?: number) => void, targetLocation: mc.Location) {
+    const req = new mcnet.HttpRequest('http://localhost:3000/updateScore');
+
+    req.body = JSON.stringify({
+        score: 22,
+    });
+
+    req.method = mcnet.HttpRequestMethod.POST;
+    req.headers = [
+        new mcnet.HttpHeader('Content-Type', 'application/json'),
+        new mcnet.HttpHeader('auth', 'my-auth-token'),
+    ];
+
+    await mcnet.http.request(req);
+}
+
+export default class SampleManager {
+    tickCount = 0;
+
+    _availableFuncs: {
+        [name: string]: Array<(log: (message: string, status?: number) => void, location: mc.Location) => void>;
+    };
+
+    pendingFuncs: Array<{
+        name: string;
+        func: (log: (message: string, status?: number) => void, location: mc.Location) => void;
+        location: mc.Location;
+    }> = [];
+
+    gameplayLogger(message: string, status?: number) {
+        if (status !== undefined && status > 0) {
+            message = 'SUCCESS: ' + message;
+        } else if (status !== undefined && status < 0) {
+            message = 'FAIL: ' + message;
+        }
+
+        this.say(message);
+    }
+    say(message: string) {
+        mc.world.getDimension('overworld').runCommand('say ' + message);
+    }
+
+    newChatMessage(chatEvent: mc.ChatEvent) {
+        const message = chatEvent.message.toLowerCase();
+
+        if (message.startsWith('howto') && chatEvent.sender) {
+            const nearbyBlock = chatEvent.sender.getBlockFromViewVector();
+            if (!nearbyBlock) {
+                this.gameplayLogger('Please look at the block where you want me to run this.');
+                return;
+            }
+
+            const nearbyBlockLoc = nearbyBlock.location;
+            const nearbyLoc = new mc.Location(nearbyBlockLoc.x, nearbyBlockLoc.y + 1, nearbyBlockLoc.z);
+
+            const sampleId = message.substring(5).trim();
+
+            if (sampleId.length < 2) {
+                let availableFuncStr = 'Here is my list of available samples:';
+
+                for (const sampleFuncKey in this._availableFuncs) {
+                    availableFuncStr += ' ' + sampleFuncKey;
+                }
+
+                this.say(availableFuncStr);
+            } else {
+                for (const sampleFuncKey in this._availableFuncs) {
+                    if (sampleFuncKey.toLowerCase() === sampleId) {
+                        const sampleFunc = this._availableFuncs[sampleFuncKey];
+
+                        this.runSample(sampleFuncKey + this.tickCount, sampleFunc, nearbyLoc);
+
+                        return;
+                    }
+                }
+
+                this.say(`I couldn't find the sample '${sampleId}"'`);
+            }
+        }
+    }
+
+    runSample(
+        sampleId: string,
+        snippetFunctions: Array<(log: (message: string, status?: number) => void, location: mc.Location) => void>,
+        targetLocation: mc.Location,
+    ) {
+        for (let i = snippetFunctions.length - 1; i >= 0; i--) {
+            this.pendingFuncs.push({ name: sampleId, func: snippetFunctions[i], location: targetLocation });
+        }
+    }
+
+    worldTick() {
+        if (this.tickCount % 10 === 0) {
+            if (this.pendingFuncs.length > 0) {
+                const funcSet = this.pendingFuncs.pop();
+
+                if (funcSet) {
+                    funcSet.func(this.gameplayLogger, funcSet.location);
+                }
+            }
+        }
+
+        this.tickCount++;
+    }
+
+    constructor() {
+        this._availableFuncs = {};
+
+        this.gameplayLogger = this.gameplayLogger.bind(this);
+
+        mc.world.events.tick.subscribe(this.worldTick.bind(this));
+        mc.world.events.chat.subscribe(this.newChatMessage.bind(this));
+    }
+
+    registerSamples(sampleSet: {
+        [name: string]: Array<(log: (message: string, status?: number) => void, location: mc.Location) => void>;
+    }) {
+        for (const sampleKey in sampleSet) {
+            if (sampleKey.length > 1 && sampleSet[sampleKey]) {
+                this._availableFuncs[sampleKey] = sampleSet[sampleKey];
+            }
+        }
+    }
+}
+
+import * as mcnet from '@minecraft/server-net'; // keep in for net samples
+
+const mojangNetAdminTestFuncs: {
+    [name: string]: Array<(log: (message: string, status?: number) => void, location: mc.Location) => void>;
+} = {
+    updateScore: [updateScore],
+};
+
+export function register(sampleManager: SampleManager) {
+    sampleManager.registerSamples(mojangNetAdminTestFuncs);
+}