@minecraft/server-admin 1.0.0-beta.1.26.10-preview.23 → 1.0.0-beta.1.26.10-preview.25

package/index.d.ts

@@ -40,6 +40,68 @@ export class AdminBeforeEvents {
     readonly asyncPlayerJoin: AsyncPlayerJoinBeforeEventSignal;
 }
 
+/**
+ * Controls the allow list for the server. Only available on
+ * dedicated server.
+ */
+export class AllowList {
+    private constructor();
+    /**
+     * @remarks
+     * This property can't be edited in restricted-execution mode.
+     *
+     */
+    enabled: boolean;
+    /**
+     * @remarks
+     * Adds a player to the server's allow list.
+     *
+     * @param player
+     * Player or player name that should be added to the allow
+     * list.
+     * @throws This function can throw errors.
+     *
+     * {@link AllowListModificationError}
+     *
+     * {@link minecraftserver.InvalidEntityError}
+     */
+    add(player: minecraftserver.Player | string): void;
+    /**
+     * @remarks
+     * Returns if the player is in the server's allow list.
+     *
+     * @param player
+     * Player or player name that should be checked for.
+     * @throws This function can throw errors.
+     *
+     * {@link minecraftserver.InvalidEntityError}
+     */
+    contains(player: minecraftserver.Player | string): boolean;
+    /**
+     * @remarks
+     * Reloads the server's allow list from disk.
+     *
+     * @throws This function can throw errors.
+     *
+     * {@link AllowListFileReloadError}
+     */
+    reloadFile(): void;
+    /**
+     * @remarks
+     * Removes a player from the server's allow list.
+     *
+     * @param player
+     * Player or player name that should be removed from the allow
+     * list.
+     * @throws This function can throw errors.
+     *
+     * {@link AllowListModificationError}
+     *
+     * {@link minecraftserver.InvalidEntityError}
+     */
+    remove(player: minecraftserver.Player | string): void;
+}
+
 /**
  * The data available before a player joins the world.
  */
@@ -120,6 +182,90 @@ export class AsyncPlayerJoinBeforeEventSignal {
     unsubscribe(callback: (arg0: AsyncPlayerJoinBeforeEvent) => Promise<void>): boolean;
 }
 
+/**
+ * Contains apis that are only available when in Bedrock
+ * Dedicated Server.
+ */
+export class DedicatedServerUtils {
+    private constructor();
+    /**
+     * @remarks
+     * Returns an object that manages the server's allow list.
+     *
+     */
+    readonly allowList: AllowList;
+    /**
+     * @remarks
+     * Returns an object that manages the level's storage.
+     *
+     */
+    readonly levelStorage: LevelStorage;
+    /**
+     * @remarks
+     * Shuts down the dedicated server.
+     *
+     */
+    stopServer(): void;
+}
+
+/**
+ * Controls how the server saves to disk. Only available on
+ * dedicated server.
+ */
+export class LevelStorage {
+    private constructor();
+    /**
+     * @remarks
+     * Disables the server writing to the world files and begins
+     * creating a snapshot.
+     *
+     * @throws This function can throw errors.
+     *
+     * {@link LevelStorageSaveStateChangeError}
+     */
+    saveHold(): void;
+    /**
+     * @remarks
+     * Returns the path and size of every file in the current
+     * snapshot if a snapshot is being taken.
+     *
+     * @throws This function can throw errors.
+     *
+     * {@link LevelStorageSaveStateChangeError}
+     */
+    saveQuery(): LevelStorageQuerySnapshotFile[];
+    /**
+     * @remarks
+     * Re-enables server writing world state to files and removes
+     * snapshot.
+     *
+     * @throws This function can throw errors.
+     *
+     * {@link LevelStorageSaveStateChangeError}
+     */
+    saveResume(): void;
+}
+
+/**
+ * Contains information about a file that was gathered during a
+ * snapshot.
+ */
+export class LevelStorageQuerySnapshotFile {
+    private constructor();
+    /**
+     * @remarks
+     * The path to the file in the snapshot.
+     *
+     */
+    readonly fileName: string;
+    /**
+     * @remarks
+     * The size of the file in the snapshot.
+     *
+     */
+    readonly fileSize: number;
+}
+
 /**
  * This represents a placeholder object that represents a
  * secret string. The contents of that string are not available
@@ -265,6 +411,24 @@ export interface TransferPlayerNetherNetOptions {
     netherNetId: string;
 }
 
+/**
+ * An error that is thrown when the allow list file fails to
+ * reload.
+ */
+// @ts-ignore Class inheritance allowed for native defined classes
+export class AllowListFileReloadError extends Error {
+    private constructor();
+}
+
+/**
+ * An error which is thrown when modifying the allow list has
+ * failed.
+ */
+// @ts-ignore Class inheritance allowed for native defined classes
+export class AllowListModificationError extends Error {
+    private constructor();
+}
+
 /**
  * An error that is thrown when trying to interact with a join
  * event and the player is disconnected.
@@ -282,6 +446,16 @@ export class DisconnectedError extends Error {
     readonly id: string;
 }
 
+/**
+ * An error that is thrown when level storage save state
+ * management are used out of sequence or are repeated in an
+ * invalid way.
+ */
+// @ts-ignore Class inheritance allowed for native defined classes
+export class LevelStorageSaveStateChangeError extends Error {
+    private constructor();
+}
+
 /**
  * @remarks
  * Transfer player to another server.
@@ -299,6 +473,13 @@ export function transferPlayer(
     options: TransferPlayerIpPortOptions | TransferPlayerNetherNetOptions,
 ): void;
 export const beforeEvents: AdminBeforeEvents;
+/**
+ * @remarks
+ * A globally available, optional object that contains
+ * dedicated-server only apis.
+ *
+ */
+export const dedicatedServer: DedicatedServerUtils | undefined;
 /**
  * @remarks
  * A globally available object that returns a list of

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@minecraft/server-admin",
-  "version": "1.0.0-beta.1.26.10-preview.23",
+  "version": "1.0.0-beta.1.26.10-preview.25",
   "description": "",
   "contributors": [
     {