node-ts-screeps-api 0.0.4 → 0.0.8

package/dist/src/apiType.d.ts

@@ -5,10 +5,10 @@ export declare type RawApiPostData<T extends RawApiType> = T extends "signinByPa
 } : T extends "signinByToken" ? {
     token: string;
 } : T extends "getSegment" ? {
-    shard: string;
+    shard?: string;
     segment: number;
 } : T extends "postSegment" ? {
-    shard: string;
+    shard?: string;
     segment: number;
     data: string;
 } : never;

package/dist/src/rawApi.d.ts

@@ -1,5 +1,6 @@
 import { RawApiPostData, RawApiReturnData } from "./apiType";
-import { ApiConfig, AuthType, Badge, MyUserInfo, RequestOpts } from "./type";
+import { ApiConfig, AuthType, Badge, BasicRequestMethod, MyUserInfo, RequestOpts } from "./type";
+import { RoomObjectReturn } from "./rawApiType/roomObjects";
 export declare class RawApi<T extends AuthType> {
     apiConfig: ApiConfig<T>;
     xToken?: string;
@@ -9,7 +10,7 @@ export declare class RawApi<T extends AuthType> {
     constructor(apiConfig: ApiConfig<T>);
     private setServer;
     private gz;
-    private req;
+    req<T>(method: BasicRequestMethod, path: string, body?: {}, headers?: {}): Promise<T>;
     inflate(data: string): Promise<string>;
     auth(): Promise<RawApiReturnData<"signinByPassword">>;
     getSegment(args: RawApiPostData<"getSegment">): Promise<RawApiReturnData<"getSegment">>;
@@ -38,7 +39,7 @@ export declare class RawApi<T extends AuthType> {
         y: number;
         structureType: string;
         name: string;
-        shard: string;
+        shard?: string;
     }): Promise<{
         ok: number;
         result: {
@@ -63,11 +64,11 @@ export declare class RawApi<T extends AuthType> {
     }>;
     getRoomObjects(args: {
         room: string;
-        shard: string;
-    }): Promise<Record<string, unknown>>;
+        shard?: string;
+    }): Promise<RoomObjectReturn>;
     getEncodedRoomTerrain(args: {
         room: string;
-        shard: string;
+        shard?: string;
     }): Promise<{
         ok: number;
         terrain: [{

package/dist/src/rawApiType/roomObjects.d.ts

@@ -0,0 +1,74 @@
+import { Badge } from "../type";
+export interface RoomObjectReturn {
+    ok: 1;
+    objects: AnyRoomObjects[];
+    user: {
+        [name: string]: {
+            _id: string;
+            username: string;
+            badge: Badge;
+        };
+    };
+}
+export declare type AnyRoomObjects = Source | Mineral | Controller;
+export declare type RoomObjectType = "source" | "mineral" | "controller";
+export declare type SpecifiedRoomObject<T extends RoomObjectType> = T extends "source" ? Source : T extends "mineral" ? Mineral : T extends "controller" ? Controller : never;
+export interface BasicRoomObject {
+    x: number;
+    y: number;
+    type: RoomObjectType;
+    _id: string;
+    room: string;
+}
+export interface Source extends BasicRoomObject {
+    type: "source";
+    energy: number;
+    energyCapacity: number;
+    ticksToRegeneration: number;
+    invaderHarvested: number;
+    nextRegenerationTime: number;
+}
+export interface Mineral extends BasicRoomObject {
+    type: "mineral";
+    mineralType: string;
+    mineralAmount: number;
+}
+export interface Controller extends BasicRoomObject {
+    type: "controller";
+    level?: number;
+    /**
+     * 占领了该controller的玩家id
+     *
+     * @type {string}
+     * @memberof Controller
+     */
+    user?: string;
+    /**
+     * 升级进度
+     *
+     * @type {number}
+     * @memberof Controller
+     */
+    progress: number;
+    /**
+     * 将要在什么时候降级
+     *
+     * @type {number}
+     * @memberof Controller
+     */
+    downgradeTime: number;
+    /**
+     * 上次启用的时间
+     *
+     * @type {number}
+     * @memberof Controller
+     */
+    safeMode: number;
+    /**
+     * 可用次数
+     *
+     * @type {number}
+     * @memberof Controller
+     */
+    safeModeAvailable: number;
+}

package/dist/src/type.d.ts

@@ -11,7 +11,7 @@ export declare type AuthInfo<T extends AuthType> = T extends "signinByToken" ? {
     password: string;
 };
 export interface HostInfo {
-    protocol: "http" | "https";
+    protocol: "http" | "https" | "localhost";
     hostname: string;
     port: number;
     path: string;

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "node-ts-screeps-api",
-    "version": "0.0.4",
+    "version": "0.0.8",
     "description": "node-ts-screeps-api",
     "main": "dist/index.js",
     "typings": "./dist/src/index.d.ts",

package/src/api.ts

@@ -1,4 +1,3 @@
-/* eslint-disable no-underscore-dangle */
 import { ApiConfig, AuthType, MyUserInfo } from "./type";
 
 import { RawApiReturnData } from "./apiType";

package/src/apiType.ts

@@ -4,9 +4,9 @@ export type RawApiPostData<T extends RawApiType> = T extends "signinByPassword"
     : T extends "signinByToken"
     ? { token: string }
     : T extends "getSegment"
-    ? { shard: string; segment: number }
+    ? { shard?: string; segment: number }
     : T extends "postSegment"
-    ? { shard: string; segment: number; data: string }
+    ? { shard?: string; segment: number; data: string }
     : never;
 
 export type RawApiReturnData<T extends RawApiType> = T extends "signinByPassword"

package/src/rawApi.ts

@@ -4,6 +4,7 @@ import axios, { AxiosInstance } from "axios";
 import { promisify } from "util";
 import { gunzip, inflate } from "zlib";
 import { ApiConfig, AuthType, Badge, BasicRequestMethod, MyUserInfo, RequestOpts } from "./type";
+import { RoomObjectReturn } from "./rawApiType/roomObjects";
 
 const gunzipAsync = promisify(gunzip);
 const inflateAsync = promisify(inflate);
@@ -15,10 +16,10 @@ export class RawApi<T extends AuthType> {
     private baseUrl: string;
     public constructor(apiConfig: ApiConfig<T>) {
         this.apiConfig = apiConfig;
-        const { protocol, hostname, path } = this.apiConfig.hostInfo;
-        this.baseUrl = `${protocol}://${hostname}${path}`;
+        const { protocol, hostname, path, port } = this.apiConfig.hostInfo;
+        this.baseUrl =
+            protocol !== "localhost" ? `${protocol}://${hostname}${path}` : `http://${hostname}:${port}${path}`;
     }
-
     private setServer(opts: Partial<RequestOpts>): void {
         if (!this.opts) {
             this.opts = {};
@@ -37,7 +38,7 @@ export class RawApi<T extends AuthType> {
         const ret = (await gunzipAsync(buf)) as { toString: () => string };
         return JSON.parse(ret.toString()) as T;
     }
-    private async req<T>(method: BasicRequestMethod, path: string, body = {}, headers = {}): Promise<T> {
+    public async req<T>(method: BasicRequestMethod, path: string, body = {}, headers = {}): Promise<T> {
         this.setServer({ method, url: this.baseUrl, headers });
         const opts: RequestOpts = {
             method,
@@ -123,7 +124,7 @@ export class RawApi<T extends AuthType> {
         y: number;
         structureType: string;
         name: string;
-        shard: string;
+        shard?: string;
     }): Promise<{
         ok: number;
         result: {
@@ -149,13 +150,13 @@ export class RawApi<T extends AuthType> {
         return this.req("POST", "/api/game/create-construction", args);
     }
 
-    public async getRoomObjects(args: { room: string; shard: string }): Promise<Record<string, unknown>> {
+    public async getRoomObjects(args: { room: string; shard?: string }): Promise<RoomObjectReturn> {
         return this.req("GET", "/api/game/room-objects", args);
     }
 
     public async getEncodedRoomTerrain(args: {
         room: string;
-        shard: string;
+        shard?: string;
     }): Promise<{ ok: number; terrain: [{ _id: string; room: string; terrain: string; type: string }] }> {
         return this.req("GET", "/api/game/room-terrain", { ...args, encoded: 1 });
     }

package/src/rawApiType/roomObjects.ts

@@ -0,0 +1,76 @@
+import { Badge } from "../type";
+
+export interface RoomObjectReturn {
+    ok: 1;
+    objects: AnyRoomObjects[];
+    user: { [name: string]: { _id: string; username: string; badge: Badge } };
+}
+export type AnyRoomObjects = Source | Mineral | Controller;
+export type RoomObjectType = "source" | "mineral" | "controller";
+export type SpecifiedRoomObject<T extends RoomObjectType> = T extends "source"
+    ? Source
+    : T extends "mineral"
+    ? Mineral
+    : T extends "controller"
+    ? Controller
+    : never;
+export interface BasicRoomObject {
+    x: number;
+    y: number;
+    type: RoomObjectType;
+    _id: string;
+    room: string;
+}
+
+export interface Source extends BasicRoomObject {
+    type: "source";
+    energy: number;
+    energyCapacity: number;
+    ticksToRegeneration: number;
+    invaderHarvested: number;
+    nextRegenerationTime: number;
+}
+export interface Mineral extends BasicRoomObject {
+    type: "mineral";
+    mineralType: string;
+    mineralAmount: number;
+}
+export interface Controller extends BasicRoomObject {
+    type: "controller";
+    level?: number;
+    /**
+     * 占领了该controller的玩家id
+     *
+     * @type {string}
+     * @memberof Controller
+     */
+    user?: string;
+    /**
+     * 升级进度
+     *
+     * @type {number}
+     * @memberof Controller
+     */
+    progress: number;
+    /**
+     * 将要在什么时候降级
+     *
+     * @type {number}
+     * @memberof Controller
+     */
+    downgradeTime: number;
+    /**
+     * 上次启用的时间
+     *
+     * @type {number}
+     * @memberof Controller
+     */
+    safeMode: number;
+    /**
+     * 可用次数
+     *
+     * @type {number}
+     * @memberof Controller
+     */
+    safeModeAvailable: number;
+}

package/src/socket.ts

@@ -1,5 +1,4 @@
 /* eslint-disable @typescript-eslint/prefer-regexp-exec */
-/* eslint-disable no-underscore-dangle */
 import { EventEmitter } from "events";
 import WebSocket from "ws";
 import { URL } from "url";

package/src/type.ts

@@ -12,7 +12,7 @@ export type AuthInfo<T extends AuthType> = T extends "signinByToken"
     : { type: T; email: string; password: string };
 
 export interface HostInfo {
-    protocol: "http" | "https";
+    protocol: "http" | "https" | "localhost";
     hostname: string;
     port: number;
     path: string;

package/test/unit/api.test.ts

@@ -1,23 +1,12 @@
-import { ScreepsApi } from "index";
 import * as assert from "assert";
-import { ApiConfig } from "type";
-import { userData } from "../../authInfo";
+
+import { apiConfig } from "../../authInfo";
+import { writeFileSync } from "fs";
+import { ScreepsApi } from "../../src";
+import { ApiConfig } from "../../src/type";
 // 上面的userData需要自己在根目录创建，示例参照根目录的authInfoSample.ts
 describe("api", () => {
     describe("create api", () => {
-        const apiConfig: ApiConfig<"signinByPassword"> = {
-            authInfo: {
-                type: "signinByPassword",
-                email: userData.email,
-                password: userData.password
-            },
-            hostInfo: {
-                protocol: "https",
-                port: 443,
-                path: "/",
-                hostname: "screeps.com"
-            }
-        };
         const api = new ScreepsApi(apiConfig);
         const rawApi = api.rawApi;
         const socket = api.socket;
@@ -39,7 +28,10 @@ describe("api", () => {
 
         it("test socket", async () => {
             let hasCpu = false;
-
+            if (api.apiConfig.hostInfo.protocol === "localhost") {
+                console.log("socket is not usable in private server");
+                return;
+            }
             await api.auth();
             await socket.connect();
             await socket.subscribe("cpu");
@@ -63,7 +55,7 @@ describe("api", () => {
         });
 
         it("sign in", async () => {
-            const data = await rawApi.auth();
+            const data = await api.auth();
             console.log(data);
         });
 
@@ -81,13 +73,29 @@ describe("api", () => {
         });
 
         it("get roomObjects", async () => {
-            const data = await rawApi.getRoomObjects({ shard: "shard3", room: "E34S21" });
-            console.log(Object.keys(data).slice(0, 5));
+            const data = await rawApi.getRoomObjects({ room: "E4N1" });
+            console.log(data.objects?.[0]?._id);
+            // const name = "test-E34S21";
+            // writeFileSync(`test/data/roomObjects/${name}.json`, JSON.stringify(data, null, 4));
         });
 
         it("get encoded roomTerrain", async () => {
-            const data = await rawApi.getEncodedRoomTerrain({ shard: "shard3", room: "E34S21" });
+            const data = await rawApi.getEncodedRoomTerrain({ room: "E4N1" });
+            console.log(data);
+        });
+
+        it("get me", async () => {
+            const data = await rawApi.me();
+            console.log(data);
+            const name = "test-me";
+            writeFileSync(`test/data/roomObjects/${name}.json`, JSON.stringify(data, null, 4));
+        });
+
+        it("test", async () => {
+            const data = await rawApi.req("GET", "/api/user/overview", { interval: 8, statName: "energy" });
             console.log(data);
+            const name = "test-test";
+            writeFileSync(`test/data/roomObjects/${name}.json`, JSON.stringify(data, null, 4));
         });
     });
 });

package/tsconfig.json

@@ -7,7 +7,6 @@
         "target": "es2017",
         "moduleResolution": "Node",
         "outDir": "dist",
-        "baseUrl": "src/",
         "sourceMap": true,
         "strict": true,
         "experimentalDecorators": true,
@@ -17,11 +16,6 @@
         "esModuleInterop": true,
         "declaration": true,
         "resolveJsonModule": true,
-        "paths": {
-            "@/*": [
-                "src/*"
-            ]
-        }
     },
     "exclude": [
         "node_modules",