feat(hub): add a command kind for message-panel actions (#189)

Author: dvcolomban

packages/hub/src/types/messages.ts

@@ -40,7 +40,23 @@ export interface DevframeMessageActivateAction {
   activate: { dockId: string, params?: Record<string, unknown> }
 }
 
-export type DevframeMessageAction = DevframeMessageActivateAction
+/**
+ * `'command'` invokes a command from the hub's command registry (the same
+ * registry backing the command palette) by `command.id`, spreading
+ * `command.params` as its positional arguments, via the hub's
+ * `hub:commands:execute` RPC.
+ */
+export interface DevframeMessageCommandAction {
+  /** Stable id for the action within its entry. */
+  id: string
+  /** Button label shown in the messages panel. */
+  label: string
+  kind: 'command'
+  /** The command to invoke, plus an optional list of positional arguments. */
+  command: { id: string, params?: unknown[] }
+}
+
+export type DevframeMessageAction = DevframeMessageActivateAction | DevframeMessageCommandAction
 
 export interface DevframeMessageEntry {
   /**

plugins/messages/src/client/App.vue

@@ -69,12 +69,13 @@ onMounted(() => {
 })
 
 async function onActivate(action: DevframeMessageAction): Promise<void> {
-  if (action.kind !== 'activate')
+  const callOptional = props.rpc.callOptional as (name: string, ...args: unknown[]) => Promise<unknown>
+  if (action.kind === 'activate') {
+    await callOptional('hub:docks:activate', action.activate)
     return
-  await (props.rpc.callOptional as (name: string, ...args: unknown[]) => Promise<unknown>)(
-    'hub:docks:activate',
-    action.activate,
-  )
+  }
+  if (action.kind === 'command')
+    await callOptional('hub:commands:execute', action.command.id, ...(action.command.params ?? []))
 }
 
 async function onDismiss(id: string): Promise<void> {

tests/__snapshots__/tsnapi/@devframes/hub/index.snapshot.d.ts

@@ -141,6 +141,15 @@ export interface DevframeMessageActivateAction {
     params?: Record<string, unknown>;
   };
 }
+export interface DevframeMessageCommandAction {
+  id: string;
+  label: string;
+  kind: 'command';
+  command: {
+    id: string;
+    params?: unknown[];
+  };
+}
 export interface DevframeMessageElementPosition {
   selector?: string;
   boundingBox?: {
@@ -337,7 +346,7 @@ export type DevframeDockEntryIcon = string | {
   dark: string;
 };
 export type DevframeDockUserEntry = DevframeDockEntryRegistry[keyof DevframeDockEntryRegistry];
-export type DevframeMessageAction = DevframeMessageActivateAction;
+export type DevframeMessageAction = DevframeMessageActivateAction | DevframeMessageCommandAction;
 export type DevframeMessageEntryFrom = 'server' | 'browser';
 export type DevframeMessageEntryInput = Omit<DevframeMessageEntry, 'id' | 'timestamp' | 'from'> & {
   id?: string;

tests/__snapshots__/tsnapi/@devframes/hub/types.snapshot.d.ts

@@ -37,6 +37,7 @@ export { DevframeHost }
 export { DevframeHubContext }
 export { DevframeMessageAction }
 export { DevframeMessageActivateAction }
+export { DevframeMessageCommandAction }
 export { DevframeMessageElementPosition }
 export { DevframeMessageEntry }
 export { DevframeMessageEntryFrom }