@wumx-labs/noxaeapi-sdk 0.5.0 → 0.5.1

package/dist/index.d.cts

@@ -82,6 +82,19 @@ interface PlayerResolveResult {
     name: string;
     uuid: string;
 }
+interface IdentityServerInfo {
+    id: string;
+    label: string;
+}
+/** Result of resolving player identity via `GET /v1/identity/{name}`. */
+interface IdentityInfo {
+    username: string;
+    identityUuid: string;
+    localUuid: string | null;
+    server: IdentityServerInfo;
+    onlineMode: boolean;
+    hasPlayedBefore: boolean;
+}
 interface ServerHealth {
     cpus: number;
     uptime: number;
@@ -828,6 +841,27 @@ declare class NoxAuthModule {
     checkPassword(name: string, password: string): Promise<PasswordCheckResult>;
 }
 
+/**
+ * Wraps the /v1/identity/* routes.
+ *
+ * Resolves a username to its deterministic network-wide identityUuid and
+ * returns whether the player has ever joined this backend server (along with
+ * this server's localUuid).
+ */
+declare class IdentityModule {
+    private readonly http;
+    constructor(http: HttpEngine);
+    /**
+     * Resolves a player's network-wide identity and local UUID status.
+     *
+     * Unlike players.resolve(name), this does NOT throw 404 if the player
+     * has never joined this server. Instead, identityUuid is always computed
+     * deterministically from the username, and hasPlayedBefore will be false
+     * with localUuid: null.
+     */
+    get(name: string): Promise<IdentityInfo>;
+}
+
 /**
  * Wraps the `/v1/skills/*` routes (mcMMO / AuraSkills).
  */
@@ -1065,6 +1099,7 @@ declare class NoxAeApiSocket {
 
 declare class NoxAeApiClient {
     readonly players: PlayersModule;
+    readonly identity: IdentityModule;
     readonly economy: EconomyModule;
     readonly server: ServerModule;
     readonly worlds: WorldsModule;
@@ -1188,4 +1223,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 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, 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 };

package/dist/index.d.ts

@@ -82,6 +82,19 @@ interface PlayerResolveResult {
     name: string;
     uuid: string;
 }
+interface IdentityServerInfo {
+    id: string;
+    label: string;
+}
+/** Result of resolving player identity via `GET /v1/identity/{name}`. */
+interface IdentityInfo {
+    username: string;
+    identityUuid: string;
+    localUuid: string | null;
+    server: IdentityServerInfo;
+    onlineMode: boolean;
+    hasPlayedBefore: boolean;
+}
 interface ServerHealth {
     cpus: number;
     uptime: number;
@@ -828,6 +841,27 @@ declare class NoxAuthModule {
     checkPassword(name: string, password: string): Promise<PasswordCheckResult>;
 }
 
+/**
+ * Wraps the /v1/identity/* routes.
+ *
+ * Resolves a username to its deterministic network-wide identityUuid and
+ * returns whether the player has ever joined this backend server (along with
+ * this server's localUuid).
+ */
+declare class IdentityModule {
+    private readonly http;
+    constructor(http: HttpEngine);
+    /**
+     * Resolves a player's network-wide identity and local UUID status.
+     *
+     * Unlike players.resolve(name), this does NOT throw 404 if the player
+     * has never joined this server. Instead, identityUuid is always computed
+     * deterministically from the username, and hasPlayedBefore will be false
+     * with localUuid: null.
+     */
+    get(name: string): Promise<IdentityInfo>;
+}
+
 /**
  * Wraps the `/v1/skills/*` routes (mcMMO / AuraSkills).
  */
@@ -1065,6 +1099,7 @@ declare class NoxAeApiSocket {
 
 declare class NoxAeApiClient {
     readonly players: PlayersModule;
+    readonly identity: IdentityModule;
     readonly economy: EconomyModule;
     readonly server: ServerModule;
     readonly worlds: WorldsModule;
@@ -1188,4 +1223,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 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, 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 };

package/dist/index.js

@@ -918,6 +918,25 @@ var NoxAuthModule = class {
   }
 };
 
+// src/modules/identity.ts
+var IdentityModule = class {
+  constructor(http) {
+    this.http = http;
+  }
+  http;
+  /**
+   * Resolves a player's network-wide identity and local UUID status.
+   *
+   * Unlike players.resolve(name), this does NOT throw 404 if the player
+   * has never joined this server. Instead, identityUuid is always computed
+   * deterministically from the username, and hasPlayedBefore will be false
+   * with localUuid: null.
+   */
+  get(name) {
+    return this.http.request("GET", `identity/${encodeURIComponent(name)}`);
+  }
+};
+
 // src/modules/skills.ts
 var SkillsModule = class {
   constructor(http) {
@@ -1194,6 +1213,7 @@ function safeParse(text) {
 // src/client.ts
 var NoxAeApiClient = class _NoxAeApiClient {
   players;
+  identity;
   economy;
   server;
   worlds;
@@ -1228,6 +1248,7 @@ var NoxAeApiClient = class _NoxAeApiClient {
     this.baseUrl = options.baseUrl;
     this.apiKey = options.apiKey;
     this.players = new PlayersModule(this.http);
+    this.identity = new IdentityModule(this.http);
     this.economy = new EconomyModule(this.http);
     this.server = new ServerModule(this.http);
     this.worlds = new WorldsModule(this.http);
@@ -1297,6 +1318,6 @@ var NoxAeApiNetworkHubClient = class _NoxAeApiNetworkHubClient {
   }
 };
 
-export { NoxAeApiClient, NoxAeApiError, NoxAeApiForbiddenError, NoxAeApiNetworkError, NoxAeApiNetworkHubClient, NoxAeApiNotFoundError, NoxAeApiRateLimitError, NoxAeApiServerError, NoxAeApiSocket, NoxAeApiUnauthorizedError };
+export { IdentityModule, NoxAeApiClient, NoxAeApiError, NoxAeApiForbiddenError, NoxAeApiNetworkError, NoxAeApiNetworkHubClient, NoxAeApiNotFoundError, NoxAeApiRateLimitError, NoxAeApiServerError, NoxAeApiSocket, NoxAeApiUnauthorizedError };
 //# sourceMappingURL=index.js.map
 //# sourceMappingURL=index.js.map