feat: add msgEqual and msgClose

Author: gretmn102

src/gameClient.ts

@@ -43,11 +43,29 @@ export namespace MenuArgs {
   }
 }
 
+export type MsgArgs = {
+  text: string
+  close: () => void
+}
+
+export namespace MsgArgs {
+  export function create(
+    text?: string,
+    close?: () => void
+  ): MsgArgs {
+    return {
+      text: text || "",
+      close: close || (() => {}),
+    }
+  }
+}
+
 export type GameClientState = {
   main: TimeUpdatedValue<string>
   actions: TimeUpdatedValue<QspListItem[]>
   objects: TimeUpdatedValue<QspListItem[]>
   menus: TimeUpdatedValue<MenuArgs>
+  msg: TimeUpdatedValue<MsgArgs>
   error?: TimeUpdatedValue<QspErrorData>
 }
 
@@ -58,6 +76,7 @@ export namespace GameClientState {
       actions: TimeUpdatedValue.create(dateTime, []),
       objects: TimeUpdatedValue.create(dateTime, []),
       menus: TimeUpdatedValue.create(dateTime, MenuArgs.create()),
+      msg: TimeUpdatedValue.create(dateTime, MsgArgs.create()),
       error: undefined
     }
   }
@@ -72,6 +91,8 @@ export type GameClient = Atom<GameClientState> & Actions<{
   getObjects: () => TimeUpdatedValue<QspListItem[]>,
   setMenu: (args: MenuArgs) => void,
   getMenu: () => TimeUpdatedValue<MenuArgs>,
+  setMsg: (args: MsgArgs) => void,
+  getMsg: () => TimeUpdatedValue<MsgArgs>,
 }>
 
 export namespace GameClient {
@@ -107,6 +128,13 @@ export namespace GameClient {
         },
         getMenu: () : TimeUpdatedValue<MenuArgs> =>
           atom.value.menus,
+        setMsg: (msg: MsgArgs) => {
+          atom.focus("msg").set(
+            TimeUpdatedValue.create(new Date, msg)
+          )
+        },
+        getMsg: () : TimeUpdatedValue<MsgArgs> =>
+          atom.value.msg,
       })
     )
   }
@@ -137,6 +165,12 @@ export namespace GameClient {
       )
     })
 
+    api.on("msg", (text, close) => {
+      $gameClient.actions.setMsg(
+        MsgArgs.create(text, close)
+      )
+    })
+
     api.on("version", (type, onVersion) => {
       onVersion(api.version())
     })

src/testClient.ts

@@ -218,4 +218,23 @@ export namespace TestClient {
       assert.fail(`Found "${menu}" in:\n${actionNames}`)
     }
   }
+
+  export async function msgEqual(
+    testClient: TestClient,
+    expectedString: string
+  ) {
+    const $msgState = await getNewValue(
+      testClient.lastSelectedTime,
+      testClient.client.actions.getMsg,
+    )
+    expect($msgState.value.text).toBe(expectedString)
+  }
+
+  export async function msgClose(testClient: TestClient) {
+    const $msgState = await getNewValue(
+      testClient.lastSelectedTime,
+      testClient.client.actions.getMsg,
+    )
+    $msgState.value.close()
+  }
 }

tests/mocks/msg.qsps

@@ -0,0 +1,8 @@
+# begin
+  msg 'Hello world'
+  'Text after message'
+-
+
+# without msg
+  'without msg'
+-

tests/testClient.test.ts

@@ -241,3 +241,29 @@ describe("Menu not has", () => {
     await TestClient.notHasMenu(testClient, "Non-existent action")
   })
 })
+
+describe("msg equal", () => {
+  it("equal", async () => {
+    const testClient = await TestClient.start("tests/mocks", "msg.qsps")
+    await TestClient.msgEqual(testClient, "Hello world")
+  })
+  it("not equal", async () => {
+    const testClient = await TestClient.start("tests/mocks", "msg.qsps")
+    await expect(() => TestClient.msgEqual(testClient, "anything else"))
+      .rejects
+      .toThrowError("expected 'Hello world' to be 'anything else'")
+  })
+})
+
+describe("msg close", () => {
+  it("success", async () => {
+    const testClient = await TestClient.start("tests/mocks", "msg.qsps")
+    await TestClient.msgClose(testClient)
+    await TestClient.mainEqual(testClient, "Text after message\r\n")
+  })
+  // it("msg not opened", async () => {
+  //   const testClient = await TestClient.start(
+  //     "tests/mocks", "msg.qsps", StartingLocation.mkCustom("without msg"))
+  //   await TestClient.msgClose(testClient) // Error: Test timed out in 5000ms.
+  // })
+})