@minecraft/server-net 0.0.1-beta

package/.eslintrc.json

@@ -0,0 +1,23 @@
+{
+    "env": {
+        "browser": true,
+        "es2021": true
+    },
+    "extends": [
+        "eslint:recommended",
+        "plugin:@typescript-eslint/recommended"
+    ],
+    "overrides": [
+    ],
+    "parser": "@typescript-eslint/parser",
+    "parserOptions": {
+        "ecmaVersion": "latest",
+        "sourceType": "module"
+    },
+    "plugins": [
+        "@typescript-eslint"
+    ],
+    "rules": {
+        "@typescript-eslint/no-explicit-any": "off"
+    }
+}

package/index.d.ts

@@ -0,0 +1,63 @@
+// Type definitions for Minecraft Bedrock Edition script APIs (experimental) 0.1
+// Project: https://docs.microsoft.com/minecraft/creator/
+// Definitions by: Jake Shirley <https://github.com/JakeShirley>
+//                 Mike Ammerlaan <https://github.com/mammerla>
+// Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped
+
+/* *****************************************************************************
+   Copyright (c) Microsoft Corporation.
+   ***************************************************************************** */
+/**
+ *
+ * Manifest Details
+ * ```json
+ * {
+ *   "module_name": "@minecraft/server-net",
+ *   "version": "1.0.0-beta"
+ * }
+ * ```
+ *
+ */
+import * as minecraftserveradmin from '@minecraft/server-admin';
+export enum HttpRequestMethod {
+    DELETE = 'DELETE',
+    GET = 'GET',
+    HEAD = 'HEAD',
+    POST = 'POST',
+    PUT = 'PUT',
+}
+export class HttpClient {
+    cancelAll(reason: string): void;
+    get(uri: string): Promise<HttpResponse>;
+    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();
+}
+export class HttpHeader {
+    key: string;
+    value: minecraftserveradmin.SecretString | string;
+    constructor(key: string, value: minecraftserveradmin.SecretString | string);
+}
+export class HttpRequest {
+    body: string;
+    headers: HttpHeader[];
+    method: HttpRequestMethod;
+    timeout: number;
+    uri: string;
+    addHeader(key: string, value: minecraftserveradmin.SecretString | string): HttpRequest;
+    constructor(uri: string);
+    setBody(body: string): HttpRequest;
+    setHeaders(headers: HttpHeader[]): HttpRequest;
+    setMethod(method: HttpRequestMethod): HttpRequest;
+    setTimeout(timeout: number): HttpRequest;
+}
+export class HttpResponse {
+    readonly body: string;
+    readonly headers: HttpHeader[];
+    readonly request: HttpRequest;
+    readonly status: number;
+    protected constructor();
+}
+export const http: HttpClient;

package/package.json

@@ -0,0 +1,19 @@
+{
+  "name": "@minecraft/server-net",
+  "version": "0.0.1-beta",
+  "description": "",
+  "contributors": [
+    {
+      "name": "Jake Shirley",
+      "email": "jake@xbox.com"
+    },
+    {
+      "name": "Mike Ammerlaan",
+      "email": "mikeam@microsoft.com"
+    }
+  ],
+  "license": "MIT",
+  "dependencies": {
+    "@minecraft/server-admin": "0.0.1-beta"
+  }
+}

package/tests.ts

@@ -0,0 +1,127 @@
+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];
+            }
+        }
+    }
+}

package/tsconfig.json

@@ -0,0 +1,20 @@
+{
+  "compilerOptions": {
+      "module": "commonjs",
+      "lib": ["es6"],
+      "target": "es6",
+      "forceConsistentCasingInFileNames": true,
+      "noEmit": true,
+      "noImplicitAny": true,
+      "noImplicitThis": true,
+      "strictFunctionTypes": true,
+      "strictNullChecks": true,
+      "baseUrl": "../",
+      "typeRoots": ["../"],
+      "types": []
+  },
+  "files": [
+      "index.d.ts",
+      "tests.ts"
+  ]
+}