@wumx-labs/noxaeapi-sdk 0.5.2 → 0.6.1

package/dist/index.d.cts

@@ -427,6 +427,210 @@ interface NetworkHubFindPlayerResponse {
 interface NetworkHubBroadcastResponse {
     delivered: number;
 }
+interface AuthMePlayerInfo {
+    name: string;
+    uuid: string;
+    registered: boolean;
+    authenticated: boolean;
+    lastIp: string;
+    lastLoginTime: number;
+}
+interface FastLoginPlayerInfo {
+    name: string;
+    uuid: string;
+    premium: boolean;
+}
+interface NLoginPlayerInfo {
+    name: string;
+    uuid: string;
+    registered: boolean;
+    authenticated: boolean;
+}
+interface LoginSecurityPlayerInfo {
+    name: string;
+    uuid: string;
+    registered: boolean;
+    authenticated: boolean;
+}
+interface BetterTeamsSummary {
+    name: string;
+    tag: string;
+    description: string;
+    score: number;
+    money: number;
+    level: number;
+    memberCount: number;
+    [key: string]: unknown;
+}
+interface BetterTeamsDetail extends BetterTeamsSummary {
+    members: string[];
+}
+interface BetterTeamsListResponse {
+    page: number;
+    limit: number;
+    total: number;
+    teams: BetterTeamsSummary[];
+}
+interface EssentialsHomeLocation {
+    name: string;
+    world: string;
+    x: number;
+    y: number;
+    z: number;
+    yaw?: number;
+    pitch?: number;
+}
+interface EssentialsPlayerHomesResponse {
+    player: string;
+    homes: EssentialsHomeLocation[];
+}
+interface EssentialsWarpsResponse {
+    total: number;
+    warps: string[];
+}
+interface EssentialsPlayerInfo {
+    player: string;
+    nickname?: string;
+    afk: boolean;
+    muted: boolean;
+    jailed: boolean;
+    godMode: boolean;
+    [key: string]: unknown;
+}
+interface GriefPreventionClaim {
+    id?: number | string;
+    owner?: string;
+    ownerUuid?: string;
+    world?: string;
+    greaterBoundary?: {
+        x: number;
+        y: number;
+        z: number;
+    };
+    lesserBoundary?: {
+        x: number;
+        y: number;
+        z: number;
+    };
+    area?: number;
+    [key: string]: unknown;
+}
+interface GriefPreventionClaimsResponse {
+    uuid: string;
+    total: number;
+    claims: GriefPreventionClaim[];
+}
+interface DiscordSRVLinkedResponse {
+    uuid: string;
+    discordId: string;
+}
+interface DiscordSRVBroadcastResponse {
+    success: boolean;
+    channel: string;
+    message: string;
+}
+interface PlayerPointsBalanceResponse {
+    uuid: string;
+    points: number;
+}
+interface PlayerPointsTransactionResult {
+    uuid: string;
+    amount: number;
+    success: boolean;
+    currentBalance: number;
+}
+interface WorldGuardRegion {
+    id: string;
+    type?: string;
+    priority?: number;
+    owners?: string[];
+    members?: string[];
+    flags?: Record<string, unknown>;
+    min?: {
+        x: number;
+        y: number;
+        z: number;
+    };
+    max?: {
+        x: number;
+        y: number;
+        z: number;
+    };
+    [key: string]: unknown;
+}
+interface PlanPlayerSummary {
+    uuid: string;
+    [key: string]: unknown;
+}
+interface GeyserPlayerInfo {
+    bedrock: boolean;
+    xuid?: string;
+    deviceOs?: string;
+    version?: string;
+    [key: string]: unknown;
+}
+interface MythicMobsListResponse {
+    total: number;
+    mobs: string[];
+}
+interface MythicMobSpawnOptions {
+    type: string;
+    world: string;
+    x: number;
+    y: number;
+    z: number;
+    level?: number;
+}
+interface MythicMobSpawnResponse {
+    success: boolean;
+    type: string;
+    world: string;
+    x: number;
+    y: number;
+    z: number;
+    level: number;
+}
+interface TabNametagResponse {
+    uuid: string;
+    prefix: string;
+    suffix: string;
+    success?: boolean;
+}
+interface CoreProtectLookupOptions {
+    time?: number;
+    user?: string;
+    limit?: number;
+}
+interface CoreProtectLookupEntry {
+    time?: number;
+    user?: string;
+    action?: string | number;
+    type?: string;
+    world?: string;
+    x?: number;
+    y?: number;
+    z?: number;
+    [key: string]: unknown;
+}
+interface CoreProtectLookupResponse {
+    total: number;
+    timeWindowSeconds: number;
+    userFilter: string;
+    results: CoreProtectLookupEntry[];
+}
+interface ShopGuiSummary {
+    id: string;
+    name?: string;
+    [key: string]: unknown;
+}
+interface ShopGuiListResponse {
+    total: number;
+    shops: ShopGuiSummary[];
+}
+interface ShopGuiShopDetail {
+    id: string;
+    [key: string]: unknown;
+}
 
 declare class PlayersModule {
     private readonly http;
@@ -1050,6 +1254,159 @@ declare class NetworkHubModule {
     }): Promise<T>;
 }
 
