@wumx-labs/noxaeapi-sdk 0.5.2 → 0.6.1

package/README.md

@@ -114,16 +114,42 @@ Javalin handler uses before wiring it up, and pass `form: true` to
 case). Getting this wrong won't throw a type error — the request just
 silently sends the wrong content type and the server won't see the field.
 
-## Optional modules
-
-Some modules only work depending on the target server's setup:
-
-- `client.luckperms.*` — requires the LuckPerms mod to be loaded on the server
-- `client.noxauth.*` — requires `noxauth.enabled: true` in the server's `noxaeapi-config.yml`
-- `client.economy.getCurrencyBalance()`/`.payCurrency()`/`.debitCurrency()`/`.setCurrencyBalance()`/`.getCurrencyTop()`/`.listCurrencies()` — requires ExcellentEconomy (throws a 424 error if it isn't installed)
-- `client.network.*` — requires `network.enabled: true` with at least one backend server configured in the server's config
-
-Calling these against a server without the corresponding feature enabled will fail (typically 404).
+## Optional modules & Integrations
+
+Some modules and external integrations depend on plugins loaded on the target server:
+
+- `client.luckperms.*` — requires LuckPerms
+- `client.noxauth.*` — requires `noxauth.enabled: true`
+- `client.economy.getCurrencyBalance()`/`.payCurrency()`/... — requires ExcellentEconomy
+- `client.network.*` — requires `network.enabled: true` with backend nodes configured
+
+### Plugin Integrations Suite (`client.integrations.*` / top-level shortcuts)
+
+NoxAeApi 1.5.0 supports deep integration with standard Spigot/Paper plugins:
+
+- **Auth**:
+  - `client.authme` (`client.integrations.authme`) — AuthMe Reloaded player info & password validation
+  - `client.fastlogin` (`client.integrations.fastlogin`) — FastLogin premium / Mojang-verified status
+  - `client.nlogin` (`client.integrations.nlogin`) — nLogin player authentication & registration status
+  - `client.loginsecurity` (`client.integrations.loginsecurity`) — LoginSecurity auth status
+- **Clans & Teams**:
+  - `client.betterteams` (`client.integrations.betterteams`) — Player teams, team details, and paginated team listings
+- **Server Utility**:
+  - `client.essentials` (`client.integrations.essentials`) — Player homes, server warps, and player info (afk, muted, godmode)
+  - `client.discordsrv` (`client.integrations.discordsrv`) — Discord linked account lookups and channel broadcasts
+  - `client.plan` (`client.integrations.plan`) — Player Analytics (Plan) player session and activity summaries
+  - `client.geyser` (`client.integrations.geyser`) — Geyser / Floodgate Bedrock player detection, XUID, and OS
+  - `client.tab` (`client.integrations.tab`) — TAB prefix/suffix reading and custom nametag updates
+- **Economy & Protection**:
+  - `client.playerpoints` (`client.integrations.playerpoints`) — PlayerPoints balance check, pay, take, and set
+  - `client.griefprevention` (`client.integrations.griefprevention`) — Player claims and coordinate claim inspections
+  - `client.worldguard` (`client.integrations.worldguard`) — Region boundaries, flags, and world listings
+  - `client.coreprotect` (`client.integrations.coreprotect`) — Block / action audit logs and rollback history lookup
+  - `client.shopgui` (`client.integrations.shopgui`) — ShopGUIPlus shop catalogs and item pricing details
+- **Custom Content**:
+  - `client.mythicmobs` (`client.integrations.mythicmobs`) — Mob catalog listing and coordinate-based mob spawning
+
+Calling integration endpoints when the corresponding backing plugin is not installed will safely return a 503 Service Unavailable error.
 
 ## NoxAeApi-Velocity network hub
 

package/dist/index.cjs

@@ -1120,6 +1120,289 @@ var NetworkHubModule = class {
   }
 };
 
