Merge pull request #1302 from kando-menu/feature/custom-menus

Add IPC interface

Author: Schneegans

assets/icon-themes/kando/open-menu.svg

@@ -126,7 +126,7 @@ const config: ForgeConfig = {
         "font-src 'self' file: data:; " +
         "style-src-elem 'self' 'unsafe-inline' file: data:; " +
         "media-src 'self' file: data:; " +
-        "connect-src 'self' file:; ",
+        "connect-src 'self' file: ws:; ",
 
       mainConfig,
       renderer: {

assets/icon-themes/kando/preview-menu.svg

@@ -107,6 +107,7 @@
     "typescript": "^5.9.3",
     "typescript-eslint": "^8.55.0",
     "typescript-plugin-css-modules": "^5.2.0",
+    "ws": "^8.18.3",
     "zod": "^4.3.6",
     "zundo": "^2.1.0",
     "zustand": "^5.0.11"

forge.config.ts

@@ -9,8 +9,9 @@
 // SPDX-License-Identifier: MIT
 
 export * from './settings-schemata';
+export * from './typed-event-emitter';
 
-import { AchievementStats } from './settings-schemata';
+import { AchievementStats, Menu } from './settings-schemata';
 
 /** This type is used to pass command line arguments to the app. */
 export type CommandlineOptions = {
@@ -123,6 +124,12 @@ export type WMInfo = {
 export type SystemInfo = {
   /** Whether the system supports launching isolated processes. */
   readonly supportsIsolatedProcesses: boolean;
+
+  /** The IPC port used by Kando's own IPC show-menu interface. */
+  readonly ipcPort: number;
+
+  /** The API version supported by Kando's own IPC show-menu interface. */
+  readonly ipcApiVersion: number;
 };
 
 /** This type describes a icon theme consisting of a collection of icon files. */
@@ -176,15 +183,24 @@ export type KeyStroke = {
  */
 export type KeySequence = Array<KeyStroke>;
 
+/** Enum for the different item categories which can be hovered or selected. */
+export enum InteractionTarget {
+  eItem = 'item',
+  eSubmenu = 'submenu',
+  eParent = 'parent',
+}
+
 /**
  * There are different reasons why a menu should be shown. This type is used to describe
  * the request to show a menu. A menu can be shown because a shortcut was pressed (in this
- * case `trigger` will be the shortcut or the shortcut ID) or because a menu was requested
- * by name.
+ * case `trigger` will be the shortcut or the shortcut ID), because a menu was requested
+ * by name, or a custom menu is requested (in this case `menu` contains the menu
+ * structure).
  */
 export type ShowMenuRequest = {
-  readonly trigger: string;
-  readonly name: string;
+  readonly trigger?: string;
+  readonly name?: string;
+  readonly menu?: Menu;
 };
 
 /**

package-lock.json

@@ -0,0 +1,28 @@
+//////////////////////////////////////////////////////////////////////////////////////////
+//   _  _ ____ _  _ ___  ____                                                           //
+//   |_/  |__| |\ | |  \ |  |    This file belongs to Kando, the cross-platform         //
+//   | \_ |  | | \| |__/ |__|    pie menu. Read more on github.com/kando-menu/kando     //
+//                                                                                      //
+//////////////////////////////////////////////////////////////////////////////////////////
+
+// SPDX-FileCopyrightText: Simon Schneegans <code@simonschneegans.de>
+// SPDX-License-Identifier: MIT
+
+/**
+ * Selects the appropriate WebSocket implementation for Node.js or browser/Electron
+ * renderer.
+ */
+export function createCrossWebSocket(url: string): {
+  send(data: string): void;
+  close(): void;
+  onopen?: () => void;
+  onmessage?: (event: { data: string }) => void;
+  onerror?: (event: unknown) => void;
+} {
+  // eslint-disable-next-line @typescript-eslint/naming-convention
+  const WebSocketImpl =
+    typeof window !== 'undefined' && typeof window.WebSocket !== 'undefined'
+      ? window.WebSocket
+      : require('ws');
+  return new WebSocketImpl(url);
+}

package.json

@@ -0,0 +1,12 @@
+//////////////////////////////////////////////////////////////////////////////////////////
+//   _  _ ____ _  _ ___  ____                                                           //
+//   |_/  |__| |\ | |  \ |  |    This file belongs to Kando, the cross-platform         //
+//   | \_ |  | | \| |__/ |__|    pie menu. Read more on github.com/kando-menu/kando     //
+//                                                                                      //
+//////////////////////////////////////////////////////////////////////////////////////////
+
+// SPDX-FileCopyrightText: Simon Schneegans <code@simonschneegans.de>
+// SPDX-License-Identifier: MIT
+
+export { IPCServer, IPCCallbacks } from './ipc-server';
+export { IPCShowMenuClient } from './ipc-show-menu-client';