@easecation/ecapi-sdk 0.1.0 → 0.1.2

package/dist/types.d.ts

@@ -1,8 +1,107 @@
+/** 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[];
-export type QueryParams = Record<string, QueryValue>;
+/**
+ * Common query keys used by ECAPI endpoints.
+ * This keeps object-key autocomplete useful while still allowing any custom key.
+ */
+export interface QueryParams {
+    action?: QueryValue;
+    address?: QueryValue;
+    addressee?: QueryValue;
+    auth_method?: QueryValue;
+    ban_type?: QueryValue;
+    bigId?: QueryValue;
+    categories?: QueryValue;
+    category?: QueryValue;
+    client_ip?: QueryValue;
+    config_type?: QueryValue;
+    csv?: QueryValue;
+    current?: QueryValue;
+    data?: QueryValue;
+    deadline?: QueryValue;
+    deadline_type?: QueryValue;
+    desc?: QueryValue;
+    deviceId?: QueryValue;
+    downloadId?: QueryValue;
+    duration_range?: QueryValue;
+    ecid?: QueryValue;
+    enableBanHistoryParse?: QueryValue;
+    end?: QueryValue;
+    endTime?: QueryValue;
+    env?: QueryValue;
+    events?: QueryValue;
+    filter?: QueryValue;
+    frame?: QueryValue;
+    from?: QueryValue;
+    game?: QueryValue;
+    high_risk?: QueryValue;
+    id?: QueryValue;
+    iditem?: QueryValue;
+    idtask?: QueryValue;
+    is_ascending?: QueryValue;
+    key?: QueryValue;
+    lang?: QueryValue;
+    limit?: QueryValue;
+    map?: QueryValue;
+    max?: QueryValue;
+    maxPoints?: QueryValue;
+    min?: QueryValue;
+    name?: QueryValue;
+    nick?: QueryValue;
+    netease?: QueryValue;
+    operation_status?: QueryValue;
+    operation_type?: QueryValue;
+    operator_id?: QueryValue;
+    order?: QueryValue;
+    page?: QueryValue;
+    pageSize?: QueryValue;
+    pattern?: QueryValue;
+    permission?: QueryValue;
+    permission_type?: QueryValue;
+    players?: QueryValue;
+    port?: QueryValue;
+    record_id?: QueryValue;
+    requestid?: QueryValue;
+    runtimeid?: QueryValue;
+    score_type?: QueryValue;
+    search?: QueryValue;
+    skipwac?: QueryValue;
+    sort?: QueryValue;
+    sortBy?: QueryValue;
+    sortField?: QueryValue;
+    sortOrder?: QueryValue;
+    source_nick?: QueryValue;
+    start?: QueryValue;
+    startTime?: QueryValue;
+    state?: QueryValue;
+    table?: QueryValue;
+    tag?: QueryValue;
+    target_nick?: QueryValue;
+    target_player_id?: QueryValue;
+    to?: QueryValue;
+    token?: QueryValue;
+    type?: QueryValue;
+    types?: QueryValue;
+    usetime?: QueryValue;
+    uuid?: QueryValue;
+    valueType?: QueryValue;
+    year?: QueryValue;
+    "runtime-id"?: QueryValue;
+    [key: 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 +109,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,15 +1,25 @@
 {
   "name": "@easecation/ecapi-sdk",
-  "version": "0.1.0",
+  "version": "0.1.2",
   "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": [
     "dist",
+    "src/method-signatures.d.ts",
     "README.md"
   ],
   "scripts": {
-    "build": "tsc -p tsconfig.json"
+    "build": "tsc -p tsconfig.json && mkdir -p dist/src && cp src/method-signatures.d.ts dist/src/method-signatures.d.ts"
   },
   "keywords": [
     "ecapi",