@minecraft/server-admin 1.0.0-beta.00001b37

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/README.md

@@ -0,0 +1,9 @@
+# `@minecraft/server-admin`
+
+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.
+
+## **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-admin/@minecraft/server-admin

package/index.d.ts

@@ -0,0 +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.00001b37"
+ * }
+ * ```
+ *
+ */
+/**
+ * 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;

package/package.json

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

package/tests.ts

@@ -0,0 +1,3 @@
+import * as serverAdmin from '@minecraft/server-admin';
+
+serverAdmin.secrets.get('authtoken');

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"
+  ]
+}