@devframes/hub 0.5.1 → 0.5.2

package/dist/settings-Bp5Ax6Os.d.mts

@@ -0,0 +1,131 @@
+import { EventEmitter } from "devframe/types";
+
+//#region src/types/commands.d.ts
+interface DevframeCommandKeybinding {
+  /**
+   * Keyboard shortcut string.
+   * Use "Mod" for platform-aware modifier (Cmd on macOS, Ctrl elsewhere).
+   * Examples: "Mod+K", "Mod+Shift+P", "Alt+N"
+   */
+  key: string;
+}
+interface DevframeCommandBase {
+  /**
+   * Unique namespaced ID, e.g. "vite:open-in-editor"
+   */
+  id: string;
+  title: string;
+  description?: string;
+  /**
+   * Iconify icon string, e.g. "ph:pencil-duotone"
+   */
+  icon?: string;
+  category?: string;
+  /**
+   * Whether to show in command palette. Default: true
+   *
+   * - `true` — show the command and flatten its children into search results
+   * - `false` — hide the command entirely from the palette
+   * - `'without-children'` — show the command but don't flatten children into top-level search (children are still accessible via drill-down)
+   */
+  showInPalette?: boolean | 'without-children';
+  /**
+   * Optional context expression for conditional visibility.
+   * When set, the command is only shown in the palette and only executable
+   * when the expression evaluates to true.
+   */
+  when?: string;
+  /**
+   * Default keyboard shortcut(s) for this command
+   */
+  keybindings?: DevframeCommandKeybinding[];
+}
+/**
+ * Server command input — what plugins pass to `ctx.commands.register()`.
+ */
+interface DevframeServerCommandInput extends DevframeCommandBase {
+  /**
+   * Handler for this command. Optional if the command only serves as a group for children.
+   */
+  handler?: (...args: any[]) => any | Promise<any>;
+  /**
+   * Static sub-commands. Two levels max (parent → children).
+   * Each child must have a globally unique `id`.
+   */
+  children?: DevframeServerCommandInput[];
+}
+/**
+ * Serializable server command entry — sent over RPC (no handler).
+ */
+interface DevframeServerCommandEntry extends DevframeCommandBase {
+  source: 'server';
+  children?: DevframeServerCommandEntry[];
+}
+/**
+ * Client command — registered in the webcomponent context.
+ */
+interface DevframeClientCommand extends DevframeCommandBase {
+  source: 'client';
+  /**
+   * Action for this command. Optional if the command only serves as a group for children.
+   * Return sub-commands for dynamic nested palette menus (runtime submenus).
+   */
+  action?: (...args: any[]) => void | DevframeClientCommand[] | Promise<void | DevframeClientCommand[]>;
+  /**
+   * Static sub-commands. Two levels max (parent → children).
+   */
+  children?: DevframeClientCommand[];
+}
+/**
+ * Union of command entries visible in the palette.
+ */
+type DevframeCommandEntry = DevframeServerCommandEntry | DevframeClientCommand;
+interface DevframeCommandHandle {
+  readonly id: string;
+  update: (patch: Partial<Omit<DevframeServerCommandInput, 'id'>>) => void;
+  unregister: () => void;
+}
+interface DevframeCommandsHostEvents {
+  'command:registered': (command: DevframeServerCommandEntry) => void;
+  'command:unregistered': (id: string) => void;
+}
+interface DevframeCommandsHost {
+  readonly commands: Map<string, DevframeServerCommandInput>;
+  readonly events: EventEmitter<DevframeCommandsHostEvents>;
+  /**
+   * Register a command (with optional children).
+   */
+  register: (command: DevframeServerCommandInput) => DevframeCommandHandle;
+  /**
+   * Unregister a command by ID (removes parent and all children).
+   */
+  unregister: (id: string) => boolean;
+  /**
+   * Execute a command by ID. Searches top-level and children.
+   * Throws if not found or if command has no handler.
+   */
+  execute: (id: string, ...args: any[]) => Promise<unknown>;
+  /**
+   * Returns serializable list (no handlers), preserving tree structure.
+   */
+  list: () => DevframeServerCommandEntry[];
+}
+interface DevframeCommandShortcutOverrides {
+  /**
+   * Command ID → keybinding overrides. Empty array = shortcut disabled.
+   */
+  [commandId: string]: DevframeCommandKeybinding[];
+}
+//#endregion
+//#region src/types/settings.d.ts
+interface DevframeDocksUserSettings {
+  docksHidden: string[];
+  docksCategoriesHidden: string[];
+  docksPinned: string[];
+  docksCustomOrder: Record<string, number>;
+  showIframeAddressBar: boolean;
+  closeOnOutsideClick: boolean;
+  commandShortcuts: DevframeCommandShortcutOverrides;
+}
+//#endregion
+export { DevframeCommandHandle as a, DevframeCommandsHost as c, DevframeServerCommandInput as d, DevframeCommandEntry as i, DevframeCommandsHostEvents as l, DevframeClientCommand as n, DevframeCommandKeybinding as o, DevframeCommandBase as r, DevframeCommandShortcutOverrides as s, DevframeDocksUserSettings as t, DevframeServerCommandEntry as u };

package/dist/types/index.d.mts

