bedrock-protocol/index.d.ts

import EventEmitter from "events"

declare module "bedrock-protocol" {
  type Version = '1.16.220' | '1.16.210' | '1.16.201'

  export interface Options {
    // The string version to start the client or server as
    version: number,
    // For the client, the hostname of the server to connect to (default: 127.0.0.1)
    // For the server, the hostname to bind to (default: 0.0.0.0)
    host: string,
    // The port to connect or bind to, default: 19132
    port: number,
    // The maximum number of players allowed on the server at any time.
    maxPlayers: number,

    motd: {
      // The header for the MOTD shown in the server list.
      motd: string,
      // The sub-header for the MOTD shown in the server list.
      levelName: string
    }
  }

  enum ClientStatus {
    Disconected, Authenticating, Initializing, Initialized
  }

  export class Connection extends EventEmitter {
    readonly status: ClientStatus

    // Check if the passed version is less than or greater than the current connected client version.
    versionLessThan(version: string | number)
    versionGreaterThan(version: string | number)

    // Writes a Minecraft bedrock packet and sends it without queue batching
    write(name: string, params: object)
    // Adds a Minecraft bedrock packet to be sent in the next outgoing batch
    queue(name: string, params: object)
    // Writes a MCPE buffer to the connection and skips Protodef serialization. `immediate` if skip queue.
    sendBuffer(buffer: Buffer, immediate?: boolean)
  }

  type PlayStatus = 
    | 'login_success'
    // # Displays "Could not connect: Outdated client!"
    | 'failed_client'
    // # Displays "Could not connect: Outdated server!"
    | 'failed_spawn'
    // # Sent after world data to spawn the player
    | 'player_spawn'
    // # Displays "Unable to connect to world. Your school does not have access to this server."
    | 'failed_invalid_tenant'
    // # Displays "The server is not running Minecraft: Education Edition. Failed to connect."
    | 'failed_vanilla_edu'
    // # Displays "The server is running an incompatible edition of Minecraft. Failed to connect."
    | 'failed_edu_vanilla'
    // # Displays "Wow this server is popular! Check back later to see if space opens up. Server Full"
    | 'failed_server_full'


  export class Client extends Connection {
    constructor(options: Options)
    // The client's EntityID returned by the server
    readonly entityId: BigInt

    /**
     * Close the connection, leave the server. 
     */
    close()
  }

  /**
   * `Player` represents a player connected to the server. 
   */
  export class Player extends Connection {
    /**
     * Disconnects a client before it has logged in via a PlayStatus packet.
     * @param {string} playStatus
     */
    sendDisconnectStatus(playStatus: PlayStatus)

    /**
     * Disconnects a client
     * @param reason The message to be shown to the user on disconnect
     * @param hide Don't show the client the reason for the disconnect
     */
    disconnect(reason: string, hide?: boolean)

    /**
     * Close the connection. Already called by disconnect. Call this to manually close RakNet connection. 
     */
    close()
  }

  export class Server extends EventEmitter {
    clients: Map<string, Player>
    // Connection logging function
    conLog: Function
    constructor(options: Options)
    // Disconnects all currently connected clients
    close(disconnectReason: string)
  }

  type RelayOptions = Options & {
    hostname: string,
    port: number,
    // Toggle packet logging.
    logging: boolean,
    // Where to proxy requests to.
    destination: {
      hostname: string,
      port: number
    }
  }
  export class Relay extends Server {
    constructor(options: RelayOptions)
  }

  class ServerAdvertisement {
    motd: string
    name: string
    protocol: number
    version: string
    players: {
      online: number,
      max: number
    }
    gamemode: string
    serverId: string
  }

  export function createClient(options: Options): Client
  export function createServer(options: Options): Server

  export function ping({ host, port }) : ServerAdvertisement
}