node-ts-screeps-api 0.0.12 → 0.0.14

package/authInfoSample.ts

@@ -5,7 +5,8 @@ const userData = {
     email: "notMyEmail@abc.com",
     password: "notMyPassword"
 };
-export const apiConfig: ApiConfig<"signinByPassword"> = {
+
+export const localServerApiConfig: ApiConfig<"signinByPassword"> = {
     authInfo: {
         type: "signinByPassword",
         email: userData.email,
@@ -18,3 +19,17 @@ export const apiConfig: ApiConfig<"signinByPassword"> = {
         hostname: "127.0.0.1"
     }
 };
+
+export const officialServerApiConfig: ApiConfig<"signinByPassword"> = {
+    authInfo: {
+        type: "signinByPassword",
+        email: userData.email,
+        password: userData.password
+    },
+    hostInfo: {
+        protocol: "https",
+        port: 443,
+        path: "/",
+        hostname: "screeps.com"
+    }
+};

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

@@ -75,7 +75,33 @@ export interface Controller extends BasicRoomObject {
 export interface Portal extends BasicRoomObject {
     type: "portal";
     destination: {
+        /**
+         * 表示目的地room。
+         *
+         * @type {string}
+         */
         room: string;
-        shard: string;
+        /**
+         * 表示目的地shard，如果没有则目的地为同shard位置。
+         *
+         * @type {string}
+         */
+        shard?: string;
     };
+    /**
+     * portal的过期时间。
+     *
+     * 当到达该时间时，该属性消失，portal会增加一个decayTime属性，表示过期的Game.time。
+     *
+     * @type {number}
+     * @memberof Portal
+     */
+    unstableDate?: number;
+    /**
+     * portal过期的Game.time。
+     *
+     * @type {number}
+     * @memberof Portal
+     */
+    decayTime?: number;
 }

package/package.json

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

package/src/rawApi.ts

@@ -94,6 +94,18 @@ export class RawApi<T extends AuthType> {
         return this.req("POST", "/api/user/memory-segment", args);
     }
 
+    public async getMemory(args: { path?: string; shard?: string }): Promise<{ ok: number; data: string }> {
+        return this.req("GET", "/api/user/memory", args);
+    }
+
+    public async postMemory(args: {
+        path?: string;
+        value: string;
+        shard?: string;
+    }): Promise<{ ok: number; data: string }> {
+        return this.req("POST", "/api/user/memory", args);
+    }
+
     public async findUser(username: string): Promise<{
         ok: number;
         user: {

package/src/rawApiType/roomObjects.ts

@@ -81,7 +81,33 @@ export interface Controller extends BasicRoomObject {
 export interface Portal extends BasicRoomObject {
     type: "portal";
     destination: {
+        /**
+         * 表示目的地room。
+         *
+         * @type {string}
+         */
         room: string;
-        shard: string;
+        /**
+         * 表示目的地shard，如果没有则目的地为同shard位置。
+         *
+         * @type {string}
+         */
+        shard?: string;
     };
+    /**
+     * portal的过期时间。
+     *
+     * 当到达该时间时，该属性消失，portal会增加一个decayTime属性，表示过期的Game.time。
+     *
+     * @type {number}
+     * @memberof Portal
+     */
+    unstableDate?: number;
+    /**
+     * portal过期的Game.time。
+     *
+     * @type {number}
+     * @memberof Portal
+     */
+    decayTime?: number;
 }

package/test/unit/api.test.ts

@@ -1,29 +1,28 @@
 import * as assert from "assert";
 
-import { apiConfig } from "../../authInfo";
+import { localServerApiConfig } from "../../authInfo";
 import { writeFileSync } from "fs";
 import { ScreepsApi } from "../../src";
-import { ApiConfig } from "../../src/type";
 // 上面的userData需要自己在根目录创建，示例参照根目录的authInfoSample.ts
 describe("api", () => {
     describe("create api", () => {
-        const api = new ScreepsApi(apiConfig);
+        const api = new ScreepsApi(localServerApiConfig);
         const rawApi = api.rawApi;
         const socket = api.socket;
         it("is apiConfig stored properly", () => {
-            assert.deepStrictEqual(api.apiConfig, apiConfig);
+            assert.deepStrictEqual(api.apiConfig, localServerApiConfig);
         });
 
         it("throw Error when unauthorized", async () => {
-            // let anErr;
-            // try {
-            // await rawApi.postSegment({ shard: "shard3", segment: 30, data: "test" });
-            // } catch (err) {
-            //     anErr = err;
-            //     const message = (err as Error).message;
-            //     assert.strictEqual(message, `{"error":"unauthorized"}`);
-            // }
-            // if (!anErr) assert.fail("no error was thrown");
+            let anErr;
+            try {
+                await rawApi.postSegment({ segment: 30, data: "test" });
+            } catch (err) {
+                anErr = err;
+                const message = (err as Error).message;
+                assert.strictEqual(message, `{"error":"unauthorized"}`);
+            }
+            if (!anErr) assert.fail("no error was thrown");
         });
 
         it("test socket", async () => {
@@ -61,16 +60,16 @@ describe("api", () => {
 
         const testStr = `test${Date.now()}`;
         it("post segment", async () => {
-            // const data = await rawApi.postSegment({ shard: "shard3", segment: 30, data: testStr });
-            // console.log(data);
-            // assert.strictEqual(data.ok, 1);
+            const data = await rawApi.postSegment({ shard: "shard3", segment: 30, data: testStr });
+            console.log(data);
+            assert.strictEqual(data.ok, 1);
         });
 
-        // it("get segment", async () => {
-        //     const data = await rawApi.getSegment({ shard: "shard3", segment: 30 });
-        //     console.log(data);
-        //     assert.strictEqual(data.data, testStr);
-        // });
+        it("get segment", async () => {
+            const data = await rawApi.getSegment({ shard: "shard3", segment: 30 });
+            console.log(data);
+            assert.strictEqual(data.data, testStr);
+        });
 
         it("get world size", async () => {
             const data = await rawApi.getWorldSize({ shard: "shard3" });

package/test/unit/officialServerApi.test.ts

@@ -0,0 +1,33 @@
+import * as assert from "assert";
+
+import { officialServerApiConfig } from "../../authInfo";
+import { ScreepsApi } from "../../src";
+import { writeFileSync } from "fs";
+// 上面的userData需要自己在根目录创建，示例参照根目录的authInfoSample.ts
+describe("api", () => {
+    describe("create api", () => {
+        const api = new ScreepsApi(officialServerApiConfig);
+        const rawApi = api.rawApi;
+        const socket = api.socket;
+        it("sign in", async () => {
+            const data = await api.auth();
+            console.log(data);
+        });
+
+        it("is apiConfig stored properly", async () => {
+            assert.deepStrictEqual(api.apiConfig, officialServerApiConfig);
+        });
+
+        it("test getMemory", async () => {
+            const data = await rawApi.getMemory({ shard: "shard3" });
+            const name = "memory";
+            writeFileSync(`test/data/roomObjects/${name}.json`, JSON.stringify(data, null, 4));
+        });
+
+        it("test getMemory by path", async () => {
+            const data = await rawApi.getMemory({ path: "creeps", shard: "shard3" });
+            const name = "memory-creeps";
+            writeFileSync(`test/data/roomObjects/${name}.json`, JSON.stringify(data, null, 4));
+        });
+    });
+});