@@ -0,0 +1,4 @@
+import { A as DevframeMessageElementPosition, C as DevframeViewLauncher, D as JsonRenderElement, E as RemoteDockOptions, F as DevframeMessageHandle, I as DevframeMessageLevel, L as DevframeMessagesClient, M as DevframeMessageEntryFrom, N as DevframeMessageEntryInput, O as JsonRenderSpec, P as DevframeMessageFilePosition, R as DevframeMessagesHost, S as DevframeViewJsonRender, T as RemoteConnectionInfo, _ as DevframeDocksHost, a as DevframeChildProcessTerminalSession, b as DevframeViewCustomRender, c as DevframeTerminalStatus, d as DevframeDockEntriesGrouped, f as DevframeDockEntry, g as DevframeDockUserEntry, h as DevframeDockEntryIcon, i as DevframeChildProcessExecuteOptions, j as DevframeMessageEntry, k as JsonRenderer, l as DevframeTerminalsHost, m as DevframeDockEntryCategory, n as DevframeHubContext, o as DevframeTerminalSession, p as DevframeDockEntryBase, s as DevframeTerminalSessionBase, t as CreateHubContextOptions, u as ClientScriptEntry, v as DevframeViewAction, w as DevframeViewLauncherStatus, x as DevframeViewIframe, y as DevframeViewBuiltin } from "../context-BGXfnFEd.mjs";
+import { a as DevframeCommandHandle, c as DevframeCommandsHost, d as DevframeServerCommandInput, i as DevframeCommandEntry, l as DevframeCommandsHostEvents, n as DevframeClientCommand, o as DevframeCommandKeybinding, r as DevframeCommandBase, s as DevframeCommandShortcutOverrides, t as DevframeDocksUserSettings, u as DevframeServerCommandEntry } from "../settings-Bp5Ax6Os.mjs";
+import { C as RpcStreamingChannel, E as Thenable, S as RpcSharedStateHost, T as RpcStreamingHost, _ as RpcBroadcastOptions, a as DevframeDiagnosticsLogger, b as RpcFunctionsHost, c as DevframeRpcClientFunctions, d as DevframeViewHost, f as EntriesToObject, g as PartialWithoutId, h as EventsMap, i as DevframeDiagnosticsHost, l as DevframeRpcServerFunctions, m as EventUnsubscribe, n as DevframeCapabilities, o as DevframeHost, p as EventEmitter, r as DevframeDiagnosticsDefinition, s as DevframeNodeRpcSession, t as ConnectionMeta, u as DevframeRpcSharedStates, v as RpcDefinitionsFilter, w as RpcStreamingChannelOptions, x as RpcSharedStateGetOptions, y as RpcDefinitionsToFunctions } from "../index-BWTfvdqa.mjs";
+export { ClientScriptEntry, ConnectionMeta, CreateHubContextOptions, DevframeCapabilities, DevframeChildProcessExecuteOptions, DevframeChildProcessTerminalSession, DevframeClientCommand, DevframeCommandBase, DevframeCommandEntry, DevframeCommandHandle, DevframeCommandKeybinding, DevframeCommandShortcutOverrides, DevframeCommandsHost, DevframeCommandsHostEvents, DevframeDiagnosticsDefinition, DevframeDiagnosticsHost, DevframeDiagnosticsLogger, DevframeDockEntriesGrouped, DevframeDockEntry, DevframeDockEntryBase, DevframeDockEntryCategory, DevframeDockEntryIcon, DevframeDockUserEntry, DevframeDocksHost, DevframeDocksUserSettings, DevframeHost, DevframeHubContext, DevframeMessageElementPosition, DevframeMessageEntry, DevframeMessageEntryFrom, DevframeMessageEntryInput, DevframeMessageFilePosition, DevframeMessageHandle, DevframeMessageLevel, DevframeMessagesClient, DevframeMessagesHost, DevframeNodeRpcSession, DevframeRpcClientFunctions, DevframeRpcServerFunctions, DevframeRpcSharedStates, DevframeServerCommandEntry, DevframeServerCommandInput, DevframeTerminalSession, DevframeTerminalSessionBase, DevframeTerminalStatus, DevframeTerminalsHost, DevframeViewAction, DevframeViewBuiltin, DevframeViewCustomRender, DevframeViewHost, DevframeViewIframe, DevframeViewJsonRender, DevframeViewLauncher, DevframeViewLauncherStatus, EntriesToObject, EventEmitter, EventUnsubscribe, EventsMap, JsonRenderElement, JsonRenderSpec, JsonRenderer, PartialWithoutId, RemoteConnectionInfo, RemoteDockOptions, RpcBroadcastOptions, RpcDefinitionsFilter, RpcDefinitionsToFunctions, RpcFunctionsHost, RpcSharedStateGetOptions, RpcSharedStateHost, RpcStreamingChannel, RpcStreamingChannelOptions, RpcStreamingHost, Thenable };

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@devframes/hub",
   "type": "module",
-  "version": "0.5.1",
+  "version": "0.5.2",
   "description": "Framework-neutral hub layer for devframe — docks, terminals, messages, commands.",
   "author": "Anthony Fu <anthonyfu117@hotmail.com>",
   "license": "MIT",
@@ -33,7 +33,7 @@
     "dist"
   ],
   "peerDependencies": {
-    "devframe": "0.5.1"
+    "devframe": "0.5.2"
   },
   "dependencies": {
     "birpc": "^4.0.0",
@@ -45,7 +45,7 @@
   "devDependencies": {
     "mlly": "^1.8.2",
     "tsdown": "^0.22.0",
-    "devframe": "0.5.1"
+    "devframe": "0.5.2"
   },
   "scripts": {
     "build": "tsdown",