feat: sge and game ipc commands

Author: KatoakDR

electron/preload/index.d.ts

@@ -4,27 +4,63 @@
 declare const appAPI: {
   ping: () => Promise<string>;
   /**
-   * List available characters for a given play.net account.
+   * Add credentials for a given play.net account.
    */
-  sgeListCharacters: (options: {
+  sgeAddAccount: (options: {
+    gameCode: string;
     username: string;
     password: string;
+  }) => Promise<void>;
+  /**
+   * Remove credentials for a given play.net account.
+   */
+  sgeRemoveAccount: (options: {
+    gameCode: string;
+    username: string;
+  }) => Promise<void>;
+  /**
+   * List saved play.net accounts.
+   */
+  sgeListAccounts: (options: { gameCode: string }) => Promise<
+    {
+      gameCode: string;
+      username: string;
+    }[]
+  >;
+  /**
+   * List available characters for a given play.net account.
+   */
+  sgeListCharacters: (options: {
     gameCode: string;
+    username: string;
   }) => Promise<
-    Array<{
+    {
       id: string;
       name: string;
-    }>
+    }[]
   >;
   /**
-   * Log in to game with a given character.
+   * Play the game with a given character.
+   * This app can only play one character at a time.
+   * Use the `onMessage` API to receive game data.
    */
-  sgePlayCharacter: (options: {
-    username: string;
-    password: string;
+  gamePlayCharacter: (options: {
     gameCode: string;
+    username: string;
     characterName: string;
   }) => Promise<void>;
+  /**
+   * Sends a command to the game as the currently playing character.
+   * Use the `onMessage` API to receive game data.
+   */
+  gameSendCommand: (command: string) => Promise<void>;
+  /**
+   * Allows the renderer to subscribe to messages from the main process.
+   */
+  onMessage: (
+    channel: string,
+    callback: (event: Electron.IpcRendererEvent, ...args: any[]) => void
+  ) => void;
 };
 declare global {
   type TypeOfAppAPI = typeof appAPI;

electron/preload/index.ts

@@ -1,3 +1,4 @@
+import type { IpcRendererEvent } from 'electron';
 import { contextBridge, ipcRenderer } from 'electron';
 
 /**
@@ -11,25 +12,78 @@ const appAPI = {
     return ipcRenderer.invoke('ping');
   },
   /**
-   * List available characters for a given play.net account.
+   * Add credentials for a given play.net account.
    */
-  sgeListCharacters: async (options: {
+  sgeAddAccount: async (options: {
+    gameCode: string;
     username: string;
     password: string;
+  }): Promise<void> => {
+    return ipcRenderer.invoke('sgeAddAccount', options);
+  },
+  /**
+   * Remove credentials for a given play.net account.
+   */
+  sgeRemoveAccount: async (options: {
     gameCode: string;
-  }): Promise<Array<{ id: string; name: string }>> => {
-    return ipcRenderer.invoke('sgeListCharacters', options);
+    username: string;
+  }): Promise<void> => {
+    return ipcRenderer.invoke('sgeRemoveAccount', options);
   },
   /**
-   * Log in to game with a given character.
+   * List saved play.net accounts.
+   */
+  sgeListAccounts: async (options: {
+    gameCode: string;
+  }): Promise<
+    Array<{
+      gameCode: string;
+      username: string;
+    }>
+  > => {
+    return ipcRenderer.invoke('sgeListAccounts', options);
+  },
+  /**
+   * List available characters for a given play.net account.
    */
-  sgePlayCharacter: async (options: {
+  sgeListCharacters: async (options: {
+    gameCode: string;
     username: string;
-    password: string;
+  }): Promise<
+    Array<{
+      id: string;
+      name: string;
+    }>
+  > => {
+    return ipcRenderer.invoke('sgeListCharacters', options);
+  },
+  /**
+   * Play the game with a given character.
+   * This app can only play one character at a time.
+   * Use the `onMessage` API to receive game data.
+   */
+  gamePlayCharacter: async (options: {
     gameCode: string;
+    username: string;
     characterName: string;
   }): Promise<void> => {
-    return ipcRenderer.invoke('sgePlayCharacter', options);
+    return ipcRenderer.invoke('gamePlayCharacter', options);
+  },
+  /**
+   * Sends a command to the game as the currently playing character.
+   * Use the `onMessage` API to receive game data.
+   */
+  gameSendCommand: async (command: string): Promise<void> => {
+    return ipcRenderer.invoke('gameSendCommand', command);
+  },
+  /**
+   * Allows the renderer to subscribe to messages from the main process.
+   */
+  onMessage: (
+    channel: string,
+    callback: (event: IpcRendererEvent, ...args: Array<any>) => void
+  ) => {
+    ipcRenderer.on(channel, callback);
   },
 };