From c78b9c44fbc1d07f655d78162d9b31c7f37c1d6c Mon Sep 17 00:00:00 2001
From: Sebastian Richner <sebastian@richner.ag>
Date: Sat, 17 Feb 2024 14:26:01 +0100
Subject: [PATCH] Add typed ipc from ft

---
 src/electron/types/TypedIpcMain.ts | 86 ++++++++++++++++++++++++++++++
 1 file changed, 86 insertions(+)
 create mode 100644 src/electron/types/TypedIpcMain.ts

diff --git a/src/electron/types/TypedIpcMain.ts b/src/electron/types/TypedIpcMain.ts
new file mode 100644
index 00000000..c2783755
--- /dev/null
+++ b/src/electron/types/TypedIpcMain.ts
@@ -0,0 +1,86 @@
+/* To following types are part of electron-typed-ipc, written by Andrei Canta (deiucanta)
+ * The package is no longer maintained which causes dependency issues. Therefore, we copied the type declaration to this file
+ * The original package can be found here: https://github.com/deiucanta/electron-typed-ipc
+ */
+
+import {
+  IpcMain,
+  IpcMainEvent,
+  IpcMainInvokeEvent,
+  IpcRenderer,
+  IpcRendererEvent,
+  WebContents
+} from 'electron';
+
+type OptionalPromise<T> = T | Promise<T>;
+type InputMap = {
+  [key: string]: (...args: any) => any;
+};
+
+export interface TypedIpcMain<IpcEvents extends InputMap, IpcCommands extends InputMap>
+  extends IpcMain {
+  on<K extends keyof IpcEvents>(
+    channel: K,
+    listener: (event: IpcMainEvent, ...args: Parameters<IpcEvents[K]>) => void
+  ): this;
+  once<K extends keyof IpcEvents>(
+    channel: K,
+    listener: (event: IpcMainEvent, ...args: Parameters<IpcEvents[K]>) => void
+  ): this;
+  removeListener<K extends keyof IpcEvents>(
+    channel: K,
+    listener: (event: IpcMainEvent, ...args: Parameters<IpcEvents[K]>) => void
+  ): this;
+  removeAllListeners<K extends keyof IpcEvents>(channel?: K): this;
+  handle<K extends keyof IpcCommands>(
+    channel: K,
+    listener: (
+      event: IpcMainInvokeEvent,
+      ...args: Parameters<IpcCommands[K]>
+    ) => OptionalPromise<ReturnType<IpcCommands[K]>>
+  ): void;
+  handleOnce<K extends keyof IpcCommands>(
+    channel: K,
+    listener: (
+      event: IpcMainInvokeEvent,
+      ...args: Parameters<IpcCommands[K]>
+    ) => OptionalPromise<ReturnType<IpcCommands[K]>>
+  ): void;
+  removeHandler<K extends keyof IpcCommands>(channel: K): void;
+}
+
+export interface TypedIpcRenderer<IpcEvents extends InputMap, IpcCommands extends InputMap>
+  extends IpcRenderer {
+  on<K extends keyof IpcEvents>(
+    channel: K,
+    listener: (event: IpcRendererEvent, ...args: Parameters<IpcEvents[K]>) => void
+  ): this;
+  once<K extends keyof IpcEvents>(
+    channel: K,
+    listener: (event: IpcRendererEvent, ...args: Parameters<IpcEvents[K]>) => void
+  ): this;
+  removeListener<K extends keyof IpcEvents>(
+    channel: K,
+    listener: (event: IpcRendererEvent, ...args: Parameters<IpcEvents[K]>) => void
+  ): this;
+  removeAllListeners<K extends keyof IpcEvents>(channel: K): this;
+  send<K extends keyof IpcEvents>(channel: K, ...args: Parameters<IpcEvents[K]>): void;
+  sendSync<K extends keyof IpcEvents>(
+    channel: K,
+    ...args: Parameters<IpcEvents[K]>
+  ): ReturnType<IpcEvents[K]>;
+  sendTo<K extends keyof IpcEvents>(
+    webContentsId: number,
+    channel: K,
+    ...args: Parameters<IpcEvents[K]>
+  ): void;
+  sendToHost<K extends keyof IpcEvents>(channel: K, ...args: Parameters<IpcEvents[K]>): void;
+  invoke<K extends keyof IpcCommands>(
+    channel: K,
+    ...args: Parameters<IpcCommands[K]>
+  ): Promise<ReturnType<IpcCommands[K]>>;
+}
+
+export interface TypedWebContents<IpcEvents extends InputMap> extends WebContents {
+  send<K extends keyof IpcEvents>(channel: K, ...args: Parameters<IpcEvents[K]>): void;
+}