@minecraft/server-admin 1.0.0-beta.00001b50 → 1.0.0-beta.1.19.60-preview.24

package/index.d.ts

@@ -1,81 +1,81 @@
-// 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
- * Contains types related to administering a Bedrock Dedicated
- * Server. These types allow for the configuration of variables
- * and secrets in JSON files in the Bedrock Dedicated Server
- * folder. These types cannot be used on Minecraft clients.
- *
- * Manifest Details
- * ```json
- * {
- *   "module_name": "@minecraft/server-admin",
- *   "version": "1.0.0-beta.00001b50"
- * }
- * ```
- *
- */
-/**
- * This represents a placeholder object that represents a
- * secret string. The contents of that string are not available
- * to script; this object is just a placeholder.
- */
-// tslint:disable-next-line:no-unnecessary-class
-export class SecretString {
-    constructor(value: string);
-}
-/**
- * A collection of server secrets defined in dedicated server
- * configuration.
- */
-export class ServerSecrets {
-    /**
-     * A list of available, configured server secrets.
-     */
-    readonly names: string[];
-    /**
-     * @remarks
-     * Returns a SecretString that is a placeholder for a secret
-     * configured in a JSON file. In certain objects, like an
-     * HttpHeader, this Secret is resolved at the time of execution
-     * but is not made available to the script environment.
-     * @param name
-     */
-    get(name: string): SecretString;
-    protected constructor();
-}
-/**
- * A collection of server variables defined in dedicated server
- * configuration.
- */
-export class ServerVariables {
-    /**
-     * A list of available, configured server variables.
-     */
-    readonly names: string[];
-    /**
-     * @remarks
-     * Returns the value of variable that has been configured in a
-     * dedicated server configuration JSON file.
-     * @param name
-     */
-    get(name: string): any;
-    protected constructor();
-}
-/**
- * A globally available object that returns a list of
- * dedicated-server configured secrets.
- */
-export const secrets: ServerSecrets;
-/**
- * A globally available object that returns a list of
- * dedicated-server configured variables.
- */
-export const variables: ServerVariables;
+// 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
+ * Contains types related to administering a Bedrock Dedicated
+ * Server. These types allow for the configuration of variables
+ * and secrets in JSON files in the Bedrock Dedicated Server
+ * folder. These types cannot be used on Minecraft clients.
+ *
+ * Manifest Details
+ * ```json
+ * {
+ *   "module_name": "@minecraft/server-admin",
+ *   "version": "1.0.0-beta.1.19.60-preview.24"
+ * }
+ * ```
+ *
+ */
+/**
+ * This represents a placeholder object that represents a
+ * secret string. The contents of that string are not available
+ * to script; this object is just a placeholder.
+ */
+// tslint:disable-next-line:no-unnecessary-class
+export class SecretString {
+    constructor(value: string);
+}
+/**
+ * A collection of server secrets defined in dedicated server
+ * configuration.
+ */
+export class ServerSecrets {
+    protected constructor();
+    /**
+     * A list of available, configured server secrets.
+     */
+    readonly names: string[];
+    /**
+     * @remarks
+     * Returns a SecretString that is a placeholder for a secret
+     * configured in a JSON file. In certain objects, like an
+     * HttpHeader, this Secret is resolved at the time of execution
+     * but is not made available to the script environment.
+     * @param name
+     */
+    get(name: string): SecretString;
+}
+/**
+ * A collection of server variables defined in dedicated server
+ * configuration.
+ */
+export class ServerVariables {
+    protected constructor();
+    /**
+     * A list of available, configured server variables.
+     */
+    readonly names: string[];
+    /**
+     * @remarks
+     * Returns the value of variable that has been configured in a
+     * dedicated server configuration JSON file.
+     * @param name
+     */
+    get(name: string): any;
+}
+/**
+ * A globally available object that returns a list of
+ * dedicated-server configured secrets.
+ */
+export const secrets: ServerSecrets;
+/**
+ * A globally available object that returns a list of
+ * dedicated-server configured variables.
+ */
+export const variables: ServerVariables;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@minecraft/server-admin",
-  "version": "1.0.0-beta.00001b50",
+  "version": "1.0.0-beta.1.19.60-preview.24",
   "description": "",
   "contributors": [
     {

package/tests.ts

@@ -1,3 +1,142 @@
-import * as serverAdmin from '@minecraft/server-admin';
-
-serverAdmin.secrets.get('authtoken');
+/* eslint-disable  @typescript-eslint/no-unused-vars */
+import * as mc from '@minecraft/server';
+
+export async function getPlayerProfile(log: (message: string, status?: number) => void, targetLocation: mc.Location) {
+    const serverUrl = mcsa.variables.get('serverEndpoint');
+
+    const req = new mcnet.HttpRequest(serverUrl + 'getPlayerProfile');
+
+    req.body = JSON.stringify({
+        playerId: 'johndoe',
+    });
+
+    req.method = mcnet.HttpRequestMethod.POST;
+    req.headers = [
+        new mcnet.HttpHeader('Content-Type', 'application/json'),
+        new mcnet.HttpHeader('auth', mcsa.secrets.get('authtoken')),
+    ];
+
+    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 mcsa from '@minecraft/server-admin';
+import * as mcnet from '@minecraft/server-net'; // keep in for net samples
+
+const mojangServerAdminTestFuncs: {
+    [name: string]: Array<(log: (message: string, status?: number) => void, location: mc.Location) => void>;
+} = {
+    getPlayerProfile: [getPlayerProfile],
+};
+
+export function register(sampleManager: SampleManager) {
+    sampleManager.registerSamples(mojangServerAdminTestFuncs);
+}