@huelder/hytale-types 1.0.0

package/bridge.d.ts

@@ -0,0 +1,189 @@
+/**
+ * Hytale TypeScript Runtime - Bridge API Types
+ *
+ * These types define the JavaScript bridge API exposed as the global `Hytale` object.
+ * Raw Java API types come from generated/hytale-api.d.ts.
+ *
+ * Usage:
+ *   // Bridge API (global Hytale object)
+ *   Hytale.commands.register({ name: 'test', execute: (ctx) => ctx.reply('Hi!') });
+ *   Hytale.events.on('playerJoin', handler);
+ *   Hytale.log('Hello!');
+ *
+ *   // Raw Java API (via Java.type) - with autocomplete!
+ *   const Server = Java.type('com.hypixel.hytale.server.core.HytaleServer');
+ *   const server = Server.get();  // ← autocomplete works!
+ */
+
+/// <reference path="./generated/hytale-api.d.ts" />
+
+/**
+ * Command context passed to command handlers.
+ */
+interface CommandContext {
+    /** Sends a reply message to the command sender. */
+    reply(message: string): void;
+    /** Gets the raw input string for the command. */
+    getInputString(): string;
+    /** Checks if the sender is a player. */
+    isPlayer(): boolean;
+    /** Gets the underlying Java CommandContext for advanced usage. */
+    getNative(): any;
+}
+
+/**
+ * Options for registering a command.
+ */
+interface CommandOptions {
+    /** The command name (what users type) */
+    name: string;
+    /** Description of what the command does */
+    description?: string;
+    /** Function to execute when the command is invoked */
+    execute: (ctx: CommandContext) => void;
+}
+
+/**
+ * Command registration API.
+ */
+interface CommandBridge {
+    /**
+     * Registers a new command.
+     * @example
+     * Hytale.commands.register({
+     *     name: 'hello',
+     *     execute: (ctx) => ctx.reply('Hello!')
+     * });
+     */
+    register(options: CommandOptions): boolean;
+    /** Unregisters a command. */
+    unregister(name: string): boolean;
+    /** Checks if a command is registered. */
+    has(name: string): boolean;
+}
+
+/**
+ * Event subscription API.
+ */
+interface EventBridge {
+    /**
+     * Subscribes to an event.
+     * @example
+     * Hytale.events.on('playerJoin', (event) => console.log('Joined!'));
+     */
+    on(eventName: string, handler: (event: any) => void): boolean;
+    /** Subscribes to an event for a single invocation. */
+    once(eventName: string, handler: (event: any) => void): boolean;
+    /** Removes an event handler. */
+    off(eventName: string, handler: (event: any) => void): boolean;
+    /** Emits a custom event. */
+    emit(eventName: string, data: any): void;
+    /** Removes all handlers for an event. */
+    removeAllListeners(eventName: string): void;
+    /** Gets the number of handlers for an event. */
+    listenerCount(eventName: string): number;
+}
+
+/**
+ * The main Hytale bridge API.
+ * Available as the global `Hytale` object in all TypeScript mods.
+ */
+interface HytaleBridge {
+    /** Command registration API */
+    readonly commands: CommandBridge;
+    /** Event subscription API */
+    readonly events: EventBridge;
+    /** Logs a message to the server console */
+    log(message: string): void;
+    /** Logs a warning to the server console */
+    warn(message: string): void;
+    /** Gets the plugin's data directory path */
+    getDataDirectory(): string;
+    /** Gets the plugin's name */
+    getPluginName(): string;
+}
+
+/**
+ * Java class type mapping for autocomplete support.
+ * Maps fully qualified class names to their TypeScript types from generated/hytale-api.d.ts.
+ */
+interface JavaClassMap {
+    // Core Server
+    'com.hypixel.hytale.server.core.HytaleServer': HytaleAPI.server.core.HytaleServer;
+    'com.hypixel.hytale.server.core.HytaleServerConfig': HytaleAPI.server.core.HytaleServerConfig;
+    'com.hypixel.hytale.server.core.Message': HytaleAPI.server.core.Message;
+
+    // Plugin System
+    'com.hypixel.hytale.server.core.plugin.JavaPlugin': HytaleAPI.server.core.plugin.JavaPlugin;
+    'com.hypixel.hytale.server.core.plugin.PluginBase': HytaleAPI.server.core.plugin.PluginBase;
+    'com.hypixel.hytale.server.core.plugin.PluginManager': HytaleAPI.server.core.plugin.PluginManager;
+
+    // Entity
+    'com.hypixel.hytale.server.core.entity.Entity': HytaleAPI.server.core.entity.Entity;
+    'com.hypixel.hytale.server.core.entity.LivingEntity': HytaleAPI.server.core.entity.LivingEntity;
+    'com.hypixel.hytale.server.core.entity.entities.Player': HytaleAPI.server.core.entity.entities.Player;
+
+    // World
+    'com.hypixel.hytale.server.core.universe.world.World': HytaleAPI.server.core.universe.world.World;
+    'com.hypixel.hytale.server.core.universe.Universe': HytaleAPI.server.core.universe.Universe;
+
+    // Commands
+    'com.hypixel.hytale.server.core.command.system.CommandRegistry': HytaleAPI.server.core.command.system.CommandRegistry;
+    'com.hypixel.hytale.server.core.command.system.CommandContext': HytaleAPI.server.core.command.system.CommandContext;
+    'com.hypixel.hytale.server.core.command.system.AbstractCommand': HytaleAPI.server.core.command.system.AbstractCommand;
+
+    // Events
+    'com.hypixel.hytale.event.EventRegistry': HytaleAPI.event.EventRegistry;
+    'com.hypixel.hytale.event.EventPriority': HytaleAPI.event.EventPriority;
+
+    // Inventory
+    'com.hypixel.hytale.server.core.inventory.Inventory': HytaleAPI.server.core.inventory.Inventory;
+    'com.hypixel.hytale.server.core.inventory.ItemStack': HytaleAPI.server.core.inventory.ItemStack;
+
+    // Tasks
+    'com.hypixel.hytale.server.core.task.TaskRegistry': HytaleAPI.server.core.task.TaskRegistry;
+
+    // Permissions
+    'com.hypixel.hytale.server.core.permissions.PermissionHolder': HytaleAPI.server.core.permissions.PermissionHolder;
+}
+
+/**
+ * GraalJS Java interop API.
+ * Use Java.type() to access raw Java classes with full autocomplete.
+ *
+ * @example
+ * const HytaleServer = Java.type('com.hypixel.hytale.server.core.HytaleServer');
+ * const server = HytaleServer.get();  // ← autocomplete works!
+ */
+interface JavaInterop {
+    /**
+     * Gets a Java class by its fully qualified name.
+     * Provides autocomplete for known Hytale classes.
+     */
+    type<K extends keyof JavaClassMap>(className: K): JavaClassMap[K];
+
+    /**
+     * Gets any Java class by its fully qualified name.
+     * Use this for classes not in the autocomplete list.
+     */
+    type<T = any>(className: string): T;
+}
+
+// Global declarations
+declare global {
+    /** The Hytale bridge API - available in all TypeScript mods */
+    const Hytale: HytaleBridge;
+
+    /** GraalJS Java interop - use to access raw Java classes */
+    const Java: JavaInterop;
+}
+
+export {
+    CommandContext,
+    CommandOptions,
+    CommandBridge,
+    EventBridge,
+    HytaleBridge,
+    JavaClassMap,
+    JavaInterop
+};

package/generated/.gitkeep

@@ -0,0 +1,3 @@
+# This folder contains auto-generated TypeScript types from Java classes.
+# Generated by running: mvn typescript-generator:generate
+# Do not edit these files manually - they will be overwritten.