+// src/modules/integrations.ts
+var AuthMeModule = class {
+  constructor(http) {
+    this.http = http;
+  }
+  http;
+  /** Gets AuthMe player auth details (registered, authenticated, lastIp, lastLoginTime). */
+  getPlayerAuth(name) {
+    return this.http.request("GET", `authme/player/${encodeURIComponent(name)}`);
+  }
+  /** Checks if the password matches the player's AuthMe password. */
+  checkPassword(name, password) {
+    return this.http.request(
+      "POST",
+      `authme/player/${encodeURIComponent(name)}/check-password`,
+      { body: { password } }
+    );
+  }
+};
+var FastLoginModule = class {
+  constructor(http) {
+    this.http = http;
+  }
+  http;
+  /** Checks if a player is running on a premium (Mojang-authenticated) account via FastLogin. */
+  getPlayerInfo(name) {
+    return this.http.request("GET", `fastlogin/player/${encodeURIComponent(name)}`);
+  }
+};
+var NLoginModule = class {
+  constructor(http) {
+    this.http = http;
+  }
+  http;
+  /** Gets nLogin authentication and registration status for a player. */
+  getPlayerAuth(name) {
+    return this.http.request("GET", `nlogin/player/${encodeURIComponent(name)}`);
+  }
+};
+var LoginSecurityModule = class {
+  constructor(http) {
+    this.http = http;
+  }
+  http;
+  /** Gets LoginSecurity authentication and registration status for a player. */
+  getPlayerAuth(name) {
+    return this.http.request("GET", `loginsecurity/player/${encodeURIComponent(name)}`);
+  }
+};
+var BetterTeamsModule = class {
+  constructor(http) {
+    this.http = http;
+  }
+  http;
+  /** Gets the team summary for a player by UUID or player name. */
+  getPlayerTeam(uuidOrName) {
+    return this.http.request("GET", `betterteams/player/${encodeURIComponent(uuidOrName)}`);
+  }
+  /** Gets full details of a team by team name, including member list. */
+  getTeam(name) {
+    return this.http.request("GET", `betterteams/team/${encodeURIComponent(name)}`);
+  }
+  /** Gets a paginated list of all teams. */
+  getTeams(options = {}) {
+    return this.http.request("GET", "betterteams/teams", {
+      query: { page: options.page, limit: options.limit }
+    });
+  }
+};
+var EssentialsModule = class {
+  constructor(http) {
+    this.http = http;
+  }
+  http;
+  /** Gets a player's home coordinates and list from Essentials. */
+  getPlayerHomes(name) {
+    return this.http.request("GET", `essentials/player/${encodeURIComponent(name)}/homes`);
+  }
+  /** Gets all configured server warps from Essentials. */
+  getWarps() {
+    return this.http.request("GET", "essentials/warps");
+  }
+  /** Gets player state info from Essentials (nickname, afk, muted, jailed, godMode). */
+  getPlayerInfo(name) {
+    return this.http.request("GET", `essentials/player/${encodeURIComponent(name)}/info`);
+  }
+};
+var GriefPreventionModule = class {
+  constructor(http) {
+    this.http = http;
+  }
+  http;
+  /** Gets all claims owned by a player by UUID. */
+  getPlayerClaims(uuid) {
+    return this.http.request("GET", `claims/player/${encodeURIComponent(uuid)}`);
+  }
+  /** Gets claim details at a specific coordinate location. */
+  getClaimAt(world, x, z) {
+    return this.http.request("GET", "claims", {
+      query: { world, x, z }
+    });
+  }
+};
+var DiscordSRVModule = class {
+  constructor(http) {
+    this.http = http;
+  }
+  http;
+  /** Gets Discord user ID linked to a Minecraft player UUID. */
+  getLinked(uuid) {
+    return this.http.request("GET", `discordsrv/linked/${encodeURIComponent(uuid)}`);
+  }
+  /** Broadcasts a message to a Discord channel configured in DiscordSRV. */
+  broadcast(message, channel = "global") {
+    return this.http.request("POST", "discordsrv/broadcast", {
+      body: { message, channel }
+    });
+  }
+};
+var PlayerPointsModule = class {
+  constructor(http) {
+    this.http = http;
+  }
+  http;
+  /** Gets points balance for a player UUID. */
+  getBalance(uuid) {
+    return this.http.request("GET", `playerpoints/${encodeURIComponent(uuid)}/balance`);
+  }
+  /** Gives points to a player UUID. */
+  pay(uuid, amount) {
+    return this.http.request("POST", `playerpoints/${encodeURIComponent(uuid)}/pay`, {
+      body: { amount }
+    });
+  }
+  /** Deducts points from a player UUID. */
+  take(uuid, amount) {
+    return this.http.request("POST", `playerpoints/${encodeURIComponent(uuid)}/take`, {
+      body: { amount }
+    });
+  }
+  /** Sets points balance for a player UUID to an exact amount. */
+  set(uuid, amount) {
+    return this.http.request("POST", `playerpoints/${encodeURIComponent(uuid)}/set`, {
+      body: { amount }
+    });
+  }
+};
+var WorldGuardModule = class {
+  constructor(http) {
+    this.http = http;
+  }
+  http;
+  /** Gets all WorldGuard regions across all loaded worlds. */
+  getAllRegions() {
+    return this.http.request("GET", "worldguard/regions");
+  }
+  /** Gets a specific WorldGuard region in a world. */
+  getRegion(world, id) {
+    return this.http.request(
+      "GET",
+      `worldguard/regions/${encodeURIComponent(world)}/${encodeURIComponent(id)}`
+    );
+  }
+};
+var PlanModule = class {
+  constructor(http) {
+    this.http = http;
+  }
+  http;
+  /** Gets analytics summary for a player from Player Analytics (Plan). */
+  getPlayerSummary(uuid) {
+    return this.http.request("GET", `plan/player/${encodeURIComponent(uuid)}/summary`);
+  }
+};
+var GeyserModule = class {
+  constructor(http) {
+    this.http = http;
+  }
+  http;
+  /** Checks Bedrock status, XUID, and device info for a player via Geyser/Floodgate. */
+  getPlayerInfo(uuid) {
+    return this.http.request("GET", `geyser/player/${encodeURIComponent(uuid)}`);
+  }
+};
+var MythicMobsModule = class {
+  constructor(http) {
+    this.http = http;
+  }
+  http;
+  /** Gets all registered custom mob types from MythicMobs. */
+  getMobs() {
+    return this.http.request("GET", "mythicmobs/mobs");
+  }
+  /** Spawns a custom MythicMob at target location coordinates. */
+  spawn(options) {
+    return this.http.request("POST", "mythicmobs/spawn", {
+      body: options
+    });
+  }
+};
+var TabModule = class {
+  constructor(http) {
+    this.http = http;
+  }
+  http;
+  /** Gets custom nametag prefix/suffix for a player from TAB. */
+  getNametag(uuid) {
+    return this.http.request("GET", `tab/player/${encodeURIComponent(uuid)}/nametag`);
+  }
+  /** Sets custom nametag prefix/suffix for a player via TAB. */
+  setNametag(uuid, options) {
+    return this.http.request("POST", `tab/player/${encodeURIComponent(uuid)}/nametag`, {
+      body: options
+    });
+  }
+};
+var CoreProtectModule = class {
+  constructor(http) {
+    this.http = http;
+  }
+  http;
+  /** Performs block and action history lookup via CoreProtect. */
+  lookup(options = {}) {
+    return this.http.request("GET", "coreprotect/lookup", {
+      query: {
+        time: options.time,
+        user: options.user,
+        limit: options.limit
+      }
+    });
+  }
+};
+var ShopGuiModule = class {
+  constructor(http) {
+    this.http = http;
+  }
+  http;
+  /** Gets all configured shops from ShopGUIPlus. */
+  getShops() {
+    return this.http.request("GET", "shopgui/shops");
+  }
+  /** Gets details of a specific shop by shop ID from ShopGUIPlus. */
+  getShop(id) {
+    return this.http.request("GET", `shopgui/shop/${encodeURIComponent(id)}`);
+  }
+};
+var IntegrationsModule = class {
+  authme;
+  fastlogin;
+  nlogin;
+  loginsecurity;
+  betterteams;
+  essentials;
+  griefprevention;
+  discordsrv;
+  playerpoints;
+  worldguard;
+  plan;
+  geyser;
+  mythicmobs;
+  tab;
+  coreprotect;
+  shopgui;
+  constructor(http) {
+    this.authme = new AuthMeModule(http);
+    this.fastlogin = new FastLoginModule(http);
+    this.nlogin = new NLoginModule(http);
+    this.loginsecurity = new LoginSecurityModule(http);
+    this.betterteams = new BetterTeamsModule(http);
+    this.essentials = new EssentialsModule(http);
+    this.griefprevention = new GriefPreventionModule(http);
+    this.discordsrv = new DiscordSRVModule(http);
+    this.playerpoints = new PlayerPointsModule(http);
+    this.worldguard = new WorldGuardModule(http);
+    this.plan = new PlanModule(http);
+    this.geyser = new GeyserModule(http);
+    this.mythicmobs = new MythicMobsModule(http);
+    this.tab = new TabModule(http);
+    this.coreprotect = new CoreProtectModule(http);
+    this.shopgui = new ShopGuiModule(http);
+  }
+};
+
 // src/socket.ts
 function toWsUrl(baseUrl, route, apiKey) {
   const url = new URL(`${baseUrl.replace(/\/+$/, "")}/v1/ws/${route.replace(/^\/+/, "")}`);
@@ -1242,6 +1525,24 @@ var NoxAeApiClient = class _NoxAeApiClient {
    * and its response shapes differ.
    */
   network;
+  /** Comprehensive external plugin integrations suite. */
+  integrations;
+  authme;
+  fastlogin;
+  nlogin;
+  loginsecurity;
+  betterteams;
+  essentials;
+  griefprevention;
+  discordsrv;
+  playerpoints;
+  worldguard;
+  plan;
+  geyser;
+  mythicmobs;
+  tab;
+  coreprotect;
+  shopgui;
   http;
   baseUrl;
   apiKey;
@@ -1262,6 +1563,23 @@ var NoxAeApiClient = class _NoxAeApiClient {
     this.skills = new SkillsModule(this.http);
     this.leaderboards = new LeaderboardModule(this.http);
     this.network = new NetworkModule(this.http);
+    this.integrations = new IntegrationsModule(this.http);
+    this.authme = this.integrations.authme;
+    this.fastlogin = this.integrations.fastlogin;
+    this.nlogin = this.integrations.nlogin;
+    this.loginsecurity = this.integrations.loginsecurity;
+    this.betterteams = this.integrations.betterteams;
+    this.essentials = this.integrations.essentials;
+    this.griefprevention = this.integrations.griefprevention;
+    this.discordsrv = this.integrations.discordsrv;
+    this.playerpoints = this.integrations.playerpoints;
+    this.worldguard = this.integrations.worldguard;
+    this.plan = this.integrations.plan;
+    this.geyser = this.integrations.geyser;
+    this.mythicmobs = this.integrations.mythicmobs;
+    this.tab = this.integrations.tab;
+    this.coreprotect = this.integrations.coreprotect;
+    this.shopgui = this.integrations.shopgui;
   }
   /**
    * Build a client from environment variables:
@@ -1320,7 +1638,19 @@ var NoxAeApiNetworkHubClient = class _NoxAeApiNetworkHubClient {
   }
 };
 
+exports.AuthMeModule = AuthMeModule;
+exports.BetterTeamsModule = BetterTeamsModule;
+exports.CoreProtectModule = CoreProtectModule;
+exports.DiscordSRVModule = DiscordSRVModule;
+exports.EssentialsModule = EssentialsModule;
+exports.FastLoginModule = FastLoginModule;
+exports.GeyserModule = GeyserModule;
+exports.GriefPreventionModule = GriefPreventionModule;
 exports.IdentityModule = IdentityModule;
+exports.IntegrationsModule = IntegrationsModule;
+exports.LoginSecurityModule = LoginSecurityModule;
+exports.MythicMobsModule = MythicMobsModule;
+exports.NLoginModule = NLoginModule;
 exports.NoxAeApiClient = NoxAeApiClient;
 exports.NoxAeApiError = NoxAeApiError;
 exports.NoxAeApiForbiddenError = NoxAeApiForbiddenError;
@@ -1331,5 +1661,10 @@ exports.NoxAeApiRateLimitError = NoxAeApiRateLimitError;
 exports.NoxAeApiServerError = NoxAeApiServerError;
 exports.NoxAeApiSocket = NoxAeApiSocket;
 exports.NoxAeApiUnauthorizedError = NoxAeApiUnauthorizedError;
+exports.PlanModule = PlanModule;
+exports.PlayerPointsModule = PlayerPointsModule;
+exports.ShopGuiModule = ShopGuiModule;
+exports.TabModule = TabModule;
+exports.WorldGuardModule = WorldGuardModule;
 //# sourceMappingURL=index.cjs.map
 //# sourceMappingURL=index.cjs.map