+declare class AuthMeModule {
+    private readonly http;
+    constructor(http: HttpEngine);
+    /** Gets AuthMe player auth details (registered, authenticated, lastIp, lastLoginTime). */
+    getPlayerAuth(name: string): Promise<AuthMePlayerInfo>;
+    /** Checks if the password matches the player's AuthMe password. */
+    checkPassword(name: string, password: string): Promise<PasswordCheckResult>;
+}
+declare class FastLoginModule {
+    private readonly http;
+    constructor(http: HttpEngine);
+    /** Checks if a player is running on a premium (Mojang-authenticated) account via FastLogin. */
+    getPlayerInfo(name: string): Promise<FastLoginPlayerInfo>;
+}
+declare class NLoginModule {
+    private readonly http;
+    constructor(http: HttpEngine);
+    /** Gets nLogin authentication and registration status for a player. */
+    getPlayerAuth(name: string): Promise<NLoginPlayerInfo>;
+}
+declare class LoginSecurityModule {
+    private readonly http;
+    constructor(http: HttpEngine);
+    /** Gets LoginSecurity authentication and registration status for a player. */
+    getPlayerAuth(name: string): Promise<LoginSecurityPlayerInfo>;
+}
+declare class BetterTeamsModule {
+    private readonly http;
+    constructor(http: HttpEngine);
+    /** Gets the team summary for a player by UUID or player name. */
+    getPlayerTeam(uuidOrName: string): Promise<BetterTeamsSummary>;
+    /** Gets full details of a team by team name, including member list. */
+    getTeam(name: string): Promise<BetterTeamsDetail>;
+    /** Gets a paginated list of all teams. */
+    getTeams(options?: {
+        page?: number;
+        limit?: number;
+    }): Promise<BetterTeamsListResponse>;
+}
+declare class EssentialsModule {
+    private readonly http;
+    constructor(http: HttpEngine);
+    /** Gets a player's home coordinates and list from Essentials. */
+    getPlayerHomes(name: string): Promise<EssentialsPlayerHomesResponse>;
+    /** Gets all configured server warps from Essentials. */
+    getWarps(): Promise<EssentialsWarpsResponse>;
+    /** Gets player state info from Essentials (nickname, afk, muted, jailed, godMode). */
+    getPlayerInfo(name: string): Promise<EssentialsPlayerInfo>;
+}
+declare class GriefPreventionModule {
+    private readonly http;
+    constructor(http: HttpEngine);
+    /** Gets all claims owned by a player by UUID. */
+    getPlayerClaims(uuid: string): Promise<GriefPreventionClaimsResponse>;
+    /** Gets claim details at a specific coordinate location. */
+    getClaimAt(world: string, x: number, z: number): Promise<GriefPreventionClaim | null>;
+}
+declare class DiscordSRVModule {
+    private readonly http;
+    constructor(http: HttpEngine);
+    /** Gets Discord user ID linked to a Minecraft player UUID. */
+    getLinked(uuid: string): Promise<DiscordSRVLinkedResponse>;
+    /** Broadcasts a message to a Discord channel configured in DiscordSRV. */
+    broadcast(message: string, channel?: string): Promise<DiscordSRVBroadcastResponse>;
+}
+declare class PlayerPointsModule {
+    private readonly http;
+    constructor(http: HttpEngine);
+    /** Gets points balance for a player UUID. */
+    getBalance(uuid: string): Promise<PlayerPointsBalanceResponse>;
+    /** Gives points to a player UUID. */
+    pay(uuid: string, amount: number): Promise<PlayerPointsTransactionResult>;
+    /** Deducts points from a player UUID. */
+    take(uuid: string, amount: number): Promise<PlayerPointsTransactionResult>;
+    /** Sets points balance for a player UUID to an exact amount. */
+    set(uuid: string, amount: number): Promise<PlayerPointsTransactionResult>;
+}
+declare class WorldGuardModule {
+    private readonly http;
+    constructor(http: HttpEngine);
+    /** Gets all WorldGuard regions across all loaded worlds. */
+    getAllRegions(): Promise<Record<string, WorldGuardRegion[]>>;
+    /** Gets a specific WorldGuard region in a world. */
+    getRegion(world: string, id: string): Promise<WorldGuardRegion>;
+}
+declare class PlanModule {
+    private readonly http;
+    constructor(http: HttpEngine);
+    /** Gets analytics summary for a player from Player Analytics (Plan). */
+    getPlayerSummary(uuid: string): Promise<PlanPlayerSummary>;
+}
+declare class GeyserModule {
+    private readonly http;
+    constructor(http: HttpEngine);
+    /** Checks Bedrock status, XUID, and device info for a player via Geyser/Floodgate. */
+    getPlayerInfo(uuid: string): Promise<GeyserPlayerInfo>;
+}
+declare class MythicMobsModule {
+    private readonly http;
+    constructor(http: HttpEngine);
+    /** Gets all registered custom mob types from MythicMobs. */
+    getMobs(): Promise<MythicMobsListResponse>;
+    /** Spawns a custom MythicMob at target location coordinates. */
+    spawn(options: MythicMobSpawnOptions): Promise<MythicMobSpawnResponse>;
+}
+declare class TabModule {
+    private readonly http;
+    constructor(http: HttpEngine);
+    /** Gets custom nametag prefix/suffix for a player from TAB. */
+    getNametag(uuid: string): Promise<TabNametagResponse>;
+    /** Sets custom nametag prefix/suffix for a player via TAB. */
+    setNametag(uuid: string, options: {
+        prefix?: string;
+        suffix?: string;
+    }): Promise<TabNametagResponse>;
+}
+declare class CoreProtectModule {
+    private readonly http;
+    constructor(http: HttpEngine);
+    /** Performs block and action history lookup via CoreProtect. */
+    lookup(options?: CoreProtectLookupOptions): Promise<CoreProtectLookupResponse>;
+}
+declare class ShopGuiModule {
+    private readonly http;
+    constructor(http: HttpEngine);
+    /** Gets all configured shops from ShopGUIPlus. */
+    getShops(): Promise<ShopGuiListResponse>;
+    /** Gets details of a specific shop by shop ID from ShopGUIPlus. */
+    getShop(id: string): Promise<ShopGuiShopDetail>;
+}
+/**
+ * Aggregates all external plugin integrations supported by NoxAeApi.
+ */
+declare class IntegrationsModule {
+    readonly authme: AuthMeModule;
+    readonly fastlogin: FastLoginModule;
+    readonly nlogin: NLoginModule;
+    readonly loginsecurity: LoginSecurityModule;
+    readonly betterteams: BetterTeamsModule;
+    readonly essentials: EssentialsModule;
+    readonly griefprevention: GriefPreventionModule;
+    readonly discordsrv: DiscordSRVModule;
+    readonly playerpoints: PlayerPointsModule;
+    readonly worldguard: WorldGuardModule;
+    readonly plan: PlanModule;
+    readonly geyser: GeyserModule;
+    readonly mythicmobs: MythicMobsModule;
+    readonly tab: TabModule;
+    readonly coreprotect: CoreProtectModule;
+    readonly shopgui: ShopGuiModule;
+    constructor(http: HttpEngine);
+}
+
 type NoxAeApiWsEvent = "open" | "close" | "error" | "console" | "event" | "message";
 type Listener = (payload: unknown) => void;
 interface NoxAeApiWsOptions {
@@ -1126,6 +1483,24 @@ declare class NoxAeApiClient {
      * and its response shapes differ.
      */
     readonly network: NetworkModule;
+    /** Comprehensive external plugin integrations suite. */
+    readonly integrations: IntegrationsModule;
+    readonly authme: AuthMeModule;
+    readonly fastlogin: FastLoginModule;
+    readonly nlogin: NLoginModule;
+    readonly loginsecurity: LoginSecurityModule;
+    readonly betterteams: BetterTeamsModule;
+    readonly essentials: EssentialsModule;
+    readonly griefprevention: GriefPreventionModule;
+    readonly discordsrv: DiscordSRVModule;
+    readonly playerpoints: PlayerPointsModule;
+    readonly worldguard: WorldGuardModule;
+    readonly plan: PlanModule;
+    readonly geyser: GeyserModule;
+    readonly mythicmobs: MythicMobsModule;
+    readonly tab: TabModule;
+    readonly coreprotect: CoreProtectModule;
+    readonly shopgui: ShopGuiModule;
     private readonly http;
     private readonly baseUrl;
     private readonly apiKey?;
@@ -1223,4 +1598,4 @@ declare class NoxAeApiNetworkError extends Error {
     constructor(message: string, method: string, path: string, cause?: unknown);
 }
 
-export { type AddPermissionOptions, type Advancement, type CurrencyBalance, type CurrencyTopEntry, type EconomyInfo, type GroupInfo, type IdentityInfo, IdentityModule, type IdentityServerInfo, type InventoryItem, type LeaderboardEntry, type LeaderboardSourceInfo, type LuckPermsCheckPermissionResult, type LuckPermsContextOptions, type LuckPermsCreateGroupResult, type LuckPermsPrimaryGroupResult, type LuckPermsTrackActionResult, type MetaInfo, type NetworkBroadcastResponse, type NetworkFindPlayerResponse, type NetworkHealthResponse, type NetworkHealthServerEntry, type NetworkHubBroadcastResponse, type NetworkHubFindPlayerResponse, type NetworkHubNode, type NetworkHubPlayer, type NetworkHubPlayersResponse, type NetworkHubStatusResponse, type NetworkPlayersResponse, type NetworkPlayersServerEntry, type NetworkServerStatus, NoxAeApiClient, type NoxAeApiClientOptions, NoxAeApiError, NoxAeApiForbiddenError, NoxAeApiNetworkError, NoxAeApiNetworkHubClient, NoxAeApiNotFoundError, NoxAeApiRateLimitError, NoxAeApiServerError, NoxAeApiSocket, NoxAeApiUnauthorizedError, type NoxAeApiWsEvent, type NoxAeApiWsOptions, type NoxAuthPlayerInfo, type Objective, type OfflinePlayer, type OnlinePlayer, type PasswordCheckResult, type PermissionNode, type PlayerBalance, type PlayerProfile, type PlayerProfileBan, type PlayerProfileEconomy, type PlayerProfileStatTile, type PlayerProfileStatus, type PlayerProfilesResponse, type PlayerResolveResult, type PlayerStats, type Plugin, type RetryOptions, type Score, type Scoreboard, type ServerBan, type ServerHealth, type ServerInfo, type SetGroupOptions, type SetMetaValueOptions, type SkillInfo, type TopBalanceEntry, type TrackInfo, type WhitelistEntry, type World };
+export { type AddPermissionOptions, type Advancement, AuthMeModule, type AuthMePlayerInfo, type BetterTeamsDetail, type BetterTeamsListResponse, BetterTeamsModule, type BetterTeamsSummary, type CoreProtectLookupEntry, type CoreProtectLookupOptions, type CoreProtectLookupResponse, CoreProtectModule, type CurrencyBalance, type CurrencyTopEntry, type DiscordSRVBroadcastResponse, type DiscordSRVLinkedResponse, DiscordSRVModule, type EconomyInfo, type EssentialsHomeLocation, EssentialsModule, type EssentialsPlayerHomesResponse, type EssentialsPlayerInfo, type EssentialsWarpsResponse, FastLoginModule, type FastLoginPlayerInfo, GeyserModule, type GeyserPlayerInfo, type GriefPreventionClaim, type GriefPreventionClaimsResponse, GriefPreventionModule, type GroupInfo, type IdentityInfo, IdentityModule, type IdentityServerInfo, IntegrationsModule, type InventoryItem, type LeaderboardEntry, type LeaderboardSourceInfo, LoginSecurityModule, type LoginSecurityPlayerInfo, type LuckPermsCheckPermissionResult, type LuckPermsContextOptions, type LuckPermsCreateGroupResult, type LuckPermsPrimaryGroupResult, type LuckPermsTrackActionResult, type MetaInfo, type MythicMobSpawnOptions, type MythicMobSpawnResponse, type MythicMobsListResponse, MythicMobsModule, NLoginModule, type NLoginPlayerInfo, type NetworkBroadcastResponse, type NetworkFindPlayerResponse, type NetworkHealthResponse, type NetworkHealthServerEntry, type NetworkHubBroadcastResponse, type NetworkHubFindPlayerResponse, type NetworkHubNode, type NetworkHubPlayer, type NetworkHubPlayersResponse, type NetworkHubStatusResponse, type NetworkPlayersResponse, type NetworkPlayersServerEntry, type NetworkServerStatus, NoxAeApiClient, type NoxAeApiClientOptions, NoxAeApiError, NoxAeApiForbiddenError, NoxAeApiNetworkError, NoxAeApiNetworkHubClient, NoxAeApiNotFoundError, NoxAeApiRateLimitError, NoxAeApiServerError, NoxAeApiSocket, NoxAeApiUnauthorizedError, type NoxAeApiWsEvent, type NoxAeApiWsOptions, type NoxAuthPlayerInfo, type Objective, type OfflinePlayer, type OnlinePlayer, type PasswordCheckResult, type PermissionNode, PlanModule, type PlanPlayerSummary, type PlayerBalance, type PlayerPointsBalanceResponse, PlayerPointsModule, type PlayerPointsTransactionResult, type PlayerProfile, type PlayerProfileBan, type PlayerProfileEconomy, type PlayerProfileStatTile, type PlayerProfileStatus, type PlayerProfilesResponse, type PlayerResolveResult, type PlayerStats, type Plugin, type RetryOptions, type Score, type Scoreboard, type ServerBan, type ServerHealth, type ServerInfo, type SetGroupOptions, type SetMetaValueOptions, type ShopGuiListResponse, ShopGuiModule, type ShopGuiShopDetail, type ShopGuiSummary, type SkillInfo, TabModule, type TabNametagResponse, type TopBalanceEntry, type TrackInfo, type WhitelistEntry, type World, WorldGuardModule, type WorldGuardRegion };