@easecation/ecapi-sdk 0.1.0 → 0.1.1

package/dist/apis.d.ts

@@ -1,6 +1,10 @@
 import { ECAPIHttpClient } from "./http";
 import { QueryParams, RequestOptions } from "./types";
 type NonBodyOptions = Omit<RequestOptions, "query" | "body">;
+/**
+ * Shared low-level HTTP wrappers used by all API groups.
+ * These helpers keep auth/header/retry behavior consistent across modules.
+ */
 declare class BaseApi {
     protected readonly http: ECAPIHttpClient;
     constructor(http: ECAPIHttpClient);
@@ -11,36 +15,64 @@ declare class BaseApi {
     protected delete<T = unknown>(path: string, query?: QueryParams, options?: Omit<RequestOptions, "query">): Promise<T>;
 }
 export declare class UserApi extends BaseApi {
+    /**
+     * Get current user profile.
+     * Note: backend expects Authorization token for this endpoint in some deployments.
+     */
     getMe(query?: QueryParams, options?: NonBodyOptions): Promise<unknown>;
     loginByPassword(payload: Record<string, unknown>, options?: Omit<RequestOptions, "body">): Promise<unknown>;
     loginByOauth2(payload: Record<string, unknown>, options?: Omit<RequestOptions, "body">): Promise<unknown>;
     refreshToken(payload: Record<string, unknown>, options?: Omit<RequestOptions, "body">): Promise<unknown>;
+    /**
+     * Get current user's OpenID.
+     * May return 404 if OpenID context is unavailable for current auth mode.
+     */
     getOpenId(query?: QueryParams, options?: NonBodyOptions): Promise<unknown>;
+    /** List all registered users (admin-scoped endpoint). */
     listAll(query?: QueryParams, options?: NonBodyOptions): Promise<unknown>;
     updatePermissions(payload: Record<string, unknown>, options?: Omit<RequestOptions, "body">): Promise<unknown>;
+    /** Query user detail by user id. */
     getById(id: string, query?: QueryParams, options?: NonBodyOptions): Promise<unknown>;
 }
 export declare class PlayerScoreApi extends BaseApi {
+    /**
+     * Get player score summary.
+     * Common required query: `nick`, `game`.
+     */
     getScore(query?: QueryParams, options?: NonBodyOptions): Promise<unknown>;
+    /** Get player score stages. Common required query: `nick`. */
     getStages(query?: QueryParams, options?: NonBodyOptions): Promise<unknown>;
+    /**
+     * Get top ranking records.
+     * Common required query: `game`, `score_type`, `deadline_type`, `limit`, `is_ascending`.
+     */
     getTop(query?: QueryParams, options?: NonBodyOptions): Promise<unknown>;
     deleteTop(query?: QueryParams, options?: Omit<RequestOptions, "query">): Promise<unknown>;
     getConfig(query?: QueryParams, options?: NonBodyOptions): Promise<unknown>;
     getLeaderboard(query?: QueryParams, options?: NonBodyOptions): Promise<unknown>;
 }
 export declare class PlayerTasksApi extends BaseApi {
+    /**
+     * List tasks for one player.
+     * Common required query: `current`, `pageSize`.
+     */
     list(ecid: string, query?: QueryParams, options?: NonBodyOptions): Promise<unknown>;
     create(ecid: string, payload: Record<string, unknown>, options?: Omit<RequestOptions, "body">): Promise<unknown>;
     update(ecid: string, taskId: string, payload: Record<string, unknown>, options?: Omit<RequestOptions, "body">): Promise<unknown>;
     deleteOne(ecid: string, taskId: string, query?: QueryParams, options?: Omit<RequestOptions, "query">): Promise<unknown>;
 }
 export declare class PlayerMerchandiseApi extends BaseApi {
+    /**
+     * List merchandise items for one player.
+     * Common required query: `current`, `pageSize`.
+     */
     list(ecid: string, query?: QueryParams, options?: NonBodyOptions): Promise<unknown>;
     create(ecid: string, payload: Record<string, unknown>, options?: Omit<RequestOptions, "body">): Promise<unknown>;
     update(ecid: string, idItem: string, payload: Record<string, unknown>, options?: Omit<RequestOptions, "body">): Promise<unknown>;
     deleteOne(ecid: string, idItem: string, query?: QueryParams, options?: Omit<RequestOptions, "query">): Promise<unknown>;
 }
 export declare class PlayerYearSummaryApi extends BaseApi {
+    /** Get year summary basic info. Common required query: `ecid` (optional `year`). */
     getBasicInfo(query?: QueryParams, options?: NonBodyOptions): Promise<unknown>;
     getLoginStats(query?: QueryParams, options?: NonBodyOptions): Promise<unknown>;
     getGameStats(query?: QueryParams, options?: NonBodyOptions): Promise<unknown>;
@@ -49,8 +81,10 @@ export declare class PlayerYearSummaryApi extends BaseApi {
     getSocialData(query?: QueryParams, options?: NonBodyOptions): Promise<unknown>;
 }
 export declare class PlayerVoteApi extends BaseApi {
+    /** Process vote rewards. Common required query: `players` (semicolon-separated). */
     processRewards(query?: QueryParams, options?: NonBodyOptions): Promise<unknown>;
 }
+/** Player-related endpoints and nested modules. */
 export declare class PlayerApi extends BaseApi {
     readonly score: PlayerScoreApi;
     readonly tasks: PlayerTasksApi;
@@ -58,25 +92,36 @@ export declare class PlayerApi extends BaseApi {
     readonly yearSummary: PlayerYearSummaryApi;
     readonly vote: PlayerVoteApi;
     constructor(http: ECAPIHttpClient);
+    /** Get online/runtime player info. Common required query: `name`. */
     getInfo(query?: QueryParams, options?: NonBodyOptions): Promise<unknown>;
+    /** Search ECID by nickname/ecid keyword. Common required query: `name`. */
     searchEcid(query?: QueryParams, options?: NonBodyOptions): Promise<unknown>;
+    /** Get player profile data. Common required query: `ecid`. */
     getUserData(query?: QueryParams, options?: NonBodyOptions): Promise<unknown>;
+    /** Query NetEase player data. Common required query: `name`. */
     queryNetease(query?: QueryParams, options?: NonBodyOptions): Promise<unknown>;
     setRankLevel(payload: Record<string, unknown>, options?: Omit<RequestOptions, "body">): Promise<unknown>;
     clearRespackCache(query?: QueryParams, options?: Omit<RequestOptions, "query">): Promise<unknown>;
+    /** Get wallet info. Common required query: `ecid`. */
     getWallet(query?: QueryParams, options?: NonBodyOptions): Promise<unknown>;
     listGamingTags(query?: QueryParams, options?: NonBodyOptions): Promise<unknown>;
     operateGamingTag(payload: Record<string, unknown>, options?: Omit<RequestOptions, "body">): Promise<unknown>;
+    /** Get recent play history. Common required query: `ecid`. */
     getLastPlayed(query?: QueryParams, options?: NonBodyOptions): Promise<unknown>;
+    /** Get stage records. Common required query: `ecid`, `start`, `end`. */
     getStageRecord(query?: QueryParams, options?: NonBodyOptions): Promise<unknown>;
+    /** Get player head icon as binary image data. Common required query: `ecid`. */
     getHeadicon(query?: QueryParams, options?: Omit<RequestOptions, "query" | "responseType">): Promise<ArrayBuffer>;
+    /** Get player skin as binary image data. Common required query: `ecid`. */
     getSkin(query?: QueryParams, options?: Omit<RequestOptions, "query" | "responseType">): Promise<ArrayBuffer>;
     batchNeteaseNicknames(payload: Record<string, unknown>, options?: Omit<RequestOptions, "body">): Promise<unknown>;
+    /** Get player binding info. Common required query: `ecid`. */
     getBinding(query?: QueryParams, options?: NonBodyOptions): Promise<unknown>;
     resetBinding(payload: Record<string, unknown>, options?: Omit<RequestOptions, "body">): Promise<unknown>;
     updateBinding(payload: Record<string, unknown>, options?: Omit<RequestOptions, "body">): Promise<unknown>;
     updateUserData(nick: string, payload: Record<string, unknown>, options?: Omit<RequestOptions, "body">): Promise<unknown>;
     updatePassword(ecid: string, payload: Record<string, unknown>, options?: Omit<RequestOptions, "body">): Promise<unknown>;
+    /** Get password hash by ecid. */
     getPasswordHash(ecid: string, query?: QueryParams, options?: NonBodyOptions): Promise<unknown>;
 }
 export declare class AdminApi extends BaseApi {
@@ -84,8 +129,11 @@ export declare class AdminApi extends BaseApi {
     prismDeviceBan(payload: Record<string, unknown>, options?: Omit<RequestOptions, "body">): Promise<unknown>;
     getPrismDeviceBanLog(query?: QueryParams, options?: NonBodyOptions): Promise<unknown>;
     upsertOverwatchCase(payload: Record<string, unknown>, options?: Omit<RequestOptions, "body">): Promise<unknown>;
+    /** Query overwatch case. Common required query: `record_id`. */
     getOverwatchCase(query?: QueryParams, options?: NonBodyOptions): Promise<unknown>;
+    /** Query admin operation logs. Common required query: `start`/`end` or `target_nick`. */
     getOperationLogs(query?: QueryParams, options?: NonBodyOptions): Promise<unknown>;
+    /** Query admin operation statistics. Common required query: `start`, `end`. */
     getOperationStatistics(query?: QueryParams, options?: NonBodyOptions): Promise<unknown>;
 }
 export declare class PunishApi extends BaseApi {
@@ -105,25 +153,34 @@ export declare class BanApi extends BaseApi {
     parkourPunish(query?: QueryParams, payload?: Record<string, unknown>, options?: Omit<RequestOptions, "query" | "body">): Promise<unknown>;
 }
 export declare class PermissionApi extends BaseApi {
+    /** Get player permission. Common required query: `ecid`. */
     getPermission(query?: QueryParams, options?: NonBodyOptions): Promise<unknown>;
     upsert(payload: Record<string, unknown>, options?: Omit<RequestOptions, "body">): Promise<unknown>;
     deleteOne(query?: QueryParams, options?: Omit<RequestOptions, "query">): Promise<unknown>;
 }
 export declare class LogApi extends BaseApi {
+    /** Query action log. Common required query: `start`, `end`, `ecid`. */
     getAction(query?: QueryParams, options?: NonBodyOptions): Promise<unknown>;
     getChat(query?: QueryParams, options?: NonBodyOptions): Promise<unknown>;
     getAuth(query?: QueryParams, options?: NonBodyOptions): Promise<unknown>;
+    /** Query teaming log. Common required query: `start`, `end`, `current`, `ecid`. */
     getTeaming(query?: QueryParams, options?: NonBodyOptions): Promise<unknown>;
     getLatestTeaming(query?: QueryParams, options?: NonBodyOptions): Promise<unknown>;
+    /** Query command log. Common required query: `start`, `end`, `current`, `ecid`. */
     getCommand(query?: QueryParams, options?: NonBodyOptions): Promise<unknown>;
     getMail(query?: QueryParams, options?: NonBodyOptions): Promise<unknown>;
 }
 export declare class OrderApi extends BaseApi {
+    /** Query delivery status. Common required query: `key`, `ecid`. */
     getDeliver(query?: QueryParams, options?: NonBodyOptions): Promise<unknown>;
+    /** Query order logs. Common required query: `ecid`. */
     getLogs(query?: QueryParams, options?: NonBodyOptions): Promise<unknown>;
+    /** Query exchange logs. Common required query: `ecid`, `from`, `to`. */
     getExchangeLogs(query?: QueryParams, options?: NonBodyOptions): Promise<unknown>;
+    /** Get download task count. Common required query: `from`, `to`. */
     getDownloadCount(query?: QueryParams, options?: NonBodyOptions): Promise<unknown>;
     createDownloadTask(query?: QueryParams, payload?: Record<string, unknown>, options?: Omit<RequestOptions, "query" | "body">): Promise<unknown>;
+    /** Get one download task status. Common required query: `downloadId`. */
     getDownloadStatus(query?: QueryParams, options?: NonBodyOptions): Promise<unknown>;
     listDownloadTasks(query?: QueryParams, options?: NonBodyOptions): Promise<unknown>;
 }
@@ -136,7 +193,9 @@ export declare class StageApi extends BaseApi {
     constructor(http: ECAPIHttpClient);
     getTypes(query?: QueryParams, options?: NonBodyOptions): Promise<unknown>;
     create(payload: Record<string, unknown>, options?: Omit<RequestOptions, "body">): Promise<unknown>;
+    /** Query stage info by filters such as game/state/runtimeid/requestid. */
     getInfo(query?: QueryParams, options?: NonBodyOptions): Promise<unknown>;
+    /** Query stage DB id. Common required query: `runtime-id`. */
     getDbId(query?: QueryParams, options?: NonBodyOptions): Promise<unknown>;
 }
 export declare class ItemApi extends BaseApi {
@@ -204,10 +263,13 @@ export declare class MonitorApi extends BaseApi {
     constructor(http: ECAPIHttpClient);
 }
 export declare class PullConfigApi extends BaseApi {
+    /** Pull current config snapshot. */
     pull(query?: QueryParams, options?: NonBodyOptions): Promise<unknown>;
 }
 export declare class SystemApi extends BaseApi {
+    /** Get API root text payload. */
     getRoot(query?: QueryParams, options?: NonBodyOptions): Promise<unknown>;
+    /** Health check endpoint. */
     getHealth(query?: QueryParams, options?: NonBodyOptions): Promise<unknown>;
 }
 export {};

package/dist/apis.js

@@ -1,6 +1,10 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.SystemApi = exports.PullConfigApi = exports.MonitorApi = exports.SpamDetectorApi = exports.AuditApi = exports.EaseChatApi = exports.BroadcastApi = exports.GlobalKVApi = exports.CfgLangApi = exports.LobbyApi = exports.ServersApi = exports.CountApi = exports.ItemApi = exports.StageApi = exports.StageLogApi = exports.OrderApi = exports.LogApi = exports.PermissionApi = exports.BanApi = exports.PunishApi = exports.AdminApi = exports.PlayerApi = exports.PlayerVoteApi = exports.PlayerYearSummaryApi = exports.PlayerMerchandiseApi = exports.PlayerTasksApi = exports.PlayerScoreApi = exports.UserApi = void 0;
+/**
+ * Shared low-level HTTP wrappers used by all API groups.
+ * These helpers keep auth/header/retry behavior consistent across modules.
+ */
 class BaseApi {
     constructor(http) {
         this.http = http;
@@ -22,6 +26,10 @@ class BaseApi {
     }
 }
 class UserApi extends BaseApi {
+    /**
+     * Get current user profile.
+     * Note: backend expects Authorization token for this endpoint in some deployments.
+     */
     getMe(query, options) {
         return this.get("/user/me", query, options);
     }
@@ -34,27 +42,42 @@ class UserApi extends BaseApi {
     refreshToken(payload, options) {
         return this.post("/user/refresh", payload, options);
     }
+    /**
+     * Get current user's OpenID.
+     * May return 404 if OpenID context is unavailable for current auth mode.
+     */
     getOpenId(query, options) {
         return this.get("/user/openid", query, options);
     }
+    /** List all registered users (admin-scoped endpoint). */
     listAll(query, options) {
         return this.get("/user/all", query, options);
     }
     updatePermissions(payload, options) {
         return this.put("/user/permissions", payload, options);
     }
+    /** Query user detail by user id. */
     getById(id, query, options) {
         return this.get(`/user/${encodeURIComponent(id)}`, query, options);
     }
 }
 exports.UserApi = UserApi;
 class PlayerScoreApi extends BaseApi {
+    /**
+     * Get player score summary.
+     * Common required query: `nick`, `game`.
+     */
     getScore(query, options) {
         return super.get("/player/score", query, options);
     }
+    /** Get player score stages. Common required query: `nick`. */
     getStages(query, options) {
         return super.get("/player/score/stages", query, options);
     }
+    /**
+     * Get top ranking records.
+     * Common required query: `game`, `score_type`, `deadline_type`, `limit`, `is_ascending`.
+     */
     getTop(query, options) {
         return super.get("/player/score/top", query, options);
     }
@@ -70,6 +93,10 @@ class PlayerScoreApi extends BaseApi {
 }
 exports.PlayerScoreApi = PlayerScoreApi;
 class PlayerTasksApi extends BaseApi {
+    /**
+     * List tasks for one player.
+     * Common required query: `current`, `pageSize`.
+     */
     list(ecid, query, options) {
         return this.get(`/player/${encodeURIComponent(ecid)}/tasks`, query, options);
     }
@@ -85,6 +112,10 @@ class PlayerTasksApi extends BaseApi {
 }
 exports.PlayerTasksApi = PlayerTasksApi;
 class PlayerMerchandiseApi extends BaseApi {
+    /**
+     * List merchandise items for one player.
+     * Common required query: `current`, `pageSize`.
+     */
     list(ecid, query, options) {
         return this.get(`/player/${encodeURIComponent(ecid)}/merchandise`, query, options);
     }
@@ -100,6 +131,7 @@ class PlayerMerchandiseApi extends BaseApi {
 }
 exports.PlayerMerchandiseApi = PlayerMerchandiseApi;
 class PlayerYearSummaryApi extends BaseApi {
+    /** Get year summary basic info. Common required query: `ecid` (optional `year`). */
     getBasicInfo(query, options) {
         return this.get("/player/year-summary/basic-info", query, options);
     }
@@ -121,11 +153,13 @@ class PlayerYearSummaryApi extends BaseApi {
 }
 exports.PlayerYearSummaryApi = PlayerYearSummaryApi;
 class PlayerVoteApi extends BaseApi {
+    /** Process vote rewards. Common required query: `players` (semicolon-separated). */
     processRewards(query, options) {
         return this.get("/player/vote", query, options);
     }
 }
 exports.PlayerVoteApi = PlayerVoteApi;
+/** Player-related endpoints and nested modules. */
 class PlayerApi extends BaseApi {
     constructor(http) {
         super(http);
@@ -135,15 +169,19 @@ class PlayerApi extends BaseApi {
         this.yearSummary = new PlayerYearSummaryApi(http);
         this.vote = new PlayerVoteApi(http);
     }
+    /** Get online/runtime player info. Common required query: `name`. */
     getInfo(query, options) {
         return this.get("/player/info", query, options);
     }
+    /** Search ECID by nickname/ecid keyword. Common required query: `name`. */
     searchEcid(query, options) {
         return this.get("/player/searchecid", query, options);
     }
+    /** Get player profile data. Common required query: `ecid`. */
     getUserData(query, options) {
         return this.get("/player/userdata", query, options);
     }
+    /** Query NetEase player data. Common required query: `name`. */
     queryNetease(query, options) {
         return this.get("/player/querynetease", query, options);
     }
@@ -153,6 +191,7 @@ class PlayerApi extends BaseApi {
     clearRespackCache(query, options) {
         return this.delete("/player/respack/cache", query, options);
     }
+    /** Get wallet info. Common required query: `ecid`. */
     getWallet(query, options) {
         return this.get("/player/wallet", query, options);
     }
@@ -162,12 +201,15 @@ class PlayerApi extends BaseApi {
     operateGamingTag(payload, options) {
         return this.post("/player/gaming-tag", payload, options);
     }
+    /** Get recent play history. Common required query: `ecid`. */
     getLastPlayed(query, options) {
         return this.get("/player/last-played", query, options);
     }
+    /** Get stage records. Common required query: `ecid`, `start`, `end`. */
     getStageRecord(query, options) {
         return this.get("/player/stage/record", query, options);
     }
+    /** Get player head icon as binary image data. Common required query: `ecid`. */
     getHeadicon(query, options) {
         return this.http.request("GET", "/player/headicon", {
             ...options,
@@ -175,6 +217,7 @@ class PlayerApi extends BaseApi {
             responseType: "arrayBuffer",
         });
     }
+    /** Get player skin as binary image data. Common required query: `ecid`. */
     getSkin(query, options) {
         return this.http.request("GET", "/player/skin", {
             ...options,
@@ -185,6 +228,7 @@ class PlayerApi extends BaseApi {
     batchNeteaseNicknames(payload, options) {
         return this.post("/player/neteasenicknames", payload, options);
     }
+    /** Get player binding info. Common required query: `ecid`. */
     getBinding(query, options) {
         return this.get("/player/binding", query, options);
     }
@@ -200,6 +244,7 @@ class PlayerApi extends BaseApi {
     updatePassword(ecid, payload, options) {
         return this.post(`/player/password/${encodeURIComponent(ecid)}`, payload, options);
     }
+    /** Get password hash by ecid. */
     getPasswordHash(ecid, query, options) {
         return this.get(`/player/password/${encodeURIComponent(ecid)}`, query, options);
     }
@@ -218,12 +263,15 @@ class AdminApi extends BaseApi {
     upsertOverwatchCase(payload, options) {
         return this.post("/admin/overwatch", payload, options);
     }
+    /** Query overwatch case. Common required query: `record_id`. */
     getOverwatchCase(query, options) {
         return this.get("/admin/overwatch", query, options);
     }
+    /** Query admin operation logs. Common required query: `start`/`end` or `target_nick`. */
     getOperationLogs(query, options) {
         return this.get("/admin/operation", query, options);
     }
+    /** Query admin operation statistics. Common required query: `start`, `end`. */
     getOperationStatistics(query, options) {
         return this.get("/admin/operation/statistic", query, options);
     }
@@ -276,6 +324,7 @@ class BanApi extends BaseApi {
 }
 exports.BanApi = BanApi;
 class PermissionApi extends BaseApi {
+    /** Get player permission. Common required query: `ecid`. */
     getPermission(query, options) {
         return super.get("/permission", query, options);
     }
@@ -288,6 +337,7 @@ class PermissionApi extends BaseApi {
 }
 exports.PermissionApi = PermissionApi;
 class LogApi extends BaseApi {
+    /** Query action log. Common required query: `start`, `end`, `ecid`. */
     getAction(query, options) {
         return this.get("/log/action", query, options);
     }
@@ -297,12 +347,14 @@ class LogApi extends BaseApi {
     getAuth(query, options) {
         return this.get("/log/auth", query, options);
     }
+    /** Query teaming log. Common required query: `start`, `end`, `current`, `ecid`. */
     getTeaming(query, options) {
         return this.get("/log/teaming", query, options);
     }
     getLatestTeaming(query, options) {
         return this.get("/log/latestTeaming", query, options);
     }
+    /** Query command log. Common required query: `start`, `end`, `current`, `ecid`. */
     getCommand(query, options) {
         return this.get("/log/command", query, options);
     }
@@ -312,15 +364,19 @@ class LogApi extends BaseApi {
 }
 exports.LogApi = LogApi;
 class OrderApi extends BaseApi {
+    /** Query delivery status. Common required query: `key`, `ecid`. */
     getDeliver(query, options) {
         return this.get("/order/deliver", query, options);
     }
+    /** Query order logs. Common required query: `ecid`. */
     getLogs(query, options) {
         return this.get("/order/logs", query, options);
     }
+    /** Query exchange logs. Common required query: `ecid`, `from`, `to`. */
     getExchangeLogs(query, options) {
         return this.get("/order/exchange-logs", query, options);
     }
+    /** Get download task count. Common required query: `from`, `to`. */
     getDownloadCount(query, options) {
         return this.get("/order/download/count", query, options);
     }
@@ -331,6 +387,7 @@ class OrderApi extends BaseApi {
             body: payload,
         });
     }
+    /** Get one download task status. Common required query: `downloadId`. */
     getDownloadStatus(query, options) {
         return this.get("/order/download/status", query, options);
     }
@@ -359,9 +416,11 @@ class StageApi extends BaseApi {
     create(payload, options) {
         return this.post("/stage/create", payload, options);
     }
+    /** Query stage info by filters such as game/state/runtimeid/requestid. */
     getInfo(query, options) {
         return this.get("/stage/info", query, options);
     }
+    /** Query stage DB id. Common required query: `runtime-id`. */
     getDbId(query, options) {
         return this.get("/stage/db-id", query, options);
     }
@@ -528,15 +587,18 @@ class MonitorApi extends BaseApi {
 }
 exports.MonitorApi = MonitorApi;
 class PullConfigApi extends BaseApi {
+    /** Pull current config snapshot. */
     pull(query, options) {
         return this.get("/pull-config", query, options);
     }
 }
 exports.PullConfigApi = PullConfigApi;
 class SystemApi extends BaseApi {
+    /** Get API root text payload. */
     getRoot(query, options) {
         return this.get("/", query, { ...options, responseType: "text" });
     }
+    /** Health check endpoint. */
     getHealth(query, options) {
         return this.get("/health", query, options);
     }

package/dist/index.d.ts

@@ -2,6 +2,14 @@ import { ECAPIError } from "./http";
 import { AdminApi, AuditApi, BanApi, BroadcastApi, CfgLangApi, CountApi, EaseChatApi, GlobalKVApi, ItemApi, LobbyApi, LogApi, MonitorApi, OrderApi, PermissionApi, PlayerApi, PullConfigApi, PunishApi, ServersApi, StageApi, SystemApi, UserApi } from "./apis";
 import { AuthCredentials, ClientOptions, RequestOptions } from "./types";
 type HttpMethod = "GET" | "POST" | "PUT" | "PATCH" | "DELETE";
+/**
+ * ECAPI main client.
+ *
+ * Usage:
+ * 1) Create a client with `baseUrl` and one auth method.
+ * 2) Call grouped APIs via `client.user`, `client.player`, etc.
+ * 3) Use `request()` for endpoints not wrapped by typed helpers.
+ */
 export declare class ECAPIClient {
     private readonly http;
     readonly user: UserApi;
@@ -25,11 +33,31 @@ export declare class ECAPIClient {
     readonly monitor: MonitorApi;
     readonly pullConfig: PullConfigApi;
     readonly system: SystemApi;
+    /**
+     * Initialize a new ECAPI client.
+     */
     constructor(options: ClientOptions);
+    /**
+     * Replace current auth config for subsequent requests.
+     */
     setAuth(auth?: AuthCredentials): void;
+    /**
+     * Use IAM API Key auth for subsequent requests.
+     */
     setApiKey(apiKey: string): void;
+    /**
+     * Use app session token auth for subsequent requests.
+     */
     setAppSessionToken(appSessionToken: string): void;
+    /**
+     * Clear auth headers from subsequent requests.
+     */
     clearAuth(): void;
+    /**
+     * Low-level request helper.
+     *
+     * Use this when an endpoint is not yet wrapped by a high-level API method.
+     */
     request<T = unknown>(method: HttpMethod, path: string, options?: RequestOptions): Promise<T>;
 }
 export * from "./types";

package/dist/index.js

@@ -18,7 +18,18 @@ exports.ECAPIError = exports.ECAPIClient = void 0;
 const http_1 = require("./http");
 Object.defineProperty(exports, "ECAPIError", { enumerable: true, get: function () { return http_1.ECAPIError; } });
 const apis_1 = require("./apis");
+/**
+ * ECAPI main client.
+ *
+ * Usage:
+ * 1) Create a client with `baseUrl` and one auth method.
+ * 2) Call grouped APIs via `client.user`, `client.player`, etc.
+ * 3) Use `request()` for endpoints not wrapped by typed helpers.
+ */
 class ECAPIClient {
+    /**
+     * Initialize a new ECAPI client.
+     */
     constructor(options) {
         this.http = new http_1.ECAPIHttpClient(options);
         this.user = new apis_1.UserApi(this.http);
@@ -43,18 +54,35 @@ class ECAPIClient {
         this.pullConfig = new apis_1.PullConfigApi(this.http);
         this.system = new apis_1.SystemApi(this.http);
     }
+    /**
+     * Replace current auth config for subsequent requests.
+     */
     setAuth(auth) {
         this.http.setAuth(auth);
     }
+    /**
+     * Use IAM API Key auth for subsequent requests.
+     */
     setApiKey(apiKey) {
         this.http.setApiKey(apiKey);
     }
+    /**
+     * Use app session token auth for subsequent requests.
+     */
     setAppSessionToken(appSessionToken) {
         this.http.setAppSessionToken(appSessionToken);
     }
+    /**
+     * Clear auth headers from subsequent requests.
+     */
     clearAuth() {
         this.http.clearAuth();
     }
+    /**
+     * Low-level request helper.
+     *
+     * Use this when an endpoint is not yet wrapped by a high-level API method.
+     */
     request(method, path, options) {
         return this.http.request(method, path, options);
     }

package/dist/types.d.ts

@@ -1,8 +1,20 @@
+/** Primitive values accepted by query/body helpers. */
 export type Primitive = string | number | boolean | null | undefined;
+/** A query field can be a scalar or an array (serialized as repeated keys). */
 export type QueryValue = Primitive | Primitive[];
+/** Query string map passed to request options. */
 export type QueryParams = Record<string, QueryValue>;
+/** Simple HTTP header map. */
 export type HeaderMap = Record<string, string>;
+/**
+ * Expected response decoding mode.
+ * - json: parse JSON (default)
+ * - text: return UTF-8 string
+ * - arrayBuffer: return binary bytes
+ * - raw: return fetch/raw response object (transport dependent)
+ */
 export type ResponseType = "json" | "text" | "arrayBuffer" | "raw";
+/** Supported auth modes for ECAPI requests. */
 export type AuthCredentials = {
     type: "apiKey";
     apiKey: string;
@@ -10,17 +22,29 @@ export type AuthCredentials = {
     type: "appSessionToken";
     appSessionToken: string;
 };
+/** Top-level options used when creating `ECAPIClient`. */
 export interface ClientOptions {
+    /** API base URL, e.g. https://console.easecation.net/apiv2 */
     baseUrl: string;
+    /** Default auth used by all requests unless overridden. */
     auth?: AuthCredentials;
+    /** Request timeout in milliseconds. Default is 15000. */
     timeoutMs?: number;
+    /** Headers merged into every request. */
     defaultHeaders?: HeaderMap;
 }
+/** Per-request options for all SDK API methods. */
 export interface RequestOptions {
+    /** Query parameters appended to URL. */
     query?: QueryParams;
+    /** Request payload for POST/PUT/PATCH/DELETE where supported. */
     body?: unknown;
+    /** Additional headers for this request only. */
     headers?: HeaderMap;
+    /** Abort signal for request cancellation. */
     signal?: AbortSignal;
+    /** Response parsing mode for this request. */
     responseType?: ResponseType;
+    /** Override client-level auth. Use null to send no auth header. */
     auth?: AuthCredentials | null;
 }

package/package.json

@@ -1,7 +1,16 @@
 {
   "name": "@easecation/ecapi-sdk",
-  "version": "0.1.0",
+  "version": "0.1.1",
   "description": "ECAPI SDK for JavaScript and TypeScript",
+  "homepage": "https://github.com/easecation/easecation-api/tree/main/sdk/npm/ecapi-sdk#readme",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/easecation/easecation-api.git",
+    "directory": "sdk/npm/ecapi-sdk"
+  },
+  "bugs": {
+    "url": "https://github.com/easecation/easecation-api/issues"
+  },
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
   "files": [